(calendar-read-mayan-haab-date, calendar-read-mayan-tzolkin-date): Use
[emacs.git] / src / keyboard.c
blob7c317660cc27e22d88d93e1b3caa95502399f633
1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985,86,87,88,89,93,94,95,96,97,99,2000,01,02,03,04
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 /* 1 after calling Freset_this_command_lengths.
149 Usually it is 0. */
150 int this_command_key_count_reset;
152 /* This vector is used as a buffer to record the events that were actually read
153 by read_key_sequence. */
154 Lisp_Object raw_keybuf;
155 int raw_keybuf_count;
157 #define GROW_RAW_KEYBUF \
158 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
160 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
161 Lisp_Object new; \
162 new = Fmake_vector (make_number (newsize), Qnil); \
163 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
164 raw_keybuf_count * sizeof (Lisp_Object)); \
165 raw_keybuf = new; \
168 /* Number of elements of this_command_keys
169 that precede this key sequence. */
170 int this_single_command_key_start;
172 /* Record values of this_command_key_count and echo_length ()
173 before this command was read. */
174 static int before_command_key_count;
175 static int before_command_echo_length;
177 extern int minbuf_level;
179 extern int message_enable_multibyte;
181 extern struct backtrace *backtrace_list;
183 /* If non-nil, the function that implements the display of help.
184 It's called with one argument, the help string to display. */
186 Lisp_Object Vshow_help_function;
188 /* If a string, the message displayed before displaying a help-echo
189 in the echo area. */
191 Lisp_Object Vpre_help_message;
193 /* Nonzero means do menu prompting. */
195 static int menu_prompting;
197 /* Character to see next line of menu prompt. */
199 static Lisp_Object menu_prompt_more_char;
201 /* For longjmp to where kbd input is being done. */
203 static jmp_buf getcjmp;
205 /* True while doing kbd input. */
206 int waiting_for_input;
208 /* True while displaying for echoing. Delays C-g throwing. */
210 int echoing;
212 /* Non-null means we can start echoing at the next input pause even
213 though there is something in the echo area. */
215 static struct kboard *ok_to_echo_at_next_pause;
217 /* The kboard last echoing, or null for none. Reset to 0 in
218 cancel_echoing. If non-null, and a current echo area message
219 exists, and echo_message_buffer is eq to the current message
220 buffer, we know that the message comes from echo_kboard. */
222 struct kboard *echo_kboard;
224 /* The buffer used for echoing. Set in echo_now, reset in
225 cancel_echoing. */
227 Lisp_Object echo_message_buffer;
229 /* Nonzero means disregard local maps for the menu bar. */
230 static int inhibit_local_menu_bar_menus;
232 /* Nonzero means C-g should cause immediate error-signal. */
233 int immediate_quit;
235 /* The user's ERASE setting. */
236 Lisp_Object Vtty_erase_char;
238 /* Character to recognize as the help char. */
239 Lisp_Object Vhelp_char;
241 /* List of other event types to recognize as meaning "help". */
242 Lisp_Object Vhelp_event_list;
244 /* Form to execute when help char is typed. */
245 Lisp_Object Vhelp_form;
247 /* Command to run when the help character follows a prefix key. */
248 Lisp_Object Vprefix_help_command;
250 /* List of items that should move to the end of the menu bar. */
251 Lisp_Object Vmenu_bar_final_items;
253 /* Non-nil means show the equivalent key-binding for
254 any M-x command that has one.
255 The value can be a length of time to show the message for.
256 If the value is non-nil and not a number, we wait 2 seconds. */
257 Lisp_Object Vsuggest_key_bindings;
259 /* How long to display an echo-area message when the minibuffer is active.
260 If the value is not a number, such messages don't time out. */
261 Lisp_Object Vminibuffer_message_timeout;
263 /* Character that causes a quit. Normally C-g.
265 If we are running on an ordinary terminal, this must be an ordinary
266 ASCII char, since we want to make it our interrupt character.
268 If we are not running on an ordinary terminal, it still needs to be
269 an ordinary ASCII char. This character needs to be recognized in
270 the input interrupt handler. At this point, the keystroke is
271 represented as a struct input_event, while the desired quit
272 character is specified as a lispy event. The mapping from struct
273 input_events to lispy events cannot run in an interrupt handler,
274 and the reverse mapping is difficult for anything but ASCII
275 keystrokes.
277 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
278 ASCII character. */
279 int quit_char;
281 extern Lisp_Object current_global_map;
282 extern int minibuf_level;
284 /* If non-nil, this is a map that overrides all other local maps. */
285 Lisp_Object Voverriding_local_map;
287 /* If non-nil, Voverriding_local_map applies to the menu bar. */
288 Lisp_Object Voverriding_local_map_menu_flag;
290 /* Keymap that defines special misc events that should
291 be processed immediately at a low level. */
292 Lisp_Object Vspecial_event_map;
294 /* Current depth in recursive edits. */
295 int command_loop_level;
297 /* Total number of times command_loop has read a key sequence. */
298 EMACS_INT num_input_keys;
300 /* Last input character read as a command. */
301 Lisp_Object last_command_char;
303 /* Last input character read as a command, not counting menus
304 reached by the mouse. */
305 Lisp_Object last_nonmenu_event;
307 /* Last input character read for any purpose. */
308 Lisp_Object last_input_char;
310 /* If not Qnil, a list of objects to be read as subsequent command input. */
311 Lisp_Object Vunread_command_events;
313 /* If not Qnil, a list of objects to be read as subsequent command input
314 including input method processing. */
315 Lisp_Object Vunread_input_method_events;
317 /* If not Qnil, a list of objects to be read as subsequent command input
318 but NOT including input method processing. */
319 Lisp_Object Vunread_post_input_method_events;
321 /* If not -1, an event to be read as subsequent command input. */
322 EMACS_INT unread_command_char;
324 /* If not Qnil, this is a switch-frame event which we decided to put
325 off until the end of a key sequence. This should be read as the
326 next command input, after any unread_command_events.
328 read_key_sequence uses this to delay switch-frame events until the
329 end of the key sequence; Fread_char uses it to put off switch-frame
330 events until a non-ASCII event is acceptable as input. */
331 Lisp_Object unread_switch_frame;
333 /* A mask of extra modifier bits to put into every keyboard char. */
334 EMACS_INT extra_keyboard_modifiers;
336 /* Char to use as prefix when a meta character is typed in.
337 This is bound on entry to minibuffer in case ESC is changed there. */
339 Lisp_Object meta_prefix_char;
341 /* Last size recorded for a current buffer which is not a minibuffer. */
342 static int last_non_minibuf_size;
344 /* Number of idle seconds before an auto-save and garbage collection. */
345 static Lisp_Object Vauto_save_timeout;
347 /* Total number of times read_char has returned. */
348 int num_input_events;
350 /* Total number of times read_char has returned, outside of macros. */
351 EMACS_INT num_nonmacro_input_events;
353 /* Auto-save automatically when this many characters have been typed
354 since the last time. */
356 static EMACS_INT auto_save_interval;
358 /* Value of num_nonmacro_input_events as of last auto save. */
360 int last_auto_save;
362 /* The command being executed by the command loop.
363 Commands may set this, and the value set will be copied into
364 current_kboard->Vlast_command instead of the actual command. */
365 Lisp_Object Vthis_command;
367 /* This is like Vthis_command, except that commands never set it. */
368 Lisp_Object real_this_command;
370 /* If the lookup of the command returns a binding, the original
371 command is stored in this-original-command. It is nil otherwise. */
372 Lisp_Object Vthis_original_command;
374 /* The value of point when the last command was executed. */
375 int last_point_position;
377 /* The buffer that was current when the last command was started. */
378 Lisp_Object last_point_position_buffer;
380 /* The frame in which the last input event occurred, or Qmacro if the
381 last event came from a macro. We use this to determine when to
382 generate switch-frame events. This may be cleared by functions
383 like Fselect_frame, to make sure that a switch-frame event is
384 generated by the next character. */
385 Lisp_Object internal_last_event_frame;
387 /* A user-visible version of the above, intended to allow users to
388 figure out where the last event came from, if the event doesn't
389 carry that information itself (i.e. if it was a character). */
390 Lisp_Object Vlast_event_frame;
392 /* The timestamp of the last input event we received from the X server.
393 X Windows wants this for selection ownership. */
394 unsigned long last_event_timestamp;
396 Lisp_Object Qself_insert_command;
397 Lisp_Object Qforward_char;
398 Lisp_Object Qbackward_char;
399 Lisp_Object Qundefined;
400 Lisp_Object Qtimer_event_handler;
402 /* read_key_sequence stores here the command definition of the
403 key sequence that it reads. */
404 Lisp_Object read_key_sequence_cmd;
406 /* Echo unfinished commands after this many seconds of pause. */
407 Lisp_Object Vecho_keystrokes;
409 /* Form to evaluate (if non-nil) when Emacs is started. */
410 Lisp_Object Vtop_level;
412 /* User-supplied table to translate input characters. */
413 Lisp_Object Vkeyboard_translate_table;
415 /* Keymap mapping ASCII function key sequences onto their preferred forms. */
416 extern Lisp_Object Vfunction_key_map;
418 /* Another keymap that maps key sequences into key sequences.
419 This one takes precedence over ordinary definitions. */
420 extern Lisp_Object Vkey_translation_map;
422 /* If non-nil, this implements the current input method. */
423 Lisp_Object Vinput_method_function;
424 Lisp_Object Qinput_method_function;
426 /* When we call Vinput_method_function,
427 this holds the echo area message that was just erased. */
428 Lisp_Object Vinput_method_previous_message;
430 /* Non-nil means deactivate the mark at end of this command. */
431 Lisp_Object Vdeactivate_mark;
433 /* Menu bar specified in Lucid Emacs fashion. */
435 Lisp_Object Vlucid_menu_bar_dirty_flag;
436 Lisp_Object Qrecompute_lucid_menubar, Qactivate_menubar_hook;
438 Lisp_Object Qecho_area_clear_hook;
440 /* Hooks to run before and after each command. */
441 Lisp_Object Qpre_command_hook, Vpre_command_hook;
442 Lisp_Object Qpost_command_hook, Vpost_command_hook;
443 Lisp_Object Qcommand_hook_internal, Vcommand_hook_internal;
444 /* Hook run after a command if there's no more input soon. */
445 Lisp_Object Qpost_command_idle_hook, Vpost_command_idle_hook;
447 /* Delay time in microseconds before running post-command-idle-hook. */
448 EMACS_INT post_command_idle_delay;
450 /* List of deferred actions to be performed at a later time.
451 The precise format isn't relevant here; we just check whether it is nil. */
452 Lisp_Object Vdeferred_action_list;
454 /* Function to call to handle deferred actions, when there are any. */
455 Lisp_Object Vdeferred_action_function;
456 Lisp_Object Qdeferred_action_function;
458 Lisp_Object Qinput_method_exit_on_first_char;
459 Lisp_Object Qinput_method_use_echo_area;
461 /* File in which we write all commands we read. */
462 FILE *dribble;
464 /* Nonzero if input is available. */
465 int input_pending;
467 /* 1 if should obey 0200 bit in input chars as "Meta", 2 if should
468 keep 0200 bit in input chars. 0 to ignore the 0200 bit. */
470 int meta_key;
472 /* Non-zero means force key bindings update in parse_menu_item. */
474 int update_menu_bindings;
476 extern char *pending_malloc_warning;
478 /* Circular buffer for pre-read keyboard input. */
480 static struct input_event kbd_buffer[KBD_BUFFER_SIZE];
482 /* Pointer to next available character in kbd_buffer.
483 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
484 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
485 next available char is in kbd_buffer[0]. */
486 static struct input_event *kbd_fetch_ptr;
488 /* Pointer to next place to store character in kbd_buffer. This
489 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
490 character should go in kbd_buffer[0]. */
491 static struct input_event * volatile kbd_store_ptr;
493 /* The above pair of variables forms a "queue empty" flag. When we
494 enqueue a non-hook event, we increment kbd_store_ptr. When we
495 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
496 there is input available iff the two pointers are not equal.
498 Why not just have a flag set and cleared by the enqueuing and
499 dequeuing functions? Such a flag could be screwed up by interrupts
500 at inopportune times. */
502 /* If this flag is non-nil, we check mouse_moved to see when the
503 mouse moves, and motion events will appear in the input stream.
504 Otherwise, mouse motion is ignored. */
505 Lisp_Object do_mouse_tracking;
507 /* Symbols to head events. */
508 Lisp_Object Qmouse_movement;
509 Lisp_Object Qscroll_bar_movement;
510 Lisp_Object Qswitch_frame;
511 Lisp_Object Qdelete_frame;
512 Lisp_Object Qiconify_frame;
513 Lisp_Object Qmake_frame_visible;
514 Lisp_Object Qselect_window;
515 Lisp_Object Qhelp_echo;
517 /* Symbols to denote kinds of events. */
518 Lisp_Object Qfunction_key;
519 Lisp_Object Qmouse_click;
520 #ifdef WINDOWSNT
521 Lisp_Object Qlanguage_change;
522 #endif
523 Lisp_Object Qdrag_n_drop;
524 Lisp_Object Qsave_session;
526 /* Lisp_Object Qmouse_movement; - also an event header */
528 /* Properties of event headers. */
529 Lisp_Object Qevent_kind;
530 Lisp_Object Qevent_symbol_elements;
532 /* menu item parts */
533 Lisp_Object Qmenu_alias;
534 Lisp_Object Qmenu_enable;
535 Lisp_Object QCenable, QCvisible, QChelp, QCfilter, QCkeys, QCkey_sequence;
536 Lisp_Object QCbutton, QCtoggle, QCradio;
537 extern Lisp_Object Vdefine_key_rebound_commands;
538 extern Lisp_Object Qmenu_item;
540 /* An event header symbol HEAD may have a property named
541 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
542 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
543 mask of modifiers applied to it. If present, this is used to help
544 speed up parse_modifiers. */
545 Lisp_Object Qevent_symbol_element_mask;
547 /* An unmodified event header BASE may have a property named
548 Qmodifier_cache, which is an alist mapping modifier masks onto
549 modified versions of BASE. If present, this helps speed up
550 apply_modifiers. */
551 Lisp_Object Qmodifier_cache;
553 /* Symbols to use for parts of windows. */
554 Lisp_Object Qmode_line;
555 Lisp_Object Qvertical_line;
556 Lisp_Object Qvertical_scroll_bar;
557 Lisp_Object Qmenu_bar;
558 extern Lisp_Object Qleft_margin, Qright_margin;
559 extern Lisp_Object Qleft_fringe, Qright_fringe;
560 extern Lisp_Object QCmap;
562 Lisp_Object recursive_edit_unwind (), command_loop ();
563 Lisp_Object Fthis_command_keys ();
564 Lisp_Object Qextended_command_history;
565 EMACS_TIME timer_check ();
567 extern Lisp_Object Vhistory_length, Vtranslation_table_for_input;
569 extern char *x_get_keysym_name ();
571 static void record_menu_key ();
572 static int echo_length ();
574 Lisp_Object Qpolling_period;
576 /* List of absolute timers. Appears in order of next scheduled event. */
577 Lisp_Object Vtimer_list;
579 /* List of idle time timers. Appears in order of next scheduled event. */
580 Lisp_Object Vtimer_idle_list;
582 /* Incremented whenever a timer is run. */
583 int timers_run;
585 extern Lisp_Object Vprint_level, Vprint_length;
587 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
588 happens. */
589 EMACS_TIME *input_available_clear_time;
591 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
592 Default is 1 if INTERRUPT_INPUT is defined. */
593 int interrupt_input;
595 /* Nonzero while interrupts are temporarily deferred during redisplay. */
596 int interrupts_deferred;
598 /* Nonzero means use ^S/^Q for flow control. */
599 int flow_control;
601 /* Allow m- file to inhibit use of FIONREAD. */
602 #ifdef BROKEN_FIONREAD
603 #undef FIONREAD
604 #endif
606 /* We are unable to use interrupts if FIONREAD is not available,
607 so flush SIGIO so we won't try. */
608 #ifndef FIONREAD
609 #ifdef SIGIO
610 #undef SIGIO
611 #endif
612 #endif
614 /* If we support a window system, turn on the code to poll periodically
615 to detect C-g. It isn't actually used when doing interrupt input. */
616 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
617 #define POLL_FOR_INPUT
618 #endif
620 /* After a command is executed, if point is moved into a region that
621 has specific properties (e.g. composition, display), we adjust
622 point to the boundary of the region. But, if a command sets this
623 variable to non-nil, we suppress this point adjustment. This
624 variable is set to nil before reading a command. */
626 Lisp_Object Vdisable_point_adjustment;
628 /* If non-nil, always disable point adjustment. */
630 Lisp_Object Vglobal_disable_point_adjustment;
632 /* The time when Emacs started being idle. */
634 static EMACS_TIME timer_idleness_start_time;
636 /* After Emacs stops being idle, this saves the last value
637 of timer_idleness_start_time from when it was idle. */
639 static EMACS_TIME timer_last_idleness_start_time;
642 /* Global variable declarations. */
644 /* Function for init_keyboard to call with no args (if nonzero). */
645 void (*keyboard_init_hook) ();
647 static int read_avail_input P_ ((int));
648 static void get_input_pending P_ ((int *, int));
649 static void get_filtered_input_pending P_ ((int *, int, int));
650 static int readable_events P_ ((int));
651 static int readable_filtered_events P_ ((int, int));
652 static Lisp_Object read_char_x_menu_prompt P_ ((int, Lisp_Object *,
653 Lisp_Object, int *));
654 static Lisp_Object read_char_x_menu_prompt ();
655 static Lisp_Object read_char_minibuf_menu_prompt P_ ((int, int,
656 Lisp_Object *));
657 static Lisp_Object make_lispy_event P_ ((struct input_event *));
658 #ifdef HAVE_MOUSE
659 static Lisp_Object make_lispy_movement P_ ((struct frame *, Lisp_Object,
660 enum scroll_bar_part,
661 Lisp_Object, Lisp_Object,
662 unsigned long));
663 #endif
664 static Lisp_Object modify_event_symbol P_ ((int, unsigned, Lisp_Object,
665 Lisp_Object, char **,
666 Lisp_Object *, unsigned));
667 static Lisp_Object make_lispy_switch_frame P_ ((Lisp_Object));
668 static int parse_solitary_modifier P_ ((Lisp_Object));
669 static int parse_solitary_modifier ();
670 static void save_getcjmp P_ ((jmp_buf));
671 static void save_getcjmp ();
672 static void restore_getcjmp P_ ((jmp_buf));
673 static Lisp_Object apply_modifiers P_ ((int, Lisp_Object));
674 static void clear_event P_ ((struct input_event *));
675 static void any_kboard_state P_ ((void));
676 static SIGTYPE interrupt_signal P_ ((int signalnum));
678 /* Nonzero means don't try to suspend even if the operating system seems
679 to support it. */
680 static int cannot_suspend;
682 /* Install the string STR as the beginning of the string of echoing,
683 so that it serves as a prompt for the next character.
684 Also start echoing. */
686 void
687 echo_prompt (str)
688 Lisp_Object str;
690 current_kboard->echo_string = str;
691 current_kboard->echo_after_prompt = SCHARS (str);
692 echo_now ();
695 /* Add C to the echo string, if echoing is going on.
696 C can be a character, which is printed prettily ("M-C-x" and all that
697 jazz), or a symbol, whose name is printed. */
699 void
700 echo_char (c)
701 Lisp_Object c;
703 if (current_kboard->immediate_echo)
705 int size = KEY_DESCRIPTION_SIZE + 100;
706 char *buffer = (char *) alloca (size);
707 char *ptr = buffer;
708 Lisp_Object echo_string;
710 echo_string = current_kboard->echo_string;
712 /* If someone has passed us a composite event, use its head symbol. */
713 c = EVENT_HEAD (c);
715 if (INTEGERP (c))
717 ptr = push_key_description (XINT (c), ptr, 1);
719 else if (SYMBOLP (c))
721 Lisp_Object name = SYMBOL_NAME (c);
722 int nbytes = SBYTES (name);
724 if (size - (ptr - buffer) < nbytes)
726 int offset = ptr - buffer;
727 size = max (2 * size, size + nbytes);
728 buffer = (char *) alloca (size);
729 ptr = buffer + offset;
732 ptr += copy_text (SDATA (name), ptr, nbytes,
733 STRING_MULTIBYTE (name), 1);
736 if ((NILP (echo_string) || SCHARS (echo_string) == 0)
737 && help_char_p (c))
739 const char *text = " (Type ? for further options)";
740 int len = strlen (text);
742 if (size - (ptr - buffer) < len)
744 int offset = ptr - buffer;
745 size += len;
746 buffer = (char *) alloca (size);
747 ptr = buffer + offset;
750 bcopy (text, ptr, len);
751 ptr += len;
754 /* Replace a dash from echo_dash with a space, otherwise
755 add a space at the end as a separator between keys. */
756 if (STRINGP (echo_string)
757 && SCHARS (echo_string) > 1)
759 Lisp_Object last_char, prev_char, idx;
761 idx = make_number (SCHARS (echo_string) - 2);
762 prev_char = Faref (echo_string, idx);
764 idx = make_number (SCHARS (echo_string) - 1);
765 last_char = Faref (echo_string, idx);
767 /* We test PREV_CHAR to make sure this isn't the echoing
768 of a minus-sign. */
769 if (XINT (last_char) == '-' && XINT (prev_char) != ' ')
770 Faset (echo_string, idx, make_number (' '));
771 else
772 echo_string = concat2 (echo_string, build_string (" "));
775 current_kboard->echo_string
776 = concat2 (echo_string, make_string (buffer, ptr - buffer));
778 echo_now ();
782 /* Temporarily add a dash to the end of the echo string if it's not
783 empty, so that it serves as a mini-prompt for the very next character. */
785 void
786 echo_dash ()
788 /* Do nothing if not echoing at all. */
789 if (NILP (current_kboard->echo_string))
790 return;
792 if (!current_kboard->immediate_echo
793 && SCHARS (current_kboard->echo_string) == 0)
794 return;
796 /* Do nothing if we just printed a prompt. */
797 if (current_kboard->echo_after_prompt
798 == SCHARS (current_kboard->echo_string))
799 return;
801 /* Put a dash at the end of the buffer temporarily,
802 but make it go away when the next character is added. */
803 current_kboard->echo_string = concat2 (current_kboard->echo_string,
804 build_string ("-"));
805 echo_now ();
808 /* Display the current echo string, and begin echoing if not already
809 doing so. */
811 void
812 echo_now ()
814 if (!current_kboard->immediate_echo)
816 int i;
817 current_kboard->immediate_echo = 1;
819 for (i = 0; i < this_command_key_count; i++)
821 Lisp_Object c;
823 /* Set before_command_echo_length to the value that would
824 have been saved before the start of this subcommand in
825 command_loop_1, if we had already been echoing then. */
826 if (i == this_single_command_key_start)
827 before_command_echo_length = echo_length ();
829 c = XVECTOR (this_command_keys)->contents[i];
830 if (! (EVENT_HAS_PARAMETERS (c)
831 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
832 echo_char (c);
835 /* Set before_command_echo_length to the value that would
836 have been saved before the start of this subcommand in
837 command_loop_1, if we had already been echoing then. */
838 if (this_command_key_count == this_single_command_key_start)
839 before_command_echo_length = echo_length ();
841 /* Put a dash at the end to invite the user to type more. */
842 echo_dash ();
845 echoing = 1;
846 message3_nolog (current_kboard->echo_string,
847 SBYTES (current_kboard->echo_string),
848 STRING_MULTIBYTE (current_kboard->echo_string));
849 echoing = 0;
851 /* Record in what buffer we echoed, and from which kboard. */
852 echo_message_buffer = echo_area_buffer[0];
853 echo_kboard = current_kboard;
855 if (waiting_for_input && !NILP (Vquit_flag))
856 quit_throw_to_read_char ();
859 /* Turn off echoing, for the start of a new command. */
861 void
862 cancel_echoing ()
864 current_kboard->immediate_echo = 0;
865 current_kboard->echo_after_prompt = -1;
866 current_kboard->echo_string = Qnil;
867 ok_to_echo_at_next_pause = NULL;
868 echo_kboard = NULL;
869 echo_message_buffer = Qnil;
872 /* Return the length of the current echo string. */
874 static int
875 echo_length ()
877 return (STRINGP (current_kboard->echo_string)
878 ? SCHARS (current_kboard->echo_string)
879 : 0);
882 /* Truncate the current echo message to its first LEN chars.
883 This and echo_char get used by read_key_sequence when the user
884 switches frames while entering a key sequence. */
886 static void
887 echo_truncate (nchars)
888 int nchars;
890 if (STRINGP (current_kboard->echo_string))
891 current_kboard->echo_string
892 = Fsubstring (current_kboard->echo_string,
893 make_number (0), make_number (nchars));
894 truncate_echo_area (nchars);
898 /* Functions for manipulating this_command_keys. */
899 static void
900 add_command_key (key)
901 Lisp_Object key;
903 #if 0 /* Not needed after we made Freset_this_command_lengths
904 do the job immediately. */
905 /* If reset-this-command-length was called recently, obey it now.
906 See the doc string of that function for an explanation of why. */
907 if (before_command_restore_flag)
909 this_command_key_count = before_command_key_count_1;
910 if (this_command_key_count < this_single_command_key_start)
911 this_single_command_key_start = this_command_key_count;
912 echo_truncate (before_command_echo_length_1);
913 before_command_restore_flag = 0;
915 #endif
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_INDEX ();
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_INDEX ();
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 #ifdef HAVE_X_WINDOWS
1118 if (display_hourglass_p)
1119 cancel_hourglass ();
1120 #endif
1122 if (!NILP (executing_macro))
1124 if (executing_macro_iterations == 1)
1125 sprintf (macroerror, "After 1 kbd macro iteration: ");
1126 else
1127 sprintf (macroerror, "After %d kbd macro iterations: ",
1128 executing_macro_iterations);
1130 else
1131 *macroerror = 0;
1133 Vstandard_output = Qt;
1134 Vstandard_input = Qt;
1135 Vexecuting_macro = Qnil;
1136 executing_macro = Qnil;
1137 current_kboard->Vprefix_arg = Qnil;
1138 current_kboard->Vlast_prefix_arg = Qnil;
1139 cancel_echoing ();
1141 /* Avoid unquittable loop if data contains a circular list. */
1142 old_level = Vprint_level;
1143 old_length = Vprint_length;
1144 XSETFASTINT (Vprint_level, 10);
1145 XSETFASTINT (Vprint_length, 10);
1146 cmd_error_internal (data, macroerror);
1147 Vprint_level = old_level;
1148 Vprint_length = old_length;
1150 Vquit_flag = Qnil;
1152 Vinhibit_quit = Qnil;
1153 #ifdef MULTI_KBOARD
1154 any_kboard_state ();
1155 #endif
1157 return make_number (0);
1160 /* Take actions on handling an error. DATA is the data that describes
1161 the error.
1163 CONTEXT is a C-string containing ASCII characters only which
1164 describes the context in which the error happened. If we need to
1165 generalize CONTEXT to allow multibyte characters, make it a Lisp
1166 string. */
1168 void
1169 cmd_error_internal (data, context)
1170 Lisp_Object data;
1171 char *context;
1173 Lisp_Object stream;
1174 int kill_emacs_p = 0;
1175 struct frame *sf = SELECTED_FRAME ();
1177 Vquit_flag = Qnil;
1178 Vinhibit_quit = Qt;
1179 clear_message (1, 0);
1181 /* If the window system or terminal frame hasn't been initialized
1182 yet, or we're not interactive, it's best to dump this message out
1183 to stderr and exit. */
1184 if (!sf->glyphs_initialized_p
1185 /* This is the case of the frame dumped with Emacs, when we're
1186 running under a window system. */
1187 || (!NILP (Vwindow_system)
1188 && !inhibit_window_system
1189 && FRAME_TERMCAP_P (sf))
1190 || noninteractive)
1192 stream = Qexternal_debugging_output;
1193 kill_emacs_p = 1;
1195 else
1197 Fdiscard_input ();
1198 message_log_maybe_newline ();
1199 bitch_at_user ();
1200 stream = Qt;
1203 /* The immediate context is not interesting for Quits,
1204 since they are asyncronous. */
1205 if (EQ (XCAR (data), Qquit))
1206 Vsignaling_function = Qnil;
1208 print_error_message (data, stream, context, Vsignaling_function);
1210 Vsignaling_function = Qnil;
1212 /* If the window system or terminal frame hasn't been initialized
1213 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1214 if (kill_emacs_p)
1216 Fterpri (stream);
1217 Fkill_emacs (make_number (-1));
1221 Lisp_Object command_loop_1 ();
1222 Lisp_Object command_loop_2 ();
1223 Lisp_Object top_level_1 ();
1225 /* Entry to editor-command-loop.
1226 This level has the catches for exiting/returning to editor command loop.
1227 It returns nil to exit recursive edit, t to abort it. */
1229 Lisp_Object
1230 command_loop ()
1232 if (command_loop_level > 0 || minibuf_level > 0)
1234 Lisp_Object val;
1235 val = internal_catch (Qexit, command_loop_2, Qnil);
1236 executing_macro = Qnil;
1237 return val;
1239 else
1240 while (1)
1242 internal_catch (Qtop_level, top_level_1, Qnil);
1243 internal_catch (Qtop_level, command_loop_2, Qnil);
1244 executing_macro = Qnil;
1246 /* End of file in -batch run causes exit here. */
1247 if (noninteractive)
1248 Fkill_emacs (Qt);
1252 /* Here we catch errors in execution of commands within the
1253 editing loop, and reenter the editing loop.
1254 When there is an error, cmd_error runs and returns a non-nil
1255 value to us. A value of nil means that command_loop_1 itself
1256 returned due to end of file (or end of kbd macro). */
1258 Lisp_Object
1259 command_loop_2 ()
1261 register Lisp_Object val;
1264 val = internal_condition_case (command_loop_1, Qerror, cmd_error);
1265 while (!NILP (val));
1267 return Qnil;
1270 Lisp_Object
1271 top_level_2 ()
1273 return Feval (Vtop_level);
1276 Lisp_Object
1277 top_level_1 ()
1279 /* On entry to the outer level, run the startup file */
1280 if (!NILP (Vtop_level))
1281 internal_condition_case (top_level_2, Qerror, cmd_error);
1282 else if (!NILP (Vpurify_flag))
1283 message ("Bare impure Emacs (standard Lisp code not loaded)");
1284 else
1285 message ("Bare Emacs (standard Lisp code not loaded)");
1286 return Qnil;
1289 DEFUN ("top-level", Ftop_level, Stop_level, 0, 0, "",
1290 doc: /* Exit all recursive editing levels. */)
1293 #ifdef HAVE_X_WINDOWS
1294 if (display_hourglass_p)
1295 cancel_hourglass ();
1296 #endif
1297 return Fthrow (Qtop_level, Qnil);
1300 DEFUN ("exit-recursive-edit", Fexit_recursive_edit, Sexit_recursive_edit, 0, 0, "",
1301 doc: /* Exit from the innermost recursive edit or minibuffer. */)
1304 if (command_loop_level > 0 || minibuf_level > 0)
1305 Fthrow (Qexit, Qnil);
1307 error ("No recursive edit is in progress");
1308 return Qnil;
1311 DEFUN ("abort-recursive-edit", Fabort_recursive_edit, Sabort_recursive_edit, 0, 0, "",
1312 doc: /* Abort the command that requested this recursive edit or minibuffer input. */)
1315 if (command_loop_level > 0 || minibuf_level > 0)
1316 Fthrow (Qexit, Qt);
1318 error ("No recursive edit is in progress");
1319 return Qnil;
1322 /* This is the actual command reading loop,
1323 sans error-handling encapsulation. */
1325 static int read_key_sequence P_ ((Lisp_Object *, int, Lisp_Object,
1326 int, int, int));
1327 void safe_run_hooks P_ ((Lisp_Object));
1328 static void adjust_point_for_property P_ ((int, int));
1330 /* Cancel hourglass from protect_unwind.
1331 ARG is not used. */
1332 #ifdef HAVE_X_WINDOWS
1333 static Lisp_Object
1334 cancel_hourglass_unwind (arg)
1335 Lisp_Object arg;
1337 cancel_hourglass ();
1339 #endif
1341 Lisp_Object
1342 command_loop_1 ()
1344 Lisp_Object cmd;
1345 int lose;
1346 int nonundocount;
1347 Lisp_Object keybuf[30];
1348 int i;
1349 int no_direct;
1350 int prev_modiff;
1351 struct buffer *prev_buffer = NULL;
1352 #ifdef MULTI_KBOARD
1353 int was_locked = single_kboard;
1354 #endif
1355 int already_adjusted;
1357 current_kboard->Vprefix_arg = Qnil;
1358 current_kboard->Vlast_prefix_arg = Qnil;
1359 Vdeactivate_mark = Qnil;
1360 waiting_for_input = 0;
1361 cancel_echoing ();
1363 nonundocount = 0;
1364 this_command_key_count = 0;
1365 this_command_key_count_reset = 0;
1366 this_single_command_key_start = 0;
1368 if (NILP (Vmemory_full))
1370 /* Make sure this hook runs after commands that get errors and
1371 throw to top level. */
1372 /* Note that the value cell will never directly contain nil
1373 if the symbol is a local variable. */
1374 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1375 safe_run_hooks (Qpost_command_hook);
1377 /* If displaying a message, resize the echo area window to fit
1378 that message's size exactly. */
1379 if (!NILP (echo_area_buffer[0]))
1380 resize_echo_area_exactly ();
1382 if (!NILP (Vdeferred_action_list))
1383 call0 (Vdeferred_action_function);
1385 if (!NILP (Vpost_command_idle_hook) && !NILP (Vrun_hooks))
1387 if (NILP (Vunread_command_events)
1388 && NILP (Vunread_input_method_events)
1389 && NILP (Vunread_post_input_method_events)
1390 && NILP (Vexecuting_macro)
1391 && !NILP (sit_for (0, post_command_idle_delay, 0, 1, 1)))
1392 safe_run_hooks (Qpost_command_idle_hook);
1396 Vmemory_full = Qnil;
1398 /* Do this after running Vpost_command_hook, for consistency. */
1399 current_kboard->Vlast_command = Vthis_command;
1400 current_kboard->Vreal_last_command = real_this_command;
1402 while (1)
1404 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1405 Fkill_emacs (Qnil);
1407 /* Make sure the current window's buffer is selected. */
1408 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1409 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1411 /* Display any malloc warning that just came out. Use while because
1412 displaying one warning can cause another. */
1414 while (pending_malloc_warning)
1415 display_malloc_warning ();
1417 no_direct = 0;
1419 Vdeactivate_mark = Qnil;
1421 /* If minibuffer on and echo area in use,
1422 wait a short time and redraw minibuffer. */
1424 if (minibuf_level
1425 && !NILP (echo_area_buffer[0])
1426 && EQ (minibuf_window, echo_area_window)
1427 && NUMBERP (Vminibuffer_message_timeout))
1429 /* Bind inhibit-quit to t so that C-g gets read in
1430 rather than quitting back to the minibuffer. */
1431 int count = SPECPDL_INDEX ();
1432 specbind (Qinhibit_quit, Qt);
1434 Fsit_for (Vminibuffer_message_timeout, Qnil, Qnil);
1435 /* Clear the echo area. */
1436 message2 (0, 0, 0);
1437 safe_run_hooks (Qecho_area_clear_hook);
1439 unbind_to (count, Qnil);
1441 /* If a C-g came in before, treat it as input now. */
1442 if (!NILP (Vquit_flag))
1444 Vquit_flag = Qnil;
1445 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
1449 #ifdef C_ALLOCA
1450 alloca (0); /* Cause a garbage collection now */
1451 /* Since we can free the most stuff here. */
1452 #endif /* C_ALLOCA */
1454 #if 0
1455 /* Select the frame that the last event came from. Usually,
1456 switch-frame events will take care of this, but if some lisp
1457 code swallows a switch-frame event, we'll fix things up here.
1458 Is this a good idea? */
1459 if (FRAMEP (internal_last_event_frame)
1460 && !EQ (internal_last_event_frame, selected_frame))
1461 Fselect_frame (internal_last_event_frame, Qnil);
1462 #endif
1463 /* If it has changed current-menubar from previous value,
1464 really recompute the menubar from the value. */
1465 if (! NILP (Vlucid_menu_bar_dirty_flag)
1466 && !NILP (Ffboundp (Qrecompute_lucid_menubar)))
1467 call0 (Qrecompute_lucid_menubar);
1469 before_command_key_count = this_command_key_count;
1470 before_command_echo_length = echo_length ();
1472 Vthis_command = Qnil;
1473 real_this_command = Qnil;
1475 /* Read next key sequence; i gets its length. */
1476 i = read_key_sequence (keybuf, sizeof keybuf / sizeof keybuf[0],
1477 Qnil, 0, 1, 1);
1479 /* A filter may have run while we were reading the input. */
1480 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
1481 Fkill_emacs (Qnil);
1482 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
1483 set_buffer_internal (XBUFFER (XWINDOW (selected_window)->buffer));
1485 ++num_input_keys;
1487 /* Now we have read a key sequence of length I,
1488 or else I is 0 and we found end of file. */
1490 if (i == 0) /* End of file -- happens only in */
1491 return Qnil; /* a kbd macro, at the end. */
1492 /* -1 means read_key_sequence got a menu that was rejected.
1493 Just loop around and read another command. */
1494 if (i == -1)
1496 cancel_echoing ();
1497 this_command_key_count = 0;
1498 this_command_key_count_reset = 0;
1499 this_single_command_key_start = 0;
1500 goto finalize;
1503 last_command_char = keybuf[i - 1];
1505 /* If the previous command tried to force a specific window-start,
1506 forget about that, in case this command moves point far away
1507 from that position. But also throw away beg_unchanged and
1508 end_unchanged information in that case, so that redisplay will
1509 update the whole window properly. */
1510 if (!NILP (XWINDOW (selected_window)->force_start))
1512 struct buffer *b;
1513 XWINDOW (selected_window)->force_start = Qnil;
1514 b = XBUFFER (XWINDOW (selected_window)->buffer);
1515 BUF_BEG_UNCHANGED (b) = BUF_END_UNCHANGED (b) = 0;
1518 cmd = read_key_sequence_cmd;
1519 if (!NILP (Vexecuting_macro))
1521 if (!NILP (Vquit_flag))
1523 Vexecuting_macro = Qt;
1524 QUIT; /* Make some noise. */
1525 /* Will return since macro now empty. */
1529 /* Do redisplay processing after this command except in special
1530 cases identified below. */
1531 prev_buffer = current_buffer;
1532 prev_modiff = MODIFF;
1533 last_point_position = PT;
1534 XSETBUFFER (last_point_position_buffer, prev_buffer);
1536 /* By default, we adjust point to a boundary of a region that
1537 has such a property that should be treated intangible
1538 (e.g. composition, display). But, some commands will set
1539 this variable differently. */
1540 Vdisable_point_adjustment = Qnil;
1542 /* Process filters and timers may have messed with deactivate-mark.
1543 reset it before we execute the command. */
1544 Vdeactivate_mark = Qnil;
1546 /* Remap command through active keymaps */
1547 Vthis_original_command = cmd;
1548 if (SYMBOLP (cmd))
1550 Lisp_Object cmd1;
1551 if (cmd1 = Fcommand_remapping (cmd), !NILP (cmd1))
1552 cmd = cmd1;
1555 /* Execute the command. */
1557 Vthis_command = cmd;
1558 real_this_command = cmd;
1559 /* Note that the value cell will never directly contain nil
1560 if the symbol is a local variable. */
1561 if (!NILP (Vpre_command_hook) && !NILP (Vrun_hooks))
1562 safe_run_hooks (Qpre_command_hook);
1564 already_adjusted = 0;
1566 if (NILP (Vthis_command))
1568 /* nil means key is undefined. */
1569 bitch_at_user ();
1570 current_kboard->defining_kbd_macro = Qnil;
1571 update_mode_lines = 1;
1572 current_kboard->Vprefix_arg = Qnil;
1574 else
1576 if (NILP (current_kboard->Vprefix_arg) && ! no_direct)
1578 /* In case we jump to directly_done. */
1579 Vcurrent_prefix_arg = current_kboard->Vprefix_arg;
1581 /* Recognize some common commands in common situations and
1582 do them directly. */
1583 if (EQ (Vthis_command, Qforward_char) && PT < ZV)
1585 struct Lisp_Char_Table *dp
1586 = window_display_table (XWINDOW (selected_window));
1587 lose = FETCH_CHAR (PT_BYTE);
1588 SET_PT (PT + 1);
1589 if (! NILP (Vpost_command_hook))
1590 /* Put this before calling adjust_point_for_property
1591 so it will only get called once in any case. */
1592 goto directly_done;
1593 if (current_buffer == prev_buffer
1594 && last_point_position != PT
1595 && NILP (Vdisable_point_adjustment)
1596 && NILP (Vglobal_disable_point_adjustment))
1597 adjust_point_for_property (last_point_position, 0);
1598 already_adjusted = 1;
1599 if (PT == last_point_position + 1
1600 && (dp
1601 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1602 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1603 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1604 && (lose >= 0x20 && lose < 0x7f)))
1605 : (lose >= 0x20 && lose < 0x7f))
1606 /* To extract the case of continuation on
1607 wide-column characters. */
1608 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE)) == 1)
1609 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1610 >= MODIFF)
1611 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1612 >= OVERLAY_MODIFF)
1613 && (XFASTINT (XWINDOW (selected_window)->last_point)
1614 == PT - 1)
1615 && !windows_or_buffers_changed
1616 && EQ (current_buffer->selective_display, Qnil)
1617 && !detect_input_pending ()
1618 && NILP (XWINDOW (selected_window)->column_number_displayed)
1619 && NILP (Vexecuting_macro))
1620 direct_output_forward_char (1);
1621 goto directly_done;
1623 else if (EQ (Vthis_command, Qbackward_char) && PT > BEGV)
1625 struct Lisp_Char_Table *dp
1626 = window_display_table (XWINDOW (selected_window));
1627 SET_PT (PT - 1);
1628 lose = FETCH_CHAR (PT_BYTE);
1629 if (! NILP (Vpost_command_hook))
1630 goto directly_done;
1631 if (current_buffer == prev_buffer
1632 && last_point_position != PT
1633 && NILP (Vdisable_point_adjustment)
1634 && NILP (Vglobal_disable_point_adjustment))
1635 adjust_point_for_property (last_point_position, 0);
1636 already_adjusted = 1;
1637 if (PT == last_point_position - 1
1638 && (dp
1639 ? (VECTORP (DISP_CHAR_VECTOR (dp, lose))
1640 ? XVECTOR (DISP_CHAR_VECTOR (dp, lose))->size == 1
1641 : (NILP (DISP_CHAR_VECTOR (dp, lose))
1642 && (lose >= 0x20 && lose < 0x7f)))
1643 : (lose >= 0x20 && lose < 0x7f))
1644 && (XFASTINT (XWINDOW (selected_window)->last_modified)
1645 >= MODIFF)
1646 && (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1647 >= OVERLAY_MODIFF)
1648 && (XFASTINT (XWINDOW (selected_window)->last_point)
1649 == PT + 1)
1650 && !windows_or_buffers_changed
1651 && EQ (current_buffer->selective_display, Qnil)
1652 && !detect_input_pending ()
1653 && NILP (XWINDOW (selected_window)->column_number_displayed)
1654 && NILP (Vexecuting_macro))
1655 direct_output_forward_char (-1);
1656 goto directly_done;
1658 else if (EQ (Vthis_command, Qself_insert_command)
1659 /* Try this optimization only on char keystrokes. */
1660 && NATNUMP (last_command_char)
1661 && CHAR_VALID_P (XFASTINT (last_command_char), 0))
1663 unsigned int c
1664 = translate_char (Vtranslation_table_for_input,
1665 XFASTINT (last_command_char), 0, 0, 0);
1666 int value;
1667 if (NILP (Vexecuting_macro)
1668 && !EQ (minibuf_window, selected_window))
1670 if (!nonundocount || nonundocount >= 20)
1672 Fundo_boundary ();
1673 nonundocount = 0;
1675 nonundocount++;
1678 lose = ((XFASTINT (XWINDOW (selected_window)->last_modified)
1679 < MODIFF)
1680 || (XFASTINT (XWINDOW (selected_window)->last_overlay_modified)
1681 < OVERLAY_MODIFF)
1682 || (XFASTINT (XWINDOW (selected_window)->last_point)
1683 != PT)
1684 || MODIFF <= SAVE_MODIFF
1685 || windows_or_buffers_changed
1686 || !EQ (current_buffer->selective_display, Qnil)
1687 || detect_input_pending ()
1688 || !NILP (XWINDOW (selected_window)->column_number_displayed)
1689 || !NILP (Vexecuting_macro));
1691 value = internal_self_insert (c, 0);
1693 if (value == 2)
1694 nonundocount = 0;
1696 if (! NILP (Vpost_command_hook))
1697 /* Put this before calling adjust_point_for_property
1698 so it will only get called once in any case. */
1699 goto directly_done;
1701 /* VALUE == 1 when AFTER-CHANGE functions are
1702 installed which is the case most of the time
1703 because FONT-LOCK installs one. */
1704 if (!lose && !value)
1705 direct_output_for_insert (c);
1706 goto directly_done;
1710 /* Here for a command that isn't executed directly */
1713 #ifdef HAVE_X_WINDOWS
1714 int scount = SPECPDL_INDEX ();
1716 if (display_hourglass_p
1717 && NILP (Vexecuting_macro))
1719 record_unwind_protect (cancel_hourglass_unwind, Qnil);
1720 start_hourglass ();
1722 #endif
1724 nonundocount = 0;
1725 if (NILP (current_kboard->Vprefix_arg))
1726 Fundo_boundary ();
1727 Fcommand_execute (Vthis_command, Qnil, Qnil, Qnil);
1729 #ifdef HAVE_X_WINDOWS
1730 /* Do not check display_hourglass_p here, because
1731 Fcommand_execute could change it, but we should cancel
1732 hourglass cursor anyway.
1733 But don't cancel the hourglass within a macro
1734 just because a command in the macro finishes. */
1735 if (NILP (Vexecuting_macro))
1736 unbind_to (scount, Qnil);
1737 #endif
1740 directly_done: ;
1741 current_kboard->Vlast_prefix_arg = Vcurrent_prefix_arg;
1743 /* Note that the value cell will never directly contain nil
1744 if the symbol is a local variable. */
1745 if (!NILP (Vpost_command_hook) && !NILP (Vrun_hooks))
1746 safe_run_hooks (Qpost_command_hook);
1748 /* If displaying a message, resize the echo area window to fit
1749 that message's size exactly. */
1750 if (!NILP (echo_area_buffer[0]))
1751 resize_echo_area_exactly ();
1753 if (!NILP (Vdeferred_action_list))
1754 safe_run_hooks (Qdeferred_action_function);
1756 if (!NILP (Vpost_command_idle_hook) && !NILP (Vrun_hooks))
1758 if (NILP (Vunread_command_events)
1759 && NILP (Vunread_input_method_events)
1760 && NILP (Vunread_post_input_method_events)
1761 && NILP (Vexecuting_macro)
1762 && !NILP (sit_for (0, post_command_idle_delay, 0, 1, 1)))
1763 safe_run_hooks (Qpost_command_idle_hook);
1766 /* If there is a prefix argument,
1767 1) We don't want Vlast_command to be ``universal-argument''
1768 (that would be dumb), so don't set Vlast_command,
1769 2) we want to leave echoing on so that the prefix will be
1770 echoed as part of this key sequence, so don't call
1771 cancel_echoing, and
1772 3) we want to leave this_command_key_count non-zero, so that
1773 read_char will realize that it is re-reading a character, and
1774 not echo it a second time.
1776 If the command didn't actually create a prefix arg,
1777 but is merely a frame event that is transparent to prefix args,
1778 then the above doesn't apply. */
1779 if (NILP (current_kboard->Vprefix_arg) || CONSP (last_command_char))
1781 current_kboard->Vlast_command = Vthis_command;
1782 current_kboard->Vreal_last_command = real_this_command;
1783 cancel_echoing ();
1784 this_command_key_count = 0;
1785 this_command_key_count_reset = 0;
1786 this_single_command_key_start = 0;
1789 if (!NILP (current_buffer->mark_active) && !NILP (Vrun_hooks))
1791 if (!NILP (Vdeactivate_mark) && !NILP (Vtransient_mark_mode))
1793 /* We could also call `deactivate'mark'. */
1794 if (EQ (Vtransient_mark_mode, Qlambda))
1795 Vtransient_mark_mode = Qnil;
1796 else
1798 current_buffer->mark_active = Qnil;
1799 call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
1802 else if (current_buffer != prev_buffer || MODIFF != prev_modiff)
1803 call1 (Vrun_hooks, intern ("activate-mark-hook"));
1806 finalize:
1808 if (current_buffer == prev_buffer
1809 && last_point_position != PT
1810 && NILP (Vdisable_point_adjustment)
1811 && NILP (Vglobal_disable_point_adjustment)
1812 && !already_adjusted)
1813 adjust_point_for_property (last_point_position, MODIFF != prev_modiff);
1815 /* Install chars successfully executed in kbd macro. */
1817 if (!NILP (current_kboard->defining_kbd_macro)
1818 && NILP (current_kboard->Vprefix_arg))
1819 finalize_kbd_macro_chars ();
1821 #ifdef MULTI_KBOARD
1822 if (!was_locked)
1823 any_kboard_state ();
1824 #endif
1828 extern Lisp_Object Qcomposition, Qdisplay;
1830 /* Adjust point to a boundary of a region that has such a property
1831 that should be treated intangible. For the moment, we check
1832 `composition', `display' and `invisible' properties.
1833 LAST_PT is the last position of point. */
1835 extern Lisp_Object Qafter_string, Qbefore_string;
1836 extern Lisp_Object get_pos_property P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
1838 static void
1839 adjust_point_for_property (last_pt, modified)
1840 int last_pt;
1841 int modified;
1843 int beg, end;
1844 Lisp_Object val, overlay, tmp;
1845 int check_composition = 1, check_display = 1, check_invisible = 1;
1846 int orig_pt = PT;
1848 /* FIXME: cycling is probably not necessary because these properties
1849 can't be usefully combined anyway. */
1850 while (check_composition || check_display || check_invisible)
1852 if (check_composition
1853 && PT > BEGV && PT < ZV
1854 && get_property_and_range (PT, Qcomposition, &val, &beg, &end, Qnil)
1855 && COMPOSITION_VALID_P (beg, end, val)
1856 && beg < PT /* && end > PT <- It's always the case. */
1857 && (last_pt <= beg || last_pt >= end))
1859 xassert (end > PT);
1860 SET_PT (PT < last_pt ? beg : end);
1861 check_display = check_invisible = 1;
1863 check_composition = 0;
1864 if (check_display
1865 && PT > BEGV && PT < ZV
1866 && !NILP (val = get_char_property_and_overlay
1867 (make_number (PT), Qdisplay, Qnil, &overlay))
1868 && display_prop_intangible_p (val)
1869 && (!OVERLAYP (overlay)
1870 ? get_property_and_range (PT, Qdisplay, &val, &beg, &end, Qnil)
1871 : (beg = OVERLAY_POSITION (OVERLAY_START (overlay)),
1872 end = OVERLAY_POSITION (OVERLAY_END (overlay))))
1873 && beg < PT) /* && end > PT <- It's always the case. */
1875 xassert (end > PT);
1876 SET_PT (PT < last_pt ? beg : end);
1877 check_composition = check_invisible = 1;
1879 check_display = 0;
1880 if (check_invisible && PT > BEGV && PT < ZV)
1882 int inv, ellipsis = 0;
1883 beg = end = PT;
1885 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1886 while (end < ZV
1887 && !NILP (val = get_char_property_and_overlay
1888 (make_number (end), Qinvisible, Qnil, &overlay))
1889 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
1891 ellipsis = ellipsis || inv > 1
1892 || (OVERLAYP (overlay)
1893 && (!NILP (Foverlay_get (overlay, Qafter_string))
1894 || !NILP (Foverlay_get (overlay, Qbefore_string))));
1895 tmp = Fnext_single_char_property_change
1896 (make_number (end), Qinvisible, Qnil, Qnil);
1897 end = NATNUMP (tmp) ? XFASTINT (tmp) : ZV;
1899 while (beg > BEGV
1900 && !NILP (val = get_char_property_and_overlay
1901 (make_number (beg - 1), Qinvisible, Qnil, &overlay))
1902 && (inv = TEXT_PROP_MEANS_INVISIBLE (val)))
1904 ellipsis = ellipsis || inv > 1
1905 || (OVERLAYP (overlay)
1906 && (!NILP (Foverlay_get (overlay, Qafter_string))
1907 || !NILP (Foverlay_get (overlay, Qbefore_string))));
1908 tmp = Fprevious_single_char_property_change
1909 (make_number (beg), Qinvisible, Qnil, Qnil);
1910 beg = NATNUMP (tmp) ? XFASTINT (tmp) : BEGV;
1913 /* Move away from the inside area. */
1914 if (beg < PT && end > PT)
1916 SET_PT ((orig_pt == PT && (last_pt < beg || last_pt > end))
1917 /* We haven't moved yet (so we don't need to fear
1918 infinite-looping) and we were outside the range
1919 before (so either end of the range still corresponds
1920 to a move in the right direction): pretend we moved
1921 less than we actually did, so that we still have
1922 more freedom below in choosing which end of the range
1923 to go to. */
1924 ? (orig_pt = -1, PT < last_pt ? end : beg)
1925 /* We either have moved already or the last point
1926 was already in the range: we don't get to choose
1927 which end of the range we have to go to. */
1928 : (PT < last_pt ? beg : end));
1929 check_composition = check_display = 1;
1931 xassert (PT == beg || PT == end);
1932 /* Pretend the area doesn't exist if the buffer is not
1933 modified. */
1934 if (!modified && !ellipsis && beg < end)
1936 if (last_pt == beg && PT == end && end < ZV)
1937 (check_composition = check_display = 1, SET_PT (end + 1));
1938 else if (last_pt == end && PT == beg && beg > BEGV)
1939 (check_composition = check_display = 1, SET_PT (beg - 1));
1940 else if (PT == ((PT < last_pt) ? beg : end))
1941 /* We've already moved as far as we can. Trying to go
1942 to the other end would mean moving backwards and thus
1943 could lead to an infinite loop. */
1945 else if (val = get_pos_property (make_number (PT),
1946 Qinvisible, Qnil),
1947 TEXT_PROP_MEANS_INVISIBLE (val)
1948 && (val = get_pos_property
1949 (make_number (PT == beg ? end : beg),
1950 Qinvisible, Qnil),
1951 !TEXT_PROP_MEANS_INVISIBLE (val)))
1952 (check_composition = check_display = 1,
1953 SET_PT (PT == beg ? end : beg));
1956 check_invisible = 0;
1960 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1962 static Lisp_Object
1963 safe_run_hooks_1 (hook)
1964 Lisp_Object hook;
1966 return call1 (Vrun_hooks, Vinhibit_quit);
1969 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
1971 static Lisp_Object
1972 safe_run_hooks_error (data)
1973 Lisp_Object data;
1975 Lisp_Object args[3];
1976 args[0] = build_string ("Error in %s: %s");
1977 args[1] = Vinhibit_quit;
1978 args[2] = data;
1979 Fmessage (3, args);
1980 return Fset (Vinhibit_quit, Qnil);
1983 /* If we get an error while running the hook, cause the hook variable
1984 to be nil. Also inhibit quits, so that C-g won't cause the hook
1985 to mysteriously evaporate. */
1987 void
1988 safe_run_hooks (hook)
1989 Lisp_Object hook;
1991 int count = SPECPDL_INDEX ();
1992 specbind (Qinhibit_quit, hook);
1994 internal_condition_case (safe_run_hooks_1, Qt, safe_run_hooks_error);
1996 unbind_to (count, Qnil);
2000 /* Number of seconds between polling for input. This is a Lisp
2001 variable that can be bound. */
2003 EMACS_INT polling_period;
2005 /* Nonzero means polling for input is temporarily suppressed. */
2007 int poll_suppress_count;
2009 /* Asynchronous timer for polling. */
2011 struct atimer *poll_timer;
2014 #ifdef POLL_FOR_INPUT
2016 /* Poll for input, so what we catch a C-g if it comes in. This
2017 function is called from x_make_frame_visible, see comment
2018 there. */
2020 void
2021 poll_for_input_1 ()
2023 if (interrupt_input_blocked == 0
2024 && !waiting_for_input)
2025 read_avail_input (0);
2028 /* Timer callback function for poll_timer. TIMER is equal to
2029 poll_timer. */
2031 void
2032 poll_for_input (timer)
2033 struct atimer *timer;
2035 if (poll_suppress_count == 0)
2036 poll_for_input_1 ();
2039 #endif /* POLL_FOR_INPUT */
2041 /* Begin signals to poll for input, if they are appropriate.
2042 This function is called unconditionally from various places. */
2044 void
2045 start_polling ()
2047 #ifdef POLL_FOR_INPUT
2048 if (read_socket_hook && !interrupt_input)
2050 /* Turn alarm handling on unconditionally. It might have
2051 been turned off in process.c. */
2052 turn_on_atimers (1);
2054 /* If poll timer doesn't exist, are we need one with
2055 a different interval, start a new one. */
2056 if (poll_timer == NULL
2057 || EMACS_SECS (poll_timer->interval) != polling_period)
2059 EMACS_TIME interval;
2061 if (poll_timer)
2062 cancel_atimer (poll_timer);
2064 EMACS_SET_SECS_USECS (interval, polling_period, 0);
2065 poll_timer = start_atimer (ATIMER_CONTINUOUS, interval,
2066 poll_for_input, NULL);
2069 /* Let the timer's callback function poll for input
2070 if this becomes zero. */
2071 --poll_suppress_count;
2073 #endif
2076 /* Nonzero if we are using polling to handle input asynchronously. */
2079 input_polling_used ()
2081 #ifdef POLL_FOR_INPUT
2082 return read_socket_hook && !interrupt_input;
2083 #else
2084 return 0;
2085 #endif
2088 /* Turn off polling. */
2090 void
2091 stop_polling ()
2093 #ifdef POLL_FOR_INPUT
2094 if (read_socket_hook && !interrupt_input)
2095 ++poll_suppress_count;
2096 #endif
2099 /* Set the value of poll_suppress_count to COUNT
2100 and start or stop polling accordingly. */
2102 void
2103 set_poll_suppress_count (count)
2104 int count;
2106 #ifdef POLL_FOR_INPUT
2107 if (count == 0 && poll_suppress_count != 0)
2109 poll_suppress_count = 1;
2110 start_polling ();
2112 else if (count != 0 && poll_suppress_count == 0)
2114 stop_polling ();
2116 poll_suppress_count = count;
2117 #endif
2120 /* Bind polling_period to a value at least N.
2121 But don't decrease it. */
2123 void
2124 bind_polling_period (n)
2125 int n;
2127 #ifdef POLL_FOR_INPUT
2128 int new = polling_period;
2130 if (n > new)
2131 new = n;
2133 stop_other_atimers (poll_timer);
2134 stop_polling ();
2135 specbind (Qpolling_period, make_number (new));
2136 /* Start a new alarm with the new period. */
2137 start_polling ();
2138 #endif
2141 /* Apply the control modifier to CHARACTER. */
2144 make_ctrl_char (c)
2145 int c;
2147 /* Save the upper bits here. */
2148 int upper = c & ~0177;
2150 c &= 0177;
2152 /* Everything in the columns containing the upper-case letters
2153 denotes a control character. */
2154 if (c >= 0100 && c < 0140)
2156 int oc = c;
2157 c &= ~0140;
2158 /* Set the shift modifier for a control char
2159 made from a shifted letter. But only for letters! */
2160 if (oc >= 'A' && oc <= 'Z')
2161 c |= shift_modifier;
2164 /* The lower-case letters denote control characters too. */
2165 else if (c >= 'a' && c <= 'z')
2166 c &= ~0140;
2168 /* Include the bits for control and shift
2169 only if the basic ASCII code can't indicate them. */
2170 else if (c >= ' ')
2171 c |= ctrl_modifier;
2173 /* Replace the high bits. */
2174 c |= (upper & ~ctrl_modifier);
2176 return c;
2179 /* Display help echo in the echo area.
2181 HELP a string means display that string, HELP nil means clear the
2182 help echo. If HELP is a function, call it with OBJECT and POS as
2183 arguments; the function should return a help string or nil for
2184 none. For all other types of HELP evaluate it to obtain a string.
2186 WINDOW is the window in which the help was generated, if any.
2187 It is nil if not in a window.
2189 If OBJECT is a buffer, POS is the position in the buffer where the
2190 `help-echo' text property was found.
2192 If OBJECT is an overlay, that overlay has a `help-echo' property,
2193 and POS is the position in the overlay's buffer under the mouse.
2195 If OBJECT is a string (an overlay string or a string displayed with
2196 the `display' property). POS is the position in that string under
2197 the mouse.
2199 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2200 echo overwrites a keystroke echo currently displayed in the echo
2201 area.
2203 Note: this function may only be called with HELP nil or a string
2204 from X code running asynchronously. */
2206 void
2207 show_help_echo (help, window, object, pos, ok_to_overwrite_keystroke_echo)
2208 Lisp_Object help, window, object, pos;
2209 int ok_to_overwrite_keystroke_echo;
2211 if (!NILP (help) && !STRINGP (help))
2213 if (FUNCTIONP (help))
2215 Lisp_Object args[4];
2216 args[0] = help;
2217 args[1] = window;
2218 args[2] = object;
2219 args[3] = pos;
2220 help = safe_call (4, args);
2222 else
2223 help = safe_eval (help);
2225 if (!STRINGP (help))
2226 return;
2229 if (STRINGP (help) || NILP (help))
2231 if (!NILP (Vshow_help_function))
2232 call1 (Vshow_help_function, help);
2233 else if (/* Don't overwrite minibuffer contents. */
2234 !MINI_WINDOW_P (XWINDOW (selected_window))
2235 /* Don't overwrite a keystroke echo. */
2236 && (NILP (echo_message_buffer)
2237 || ok_to_overwrite_keystroke_echo)
2238 /* Don't overwrite a prompt. */
2239 && !cursor_in_echo_area)
2241 if (STRINGP (help))
2243 int count = SPECPDL_INDEX ();
2245 if (!help_echo_showing_p)
2246 Vpre_help_message = current_message ();
2248 specbind (Qmessage_truncate_lines, Qt);
2249 message3_nolog (help, SBYTES (help),
2250 STRING_MULTIBYTE (help));
2251 unbind_to (count, Qnil);
2253 else if (STRINGP (Vpre_help_message))
2255 message3_nolog (Vpre_help_message,
2256 SBYTES (Vpre_help_message),
2257 STRING_MULTIBYTE (Vpre_help_message));
2258 Vpre_help_message = Qnil;
2260 else
2261 message (0);
2264 help_echo_showing_p = STRINGP (help);
2270 /* Input of single characters from keyboard */
2272 Lisp_Object print_help ();
2273 static Lisp_Object kbd_buffer_get_event ();
2274 static void record_char ();
2276 #ifdef MULTI_KBOARD
2277 static jmp_buf wrong_kboard_jmpbuf;
2278 #endif
2280 #define STOP_POLLING \
2281 do { if (! polling_stopped_here) stop_polling (); \
2282 polling_stopped_here = 1; } while (0)
2284 #define RESUME_POLLING \
2285 do { if (polling_stopped_here) start_polling (); \
2286 polling_stopped_here = 0; } while (0)
2288 /* read a character from the keyboard; call the redisplay if needed */
2289 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2290 -1 means do not do redisplay, but do do autosaving.
2291 1 means do both. */
2293 /* The arguments MAPS and NMAPS are for menu prompting.
2294 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2296 PREV_EVENT is the previous input event, or nil if we are reading
2297 the first event of a key sequence (or not reading a key sequence).
2298 If PREV_EVENT is t, that is a "magic" value that says
2299 not to run input methods, but in other respects to act as if
2300 not reading a key sequence.
2302 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2303 if we used a mouse menu to read the input, or zero otherwise. If
2304 USED_MOUSE_MENU is null, we don't dereference it.
2306 Value is t if we showed a menu and the user rejected it. */
2308 Lisp_Object
2309 read_char (commandflag, nmaps, maps, prev_event, used_mouse_menu)
2310 int commandflag;
2311 int nmaps;
2312 Lisp_Object *maps;
2313 Lisp_Object prev_event;
2314 int *used_mouse_menu;
2316 volatile Lisp_Object c;
2317 int count;
2318 jmp_buf local_getcjmp;
2319 jmp_buf save_jump;
2320 volatile int key_already_recorded = 0;
2321 Lisp_Object tem, save;
2322 volatile Lisp_Object previous_echo_area_message;
2323 volatile Lisp_Object also_record;
2324 volatile int reread;
2325 struct gcpro gcpro1, gcpro2;
2326 EMACS_TIME last_idle_start;
2327 int polling_stopped_here = 0;
2329 also_record = Qnil;
2331 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2332 before_command_key_count = this_command_key_count;
2333 before_command_echo_length = echo_length ();
2334 #endif
2335 c = Qnil;
2336 previous_echo_area_message = Qnil;
2338 GCPRO2 (c, previous_echo_area_message);
2340 retry:
2342 reread = 0;
2343 if (CONSP (Vunread_post_input_method_events))
2345 c = XCAR (Vunread_post_input_method_events);
2346 Vunread_post_input_method_events
2347 = XCDR (Vunread_post_input_method_events);
2349 /* Undo what read_char_x_menu_prompt did when it unread
2350 additional keys returned by Fx_popup_menu. */
2351 if (CONSP (c)
2352 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2353 && NILP (XCDR (c)))
2354 c = XCAR (c);
2356 reread = 1;
2357 goto reread_first;
2360 if (unread_command_char != -1)
2362 XSETINT (c, unread_command_char);
2363 unread_command_char = -1;
2365 reread = 1;
2366 goto reread_first;
2369 if (CONSP (Vunread_command_events))
2371 c = XCAR (Vunread_command_events);
2372 Vunread_command_events = XCDR (Vunread_command_events);
2374 /* Undo what read_char_x_menu_prompt did when it unread
2375 additional keys returned by Fx_popup_menu. */
2376 if (CONSP (c)
2377 && EQ (XCDR (c), Qdisabled)
2378 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c))))
2379 c = XCAR (c);
2381 /* If the queued event is something that used the mouse,
2382 set used_mouse_menu accordingly. */
2383 if (used_mouse_menu
2384 && (EQ (c, Qtool_bar) || EQ (c, Qmenu_bar)))
2385 *used_mouse_menu = 1;
2387 reread = 1;
2388 goto reread_for_input_method;
2391 if (CONSP (Vunread_input_method_events))
2393 c = XCAR (Vunread_input_method_events);
2394 Vunread_input_method_events = XCDR (Vunread_input_method_events);
2396 /* Undo what read_char_x_menu_prompt did when it unread
2397 additional keys returned by Fx_popup_menu. */
2398 if (CONSP (c)
2399 && (SYMBOLP (XCAR (c)) || INTEGERP (XCAR (c)))
2400 && NILP (XCDR (c)))
2401 c = XCAR (c);
2402 reread = 1;
2403 goto reread_for_input_method;
2406 this_command_key_count_reset = 0;
2408 if (!NILP (Vexecuting_macro))
2410 /* We set this to Qmacro; since that's not a frame, nobody will
2411 try to switch frames on us, and the selected window will
2412 remain unchanged.
2414 Since this event came from a macro, it would be misleading to
2415 leave internal_last_event_frame set to wherever the last
2416 real event came from. Normally, a switch-frame event selects
2417 internal_last_event_frame after each command is read, but
2418 events read from a macro should never cause a new frame to be
2419 selected. */
2420 Vlast_event_frame = internal_last_event_frame = Qmacro;
2422 /* Exit the macro if we are at the end.
2423 Also, some things replace the macro with t
2424 to force an early exit. */
2425 if (EQ (Vexecuting_macro, Qt)
2426 || executing_macro_index >= XFASTINT (Flength (Vexecuting_macro)))
2428 XSETINT (c, -1);
2429 goto exit;
2432 c = Faref (Vexecuting_macro, make_number (executing_macro_index));
2433 if (STRINGP (Vexecuting_macro)
2434 && (XINT (c) & 0x80))
2435 XSETFASTINT (c, CHAR_META | (XINT (c) & ~0x80));
2437 executing_macro_index++;
2439 goto from_macro;
2442 if (!NILP (unread_switch_frame))
2444 c = unread_switch_frame;
2445 unread_switch_frame = Qnil;
2447 /* This event should make it into this_command_keys, and get echoed
2448 again, so we do not set `reread'. */
2449 goto reread_first;
2452 /* if redisplay was requested */
2453 if (commandflag >= 0)
2455 /* If there is pending input, process any events which are not
2456 user-visible, such as X selection_request events. */
2457 if (input_pending
2458 || detect_input_pending_run_timers (0))
2459 swallow_events (0); /* may clear input_pending */
2461 /* Redisplay if no pending input. */
2462 while (!input_pending)
2464 if (help_echo_showing_p && !EQ (selected_window, minibuf_window))
2465 redisplay_preserve_echo_area (5);
2466 else
2467 redisplay ();
2469 if (!input_pending)
2470 /* Normal case: no input arrived during redisplay. */
2471 break;
2473 /* Input arrived and pre-empted redisplay.
2474 Process any events which are not user-visible. */
2475 swallow_events (0);
2476 /* If that cleared input_pending, try again to redisplay. */
2480 /* Message turns off echoing unless more keystrokes turn it on again.
2482 The code in 20.x for the condition was
2484 1. echo_area_glyphs && *echo_area_glyphs
2485 2. && echo_area_glyphs != current_kboard->echobuf
2486 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2488 (1) means there's a current message displayed
2490 (2) means it's not the message from echoing from the current
2491 kboard.
2493 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2494 is set to a non-null value. This is done in read_char and it is
2495 set to echo_area_glyphs after a call to echo_char. That means
2496 ok_to_echo_at_next_pause is either null or
2497 current_kboard->echobuf with the appropriate current_kboard at
2498 that time.
2500 So, condition (3) means in clear text ok_to_echo_at_next_pause
2501 must be either null, or the current message isn't from echoing at
2502 all, or it's from echoing from a different kboard than the
2503 current one. */
2505 if (/* There currently is something in the echo area. */
2506 !NILP (echo_area_buffer[0])
2507 && (/* And it's either not from echoing. */
2508 !EQ (echo_area_buffer[0], echo_message_buffer)
2509 /* Or it's an echo from a different kboard. */
2510 || echo_kboard != current_kboard
2511 /* Or we explicitly allow overwriting whatever there is. */
2512 || ok_to_echo_at_next_pause == NULL))
2513 cancel_echoing ();
2514 else
2515 echo_dash ();
2517 /* Try reading a character via menu prompting in the minibuf.
2518 Try this before the sit-for, because the sit-for
2519 would do the wrong thing if we are supposed to do
2520 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2521 after a mouse event so don't try a minibuf menu. */
2522 c = Qnil;
2523 if (nmaps > 0 && INTERACTIVE
2524 && !NILP (prev_event) && ! EVENT_HAS_PARAMETERS (prev_event)
2525 /* Don't bring up a menu if we already have another event. */
2526 && NILP (Vunread_command_events)
2527 && unread_command_char < 0
2528 && !detect_input_pending_run_timers (0))
2530 c = read_char_minibuf_menu_prompt (commandflag, nmaps, maps);
2531 if (! NILP (c))
2533 key_already_recorded = 1;
2534 goto non_reread_1;
2538 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2539 We will do that below, temporarily for short sections of code,
2540 when appropriate. local_getcjmp must be in effect
2541 around any call to sit_for or kbd_buffer_get_event;
2542 it *must not* be in effect when we call redisplay. */
2544 if (_setjmp (local_getcjmp))
2546 XSETINT (c, quit_char);
2547 internal_last_event_frame = selected_frame;
2548 Vlast_event_frame = internal_last_event_frame;
2549 /* If we report the quit char as an event,
2550 don't do so more than once. */
2551 if (!NILP (Vinhibit_quit))
2552 Vquit_flag = Qnil;
2554 #ifdef MULTI_KBOARD
2556 KBOARD *kb = FRAME_KBOARD (XFRAME (selected_frame));
2557 if (kb != current_kboard)
2559 Lisp_Object link = kb->kbd_queue;
2560 /* We shouldn't get here if we were in single-kboard mode! */
2561 if (single_kboard)
2562 abort ();
2563 if (CONSP (link))
2565 while (CONSP (XCDR (link)))
2566 link = XCDR (link);
2567 if (!NILP (XCDR (link)))
2568 abort ();
2570 if (!CONSP (link))
2571 kb->kbd_queue = Fcons (c, Qnil);
2572 else
2573 XSETCDR (link, Fcons (c, Qnil));
2574 kb->kbd_queue_has_data = 1;
2575 current_kboard = kb;
2576 /* This is going to exit from read_char
2577 so we had better get rid of this frame's stuff. */
2578 UNGCPRO;
2579 longjmp (wrong_kboard_jmpbuf, 1);
2582 #endif
2583 goto non_reread;
2586 timer_start_idle ();
2588 /* If in middle of key sequence and minibuffer not active,
2589 start echoing if enough time elapses. */
2591 if (minibuf_level == 0
2592 && !current_kboard->immediate_echo
2593 && this_command_key_count > 0
2594 && ! noninteractive
2595 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
2596 && NILP (Fzerop (Vecho_keystrokes))
2597 && (/* No message. */
2598 NILP (echo_area_buffer[0])
2599 /* Or empty message. */
2600 || (BUF_BEG (XBUFFER (echo_area_buffer[0]))
2601 == BUF_Z (XBUFFER (echo_area_buffer[0])))
2602 /* Or already echoing from same kboard. */
2603 || (echo_kboard && ok_to_echo_at_next_pause == echo_kboard)
2604 /* Or not echoing before and echoing allowed. */
2605 || (!echo_kboard && ok_to_echo_at_next_pause)))
2607 Lisp_Object tem0;
2609 /* After a mouse event, start echoing right away.
2610 This is because we are probably about to display a menu,
2611 and we don't want to delay before doing so. */
2612 if (EVENT_HAS_PARAMETERS (prev_event))
2613 echo_now ();
2614 else
2616 int sec, usec;
2617 double duration = extract_float (Vecho_keystrokes);
2618 sec = (int) duration;
2619 usec = (duration - sec) * 1000000;
2620 save_getcjmp (save_jump);
2621 restore_getcjmp (local_getcjmp);
2622 tem0 = sit_for (sec, usec, 1, 1, 0);
2623 restore_getcjmp (save_jump);
2624 if (EQ (tem0, Qt)
2625 && ! CONSP (Vunread_command_events))
2626 echo_now ();
2630 /* Maybe auto save due to number of keystrokes. */
2632 if (commandflag != 0
2633 && auto_save_interval > 0
2634 && num_nonmacro_input_events - last_auto_save > max (auto_save_interval, 20)
2635 && !detect_input_pending_run_timers (0))
2637 Fdo_auto_save (Qnil, Qnil);
2638 /* Hooks can actually change some buffers in auto save. */
2639 redisplay ();
2642 /* Try reading using an X menu.
2643 This is never confused with reading using the minibuf
2644 because the recursive call of read_char in read_char_minibuf_menu_prompt
2645 does not pass on any keymaps. */
2647 if (nmaps > 0 && INTERACTIVE
2648 && !NILP (prev_event)
2649 && EVENT_HAS_PARAMETERS (prev_event)
2650 && !EQ (XCAR (prev_event), Qmenu_bar)
2651 && !EQ (XCAR (prev_event), Qtool_bar)
2652 /* Don't bring up a menu if we already have another event. */
2653 && NILP (Vunread_command_events)
2654 && unread_command_char < 0)
2656 c = read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu);
2658 /* Now that we have read an event, Emacs is not idle. */
2659 timer_stop_idle ();
2661 goto exit;
2664 /* Maybe autosave and/or garbage collect due to idleness. */
2666 if (INTERACTIVE && NILP (c))
2668 int delay_level, buffer_size;
2670 /* Slow down auto saves logarithmically in size of current buffer,
2671 and garbage collect while we're at it. */
2672 if (! MINI_WINDOW_P (XWINDOW (selected_window)))
2673 last_non_minibuf_size = Z - BEG;
2674 buffer_size = (last_non_minibuf_size >> 8) + 1;
2675 delay_level = 0;
2676 while (buffer_size > 64)
2677 delay_level++, buffer_size -= buffer_size >> 2;
2678 if (delay_level < 4) delay_level = 4;
2679 /* delay_level is 4 for files under around 50k, 7 at 100k,
2680 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2682 /* Auto save if enough time goes by without input. */
2683 if (commandflag != 0
2684 && num_nonmacro_input_events > last_auto_save
2685 && INTEGERP (Vauto_save_timeout)
2686 && XINT (Vauto_save_timeout) > 0)
2688 Lisp_Object tem0;
2690 save_getcjmp (save_jump);
2691 restore_getcjmp (local_getcjmp);
2692 tem0 = sit_for (delay_level * XFASTINT (Vauto_save_timeout) / 4,
2693 0, 1, 1, 0);
2694 restore_getcjmp (save_jump);
2696 if (EQ (tem0, Qt)
2697 && ! CONSP (Vunread_command_events))
2699 Fdo_auto_save (Qnil, Qnil);
2701 /* If we have auto-saved and there is still no input
2702 available, garbage collect if there has been enough
2703 consing going on to make it worthwhile. */
2704 if (!detect_input_pending_run_timers (0)
2705 && consing_since_gc > gc_cons_threshold / 2)
2706 Fgarbage_collect ();
2708 redisplay ();
2713 /* If this has become non-nil here, it has been set by a timer
2714 or sentinel or filter. */
2715 if (CONSP (Vunread_command_events))
2717 c = XCAR (Vunread_command_events);
2718 Vunread_command_events = XCDR (Vunread_command_events);
2721 /* Read something from current KBOARD's side queue, if possible. */
2723 if (NILP (c))
2725 if (current_kboard->kbd_queue_has_data)
2727 if (!CONSP (current_kboard->kbd_queue))
2728 abort ();
2729 c = XCAR (current_kboard->kbd_queue);
2730 current_kboard->kbd_queue
2731 = XCDR (current_kboard->kbd_queue);
2732 if (NILP (current_kboard->kbd_queue))
2733 current_kboard->kbd_queue_has_data = 0;
2734 input_pending = readable_events (0);
2735 if (EVENT_HAS_PARAMETERS (c)
2736 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qswitch_frame))
2737 internal_last_event_frame = XCAR (XCDR (c));
2738 Vlast_event_frame = internal_last_event_frame;
2742 #ifdef MULTI_KBOARD
2743 /* If current_kboard's side queue is empty check the other kboards.
2744 If one of them has data that we have not yet seen here,
2745 switch to it and process the data waiting for it.
2747 Note: if the events queued up for another kboard
2748 have already been seen here, and therefore are not a complete command,
2749 the kbd_queue_has_data field is 0, so we skip that kboard here.
2750 That's to avoid an infinite loop switching between kboards here. */
2751 if (NILP (c) && !single_kboard)
2753 KBOARD *kb;
2754 for (kb = all_kboards; kb; kb = kb->next_kboard)
2755 if (kb->kbd_queue_has_data)
2757 current_kboard = kb;
2758 /* This is going to exit from read_char
2759 so we had better get rid of this frame's stuff. */
2760 UNGCPRO;
2761 longjmp (wrong_kboard_jmpbuf, 1);
2764 #endif
2766 wrong_kboard:
2768 STOP_POLLING;
2770 /* Finally, we read from the main queue,
2771 and if that gives us something we can't use yet, we put it on the
2772 appropriate side queue and try again. */
2774 if (NILP (c))
2776 KBOARD *kb;
2778 /* Actually read a character, waiting if necessary. */
2779 save_getcjmp (save_jump);
2780 restore_getcjmp (local_getcjmp);
2781 timer_start_idle ();
2782 c = kbd_buffer_get_event (&kb, used_mouse_menu);
2783 restore_getcjmp (save_jump);
2785 #ifdef MULTI_KBOARD
2786 if (! NILP (c) && (kb != current_kboard))
2788 Lisp_Object link = kb->kbd_queue;
2789 if (CONSP (link))
2791 while (CONSP (XCDR (link)))
2792 link = XCDR (link);
2793 if (!NILP (XCDR (link)))
2794 abort ();
2796 if (!CONSP (link))
2797 kb->kbd_queue = Fcons (c, Qnil);
2798 else
2799 XSETCDR (link, Fcons (c, Qnil));
2800 kb->kbd_queue_has_data = 1;
2801 c = Qnil;
2802 if (single_kboard)
2803 goto wrong_kboard;
2804 current_kboard = kb;
2805 /* This is going to exit from read_char
2806 so we had better get rid of this frame's stuff. */
2807 UNGCPRO;
2808 longjmp (wrong_kboard_jmpbuf, 1);
2810 #endif
2813 /* Terminate Emacs in batch mode if at eof. */
2814 if (noninteractive && INTEGERP (c) && XINT (c) < 0)
2815 Fkill_emacs (make_number (1));
2817 if (INTEGERP (c))
2819 /* Add in any extra modifiers, where appropriate. */
2820 if ((extra_keyboard_modifiers & CHAR_CTL)
2821 || ((extra_keyboard_modifiers & 0177) < ' '
2822 && (extra_keyboard_modifiers & 0177) != 0))
2823 XSETINT (c, make_ctrl_char (XINT (c)));
2825 /* Transfer any other modifier bits directly from
2826 extra_keyboard_modifiers to c. Ignore the actual character code
2827 in the low 16 bits of extra_keyboard_modifiers. */
2828 XSETINT (c, XINT (c) | (extra_keyboard_modifiers & ~0xff7f & ~CHAR_CTL));
2831 non_reread:
2833 /* Record the last idle start time so that we can reset it
2834 should the next event read be a help-echo. */
2835 last_idle_start = timer_idleness_start_time;
2836 timer_stop_idle ();
2837 RESUME_POLLING;
2839 if (NILP (c))
2841 if (commandflag >= 0
2842 && !input_pending && !detect_input_pending_run_timers (0))
2843 redisplay ();
2845 goto wrong_kboard;
2848 non_reread_1:
2850 /* Buffer switch events are only for internal wakeups
2851 so don't show them to the user.
2852 Also, don't record a key if we already did. */
2853 if (BUFFERP (c) || key_already_recorded)
2854 goto exit;
2856 /* Process special events within read_char
2857 and loop around to read another event. */
2858 save = Vquit_flag;
2859 Vquit_flag = Qnil;
2860 tem = access_keymap (get_keymap (Vspecial_event_map, 0, 1), c, 0, 0, 1);
2861 Vquit_flag = save;
2863 if (!NILP (tem))
2865 int was_locked = single_kboard;
2867 last_input_char = c;
2868 Fcommand_execute (tem, Qnil, Fvector (1, &last_input_char), Qt);
2870 if (CONSP (c) && EQ (XCAR (c), Qselect_window))
2871 /* We stopped being idle for this event; undo that. This
2872 prevents automatic window selection (under
2873 mouse_autoselect_window from acting as a real input event, for
2874 example banishing the mouse under mouse-avoidance-mode. */
2875 timer_idleness_start_time = last_idle_start;
2877 /* Resume allowing input from any kboard, if that was true before. */
2878 if (!was_locked)
2879 any_kboard_state ();
2881 goto retry;
2884 /* Handle things that only apply to characters. */
2885 if (INTEGERP (c))
2887 /* If kbd_buffer_get_event gave us an EOF, return that. */
2888 if (XINT (c) == -1)
2889 goto exit;
2891 if ((STRINGP (Vkeyboard_translate_table)
2892 && SCHARS (Vkeyboard_translate_table) > (unsigned) XFASTINT (c))
2893 || (VECTORP (Vkeyboard_translate_table)
2894 && XVECTOR (Vkeyboard_translate_table)->size > (unsigned) XFASTINT (c))
2895 || (CHAR_TABLE_P (Vkeyboard_translate_table)
2896 && CHAR_VALID_P (XINT (c), 0)))
2898 Lisp_Object d;
2899 d = Faref (Vkeyboard_translate_table, c);
2900 /* nil in keyboard-translate-table means no translation. */
2901 if (!NILP (d))
2902 c = d;
2906 /* If this event is a mouse click in the menu bar,
2907 return just menu-bar for now. Modify the mouse click event
2908 so we won't do this twice, then queue it up. */
2909 if (EVENT_HAS_PARAMETERS (c)
2910 && CONSP (XCDR (c))
2911 && CONSP (EVENT_START (c))
2912 && CONSP (XCDR (EVENT_START (c))))
2914 Lisp_Object posn;
2916 posn = POSN_POSN (EVENT_START (c));
2917 /* Handle menu-bar events:
2918 insert the dummy prefix event `menu-bar'. */
2919 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
2921 /* Change menu-bar to (menu-bar) as the event "position". */
2922 POSN_SET_POSN (EVENT_START (c), Fcons (posn, Qnil));
2924 also_record = c;
2925 Vunread_command_events = Fcons (c, Vunread_command_events);
2926 c = posn;
2930 /* Store these characters into recent_keys, the dribble file if any,
2931 and the keyboard macro being defined, if any. */
2932 record_char (c);
2933 if (! NILP (also_record))
2934 record_char (also_record);
2936 /* Wipe the echo area.
2937 But first, if we are about to use an input method,
2938 save the echo area contents for it to refer to. */
2939 if (INTEGERP (c)
2940 && ! NILP (Vinput_method_function)
2941 && (unsigned) XINT (c) >= ' '
2942 && (unsigned) XINT (c) != 127
2943 && (unsigned) XINT (c) < 256)
2945 previous_echo_area_message = Fcurrent_message ();
2946 Vinput_method_previous_message = previous_echo_area_message;
2949 /* Now wipe the echo area, except for help events which do their
2950 own stuff with the echo area. */
2951 if (!CONSP (c)
2952 || (!(EQ (Qhelp_echo, XCAR (c)))
2953 && !(EQ (Qswitch_frame, XCAR (c)))))
2955 if (!NILP (echo_area_buffer[0]))
2956 safe_run_hooks (Qecho_area_clear_hook);
2957 clear_message (1, 0);
2960 reread_for_input_method:
2961 from_macro:
2962 /* Pass this to the input method, if appropriate. */
2963 if (INTEGERP (c)
2964 && ! NILP (Vinput_method_function)
2965 /* Don't run the input method within a key sequence,
2966 after the first event of the key sequence. */
2967 && NILP (prev_event)
2968 && (unsigned) XINT (c) >= ' '
2969 && (unsigned) XINT (c) != 127
2970 && (unsigned) XINT (c) < 256)
2972 Lisp_Object keys;
2973 int key_count, key_count_reset;
2974 struct gcpro gcpro1;
2975 int count = SPECPDL_INDEX ();
2977 /* Save the echo status. */
2978 int saved_immediate_echo = current_kboard->immediate_echo;
2979 struct kboard *saved_ok_to_echo = ok_to_echo_at_next_pause;
2980 int saved_echo_after_prompt = current_kboard->echo_after_prompt;
2982 #if 0
2983 if (before_command_restore_flag)
2985 this_command_key_count = before_command_key_count_1;
2986 if (this_command_key_count < this_single_command_key_start)
2987 this_single_command_key_start = this_command_key_count;
2988 echo_truncate (before_command_echo_length_1);
2989 before_command_restore_flag = 0;
2991 #endif
2993 /* Save the this_command_keys status. */
2994 key_count = this_command_key_count;
2995 key_count_reset = this_command_key_count_reset;
2997 if (key_count > 0)
2998 keys = Fcopy_sequence (this_command_keys);
2999 else
3000 keys = Qnil;
3001 GCPRO1 (keys);
3003 /* Clear out this_command_keys. */
3004 this_command_key_count = 0;
3005 this_command_key_count_reset = 0;
3007 /* Now wipe the echo area. */
3008 if (!NILP (echo_area_buffer[0]))
3009 safe_run_hooks (Qecho_area_clear_hook);
3010 clear_message (1, 0);
3011 echo_truncate (0);
3013 /* If we are not reading a key sequence,
3014 never use the echo area. */
3015 if (maps == 0)
3017 specbind (Qinput_method_use_echo_area, Qt);
3020 /* Call the input method. */
3021 tem = call1 (Vinput_method_function, c);
3023 tem = unbind_to (count, tem);
3025 /* Restore the saved echoing state
3026 and this_command_keys state. */
3027 this_command_key_count = key_count;
3028 this_command_key_count_reset = key_count_reset;
3029 if (key_count > 0)
3030 this_command_keys = keys;
3032 cancel_echoing ();
3033 ok_to_echo_at_next_pause = saved_ok_to_echo;
3034 current_kboard->echo_after_prompt = saved_echo_after_prompt;
3035 if (saved_immediate_echo)
3036 echo_now ();
3038 UNGCPRO;
3040 /* The input method can return no events. */
3041 if (! CONSP (tem))
3043 /* Bring back the previous message, if any. */
3044 if (! NILP (previous_echo_area_message))
3045 message_with_string ("%s", previous_echo_area_message, 0);
3046 goto retry;
3048 /* It returned one event or more. */
3049 c = XCAR (tem);
3050 Vunread_post_input_method_events
3051 = nconc2 (XCDR (tem), Vunread_post_input_method_events);
3054 reread_first:
3056 /* Display help if not echoing. */
3057 if (CONSP (c) && EQ (XCAR (c), Qhelp_echo))
3059 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3060 Lisp_Object help, object, position, window, tem;
3062 tem = Fcdr (XCDR (c));
3063 help = Fcar (tem);
3064 tem = Fcdr (tem);
3065 window = Fcar (tem);
3066 tem = Fcdr (tem);
3067 object = Fcar (tem);
3068 tem = Fcdr (tem);
3069 position = Fcar (tem);
3071 show_help_echo (help, window, object, position, 0);
3073 /* We stopped being idle for this event; undo that. */
3074 timer_idleness_start_time = last_idle_start;
3075 goto retry;
3078 if (! reread || this_command_key_count == 0
3079 || this_command_key_count_reset)
3082 /* Don't echo mouse motion events. */
3083 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3084 && NILP (Fzerop (Vecho_keystrokes))
3085 && ! (EVENT_HAS_PARAMETERS (c)
3086 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c)), Qmouse_movement)))
3088 echo_char (c);
3089 if (! NILP (also_record))
3090 echo_char (also_record);
3091 /* Once we reread a character, echoing can happen
3092 the next time we pause to read a new one. */
3093 ok_to_echo_at_next_pause = current_kboard;
3096 /* Record this character as part of the current key. */
3097 add_command_key (c);
3098 if (! NILP (also_record))
3099 add_command_key (also_record);
3102 last_input_char = c;
3103 num_input_events++;
3105 /* Process the help character specially if enabled */
3106 if (!NILP (Vhelp_form) && help_char_p (c))
3108 Lisp_Object tem0;
3109 count = SPECPDL_INDEX ();
3111 record_unwind_protect (Fset_window_configuration,
3112 Fcurrent_window_configuration (Qnil));
3114 tem0 = Feval (Vhelp_form);
3115 if (STRINGP (tem0))
3116 internal_with_output_to_temp_buffer ("*Help*", print_help, tem0);
3118 cancel_echoing ();
3120 c = read_char (0, 0, 0, Qnil, 0);
3121 while (BUFFERP (c));
3122 /* Remove the help from the frame */
3123 unbind_to (count, Qnil);
3125 redisplay ();
3126 if (EQ (c, make_number (040)))
3128 cancel_echoing ();
3130 c = read_char (0, 0, 0, Qnil, 0);
3131 while (BUFFERP (c));
3135 exit:
3136 RESUME_POLLING;
3137 RETURN_UNGCPRO (c);
3140 /* Record a key that came from a mouse menu.
3141 Record it for echoing, for this-command-keys, and so on. */
3143 static void
3144 record_menu_key (c)
3145 Lisp_Object c;
3147 /* Wipe the echo area. */
3148 clear_message (1, 0);
3150 record_char (c);
3152 #if 0
3153 before_command_key_count = this_command_key_count;
3154 before_command_echo_length = echo_length ();
3155 #endif
3157 /* Don't echo mouse motion events. */
3158 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
3159 && NILP (Fzerop (Vecho_keystrokes)))
3161 echo_char (c);
3163 /* Once we reread a character, echoing can happen
3164 the next time we pause to read a new one. */
3165 ok_to_echo_at_next_pause = 0;
3168 /* Record this character as part of the current key. */
3169 add_command_key (c);
3171 /* Re-reading in the middle of a command */
3172 last_input_char = c;
3173 num_input_events++;
3176 /* Return 1 if should recognize C as "the help character". */
3179 help_char_p (c)
3180 Lisp_Object c;
3182 Lisp_Object tail;
3184 if (EQ (c, Vhelp_char))
3185 return 1;
3186 for (tail = Vhelp_event_list; CONSP (tail); tail = XCDR (tail))
3187 if (EQ (c, XCAR (tail)))
3188 return 1;
3189 return 0;
3192 /* Record the input event C in various ways. */
3194 static void
3195 record_char (c)
3196 Lisp_Object c;
3198 int recorded = 0;
3200 if (CONSP (c) && (EQ (XCAR (c), Qhelp_echo) || EQ (XCAR (c), Qmouse_movement)))
3202 /* To avoid filling recent_keys with help-echo and mouse-movement
3203 events, we filter out repeated help-echo events, only store the
3204 first and last in a series of mouse-movement events, and don't
3205 store repeated help-echo events which are only separated by
3206 mouse-movement events. */
3208 Lisp_Object ev1, ev2, ev3;
3209 int ix1, ix2, ix3;
3211 if ((ix1 = recent_keys_index - 1) < 0)
3212 ix1 = NUM_RECENT_KEYS - 1;
3213 ev1 = AREF (recent_keys, ix1);
3215 if ((ix2 = ix1 - 1) < 0)
3216 ix2 = NUM_RECENT_KEYS - 1;
3217 ev2 = AREF (recent_keys, ix2);
3219 if ((ix3 = ix2 - 1) < 0)
3220 ix3 = NUM_RECENT_KEYS - 1;
3221 ev3 = AREF (recent_keys, ix3);
3223 if (EQ (XCAR (c), Qhelp_echo))
3225 /* Don't record `help-echo' in recent_keys unless it shows some help
3226 message, and a different help than the previously recorded
3227 event. */
3228 Lisp_Object help, last_help;
3230 help = Fcar_safe (Fcdr_safe (XCDR (c)));
3231 if (!STRINGP (help))
3232 recorded = 1;
3233 else if (CONSP (ev1) && EQ (XCAR (ev1), Qhelp_echo)
3234 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev1))), EQ (last_help, help)))
3235 recorded = 1;
3236 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3237 && CONSP (ev2) && EQ (XCAR (ev2), Qhelp_echo)
3238 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev2))), EQ (last_help, help)))
3239 recorded = -1;
3240 else if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3241 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3242 && CONSP (ev3) && EQ (XCAR (ev3), Qhelp_echo)
3243 && (last_help = Fcar_safe (Fcdr_safe (XCDR (ev3))), EQ (last_help, help)))
3244 recorded = -2;
3246 else if (EQ (XCAR (c), Qmouse_movement))
3248 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3249 So additional mouse movement events replace the last element. */
3250 Lisp_Object last_window, window;
3252 window = Fcar_safe (Fcar_safe (XCDR (c)));
3253 if (CONSP (ev1) && EQ (XCAR (ev1), Qmouse_movement)
3254 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev1))), EQ (last_window, window))
3255 && CONSP (ev2) && EQ (XCAR (ev2), Qmouse_movement)
3256 && (last_window = Fcar_safe (Fcar_safe (XCDR (ev2))), EQ (last_window, window)))
3258 ASET (recent_keys, ix1, c);
3259 recorded = 1;
3263 else
3264 store_kbd_macro_char (c);
3266 if (!recorded)
3268 total_keys++;
3269 ASET (recent_keys, recent_keys_index, c);
3270 if (++recent_keys_index >= NUM_RECENT_KEYS)
3271 recent_keys_index = 0;
3273 else if (recorded < 0)
3275 /* We need to remove one or two events from recent_keys.
3276 To do this, we simply put nil at those events and move the
3277 recent_keys_index backwards over those events. Usually,
3278 users will never see those nil events, as they will be
3279 overwritten by the command keys entered to see recent_keys
3280 (e.g. C-h l). */
3282 while (recorded++ < 0 && total_keys > 0)
3284 if (total_keys < NUM_RECENT_KEYS)
3285 total_keys--;
3286 if (--recent_keys_index < 0)
3287 recent_keys_index = NUM_RECENT_KEYS - 1;
3288 ASET (recent_keys, recent_keys_index, Qnil);
3292 num_nonmacro_input_events++;
3294 /* Write c to the dribble file. If c is a lispy event, write
3295 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3296 If you, dear reader, have a better idea, you've got the source. :-) */
3297 if (dribble)
3299 if (INTEGERP (c))
3301 if (XUINT (c) < 0x100)
3302 putc (XINT (c), dribble);
3303 else
3304 fprintf (dribble, " 0x%x", (int) XUINT (c));
3306 else
3308 Lisp_Object dribblee;
3310 /* If it's a structured event, take the event header. */
3311 dribblee = EVENT_HEAD (c);
3313 if (SYMBOLP (dribblee))
3315 putc ('<', dribble);
3316 fwrite (SDATA (SYMBOL_NAME (dribblee)), sizeof (char),
3317 SBYTES (SYMBOL_NAME (dribblee)),
3318 dribble);
3319 putc ('>', dribble);
3323 fflush (dribble);
3327 Lisp_Object
3328 print_help (object)
3329 Lisp_Object object;
3331 struct buffer *old = current_buffer;
3332 Fprinc (object, Qnil);
3333 set_buffer_internal (XBUFFER (Vstandard_output));
3334 call0 (intern ("help-mode"));
3335 set_buffer_internal (old);
3336 return Qnil;
3339 /* Copy out or in the info on where C-g should throw to.
3340 This is used when running Lisp code from within get_char,
3341 in case get_char is called recursively.
3342 See read_process_output. */
3344 static void
3345 save_getcjmp (temp)
3346 jmp_buf temp;
3348 bcopy (getcjmp, temp, sizeof getcjmp);
3351 static void
3352 restore_getcjmp (temp)
3353 jmp_buf temp;
3355 bcopy (temp, getcjmp, sizeof getcjmp);
3358 #ifdef HAVE_MOUSE
3360 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3361 of this function. */
3363 static Lisp_Object
3364 tracking_off (old_value)
3365 Lisp_Object old_value;
3367 do_mouse_tracking = old_value;
3368 if (NILP (old_value))
3370 /* Redisplay may have been preempted because there was input
3371 available, and it assumes it will be called again after the
3372 input has been processed. If the only input available was
3373 the sort that we have just disabled, then we need to call
3374 redisplay. */
3375 if (!readable_events (1))
3377 redisplay_preserve_echo_area (6);
3378 get_input_pending (&input_pending, 1);
3381 return Qnil;
3384 DEFUN ("track-mouse", Ftrack_mouse, Strack_mouse, 0, UNEVALLED, 0,
3385 doc: /* Evaluate BODY with mouse movement events enabled.
3386 Within a `track-mouse' form, mouse motion generates input events that
3387 you can read with `read-event'.
3388 Normally, mouse motion is ignored.
3389 usage: (track-mouse BODY ...) */)
3390 (args)
3391 Lisp_Object args;
3393 int count = SPECPDL_INDEX ();
3394 Lisp_Object val;
3396 record_unwind_protect (tracking_off, do_mouse_tracking);
3398 do_mouse_tracking = Qt;
3400 val = Fprogn (args);
3401 return unbind_to (count, val);
3404 /* If mouse has moved on some frame, return one of those frames.
3405 Return 0 otherwise. */
3407 static FRAME_PTR
3408 some_mouse_moved ()
3410 Lisp_Object tail, frame;
3412 FOR_EACH_FRAME (tail, frame)
3414 if (XFRAME (frame)->mouse_moved)
3415 return XFRAME (frame);
3418 return 0;
3421 #endif /* HAVE_MOUSE */
3423 /* Low level keyboard/mouse input.
3424 kbd_buffer_store_event places events in kbd_buffer, and
3425 kbd_buffer_get_event retrieves them. */
3427 /* Return true iff there are any events in the queue that read-char
3428 would return. If this returns false, a read-char would block. */
3429 static int
3430 readable_filtered_events (do_timers_now, filter_events)
3431 int do_timers_now;
3432 int filter_events;
3434 if (do_timers_now)
3435 timer_check (do_timers_now);
3437 /* If the buffer contains only FOCUS_IN_EVENT events,
3438 and FILTER_EVENTS is nonzero, report it as empty. */
3439 if (kbd_fetch_ptr != kbd_store_ptr)
3441 int have_live_event = 1;
3443 if (filter_events)
3445 struct input_event *event;
3447 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3448 ? kbd_fetch_ptr
3449 : kbd_buffer);
3451 while (have_live_event && event->kind == FOCUS_IN_EVENT)
3453 event++;
3454 if (event == kbd_buffer + KBD_BUFFER_SIZE)
3455 event = kbd_buffer;
3456 if (event == kbd_store_ptr)
3457 have_live_event = 0;
3460 if (have_live_event) return 1;
3463 #ifdef HAVE_MOUSE
3464 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
3465 return 1;
3466 #endif
3467 if (single_kboard)
3469 if (current_kboard->kbd_queue_has_data)
3470 return 1;
3472 else
3474 KBOARD *kb;
3475 for (kb = all_kboards; kb; kb = kb->next_kboard)
3476 if (kb->kbd_queue_has_data)
3477 return 1;
3479 return 0;
3482 /* Return true iff there are any events in the queue that read-char
3483 would return. If this returns false, a read-char would block. */
3484 static int
3485 readable_events (do_timers_now)
3486 int do_timers_now;
3488 return readable_filtered_events (do_timers_now, 0);
3491 /* Set this for debugging, to have a way to get out */
3492 int stop_character;
3494 #ifdef MULTI_KBOARD
3495 static KBOARD *
3496 event_to_kboard (event)
3497 struct input_event *event;
3499 Lisp_Object frame;
3500 frame = event->frame_or_window;
3501 if (CONSP (frame))
3502 frame = XCAR (frame);
3503 else if (WINDOWP (frame))
3504 frame = WINDOW_FRAME (XWINDOW (frame));
3506 /* There are still some events that don't set this field.
3507 For now, just ignore the problem.
3508 Also ignore dead frames here. */
3509 if (!FRAMEP (frame) || !FRAME_LIVE_P (XFRAME (frame)))
3510 return 0;
3511 else
3512 return FRAME_KBOARD (XFRAME (frame));
3514 #endif
3516 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3518 void
3519 kbd_buffer_store_event (event)
3520 register struct input_event *event;
3522 if (event->kind == NO_EVENT)
3523 abort ();
3525 if (event->kind == ASCII_KEYSTROKE_EVENT)
3527 register int c = event->code & 0377;
3529 if (event->modifiers & ctrl_modifier)
3530 c = make_ctrl_char (c);
3532 c |= (event->modifiers
3533 & (meta_modifier | alt_modifier
3534 | hyper_modifier | super_modifier));
3536 if (c == quit_char)
3538 #ifdef MULTI_KBOARD
3539 KBOARD *kb;
3540 struct input_event *sp;
3542 if (single_kboard
3543 && (kb = FRAME_KBOARD (XFRAME (event->frame_or_window)),
3544 kb != current_kboard))
3546 kb->kbd_queue
3547 = Fcons (make_lispy_switch_frame (event->frame_or_window),
3548 Fcons (make_number (c), Qnil));
3549 kb->kbd_queue_has_data = 1;
3550 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3552 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3553 sp = kbd_buffer;
3555 if (event_to_kboard (sp) == kb)
3557 sp->kind = NO_EVENT;
3558 sp->frame_or_window = Qnil;
3559 sp->arg = Qnil;
3562 return;
3564 #endif
3566 /* If this results in a quit_char being returned to Emacs as
3567 input, set Vlast_event_frame properly. If this doesn't
3568 get returned to Emacs as an event, the next event read
3569 will set Vlast_event_frame again, so this is safe to do. */
3571 Lisp_Object focus;
3573 focus = FRAME_FOCUS_FRAME (XFRAME (event->frame_or_window));
3574 if (NILP (focus))
3575 focus = event->frame_or_window;
3576 internal_last_event_frame = focus;
3577 Vlast_event_frame = focus;
3580 last_event_timestamp = event->timestamp;
3581 interrupt_signal (0 /* dummy */);
3582 return;
3585 if (c && c == stop_character)
3587 sys_suspend ();
3588 return;
3591 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3592 Just ignore the second one. */
3593 else if (event->kind == BUFFER_SWITCH_EVENT
3594 && kbd_fetch_ptr != kbd_store_ptr
3595 && kbd_store_ptr->kind == BUFFER_SWITCH_EVENT)
3596 return;
3598 if (kbd_store_ptr - kbd_buffer == KBD_BUFFER_SIZE)
3599 kbd_store_ptr = kbd_buffer;
3601 /* Don't let the very last slot in the buffer become full,
3602 since that would make the two pointers equal,
3603 and that is indistinguishable from an empty buffer.
3604 Discard the event if it would fill the last slot. */
3605 if (kbd_fetch_ptr - 1 != kbd_store_ptr)
3608 #if 0 /* The SELECTION_REQUEST_EVENT case looks bogus, and it's error
3609 prone to assign individual members for other events, in case
3610 the input_event structure is changed. --2000-07-13, gerd. */
3611 struct input_event *sp = kbd_store_ptr;
3612 sp->kind = event->kind;
3613 if (event->kind == SELECTION_REQUEST_EVENT)
3615 /* We must not use the ordinary copying code for this case,
3616 since `part' is an enum and copying it might not copy enough
3617 in this case. */
3618 bcopy (event, (char *) sp, sizeof (*event));
3620 else
3623 sp->code = event->code;
3624 sp->part = event->part;
3625 sp->frame_or_window = event->frame_or_window;
3626 sp->arg = event->arg;
3627 sp->modifiers = event->modifiers;
3628 sp->x = event->x;
3629 sp->y = event->y;
3630 sp->timestamp = event->timestamp;
3632 #else
3633 *kbd_store_ptr = *event;
3634 #endif
3636 ++kbd_store_ptr;
3641 /* Generate HELP_EVENT input_events in BUFP which has room for
3642 SIZE events. If there's not enough room in BUFP, ignore this
3643 event.
3645 HELP is the help form.
3647 FRAME is the frame on which the help is generated. OBJECT is the
3648 Lisp object where the help was found (a buffer, a string, an
3649 overlay, or nil if neither from a string nor from a buffer. POS is
3650 the position within OBJECT where the help was found.
3652 Value is the number of input_events generated. */
3655 gen_help_event (bufp, size, help, frame, window, object, pos)
3656 struct input_event *bufp;
3657 int size;
3658 Lisp_Object help, frame, object, window;
3659 int pos;
3661 if (size >= 1)
3663 bufp->kind = HELP_EVENT;
3664 bufp->frame_or_window = frame;
3665 bufp->arg = object;
3666 bufp->x = WINDOWP (window) ? window : frame;
3667 bufp->y = help;
3668 bufp->code = pos;
3669 return 1;
3671 return 0;
3675 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3677 void
3678 kbd_buffer_store_help_event (frame, help)
3679 Lisp_Object frame, help;
3681 struct input_event event;
3683 event.kind = HELP_EVENT;
3684 event.frame_or_window = frame;
3685 event.arg = Qnil;
3686 event.x = Qnil;
3687 event.y = help;
3688 event.code = 0;
3689 kbd_buffer_store_event (&event);
3693 /* Discard any mouse events in the event buffer by setting them to
3694 NO_EVENT. */
3695 void
3696 discard_mouse_events ()
3698 struct input_event *sp;
3699 for (sp = kbd_fetch_ptr; sp != kbd_store_ptr; sp++)
3701 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3702 sp = kbd_buffer;
3704 if (sp->kind == MOUSE_CLICK_EVENT
3705 || sp->kind == WHEEL_EVENT
3706 #ifdef WINDOWSNT
3707 || sp->kind == W32_SCROLL_BAR_CLICK_EVENT
3708 #endif
3709 || sp->kind == SCROLL_BAR_CLICK_EVENT)
3711 sp->kind = NO_EVENT;
3717 /* Return non-zero if there are any real events waiting in the event
3718 buffer, not counting `NO_EVENT's.
3720 If DISCARD is non-zero, discard NO_EVENT events at the front of
3721 the input queue, possibly leaving the input queue empty if there
3722 are no real input events. */
3725 kbd_buffer_events_waiting (discard)
3726 int discard;
3728 struct input_event *sp;
3730 for (sp = kbd_fetch_ptr;
3731 sp != kbd_store_ptr && sp->kind == NO_EVENT;
3732 ++sp)
3734 if (sp == kbd_buffer + KBD_BUFFER_SIZE)
3735 sp = kbd_buffer;
3738 if (discard)
3739 kbd_fetch_ptr = sp;
3741 return sp != kbd_store_ptr && sp->kind != NO_EVENT;
3745 /* Clear input event EVENT. */
3747 static INLINE void
3748 clear_event (event)
3749 struct input_event *event;
3751 event->kind = NO_EVENT;
3755 /* Read one event from the event buffer, waiting if necessary.
3756 The value is a Lisp object representing the event.
3757 The value is nil for an event that should be ignored,
3758 or that was handled here.
3759 We always read and discard one event. */
3761 static Lisp_Object
3762 kbd_buffer_get_event (kbp, used_mouse_menu)
3763 KBOARD **kbp;
3764 int *used_mouse_menu;
3766 register int c;
3767 Lisp_Object obj;
3769 if (noninteractive)
3771 c = getchar ();
3772 XSETINT (obj, c);
3773 *kbp = current_kboard;
3774 return obj;
3777 /* Wait until there is input available. */
3778 for (;;)
3780 if (kbd_fetch_ptr != kbd_store_ptr)
3781 break;
3782 #ifdef HAVE_MOUSE
3783 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
3784 break;
3785 #endif
3787 /* If the quit flag is set, then read_char will return
3788 quit_char, so that counts as "available input." */
3789 if (!NILP (Vquit_flag))
3790 quit_throw_to_read_char ();
3792 /* One way or another, wait until input is available; then, if
3793 interrupt handlers have not read it, read it now. */
3795 #ifdef OLDVMS
3796 wait_for_kbd_input ();
3797 #else
3798 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3799 #ifdef SIGIO
3800 gobble_input (0);
3801 #endif /* SIGIO */
3802 if (kbd_fetch_ptr != kbd_store_ptr)
3803 break;
3804 #ifdef HAVE_MOUSE
3805 if (!NILP (do_mouse_tracking) && some_mouse_moved ())
3806 break;
3807 #endif
3809 Lisp_Object minus_one;
3811 XSETINT (minus_one, -1);
3812 wait_reading_process_input (0, 0, minus_one, 1);
3814 if (!interrupt_input && kbd_fetch_ptr == kbd_store_ptr)
3815 /* Pass 1 for EXPECT since we just waited to have input. */
3816 read_avail_input (1);
3818 #endif /* not VMS */
3821 if (CONSP (Vunread_command_events))
3823 Lisp_Object first;
3824 first = XCAR (Vunread_command_events);
3825 Vunread_command_events = XCDR (Vunread_command_events);
3826 *kbp = current_kboard;
3827 return first;
3830 /* At this point, we know that there is a readable event available
3831 somewhere. If the event queue is empty, then there must be a
3832 mouse movement enabled and available. */
3833 if (kbd_fetch_ptr != kbd_store_ptr)
3835 struct input_event *event;
3837 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
3838 ? kbd_fetch_ptr
3839 : kbd_buffer);
3841 last_event_timestamp = event->timestamp;
3843 #ifdef MULTI_KBOARD
3844 *kbp = event_to_kboard (event);
3845 if (*kbp == 0)
3846 *kbp = current_kboard; /* Better than returning null ptr? */
3847 #else
3848 *kbp = &the_only_kboard;
3849 #endif
3851 obj = Qnil;
3853 /* These two kinds of events get special handling
3854 and don't actually appear to the command loop.
3855 We return nil for them. */
3856 if (event->kind == SELECTION_REQUEST_EVENT)
3858 #ifdef HAVE_X11
3859 struct input_event copy;
3861 /* Remove it from the buffer before processing it,
3862 since otherwise swallow_events will see it
3863 and process it again. */
3864 copy = *event;
3865 kbd_fetch_ptr = event + 1;
3866 input_pending = readable_events (0);
3867 x_handle_selection_request (&copy);
3868 #else
3869 /* We're getting selection request events, but we don't have
3870 a window system. */
3871 abort ();
3872 #endif
3875 else if (event->kind == SELECTION_CLEAR_EVENT)
3877 #ifdef HAVE_X11
3878 struct input_event copy;
3880 /* Remove it from the buffer before processing it. */
3881 copy = *event;
3882 kbd_fetch_ptr = event + 1;
3883 input_pending = readable_events (0);
3884 x_handle_selection_clear (&copy);
3885 #else
3886 /* We're getting selection request events, but we don't have
3887 a window system. */
3888 abort ();
3889 #endif
3891 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
3892 else if (event->kind == DELETE_WINDOW_EVENT)
3894 /* Make an event (delete-frame (FRAME)). */
3895 obj = Fcons (event->frame_or_window, Qnil);
3896 obj = Fcons (Qdelete_frame, Fcons (obj, Qnil));
3897 kbd_fetch_ptr = event + 1;
3899 #endif
3900 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
3901 else if (event->kind == ICONIFY_EVENT)
3903 /* Make an event (iconify-frame (FRAME)). */
3904 obj = Fcons (event->frame_or_window, Qnil);
3905 obj = Fcons (Qiconify_frame, Fcons (obj, Qnil));
3906 kbd_fetch_ptr = event + 1;
3908 else if (event->kind == DEICONIFY_EVENT)
3910 /* Make an event (make-frame-visible (FRAME)). */
3911 obj = Fcons (event->frame_or_window, Qnil);
3912 obj = Fcons (Qmake_frame_visible, Fcons (obj, Qnil));
3913 kbd_fetch_ptr = event + 1;
3915 #endif
3916 else if (event->kind == BUFFER_SWITCH_EVENT)
3918 /* The value doesn't matter here; only the type is tested. */
3919 XSETBUFFER (obj, current_buffer);
3920 kbd_fetch_ptr = event + 1;
3922 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
3923 || defined (USE_GTK)
3924 else if (event->kind == MENU_BAR_ACTIVATE_EVENT)
3926 kbd_fetch_ptr = event + 1;
3927 input_pending = readable_events (0);
3928 if (FRAME_LIVE_P (XFRAME (event->frame_or_window)))
3929 x_activate_menubar (XFRAME (event->frame_or_window));
3931 #endif
3932 #ifdef WINDOWSNT
3933 else if (event->kind == LANGUAGE_CHANGE_EVENT)
3935 /* Make an event (language-change (FRAME CHARSET LCID)). */
3936 obj = Fcons (event->modifiers, Qnil);
3937 obj = Fcons (event->code, obj);
3938 obj = Fcons (event->frame_or_window, obj);
3939 obj = Fcons (Qlanguage_change, Fcons (obj, Qnil));
3940 kbd_fetch_ptr = event + 1;
3942 #endif
3943 else if (event->kind == SAVE_SESSION_EVENT)
3945 obj = Fcons (Qsave_session, Qnil);
3946 kbd_fetch_ptr = event + 1;
3948 /* Just discard these, by returning nil.
3949 With MULTI_KBOARD, these events are used as placeholders
3950 when we need to randomly delete events from the queue.
3951 (They shouldn't otherwise be found in the buffer,
3952 but on some machines it appears they do show up
3953 even without MULTI_KBOARD.) */
3954 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3955 mouse events during a popup-menu call. */
3956 else if (event->kind == NO_EVENT)
3957 kbd_fetch_ptr = event + 1;
3958 else if (event->kind == HELP_EVENT)
3960 Lisp_Object object, position, help, frame, window;
3962 frame = event->frame_or_window;
3963 object = event->arg;
3964 position = make_number (event->code);
3965 window = event->x;
3966 help = event->y;
3967 clear_event (event);
3969 kbd_fetch_ptr = event + 1;
3970 if (!WINDOWP (window))
3971 window = Qnil;
3972 obj = Fcons (Qhelp_echo,
3973 list5 (frame, help, window, object, position));
3975 else if (event->kind == FOCUS_IN_EVENT)
3977 /* Notification of a FocusIn event. The frame receiving the
3978 focus is in event->frame_or_window. Generate a
3979 switch-frame event if necessary. */
3980 Lisp_Object frame, focus;
3982 frame = event->frame_or_window;
3983 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
3984 if (FRAMEP (focus))
3985 frame = focus;
3987 if (!EQ (frame, internal_last_event_frame)
3988 && !EQ (frame, selected_frame))
3989 obj = make_lispy_switch_frame (frame);
3990 internal_last_event_frame = frame;
3991 kbd_fetch_ptr = event + 1;
3993 else
3995 /* If this event is on a different frame, return a switch-frame this
3996 time, and leave the event in the queue for next time. */
3997 Lisp_Object frame;
3998 Lisp_Object focus;
4000 frame = event->frame_or_window;
4001 if (CONSP (frame))
4002 frame = XCAR (frame);
4003 else if (WINDOWP (frame))
4004 frame = WINDOW_FRAME (XWINDOW (frame));
4006 focus = FRAME_FOCUS_FRAME (XFRAME (frame));
4007 if (! NILP (focus))
4008 frame = focus;
4010 if (! EQ (frame, internal_last_event_frame)
4011 && !EQ (frame, selected_frame))
4012 obj = make_lispy_switch_frame (frame);
4013 internal_last_event_frame = frame;
4015 /* If we didn't decide to make a switch-frame event, go ahead
4016 and build a real event from the queue entry. */
4018 if (NILP (obj))
4020 obj = make_lispy_event (event);
4022 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4023 || defined (USE_GTK)
4024 /* If this was a menu selection, then set the flag to inhibit
4025 writing to last_nonmenu_event. Don't do this if the event
4026 we're returning is (menu-bar), though; that indicates the
4027 beginning of the menu sequence, and we might as well leave
4028 that as the `event with parameters' for this selection. */
4029 if (used_mouse_menu
4030 && !EQ (event->frame_or_window, event->arg)
4031 && (event->kind == MENU_BAR_EVENT
4032 || event->kind == TOOL_BAR_EVENT))
4033 *used_mouse_menu = 1;
4034 #endif
4036 /* Wipe out this event, to catch bugs. */
4037 clear_event (event);
4038 kbd_fetch_ptr = event + 1;
4042 #ifdef HAVE_MOUSE
4043 /* Try generating a mouse motion event. */
4044 else if (!NILP (do_mouse_tracking) && some_mouse_moved ())
4046 FRAME_PTR f = some_mouse_moved ();
4047 Lisp_Object bar_window;
4048 enum scroll_bar_part part;
4049 Lisp_Object x, y;
4050 unsigned long time;
4052 *kbp = current_kboard;
4053 /* Note that this uses F to determine which display to look at.
4054 If there is no valid info, it does not store anything
4055 so x remains nil. */
4056 x = Qnil;
4057 (*mouse_position_hook) (&f, 0, &bar_window, &part, &x, &y, &time);
4059 obj = Qnil;
4061 /* Decide if we should generate a switch-frame event. Don't
4062 generate switch-frame events for motion outside of all Emacs
4063 frames. */
4064 if (!NILP (x) && f)
4066 Lisp_Object frame;
4068 frame = FRAME_FOCUS_FRAME (f);
4069 if (NILP (frame))
4070 XSETFRAME (frame, f);
4072 if (! EQ (frame, internal_last_event_frame)
4073 && !EQ (frame, selected_frame))
4074 obj = make_lispy_switch_frame (frame);
4075 internal_last_event_frame = frame;
4078 /* If we didn't decide to make a switch-frame event, go ahead and
4079 return a mouse-motion event. */
4080 if (!NILP (x) && NILP (obj))
4081 obj = make_lispy_movement (f, bar_window, part, x, y, time);
4083 #endif /* HAVE_MOUSE */
4084 else
4085 /* We were promised by the above while loop that there was
4086 something for us to read! */
4087 abort ();
4089 input_pending = readable_events (0);
4091 Vlast_event_frame = internal_last_event_frame;
4093 return (obj);
4096 /* Process any events that are not user-visible,
4097 then return, without reading any user-visible events. */
4099 void
4100 swallow_events (do_display)
4101 int do_display;
4103 int old_timers_run;
4105 while (kbd_fetch_ptr != kbd_store_ptr)
4107 struct input_event *event;
4109 event = ((kbd_fetch_ptr < kbd_buffer + KBD_BUFFER_SIZE)
4110 ? kbd_fetch_ptr
4111 : kbd_buffer);
4113 last_event_timestamp = event->timestamp;
4115 /* These two kinds of events get special handling
4116 and don't actually appear to the command loop. */
4117 if (event->kind == SELECTION_REQUEST_EVENT)
4119 #ifdef HAVE_X11
4120 struct input_event copy;
4122 /* Remove it from the buffer before processing it,
4123 since otherwise swallow_events called recursively could see it
4124 and process it again. */
4125 copy = *event;
4126 kbd_fetch_ptr = event + 1;
4127 input_pending = readable_events (0);
4128 x_handle_selection_request (&copy);
4129 #else
4130 /* We're getting selection request events, but we don't have
4131 a window system. */
4132 abort ();
4133 #endif
4136 else if (event->kind == SELECTION_CLEAR_EVENT)
4138 #ifdef HAVE_X11
4139 struct input_event copy;
4141 /* Remove it from the buffer before processing it, */
4142 copy = *event;
4144 kbd_fetch_ptr = event + 1;
4145 input_pending = readable_events (0);
4146 x_handle_selection_clear (&copy);
4147 #else
4148 /* We're getting selection request events, but we don't have
4149 a window system. */
4150 abort ();
4151 #endif
4153 else
4154 break;
4157 old_timers_run = timers_run;
4158 get_input_pending (&input_pending, 1);
4160 if (timers_run != old_timers_run && do_display)
4161 redisplay_preserve_echo_area (7);
4164 /* Record the start of when Emacs is idle,
4165 for the sake of running idle-time timers. */
4167 void
4168 timer_start_idle ()
4170 Lisp_Object timers;
4172 /* If we are already in the idle state, do nothing. */
4173 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4174 return;
4176 EMACS_GET_TIME (timer_idleness_start_time);
4178 timer_last_idleness_start_time = timer_idleness_start_time;
4180 /* Mark all idle-time timers as once again candidates for running. */
4181 for (timers = Vtimer_idle_list; CONSP (timers); timers = XCDR (timers))
4183 Lisp_Object timer;
4185 timer = XCAR (timers);
4187 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4188 continue;
4189 XVECTOR (timer)->contents[0] = Qnil;
4193 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4195 void
4196 timer_stop_idle ()
4198 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
4201 /* This is only for debugging. */
4202 struct input_event last_timer_event;
4204 /* Check whether a timer has fired. To prevent larger problems we simply
4205 disregard elements that are not proper timers. Do not make a circular
4206 timer list for the time being.
4208 Returns the number of seconds to wait until the next timer fires. If a
4209 timer is triggering now, return zero seconds.
4210 If no timer is active, return -1 seconds.
4212 If a timer is ripe, we run it, with quitting turned off.
4214 DO_IT_NOW is now ignored. It used to mean that we should
4215 run the timer directly instead of queueing a timer-event.
4216 Now we always run timers directly. */
4218 EMACS_TIME
4219 timer_check (do_it_now)
4220 int do_it_now;
4222 EMACS_TIME nexttime;
4223 EMACS_TIME now, idleness_now;
4224 Lisp_Object timers, idle_timers, chosen_timer;
4225 struct gcpro gcpro1, gcpro2, gcpro3;
4227 EMACS_SET_SECS (nexttime, -1);
4228 EMACS_SET_USECS (nexttime, -1);
4230 /* Always consider the ordinary timers. */
4231 timers = Vtimer_list;
4232 /* Consider the idle timers only if Emacs is idle. */
4233 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4234 idle_timers = Vtimer_idle_list;
4235 else
4236 idle_timers = Qnil;
4237 chosen_timer = Qnil;
4238 GCPRO3 (timers, idle_timers, chosen_timer);
4240 if (CONSP (timers) || CONSP (idle_timers))
4242 EMACS_GET_TIME (now);
4243 if (! EMACS_TIME_NEG_P (timer_idleness_start_time))
4244 EMACS_SUB_TIME (idleness_now, now, timer_idleness_start_time);
4247 while (CONSP (timers) || CONSP (idle_timers))
4249 Lisp_Object *vector;
4250 Lisp_Object timer = Qnil, idle_timer = Qnil;
4251 EMACS_TIME timer_time, idle_timer_time;
4252 EMACS_TIME difference, timer_difference, idle_timer_difference;
4254 /* Skip past invalid timers and timers already handled. */
4255 if (!NILP (timers))
4257 timer = XCAR (timers);
4258 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4260 timers = XCDR (timers);
4261 continue;
4263 vector = XVECTOR (timer)->contents;
4265 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4266 || !INTEGERP (vector[3])
4267 || ! NILP (vector[0]))
4269 timers = XCDR (timers);
4270 continue;
4273 if (!NILP (idle_timers))
4275 timer = XCAR (idle_timers);
4276 if (!VECTORP (timer) || XVECTOR (timer)->size != 8)
4278 idle_timers = XCDR (idle_timers);
4279 continue;
4281 vector = XVECTOR (timer)->contents;
4283 if (!INTEGERP (vector[1]) || !INTEGERP (vector[2])
4284 || !INTEGERP (vector[3])
4285 || ! NILP (vector[0]))
4287 idle_timers = XCDR (idle_timers);
4288 continue;
4292 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4293 based on the next ordinary timer.
4294 TIMER_DIFFERENCE is the distance in time from NOW to when
4295 this timer becomes ripe (negative if it's already ripe). */
4296 if (!NILP (timers))
4298 timer = XCAR (timers);
4299 vector = XVECTOR (timer)->contents;
4300 EMACS_SET_SECS (timer_time,
4301 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4302 EMACS_SET_USECS (timer_time, XINT (vector[3]));
4303 EMACS_SUB_TIME (timer_difference, timer_time, now);
4306 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4307 based on the next idle timer. */
4308 if (!NILP (idle_timers))
4310 idle_timer = XCAR (idle_timers);
4311 vector = XVECTOR (idle_timer)->contents;
4312 EMACS_SET_SECS (idle_timer_time,
4313 (XINT (vector[1]) << 16) | (XINT (vector[2])));
4314 EMACS_SET_USECS (idle_timer_time, XINT (vector[3]));
4315 EMACS_SUB_TIME (idle_timer_difference, idle_timer_time, idleness_now);
4318 /* Decide which timer is the next timer,
4319 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4320 Also step down the list where we found that timer. */
4322 if (! NILP (timers) && ! NILP (idle_timers))
4324 EMACS_TIME temp;
4325 EMACS_SUB_TIME (temp, timer_difference, idle_timer_difference);
4326 if (EMACS_TIME_NEG_P (temp))
4328 chosen_timer = timer;
4329 timers = XCDR (timers);
4330 difference = timer_difference;
4332 else
4334 chosen_timer = idle_timer;
4335 idle_timers = XCDR (idle_timers);
4336 difference = idle_timer_difference;
4339 else if (! NILP (timers))
4341 chosen_timer = timer;
4342 timers = XCDR (timers);
4343 difference = timer_difference;
4345 else
4347 chosen_timer = idle_timer;
4348 idle_timers = XCDR (idle_timers);
4349 difference = idle_timer_difference;
4351 vector = XVECTOR (chosen_timer)->contents;
4353 /* If timer is ripe, run it if it hasn't been run. */
4354 if (EMACS_TIME_NEG_P (difference)
4355 || (EMACS_SECS (difference) == 0
4356 && EMACS_USECS (difference) == 0))
4358 if (NILP (vector[0]))
4360 int was_locked = single_kboard;
4361 int count = SPECPDL_INDEX ();
4362 Lisp_Object old_deactivate_mark = Vdeactivate_mark;
4364 /* Mark the timer as triggered to prevent problems if the lisp
4365 code fails to reschedule it right. */
4366 vector[0] = Qt;
4368 specbind (Qinhibit_quit, Qt);
4370 call1 (Qtimer_event_handler, chosen_timer);
4371 Vdeactivate_mark = old_deactivate_mark;
4372 timers_run++;
4373 unbind_to (count, Qnil);
4375 /* Resume allowing input from any kboard, if that was true before. */
4376 if (!was_locked)
4377 any_kboard_state ();
4379 /* Since we have handled the event,
4380 we don't need to tell the caller to wake up and do it. */
4383 else
4384 /* When we encounter a timer that is still waiting,
4385 return the amount of time to wait before it is ripe. */
4387 UNGCPRO;
4388 return difference;
4392 /* No timers are pending in the future. */
4393 /* Return 0 if we generated an event, and -1 if not. */
4394 UNGCPRO;
4395 return nexttime;
4398 /* Caches for modify_event_symbol. */
4399 static Lisp_Object accent_key_syms;
4400 static Lisp_Object func_key_syms;
4401 static Lisp_Object mouse_syms;
4402 static Lisp_Object wheel_syms;
4403 static Lisp_Object drag_n_drop_syms;
4405 /* This is a list of keysym codes for special "accent" characters.
4406 It parallels lispy_accent_keys. */
4408 static int lispy_accent_codes[] =
4410 #ifdef XK_dead_circumflex
4411 XK_dead_circumflex,
4412 #else
4414 #endif
4415 #ifdef XK_dead_grave
4416 XK_dead_grave,
4417 #else
4419 #endif
4420 #ifdef XK_dead_tilde
4421 XK_dead_tilde,
4422 #else
4424 #endif
4425 #ifdef XK_dead_diaeresis
4426 XK_dead_diaeresis,
4427 #else
4429 #endif
4430 #ifdef XK_dead_macron
4431 XK_dead_macron,
4432 #else
4434 #endif
4435 #ifdef XK_dead_degree
4436 XK_dead_degree,
4437 #else
4439 #endif
4440 #ifdef XK_dead_acute
4441 XK_dead_acute,
4442 #else
4444 #endif
4445 #ifdef XK_dead_cedilla
4446 XK_dead_cedilla,
4447 #else
4449 #endif
4450 #ifdef XK_dead_breve
4451 XK_dead_breve,
4452 #else
4454 #endif
4455 #ifdef XK_dead_ogonek
4456 XK_dead_ogonek,
4457 #else
4459 #endif
4460 #ifdef XK_dead_caron
4461 XK_dead_caron,
4462 #else
4464 #endif
4465 #ifdef XK_dead_doubleacute
4466 XK_dead_doubleacute,
4467 #else
4469 #endif
4470 #ifdef XK_dead_abovedot
4471 XK_dead_abovedot,
4472 #else
4474 #endif
4475 #ifdef XK_dead_abovering
4476 XK_dead_abovering,
4477 #else
4479 #endif
4480 #ifdef XK_dead_iota
4481 XK_dead_iota,
4482 #else
4484 #endif
4485 #ifdef XK_dead_belowdot
4486 XK_dead_belowdot,
4487 #else
4489 #endif
4490 #ifdef XK_dead_voiced_sound
4491 XK_dead_voiced_sound,
4492 #else
4494 #endif
4495 #ifdef XK_dead_semivoiced_sound
4496 XK_dead_semivoiced_sound,
4497 #else
4499 #endif
4500 #ifdef XK_dead_hook
4501 XK_dead_hook,
4502 #else
4504 #endif
4505 #ifdef XK_dead_horn
4506 XK_dead_horn,
4507 #else
4509 #endif
4512 /* This is a list of Lisp names for special "accent" characters.
4513 It parallels lispy_accent_codes. */
4515 static char *lispy_accent_keys[] =
4517 "dead-circumflex",
4518 "dead-grave",
4519 "dead-tilde",
4520 "dead-diaeresis",
4521 "dead-macron",
4522 "dead-degree",
4523 "dead-acute",
4524 "dead-cedilla",
4525 "dead-breve",
4526 "dead-ogonek",
4527 "dead-caron",
4528 "dead-doubleacute",
4529 "dead-abovedot",
4530 "dead-abovering",
4531 "dead-iota",
4532 "dead-belowdot",
4533 "dead-voiced-sound",
4534 "dead-semivoiced-sound",
4535 "dead-hook",
4536 "dead-horn",
4539 #ifdef HAVE_NTGUI
4540 #define FUNCTION_KEY_OFFSET 0x0
4542 char *lispy_function_keys[] =
4544 0, /* 0 */
4546 0, /* VK_LBUTTON 0x01 */
4547 0, /* VK_RBUTTON 0x02 */
4548 "cancel", /* VK_CANCEL 0x03 */
4549 0, /* VK_MBUTTON 0x04 */
4551 0, 0, 0, /* 0x05 .. 0x07 */
4553 "backspace", /* VK_BACK 0x08 */
4554 "tab", /* VK_TAB 0x09 */
4556 0, 0, /* 0x0A .. 0x0B */
4558 "clear", /* VK_CLEAR 0x0C */
4559 "return", /* VK_RETURN 0x0D */
4561 0, 0, /* 0x0E .. 0x0F */
4563 0, /* VK_SHIFT 0x10 */
4564 0, /* VK_CONTROL 0x11 */
4565 0, /* VK_MENU 0x12 */
4566 "pause", /* VK_PAUSE 0x13 */
4567 "capslock", /* VK_CAPITAL 0x14 */
4569 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4571 "escape", /* VK_ESCAPE 0x1B */
4573 0, 0, 0, 0, /* 0x1C .. 0x1F */
4575 0, /* VK_SPACE 0x20 */
4576 "prior", /* VK_PRIOR 0x21 */
4577 "next", /* VK_NEXT 0x22 */
4578 "end", /* VK_END 0x23 */
4579 "home", /* VK_HOME 0x24 */
4580 "left", /* VK_LEFT 0x25 */
4581 "up", /* VK_UP 0x26 */
4582 "right", /* VK_RIGHT 0x27 */
4583 "down", /* VK_DOWN 0x28 */
4584 "select", /* VK_SELECT 0x29 */
4585 "print", /* VK_PRINT 0x2A */
4586 "execute", /* VK_EXECUTE 0x2B */
4587 "snapshot", /* VK_SNAPSHOT 0x2C */
4588 "insert", /* VK_INSERT 0x2D */
4589 "delete", /* VK_DELETE 0x2E */
4590 "help", /* VK_HELP 0x2F */
4592 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4594 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4596 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4598 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4600 0, 0, 0, 0, 0, 0, 0, 0, 0,
4601 0, 0, 0, 0, 0, 0, 0, 0, 0,
4602 0, 0, 0, 0, 0, 0, 0, 0,
4604 "lwindow", /* VK_LWIN 0x5B */
4605 "rwindow", /* VK_RWIN 0x5C */
4606 "apps", /* VK_APPS 0x5D */
4608 0, 0, /* 0x5E .. 0x5F */
4610 "kp-0", /* VK_NUMPAD0 0x60 */
4611 "kp-1", /* VK_NUMPAD1 0x61 */
4612 "kp-2", /* VK_NUMPAD2 0x62 */
4613 "kp-3", /* VK_NUMPAD3 0x63 */
4614 "kp-4", /* VK_NUMPAD4 0x64 */
4615 "kp-5", /* VK_NUMPAD5 0x65 */
4616 "kp-6", /* VK_NUMPAD6 0x66 */
4617 "kp-7", /* VK_NUMPAD7 0x67 */
4618 "kp-8", /* VK_NUMPAD8 0x68 */
4619 "kp-9", /* VK_NUMPAD9 0x69 */
4620 "kp-multiply", /* VK_MULTIPLY 0x6A */
4621 "kp-add", /* VK_ADD 0x6B */
4622 "kp-separator", /* VK_SEPARATOR 0x6C */
4623 "kp-subtract", /* VK_SUBTRACT 0x6D */
4624 "kp-decimal", /* VK_DECIMAL 0x6E */
4625 "kp-divide", /* VK_DIVIDE 0x6F */
4626 "f1", /* VK_F1 0x70 */
4627 "f2", /* VK_F2 0x71 */
4628 "f3", /* VK_F3 0x72 */
4629 "f4", /* VK_F4 0x73 */
4630 "f5", /* VK_F5 0x74 */
4631 "f6", /* VK_F6 0x75 */
4632 "f7", /* VK_F7 0x76 */
4633 "f8", /* VK_F8 0x77 */
4634 "f9", /* VK_F9 0x78 */
4635 "f10", /* VK_F10 0x79 */
4636 "f11", /* VK_F11 0x7A */
4637 "f12", /* VK_F12 0x7B */
4638 "f13", /* VK_F13 0x7C */
4639 "f14", /* VK_F14 0x7D */
4640 "f15", /* VK_F15 0x7E */
4641 "f16", /* VK_F16 0x7F */
4642 "f17", /* VK_F17 0x80 */
4643 "f18", /* VK_F18 0x81 */
4644 "f19", /* VK_F19 0x82 */
4645 "f20", /* VK_F20 0x83 */
4646 "f21", /* VK_F21 0x84 */
4647 "f22", /* VK_F22 0x85 */
4648 "f23", /* VK_F23 0x86 */
4649 "f24", /* VK_F24 0x87 */
4651 0, 0, 0, 0, /* 0x88 .. 0x8B */
4652 0, 0, 0, 0, /* 0x8C .. 0x8F */
4654 "kp-numlock", /* VK_NUMLOCK 0x90 */
4655 "scroll", /* VK_SCROLL 0x91 */
4657 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4658 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4659 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4660 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4661 "kp-end", /* VK_NUMPAD_END 0x96 */
4662 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4663 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4664 "kp-up", /* VK_NUMPAD_UP 0x99 */
4665 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4666 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4667 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4668 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4670 0, 0, /* 0x9E .. 0x9F */
4673 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4674 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4675 * No other API or message will distinguish left and right keys this way.
4677 /* 0xA0 .. 0xEF */
4679 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4680 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4681 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4682 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4683 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4685 /* 0xF0 .. 0xF5 */
4687 0, 0, 0, 0, 0, 0,
4689 "attn", /* VK_ATTN 0xF6 */
4690 "crsel", /* VK_CRSEL 0xF7 */
4691 "exsel", /* VK_EXSEL 0xF8 */
4692 "ereof", /* VK_EREOF 0xF9 */
4693 "play", /* VK_PLAY 0xFA */
4694 "zoom", /* VK_ZOOM 0xFB */
4695 "noname", /* VK_NONAME 0xFC */
4696 "pa1", /* VK_PA1 0xFD */
4697 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4698 0 /* 0xFF */
4701 #else /* not HAVE_NTGUI */
4703 /* This should be dealt with in XTread_socket now, and that doesn't
4704 depend on the client system having the Kana syms defined. See also
4705 the XK_kana_A case below. */
4706 #if 0
4707 #ifdef XK_kana_A
4708 static char *lispy_kana_keys[] =
4710 /* X Keysym value */
4711 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4712 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4713 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4714 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4715 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4716 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4717 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4718 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4719 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4720 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4721 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4722 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4723 "kana-i", "kana-u", "kana-e", "kana-o",
4724 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4725 "prolongedsound", "kana-A", "kana-I", "kana-U",
4726 "kana-E", "kana-O", "kana-KA", "kana-KI",
4727 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4728 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4729 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4730 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4731 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4732 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4733 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4734 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4735 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4736 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4737 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4738 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4740 #endif /* XK_kana_A */
4741 #endif /* 0 */
4743 #define FUNCTION_KEY_OFFSET 0xff00
4745 /* You'll notice that this table is arranged to be conveniently
4746 indexed by X Windows keysym values. */
4747 static char *lispy_function_keys[] =
4749 /* X Keysym value */
4751 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4752 "backspace", "tab", "linefeed", "clear",
4753 0, "return", 0, 0,
4754 0, 0, 0, "pause", /* 0xff10...1f */
4755 0, 0, 0, 0, 0, 0, 0, "escape",
4756 0, 0, 0, 0,
4757 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4758 "romaji", "hiragana", "katakana", "hiragana-katakana",
4759 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4760 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4761 "eisu-toggle", /* 0xff30...3f */
4762 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4763 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4765 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4766 "down", "prior", "next", "end",
4767 "begin", 0, 0, 0, 0, 0, 0, 0,
4768 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4769 "print",
4770 "execute",
4771 "insert",
4772 0, /* 0xff64 */
4773 "undo",
4774 "redo",
4775 "menu",
4776 "find",
4777 "cancel",
4778 "help",
4779 "break", /* 0xff6b */
4781 0, 0, 0, 0,
4782 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4783 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4784 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4785 0, 0, 0, 0, 0, 0, 0, 0,
4786 "kp-tab", /* 0xff89 */
4787 0, 0, 0,
4788 "kp-enter", /* 0xff8d */
4789 0, 0, 0,
4790 "kp-f1", /* 0xff91 */
4791 "kp-f2",
4792 "kp-f3",
4793 "kp-f4",
4794 "kp-home", /* 0xff95 */
4795 "kp-left",
4796 "kp-up",
4797 "kp-right",
4798 "kp-down",
4799 "kp-prior", /* kp-page-up */
4800 "kp-next", /* kp-page-down */
4801 "kp-end",
4802 "kp-begin",
4803 "kp-insert",
4804 "kp-delete",
4805 0, /* 0xffa0 */
4806 0, 0, 0, 0, 0, 0, 0, 0, 0,
4807 "kp-multiply", /* 0xffaa */
4808 "kp-add",
4809 "kp-separator",
4810 "kp-subtract",
4811 "kp-decimal",
4812 "kp-divide", /* 0xffaf */
4813 "kp-0", /* 0xffb0 */
4814 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4815 0, /* 0xffba */
4816 0, 0,
4817 "kp-equal", /* 0xffbd */
4818 "f1", /* 0xffbe */ /* IsFunctionKey */
4819 "f2",
4820 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4821 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4822 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4823 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4824 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4825 0, 0, 0, 0, 0, 0, 0, 0,
4826 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4827 0, 0, 0, 0, 0, 0, 0, "delete"
4830 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4831 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4833 static char *iso_lispy_function_keys[] =
4835 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4836 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4837 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4838 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4839 "iso-lefttab", /* 0xfe20 */
4840 "iso-move-line-up", "iso-move-line-down",
4841 "iso-partial-line-up", "iso-partial-line-down",
4842 "iso-partial-space-left", "iso-partial-space-right",
4843 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4844 "iso-release-margin-left", "iso-release-margin-right",
4845 "iso-release-both-margins",
4846 "iso-fast-cursor-left", "iso-fast-cursor-right",
4847 "iso-fast-cursor-up", "iso-fast-cursor-down",
4848 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4849 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4852 #endif /* not HAVE_NTGUI */
4854 Lisp_Object Vlispy_mouse_stem;
4856 static char *lispy_wheel_names[] =
4858 "wheel-up", "wheel-down"
4861 /* drag-n-drop events are generated when a set of selected files are
4862 dragged from another application and dropped onto an Emacs window. */
4863 static char *lispy_drag_n_drop_names[] =
4865 "drag-n-drop"
4868 /* Scroll bar parts. */
4869 Lisp_Object Qabove_handle, Qhandle, Qbelow_handle;
4870 Lisp_Object Qup, Qdown, Qbottom, Qend_scroll;
4871 Lisp_Object Qtop, Qratio;
4873 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4874 Lisp_Object *scroll_bar_parts[] = {
4875 &Qabove_handle, &Qhandle, &Qbelow_handle,
4876 &Qup, &Qdown, &Qtop, &Qbottom, &Qend_scroll, &Qratio
4879 /* User signal events. */
4880 Lisp_Object Qusr1_signal, Qusr2_signal;
4882 Lisp_Object *lispy_user_signals[] =
4884 &Qusr1_signal, &Qusr2_signal
4888 /* A vector, indexed by button number, giving the down-going location
4889 of currently depressed buttons, both scroll bar and non-scroll bar.
4891 The elements have the form
4892 (BUTTON-NUMBER MODIFIER-MASK . REST)
4893 where REST is the cdr of a position as it would be reported in the event.
4895 The make_lispy_event function stores positions here to tell the
4896 difference between click and drag events, and to store the starting
4897 location to be included in drag events. */
4899 static Lisp_Object button_down_location;
4901 /* Information about the most recent up-going button event: Which
4902 button, what location, and what time. */
4904 static int last_mouse_button;
4905 static int last_mouse_x;
4906 static int last_mouse_y;
4907 static unsigned long button_down_time;
4909 /* The maximum time between clicks to make a double-click, or Qnil to
4910 disable double-click detection, or Qt for no time limit. */
4912 Lisp_Object Vdouble_click_time;
4914 /* Maximum number of pixels the mouse may be moved between clicks
4915 to make a double-click. */
4917 EMACS_INT double_click_fuzz;
4919 /* The number of clicks in this multiple-click. */
4921 int double_click_count;
4923 /* Return position of a mouse click or wheel event */
4925 static Lisp_Object
4926 make_lispy_position (f, x, y, time)
4927 struct frame *f;
4928 Lisp_Object *x, *y;
4929 unsigned long time;
4931 Lisp_Object window;
4932 enum window_part part;
4933 Lisp_Object posn = Qnil;
4934 Lisp_Object extra_info = Qnil;
4935 int wx, wy;
4937 /* Set `window' to the window under frame pixel coordinates (x,y) */
4938 if (f)
4939 window = window_from_coordinates (f, XINT (*x), XINT (*y),
4940 &part, &wx, &wy, 0);
4941 else
4942 window = Qnil;
4944 if (WINDOWP (window))
4946 /* It's a click in window window at frame coordinates (x,y) */
4947 struct window *w = XWINDOW (window);
4948 Lisp_Object string_info = Qnil;
4949 int textpos = -1, rx = -1, ry = -1;
4950 int dx = -1, dy = -1;
4951 int width = -1, height = -1;
4952 Lisp_Object object = Qnil;
4954 /* Set event coordinates to window-relative coordinates
4955 for constructing the Lisp event below. */
4956 XSETINT (*x, wx);
4957 XSETINT (*y, wy);
4959 if (part == ON_MODE_LINE || part == ON_HEADER_LINE)
4961 /* Mode line or header line. Look for a string under
4962 the mouse that may have a `local-map' property. */
4963 Lisp_Object string;
4964 int charpos;
4966 posn = part == ON_MODE_LINE ? Qmode_line : Qheader_line;
4967 rx = wx, ry = wy;
4968 string = mode_line_string (w, part, &rx, &ry, &charpos,
4969 &object, &dx, &dy, &width, &height);
4970 if (STRINGP (string))
4971 string_info = Fcons (string, make_number (charpos));
4972 if (w == XWINDOW (selected_window))
4973 textpos = PT;
4974 else
4975 textpos = XMARKER (w->pointm)->charpos;
4977 else if (part == ON_VERTICAL_BORDER)
4979 posn = Qvertical_line;
4980 wx = -1;
4981 dx = 0;
4982 width = 1;
4984 else if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
4986 Lisp_Object string;
4987 int charpos;
4989 posn = (part == ON_LEFT_MARGIN) ? Qleft_margin : Qright_margin;
4990 rx = wx, ry = wy;
4991 string = marginal_area_string (w, part, &rx, &ry, &charpos,
4992 &object, &dx, &dy, &width, &height);
4993 if (STRINGP (string))
4994 string_info = Fcons (string, make_number (charpos));
4996 else if (part == ON_LEFT_FRINGE || part == ON_RIGHT_FRINGE)
4998 posn = (part == ON_LEFT_FRINGE) ? Qleft_fringe : Qright_fringe;
4999 rx = 0;
5000 dx = wx;
5001 if (part == ON_RIGHT_FRINGE)
5002 dx -= (window_box_width (w, LEFT_MARGIN_AREA)
5003 + window_box_width (w, TEXT_AREA)
5004 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5005 ? window_box_width (w, RIGHT_MARGIN_AREA)
5006 : 0));
5007 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
5008 dx -= window_box_width (w, LEFT_MARGIN_AREA);
5011 if (textpos < 0)
5013 Lisp_Object string2, object2 = Qnil;
5014 struct display_pos p;
5015 int dx2, dy2;
5016 int width2, height2;
5017 wx = max (WINDOW_LEFT_MARGIN_WIDTH (w), wx);
5018 string2 = buffer_posn_from_coords (w, &wx, &wy, &p,
5019 &object2, &dx2, &dy2,
5020 &width2, &height2);
5021 textpos = CHARPOS (p.pos);
5022 if (rx < 0) rx = wx;
5023 if (ry < 0) ry = wy;
5024 if (dx < 0) dx = dx2;
5025 if (dy < 0) dy = dy2;
5026 if (width < 0) width = width2;
5027 if (height < 0) height = height2;
5029 if (NILP (posn))
5031 posn = make_number (textpos);
5032 if (STRINGP (string2))
5033 string_info = Fcons (string2,
5034 make_number (CHARPOS (p.string_pos)));
5036 if (NILP (object))
5037 object = object2;
5040 #ifdef HAVE_WINDOW_SYSTEM
5041 if (IMAGEP (object))
5043 Lisp_Object image_map, hotspot;
5044 if ((image_map = Fplist_get (XCDR (object), QCmap),
5045 !NILP (image_map))
5046 && (hotspot = find_hot_spot (image_map, dx, dy),
5047 CONSP (hotspot))
5048 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
5049 posn = XCAR (hotspot);
5051 #endif
5053 /* Object info */
5054 extra_info = Fcons (object,
5055 Fcons (Fcons (make_number (dx),
5056 make_number (dy)),
5057 Fcons (Fcons (make_number (width),
5058 make_number (height)),
5059 Qnil)));
5061 /* String info */
5062 extra_info = Fcons (string_info,
5063 Fcons (make_number (textpos),
5064 Fcons (Fcons (make_number (rx),
5065 make_number (ry)),
5066 extra_info)));
5068 else if (f != 0)
5070 XSETFRAME (window, f);
5072 else
5074 window = Qnil;
5075 XSETFASTINT (*x, 0);
5076 XSETFASTINT (*y, 0);
5079 return Fcons (window,
5080 Fcons (posn,
5081 Fcons (Fcons (*x, *y),
5082 Fcons (make_number (time),
5083 extra_info))));
5086 /* Given a struct input_event, build the lisp event which represents
5087 it. If EVENT is 0, build a mouse movement event from the mouse
5088 movement buffer, which should have a movement event in it.
5090 Note that events must be passed to this function in the order they
5091 are received; this function stores the location of button presses
5092 in order to build drag events when the button is released. */
5094 static Lisp_Object
5095 make_lispy_event (event)
5096 struct input_event *event;
5098 int i;
5100 switch (SWITCH_ENUM_CAST (event->kind))
5102 /* A simple keystroke. */
5103 case ASCII_KEYSTROKE_EVENT:
5105 Lisp_Object lispy_c;
5106 int c = event->code & 0377;
5107 /* Turn ASCII characters into control characters
5108 when proper. */
5109 if (event->modifiers & ctrl_modifier)
5110 c = make_ctrl_char (c);
5112 /* Add in the other modifier bits. We took care of ctrl_modifier
5113 just above, and the shift key was taken care of by the X code,
5114 and applied to control characters by make_ctrl_char. */
5115 c |= (event->modifiers
5116 & (meta_modifier | alt_modifier
5117 | hyper_modifier | super_modifier));
5118 /* Distinguish Shift-SPC from SPC. */
5119 if ((event->code & 0377) == 040
5120 && event->modifiers & shift_modifier)
5121 c |= shift_modifier;
5122 button_down_time = 0;
5123 XSETFASTINT (lispy_c, c);
5124 return lispy_c;
5127 case MULTIBYTE_CHAR_KEYSTROKE_EVENT:
5129 Lisp_Object lispy_c;
5130 int c = event->code;
5132 /* Add in the other modifier bits. We took care of ctrl_modifier
5133 just above, and the shift key was taken care of by the X code,
5134 and applied to control characters by make_ctrl_char. */
5135 c |= (event->modifiers
5136 & (meta_modifier | alt_modifier
5137 | hyper_modifier | super_modifier | ctrl_modifier));
5138 /* What about the `shift' modifier ? */
5139 button_down_time = 0;
5140 XSETFASTINT (lispy_c, c);
5141 return lispy_c;
5144 /* A function key. The symbol may need to have modifier prefixes
5145 tacked onto it. */
5146 case NON_ASCII_KEYSTROKE_EVENT:
5147 button_down_time = 0;
5149 for (i = 0; i < sizeof (lispy_accent_codes) / sizeof (int); i++)
5150 if (event->code == lispy_accent_codes[i])
5151 return modify_event_symbol (i,
5152 event->modifiers,
5153 Qfunction_key, Qnil,
5154 lispy_accent_keys, &accent_key_syms,
5155 (sizeof (lispy_accent_keys)
5156 / sizeof (lispy_accent_keys[0])));
5158 #if 0
5159 #ifdef XK_kana_A
5160 if (event->code >= 0x400 && event->code < 0x500)
5161 return modify_event_symbol (event->code - 0x400,
5162 event->modifiers & ~shift_modifier,
5163 Qfunction_key, Qnil,
5164 lispy_kana_keys, &func_key_syms,
5165 (sizeof (lispy_kana_keys)
5166 / sizeof (lispy_kana_keys[0])));
5167 #endif /* XK_kana_A */
5168 #endif /* 0 */
5170 #ifdef ISO_FUNCTION_KEY_OFFSET
5171 if (event->code < FUNCTION_KEY_OFFSET
5172 && event->code >= ISO_FUNCTION_KEY_OFFSET)
5173 return modify_event_symbol (event->code - ISO_FUNCTION_KEY_OFFSET,
5174 event->modifiers,
5175 Qfunction_key, Qnil,
5176 iso_lispy_function_keys, &func_key_syms,
5177 (sizeof (iso_lispy_function_keys)
5178 / sizeof (iso_lispy_function_keys[0])));
5179 #endif
5181 /* Handle system-specific or unknown keysyms. */
5182 if (event->code & (1 << 28)
5183 || event->code - FUNCTION_KEY_OFFSET < 0
5184 || (event->code - FUNCTION_KEY_OFFSET
5185 >= sizeof lispy_function_keys / sizeof *lispy_function_keys)
5186 || !lispy_function_keys[event->code - FUNCTION_KEY_OFFSET])
5188 /* We need to use an alist rather than a vector as the cache
5189 since we can't make a vector long enuf. */
5190 if (NILP (current_kboard->system_key_syms))
5191 current_kboard->system_key_syms = Fcons (Qnil, Qnil);
5192 return modify_event_symbol (event->code,
5193 event->modifiers,
5194 Qfunction_key,
5195 current_kboard->Vsystem_key_alist,
5196 0, &current_kboard->system_key_syms,
5197 (unsigned) -1);
5200 return modify_event_symbol (event->code - FUNCTION_KEY_OFFSET,
5201 event->modifiers,
5202 Qfunction_key, Qnil,
5203 lispy_function_keys, &func_key_syms,
5204 (sizeof (lispy_function_keys)
5205 / sizeof (lispy_function_keys[0])));
5207 #ifdef HAVE_MOUSE
5208 /* A mouse click. Figure out where it is, decide whether it's
5209 a press, click or drag, and build the appropriate structure. */
5210 case MOUSE_CLICK_EVENT:
5211 #ifndef USE_TOOLKIT_SCROLL_BARS
5212 case SCROLL_BAR_CLICK_EVENT:
5213 #endif
5215 int button = event->code;
5216 int is_double;
5217 Lisp_Object position;
5218 Lisp_Object *start_pos_ptr;
5219 Lisp_Object start_pos;
5221 position = Qnil;
5223 /* Build the position as appropriate for this mouse click. */
5224 if (event->kind == MOUSE_CLICK_EVENT)
5226 struct frame *f = XFRAME (event->frame_or_window);
5227 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5228 int row, column;
5229 #endif
5231 /* Ignore mouse events that were made on frame that
5232 have been deleted. */
5233 if (! FRAME_LIVE_P (f))
5234 return Qnil;
5236 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5237 /* EVENT->x and EVENT->y are frame-relative pixel
5238 coordinates at this place. Under old redisplay, COLUMN
5239 and ROW are set to frame relative glyph coordinates
5240 which are then used to determine whether this click is
5241 in a menu (non-toolkit version). */
5242 pixel_to_glyph_coords (f, XINT (event->x), XINT (event->y),
5243 &column, &row, NULL, 1);
5245 /* In the non-toolkit version, clicks on the menu bar
5246 are ordinary button events in the event buffer.
5247 Distinguish them, and invoke the menu.
5249 (In the toolkit version, the toolkit handles the menu bar
5250 and Emacs doesn't know about it until after the user
5251 makes a selection.) */
5252 if (row >= 0 && row < FRAME_MENU_BAR_LINES (f)
5253 && (event->modifiers & down_modifier))
5255 Lisp_Object items, item;
5256 int hpos;
5257 int i;
5259 #if 0
5260 /* Activate the menu bar on the down event. If the
5261 up event comes in before the menu code can deal with it,
5262 just ignore it. */
5263 if (! (event->modifiers & down_modifier))
5264 return Qnil;
5265 #endif
5267 /* Find the menu bar item under `column'. */
5268 item = Qnil;
5269 items = FRAME_MENU_BAR_ITEMS (f);
5270 for (i = 0; i < XVECTOR (items)->size; i += 4)
5272 Lisp_Object pos, string;
5273 string = AREF (items, i + 1);
5274 pos = AREF (items, i + 3);
5275 if (NILP (string))
5276 break;
5277 if (column >= XINT (pos)
5278 && column < XINT (pos) + SCHARS (string))
5280 item = AREF (items, i);
5281 break;
5285 /* ELisp manual 2.4b says (x y) are window relative but
5286 code says they are frame-relative. */
5287 position
5288 = Fcons (event->frame_or_window,
5289 Fcons (Qmenu_bar,
5290 Fcons (Fcons (event->x, event->y),
5291 Fcons (make_number (event->timestamp),
5292 Qnil))));
5294 return Fcons (item, Fcons (position, Qnil));
5296 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5298 position = make_lispy_position (f, &event->x, &event->y,
5299 event->timestamp);
5301 #ifndef USE_TOOLKIT_SCROLL_BARS
5302 else
5304 /* It's a scrollbar click. */
5305 Lisp_Object window;
5306 Lisp_Object portion_whole;
5307 Lisp_Object part;
5309 window = event->frame_or_window;
5310 portion_whole = Fcons (event->x, event->y);
5311 part = *scroll_bar_parts[(int) event->part];
5313 position
5314 = Fcons (window,
5315 Fcons (Qvertical_scroll_bar,
5316 Fcons (portion_whole,
5317 Fcons (make_number (event->timestamp),
5318 Fcons (part, Qnil)))));
5320 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5322 if (button >= ASIZE (button_down_location))
5324 button_down_location = larger_vector (button_down_location,
5325 button + 1, Qnil);
5326 mouse_syms = larger_vector (mouse_syms, button + 1, Qnil);
5329 start_pos_ptr = &AREF (button_down_location, button);
5330 start_pos = *start_pos_ptr;
5331 *start_pos_ptr = Qnil;
5334 /* On window-system frames, use the value of
5335 double-click-fuzz as is. On other frames, interpret it
5336 as a multiple of 1/8 characters. */
5337 struct frame *f;
5338 int fuzz;
5340 if (WINDOWP (event->frame_or_window))
5341 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
5342 else if (FRAMEP (event->frame_or_window))
5343 f = XFRAME (event->frame_or_window);
5344 else
5345 abort ();
5347 if (FRAME_WINDOW_P (f))
5348 fuzz = double_click_fuzz;
5349 else
5350 fuzz = double_click_fuzz / 8;
5352 is_double = (button == last_mouse_button
5353 && (abs (XINT (event->x) - last_mouse_x) <= fuzz)
5354 && (abs (XINT (event->y) - last_mouse_y) <= fuzz)
5355 && button_down_time != 0
5356 && (EQ (Vdouble_click_time, Qt)
5357 || (INTEGERP (Vdouble_click_time)
5358 && ((int)(event->timestamp - button_down_time)
5359 < XINT (Vdouble_click_time)))));
5362 last_mouse_button = button;
5363 last_mouse_x = XINT (event->x);
5364 last_mouse_y = XINT (event->y);
5366 /* If this is a button press, squirrel away the location, so
5367 we can decide later whether it was a click or a drag. */
5368 if (event->modifiers & down_modifier)
5370 if (is_double)
5372 double_click_count++;
5373 event->modifiers |= ((double_click_count > 2)
5374 ? triple_modifier
5375 : double_modifier);
5377 else
5378 double_click_count = 1;
5379 button_down_time = event->timestamp;
5380 *start_pos_ptr = Fcopy_alist (position);
5383 /* Now we're releasing a button - check the co-ordinates to
5384 see if this was a click or a drag. */
5385 else if (event->modifiers & up_modifier)
5387 /* If we did not see a down before this up, ignore the up.
5388 Probably this happened because the down event chose a
5389 menu item. It would be an annoyance to treat the
5390 release of the button that chose the menu item as a
5391 separate event. */
5393 if (!CONSP (start_pos))
5394 return Qnil;
5396 event->modifiers &= ~up_modifier;
5397 #if 0 /* Formerly we treated an up with no down as a click event. */
5398 if (!CONSP (start_pos))
5399 event->modifiers |= click_modifier;
5400 else
5401 #endif
5403 Lisp_Object down;
5404 EMACS_INT xdiff = double_click_fuzz, ydiff = double_click_fuzz;
5406 /* The third element of every position
5407 should be the (x,y) pair. */
5408 down = Fcar (Fcdr (Fcdr (start_pos)));
5409 if (CONSP (down)
5410 && INTEGERP (XCAR (down)) && INTEGERP (XCDR (down)))
5412 xdiff = XFASTINT (event->x) - XFASTINT (XCAR (down));
5413 ydiff = XFASTINT (event->y) - XFASTINT (XCDR (down));
5416 if (xdiff < double_click_fuzz && xdiff > - double_click_fuzz
5417 && ydiff < double_click_fuzz
5418 && ydiff > - double_click_fuzz)
5419 /* Mouse hasn't moved (much). */
5420 event->modifiers |= click_modifier;
5421 else
5423 button_down_time = 0;
5424 event->modifiers |= drag_modifier;
5427 /* Don't check is_double; treat this as multiple
5428 if the down-event was multiple. */
5429 if (double_click_count > 1)
5430 event->modifiers |= ((double_click_count > 2)
5431 ? triple_modifier
5432 : double_modifier);
5435 else
5436 /* Every mouse event should either have the down_modifier or
5437 the up_modifier set. */
5438 abort ();
5441 /* Get the symbol we should use for the mouse click. */
5442 Lisp_Object head;
5444 head = modify_event_symbol (button,
5445 event->modifiers,
5446 Qmouse_click, Vlispy_mouse_stem,
5447 NULL,
5448 &mouse_syms,
5449 XVECTOR (mouse_syms)->size);
5450 if (event->modifiers & drag_modifier)
5451 return Fcons (head,
5452 Fcons (start_pos,
5453 Fcons (position,
5454 Qnil)));
5455 else if (event->modifiers & (double_modifier | triple_modifier))
5456 return Fcons (head,
5457 Fcons (position,
5458 Fcons (make_number (double_click_count),
5459 Qnil)));
5460 else
5461 return Fcons (head,
5462 Fcons (position,
5463 Qnil));
5467 case WHEEL_EVENT:
5469 Lisp_Object position;
5470 Lisp_Object head;
5472 /* Build the position as appropriate for this mouse click. */
5473 struct frame *f = XFRAME (event->frame_or_window);
5475 /* Ignore wheel events that were made on frame that have been
5476 deleted. */
5477 if (! FRAME_LIVE_P (f))
5478 return Qnil;
5480 position = make_lispy_position (f, &event->x, &event->y,
5481 event->timestamp);
5483 /* Set double or triple modifiers to indicate the wheel speed. */
5485 /* On window-system frames, use the value of
5486 double-click-fuzz as is. On other frames, interpret it
5487 as a multiple of 1/8 characters. */
5488 struct frame *f;
5489 int fuzz;
5490 int is_double;
5492 if (WINDOWP (event->frame_or_window))
5493 f = XFRAME (XWINDOW (event->frame_or_window)->frame);
5494 else if (FRAMEP (event->frame_or_window))
5495 f = XFRAME (event->frame_or_window);
5496 else
5497 abort ();
5499 if (FRAME_WINDOW_P (f))
5500 fuzz = double_click_fuzz;
5501 else
5502 fuzz = double_click_fuzz / 8;
5504 is_double = (last_mouse_button < 0
5505 && (abs (XINT (event->x) - last_mouse_x) <= fuzz)
5506 && (abs (XINT (event->y) - last_mouse_y) <= fuzz)
5507 && button_down_time != 0
5508 && (EQ (Vdouble_click_time, Qt)
5509 || (INTEGERP (Vdouble_click_time)
5510 && ((int)(event->timestamp - button_down_time)
5511 < XINT (Vdouble_click_time)))));
5512 if (is_double)
5514 double_click_count++;
5515 event->modifiers |= ((double_click_count > 2)
5516 ? triple_modifier
5517 : double_modifier);
5519 else
5521 double_click_count = 1;
5522 event->modifiers |= click_modifier;
5525 button_down_time = event->timestamp;
5526 /* Use a negative value to distinguish wheel from mouse button. */
5527 last_mouse_button = -1;
5528 last_mouse_x = XINT (event->x);
5529 last_mouse_y = XINT (event->y);
5533 int symbol_num;
5535 if (event->modifiers & up_modifier)
5537 /* Emit a wheel-up event. */
5538 event->modifiers &= ~up_modifier;
5539 symbol_num = 0;
5541 else if (event->modifiers & down_modifier)
5543 /* Emit a wheel-down event. */
5544 event->modifiers &= ~down_modifier;
5545 symbol_num = 1;
5547 else
5548 /* Every wheel event should either have the down_modifier or
5549 the up_modifier set. */
5550 abort ();
5552 /* Get the symbol we should use for the wheel event. */
5553 head = modify_event_symbol (symbol_num,
5554 event->modifiers,
5555 Qmouse_click,
5556 Qnil,
5557 lispy_wheel_names,
5558 &wheel_syms,
5559 ASIZE (wheel_syms));
5562 if (event->modifiers & (double_modifier | triple_modifier))
5563 return Fcons (head,
5564 Fcons (position,
5565 Fcons (make_number (double_click_count),
5566 Qnil)));
5567 else
5568 return Fcons (head,
5569 Fcons (position,
5570 Qnil));
5574 #ifdef USE_TOOLKIT_SCROLL_BARS
5576 /* We don't have down and up events if using toolkit scroll bars,
5577 so make this always a click event. Store in the `part' of
5578 the Lisp event a symbol which maps to the following actions:
5580 `above_handle' page up
5581 `below_handle' page down
5582 `up' line up
5583 `down' line down
5584 `top' top of buffer
5585 `bottom' bottom of buffer
5586 `handle' thumb has been dragged.
5587 `end-scroll' end of interaction with scroll bar
5589 The incoming input_event contains in its `part' member an
5590 index of type `enum scroll_bar_part' which we can use as an
5591 index in scroll_bar_parts to get the appropriate symbol. */
5593 case SCROLL_BAR_CLICK_EVENT:
5595 Lisp_Object position, head, window, portion_whole, part;
5597 window = event->frame_or_window;
5598 portion_whole = Fcons (event->x, event->y);
5599 part = *scroll_bar_parts[(int) event->part];
5601 position
5602 = Fcons (window,
5603 Fcons (Qvertical_scroll_bar,
5604 Fcons (portion_whole,
5605 Fcons (make_number (event->timestamp),
5606 Fcons (part, Qnil)))));
5608 /* Always treat scroll bar events as clicks. */
5609 event->modifiers |= click_modifier;
5610 event->modifiers &= ~up_modifier;
5612 if (event->code >= ASIZE (mouse_syms))
5613 mouse_syms = larger_vector (mouse_syms, event->code + 1, Qnil);
5615 /* Get the symbol we should use for the mouse click. */
5616 head = modify_event_symbol (event->code,
5617 event->modifiers,
5618 Qmouse_click,
5619 Vlispy_mouse_stem,
5620 NULL, &mouse_syms,
5621 XVECTOR (mouse_syms)->size);
5622 return Fcons (head, Fcons (position, Qnil));
5625 #endif /* USE_TOOLKIT_SCROLL_BARS */
5627 #ifdef WINDOWSNT
5628 case W32_SCROLL_BAR_CLICK_EVENT:
5630 int button = event->code;
5631 int is_double;
5632 Lisp_Object position;
5633 Lisp_Object *start_pos_ptr;
5634 Lisp_Object start_pos;
5637 Lisp_Object window;
5638 Lisp_Object portion_whole;
5639 Lisp_Object part;
5641 window = event->frame_or_window;
5642 portion_whole = Fcons (event->x, event->y);
5643 part = *scroll_bar_parts[(int) event->part];
5645 position
5646 = Fcons (window,
5647 Fcons (Qvertical_scroll_bar,
5648 Fcons (portion_whole,
5649 Fcons (make_number (event->timestamp),
5650 Fcons (part, Qnil)))));
5653 /* Always treat W32 scroll bar events as clicks. */
5654 event->modifiers |= click_modifier;
5657 /* Get the symbol we should use for the mouse click. */
5658 Lisp_Object head;
5660 head = modify_event_symbol (button,
5661 event->modifiers,
5662 Qmouse_click,
5663 Vlispy_mouse_stem,
5664 NULL, &mouse_syms,
5665 XVECTOR (mouse_syms)->size);
5666 return Fcons (head,
5667 Fcons (position,
5668 Qnil));
5671 #endif /* WINDOWSNT */
5673 case DRAG_N_DROP_EVENT:
5675 FRAME_PTR f;
5676 Lisp_Object head, position;
5677 Lisp_Object files;
5679 /* The frame_or_window field should be a cons of the frame in
5680 which the event occurred and a list of the filenames
5681 dropped. */
5682 if (! CONSP (event->frame_or_window))
5683 abort ();
5685 f = XFRAME (XCAR (event->frame_or_window));
5686 files = XCDR (event->frame_or_window);
5688 /* Ignore mouse events that were made on frames that
5689 have been deleted. */
5690 if (! FRAME_LIVE_P (f))
5691 return Qnil;
5693 position = make_lispy_position (f, &event->x, &event->y,
5694 event->timestamp);
5696 head = modify_event_symbol (0, event->modifiers,
5697 Qdrag_n_drop, Qnil,
5698 lispy_drag_n_drop_names,
5699 &drag_n_drop_syms, 1);
5700 return Fcons (head,
5701 Fcons (position,
5702 Fcons (files,
5703 Qnil)));
5705 #endif /* HAVE_MOUSE */
5707 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5708 || defined (USE_GTK)
5709 case MENU_BAR_EVENT:
5710 if (EQ (event->arg, event->frame_or_window))
5711 /* This is the prefix key. We translate this to
5712 `(menu_bar)' because the code in keyboard.c for menu
5713 events, which we use, relies on this. */
5714 return Fcons (Qmenu_bar, Qnil);
5715 return event->arg;
5716 #endif
5718 case SELECT_WINDOW_EVENT:
5719 /* Make an event (select-window (WINDOW)). */
5720 return Fcons (Qselect_window,
5721 Fcons (Fcons (event->frame_or_window, Qnil),
5722 Qnil));
5724 case TOOL_BAR_EVENT:
5725 if (EQ (event->arg, event->frame_or_window))
5726 /* This is the prefix key. We translate this to
5727 `(tool_bar)' because the code in keyboard.c for tool bar
5728 events, which we use, relies on this. */
5729 return Fcons (Qtool_bar, Qnil);
5730 else if (SYMBOLP (event->arg))
5731 return apply_modifiers (event->modifiers, event->arg);
5732 return event->arg;
5734 case USER_SIGNAL_EVENT:
5735 /* A user signal. */
5736 return *lispy_user_signals[event->code];
5738 case SAVE_SESSION_EVENT:
5739 return Qsave_session;
5741 /* The 'kind' field of the event is something we don't recognize. */
5742 default:
5743 abort ();
5747 #ifdef HAVE_MOUSE
5749 static Lisp_Object
5750 make_lispy_movement (frame, bar_window, part, x, y, time)
5751 FRAME_PTR frame;
5752 Lisp_Object bar_window;
5753 enum scroll_bar_part part;
5754 Lisp_Object x, y;
5755 unsigned long time;
5757 /* Is it a scroll bar movement? */
5758 if (frame && ! NILP (bar_window))
5760 Lisp_Object part_sym;
5762 part_sym = *scroll_bar_parts[(int) part];
5763 return Fcons (Qscroll_bar_movement,
5764 (Fcons (Fcons (bar_window,
5765 Fcons (Qvertical_scroll_bar,
5766 Fcons (Fcons (x, y),
5767 Fcons (make_number (time),
5768 Fcons (part_sym,
5769 Qnil))))),
5770 Qnil)));
5773 /* Or is it an ordinary mouse movement? */
5774 else
5776 Lisp_Object position;
5778 position = make_lispy_position (frame, &x, &y, time);
5780 return Fcons (Qmouse_movement,
5781 Fcons (position,
5782 Qnil));
5786 #endif /* HAVE_MOUSE */
5788 /* Construct a switch frame event. */
5789 static Lisp_Object
5790 make_lispy_switch_frame (frame)
5791 Lisp_Object frame;
5793 return Fcons (Qswitch_frame, Fcons (frame, Qnil));
5796 /* Manipulating modifiers. */
5798 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5800 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5801 SYMBOL's name of the end of the modifiers; the string from this
5802 position is the unmodified symbol name.
5804 This doesn't use any caches. */
5806 static int
5807 parse_modifiers_uncached (symbol, modifier_end)
5808 Lisp_Object symbol;
5809 int *modifier_end;
5811 Lisp_Object name;
5812 int i;
5813 int modifiers;
5815 CHECK_SYMBOL (symbol);
5817 modifiers = 0;
5818 name = SYMBOL_NAME (symbol);
5820 for (i = 0; i+2 <= SBYTES (name); )
5822 int this_mod_end = 0;
5823 int this_mod = 0;
5825 /* See if the name continues with a modifier word.
5826 Check that the word appears, but don't check what follows it.
5827 Set this_mod and this_mod_end to record what we find. */
5829 switch (SREF (name, i))
5831 #define SINGLE_LETTER_MOD(BIT) \
5832 (this_mod_end = i + 1, this_mod = BIT)
5834 case 'A':
5835 SINGLE_LETTER_MOD (alt_modifier);
5836 break;
5838 case 'C':
5839 SINGLE_LETTER_MOD (ctrl_modifier);
5840 break;
5842 case 'H':
5843 SINGLE_LETTER_MOD (hyper_modifier);
5844 break;
5846 case 'M':
5847 SINGLE_LETTER_MOD (meta_modifier);
5848 break;
5850 case 'S':
5851 SINGLE_LETTER_MOD (shift_modifier);
5852 break;
5854 case 's':
5855 SINGLE_LETTER_MOD (super_modifier);
5856 break;
5858 #undef SINGLE_LETTER_MOD
5860 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5861 if (i + LEN + 1 <= SBYTES (name) \
5862 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5864 this_mod_end = i + LEN; \
5865 this_mod = BIT; \
5868 case 'd':
5869 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
5870 MULTI_LETTER_MOD (down_modifier, "down", 4);
5871 MULTI_LETTER_MOD (double_modifier, "double", 6);
5872 break;
5874 case 't':
5875 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
5876 break;
5877 #undef MULTI_LETTER_MOD
5881 /* If we found no modifier, stop looking for them. */
5882 if (this_mod_end == 0)
5883 break;
5885 /* Check there is a dash after the modifier, so that it
5886 really is a modifier. */
5887 if (this_mod_end >= SBYTES (name)
5888 || SREF (name, this_mod_end) != '-')
5889 break;
5891 /* This modifier is real; look for another. */
5892 modifiers |= this_mod;
5893 i = this_mod_end + 1;
5896 /* Should we include the `click' modifier? */
5897 if (! (modifiers & (down_modifier | drag_modifier
5898 | double_modifier | triple_modifier))
5899 && i + 7 == SBYTES (name)
5900 && strncmp (SDATA (name) + i, "mouse-", 6) == 0
5901 && ('0' <= SREF (name, i + 6) && SREF (name, i + 6) <= '9'))
5902 modifiers |= click_modifier;
5904 if (modifier_end)
5905 *modifier_end = i;
5907 return modifiers;
5910 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
5911 prepended to the string BASE[0..BASE_LEN-1].
5912 This doesn't use any caches. */
5913 static Lisp_Object
5914 apply_modifiers_uncached (modifiers, base, base_len, base_len_byte)
5915 int modifiers;
5916 char *base;
5917 int base_len, base_len_byte;
5919 /* Since BASE could contain nulls, we can't use intern here; we have
5920 to use Fintern, which expects a genuine Lisp_String, and keeps a
5921 reference to it. */
5922 char *new_mods
5923 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
5924 int mod_len;
5927 char *p = new_mods;
5929 /* Only the event queue may use the `up' modifier; it should always
5930 be turned into a click or drag event before presented to lisp code. */
5931 if (modifiers & up_modifier)
5932 abort ();
5934 if (modifiers & alt_modifier) { *p++ = 'A'; *p++ = '-'; }
5935 if (modifiers & ctrl_modifier) { *p++ = 'C'; *p++ = '-'; }
5936 if (modifiers & hyper_modifier) { *p++ = 'H'; *p++ = '-'; }
5937 if (modifiers & meta_modifier) { *p++ = 'M'; *p++ = '-'; }
5938 if (modifiers & shift_modifier) { *p++ = 'S'; *p++ = '-'; }
5939 if (modifiers & super_modifier) { *p++ = 's'; *p++ = '-'; }
5940 if (modifiers & double_modifier) { strcpy (p, "double-"); p += 7; }
5941 if (modifiers & triple_modifier) { strcpy (p, "triple-"); p += 7; }
5942 if (modifiers & down_modifier) { strcpy (p, "down-"); p += 5; }
5943 if (modifiers & drag_modifier) { strcpy (p, "drag-"); p += 5; }
5944 /* The click modifier is denoted by the absence of other modifiers. */
5946 *p = '\0';
5948 mod_len = p - new_mods;
5952 Lisp_Object new_name;
5954 new_name = make_uninit_multibyte_string (mod_len + base_len,
5955 mod_len + base_len_byte);
5956 bcopy (new_mods, SDATA (new_name), mod_len);
5957 bcopy (base, SDATA (new_name) + mod_len, base_len_byte);
5959 return Fintern (new_name, Qnil);
5964 static char *modifier_names[] =
5966 "up", "down", "drag", "click", "double", "triple", 0, 0,
5967 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5968 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
5970 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
5972 static Lisp_Object modifier_symbols;
5974 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
5975 static Lisp_Object
5976 lispy_modifier_list (modifiers)
5977 int modifiers;
5979 Lisp_Object modifier_list;
5980 int i;
5982 modifier_list = Qnil;
5983 for (i = 0; (1<<i) <= modifiers && i < NUM_MOD_NAMES; i++)
5984 if (modifiers & (1<<i))
5985 modifier_list = Fcons (XVECTOR (modifier_symbols)->contents[i],
5986 modifier_list);
5988 return modifier_list;
5992 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
5993 where UNMODIFIED is the unmodified form of SYMBOL,
5994 MASK is the set of modifiers present in SYMBOL's name.
5995 This is similar to parse_modifiers_uncached, but uses the cache in
5996 SYMBOL's Qevent_symbol_element_mask property, and maintains the
5997 Qevent_symbol_elements property. */
5999 Lisp_Object
6000 parse_modifiers (symbol)
6001 Lisp_Object symbol;
6003 Lisp_Object elements;
6005 elements = Fget (symbol, Qevent_symbol_element_mask);
6006 if (CONSP (elements))
6007 return elements;
6008 else
6010 int end;
6011 int modifiers = parse_modifiers_uncached (symbol, &end);
6012 Lisp_Object unmodified;
6013 Lisp_Object mask;
6015 unmodified = Fintern (make_string (SDATA (SYMBOL_NAME (symbol)) + end,
6016 SBYTES (SYMBOL_NAME (symbol)) - end),
6017 Qnil);
6019 if (modifiers & ~INTMASK)
6020 abort ();
6021 XSETFASTINT (mask, modifiers);
6022 elements = Fcons (unmodified, Fcons (mask, Qnil));
6024 /* Cache the parsing results on SYMBOL. */
6025 Fput (symbol, Qevent_symbol_element_mask,
6026 elements);
6027 Fput (symbol, Qevent_symbol_elements,
6028 Fcons (unmodified, lispy_modifier_list (modifiers)));
6030 /* Since we know that SYMBOL is modifiers applied to unmodified,
6031 it would be nice to put that in unmodified's cache.
6032 But we can't, since we're not sure that parse_modifiers is
6033 canonical. */
6035 return elements;
6039 /* Apply the modifiers MODIFIERS to the symbol BASE.
6040 BASE must be unmodified.
6042 This is like apply_modifiers_uncached, but uses BASE's
6043 Qmodifier_cache property, if present. It also builds
6044 Qevent_symbol_elements properties, since it has that info anyway.
6046 apply_modifiers copies the value of BASE's Qevent_kind property to
6047 the modified symbol. */
6048 static Lisp_Object
6049 apply_modifiers (modifiers, base)
6050 int modifiers;
6051 Lisp_Object base;
6053 Lisp_Object cache, index, entry, new_symbol;
6055 /* Mask out upper bits. We don't know where this value's been. */
6056 modifiers &= INTMASK;
6058 /* The click modifier never figures into cache indices. */
6059 cache = Fget (base, Qmodifier_cache);
6060 XSETFASTINT (index, (modifiers & ~click_modifier));
6061 entry = assq_no_quit (index, cache);
6063 if (CONSP (entry))
6064 new_symbol = XCDR (entry);
6065 else
6067 /* We have to create the symbol ourselves. */
6068 new_symbol = apply_modifiers_uncached (modifiers,
6069 SDATA (SYMBOL_NAME (base)),
6070 SCHARS (SYMBOL_NAME (base)),
6071 SBYTES (SYMBOL_NAME (base)));
6073 /* Add the new symbol to the base's cache. */
6074 entry = Fcons (index, new_symbol);
6075 Fput (base, Qmodifier_cache, Fcons (entry, cache));
6077 /* We have the parsing info now for free, so we could add it to
6078 the caches:
6079 XSETFASTINT (index, modifiers);
6080 Fput (new_symbol, Qevent_symbol_element_mask,
6081 Fcons (base, Fcons (index, Qnil)));
6082 Fput (new_symbol, Qevent_symbol_elements,
6083 Fcons (base, lispy_modifier_list (modifiers)));
6084 Sadly, this is only correct if `base' is indeed a base event,
6085 which is not necessarily the case. -stef */
6088 /* Make sure this symbol is of the same kind as BASE.
6090 You'd think we could just set this once and for all when we
6091 intern the symbol above, but reorder_modifiers may call us when
6092 BASE's property isn't set right; we can't assume that just
6093 because it has a Qmodifier_cache property it must have its
6094 Qevent_kind set right as well. */
6095 if (NILP (Fget (new_symbol, Qevent_kind)))
6097 Lisp_Object kind;
6099 kind = Fget (base, Qevent_kind);
6100 if (! NILP (kind))
6101 Fput (new_symbol, Qevent_kind, kind);
6104 return new_symbol;
6108 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6109 return a symbol with the modifiers placed in the canonical order.
6110 Canonical order is alphabetical, except for down and drag, which
6111 always come last. The 'click' modifier is never written out.
6113 Fdefine_key calls this to make sure that (for example) C-M-foo
6114 and M-C-foo end up being equivalent in the keymap. */
6116 Lisp_Object
6117 reorder_modifiers (symbol)
6118 Lisp_Object symbol;
6120 /* It's hopefully okay to write the code this way, since everything
6121 will soon be in caches, and no consing will be done at all. */
6122 Lisp_Object parsed;
6124 parsed = parse_modifiers (symbol);
6125 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed))),
6126 XCAR (parsed));
6130 /* For handling events, we often want to produce a symbol whose name
6131 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6132 to some base, like the name of a function key or mouse button.
6133 modify_event_symbol produces symbols of this sort.
6135 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6136 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6137 in the table.
6139 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6140 into symbol names, or a string specifying a name stem used to
6141 construct a symbol name or the form `STEM-N', where N is the decimal
6142 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6143 non-nil; otherwise NAME_TABLE is used.
6145 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6146 persist between calls to modify_event_symbol that it can use to
6147 store a cache of the symbols it's generated for this NAME_TABLE
6148 before. The object stored there may be a vector or an alist.
6150 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6152 MODIFIERS is a set of modifier bits (as given in struct input_events)
6153 whose prefixes should be applied to the symbol name.
6155 SYMBOL_KIND is the value to be placed in the event_kind property of
6156 the returned symbol.
6158 The symbols we create are supposed to have an
6159 `event-symbol-elements' property, which lists the modifiers present
6160 in the symbol's name. */
6162 static Lisp_Object
6163 modify_event_symbol (symbol_num, modifiers, symbol_kind, name_alist_or_stem,
6164 name_table, symbol_table, table_size)
6165 int symbol_num;
6166 unsigned modifiers;
6167 Lisp_Object symbol_kind;
6168 Lisp_Object name_alist_or_stem;
6169 char **name_table;
6170 Lisp_Object *symbol_table;
6171 unsigned int table_size;
6173 Lisp_Object value;
6174 Lisp_Object symbol_int;
6176 /* Get rid of the "vendor-specific" bit here. */
6177 XSETINT (symbol_int, symbol_num & 0xffffff);
6179 /* Is this a request for a valid symbol? */
6180 if (symbol_num < 0 || symbol_num >= table_size)
6181 return Qnil;
6183 if (CONSP (*symbol_table))
6184 value = Fcdr (assq_no_quit (symbol_int, *symbol_table));
6186 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6187 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6188 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6189 we've never used that symbol before. */
6190 else
6192 if (! VECTORP (*symbol_table)
6193 || XVECTOR (*symbol_table)->size != table_size)
6195 Lisp_Object size;
6197 XSETFASTINT (size, table_size);
6198 *symbol_table = Fmake_vector (size, Qnil);
6201 value = XVECTOR (*symbol_table)->contents[symbol_num];
6204 /* Have we already used this symbol before? */
6205 if (NILP (value))
6207 /* No; let's create it. */
6208 if (CONSP (name_alist_or_stem))
6209 value = Fcdr_safe (Fassq (symbol_int, name_alist_or_stem));
6210 else if (STRINGP (name_alist_or_stem))
6212 int len = SBYTES (name_alist_or_stem);
6213 char *buf = (char *) alloca (len + 50);
6214 if (sizeof (int) == sizeof (EMACS_INT))
6215 sprintf (buf, "%s-%d", SDATA (name_alist_or_stem),
6216 XINT (symbol_int) + 1);
6217 else if (sizeof (long) == sizeof (EMACS_INT))
6218 sprintf (buf, "%s-%ld", SDATA (name_alist_or_stem),
6219 XINT (symbol_int) + 1);
6220 value = intern (buf);
6222 else if (name_table != 0 && name_table[symbol_num])
6223 value = intern (name_table[symbol_num]);
6225 #ifdef HAVE_WINDOW_SYSTEM
6226 if (NILP (value))
6228 char *name = x_get_keysym_name (symbol_num);
6229 if (name)
6230 value = intern (name);
6232 #endif
6234 if (NILP (value))
6236 char buf[20];
6237 sprintf (buf, "key-%d", symbol_num);
6238 value = intern (buf);
6241 if (CONSP (*symbol_table))
6242 *symbol_table = Fcons (Fcons (symbol_int, value), *symbol_table);
6243 else
6244 XVECTOR (*symbol_table)->contents[symbol_num] = value;
6246 /* Fill in the cache entries for this symbol; this also
6247 builds the Qevent_symbol_elements property, which the user
6248 cares about. */
6249 apply_modifiers (modifiers & click_modifier, value);
6250 Fput (value, Qevent_kind, symbol_kind);
6253 /* Apply modifiers to that symbol. */
6254 return apply_modifiers (modifiers, value);
6257 /* Convert a list that represents an event type,
6258 such as (ctrl meta backspace), into the usual representation of that
6259 event type as a number or a symbol. */
6261 DEFUN ("event-convert-list", Fevent_convert_list, Sevent_convert_list, 1, 1, 0,
6262 doc: /* Convert the event description list EVENT-DESC to an event type.
6263 EVENT-DESC should contain one base event type (a character or symbol)
6264 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6265 drag, down, double or triple). The base must be last.
6266 The return value is an event type (a character or symbol) which
6267 has the same base event type and all the specified modifiers. */)
6268 (event_desc)
6269 Lisp_Object event_desc;
6271 Lisp_Object base;
6272 int modifiers = 0;
6273 Lisp_Object rest;
6275 base = Qnil;
6276 rest = event_desc;
6277 while (CONSP (rest))
6279 Lisp_Object elt;
6280 int this = 0;
6282 elt = XCAR (rest);
6283 rest = XCDR (rest);
6285 /* Given a symbol, see if it is a modifier name. */
6286 if (SYMBOLP (elt) && CONSP (rest))
6287 this = parse_solitary_modifier (elt);
6289 if (this != 0)
6290 modifiers |= this;
6291 else if (!NILP (base))
6292 error ("Two bases given in one event");
6293 else
6294 base = elt;
6298 /* Let the symbol A refer to the character A. */
6299 if (SYMBOLP (base) && SCHARS (SYMBOL_NAME (base)) == 1)
6300 XSETINT (base, SREF (SYMBOL_NAME (base), 0));
6302 if (INTEGERP (base))
6304 /* Turn (shift a) into A. */
6305 if ((modifiers & shift_modifier) != 0
6306 && (XINT (base) >= 'a' && XINT (base) <= 'z'))
6308 XSETINT (base, XINT (base) - ('a' - 'A'));
6309 modifiers &= ~shift_modifier;
6312 /* Turn (control a) into C-a. */
6313 if (modifiers & ctrl_modifier)
6314 return make_number ((modifiers & ~ctrl_modifier)
6315 | make_ctrl_char (XINT (base)));
6316 else
6317 return make_number (modifiers | XINT (base));
6319 else if (SYMBOLP (base))
6320 return apply_modifiers (modifiers, base);
6321 else
6323 error ("Invalid base event");
6324 return Qnil;
6328 /* Try to recognize SYMBOL as a modifier name.
6329 Return the modifier flag bit, or 0 if not recognized. */
6331 static int
6332 parse_solitary_modifier (symbol)
6333 Lisp_Object symbol;
6335 Lisp_Object name = SYMBOL_NAME (symbol);
6337 switch (SREF (name, 0))
6339 #define SINGLE_LETTER_MOD(BIT) \
6340 if (SBYTES (name) == 1) \
6341 return BIT;
6343 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6344 if (LEN == SBYTES (name) \
6345 && ! strncmp (SDATA (name), NAME, LEN)) \
6346 return BIT;
6348 case 'A':
6349 SINGLE_LETTER_MOD (alt_modifier);
6350 break;
6352 case 'a':
6353 MULTI_LETTER_MOD (alt_modifier, "alt", 3);
6354 break;
6356 case 'C':
6357 SINGLE_LETTER_MOD (ctrl_modifier);
6358 break;
6360 case 'c':
6361 MULTI_LETTER_MOD (ctrl_modifier, "ctrl", 4);
6362 MULTI_LETTER_MOD (ctrl_modifier, "control", 7);
6363 break;
6365 case 'H':
6366 SINGLE_LETTER_MOD (hyper_modifier);
6367 break;
6369 case 'h':
6370 MULTI_LETTER_MOD (hyper_modifier, "hyper", 5);
6371 break;
6373 case 'M':
6374 SINGLE_LETTER_MOD (meta_modifier);
6375 break;
6377 case 'm':
6378 MULTI_LETTER_MOD (meta_modifier, "meta", 4);
6379 break;
6381 case 'S':
6382 SINGLE_LETTER_MOD (shift_modifier);
6383 break;
6385 case 's':
6386 MULTI_LETTER_MOD (shift_modifier, "shift", 5);
6387 MULTI_LETTER_MOD (super_modifier, "super", 5);
6388 SINGLE_LETTER_MOD (super_modifier);
6389 break;
6391 case 'd':
6392 MULTI_LETTER_MOD (drag_modifier, "drag", 4);
6393 MULTI_LETTER_MOD (down_modifier, "down", 4);
6394 MULTI_LETTER_MOD (double_modifier, "double", 6);
6395 break;
6397 case 't':
6398 MULTI_LETTER_MOD (triple_modifier, "triple", 6);
6399 break;
6401 #undef SINGLE_LETTER_MOD
6402 #undef MULTI_LETTER_MOD
6405 return 0;
6408 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6409 Such a list is not valid as an event,
6410 but it can be a Lucid-style event type list. */
6413 lucid_event_type_list_p (object)
6414 Lisp_Object object;
6416 Lisp_Object tail;
6418 if (! CONSP (object))
6419 return 0;
6421 if (EQ (XCAR (object), Qhelp_echo)
6422 || EQ (XCAR (object), Qvertical_line)
6423 || EQ (XCAR (object), Qmode_line)
6424 || EQ (XCAR (object), Qheader_line))
6425 return 0;
6427 for (tail = object; CONSP (tail); tail = XCDR (tail))
6429 Lisp_Object elt;
6430 elt = XCAR (tail);
6431 if (! (INTEGERP (elt) || SYMBOLP (elt)))
6432 return 0;
6435 return NILP (tail);
6438 /* Store into *addr a value nonzero if terminal input chars are available.
6439 Serves the purpose of ioctl (0, FIONREAD, addr)
6440 but works even if FIONREAD does not exist.
6441 (In fact, this may actually read some input.)
6443 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe.
6444 If FILTER_EVENTS is nonzero, ignore internal events (FOCUS_IN_EVENT). */
6446 static void
6447 get_filtered_input_pending (addr, do_timers_now, filter_events)
6448 int *addr;
6449 int do_timers_now;
6450 int filter_events;
6452 /* First of all, have we already counted some input? */
6453 *addr = (!NILP (Vquit_flag)
6454 || readable_filtered_events (do_timers_now, filter_events));
6456 /* If input is being read as it arrives, and we have none, there is none. */
6457 if (*addr > 0 || (interrupt_input && ! interrupts_deferred))
6458 return;
6460 /* Try to read some input and see how much we get. */
6461 gobble_input (0);
6462 *addr = (!NILP (Vquit_flag)
6463 || readable_filtered_events (do_timers_now, filter_events));
6466 /* Store into *addr a value nonzero if terminal input chars are available.
6467 Serves the purpose of ioctl (0, FIONREAD, addr)
6468 but works even if FIONREAD does not exist.
6469 (In fact, this may actually read some input.)
6471 If DO_TIMERS_NOW is nonzero, actually run timer events that are ripe. */
6473 static void
6474 get_input_pending (addr, do_timers_now)
6475 int *addr;
6476 int do_timers_now;
6478 get_filtered_input_pending (addr, do_timers_now, 0);
6481 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6483 void
6484 gobble_input (expected)
6485 int expected;
6487 #ifndef VMS
6488 #ifdef SIGIO
6489 if (interrupt_input)
6491 SIGMASKTYPE mask;
6492 mask = sigblock (sigmask (SIGIO));
6493 read_avail_input (expected);
6494 sigsetmask (mask);
6496 else
6497 #ifdef POLL_FOR_INPUT
6498 if (read_socket_hook && !interrupt_input && poll_suppress_count == 0)
6500 SIGMASKTYPE mask;
6501 mask = sigblock (sigmask (SIGALRM));
6502 read_avail_input (expected);
6503 sigsetmask (mask);
6505 else
6506 #endif
6507 #endif
6508 read_avail_input (expected);
6509 #endif
6512 /* Put a BUFFER_SWITCH_EVENT in the buffer
6513 so that read_key_sequence will notice the new current buffer. */
6515 void
6516 record_asynch_buffer_change ()
6518 struct input_event event;
6519 Lisp_Object tem;
6520 EVENT_INIT (event);
6522 event.kind = BUFFER_SWITCH_EVENT;
6523 event.frame_or_window = Qnil;
6524 event.arg = Qnil;
6526 #ifdef subprocesses
6527 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6528 The purpose of the event is to make read_key_sequence look up the
6529 keymaps again. If we aren't in read_key_sequence, we don't need one,
6530 and the event could cause trouble by messing up (input-pending-p). */
6531 tem = Fwaiting_for_user_input_p ();
6532 if (NILP (tem))
6533 return;
6534 #else
6535 /* We never need these events if we have no asynchronous subprocesses. */
6536 return;
6537 #endif
6539 /* Make sure no interrupt happens while storing the event. */
6540 #ifdef SIGIO
6541 if (interrupt_input)
6543 SIGMASKTYPE mask;
6544 mask = sigblock (sigmask (SIGIO));
6545 kbd_buffer_store_event (&event);
6546 sigsetmask (mask);
6548 else
6549 #endif
6551 stop_polling ();
6552 kbd_buffer_store_event (&event);
6553 start_polling ();
6557 #ifndef VMS
6559 /* We make the read_avail_input buffer static to avoid zeroing out the
6560 whole struct input_event buf on every call. */
6561 static struct input_event read_avail_input_buf[KBD_BUFFER_SIZE];
6563 /* I don't know whether it is necessary, but make read_avail_input
6564 re-entrant. */
6565 static int in_read_avail_input = 0;
6567 /* Read any terminal input already buffered up by the system
6568 into the kbd_buffer, but do not wait.
6570 EXPECTED should be nonzero if the caller knows there is some input.
6572 Except on VMS, all input is read by this function.
6573 If interrupt_input is nonzero, this function MUST be called
6574 only when SIGIO is blocked.
6576 Returns the number of keyboard chars read, or -1 meaning
6577 this is a bad time to try to read input. */
6579 static int
6580 read_avail_input (expected)
6581 int expected;
6583 struct input_event *buf = read_avail_input_buf;
6584 struct input_event tmp_buf[KBD_BUFFER_SIZE];
6585 register int i;
6586 int nread;
6588 /* Trivial hack to make read_avail_input re-entrant. */
6589 if (in_read_avail_input++)
6591 buf = tmp_buf;
6592 for (i = 0; i < KBD_BUFFER_SIZE; i++)
6593 EVENT_INIT (buf[i]);
6596 if (read_socket_hook)
6597 /* No need for FIONREAD or fcntl; just say don't wait. */
6598 nread = (*read_socket_hook) (input_fd, buf, KBD_BUFFER_SIZE, expected);
6599 else
6601 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6602 the kbd_buffer can really hold. That may prevent loss
6603 of characters on some systems when input is stuffed at us. */
6604 unsigned char cbuf[KBD_BUFFER_SIZE - 1];
6605 int n_to_read;
6607 /* Determine how many characters we should *try* to read. */
6608 #ifdef WINDOWSNT
6609 --in_read_avail_input;
6610 return 0;
6611 #else /* not WINDOWSNT */
6612 #ifdef MSDOS
6613 n_to_read = dos_keysns ();
6614 if (n_to_read == 0)
6616 --in_read_avail_input;
6617 return 0;
6619 #else /* not MSDOS */
6620 #ifdef FIONREAD
6621 /* Find out how much input is available. */
6622 if (ioctl (input_fd, FIONREAD, &n_to_read) < 0)
6623 /* Formerly simply reported no input, but that sometimes led to
6624 a failure of Emacs to terminate.
6625 SIGHUP seems appropriate if we can't reach the terminal. */
6626 /* ??? Is it really right to send the signal just to this process
6627 rather than to the whole process group?
6628 Perhaps on systems with FIONREAD Emacs is alone in its group. */
6630 if (! noninteractive)
6631 kill (getpid (), SIGHUP);
6632 else
6633 n_to_read = 0;
6635 if (n_to_read == 0)
6637 --in_read_avail_input;
6638 return 0;
6640 if (n_to_read > sizeof cbuf)
6641 n_to_read = sizeof cbuf;
6642 #else /* no FIONREAD */
6643 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6644 /* Read some input if available, but don't wait. */
6645 n_to_read = sizeof cbuf;
6646 fcntl (input_fd, F_SETFL, O_NDELAY);
6647 #else
6648 you lose;
6649 #endif
6650 #endif
6651 #endif /* not MSDOS */
6652 #endif /* not WINDOWSNT */
6654 /* Now read; for one reason or another, this will not block.
6655 NREAD is set to the number of chars read. */
6658 #ifdef MSDOS
6659 cbuf[0] = dos_keyread ();
6660 nread = 1;
6661 #else
6662 nread = emacs_read (input_fd, cbuf, n_to_read);
6663 #endif
6664 /* POSIX infers that processes which are not in the session leader's
6665 process group won't get SIGHUP's at logout time. BSDI adheres to
6666 this part standard and returns -1 from read (0) with errno==EIO
6667 when the control tty is taken away.
6668 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6669 if (nread == -1 && errno == EIO)
6670 kill (0, SIGHUP);
6671 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6672 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6673 This looks incorrect, but it isn't, because _BSD causes
6674 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6675 and that causes a value other than 0 when there is no input. */
6676 if (nread == 0)
6677 kill (0, SIGHUP);
6678 #endif
6680 while (
6681 /* We used to retry the read if it was interrupted.
6682 But this does the wrong thing when O_NDELAY causes
6683 an EAGAIN error. Does anybody know of a situation
6684 where a retry is actually needed? */
6685 #if 0
6686 nread < 0 && (errno == EAGAIN
6687 #ifdef EFAULT
6688 || errno == EFAULT
6689 #endif
6690 #ifdef EBADSLT
6691 || errno == EBADSLT
6692 #endif
6694 #else
6696 #endif
6699 #ifndef FIONREAD
6700 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6701 fcntl (input_fd, F_SETFL, 0);
6702 #endif /* USG or DGUX or CYGWIN */
6703 #endif /* no FIONREAD */
6704 for (i = 0; i < nread; i++)
6706 buf[i].kind = ASCII_KEYSTROKE_EVENT;
6707 buf[i].modifiers = 0;
6708 if (meta_key == 1 && (cbuf[i] & 0x80))
6709 buf[i].modifiers = meta_modifier;
6710 if (meta_key != 2)
6711 cbuf[i] &= ~0x80;
6713 buf[i].code = cbuf[i];
6714 buf[i].frame_or_window = selected_frame;
6715 buf[i].arg = Qnil;
6719 /* Scan the chars for C-g and store them in kbd_buffer. */
6720 for (i = 0; i < nread; i++)
6722 kbd_buffer_store_event (&buf[i]);
6723 /* Don't look at input that follows a C-g too closely.
6724 This reduces lossage due to autorepeat on C-g. */
6725 if (buf[i].kind == ASCII_KEYSTROKE_EVENT
6726 && buf[i].code == quit_char)
6727 break;
6730 /* Clear used events */
6731 if (--in_read_avail_input == 0)
6732 for (i = 0; i < nread; i++)
6733 EVENT_INIT (buf[i]);
6735 return nread;
6737 #endif /* not VMS */
6739 void
6740 handle_async_input ()
6742 #ifdef BSD4_1
6743 extern int select_alarmed;
6744 #endif
6745 interrupt_input_pending = 0;
6747 while (1)
6749 int nread;
6750 nread = read_avail_input (1);
6751 /* -1 means it's not ok to read the input now.
6752 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6753 0 means there was no keyboard input available. */
6754 if (nread <= 0)
6755 break;
6757 #ifdef BSD4_1
6758 select_alarmed = 1; /* Force the select emulator back to life */
6759 #endif
6763 #ifdef SIGIO /* for entire page */
6764 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6766 static SIGTYPE
6767 input_available_signal (signo)
6768 int signo;
6770 /* Must preserve main program's value of errno. */
6771 int old_errno = errno;
6773 #if defined (USG) && !defined (POSIX_SIGNALS)
6774 /* USG systems forget handlers when they are used;
6775 must reestablish each time */
6776 signal (signo, input_available_signal);
6777 #endif /* USG */
6779 #ifdef BSD4_1
6780 sigisheld (SIGIO);
6781 #endif
6783 if (input_available_clear_time)
6784 EMACS_SET_SECS_USECS (*input_available_clear_time, 0, 0);
6786 #ifdef SYNC_INPUT
6787 interrupt_input_pending = 1;
6788 #else
6789 handle_async_input ();
6790 #endif
6792 #ifdef BSD4_1
6793 sigfree ();
6794 #endif
6795 errno = old_errno;
6797 #endif /* SIGIO */
6799 /* Send ourselves a SIGIO.
6801 This function exists so that the UNBLOCK_INPUT macro in
6802 blockinput.h can have some way to take care of input we put off
6803 dealing with, without assuming that every file which uses
6804 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6805 void
6806 reinvoke_input_signal ()
6808 #ifdef SIGIO
6809 handle_async_input ();
6810 #endif
6815 static void menu_bar_item P_ ((Lisp_Object, Lisp_Object, Lisp_Object, void*));
6816 static Lisp_Object menu_bar_one_keymap_changed_items;
6818 /* These variables hold the vector under construction within
6819 menu_bar_items and its subroutines, and the current index
6820 for storing into that vector. */
6821 static Lisp_Object menu_bar_items_vector;
6822 static int menu_bar_items_index;
6824 /* Return a vector of menu items for a menu bar, appropriate
6825 to the current buffer. Each item has three elements in the vector:
6826 KEY STRING MAPLIST.
6828 OLD is an old vector we can optionally reuse, or nil. */
6830 Lisp_Object
6831 menu_bar_items (old)
6832 Lisp_Object old;
6834 /* The number of keymaps we're scanning right now, and the number of
6835 keymaps we have allocated space for. */
6836 int nmaps;
6838 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6839 in the current keymaps, or nil where it is not a prefix. */
6840 Lisp_Object *maps;
6842 Lisp_Object def, tail;
6844 Lisp_Object result;
6846 int mapno;
6847 Lisp_Object oquit;
6849 int i;
6851 struct gcpro gcpro1;
6853 /* In order to build the menus, we need to call the keymap
6854 accessors. They all call QUIT. But this function is called
6855 during redisplay, during which a quit is fatal. So inhibit
6856 quitting while building the menus.
6857 We do this instead of specbind because (1) errors will clear it anyway
6858 and (2) this avoids risk of specpdl overflow. */
6859 oquit = Vinhibit_quit;
6860 Vinhibit_quit = Qt;
6862 if (!NILP (old))
6863 menu_bar_items_vector = old;
6864 else
6865 menu_bar_items_vector = Fmake_vector (make_number (24), Qnil);
6866 menu_bar_items_index = 0;
6868 GCPRO1 (menu_bar_items_vector);
6870 /* Build our list of keymaps.
6871 If we recognize a function key and replace its escape sequence in
6872 keybuf with its symbol, or if the sequence starts with a mouse
6873 click and we need to switch buffers, we jump back here to rebuild
6874 the initial keymaps from the current buffer. */
6876 Lisp_Object *tmaps;
6878 /* Should overriding-terminal-local-map and overriding-local-map apply? */
6879 if (!NILP (Voverriding_local_map_menu_flag))
6881 /* Yes, use them (if non-nil) as well as the global map. */
6882 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
6883 nmaps = 0;
6884 if (!NILP (current_kboard->Voverriding_terminal_local_map))
6885 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
6886 if (!NILP (Voverriding_local_map))
6887 maps[nmaps++] = Voverriding_local_map;
6889 else
6891 /* No, so use major and minor mode keymaps and keymap property.
6892 Note that menu-bar bindings in the local-map and keymap
6893 properties may not work reliable, as they are only
6894 recognized when the menu-bar (or mode-line) is updated,
6895 which does not normally happen after every command. */
6896 Lisp_Object tem;
6897 int nminor;
6898 nminor = current_minor_maps (NULL, &tmaps);
6899 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
6900 nmaps = 0;
6901 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
6902 maps[nmaps++] = tem;
6903 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
6904 nmaps += nminor;
6905 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
6907 maps[nmaps++] = current_global_map;
6910 /* Look up in each map the dummy prefix key `menu-bar'. */
6912 result = Qnil;
6914 for (mapno = nmaps - 1; mapno >= 0; mapno--)
6915 if (!NILP (maps[mapno]))
6917 def = get_keymap (access_keymap (maps[mapno], Qmenu_bar, 1, 0, 1),
6918 0, 1);
6919 if (CONSP (def))
6921 menu_bar_one_keymap_changed_items = Qnil;
6922 map_keymap (def, menu_bar_item, Qnil, NULL, 1);
6926 /* Move to the end those items that should be at the end. */
6928 for (tail = Vmenu_bar_final_items; CONSP (tail); tail = XCDR (tail))
6930 int i;
6931 int end = menu_bar_items_index;
6933 for (i = 0; i < end; i += 4)
6934 if (EQ (XCAR (tail), XVECTOR (menu_bar_items_vector)->contents[i]))
6936 Lisp_Object tem0, tem1, tem2, tem3;
6937 /* Move the item at index I to the end,
6938 shifting all the others forward. */
6939 tem0 = XVECTOR (menu_bar_items_vector)->contents[i + 0];
6940 tem1 = XVECTOR (menu_bar_items_vector)->contents[i + 1];
6941 tem2 = XVECTOR (menu_bar_items_vector)->contents[i + 2];
6942 tem3 = XVECTOR (menu_bar_items_vector)->contents[i + 3];
6943 if (end > i + 4)
6944 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
6945 &XVECTOR (menu_bar_items_vector)->contents[i],
6946 (end - i - 4) * sizeof (Lisp_Object));
6947 XVECTOR (menu_bar_items_vector)->contents[end - 4] = tem0;
6948 XVECTOR (menu_bar_items_vector)->contents[end - 3] = tem1;
6949 XVECTOR (menu_bar_items_vector)->contents[end - 2] = tem2;
6950 XVECTOR (menu_bar_items_vector)->contents[end - 1] = tem3;
6951 break;
6955 /* Add nil, nil, nil, nil at the end. */
6956 i = menu_bar_items_index;
6957 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
6959 Lisp_Object tem;
6960 tem = Fmake_vector (make_number (2 * i), Qnil);
6961 bcopy (XVECTOR (menu_bar_items_vector)->contents,
6962 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
6963 menu_bar_items_vector = tem;
6965 /* Add this item. */
6966 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
6967 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
6968 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
6969 XVECTOR (menu_bar_items_vector)->contents[i++] = Qnil;
6970 menu_bar_items_index = i;
6972 Vinhibit_quit = oquit;
6973 UNGCPRO;
6974 return menu_bar_items_vector;
6977 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
6978 If there's already an item for KEY, add this DEF to it. */
6980 Lisp_Object item_properties;
6982 static void
6983 menu_bar_item (key, item, dummy1, dummy2)
6984 Lisp_Object key, item, dummy1;
6985 void *dummy2;
6987 struct gcpro gcpro1;
6988 int i;
6989 Lisp_Object tem;
6991 if (EQ (item, Qundefined))
6993 /* If a map has an explicit `undefined' as definition,
6994 discard any previously made menu bar item. */
6996 for (i = 0; i < menu_bar_items_index; i += 4)
6997 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
6999 if (menu_bar_items_index > i + 4)
7000 bcopy (&XVECTOR (menu_bar_items_vector)->contents[i + 4],
7001 &XVECTOR (menu_bar_items_vector)->contents[i],
7002 (menu_bar_items_index - i - 4) * sizeof (Lisp_Object));
7003 menu_bar_items_index -= 4;
7007 /* If this keymap has already contributed to this KEY,
7008 don't contribute to it a second time. */
7009 tem = Fmemq (key, menu_bar_one_keymap_changed_items);
7010 if (!NILP (tem) || NILP (item))
7011 return;
7013 menu_bar_one_keymap_changed_items
7014 = Fcons (key, menu_bar_one_keymap_changed_items);
7016 /* We add to menu_bar_one_keymap_changed_items before doing the
7017 parse_menu_item, so that if it turns out it wasn't a menu item,
7018 it still correctly hides any further menu item. */
7019 GCPRO1 (key);
7020 i = parse_menu_item (item, 0, 1);
7021 UNGCPRO;
7022 if (!i)
7023 return;
7025 item = XVECTOR (item_properties)->contents[ITEM_PROPERTY_DEF];
7027 /* Find any existing item for this KEY. */
7028 for (i = 0; i < menu_bar_items_index; i += 4)
7029 if (EQ (key, XVECTOR (menu_bar_items_vector)->contents[i]))
7030 break;
7032 /* If we did not find this KEY, add it at the end. */
7033 if (i == menu_bar_items_index)
7035 /* If vector is too small, get a bigger one. */
7036 if (i + 4 > XVECTOR (menu_bar_items_vector)->size)
7038 Lisp_Object tem;
7039 tem = Fmake_vector (make_number (2 * i), Qnil);
7040 bcopy (XVECTOR (menu_bar_items_vector)->contents,
7041 XVECTOR (tem)->contents, i * sizeof (Lisp_Object));
7042 menu_bar_items_vector = tem;
7045 /* Add this item. */
7046 XVECTOR (menu_bar_items_vector)->contents[i++] = key;
7047 XVECTOR (menu_bar_items_vector)->contents[i++]
7048 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
7049 XVECTOR (menu_bar_items_vector)->contents[i++] = Fcons (item, Qnil);
7050 XVECTOR (menu_bar_items_vector)->contents[i++] = make_number (0);
7051 menu_bar_items_index = i;
7053 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7054 else
7056 Lisp_Object old;
7057 old = XVECTOR (menu_bar_items_vector)->contents[i + 2];
7058 /* If the new and the old items are not both keymaps,
7059 the lookup will only find `item'. */
7060 item = Fcons (item, KEYMAPP (item) && KEYMAPP (XCAR (old)) ? old : Qnil);
7061 XVECTOR (menu_bar_items_vector)->contents[i + 2] = item;
7065 /* This is used as the handler when calling menu_item_eval_property. */
7066 static Lisp_Object
7067 menu_item_eval_property_1 (arg)
7068 Lisp_Object arg;
7070 /* If we got a quit from within the menu computation,
7071 quit all the way out of it. This takes care of C-] in the debugger. */
7072 if (CONSP (arg) && EQ (XCAR (arg), Qquit))
7073 Fsignal (Qquit, Qnil);
7075 return Qnil;
7078 /* Evaluate an expression and return the result (or nil if something
7079 went wrong). Used to evaluate dynamic parts of menu items. */
7080 Lisp_Object
7081 menu_item_eval_property (sexpr)
7082 Lisp_Object sexpr;
7084 int count = SPECPDL_INDEX ();
7085 Lisp_Object val;
7086 specbind (Qinhibit_redisplay, Qt);
7087 val = internal_condition_case_1 (Feval, sexpr, Qerror,
7088 menu_item_eval_property_1);
7089 return unbind_to (count, val);
7092 /* This function parses a menu item and leaves the result in the
7093 vector item_properties.
7094 ITEM is a key binding, a possible menu item.
7095 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7096 evaluate dynamic expressions in the menu item.
7097 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7098 top level.
7099 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7100 parse_menu_item returns true if the item is a menu item and false
7101 otherwise. */
7104 parse_menu_item (item, notreal, inmenubar)
7105 Lisp_Object item;
7106 int notreal, inmenubar;
7108 Lisp_Object def, tem, item_string, start;
7109 Lisp_Object cachelist;
7110 Lisp_Object filter;
7111 Lisp_Object keyhint;
7112 int i;
7113 int newcache = 0;
7115 cachelist = Qnil;
7116 filter = Qnil;
7117 keyhint = Qnil;
7119 if (!CONSP (item))
7120 return 0;
7122 /* Create item_properties vector if necessary. */
7123 if (NILP (item_properties))
7124 item_properties
7125 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE + 1), Qnil);
7127 /* Initialize optional entries. */
7128 for (i = ITEM_PROPERTY_DEF; i < ITEM_PROPERTY_ENABLE; i++)
7129 AREF (item_properties, i) = Qnil;
7130 AREF (item_properties, ITEM_PROPERTY_ENABLE) = Qt;
7132 /* Save the item here to protect it from GC. */
7133 AREF (item_properties, ITEM_PROPERTY_ITEM) = item;
7135 item_string = XCAR (item);
7137 start = item;
7138 item = XCDR (item);
7139 if (STRINGP (item_string))
7141 /* Old format menu item. */
7142 AREF (item_properties, ITEM_PROPERTY_NAME) = item_string;
7144 /* Maybe help string. */
7145 if (CONSP (item) && STRINGP (XCAR (item)))
7147 AREF (item_properties, ITEM_PROPERTY_HELP) = XCAR (item);
7148 start = item;
7149 item = XCDR (item);
7152 /* Maybe key binding cache. */
7153 if (CONSP (item) && CONSP (XCAR (item))
7154 && (NILP (XCAR (XCAR (item)))
7155 || VECTORP (XCAR (XCAR (item)))))
7157 cachelist = XCAR (item);
7158 item = XCDR (item);
7161 /* This is the real definition--the function to run. */
7162 AREF (item_properties, ITEM_PROPERTY_DEF) = item;
7164 /* Get enable property, if any. */
7165 if (SYMBOLP (item))
7167 tem = Fget (item, Qmenu_enable);
7168 if (!NILP (tem))
7169 AREF (item_properties, ITEM_PROPERTY_ENABLE) = tem;
7172 else if (EQ (item_string, Qmenu_item) && CONSP (item))
7174 /* New format menu item. */
7175 AREF (item_properties, ITEM_PROPERTY_NAME) = XCAR (item);
7176 start = XCDR (item);
7177 if (CONSP (start))
7179 /* We have a real binding. */
7180 AREF (item_properties, ITEM_PROPERTY_DEF) = XCAR (start);
7182 item = XCDR (start);
7183 /* Is there a cache list with key equivalences. */
7184 if (CONSP (item) && CONSP (XCAR (item)))
7186 cachelist = XCAR (item);
7187 item = XCDR (item);
7190 /* Parse properties. */
7191 while (CONSP (item) && CONSP (XCDR (item)))
7193 tem = XCAR (item);
7194 item = XCDR (item);
7196 if (EQ (tem, QCenable))
7197 AREF (item_properties, ITEM_PROPERTY_ENABLE) = XCAR (item);
7198 else if (EQ (tem, QCvisible) && !notreal)
7200 /* If got a visible property and that evaluates to nil
7201 then ignore this item. */
7202 tem = menu_item_eval_property (XCAR (item));
7203 if (NILP (tem))
7204 return 0;
7206 else if (EQ (tem, QChelp))
7207 AREF (item_properties, ITEM_PROPERTY_HELP) = XCAR (item);
7208 else if (EQ (tem, QCfilter))
7209 filter = item;
7210 else if (EQ (tem, QCkey_sequence))
7212 tem = XCAR (item);
7213 if (NILP (cachelist)
7214 && (SYMBOLP (tem) || STRINGP (tem) || VECTORP (tem)))
7215 /* Be GC protected. Set keyhint to item instead of tem. */
7216 keyhint = item;
7218 else if (EQ (tem, QCkeys))
7220 tem = XCAR (item);
7221 if (CONSP (tem) || (STRINGP (tem) && NILP (cachelist)))
7222 AREF (item_properties, ITEM_PROPERTY_KEYEQ) = tem;
7224 else if (EQ (tem, QCbutton) && CONSP (XCAR (item)))
7226 Lisp_Object type;
7227 tem = XCAR (item);
7228 type = XCAR (tem);
7229 if (EQ (type, QCtoggle) || EQ (type, QCradio))
7231 AREF (item_properties, ITEM_PROPERTY_SELECTED)
7232 = XCDR (tem);
7233 AREF (item_properties, ITEM_PROPERTY_TYPE)
7234 = type;
7237 item = XCDR (item);
7240 else if (inmenubar || !NILP (start))
7241 return 0;
7243 else
7244 return 0; /* not a menu item */
7246 /* If item string is not a string, evaluate it to get string.
7247 If we don't get a string, skip this item. */
7248 item_string = AREF (item_properties, ITEM_PROPERTY_NAME);
7249 if (!(STRINGP (item_string) || notreal))
7251 item_string = menu_item_eval_property (item_string);
7252 if (!STRINGP (item_string))
7253 return 0;
7254 AREF (item_properties, ITEM_PROPERTY_NAME) = item_string;
7257 /* If got a filter apply it on definition. */
7258 def = AREF (item_properties, ITEM_PROPERTY_DEF);
7259 if (!NILP (filter))
7261 def = menu_item_eval_property (list2 (XCAR (filter),
7262 list2 (Qquote, def)));
7264 AREF (item_properties, ITEM_PROPERTY_DEF) = def;
7267 /* Enable or disable selection of item. */
7268 tem = AREF (item_properties, ITEM_PROPERTY_ENABLE);
7269 if (!EQ (tem, Qt))
7271 if (notreal)
7272 tem = Qt;
7273 else
7274 tem = menu_item_eval_property (tem);
7275 if (inmenubar && NILP (tem))
7276 return 0; /* Ignore disabled items in menu bar. */
7277 AREF (item_properties, ITEM_PROPERTY_ENABLE) = tem;
7280 /* If we got no definition, this item is just unselectable text which
7281 is OK in a submenu but not in the menubar. */
7282 if (NILP (def))
7283 return (inmenubar ? 0 : 1);
7285 /* See if this is a separate pane or a submenu. */
7286 def = AREF (item_properties, ITEM_PROPERTY_DEF);
7287 tem = get_keymap (def, 0, 1);
7288 /* For a subkeymap, just record its details and exit. */
7289 if (CONSP (tem))
7291 AREF (item_properties, ITEM_PROPERTY_MAP) = tem;
7292 AREF (item_properties, ITEM_PROPERTY_DEF) = tem;
7293 return 1;
7296 /* At the top level in the menu bar, do likewise for commands also.
7297 The menu bar does not display equivalent key bindings anyway.
7298 ITEM_PROPERTY_DEF is already set up properly. */
7299 if (inmenubar > 0)
7300 return 1;
7302 /* This is a command. See if there is an equivalent key binding. */
7303 if (NILP (cachelist))
7305 /* We have to create a cachelist. */
7306 CHECK_IMPURE (start);
7307 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
7308 cachelist = XCAR (XCDR (start));
7309 newcache = 1;
7310 tem = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
7311 if (!NILP (keyhint))
7313 XSETCAR (cachelist, XCAR (keyhint));
7314 newcache = 0;
7316 else if (STRINGP (tem))
7318 XSETCDR (cachelist, Fsubstitute_command_keys (tem));
7319 XSETCAR (cachelist, Qt);
7323 tem = XCAR (cachelist);
7324 if (!EQ (tem, Qt))
7326 int chkcache = 0;
7327 Lisp_Object prefix;
7329 if (!NILP (tem))
7330 tem = Fkey_binding (tem, Qnil, Qnil);
7332 prefix = AREF (item_properties, ITEM_PROPERTY_KEYEQ);
7333 if (CONSP (prefix))
7335 def = XCAR (prefix);
7336 prefix = XCDR (prefix);
7338 else
7339 def = AREF (item_properties, ITEM_PROPERTY_DEF);
7341 if (!update_menu_bindings)
7342 chkcache = 0;
7343 else if (NILP (XCAR (cachelist))) /* Have no saved key. */
7345 if (newcache /* Always check first time. */
7346 /* Should we check everything when precomputing key
7347 bindings? */
7348 /* If something had no key binding before, don't recheck it
7349 because that is too slow--except if we have a list of
7350 rebound commands in Vdefine_key_rebound_commands, do
7351 recheck any command that appears in that list. */
7352 || (CONSP (Vdefine_key_rebound_commands)
7353 && !NILP (Fmemq (def, Vdefine_key_rebound_commands))))
7354 chkcache = 1;
7356 /* We had a saved key. Is it still bound to the command? */
7357 else if (NILP (tem)
7358 || (!EQ (tem, def)
7359 /* If the command is an alias for another
7360 (such as lmenu.el set it up), check if the
7361 original command matches the cached command. */
7362 && !(SYMBOLP (def) && EQ (tem, XSYMBOL (def)->function))))
7363 chkcache = 1; /* Need to recompute key binding. */
7365 if (chkcache)
7367 /* Recompute equivalent key binding. If the command is an alias
7368 for another (such as lmenu.el set it up), see if the original
7369 command name has equivalent keys. Otherwise look up the
7370 specified command itself. We don't try both, because that
7371 makes lmenu menus slow. */
7372 if (SYMBOLP (def)
7373 && SYMBOLP (XSYMBOL (def)->function)
7374 && ! NILP (Fget (def, Qmenu_alias)))
7375 def = XSYMBOL (def)->function;
7376 tem = Fwhere_is_internal (def, Qnil, Qt, Qnil, Qt);
7377 XSETCAR (cachelist, tem);
7378 if (NILP (tem))
7380 XSETCDR (cachelist, Qnil);
7381 chkcache = 0;
7384 else if (!NILP (keyhint) && !NILP (XCAR (cachelist)))
7386 tem = XCAR (cachelist);
7387 chkcache = 1;
7390 newcache = chkcache;
7391 if (chkcache)
7393 tem = Fkey_description (tem);
7394 if (CONSP (prefix))
7396 if (STRINGP (XCAR (prefix)))
7397 tem = concat2 (XCAR (prefix), tem);
7398 if (STRINGP (XCDR (prefix)))
7399 tem = concat2 (tem, XCDR (prefix));
7401 XSETCDR (cachelist, tem);
7405 tem = XCDR (cachelist);
7406 if (newcache && !NILP (tem))
7408 tem = concat3 (build_string (" ("), tem, build_string (")"));
7409 XSETCDR (cachelist, tem);
7412 /* If we only want to precompute equivalent key bindings, stop here. */
7413 if (notreal)
7414 return 1;
7416 /* If we have an equivalent key binding, use that. */
7417 AREF (item_properties, ITEM_PROPERTY_KEYEQ) = tem;
7419 /* Include this when menu help is implemented.
7420 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7421 if (!(NILP (tem) || STRINGP (tem)))
7423 tem = menu_item_eval_property (tem);
7424 if (!STRINGP (tem))
7425 tem = Qnil;
7426 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7430 /* Handle radio buttons or toggle boxes. */
7431 tem = AREF (item_properties, ITEM_PROPERTY_SELECTED);
7432 if (!NILP (tem))
7433 AREF (item_properties, ITEM_PROPERTY_SELECTED)
7434 = menu_item_eval_property (tem);
7436 return 1;
7441 /***********************************************************************
7442 Tool-bars
7443 ***********************************************************************/
7445 /* A vector holding tool bar items while they are parsed in function
7446 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7447 in the vector. */
7449 static Lisp_Object tool_bar_items_vector;
7451 /* A vector holding the result of parse_tool_bar_item. Layout is like
7452 the one for a single item in tool_bar_items_vector. */
7454 static Lisp_Object tool_bar_item_properties;
7456 /* Next free index in tool_bar_items_vector. */
7458 static int ntool_bar_items;
7460 /* The symbols `tool-bar', and `:image'. */
7462 extern Lisp_Object Qtool_bar;
7463 Lisp_Object QCimage;
7465 /* Function prototypes. */
7467 static void init_tool_bar_items P_ ((Lisp_Object));
7468 static void process_tool_bar_item P_ ((Lisp_Object, Lisp_Object));
7469 static int parse_tool_bar_item P_ ((Lisp_Object, Lisp_Object));
7470 static void append_tool_bar_item P_ ((void));
7473 /* Return a vector of tool bar items for keymaps currently in effect.
7474 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7475 tool bar items found. */
7477 Lisp_Object
7478 tool_bar_items (reuse, nitems)
7479 Lisp_Object reuse;
7480 int *nitems;
7482 Lisp_Object *maps;
7483 int nmaps, i;
7484 Lisp_Object oquit;
7485 Lisp_Object *tmaps;
7487 *nitems = 0;
7489 /* In order to build the menus, we need to call the keymap
7490 accessors. They all call QUIT. But this function is called
7491 during redisplay, during which a quit is fatal. So inhibit
7492 quitting while building the menus. We do this instead of
7493 specbind because (1) errors will clear it anyway and (2) this
7494 avoids risk of specpdl overflow. */
7495 oquit = Vinhibit_quit;
7496 Vinhibit_quit = Qt;
7498 /* Initialize tool_bar_items_vector and protect it from GC. */
7499 init_tool_bar_items (reuse);
7501 /* Build list of keymaps in maps. Set nmaps to the number of maps
7502 to process. */
7504 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7505 if (!NILP (Voverriding_local_map_menu_flag))
7507 /* Yes, use them (if non-nil) as well as the global map. */
7508 maps = (Lisp_Object *) alloca (3 * sizeof (maps[0]));
7509 nmaps = 0;
7510 if (!NILP (current_kboard->Voverriding_terminal_local_map))
7511 maps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
7512 if (!NILP (Voverriding_local_map))
7513 maps[nmaps++] = Voverriding_local_map;
7515 else
7517 /* No, so use major and minor mode keymaps and keymap property.
7518 Note that tool-bar bindings in the local-map and keymap
7519 properties may not work reliable, as they are only
7520 recognized when the tool-bar (or mode-line) is updated,
7521 which does not normally happen after every command. */
7522 Lisp_Object tem;
7523 int nminor;
7524 nminor = current_minor_maps (NULL, &tmaps);
7525 maps = (Lisp_Object *) alloca ((nminor + 3) * sizeof (maps[0]));
7526 nmaps = 0;
7527 if (tem = get_local_map (PT, current_buffer, Qkeymap), !NILP (tem))
7528 maps[nmaps++] = tem;
7529 bcopy (tmaps, (void *) (maps + nmaps), nminor * sizeof (maps[0]));
7530 nmaps += nminor;
7531 maps[nmaps++] = get_local_map (PT, current_buffer, Qlocal_map);
7534 /* Add global keymap at the end. */
7535 maps[nmaps++] = current_global_map;
7537 /* Process maps in reverse order and look up in each map the prefix
7538 key `tool-bar'. */
7539 for (i = nmaps - 1; i >= 0; --i)
7540 if (!NILP (maps[i]))
7542 Lisp_Object keymap;
7544 keymap = get_keymap (access_keymap (maps[i], Qtool_bar, 1, 0, 1), 0, 1);
7545 if (CONSP (keymap))
7547 Lisp_Object tail;
7549 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7550 for (tail = keymap; CONSP (tail); tail = XCDR (tail))
7552 Lisp_Object keydef = XCAR (tail);
7553 if (CONSP (keydef))
7554 process_tool_bar_item (XCAR (keydef), XCDR (keydef));
7559 Vinhibit_quit = oquit;
7560 *nitems = ntool_bar_items / TOOL_BAR_ITEM_NSLOTS;
7561 return tool_bar_items_vector;
7565 /* Process the definition of KEY which is DEF. */
7567 static void
7568 process_tool_bar_item (key, def)
7569 Lisp_Object key, def;
7571 int i;
7572 extern Lisp_Object Qundefined;
7573 struct gcpro gcpro1, gcpro2;
7575 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7576 eval. */
7577 GCPRO2 (key, def);
7579 if (EQ (def, Qundefined))
7581 /* If a map has an explicit `undefined' as definition,
7582 discard any previously made item. */
7583 for (i = 0; i < ntool_bar_items; i += TOOL_BAR_ITEM_NSLOTS)
7585 Lisp_Object *v = XVECTOR (tool_bar_items_vector)->contents + i;
7587 if (EQ (key, v[TOOL_BAR_ITEM_KEY]))
7589 if (ntool_bar_items > i + TOOL_BAR_ITEM_NSLOTS)
7590 bcopy (v + TOOL_BAR_ITEM_NSLOTS, v,
7591 ((ntool_bar_items - i - TOOL_BAR_ITEM_NSLOTS)
7592 * sizeof (Lisp_Object)));
7593 ntool_bar_items -= TOOL_BAR_ITEM_NSLOTS;
7594 break;
7598 else if (parse_tool_bar_item (key, def))
7599 /* Append a new tool bar item to tool_bar_items_vector. Accept
7600 more than one definition for the same key. */
7601 append_tool_bar_item ();
7603 UNGCPRO;
7607 /* Parse a tool bar item specification ITEM for key KEY and return the
7608 result in tool_bar_item_properties. Value is zero if ITEM is
7609 invalid.
7611 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7613 CAPTION is the caption of the item, If it's not a string, it is
7614 evaluated to get a string.
7616 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7617 as binding are currently ignored.
7619 The following properties are recognized:
7621 - `:enable FORM'.
7623 FORM is evaluated and specifies whether the tool bar item is
7624 enabled or disabled.
7626 - `:visible FORM'
7628 FORM is evaluated and specifies whether the tool bar item is visible.
7630 - `:filter FUNCTION'
7632 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7633 result is stored as the new binding.
7635 - `:button (TYPE SELECTED)'
7637 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7638 and specifies whether the button is selected (pressed) or not.
7640 - `:image IMAGES'
7642 IMAGES is either a single image specification or a vector of four
7643 image specifications. See enum tool_bar_item_images.
7645 - `:help HELP-STRING'.
7647 Gives a help string to display for the tool bar item. */
7649 static int
7650 parse_tool_bar_item (key, item)
7651 Lisp_Object key, item;
7653 /* Access slot with index IDX of vector tool_bar_item_properties. */
7654 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7656 Lisp_Object filter = Qnil;
7657 Lisp_Object caption;
7658 int i;
7660 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7661 Rule out items that aren't lists, don't start with
7662 `menu-item' or whose rest following `tool-bar-item' is not a
7663 list. */
7664 if (!CONSP (item)
7665 || !EQ (XCAR (item), Qmenu_item)
7666 || (item = XCDR (item),
7667 !CONSP (item)))
7668 return 0;
7670 /* Create tool_bar_item_properties vector if necessary. Reset it to
7671 defaults. */
7672 if (VECTORP (tool_bar_item_properties))
7674 for (i = 0; i < TOOL_BAR_ITEM_NSLOTS; ++i)
7675 PROP (i) = Qnil;
7677 else
7678 tool_bar_item_properties
7679 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS), Qnil);
7681 /* Set defaults. */
7682 PROP (TOOL_BAR_ITEM_KEY) = key;
7683 PROP (TOOL_BAR_ITEM_ENABLED_P) = Qt;
7685 /* Get the caption of the item. If the caption is not a string,
7686 evaluate it to get a string. If we don't get a string, skip this
7687 item. */
7688 caption = XCAR (item);
7689 if (!STRINGP (caption))
7691 caption = menu_item_eval_property (caption);
7692 if (!STRINGP (caption))
7693 return 0;
7695 PROP (TOOL_BAR_ITEM_CAPTION) = caption;
7697 /* Give up if rest following the caption is not a list. */
7698 item = XCDR (item);
7699 if (!CONSP (item))
7700 return 0;
7702 /* Store the binding. */
7703 PROP (TOOL_BAR_ITEM_BINDING) = XCAR (item);
7704 item = XCDR (item);
7706 /* Ignore cached key binding, if any. */
7707 if (CONSP (item) && CONSP (XCAR (item)))
7708 item = XCDR (item);
7710 /* Process the rest of the properties. */
7711 for (; CONSP (item) && CONSP (XCDR (item)); item = XCDR (XCDR (item)))
7713 Lisp_Object key, value;
7715 key = XCAR (item);
7716 value = XCAR (XCDR (item));
7718 if (EQ (key, QCenable))
7719 /* `:enable FORM'. */
7720 PROP (TOOL_BAR_ITEM_ENABLED_P) = value;
7721 else if (EQ (key, QCvisible))
7723 /* `:visible FORM'. If got a visible property and that
7724 evaluates to nil then ignore this item. */
7725 if (NILP (menu_item_eval_property (value)))
7726 return 0;
7728 else if (EQ (key, QChelp))
7729 /* `:help HELP-STRING'. */
7730 PROP (TOOL_BAR_ITEM_HELP) = value;
7731 else if (EQ (key, QCfilter))
7732 /* ':filter FORM'. */
7733 filter = value;
7734 else if (EQ (key, QCbutton) && CONSP (value))
7736 /* `:button (TYPE . SELECTED)'. */
7737 Lisp_Object type, selected;
7739 type = XCAR (value);
7740 selected = XCDR (value);
7741 if (EQ (type, QCtoggle) || EQ (type, QCradio))
7743 PROP (TOOL_BAR_ITEM_SELECTED_P) = selected;
7744 PROP (TOOL_BAR_ITEM_TYPE) = type;
7747 else if (EQ (key, QCimage)
7748 && (CONSP (value)
7749 || (VECTORP (value) && XVECTOR (value)->size == 4)))
7750 /* Value is either a single image specification or a vector
7751 of 4 such specifications for the different button states. */
7752 PROP (TOOL_BAR_ITEM_IMAGES) = value;
7755 /* If got a filter apply it on binding. */
7756 if (!NILP (filter))
7757 PROP (TOOL_BAR_ITEM_BINDING)
7758 = menu_item_eval_property (list2 (filter,
7759 list2 (Qquote,
7760 PROP (TOOL_BAR_ITEM_BINDING))));
7762 /* See if the binding is a keymap. Give up if it is. */
7763 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING), 0, 1)))
7764 return 0;
7766 /* Enable or disable selection of item. */
7767 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P), Qt))
7768 PROP (TOOL_BAR_ITEM_ENABLED_P)
7769 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P));
7771 /* Handle radio buttons or toggle boxes. */
7772 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P)))
7773 PROP (TOOL_BAR_ITEM_SELECTED_P)
7774 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P));
7776 return 1;
7778 #undef PROP
7782 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7783 that can be reused. */
7785 static void
7786 init_tool_bar_items (reuse)
7787 Lisp_Object reuse;
7789 if (VECTORP (reuse))
7790 tool_bar_items_vector = reuse;
7791 else
7792 tool_bar_items_vector = Fmake_vector (make_number (64), Qnil);
7793 ntool_bar_items = 0;
7797 /* Append parsed tool bar item properties from
7798 tool_bar_item_properties */
7800 static void
7801 append_tool_bar_item ()
7803 Lisp_Object *to, *from;
7805 /* Enlarge tool_bar_items_vector if necessary. */
7806 if (ntool_bar_items + TOOL_BAR_ITEM_NSLOTS
7807 >= XVECTOR (tool_bar_items_vector)->size)
7809 Lisp_Object new_vector;
7810 int old_size = XVECTOR (tool_bar_items_vector)->size;
7812 new_vector = Fmake_vector (make_number (2 * old_size), Qnil);
7813 bcopy (XVECTOR (tool_bar_items_vector)->contents,
7814 XVECTOR (new_vector)->contents,
7815 old_size * sizeof (Lisp_Object));
7816 tool_bar_items_vector = new_vector;
7819 /* Append entries from tool_bar_item_properties to the end of
7820 tool_bar_items_vector. */
7821 to = XVECTOR (tool_bar_items_vector)->contents + ntool_bar_items;
7822 from = XVECTOR (tool_bar_item_properties)->contents;
7823 bcopy (from, to, TOOL_BAR_ITEM_NSLOTS * sizeof *to);
7824 ntool_bar_items += TOOL_BAR_ITEM_NSLOTS;
7831 /* Read a character using menus based on maps in the array MAPS.
7832 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7833 Return t if we displayed a menu but the user rejected it.
7835 PREV_EVENT is the previous input event, or nil if we are reading
7836 the first event of a key sequence.
7838 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7839 if we used a mouse menu to read the input, or zero otherwise. If
7840 USED_MOUSE_MENU is null, we don't dereference it.
7842 The prompting is done based on the prompt-string of the map
7843 and the strings associated with various map elements.
7845 This can be done with X menus or with menus put in the minibuf.
7846 These are done in different ways, depending on how the input will be read.
7847 Menus using X are done after auto-saving in read-char, getting the input
7848 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7849 and do auto-saving in the inner call of read_char. */
7851 static Lisp_Object
7852 read_char_x_menu_prompt (nmaps, maps, prev_event, used_mouse_menu)
7853 int nmaps;
7854 Lisp_Object *maps;
7855 Lisp_Object prev_event;
7856 int *used_mouse_menu;
7858 int mapno;
7859 register Lisp_Object name = Qnil;
7861 if (used_mouse_menu)
7862 *used_mouse_menu = 0;
7864 /* Use local over global Menu maps */
7866 if (! menu_prompting)
7867 return Qnil;
7869 /* Optionally disregard all but the global map. */
7870 if (inhibit_local_menu_bar_menus)
7872 maps += (nmaps - 1);
7873 nmaps = 1;
7876 /* Get the menu name from the first map that has one (a prompt string). */
7877 for (mapno = 0; mapno < nmaps; mapno++)
7879 name = Fkeymap_prompt (maps[mapno]);
7880 if (!NILP (name))
7881 break;
7884 /* If we don't have any menus, just read a character normally. */
7885 if (!STRINGP (name))
7886 return Qnil;
7888 #ifdef HAVE_MENUS
7889 /* If we got to this point via a mouse click,
7890 use a real menu for mouse selection. */
7891 if (EVENT_HAS_PARAMETERS (prev_event)
7892 && !EQ (XCAR (prev_event), Qmenu_bar)
7893 && !EQ (XCAR (prev_event), Qtool_bar))
7895 /* Display the menu and get the selection. */
7896 Lisp_Object *realmaps
7897 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
7898 Lisp_Object value;
7899 int nmaps1 = 0;
7901 /* Use the maps that are not nil. */
7902 for (mapno = 0; mapno < nmaps; mapno++)
7903 if (!NILP (maps[mapno]))
7904 realmaps[nmaps1++] = maps[mapno];
7906 value = Fx_popup_menu (prev_event, Flist (nmaps1, realmaps));
7907 if (CONSP (value))
7909 Lisp_Object tem;
7911 record_menu_key (XCAR (value));
7913 /* If we got multiple events, unread all but
7914 the first.
7915 There is no way to prevent those unread events
7916 from showing up later in last_nonmenu_event.
7917 So turn symbol and integer events into lists,
7918 to indicate that they came from a mouse menu,
7919 so that when present in last_nonmenu_event
7920 they won't confuse things. */
7921 for (tem = XCDR (value); !NILP (tem); tem = XCDR (tem))
7923 record_menu_key (XCAR (tem));
7924 if (SYMBOLP (XCAR (tem))
7925 || INTEGERP (XCAR (tem)))
7926 XSETCAR (tem, Fcons (XCAR (tem), Qdisabled));
7929 /* If we got more than one event, put all but the first
7930 onto this list to be read later.
7931 Return just the first event now. */
7932 Vunread_command_events
7933 = nconc2 (XCDR (value), Vunread_command_events);
7934 value = XCAR (value);
7936 else if (NILP (value))
7937 value = Qt;
7938 if (used_mouse_menu)
7939 *used_mouse_menu = 1;
7940 return value;
7942 #endif /* HAVE_MENUS */
7943 return Qnil ;
7946 /* Buffer in use so far for the minibuf prompts for menu keymaps.
7947 We make this bigger when necessary, and never free it. */
7948 static char *read_char_minibuf_menu_text;
7949 /* Size of that buffer. */
7950 static int read_char_minibuf_menu_width;
7952 static Lisp_Object
7953 read_char_minibuf_menu_prompt (commandflag, nmaps, maps)
7954 int commandflag ;
7955 int nmaps;
7956 Lisp_Object *maps;
7958 int mapno;
7959 register Lisp_Object name;
7960 int nlength;
7961 /* FIXME: Use the minibuffer's frame width. */
7962 int width = FRAME_COLS (SELECTED_FRAME ()) - 4;
7963 int idx = -1;
7964 int nobindings = 1;
7965 Lisp_Object rest, vector;
7966 char *menu;
7968 vector = Qnil;
7969 name = Qnil;
7971 if (! menu_prompting)
7972 return Qnil;
7974 /* Make sure we have a big enough buffer for the menu text. */
7975 if (read_char_minibuf_menu_text == 0)
7977 read_char_minibuf_menu_width = width + 4;
7978 read_char_minibuf_menu_text = (char *) xmalloc (width + 4);
7980 else if (width + 4 > read_char_minibuf_menu_width)
7982 read_char_minibuf_menu_width = width + 4;
7983 read_char_minibuf_menu_text
7984 = (char *) xrealloc (read_char_minibuf_menu_text, width + 4);
7986 menu = read_char_minibuf_menu_text;
7988 /* Get the menu name from the first map that has one (a prompt string). */
7989 for (mapno = 0; mapno < nmaps; mapno++)
7991 name = Fkeymap_prompt (maps[mapno]);
7992 if (!NILP (name))
7993 break;
7996 /* If we don't have any menus, just read a character normally. */
7997 if (!STRINGP (name))
7998 return Qnil;
8000 /* Prompt string always starts with map's prompt, and a space. */
8001 strcpy (menu, SDATA (name));
8002 nlength = SBYTES (name);
8003 menu[nlength++] = ':';
8004 menu[nlength++] = ' ';
8005 menu[nlength] = 0;
8007 /* Start prompting at start of first map. */
8008 mapno = 0;
8009 rest = maps[mapno];
8011 /* Present the documented bindings, a line at a time. */
8012 while (1)
8014 int notfirst = 0;
8015 int i = nlength;
8016 Lisp_Object obj;
8017 int ch;
8018 Lisp_Object orig_defn_macro;
8020 /* Loop over elements of map. */
8021 while (i < width)
8023 Lisp_Object elt;
8025 /* If reached end of map, start at beginning of next map. */
8026 if (NILP (rest))
8028 mapno++;
8029 /* At end of last map, wrap around to first map if just starting,
8030 or end this line if already have something on it. */
8031 if (mapno == nmaps)
8033 mapno = 0;
8034 if (notfirst || nobindings) break;
8036 rest = maps[mapno];
8039 /* Look at the next element of the map. */
8040 if (idx >= 0)
8041 elt = XVECTOR (vector)->contents[idx];
8042 else
8043 elt = Fcar_safe (rest);
8045 if (idx < 0 && VECTORP (elt))
8047 /* If we found a dense table in the keymap,
8048 advanced past it, but start scanning its contents. */
8049 rest = Fcdr_safe (rest);
8050 vector = elt;
8051 idx = 0;
8053 else
8055 /* An ordinary element. */
8056 Lisp_Object event, tem;
8058 if (idx < 0)
8060 event = Fcar_safe (elt); /* alist */
8061 elt = Fcdr_safe (elt);
8063 else
8065 XSETINT (event, idx); /* vector */
8068 /* Ignore the element if it has no prompt string. */
8069 if (INTEGERP (event) && parse_menu_item (elt, 0, -1))
8071 /* 1 if the char to type matches the string. */
8072 int char_matches;
8073 Lisp_Object upcased_event, downcased_event;
8074 Lisp_Object desc = Qnil;
8075 Lisp_Object s
8076 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
8078 upcased_event = Fupcase (event);
8079 downcased_event = Fdowncase (event);
8080 char_matches = (XINT (upcased_event) == SREF (s, 0)
8081 || XINT (downcased_event) == SREF (s, 0));
8082 if (! char_matches)
8083 desc = Fsingle_key_description (event, Qnil);
8085 #if 0 /* It is redundant to list the equivalent key bindings because
8086 the prefix is what the user has already typed. */
8088 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_KEYEQ];
8089 if (!NILP (tem))
8090 /* Insert equivalent keybinding. */
8091 s = concat2 (s, tem);
8092 #endif
8094 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_TYPE];
8095 if (EQ (tem, QCradio) || EQ (tem, QCtoggle))
8097 /* Insert button prefix. */
8098 Lisp_Object selected
8099 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_SELECTED];
8100 if (EQ (tem, QCradio))
8101 tem = build_string (NILP (selected) ? "(*) " : "( ) ");
8102 else
8103 tem = build_string (NILP (selected) ? "[X] " : "[ ] ");
8104 s = concat2 (tem, s);
8108 /* If we have room for the prompt string, add it to this line.
8109 If this is the first on the line, always add it. */
8110 if ((SCHARS (s) + i + 2
8111 + (char_matches ? 0 : SCHARS (desc) + 3))
8112 < width
8113 || !notfirst)
8115 int thiswidth;
8117 /* Punctuate between strings. */
8118 if (notfirst)
8120 strcpy (menu + i, ", ");
8121 i += 2;
8123 notfirst = 1;
8124 nobindings = 0 ;
8126 /* If the char to type doesn't match the string's
8127 first char, explicitly show what char to type. */
8128 if (! char_matches)
8130 /* Add as much of string as fits. */
8131 thiswidth = SCHARS (desc);
8132 if (thiswidth + i > width)
8133 thiswidth = width - i;
8134 bcopy (SDATA (desc), menu + i, thiswidth);
8135 i += thiswidth;
8136 strcpy (menu + i, " = ");
8137 i += 3;
8140 /* Add as much of string as fits. */
8141 thiswidth = SCHARS (s);
8142 if (thiswidth + i > width)
8143 thiswidth = width - i;
8144 bcopy (SDATA (s), menu + i, thiswidth);
8145 i += thiswidth;
8146 menu[i] = 0;
8148 else
8150 /* If this element does not fit, end the line now,
8151 and save the element for the next line. */
8152 strcpy (menu + i, "...");
8153 break;
8157 /* Move past this element. */
8158 if (idx >= 0 && idx + 1 >= XVECTOR (vector)->size)
8159 /* Handle reaching end of dense table. */
8160 idx = -1;
8161 if (idx >= 0)
8162 idx++;
8163 else
8164 rest = Fcdr_safe (rest);
8168 /* Prompt with that and read response. */
8169 message2_nolog (menu, strlen (menu),
8170 ! NILP (current_buffer->enable_multibyte_characters));
8172 /* Make believe its not a keyboard macro in case the help char
8173 is pressed. Help characters are not recorded because menu prompting
8174 is not used on replay.
8176 orig_defn_macro = current_kboard->defining_kbd_macro;
8177 current_kboard->defining_kbd_macro = Qnil;
8179 obj = read_char (commandflag, 0, 0, Qt, 0);
8180 while (BUFFERP (obj));
8181 current_kboard->defining_kbd_macro = orig_defn_macro;
8183 if (!INTEGERP (obj))
8184 return obj;
8185 else
8186 ch = XINT (obj);
8188 if (! EQ (obj, menu_prompt_more_char)
8189 && (!INTEGERP (menu_prompt_more_char)
8190 || ! EQ (obj, make_number (Ctl (XINT (menu_prompt_more_char))))))
8192 if (!NILP (current_kboard->defining_kbd_macro))
8193 store_kbd_macro_char (obj);
8194 return obj;
8196 /* Help char - go round again */
8200 /* Reading key sequences. */
8202 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8203 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8204 keymap, or nil otherwise. Return the index of the first keymap in
8205 which KEY has any binding, or NMAPS if no map has a binding.
8207 If KEY is a meta ASCII character, treat it like meta-prefix-char
8208 followed by the corresponding non-meta character. Keymaps in
8209 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8210 NEXT.
8212 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8213 unmodified.
8215 NEXT may be the same array as CURRENT. */
8217 static int
8218 follow_key (key, nmaps, current, defs, next)
8219 Lisp_Object key;
8220 Lisp_Object *current, *defs, *next;
8221 int nmaps;
8223 int i, first_binding;
8225 first_binding = nmaps;
8226 for (i = nmaps - 1; i >= 0; i--)
8228 if (! NILP (current[i]))
8230 defs[i] = access_keymap (current[i], key, 1, 0, 1);
8231 if (! NILP (defs[i]))
8232 first_binding = i;
8234 else
8235 defs[i] = Qnil;
8238 /* Given the set of bindings we've found, produce the next set of maps. */
8239 if (first_binding < nmaps)
8240 for (i = 0; i < nmaps; i++)
8241 next[i] = NILP (defs[i]) ? Qnil : get_keymap (defs[i], 0, 1);
8243 return first_binding;
8246 /* Structure used to keep track of partial application of key remapping
8247 such as Vfunction_key_map and Vkey_translation_map. */
8248 typedef struct keyremap
8250 Lisp_Object map, parent;
8251 int start, end;
8252 } keyremap;
8254 /* Lookup KEY in MAP.
8255 MAP is a keymap mapping keys to key vectors or functions.
8256 If the mapping is a function and DO_FUNCTION is non-zero, then
8257 the function is called with PROMPT as parameter and its return
8258 value is used as the return value of this function (after checking
8259 that it is indeed a vector). */
8261 static Lisp_Object
8262 access_keymap_keyremap (map, key, prompt, do_funcall)
8263 Lisp_Object map, key, prompt;
8264 int do_funcall;
8266 Lisp_Object next;
8268 next = access_keymap (map, key, 1, 0, 1);
8270 /* Handle symbol with autoload definition. */
8271 if (SYMBOLP (next) && !NILP (Ffboundp (next))
8272 && CONSP (XSYMBOL (next)->function)
8273 && EQ (XCAR (XSYMBOL (next)->function), Qautoload))
8274 do_autoload (XSYMBOL (next)->function, next);
8276 /* Handle a symbol whose function definition is a keymap
8277 or an array. */
8278 if (SYMBOLP (next) && !NILP (Ffboundp (next))
8279 && (!NILP (Farrayp (XSYMBOL (next)->function))
8280 || KEYMAPP (XSYMBOL (next)->function)))
8281 next = XSYMBOL (next)->function;
8283 /* If the keymap gives a function, not an
8284 array, then call the function with one arg and use
8285 its value instead. */
8286 if (SYMBOLP (next) && !NILP (Ffboundp (next)) && do_funcall)
8288 Lisp_Object tem;
8289 tem = next;
8291 next = call1 (next, prompt);
8292 /* If the function returned something invalid,
8293 barf--don't ignore it.
8294 (To ignore it safely, we would need to gcpro a bunch of
8295 other variables.) */
8296 if (! (VECTORP (next) || STRINGP (next)))
8297 error ("Function %s returns invalid key sequence", tem);
8299 return next;
8302 /* Do one step of the key remapping used for function-key-map and
8303 key-translation-map:
8304 KEYBUF is the buffer holding the input events.
8305 BUFSIZE is its maximum size.
8306 FKEY is a pointer to the keyremap structure to use.
8307 INPUT is the index of the last element in KEYBUF.
8308 DOIT if non-zero says that the remapping can actually take place.
8309 DIFF is used to return the number of keys added/removed by the remapping.
8310 PARENT is the root of the keymap.
8311 PROMPT is the prompt to use if the remapping happens through a function.
8312 The return value is non-zero if the remapping actually took place. */
8314 static int
8315 keyremap_step (keybuf, bufsize, fkey, input, doit, diff, prompt)
8316 Lisp_Object *keybuf, prompt;
8317 keyremap *fkey;
8318 int input, doit, *diff, bufsize;
8320 Lisp_Object next, key;
8322 key = keybuf[fkey->end++];
8323 next = access_keymap_keyremap (fkey->map, key, prompt, doit);
8325 /* If keybuf[fkey->start..fkey->end] is bound in the
8326 map and we're in a position to do the key remapping, replace it with
8327 the binding and restart with fkey->start at the end. */
8328 if ((VECTORP (next) || STRINGP (next)) && doit)
8330 int len = XFASTINT (Flength (next));
8331 int i;
8333 *diff = len - (fkey->end - fkey->start);
8335 if (input + *diff >= bufsize)
8336 error ("Key sequence too long");
8338 /* Shift the keys that follow fkey->end. */
8339 if (*diff < 0)
8340 for (i = fkey->end; i < input; i++)
8341 keybuf[i + *diff] = keybuf[i];
8342 else if (*diff > 0)
8343 for (i = input - 1; i >= fkey->end; i--)
8344 keybuf[i + *diff] = keybuf[i];
8345 /* Overwrite the old keys with the new ones. */
8346 for (i = 0; i < len; i++)
8347 keybuf[fkey->start + i]
8348 = Faref (next, make_number (i));
8350 fkey->start = fkey->end += *diff;
8351 fkey->map = fkey->parent;
8353 return 1;
8356 fkey->map = get_keymap (next, 0, 1);
8358 /* If we no longer have a bound suffix, try a new position for
8359 fkey->start. */
8360 if (!CONSP (fkey->map))
8362 fkey->end = ++fkey->start;
8363 fkey->map = fkey->parent;
8365 return 0;
8368 /* Read a sequence of keys that ends with a non prefix character,
8369 storing it in KEYBUF, a buffer of size BUFSIZE.
8370 Prompt with PROMPT.
8371 Return the length of the key sequence stored.
8372 Return -1 if the user rejected a command menu.
8374 Echo starting immediately unless `prompt' is 0.
8376 Where a key sequence ends depends on the currently active keymaps.
8377 These include any minor mode keymaps active in the current buffer,
8378 the current buffer's local map, and the global map.
8380 If a key sequence has no other bindings, we check Vfunction_key_map
8381 to see if some trailing subsequence might be the beginning of a
8382 function key's sequence. If so, we try to read the whole function
8383 key, and substitute its symbolic name into the key sequence.
8385 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8386 `double-' events into similar click events, if that would make them
8387 bound. We try to turn `triple-' events first into `double-' events,
8388 then into clicks.
8390 If we get a mouse click in a mode line, vertical divider, or other
8391 non-text area, we treat the click as if it were prefixed by the
8392 symbol denoting that area - `mode-line', `vertical-line', or
8393 whatever.
8395 If the sequence starts with a mouse click, we read the key sequence
8396 with respect to the buffer clicked on, not the current buffer.
8398 If the user switches frames in the midst of a key sequence, we put
8399 off the switch-frame event until later; the next call to
8400 read_char will return it.
8402 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8403 from the selected window's buffer. */
8405 static int
8406 read_key_sequence (keybuf, bufsize, prompt, dont_downcase_last,
8407 can_return_switch_frame, fix_current_buffer)
8408 Lisp_Object *keybuf;
8409 int bufsize;
8410 Lisp_Object prompt;
8411 int dont_downcase_last;
8412 int can_return_switch_frame;
8413 int fix_current_buffer;
8415 volatile Lisp_Object from_string;
8416 volatile int count = SPECPDL_INDEX ();
8418 /* How many keys there are in the current key sequence. */
8419 volatile int t;
8421 /* The length of the echo buffer when we started reading, and
8422 the length of this_command_keys when we started reading. */
8423 volatile int echo_start;
8424 volatile int keys_start;
8426 /* The number of keymaps we're scanning right now, and the number of
8427 keymaps we have allocated space for. */
8428 volatile int nmaps;
8429 volatile int nmaps_allocated = 0;
8431 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8432 the current keymaps. */
8433 Lisp_Object *volatile defs = NULL;
8435 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8436 in the current keymaps, or nil where it is not a prefix. */
8437 Lisp_Object *volatile submaps = NULL;
8439 /* The local map to start out with at start of key sequence. */
8440 volatile Lisp_Object orig_local_map;
8442 /* The map from the `keymap' property to start out with at start of
8443 key sequence. */
8444 volatile Lisp_Object orig_keymap;
8446 /* 1 if we have already considered switching to the local-map property
8447 of the place where a mouse click occurred. */
8448 volatile int localized_local_map = 0;
8450 /* The index in defs[] of the first keymap that has a binding for
8451 this key sequence. In other words, the lowest i such that
8452 defs[i] is non-nil. */
8453 volatile int first_binding;
8454 /* Index of the first key that has no binding.
8455 It is useless to try fkey.start larger than that. */
8456 volatile int first_unbound;
8458 /* If t < mock_input, then KEYBUF[t] should be read as the next
8459 input key.
8461 We use this to recover after recognizing a function key. Once we
8462 realize that a suffix of the current key sequence is actually a
8463 function key's escape sequence, we replace the suffix with the
8464 function key's binding from Vfunction_key_map. Now keybuf
8465 contains a new and different key sequence, so the echo area,
8466 this_command_keys, and the submaps and defs arrays are wrong. In
8467 this situation, we set mock_input to t, set t to 0, and jump to
8468 restart_sequence; the loop will read keys from keybuf up until
8469 mock_input, thus rebuilding the state; and then it will resume
8470 reading characters from the keyboard. */
8471 volatile int mock_input = 0;
8473 /* If the sequence is unbound in submaps[], then
8474 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8475 and fkey.map is its binding.
8477 These might be > t, indicating that all function key scanning
8478 should hold off until t reaches them. We do this when we've just
8479 recognized a function key, to avoid searching for the function
8480 key's again in Vfunction_key_map. */
8481 volatile keyremap fkey;
8483 /* Likewise, for key_translation_map. */
8484 volatile keyremap keytran;
8486 /* If we receive a `switch-frame' or `select-window' event in the middle of
8487 a key sequence, we put it off for later.
8488 While we're reading, we keep the event here. */
8489 volatile Lisp_Object delayed_switch_frame;
8491 /* See the comment below... */
8492 #if defined (GOBBLE_FIRST_EVENT)
8493 Lisp_Object first_event;
8494 #endif
8496 volatile Lisp_Object original_uppercase;
8497 volatile int original_uppercase_position = -1;
8499 /* Gets around Microsoft compiler limitations. */
8500 int dummyflag = 0;
8502 struct buffer *starting_buffer;
8504 /* List of events for which a fake prefix key has been generated. */
8505 volatile Lisp_Object fake_prefixed_keys = Qnil;
8507 #if defined (GOBBLE_FIRST_EVENT)
8508 int junk;
8509 #endif
8511 struct gcpro gcpro1;
8513 GCPRO1 (fake_prefixed_keys);
8514 raw_keybuf_count = 0;
8516 last_nonmenu_event = Qnil;
8518 delayed_switch_frame = Qnil;
8519 fkey.map = fkey.parent = Vfunction_key_map;
8520 keytran.map = keytran.parent = Vkey_translation_map;
8521 /* If there is no translation-map, turn off scanning. */
8522 fkey.start = fkey.end = KEYMAPP (fkey.map) ? 0 : bufsize + 1;
8523 keytran.start = keytran.end = KEYMAPP (keytran.map) ? 0 : bufsize + 1;
8525 if (INTERACTIVE)
8527 if (!NILP (prompt))
8528 echo_prompt (prompt);
8529 else if (cursor_in_echo_area
8530 && (FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
8531 && NILP (Fzerop (Vecho_keystrokes)))
8532 /* This doesn't put in a dash if the echo buffer is empty, so
8533 you don't always see a dash hanging out in the minibuffer. */
8534 echo_dash ();
8537 /* Record the initial state of the echo area and this_command_keys;
8538 we will need to restore them if we replay a key sequence. */
8539 if (INTERACTIVE)
8540 echo_start = echo_length ();
8541 keys_start = this_command_key_count;
8542 this_single_command_key_start = keys_start;
8544 #if defined (GOBBLE_FIRST_EVENT)
8545 /* This doesn't quite work, because some of the things that read_char
8546 does cannot safely be bypassed. It seems too risky to try to make
8547 this work right. */
8549 /* Read the first char of the sequence specially, before setting
8550 up any keymaps, in case a filter runs and switches buffers on us. */
8551 first_event = read_char (NILP (prompt), 0, submaps, last_nonmenu_event,
8552 &junk);
8553 #endif /* GOBBLE_FIRST_EVENT */
8555 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8556 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
8557 from_string = Qnil;
8559 /* We jump here when the key sequence has been thoroughly changed, and
8560 we need to rescan it starting from the beginning. When we jump here,
8561 keybuf[0..mock_input] holds the sequence we should reread. */
8562 replay_sequence:
8564 starting_buffer = current_buffer;
8565 first_unbound = bufsize + 1;
8567 /* Build our list of keymaps.
8568 If we recognize a function key and replace its escape sequence in
8569 keybuf with its symbol, or if the sequence starts with a mouse
8570 click and we need to switch buffers, we jump back here to rebuild
8571 the initial keymaps from the current buffer. */
8572 nmaps = 0;
8574 if (!NILP (current_kboard->Voverriding_terminal_local_map)
8575 || !NILP (Voverriding_local_map))
8577 if (3 > nmaps_allocated)
8579 submaps = (Lisp_Object *) alloca (3 * sizeof (submaps[0]));
8580 defs = (Lisp_Object *) alloca (3 * sizeof (defs[0]));
8581 nmaps_allocated = 3;
8583 if (!NILP (current_kboard->Voverriding_terminal_local_map))
8584 submaps[nmaps++] = current_kboard->Voverriding_terminal_local_map;
8585 if (!NILP (Voverriding_local_map))
8586 submaps[nmaps++] = Voverriding_local_map;
8588 else
8590 int nminor;
8591 int total;
8592 Lisp_Object *maps;
8594 nminor = current_minor_maps (0, &maps);
8595 total = nminor + (!NILP (orig_keymap) ? 3 : 2);
8597 if (total > nmaps_allocated)
8599 submaps = (Lisp_Object *) alloca (total * sizeof (submaps[0]));
8600 defs = (Lisp_Object *) alloca (total * sizeof (defs[0]));
8601 nmaps_allocated = total;
8604 if (!NILP (orig_keymap))
8605 submaps[nmaps++] = orig_keymap;
8607 bcopy (maps, (void *) (submaps + nmaps),
8608 nminor * sizeof (submaps[0]));
8610 nmaps += nminor;
8612 submaps[nmaps++] = orig_local_map;
8614 submaps[nmaps++] = current_global_map;
8616 /* Find an accurate initial value for first_binding. */
8617 for (first_binding = 0; first_binding < nmaps; first_binding++)
8618 if (! NILP (submaps[first_binding]))
8619 break;
8621 /* Start from the beginning in keybuf. */
8622 t = 0;
8624 /* These are no-ops the first time through, but if we restart, they
8625 revert the echo area and this_command_keys to their original state. */
8626 this_command_key_count = keys_start;
8627 if (INTERACTIVE && t < mock_input)
8628 echo_truncate (echo_start);
8630 /* If the best binding for the current key sequence is a keymap, or
8631 we may be looking at a function key's escape sequence, keep on
8632 reading. */
8633 while (first_binding < nmaps
8634 /* Keep reading as long as there's a prefix binding. */
8635 ? !NILP (submaps[first_binding])
8636 /* Don't return in the middle of a possible function key sequence,
8637 if the only bindings we found were via case conversion.
8638 Thus, if ESC O a has a function-key-map translation
8639 and ESC o has a binding, don't return after ESC O,
8640 so that we can translate ESC O plus the next character. */
8641 : (fkey.start < t || keytran.start < t))
8643 Lisp_Object key;
8644 int used_mouse_menu = 0;
8646 /* Where the last real key started. If we need to throw away a
8647 key that has expanded into more than one element of keybuf
8648 (say, a mouse click on the mode line which is being treated
8649 as [mode-line (mouse-...)], then we backtrack to this point
8650 of keybuf. */
8651 volatile int last_real_key_start;
8653 /* These variables are analogous to echo_start and keys_start;
8654 while those allow us to restart the entire key sequence,
8655 echo_local_start and keys_local_start allow us to throw away
8656 just one key. */
8657 volatile int echo_local_start, keys_local_start, local_first_binding;
8659 eassert (fkey.end == t || (fkey.end > t && fkey.end <= mock_input));
8660 eassert (fkey.start <= fkey.end);
8661 eassert (keytran.start <= keytran.end);
8662 /* key-translation-map is applied *after* function-key-map. */
8663 eassert (keytran.end <= fkey.start);
8665 if (first_unbound < fkey.start && first_unbound < keytran.start)
8666 { /* The prefix upto first_unbound has no binding and has
8667 no translation left to do either, so we know it's unbound.
8668 If we don't stop now, we risk staying here indefinitely
8669 (if the user keeps entering fkey or keytran prefixes
8670 like C-c ESC ESC ESC ESC ...) */
8671 int i;
8672 for (i = first_unbound + 1; i < t; i++)
8673 keybuf[i - first_unbound - 1] = keybuf[i];
8674 mock_input = t - first_unbound - 1;
8675 fkey.end = fkey.start -= first_unbound + 1;
8676 fkey.map = fkey.parent;
8677 keytran.end = keytran.start -= first_unbound + 1;
8678 keytran.map = keytran.parent;
8679 goto replay_sequence;
8682 if (t >= bufsize)
8683 error ("Key sequence too long");
8685 if (INTERACTIVE)
8686 echo_local_start = echo_length ();
8687 keys_local_start = this_command_key_count;
8688 local_first_binding = first_binding;
8690 replay_key:
8691 /* These are no-ops, unless we throw away a keystroke below and
8692 jumped back up to replay_key; in that case, these restore the
8693 variables to their original state, allowing us to replay the
8694 loop. */
8695 if (INTERACTIVE && t < mock_input)
8696 echo_truncate (echo_local_start);
8697 this_command_key_count = keys_local_start;
8698 first_binding = local_first_binding;
8700 /* By default, assume each event is "real". */
8701 last_real_key_start = t;
8703 /* Does mock_input indicate that we are re-reading a key sequence? */
8704 if (t < mock_input)
8706 key = keybuf[t];
8707 add_command_key (key);
8708 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
8709 && NILP (Fzerop (Vecho_keystrokes)))
8710 echo_char (key);
8713 /* If not, we should actually read a character. */
8714 else
8717 #ifdef MULTI_KBOARD
8718 KBOARD *interrupted_kboard = current_kboard;
8719 struct frame *interrupted_frame = SELECTED_FRAME ();
8720 if (setjmp (wrong_kboard_jmpbuf))
8722 if (!NILP (delayed_switch_frame))
8724 interrupted_kboard->kbd_queue
8725 = Fcons (delayed_switch_frame,
8726 interrupted_kboard->kbd_queue);
8727 delayed_switch_frame = Qnil;
8729 while (t > 0)
8730 interrupted_kboard->kbd_queue
8731 = Fcons (keybuf[--t], interrupted_kboard->kbd_queue);
8733 /* If the side queue is non-empty, ensure it begins with a
8734 switch-frame, so we'll replay it in the right context. */
8735 if (CONSP (interrupted_kboard->kbd_queue)
8736 && (key = XCAR (interrupted_kboard->kbd_queue),
8737 !(EVENT_HAS_PARAMETERS (key)
8738 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)),
8739 Qswitch_frame))))
8741 Lisp_Object frame;
8742 XSETFRAME (frame, interrupted_frame);
8743 interrupted_kboard->kbd_queue
8744 = Fcons (make_lispy_switch_frame (frame),
8745 interrupted_kboard->kbd_queue);
8747 mock_input = 0;
8748 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8749 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
8750 goto replay_sequence;
8752 #endif
8753 key = read_char (NILP (prompt), nmaps,
8754 (Lisp_Object *) submaps, last_nonmenu_event,
8755 &used_mouse_menu);
8758 /* read_char returns t when it shows a menu and the user rejects it.
8759 Just return -1. */
8760 if (EQ (key, Qt))
8762 unbind_to (count, Qnil);
8763 UNGCPRO;
8764 return -1;
8767 /* read_char returns -1 at the end of a macro.
8768 Emacs 18 handles this by returning immediately with a
8769 zero, so that's what we'll do. */
8770 if (INTEGERP (key) && XINT (key) == -1)
8772 t = 0;
8773 /* The Microsoft C compiler can't handle the goto that
8774 would go here. */
8775 dummyflag = 1;
8776 break;
8779 /* If the current buffer has been changed from under us, the
8780 keymap may have changed, so replay the sequence. */
8781 if (BUFFERP (key))
8783 EMACS_TIME initial_idleness_start_time;
8784 EMACS_SET_SECS_USECS (initial_idleness_start_time,
8785 EMACS_SECS (timer_last_idleness_start_time),
8786 EMACS_USECS (timer_last_idleness_start_time));
8788 /* Resume idle state, using the same start-time as before. */
8789 timer_start_idle ();
8790 timer_idleness_start_time = initial_idleness_start_time;
8792 mock_input = t;
8793 /* Reset the current buffer from the selected window
8794 in case something changed the former and not the latter.
8795 This is to be more consistent with the behavior
8796 of the command_loop_1. */
8797 if (fix_current_buffer)
8799 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
8800 Fkill_emacs (Qnil);
8801 if (XBUFFER (XWINDOW (selected_window)->buffer) != current_buffer)
8802 Fset_buffer (XWINDOW (selected_window)->buffer);
8805 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8806 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
8807 goto replay_sequence;
8810 /* If we have a quit that was typed in another frame, and
8811 quit_throw_to_read_char switched buffers,
8812 replay to get the right keymap. */
8813 if (INTEGERP (key)
8814 && XINT (key) == quit_char
8815 && current_buffer != starting_buffer)
8817 GROW_RAW_KEYBUF;
8818 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
8819 keybuf[t++] = key;
8820 mock_input = t;
8821 Vquit_flag = Qnil;
8822 orig_local_map = get_local_map (PT, current_buffer, Qlocal_map);
8823 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
8824 goto replay_sequence;
8827 Vquit_flag = Qnil;
8829 if (EVENT_HAS_PARAMETERS (key)
8830 /* Either a `switch-frame' or a `select-window' event. */
8831 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key)), Qswitch_frame))
8833 /* If we're at the beginning of a key sequence, and the caller
8834 says it's okay, go ahead and return this event. If we're
8835 in the midst of a key sequence, delay it until the end. */
8836 if (t > 0 || !can_return_switch_frame)
8838 delayed_switch_frame = key;
8839 goto replay_key;
8843 GROW_RAW_KEYBUF;
8844 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
8847 /* Clicks in non-text areas get prefixed by the symbol
8848 in their CHAR-ADDRESS field. For example, a click on
8849 the mode line is prefixed by the symbol `mode-line'.
8851 Furthermore, key sequences beginning with mouse clicks
8852 are read using the keymaps of the buffer clicked on, not
8853 the current buffer. So we may have to switch the buffer
8854 here.
8856 When we turn one event into two events, we must make sure
8857 that neither of the two looks like the original--so that,
8858 if we replay the events, they won't be expanded again.
8859 If not for this, such reexpansion could happen either here
8860 or when user programs play with this-command-keys. */
8861 if (EVENT_HAS_PARAMETERS (key))
8863 Lisp_Object kind;
8864 Lisp_Object string;
8866 kind = EVENT_HEAD_KIND (EVENT_HEAD (key));
8867 if (EQ (kind, Qmouse_click))
8869 Lisp_Object window, posn;
8871 window = POSN_WINDOW (EVENT_START (key));
8872 posn = POSN_POSN (EVENT_START (key));
8874 if (CONSP (posn)
8875 || (!NILP (fake_prefixed_keys)
8876 && !NILP (Fmemq (key, fake_prefixed_keys))))
8878 /* We're looking a second time at an event for which
8879 we generated a fake prefix key. Set
8880 last_real_key_start appropriately. */
8881 if (t > 0)
8882 last_real_key_start = t - 1;
8885 /* Key sequences beginning with mouse clicks are
8886 read using the keymaps in the buffer clicked on,
8887 not the current buffer. If we're at the
8888 beginning of a key sequence, switch buffers. */
8889 if (last_real_key_start == 0
8890 && WINDOWP (window)
8891 && BUFFERP (XWINDOW (window)->buffer)
8892 && XBUFFER (XWINDOW (window)->buffer) != current_buffer)
8894 XVECTOR (raw_keybuf)->contents[raw_keybuf_count++] = key;
8895 keybuf[t] = key;
8896 mock_input = t + 1;
8898 /* Arrange to go back to the original buffer once we're
8899 done reading the key sequence. Note that we can't
8900 use save_excursion_{save,restore} here, because they
8901 save point as well as the current buffer; we don't
8902 want to save point, because redisplay may change it,
8903 to accommodate a Fset_window_start or something. We
8904 don't want to do this at the top of the function,
8905 because we may get input from a subprocess which
8906 wants to change the selected window and stuff (say,
8907 emacsclient). */
8908 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
8910 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
8911 Fkill_emacs (Qnil);
8912 set_buffer_internal (XBUFFER (XWINDOW (window)->buffer));
8913 orig_local_map = get_local_map (PT, current_buffer,
8914 Qlocal_map);
8915 orig_keymap = get_local_map (PT, current_buffer, Qkeymap);
8916 goto replay_sequence;
8919 /* For a mouse click, get the local text-property keymap
8920 of the place clicked on, rather than point. */
8921 if (last_real_key_start == 0
8922 && CONSP (XCDR (key))
8923 && ! localized_local_map)
8925 Lisp_Object map_here, start, pos;
8927 localized_local_map = 1;
8928 start = EVENT_START (key);
8930 if (CONSP (start) && POSN_INBUFFER_P (start))
8932 pos = POSN_BUFFER_POSN (start);
8933 if (INTEGERP (pos)
8934 && XINT (pos) >= BEG && XINT (pos) <= Z)
8936 map_here = get_local_map (XINT (pos),
8937 current_buffer, Qlocal_map);
8938 if (!EQ (map_here, orig_local_map))
8940 orig_local_map = map_here;
8941 keybuf[t] = key;
8942 mock_input = t + 1;
8944 goto replay_sequence;
8946 map_here = get_local_map (XINT (pos),
8947 current_buffer, Qkeymap);
8948 if (!EQ (map_here, orig_keymap))
8950 orig_keymap = map_here;
8951 keybuf[t] = key;
8952 mock_input = t + 1;
8954 goto replay_sequence;
8960 /* Expand mode-line and scroll-bar events into two events:
8961 use posn as a fake prefix key. */
8962 if (SYMBOLP (posn)
8963 && (NILP (fake_prefixed_keys)
8964 || NILP (Fmemq (key, fake_prefixed_keys))))
8966 if (t + 1 >= bufsize)
8967 error ("Key sequence too long");
8969 keybuf[t] = posn;
8970 keybuf[t + 1] = key;
8971 mock_input = t + 2;
8973 /* Record that a fake prefix key has been generated
8974 for KEY. Don't modify the event; this would
8975 prevent proper action when the event is pushed
8976 back into unread-command-events. */
8977 fake_prefixed_keys = Fcons (key, fake_prefixed_keys);
8979 /* If on a mode line string with a local keymap,
8980 reconsider the key sequence with that keymap. */
8981 if (string = POSN_STRING (EVENT_START (key)),
8982 (CONSP (string) && STRINGP (XCAR (string))))
8984 Lisp_Object pos, map, map2;
8986 pos = XCDR (string);
8987 string = XCAR (string);
8988 if (XINT (pos) >= 0
8989 && XINT (pos) < SCHARS (string))
8991 map = Fget_text_property (pos, Qlocal_map, string);
8992 if (!NILP (map))
8993 orig_local_map = map;
8994 map2 = Fget_text_property (pos, Qkeymap, string);
8995 if (!NILP (map2))
8996 orig_keymap = map2;
8997 if (!NILP (map) || !NILP (map2))
8998 goto replay_sequence;
9002 goto replay_key;
9004 else if (NILP (from_string)
9005 && (string = POSN_STRING (EVENT_START (key)),
9006 (CONSP (string) && STRINGP (XCAR (string)))))
9008 /* For a click on a string, i.e. overlay string or a
9009 string displayed via the `display' property,
9010 consider `local-map' and `keymap' properties of
9011 that string. */
9012 Lisp_Object pos, map, map2;
9014 pos = XCDR (string);
9015 string = XCAR (string);
9016 if (XINT (pos) >= 0
9017 && XINT (pos) < SCHARS (string))
9019 map = Fget_text_property (pos, Qlocal_map, string);
9020 if (!NILP (map))
9021 orig_local_map = map;
9022 map2 = Fget_text_property (pos, Qkeymap, string);
9023 if (!NILP (map2))
9024 orig_keymap = map2;
9026 if (!NILP (map) || !NILP (map2))
9028 from_string = string;
9029 goto replay_sequence;
9034 else if (CONSP (XCDR (key))
9035 && CONSP (EVENT_START (key))
9036 && CONSP (XCDR (EVENT_START (key))))
9038 Lisp_Object posn;
9040 posn = POSN_POSN (EVENT_START (key));
9041 /* Handle menu-bar events:
9042 insert the dummy prefix event `menu-bar'. */
9043 if (EQ (posn, Qmenu_bar) || EQ (posn, Qtool_bar))
9045 if (t + 1 >= bufsize)
9046 error ("Key sequence too long");
9047 keybuf[t] = posn;
9048 keybuf[t+1] = key;
9050 /* Zap the position in key, so we know that we've
9051 expanded it, and don't try to do so again. */
9052 POSN_SET_POSN (EVENT_START (key),
9053 Fcons (posn, Qnil));
9055 mock_input = t + 2;
9056 goto replay_sequence;
9058 else if (CONSP (posn))
9060 /* We're looking at the second event of a
9061 sequence which we expanded before. Set
9062 last_real_key_start appropriately. */
9063 if (last_real_key_start == t && t > 0)
9064 last_real_key_start = t - 1;
9069 /* We have finally decided that KEY is something we might want
9070 to look up. */
9071 first_binding = (follow_key (key,
9072 nmaps - first_binding,
9073 submaps + first_binding,
9074 defs + first_binding,
9075 submaps + first_binding)
9076 + first_binding);
9078 /* If KEY wasn't bound, we'll try some fallbacks. */
9079 if (first_binding < nmaps)
9080 /* This is needed for the following scenario:
9081 event 0: a down-event that gets dropped by calling replay_key.
9082 event 1: some normal prefix like C-h.
9083 After event 0, first_unbound is 0, after event 1 fkey.start
9084 and keytran.start are both 1, so when we see that C-h is bound,
9085 we need to update first_unbound. */
9086 first_unbound = max (t + 1, first_unbound);
9087 else
9089 Lisp_Object head;
9091 /* Remember the position to put an upper bound on fkey.start. */
9092 first_unbound = min (t, first_unbound);
9094 head = EVENT_HEAD (key);
9095 if (help_char_p (head) && t > 0)
9097 read_key_sequence_cmd = Vprefix_help_command;
9098 keybuf[t++] = key;
9099 last_nonmenu_event = key;
9100 /* The Microsoft C compiler can't handle the goto that
9101 would go here. */
9102 dummyflag = 1;
9103 break;
9106 if (SYMBOLP (head))
9108 Lisp_Object breakdown;
9109 int modifiers;
9111 breakdown = parse_modifiers (head);
9112 modifiers = XINT (XCAR (XCDR (breakdown)));
9113 /* Attempt to reduce an unbound mouse event to a simpler
9114 event that is bound:
9115 Drags reduce to clicks.
9116 Double-clicks reduce to clicks.
9117 Triple-clicks reduce to double-clicks, then to clicks.
9118 Down-clicks are eliminated.
9119 Double-downs reduce to downs, then are eliminated.
9120 Triple-downs reduce to double-downs, then to downs,
9121 then are eliminated. */
9122 if (modifiers & (down_modifier | drag_modifier
9123 | double_modifier | triple_modifier))
9125 while (modifiers & (down_modifier | drag_modifier
9126 | double_modifier | triple_modifier))
9128 Lisp_Object new_head, new_click;
9129 if (modifiers & triple_modifier)
9130 modifiers ^= (double_modifier | triple_modifier);
9131 else if (modifiers & double_modifier)
9132 modifiers &= ~double_modifier;
9133 else if (modifiers & drag_modifier)
9134 modifiers &= ~drag_modifier;
9135 else
9137 /* Dispose of this `down' event by simply jumping
9138 back to replay_key, to get another event.
9140 Note that if this event came from mock input,
9141 then just jumping back to replay_key will just
9142 hand it to us again. So we have to wipe out any
9143 mock input.
9145 We could delete keybuf[t] and shift everything
9146 after that to the left by one spot, but we'd also
9147 have to fix up any variable that points into
9148 keybuf, and shifting isn't really necessary
9149 anyway.
9151 Adding prefixes for non-textual mouse clicks
9152 creates two characters of mock input, and both
9153 must be thrown away. If we're only looking at
9154 the prefix now, we can just jump back to
9155 replay_key. On the other hand, if we've already
9156 processed the prefix, and now the actual click
9157 itself is giving us trouble, then we've lost the
9158 state of the keymaps we want to backtrack to, and
9159 we need to replay the whole sequence to rebuild
9162 Beyond that, only function key expansion could
9163 create more than two keys, but that should never
9164 generate mouse events, so it's okay to zero
9165 mock_input in that case too.
9167 FIXME: The above paragraph seems just plain
9168 wrong, if you consider things like
9169 xterm-mouse-mode. -stef
9171 Isn't this just the most wonderful code ever? */
9173 /* If mock_input > t + 1, the above simplification
9174 will actually end up dropping keys on the floor.
9175 This is probably OK for now, but even
9176 if mock_input <= t + 1, we need to adjust fkey
9177 and keytran.
9178 Typical case [header-line down-mouse-N]:
9179 mock_input = 2, t = 1, fkey.end = 1,
9180 last_real_key_start = 0. */
9181 if (fkey.end > last_real_key_start)
9183 fkey.end = fkey.start
9184 = min (last_real_key_start, fkey.start);
9185 fkey.map = fkey.parent;
9186 if (keytran.end > last_real_key_start)
9188 keytran.end = keytran.start
9189 = min (last_real_key_start, keytran.start);
9190 keytran.map = keytran.parent;
9193 if (t == last_real_key_start)
9195 mock_input = 0;
9196 goto replay_key;
9198 else
9200 mock_input = last_real_key_start;
9201 goto replay_sequence;
9205 new_head
9206 = apply_modifiers (modifiers, XCAR (breakdown));
9207 new_click
9208 = Fcons (new_head, Fcons (EVENT_START (key), Qnil));
9210 /* Look for a binding for this new key. follow_key
9211 promises that it didn't munge submaps the
9212 last time we called it, since key was unbound. */
9213 first_binding
9214 = (follow_key (new_click,
9215 nmaps - local_first_binding,
9216 submaps + local_first_binding,
9217 defs + local_first_binding,
9218 submaps + local_first_binding)
9219 + local_first_binding);
9221 /* If that click is bound, go for it. */
9222 if (first_binding < nmaps)
9224 key = new_click;
9225 break;
9227 /* Otherwise, we'll leave key set to the drag event. */
9233 keybuf[t++] = key;
9234 /* Normally, last_nonmenu_event gets the previous key we read.
9235 But when a mouse popup menu is being used,
9236 we don't update last_nonmenu_event; it continues to hold the mouse
9237 event that preceded the first level of menu. */
9238 if (!used_mouse_menu)
9239 last_nonmenu_event = key;
9241 /* Record what part of this_command_keys is the current key sequence. */
9242 this_single_command_key_start = this_command_key_count - t;
9244 if (first_binding < nmaps && NILP (submaps[first_binding]))
9245 /* There is a binding and it's not a prefix.
9246 There is thus no function-key in this sequence.
9247 Moving fkey.start is important in this case to allow keytran.start
9248 to go over the sequence before we return (since we keep the
9249 invariant that keytran.end <= fkey.start). */
9251 if (fkey.start < t)
9252 (fkey.start = fkey.end = t, fkey.map = fkey.parent);
9254 else
9255 /* If the sequence is unbound, see if we can hang a function key
9256 off the end of it. */
9257 /* Continue scan from fkey.end until we find a bound suffix. */
9258 while (fkey.end < t)
9260 struct gcpro gcpro1, gcpro2, gcpro3;
9261 int done, diff;
9263 GCPRO3 (fkey.map, keytran.map, delayed_switch_frame);
9264 done = keyremap_step (keybuf, bufsize, &fkey,
9265 max (t, mock_input),
9266 /* If there's a binding (i.e.
9267 first_binding >= nmaps) we don't want
9268 to apply this function-key-mapping. */
9269 fkey.end + 1 == t && first_binding >= nmaps,
9270 &diff, prompt);
9271 UNGCPRO;
9272 if (done)
9274 mock_input = diff + max (t, mock_input);
9275 goto replay_sequence;
9279 /* Look for this sequence in key-translation-map.
9280 Scan from keytran.end until we find a bound suffix. */
9281 while (keytran.end < fkey.start)
9283 struct gcpro gcpro1, gcpro2, gcpro3;
9284 int done, diff;
9286 GCPRO3 (fkey.map, keytran.map, delayed_switch_frame);
9287 done = keyremap_step (keybuf, bufsize, &keytran, max (t, mock_input),
9288 1, &diff, prompt);
9289 UNGCPRO;
9290 if (done)
9292 mock_input = diff + max (t, mock_input);
9293 /* Adjust the function-key-map counters. */
9294 fkey.end += diff;
9295 fkey.start += diff;
9297 goto replay_sequence;
9301 /* If KEY is not defined in any of the keymaps,
9302 and cannot be part of a function key or translation,
9303 and is an upper case letter
9304 use the corresponding lower-case letter instead. */
9305 if (first_binding >= nmaps
9306 && fkey.start >= t && keytran.start >= t
9307 && INTEGERP (key)
9308 && ((((XINT (key) & 0x3ffff)
9309 < XCHAR_TABLE (current_buffer->downcase_table)->size)
9310 && UPPERCASEP (XINT (key) & 0x3ffff))
9311 || (XINT (key) & shift_modifier)))
9313 Lisp_Object new_key;
9315 original_uppercase = key;
9316 original_uppercase_position = t - 1;
9318 if (XINT (key) & shift_modifier)
9319 XSETINT (new_key, XINT (key) & ~shift_modifier);
9320 else
9321 XSETINT (new_key, (DOWNCASE (XINT (key) & 0x3ffff)
9322 | (XINT (key) & ~0x3ffff)));
9324 /* We have to do this unconditionally, regardless of whether
9325 the lower-case char is defined in the keymaps, because they
9326 might get translated through function-key-map. */
9327 keybuf[t - 1] = new_key;
9328 mock_input = max (t, mock_input);
9330 goto replay_sequence;
9332 /* If KEY is not defined in any of the keymaps,
9333 and cannot be part of a function key or translation,
9334 and is a shifted function key,
9335 use the corresponding unshifted function key instead. */
9336 if (first_binding >= nmaps
9337 && fkey.start >= t && keytran.start >= t
9338 && SYMBOLP (key))
9340 Lisp_Object breakdown;
9341 int modifiers;
9343 breakdown = parse_modifiers (key);
9344 modifiers = XINT (XCAR (XCDR (breakdown)));
9345 if (modifiers & shift_modifier)
9347 Lisp_Object new_key;
9349 original_uppercase = key;
9350 original_uppercase_position = t - 1;
9352 modifiers &= ~shift_modifier;
9353 new_key = apply_modifiers (modifiers,
9354 XCAR (breakdown));
9356 keybuf[t - 1] = new_key;
9357 mock_input = max (t, mock_input);
9358 fkey.start = fkey.end = KEYMAPP (fkey.map) ? 0 : bufsize + 1;
9359 keytran.start = keytran.end = KEYMAPP (keytran.map) ? 0 : bufsize + 1;
9361 goto replay_sequence;
9366 if (!dummyflag)
9367 read_key_sequence_cmd = (first_binding < nmaps
9368 ? defs[first_binding]
9369 : Qnil);
9371 unread_switch_frame = delayed_switch_frame;
9372 unbind_to (count, Qnil);
9374 /* Don't downcase the last character if the caller says don't.
9375 Don't downcase it if the result is undefined, either. */
9376 if ((dont_downcase_last || first_binding >= nmaps)
9377 && t - 1 == original_uppercase_position)
9378 keybuf[t - 1] = original_uppercase;
9380 /* Occasionally we fabricate events, perhaps by expanding something
9381 according to function-key-map, or by adding a prefix symbol to a
9382 mouse click in the scroll bar or modeline. In this cases, return
9383 the entire generated key sequence, even if we hit an unbound
9384 prefix or a definition before the end. This means that you will
9385 be able to push back the event properly, and also means that
9386 read-key-sequence will always return a logical unit.
9388 Better ideas? */
9389 for (; t < mock_input; t++)
9391 if ((FLOATP (Vecho_keystrokes) || INTEGERP (Vecho_keystrokes))
9392 && NILP (Fzerop (Vecho_keystrokes)))
9393 echo_char (keybuf[t]);
9394 add_command_key (keybuf[t]);
9399 UNGCPRO;
9400 return t;
9403 DEFUN ("read-key-sequence", Fread_key_sequence, Sread_key_sequence, 1, 5, 0,
9404 doc: /* Read a sequence of keystrokes and return as a string or vector.
9405 The sequence is sufficient to specify a non-prefix command in the
9406 current local and global maps.
9408 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9409 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9410 as a continuation of the previous key.
9412 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9413 convert the last event to lower case. (Normally any upper case event
9414 is converted to lower case if the original event is undefined and the lower
9415 case equivalent is defined.) A non-nil value is appropriate for reading
9416 a key sequence to be defined.
9418 A C-g typed while in this function is treated like any other character,
9419 and `quit-flag' is not set.
9421 If the key sequence starts with a mouse click, then the sequence is read
9422 using the keymaps of the buffer of the window clicked in, not the buffer
9423 of the selected window as normal.
9425 `read-key-sequence' drops unbound button-down events, since you normally
9426 only care about the click or drag events which follow them. If a drag
9427 or multi-click event is unbound, but the corresponding click event would
9428 be bound, `read-key-sequence' turns the event into a click event at the
9429 drag's starting position. This means that you don't have to distinguish
9430 between click and drag, double, or triple events unless you want to.
9432 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9433 lines separating windows, and scroll bars with imaginary keys
9434 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9436 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9437 function will process a switch-frame event if the user switches frames
9438 before typing anything. If the user switches frames in the middle of a
9439 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9440 is nil, then the event will be put off until after the current key sequence.
9442 `read-key-sequence' checks `function-key-map' for function key
9443 sequences, where they wouldn't conflict with ordinary bindings. See
9444 `function-key-map' for more details.
9446 The optional fifth argument COMMAND-LOOP, if non-nil, means
9447 that this key sequence is being read by something that will
9448 read commands one after another. It should be nil if the caller
9449 will read just one key sequence. */)
9450 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
9451 command_loop)
9452 Lisp_Object prompt, continue_echo, dont_downcase_last;
9453 Lisp_Object can_return_switch_frame, command_loop;
9455 Lisp_Object keybuf[30];
9456 register int i;
9457 struct gcpro gcpro1;
9458 int count = SPECPDL_INDEX ();
9460 if (!NILP (prompt))
9461 CHECK_STRING (prompt);
9462 QUIT;
9464 specbind (Qinput_method_exit_on_first_char,
9465 (NILP (command_loop) ? Qt : Qnil));
9466 specbind (Qinput_method_use_echo_area,
9467 (NILP (command_loop) ? Qt : Qnil));
9469 bzero (keybuf, sizeof keybuf);
9470 GCPRO1 (keybuf[0]);
9471 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
9473 if (NILP (continue_echo))
9475 this_command_key_count = 0;
9476 this_command_key_count_reset = 0;
9477 this_single_command_key_start = 0;
9480 #ifdef HAVE_X_WINDOWS
9481 if (display_hourglass_p)
9482 cancel_hourglass ();
9483 #endif
9485 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
9486 prompt, ! NILP (dont_downcase_last),
9487 ! NILP (can_return_switch_frame), 0);
9489 #if 0 /* The following is fine for code reading a key sequence and
9490 then proceeding with a lenghty computation, but it's not good
9491 for code reading keys in a loop, like an input method. */
9492 #ifdef HAVE_X_WINDOWS
9493 if (display_hourglass_p)
9494 start_hourglass ();
9495 #endif
9496 #endif
9498 if (i == -1)
9500 Vquit_flag = Qt;
9501 QUIT;
9503 UNGCPRO;
9504 return unbind_to (count, make_event_array (i, keybuf));
9507 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector,
9508 Sread_key_sequence_vector, 1, 5, 0,
9509 doc: /* Like `read-key-sequence' but always return a vector. */)
9510 (prompt, continue_echo, dont_downcase_last, can_return_switch_frame,
9511 command_loop)
9512 Lisp_Object prompt, continue_echo, dont_downcase_last;
9513 Lisp_Object can_return_switch_frame, command_loop;
9515 Lisp_Object keybuf[30];
9516 register int i;
9517 struct gcpro gcpro1;
9518 int count = SPECPDL_INDEX ();
9520 if (!NILP (prompt))
9521 CHECK_STRING (prompt);
9522 QUIT;
9524 specbind (Qinput_method_exit_on_first_char,
9525 (NILP (command_loop) ? Qt : Qnil));
9526 specbind (Qinput_method_use_echo_area,
9527 (NILP (command_loop) ? Qt : Qnil));
9529 bzero (keybuf, sizeof keybuf);
9530 GCPRO1 (keybuf[0]);
9531 gcpro1.nvars = (sizeof keybuf/sizeof (keybuf[0]));
9533 if (NILP (continue_echo))
9535 this_command_key_count = 0;
9536 this_command_key_count_reset = 0;
9537 this_single_command_key_start = 0;
9540 #ifdef HAVE_X_WINDOWS
9541 if (display_hourglass_p)
9542 cancel_hourglass ();
9543 #endif
9545 i = read_key_sequence (keybuf, (sizeof keybuf/sizeof (keybuf[0])),
9546 prompt, ! NILP (dont_downcase_last),
9547 ! NILP (can_return_switch_frame), 0);
9549 #ifdef HAVE_X_WINDOWS
9550 if (display_hourglass_p)
9551 start_hourglass ();
9552 #endif
9554 if (i == -1)
9556 Vquit_flag = Qt;
9557 QUIT;
9559 UNGCPRO;
9560 return unbind_to (count, Fvector (i, keybuf));
9563 DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0,
9564 doc: /* Execute CMD as an editor command.
9565 CMD must be a symbol that satisfies the `commandp' predicate.
9566 Optional second arg RECORD-FLAG non-nil
9567 means unconditionally put this command in `command-history'.
9568 Otherwise, that is done only if an arg is read using the minibuffer.
9569 The argument KEYS specifies the value to use instead of (this-command-keys)
9570 when reading the arguments; if it is nil, (this-command-keys) is used.
9571 The argument SPECIAL, if non-nil, means that this command is executing
9572 a special event, so ignore the prefix argument and don't clear it. */)
9573 (cmd, record_flag, keys, special)
9574 Lisp_Object cmd, record_flag, keys, special;
9576 register Lisp_Object final;
9577 register Lisp_Object tem;
9578 Lisp_Object prefixarg;
9579 struct backtrace backtrace;
9580 extern int debug_on_next_call;
9582 debug_on_next_call = 0;
9584 if (NILP (special))
9586 prefixarg = current_kboard->Vprefix_arg;
9587 Vcurrent_prefix_arg = prefixarg;
9588 current_kboard->Vprefix_arg = Qnil;
9590 else
9591 prefixarg = Qnil;
9593 if (SYMBOLP (cmd))
9595 tem = Fget (cmd, Qdisabled);
9596 if (!NILP (tem) && !NILP (Vrun_hooks))
9598 tem = Fsymbol_value (Qdisabled_command_hook);
9599 if (!NILP (tem))
9600 return call1 (Vrun_hooks, Qdisabled_command_hook);
9604 while (1)
9606 final = Findirect_function (cmd);
9608 if (CONSP (final) && (tem = Fcar (final), EQ (tem, Qautoload)))
9610 struct gcpro gcpro1, gcpro2;
9612 GCPRO2 (cmd, prefixarg);
9613 do_autoload (final, cmd);
9614 UNGCPRO;
9616 else
9617 break;
9620 if (STRINGP (final) || VECTORP (final))
9622 /* If requested, place the macro in the command history. For
9623 other sorts of commands, call-interactively takes care of
9624 this. */
9625 if (!NILP (record_flag))
9627 Vcommand_history
9628 = Fcons (Fcons (Qexecute_kbd_macro,
9629 Fcons (final, Fcons (prefixarg, Qnil))),
9630 Vcommand_history);
9632 /* Don't keep command history around forever. */
9633 if (NUMBERP (Vhistory_length) && XINT (Vhistory_length) > 0)
9635 tem = Fnthcdr (Vhistory_length, Vcommand_history);
9636 if (CONSP (tem))
9637 XSETCDR (tem, Qnil);
9641 return Fexecute_kbd_macro (final, prefixarg, Qnil);
9644 if (CONSP (final) || SUBRP (final) || COMPILEDP (final))
9646 backtrace.next = backtrace_list;
9647 backtrace_list = &backtrace;
9648 backtrace.function = &Qcall_interactively;
9649 backtrace.args = &cmd;
9650 backtrace.nargs = 1;
9651 backtrace.evalargs = 0;
9653 tem = Fcall_interactively (cmd, record_flag, keys);
9655 backtrace_list = backtrace.next;
9656 return tem;
9658 return Qnil;
9663 DEFUN ("execute-extended-command", Fexecute_extended_command, Sexecute_extended_command,
9664 1, 1, "P",
9665 doc: /* Read function name, then read its arguments and call it. */)
9666 (prefixarg)
9667 Lisp_Object prefixarg;
9669 Lisp_Object function;
9670 char buf[40];
9671 int saved_last_point_position;
9672 Lisp_Object saved_keys, saved_last_point_position_buffer;
9673 Lisp_Object bindings, value;
9674 struct gcpro gcpro1, gcpro2, gcpro3;
9676 saved_keys = Fvector (this_command_key_count,
9677 XVECTOR (this_command_keys)->contents);
9678 saved_last_point_position_buffer = last_point_position_buffer;
9679 saved_last_point_position = last_point_position;
9680 buf[0] = 0;
9681 GCPRO3 (saved_keys, prefixarg, saved_last_point_position_buffer);
9683 if (EQ (prefixarg, Qminus))
9684 strcpy (buf, "- ");
9685 else if (CONSP (prefixarg) && XINT (XCAR (prefixarg)) == 4)
9686 strcpy (buf, "C-u ");
9687 else if (CONSP (prefixarg) && INTEGERP (XCAR (prefixarg)))
9689 if (sizeof (int) == sizeof (EMACS_INT))
9690 sprintf (buf, "%d ", XINT (XCAR (prefixarg)));
9691 else if (sizeof (long) == sizeof (EMACS_INT))
9692 sprintf (buf, "%ld ", (long) XINT (XCAR (prefixarg)));
9693 else
9694 abort ();
9696 else if (INTEGERP (prefixarg))
9698 if (sizeof (int) == sizeof (EMACS_INT))
9699 sprintf (buf, "%d ", XINT (prefixarg));
9700 else if (sizeof (long) == sizeof (EMACS_INT))
9701 sprintf (buf, "%ld ", (long) XINT (prefixarg));
9702 else
9703 abort ();
9706 /* This isn't strictly correct if execute-extended-command
9707 is bound to anything else. Perhaps it should use
9708 this_command_keys? */
9709 strcat (buf, "M-x ");
9711 /* Prompt with buf, and then read a string, completing from and
9712 restricting to the set of all defined commands. Don't provide
9713 any initial input. Save the command read on the extended-command
9714 history list. */
9715 function = Fcompleting_read (build_string (buf),
9716 Vobarray, Qcommandp,
9717 Qt, Qnil, Qextended_command_history, Qnil,
9718 Qnil);
9720 if (STRINGP (function) && SCHARS (function) == 0)
9721 error ("No command name given");
9723 /* Set this_command_keys to the concatenation of saved_keys and
9724 function, followed by a RET. */
9726 Lisp_Object *keys;
9727 int i;
9729 this_command_key_count = 0;
9730 this_command_key_count_reset = 0;
9731 this_single_command_key_start = 0;
9733 keys = XVECTOR (saved_keys)->contents;
9734 for (i = 0; i < XVECTOR (saved_keys)->size; i++)
9735 add_command_key (keys[i]);
9737 for (i = 0; i < SCHARS (function); i++)
9738 add_command_key (Faref (function, make_number (i)));
9740 add_command_key (make_number ('\015'));
9743 last_point_position = saved_last_point_position;
9744 last_point_position_buffer = saved_last_point_position_buffer;
9746 UNGCPRO;
9748 function = Fintern (function, Qnil);
9749 current_kboard->Vprefix_arg = prefixarg;
9750 Vthis_command = function;
9751 real_this_command = function;
9753 /* If enabled, show which key runs this command. */
9754 if (!NILP (Vsuggest_key_bindings)
9755 && NILP (Vexecuting_macro)
9756 && SYMBOLP (function))
9757 bindings = Fwhere_is_internal (function, Voverriding_local_map,
9758 Qt, Qnil, Qnil);
9759 else
9760 bindings = Qnil;
9762 value = Qnil;
9763 GCPRO2 (bindings, value);
9764 value = Fcommand_execute (function, Qt, Qnil, Qnil);
9766 /* If the command has a key binding, print it now. */
9767 if (!NILP (bindings)
9768 && ! (VECTORP (bindings) && EQ (Faref (bindings, make_number (0)),
9769 Qmouse_movement)))
9771 /* But first wait, and skip the message if there is input. */
9772 int delay_time;
9773 if (!NILP (echo_area_buffer[0]))
9774 /* This command displayed something in the echo area;
9775 so wait a few seconds, then display our suggestion message. */
9776 delay_time = (NUMBERP (Vsuggest_key_bindings)
9777 ? XINT (Vsuggest_key_bindings) : 2);
9778 else
9779 /* This command left the echo area empty,
9780 so display our message immediately. */
9781 delay_time = 0;
9783 if (!NILP (Fsit_for (make_number (delay_time), Qnil, Qnil))
9784 && ! CONSP (Vunread_command_events))
9786 Lisp_Object binding;
9787 char *newmessage;
9788 int message_p = push_message ();
9789 int count = SPECPDL_INDEX ();
9791 record_unwind_protect (pop_message_unwind, Qnil);
9792 binding = Fkey_description (bindings);
9794 newmessage
9795 = (char *) alloca (SCHARS (SYMBOL_NAME (function))
9796 + SBYTES (binding)
9797 + 100);
9798 sprintf (newmessage, "You can run the command `%s' with %s",
9799 SDATA (SYMBOL_NAME (function)),
9800 SDATA (binding));
9801 message2_nolog (newmessage,
9802 strlen (newmessage),
9803 STRING_MULTIBYTE (binding));
9804 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings)
9805 ? Vsuggest_key_bindings : make_number (2)),
9806 Qnil, Qnil))
9807 && message_p)
9808 restore_message ();
9810 unbind_to (count, Qnil);
9814 RETURN_UNGCPRO (value);
9818 /* Return nonzero if input events are pending. */
9821 detect_input_pending ()
9823 if (!input_pending)
9824 get_input_pending (&input_pending, 0);
9826 return input_pending;
9829 /* Return nonzero if input events are pending, and run any pending timers. */
9832 detect_input_pending_run_timers (do_display)
9833 int do_display;
9835 int old_timers_run = timers_run;
9837 if (!input_pending)
9838 get_input_pending (&input_pending, 1);
9840 if (old_timers_run != timers_run && do_display)
9842 redisplay_preserve_echo_area (8);
9843 /* The following fixes a bug when using lazy-lock with
9844 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9845 from an idle timer function. The symptom of the bug is that
9846 the cursor sometimes doesn't become visible until the next X
9847 event is processed. --gerd. */
9848 if (rif)
9849 rif->flush_display (NULL);
9852 return input_pending;
9855 /* This is called in some cases before a possible quit.
9856 It cases the next call to detect_input_pending to recompute input_pending.
9857 So calling this function unnecessarily can't do any harm. */
9859 void
9860 clear_input_pending ()
9862 input_pending = 0;
9865 /* Return nonzero if there are pending requeued events.
9866 This isn't used yet. The hope is to make wait_reading_process_input
9867 call it, and return if it runs Lisp code that unreads something.
9868 The problem is, kbd_buffer_get_event needs to be fixed to know what
9869 to do in that case. It isn't trivial. */
9872 requeued_events_pending_p ()
9874 return (!NILP (Vunread_command_events) || unread_command_char != -1);
9878 DEFUN ("input-pending-p", Finput_pending_p, Sinput_pending_p, 0, 0, 0,
9879 doc: /* Return t if command input is currently available with no wait.
9880 Actually, the value is nil only if we can be sure that no input is available;
9881 if there is a doubt, the value is t. */)
9884 if (!NILP (Vunread_command_events) || unread_command_char != -1)
9885 return (Qt);
9887 get_filtered_input_pending (&input_pending, 1, 1);
9888 return input_pending > 0 ? Qt : Qnil;
9891 DEFUN ("recent-keys", Frecent_keys, Srecent_keys, 0, 0, 0,
9892 doc: /* Return vector of last 100 events, not counting those from keyboard macros. */)
9895 Lisp_Object *keys = XVECTOR (recent_keys)->contents;
9896 Lisp_Object val;
9898 if (total_keys < NUM_RECENT_KEYS)
9899 return Fvector (total_keys, keys);
9900 else
9902 val = Fvector (NUM_RECENT_KEYS, keys);
9903 bcopy (keys + recent_keys_index,
9904 XVECTOR (val)->contents,
9905 (NUM_RECENT_KEYS - recent_keys_index) * sizeof (Lisp_Object));
9906 bcopy (keys,
9907 XVECTOR (val)->contents + NUM_RECENT_KEYS - recent_keys_index,
9908 recent_keys_index * sizeof (Lisp_Object));
9909 return val;
9913 DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
9914 doc: /* Return the key sequence that invoked this command.
9915 However, if the command has called `read-key-sequence', it returns
9916 the last key sequence that has been read.
9917 The value is a string or a vector. */)
9920 return make_event_array (this_command_key_count,
9921 XVECTOR (this_command_keys)->contents);
9924 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0,
9925 doc: /* Return the key sequence that invoked this command, as a vector.
9926 However, if the command has called `read-key-sequence', it returns
9927 the last key sequence that has been read. */)
9930 return Fvector (this_command_key_count,
9931 XVECTOR (this_command_keys)->contents);
9934 DEFUN ("this-single-command-keys", Fthis_single_command_keys,
9935 Sthis_single_command_keys, 0, 0, 0,
9936 doc: /* Return the key sequence that invoked this command.
9937 More generally, it returns the last key sequence read, either by
9938 the command loop or by `read-key-sequence'.
9939 Unlike `this-command-keys', this function's value
9940 does not include prefix arguments.
9941 The value is always a vector. */)
9944 return Fvector (this_command_key_count
9945 - this_single_command_key_start,
9946 (XVECTOR (this_command_keys)->contents
9947 + this_single_command_key_start));
9950 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys,
9951 Sthis_single_command_raw_keys, 0, 0, 0,
9952 doc: /* Return the raw events that were read for this command.
9953 More generally, it returns the last key sequence read, either by
9954 the command loop or by `read-key-sequence'.
9955 Unlike `this-single-command-keys', this function's value
9956 shows the events before all translations (except for input methods).
9957 The value is always a vector. */)
9960 return Fvector (raw_keybuf_count,
9961 (XVECTOR (raw_keybuf)->contents));
9964 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths,
9965 Sreset_this_command_lengths, 0, 0, 0,
9966 doc: /* Make the unread events replace the last command and echo.
9967 Used in `universal-argument-other-key'.
9969 `universal-argument-other-key' rereads the event just typed.
9970 It then gets translated through `function-key-map'.
9971 The translated event has to replace the real events,
9972 both in the value of (this-command-keys) and in echoing.
9973 To achieve this, `universal-argument-other-key' calls
9974 `reset-this-command-lengths', which discards the record of reading
9975 these events the first time. */)
9978 this_command_key_count = before_command_key_count;
9979 if (this_command_key_count < this_single_command_key_start)
9980 this_single_command_key_start = this_command_key_count;
9982 echo_truncate (before_command_echo_length);
9984 /* Cause whatever we put into unread-command-events
9985 to echo as if it were being freshly read from the keyboard. */
9986 this_command_key_count_reset = 1;
9988 return Qnil;
9991 DEFUN ("clear-this-command-keys", Fclear_this_command_keys,
9992 Sclear_this_command_keys, 0, 1, 0,
9993 doc: /* Clear out the vector that `this-command-keys' returns.
9994 Also clear the record of the last 100 events, unless optional arg
9995 KEEP-RECORD is non-nil. */)
9996 (keep_record)
9997 Lisp_Object keep_record;
9999 int i;
10001 this_command_key_count = 0;
10002 this_command_key_count_reset = 0;
10004 if (NILP (keep_record))
10006 for (i = 0; i < XVECTOR (recent_keys)->size; ++i)
10007 XVECTOR (recent_keys)->contents[i] = Qnil;
10008 total_keys = 0;
10009 recent_keys_index = 0;
10011 return Qnil;
10014 DEFUN ("recursion-depth", Frecursion_depth, Srecursion_depth, 0, 0, 0,
10015 doc: /* Return the current depth in recursive edits. */)
10018 Lisp_Object temp;
10019 XSETFASTINT (temp, command_loop_level + minibuf_level);
10020 return temp;
10023 DEFUN ("open-dribble-file", Fopen_dribble_file, Sopen_dribble_file, 1, 1,
10024 "FOpen dribble file: ",
10025 doc: /* Start writing all keyboard characters to a dribble file called FILE.
10026 If FILE is nil, close any open dribble file. */)
10027 (file)
10028 Lisp_Object file;
10030 if (dribble)
10032 fclose (dribble);
10033 dribble = 0;
10035 if (!NILP (file))
10037 file = Fexpand_file_name (file, Qnil);
10038 dribble = fopen (SDATA (file), "w");
10039 if (dribble == 0)
10040 report_file_error ("Opening dribble", Fcons (file, Qnil));
10042 return Qnil;
10045 DEFUN ("discard-input", Fdiscard_input, Sdiscard_input, 0, 0, 0,
10046 doc: /* Discard the contents of the terminal input buffer.
10047 Also end any kbd macro being defined. */)
10050 if (!NILP (current_kboard->defining_kbd_macro))
10052 /* Discard the last command from the macro. */
10053 Fcancel_kbd_macro_events ();
10054 end_kbd_macro ();
10057 update_mode_lines++;
10059 Vunread_command_events = Qnil;
10060 unread_command_char = -1;
10062 discard_tty_input ();
10064 kbd_fetch_ptr = kbd_store_ptr;
10065 input_pending = 0;
10067 return Qnil;
10070 DEFUN ("suspend-emacs", Fsuspend_emacs, Ssuspend_emacs, 0, 1, "",
10071 doc: /* Stop Emacs and return to superior process. You can resume later.
10072 If `cannot-suspend' is non-nil, or if the system doesn't support job
10073 control, run a subshell instead.
10075 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10076 to be read as terminal input by Emacs's parent, after suspension.
10078 Before suspending, run the normal hook `suspend-hook'.
10079 After resumption run the normal hook `suspend-resume-hook'.
10081 Some operating systems cannot stop the Emacs process and resume it later.
10082 On such systems, Emacs starts a subshell instead of suspending. */)
10083 (stuffstring)
10084 Lisp_Object stuffstring;
10086 int count = SPECPDL_INDEX ();
10087 int old_height, old_width;
10088 int width, height;
10089 struct gcpro gcpro1;
10091 if (!NILP (stuffstring))
10092 CHECK_STRING (stuffstring);
10094 /* Run the functions in suspend-hook. */
10095 if (!NILP (Vrun_hooks))
10096 call1 (Vrun_hooks, intern ("suspend-hook"));
10098 GCPRO1 (stuffstring);
10099 get_frame_size (&old_width, &old_height);
10100 reset_sys_modes ();
10101 /* sys_suspend can get an error if it tries to fork a subshell
10102 and the system resources aren't available for that. */
10103 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object))) init_sys_modes,
10104 Qnil);
10105 stuff_buffered_input (stuffstring);
10106 if (cannot_suspend)
10107 sys_subshell ();
10108 else
10109 sys_suspend ();
10110 unbind_to (count, Qnil);
10112 /* Check if terminal/window size has changed.
10113 Note that this is not useful when we are running directly
10114 with a window system; but suspend should be disabled in that case. */
10115 get_frame_size (&width, &height);
10116 if (width != old_width || height != old_height)
10117 change_frame_size (SELECTED_FRAME (), height, width, 0, 0, 0);
10119 /* Run suspend-resume-hook. */
10120 if (!NILP (Vrun_hooks))
10121 call1 (Vrun_hooks, intern ("suspend-resume-hook"));
10123 UNGCPRO;
10124 return Qnil;
10127 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10128 Then in any case stuff anything Emacs has read ahead and not used. */
10130 void
10131 stuff_buffered_input (stuffstring)
10132 Lisp_Object stuffstring;
10134 /* stuff_char works only in BSD, versions 4.2 and up. */
10135 #ifdef BSD_SYSTEM
10136 #ifndef BSD4_1
10137 register unsigned char *p;
10139 if (STRINGP (stuffstring))
10141 register int count;
10143 p = SDATA (stuffstring);
10144 count = SBYTES (stuffstring);
10145 while (count-- > 0)
10146 stuff_char (*p++);
10147 stuff_char ('\n');
10150 /* Anything we have read ahead, put back for the shell to read. */
10151 /* ?? What should this do when we have multiple keyboards??
10152 Should we ignore anything that was typed in at the "wrong" kboard? */
10153 for (; kbd_fetch_ptr != kbd_store_ptr; kbd_fetch_ptr++)
10156 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
10157 kbd_fetch_ptr = kbd_buffer;
10158 if (kbd_fetch_ptr->kind == ASCII_KEYSTROKE_EVENT)
10159 stuff_char (kbd_fetch_ptr->code);
10161 clear_event (kbd_fetch_ptr);
10164 input_pending = 0;
10165 #endif
10166 #endif /* BSD_SYSTEM and not BSD4_1 */
10169 void
10170 set_waiting_for_input (time_to_clear)
10171 EMACS_TIME *time_to_clear;
10173 input_available_clear_time = time_to_clear;
10175 /* Tell interrupt_signal to throw back to read_char, */
10176 waiting_for_input = 1;
10178 /* If interrupt_signal was called before and buffered a C-g,
10179 make it run again now, to avoid timing error. */
10180 if (!NILP (Vquit_flag))
10181 quit_throw_to_read_char ();
10184 void
10185 clear_waiting_for_input ()
10187 /* Tell interrupt_signal not to throw back to read_char, */
10188 waiting_for_input = 0;
10189 input_available_clear_time = 0;
10192 /* This routine is called at interrupt level in response to C-g.
10194 If interrupt_input, this is the handler for SIGINT. Otherwise, it
10195 is called from kbd_buffer_store_event, in handling SIGIO or
10196 SIGTINT.
10198 If `waiting_for_input' is non zero, then unless `echoing' is
10199 nonzero, immediately throw back to read_char.
10201 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10202 eval to throw, when it gets a chance. If quit-flag is already
10203 non-nil, it stops the job right away. */
10205 static SIGTYPE
10206 interrupt_signal (signalnum) /* If we don't have an argument, */
10207 int signalnum; /* some compilers complain in signal calls. */
10209 char c;
10210 /* Must preserve main program's value of errno. */
10211 int old_errno = errno;
10212 struct frame *sf = SELECTED_FRAME ();
10214 #if defined (USG) && !defined (POSIX_SIGNALS)
10215 if (!read_socket_hook && NILP (Vwindow_system))
10217 /* USG systems forget handlers when they are used;
10218 must reestablish each time */
10219 signal (SIGINT, interrupt_signal);
10220 signal (SIGQUIT, interrupt_signal);
10222 #endif /* USG */
10224 cancel_echoing ();
10226 if (!NILP (Vquit_flag)
10227 && (FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf)))
10229 /* If SIGINT isn't blocked, don't let us be interrupted by
10230 another SIGINT, it might be harmful due to non-reentrancy
10231 in I/O functions. */
10232 sigblock (sigmask (SIGINT));
10234 fflush (stdout);
10235 reset_sys_modes ();
10237 #ifdef SIGTSTP /* Support possible in later USG versions */
10239 * On systems which can suspend the current process and return to the original
10240 * shell, this command causes the user to end up back at the shell.
10241 * The "Auto-save" and "Abort" questions are not asked until
10242 * the user elects to return to emacs, at which point he can save the current
10243 * job and either dump core or continue.
10245 sys_suspend ();
10246 #else
10247 #ifdef VMS
10248 if (sys_suspend () == -1)
10250 printf ("Not running as a subprocess;\n");
10251 printf ("you can continue or abort.\n");
10253 #else /* not VMS */
10254 /* Perhaps should really fork an inferior shell?
10255 But that would not provide any way to get back
10256 to the original shell, ever. */
10257 printf ("No support for stopping a process on this operating system;\n");
10258 printf ("you can continue or abort.\n");
10259 #endif /* not VMS */
10260 #endif /* not SIGTSTP */
10261 #ifdef MSDOS
10262 /* We must remain inside the screen area when the internal terminal
10263 is used. Note that [Enter] is not echoed by dos. */
10264 cursor_to (0, 0);
10265 #endif
10266 /* It doesn't work to autosave while GC is in progress;
10267 the code used for auto-saving doesn't cope with the mark bit. */
10268 if (!gc_in_progress)
10270 printf ("Auto-save? (y or n) ");
10271 fflush (stdout);
10272 if (((c = getchar ()) & ~040) == 'Y')
10274 Fdo_auto_save (Qt, Qnil);
10275 #ifdef MSDOS
10276 printf ("\r\nAuto-save done");
10277 #else /* not MSDOS */
10278 printf ("Auto-save done\n");
10279 #endif /* not MSDOS */
10281 while (c != '\n') c = getchar ();
10283 else
10285 /* During GC, it must be safe to reenable quitting again. */
10286 Vinhibit_quit = Qnil;
10287 #ifdef MSDOS
10288 printf ("\r\n");
10289 #endif /* not MSDOS */
10290 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10291 printf ("but will instead do a real quit after garbage collection ends\r\n");
10292 fflush (stdout);
10295 #ifdef MSDOS
10296 printf ("\r\nAbort? (y or n) ");
10297 #else /* not MSDOS */
10298 #ifdef VMS
10299 printf ("Abort (and enter debugger)? (y or n) ");
10300 #else /* not VMS */
10301 printf ("Abort (and dump core)? (y or n) ");
10302 #endif /* not VMS */
10303 #endif /* not MSDOS */
10304 fflush (stdout);
10305 if (((c = getchar ()) & ~040) == 'Y')
10306 abort ();
10307 while (c != '\n') c = getchar ();
10308 #ifdef MSDOS
10309 printf ("\r\nContinuing...\r\n");
10310 #else /* not MSDOS */
10311 printf ("Continuing...\n");
10312 #endif /* not MSDOS */
10313 fflush (stdout);
10314 init_sys_modes ();
10315 sigfree ();
10317 else
10319 /* If executing a function that wants to be interrupted out of
10320 and the user has not deferred quitting by binding `inhibit-quit'
10321 then quit right away. */
10322 if (immediate_quit && NILP (Vinhibit_quit))
10324 struct gl_state_s saved;
10325 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10327 immediate_quit = 0;
10328 sigfree ();
10329 saved = gl_state;
10330 GCPRO4 (saved.object, saved.global_code,
10331 saved.current_syntax_table, saved.old_prop);
10332 Fsignal (Qquit, Qnil);
10333 gl_state = saved;
10334 UNGCPRO;
10336 else
10337 /* Else request quit when it's safe */
10338 Vquit_flag = Qt;
10341 if (waiting_for_input && !echoing)
10342 quit_throw_to_read_char ();
10344 errno = old_errno;
10347 /* Handle a C-g by making read_char return C-g. */
10349 void
10350 quit_throw_to_read_char ()
10352 sigfree ();
10353 /* Prevent another signal from doing this before we finish. */
10354 clear_waiting_for_input ();
10355 input_pending = 0;
10357 Vunread_command_events = Qnil;
10358 unread_command_char = -1;
10360 #if 0 /* Currently, sit_for is called from read_char without turning
10361 off polling. And that can call set_waiting_for_input.
10362 It seems to be harmless. */
10363 #ifdef POLL_FOR_INPUT
10364 /* May be > 1 if in recursive minibuffer. */
10365 if (poll_suppress_count == 0)
10366 abort ();
10367 #endif
10368 #endif
10369 if (FRAMEP (internal_last_event_frame)
10370 && !EQ (internal_last_event_frame, selected_frame))
10371 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame),
10372 0, 0);
10374 _longjmp (getcjmp, 1);
10377 DEFUN ("set-input-mode", Fset_input_mode, Sset_input_mode, 3, 4, 0,
10378 doc: /* Set mode of reading keyboard input.
10379 First arg INTERRUPT non-nil means use input interrupts;
10380 nil means use CBREAK mode.
10381 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10382 (no effect except in CBREAK mode).
10383 Third arg META t means accept 8-bit input (for a Meta key).
10384 META nil means ignore the top bit, on the assumption it is parity.
10385 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10386 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10387 See also `current-input-mode'. */)
10388 (interrupt, flow, meta, quit)
10389 Lisp_Object interrupt, flow, meta, quit;
10391 if (!NILP (quit)
10392 && (!INTEGERP (quit) || XINT (quit) < 0 || XINT (quit) > 0400))
10393 error ("set-input-mode: QUIT must be an ASCII character");
10395 #ifdef POLL_FOR_INPUT
10396 stop_polling ();
10397 #endif
10399 #ifndef DOS_NT
10400 /* this causes startup screen to be restored and messes with the mouse */
10401 reset_sys_modes ();
10402 #endif
10404 #ifdef SIGIO
10405 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10406 if (read_socket_hook)
10408 /* When using X, don't give the user a real choice,
10409 because we haven't implemented the mechanisms to support it. */
10410 #ifdef NO_SOCK_SIGIO
10411 interrupt_input = 0;
10412 #else /* not NO_SOCK_SIGIO */
10413 interrupt_input = 1;
10414 #endif /* NO_SOCK_SIGIO */
10416 else
10417 interrupt_input = !NILP (interrupt);
10418 #else /* not SIGIO */
10419 interrupt_input = 0;
10420 #endif /* not SIGIO */
10422 /* Our VMS input only works by interrupts, as of now. */
10423 #ifdef VMS
10424 interrupt_input = 1;
10425 #endif
10427 flow_control = !NILP (flow);
10428 if (NILP (meta))
10429 meta_key = 0;
10430 else if (EQ (meta, Qt))
10431 meta_key = 1;
10432 else
10433 meta_key = 2;
10434 if (!NILP (quit))
10435 /* Don't let this value be out of range. */
10436 quit_char = XINT (quit) & (meta_key ? 0377 : 0177);
10438 #ifndef DOS_NT
10439 init_sys_modes ();
10440 #endif
10442 #ifdef POLL_FOR_INPUT
10443 poll_suppress_count = 1;
10444 start_polling ();
10445 #endif
10446 return Qnil;
10449 DEFUN ("current-input-mode", Fcurrent_input_mode, Scurrent_input_mode, 0, 0, 0,
10450 doc: /* Return information about the way Emacs currently reads keyboard input.
10451 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10452 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10453 nil, Emacs is using CBREAK mode.
10454 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10455 terminal; this does not apply if Emacs uses interrupt-driven input.
10456 META is t if accepting 8-bit input with 8th bit as Meta flag.
10457 META nil means ignoring the top bit, on the assumption it is parity.
10458 META is neither t nor nil if accepting 8-bit input and using
10459 all 8 bits as the character code.
10460 QUIT is the character Emacs currently uses to quit.
10461 The elements of this list correspond to the arguments of
10462 `set-input-mode'. */)
10465 Lisp_Object val[4];
10467 val[0] = interrupt_input ? Qt : Qnil;
10468 val[1] = flow_control ? Qt : Qnil;
10469 val[2] = meta_key == 2 ? make_number (0) : meta_key == 1 ? Qt : Qnil;
10470 XSETFASTINT (val[3], quit_char);
10472 return Flist (sizeof (val) / sizeof (val[0]), val);
10477 * Set up a new kboard object with reasonable initial values.
10479 void
10480 init_kboard (kb)
10481 KBOARD *kb;
10483 kb->Voverriding_terminal_local_map = Qnil;
10484 kb->Vlast_command = Qnil;
10485 kb->Vreal_last_command = Qnil;
10486 kb->Vprefix_arg = Qnil;
10487 kb->Vlast_prefix_arg = Qnil;
10488 kb->kbd_queue = Qnil;
10489 kb->kbd_queue_has_data = 0;
10490 kb->immediate_echo = 0;
10491 kb->echo_string = Qnil;
10492 kb->echo_after_prompt = -1;
10493 kb->kbd_macro_buffer = 0;
10494 kb->kbd_macro_bufsize = 0;
10495 kb->defining_kbd_macro = Qnil;
10496 kb->Vlast_kbd_macro = Qnil;
10497 kb->reference_count = 0;
10498 kb->Vsystem_key_alist = Qnil;
10499 kb->system_key_syms = Qnil;
10500 kb->Vdefault_minibuffer_frame = Qnil;
10504 * Destroy the contents of a kboard object, but not the object itself.
10505 * We use this just before deleting it, or if we're going to initialize
10506 * it a second time.
10508 static void
10509 wipe_kboard (kb)
10510 KBOARD *kb;
10512 if (kb->kbd_macro_buffer)
10513 xfree (kb->kbd_macro_buffer);
10516 #ifdef MULTI_KBOARD
10518 /* Free KB and memory referenced from it. */
10520 void
10521 delete_kboard (kb)
10522 KBOARD *kb;
10524 KBOARD **kbp;
10526 for (kbp = &all_kboards; *kbp != kb; kbp = &(*kbp)->next_kboard)
10527 if (*kbp == NULL)
10528 abort ();
10529 *kbp = kb->next_kboard;
10531 /* Prevent a dangling reference to KB. */
10532 if (kb == current_kboard
10533 && FRAMEP (selected_frame)
10534 && FRAME_LIVE_P (XFRAME (selected_frame)))
10536 current_kboard = XFRAME (selected_frame)->kboard;
10537 if (current_kboard == kb)
10538 abort ();
10541 wipe_kboard (kb);
10542 xfree (kb);
10545 #endif /* MULTI_KBOARD */
10547 void
10548 init_keyboard ()
10550 /* This is correct before outermost invocation of the editor loop */
10551 command_loop_level = -1;
10552 immediate_quit = 0;
10553 quit_char = Ctl ('g');
10554 Vunread_command_events = Qnil;
10555 unread_command_char = -1;
10556 EMACS_SET_SECS_USECS (timer_idleness_start_time, -1, -1);
10557 total_keys = 0;
10558 recent_keys_index = 0;
10559 kbd_fetch_ptr = kbd_buffer;
10560 kbd_store_ptr = kbd_buffer;
10561 #ifdef HAVE_MOUSE
10562 do_mouse_tracking = Qnil;
10563 #endif
10564 input_pending = 0;
10565 #ifndef VMS
10567 int i;
10568 for (i = 0; i < KBD_BUFFER_SIZE; i++)
10569 EVENT_INIT (read_avail_input_buf[i]);
10571 #endif
10574 /* This means that command_loop_1 won't try to select anything the first
10575 time through. */
10576 internal_last_event_frame = Qnil;
10577 Vlast_event_frame = internal_last_event_frame;
10579 #ifdef MULTI_KBOARD
10580 current_kboard = initial_kboard;
10581 #endif
10582 wipe_kboard (current_kboard);
10583 init_kboard (current_kboard);
10585 if (!noninteractive && !read_socket_hook && NILP (Vwindow_system))
10587 signal (SIGINT, interrupt_signal);
10588 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10589 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10590 SIGQUIT and we can't tell which one it will give us. */
10591 signal (SIGQUIT, interrupt_signal);
10592 #endif /* HAVE_TERMIO */
10594 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10595 #ifdef SIGIO
10596 if (!noninteractive)
10597 signal (SIGIO, input_available_signal);
10598 #endif /* SIGIO */
10600 /* Use interrupt input by default, if it works and noninterrupt input
10601 has deficiencies. */
10603 #ifdef INTERRUPT_INPUT
10604 interrupt_input = 1;
10605 #else
10606 interrupt_input = 0;
10607 #endif
10609 /* Our VMS input only works by interrupts, as of now. */
10610 #ifdef VMS
10611 interrupt_input = 1;
10612 #endif
10614 sigfree ();
10615 dribble = 0;
10617 if (keyboard_init_hook)
10618 (*keyboard_init_hook) ();
10620 #ifdef POLL_FOR_INPUT
10621 poll_suppress_count = 1;
10622 start_polling ();
10623 #endif
10625 #ifdef MAC_OSX
10626 /* At least provide an escape route since C-g doesn't work. */
10627 signal (SIGINT, interrupt_signal);
10628 #endif
10631 /* This type's only use is in syms_of_keyboard, to initialize the
10632 event header symbols and put properties on them. */
10633 struct event_head {
10634 Lisp_Object *var;
10635 char *name;
10636 Lisp_Object *kind;
10639 struct event_head head_table[] = {
10640 {&Qmouse_movement, "mouse-movement", &Qmouse_movement},
10641 {&Qscroll_bar_movement, "scroll-bar-movement", &Qmouse_movement},
10642 {&Qswitch_frame, "switch-frame", &Qswitch_frame},
10643 {&Qdelete_frame, "delete-frame", &Qdelete_frame},
10644 {&Qiconify_frame, "iconify-frame", &Qiconify_frame},
10645 {&Qmake_frame_visible, "make-frame-visible", &Qmake_frame_visible},
10646 /* `select-window' should be handled just like `switch-frame'
10647 in read_key_sequence. */
10648 {&Qselect_window, "select-window", &Qswitch_frame}
10651 void
10652 syms_of_keyboard ()
10654 Vpre_help_message = Qnil;
10655 staticpro (&Vpre_help_message);
10657 Vlispy_mouse_stem = build_string ("mouse");
10658 staticpro (&Vlispy_mouse_stem);
10660 /* Tool-bars. */
10661 QCimage = intern (":image");
10662 staticpro (&QCimage);
10664 staticpro (&Qhelp_echo);
10665 Qhelp_echo = intern ("help-echo");
10667 staticpro (&item_properties);
10668 item_properties = Qnil;
10670 staticpro (&tool_bar_item_properties);
10671 tool_bar_item_properties = Qnil;
10672 staticpro (&tool_bar_items_vector);
10673 tool_bar_items_vector = Qnil;
10675 staticpro (&real_this_command);
10676 real_this_command = Qnil;
10678 Qtimer_event_handler = intern ("timer-event-handler");
10679 staticpro (&Qtimer_event_handler);
10681 Qdisabled_command_hook = intern ("disabled-command-hook");
10682 staticpro (&Qdisabled_command_hook);
10684 Qself_insert_command = intern ("self-insert-command");
10685 staticpro (&Qself_insert_command);
10687 Qforward_char = intern ("forward-char");
10688 staticpro (&Qforward_char);
10690 Qbackward_char = intern ("backward-char");
10691 staticpro (&Qbackward_char);
10693 Qdisabled = intern ("disabled");
10694 staticpro (&Qdisabled);
10696 Qundefined = intern ("undefined");
10697 staticpro (&Qundefined);
10699 Qpre_command_hook = intern ("pre-command-hook");
10700 staticpro (&Qpre_command_hook);
10702 Qpost_command_hook = intern ("post-command-hook");
10703 staticpro (&Qpost_command_hook);
10705 Qpost_command_idle_hook = intern ("post-command-idle-hook");
10706 staticpro (&Qpost_command_idle_hook);
10708 Qdeferred_action_function = intern ("deferred-action-function");
10709 staticpro (&Qdeferred_action_function);
10711 Qcommand_hook_internal = intern ("command-hook-internal");
10712 staticpro (&Qcommand_hook_internal);
10714 Qfunction_key = intern ("function-key");
10715 staticpro (&Qfunction_key);
10716 Qmouse_click = intern ("mouse-click");
10717 staticpro (&Qmouse_click);
10718 #ifdef WINDOWSNT
10719 Qlanguage_change = intern ("language-change");
10720 staticpro (&Qlanguage_change);
10721 #endif
10722 Qdrag_n_drop = intern ("drag-n-drop");
10723 staticpro (&Qdrag_n_drop);
10725 Qsave_session = intern ("save-session");
10726 staticpro(&Qsave_session);
10728 Qusr1_signal = intern ("usr1-signal");
10729 staticpro (&Qusr1_signal);
10730 Qusr2_signal = intern ("usr2-signal");
10731 staticpro (&Qusr2_signal);
10733 Qmenu_enable = intern ("menu-enable");
10734 staticpro (&Qmenu_enable);
10735 Qmenu_alias = intern ("menu-alias");
10736 staticpro (&Qmenu_alias);
10737 QCenable = intern (":enable");
10738 staticpro (&QCenable);
10739 QCvisible = intern (":visible");
10740 staticpro (&QCvisible);
10741 QChelp = intern (":help");
10742 staticpro (&QChelp);
10743 QCfilter = intern (":filter");
10744 staticpro (&QCfilter);
10745 QCbutton = intern (":button");
10746 staticpro (&QCbutton);
10747 QCkeys = intern (":keys");
10748 staticpro (&QCkeys);
10749 QCkey_sequence = intern (":key-sequence");
10750 staticpro (&QCkey_sequence);
10751 QCtoggle = intern (":toggle");
10752 staticpro (&QCtoggle);
10753 QCradio = intern (":radio");
10754 staticpro (&QCradio);
10756 Qmode_line = intern ("mode-line");
10757 staticpro (&Qmode_line);
10758 Qvertical_line = intern ("vertical-line");
10759 staticpro (&Qvertical_line);
10760 Qvertical_scroll_bar = intern ("vertical-scroll-bar");
10761 staticpro (&Qvertical_scroll_bar);
10762 Qmenu_bar = intern ("menu-bar");
10763 staticpro (&Qmenu_bar);
10765 Qabove_handle = intern ("above-handle");
10766 staticpro (&Qabove_handle);
10767 Qhandle = intern ("handle");
10768 staticpro (&Qhandle);
10769 Qbelow_handle = intern ("below-handle");
10770 staticpro (&Qbelow_handle);
10771 Qup = intern ("up");
10772 staticpro (&Qup);
10773 Qdown = intern ("down");
10774 staticpro (&Qdown);
10775 Qtop = intern ("top");
10776 staticpro (&Qtop);
10777 Qbottom = intern ("bottom");
10778 staticpro (&Qbottom);
10779 Qend_scroll = intern ("end-scroll");
10780 staticpro (&Qend_scroll);
10781 Qratio = intern ("ratio");
10782 staticpro (&Qratio);
10784 Qevent_kind = intern ("event-kind");
10785 staticpro (&Qevent_kind);
10786 Qevent_symbol_elements = intern ("event-symbol-elements");
10787 staticpro (&Qevent_symbol_elements);
10788 Qevent_symbol_element_mask = intern ("event-symbol-element-mask");
10789 staticpro (&Qevent_symbol_element_mask);
10790 Qmodifier_cache = intern ("modifier-cache");
10791 staticpro (&Qmodifier_cache);
10793 Qrecompute_lucid_menubar = intern ("recompute-lucid-menubar");
10794 staticpro (&Qrecompute_lucid_menubar);
10795 Qactivate_menubar_hook = intern ("activate-menubar-hook");
10796 staticpro (&Qactivate_menubar_hook);
10798 Qpolling_period = intern ("polling-period");
10799 staticpro (&Qpolling_period);
10801 Qinput_method_function = intern ("input-method-function");
10802 staticpro (&Qinput_method_function);
10804 Qinput_method_exit_on_first_char = intern ("input-method-exit-on-first-char");
10805 staticpro (&Qinput_method_exit_on_first_char);
10806 Qinput_method_use_echo_area = intern ("input-method-use-echo-area");
10807 staticpro (&Qinput_method_use_echo_area);
10809 Fset (Qinput_method_exit_on_first_char, Qnil);
10810 Fset (Qinput_method_use_echo_area, Qnil);
10812 last_point_position_buffer = Qnil;
10815 struct event_head *p;
10817 for (p = head_table;
10818 p < head_table + (sizeof (head_table) / sizeof (head_table[0]));
10819 p++)
10821 *p->var = intern (p->name);
10822 staticpro (p->var);
10823 Fput (*p->var, Qevent_kind, *p->kind);
10824 Fput (*p->var, Qevent_symbol_elements, Fcons (*p->var, Qnil));
10828 button_down_location = Fmake_vector (make_number (1), Qnil);
10829 staticpro (&button_down_location);
10830 mouse_syms = Fmake_vector (make_number (1), Qnil);
10831 staticpro (&mouse_syms);
10832 wheel_syms = Fmake_vector (make_number (2), Qnil);
10833 staticpro (&wheel_syms);
10836 int i;
10837 int len = sizeof (modifier_names) / sizeof (modifier_names[0]);
10839 modifier_symbols = Fmake_vector (make_number (len), Qnil);
10840 for (i = 0; i < len; i++)
10841 if (modifier_names[i])
10842 XVECTOR (modifier_symbols)->contents[i] = intern (modifier_names[i]);
10843 staticpro (&modifier_symbols);
10846 recent_keys = Fmake_vector (make_number (NUM_RECENT_KEYS), Qnil);
10847 staticpro (&recent_keys);
10849 this_command_keys = Fmake_vector (make_number (40), Qnil);
10850 staticpro (&this_command_keys);
10852 raw_keybuf = Fmake_vector (make_number (30), Qnil);
10853 staticpro (&raw_keybuf);
10855 Qextended_command_history = intern ("extended-command-history");
10856 Fset (Qextended_command_history, Qnil);
10857 staticpro (&Qextended_command_history);
10859 accent_key_syms = Qnil;
10860 staticpro (&accent_key_syms);
10862 func_key_syms = Qnil;
10863 staticpro (&func_key_syms);
10865 drag_n_drop_syms = Qnil;
10866 staticpro (&drag_n_drop_syms);
10868 unread_switch_frame = Qnil;
10869 staticpro (&unread_switch_frame);
10871 internal_last_event_frame = Qnil;
10872 staticpro (&internal_last_event_frame);
10874 read_key_sequence_cmd = Qnil;
10875 staticpro (&read_key_sequence_cmd);
10877 menu_bar_one_keymap_changed_items = Qnil;
10878 staticpro (&menu_bar_one_keymap_changed_items);
10880 defsubr (&Sevent_convert_list);
10881 defsubr (&Sread_key_sequence);
10882 defsubr (&Sread_key_sequence_vector);
10883 defsubr (&Srecursive_edit);
10884 #ifdef HAVE_MOUSE
10885 defsubr (&Strack_mouse);
10886 #endif
10887 defsubr (&Sinput_pending_p);
10888 defsubr (&Scommand_execute);
10889 defsubr (&Srecent_keys);
10890 defsubr (&Sthis_command_keys);
10891 defsubr (&Sthis_command_keys_vector);
10892 defsubr (&Sthis_single_command_keys);
10893 defsubr (&Sthis_single_command_raw_keys);
10894 defsubr (&Sreset_this_command_lengths);
10895 defsubr (&Sclear_this_command_keys);
10896 defsubr (&Ssuspend_emacs);
10897 defsubr (&Sabort_recursive_edit);
10898 defsubr (&Sexit_recursive_edit);
10899 defsubr (&Srecursion_depth);
10900 defsubr (&Stop_level);
10901 defsubr (&Sdiscard_input);
10902 defsubr (&Sopen_dribble_file);
10903 defsubr (&Sset_input_mode);
10904 defsubr (&Scurrent_input_mode);
10905 defsubr (&Sexecute_extended_command);
10907 DEFVAR_LISP ("last-command-char", &last_command_char,
10908 doc: /* Last input event that was part of a command. */);
10910 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char,
10911 doc: /* Last input event that was part of a command. */);
10913 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event,
10914 doc: /* Last input event in a command, except for mouse menu events.
10915 Mouse menus give back keys that don't look like mouse events;
10916 this variable holds the actual mouse event that led to the menu,
10917 so that you can determine whether the command was run by mouse or not. */);
10919 DEFVAR_LISP ("last-input-char", &last_input_char,
10920 doc: /* Last input event. */);
10922 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char,
10923 doc: /* Last input event. */);
10925 DEFVAR_LISP ("unread-command-events", &Vunread_command_events,
10926 doc: /* List of events to be read as the command input.
10927 These events are processed first, before actual keyboard input. */);
10928 Vunread_command_events = Qnil;
10930 DEFVAR_INT ("unread-command-char", &unread_command_char,
10931 doc: /* If not -1, an object to be read as next command input event. */);
10933 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events,
10934 doc: /* List of events to be processed as input by input methods.
10935 These events are processed after `unread-command-events', but
10936 before actual keyboard input. */);
10937 Vunread_post_input_method_events = Qnil;
10939 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events,
10940 doc: /* List of events to be processed as input by input methods.
10941 These events are processed after `unread-command-events', but
10942 before actual keyboard input. */);
10943 Vunread_input_method_events = Qnil;
10945 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char,
10946 doc: /* Meta-prefix character code.
10947 Meta-foo as command input turns into this character followed by foo. */);
10948 XSETINT (meta_prefix_char, 033);
10950 DEFVAR_KBOARD ("last-command", Vlast_command,
10951 doc: /* The last command executed.
10952 Normally a symbol with a function definition, but can be whatever was found
10953 in the keymap, or whatever the variable `this-command' was set to by that
10954 command.
10956 The value `mode-exit' is special; it means that the previous command
10957 read an event that told it to exit, and it did so and unread that event.
10958 In other words, the present command is the event that made the previous
10959 command exit.
10961 The value `kill-region' is special; it means that the previous command
10962 was a kill command. */);
10964 DEFVAR_KBOARD ("real-last-command", Vreal_last_command,
10965 doc: /* Same as `last-command', but never altered by Lisp code. */);
10967 DEFVAR_LISP ("this-command", &Vthis_command,
10968 doc: /* The command now being executed.
10969 The command can set this variable; whatever is put here
10970 will be in `last-command' during the following command. */);
10971 Vthis_command = Qnil;
10973 DEFVAR_LISP ("this-original-command", &Vthis_original_command,
10974 doc: /* The command bound to the current key sequence before remapping.
10975 It equals `this-command' if the original command was not remapped through
10976 any of the active keymaps. Otherwise, the value of `this-command' is the
10977 result of looking up the original command in the active keymaps. */);
10978 Vthis_original_command = Qnil;
10980 DEFVAR_INT ("auto-save-interval", &auto_save_interval,
10981 doc: /* *Number of input events between auto-saves.
10982 Zero means disable autosaving due to number of characters typed. */);
10983 auto_save_interval = 300;
10985 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout,
10986 doc: /* *Number of seconds idle time before auto-save.
10987 Zero or nil means disable auto-saving due to idleness.
10988 After auto-saving due to this many seconds of idle time,
10989 Emacs also does a garbage collection if that seems to be warranted. */);
10990 XSETFASTINT (Vauto_save_timeout, 30);
10992 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes,
10993 doc: /* *Nonzero means echo unfinished commands after this many seconds of pause.
10994 The value may be integer or floating point. */);
10995 Vecho_keystrokes = make_number (1);
10997 DEFVAR_INT ("polling-period", &polling_period,
10998 doc: /* *Interval between polling for input during Lisp execution.
10999 The reason for polling is to make C-g work to stop a running program.
11000 Polling is needed only when using X windows and SIGIO does not work.
11001 Polling is automatically disabled in all other cases. */);
11002 polling_period = 2;
11004 DEFVAR_LISP ("double-click-time", &Vdouble_click_time,
11005 doc: /* *Maximum time between mouse clicks to make a double-click.
11006 Measured in milliseconds. nil means disable double-click recognition;
11007 t means double-clicks have no time limit and are detected
11008 by position only. */);
11009 Vdouble_click_time = make_number (500);
11011 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz,
11012 doc: /* *Maximum mouse movement between clicks to make a double-click.
11013 On window-system frames, value is the number of pixels the mouse may have
11014 moved horizontally or vertically between two clicks to make a double-click.
11015 On non window-system frames, value is interpreted in units of 1/8 characters
11016 instead of pixels.
11018 This variable is also the threshold for motion of the mouse
11019 to count as a drag. */);
11020 double_click_fuzz = 3;
11022 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus,
11023 doc: /* *Non-nil means inhibit local map menu bar menus. */);
11024 inhibit_local_menu_bar_menus = 0;
11026 DEFVAR_INT ("num-input-keys", &num_input_keys,
11027 doc: /* Number of complete key sequences read as input so far.
11028 This includes key sequences read from keyboard macros.
11029 The number is effectively the number of interactive command invocations. */);
11030 num_input_keys = 0;
11032 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events,
11033 doc: /* Number of input events read from the keyboard so far.
11034 This does not include events generated by keyboard macros. */);
11035 num_nonmacro_input_events = 0;
11037 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame,
11038 doc: /* The frame in which the most recently read event occurred.
11039 If the last event came from a keyboard macro, this is set to `macro'. */);
11040 Vlast_event_frame = Qnil;
11042 /* This variable is set up in sysdep.c. */
11043 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char,
11044 doc: /* The ERASE character as set by the user with stty. */);
11046 DEFVAR_LISP ("help-char", &Vhelp_char,
11047 doc: /* Character to recognize as meaning Help.
11048 When it is read, do `(eval help-form)', and display result if it's a string.
11049 If the value of `help-form' is nil, this char can be read normally. */);
11050 XSETINT (Vhelp_char, Ctl ('H'));
11052 DEFVAR_LISP ("help-event-list", &Vhelp_event_list,
11053 doc: /* List of input events to recognize as meaning Help.
11054 These work just like the value of `help-char' (see that). */);
11055 Vhelp_event_list = Qnil;
11057 DEFVAR_LISP ("help-form", &Vhelp_form,
11058 doc: /* Form to execute when character `help-char' is read.
11059 If the form returns a string, that string is displayed.
11060 If `help-form' is nil, the help char is not recognized. */);
11061 Vhelp_form = Qnil;
11063 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command,
11064 doc: /* Command to run when `help-char' character follows a prefix key.
11065 This command is used only when there is no actual binding
11066 for that character after that prefix key. */);
11067 Vprefix_help_command = Qnil;
11069 DEFVAR_LISP ("top-level", &Vtop_level,
11070 doc: /* Form to evaluate when Emacs starts up.
11071 Useful to set before you dump a modified Emacs. */);
11072 Vtop_level = Qnil;
11074 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table,
11075 doc: /* Translate table for keyboard input, or nil.
11076 Each character is looked up in this string and the contents used instead.
11077 The value may be a string, a vector, or a char-table.
11078 If it is a string or vector of length N,
11079 character codes N and up are untranslated.
11080 In a vector or a char-table, an element which is nil means "no translation".
11082 This is applied to the characters supplied to input methods, not their
11083 output. See also `translation-table-for-input'. */);
11084 Vkeyboard_translate_table = Qnil;
11086 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend,
11087 doc: /* Non-nil means to always spawn a subshell instead of suspending.
11088 \(Even if the operating system has support for stopping a process.\) */);
11089 cannot_suspend = 0;
11091 DEFVAR_BOOL ("menu-prompting", &menu_prompting,
11092 doc: /* Non-nil means prompt with menus when appropriate.
11093 This is done when reading from a keymap that has a prompt string,
11094 for elements that have prompt strings.
11095 The menu is displayed on the screen
11096 if X menus were enabled at configuration
11097 time and the previous event was a mouse click prefix key.
11098 Otherwise, menu prompting uses the echo area. */);
11099 menu_prompting = 1;
11101 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char,
11102 doc: /* Character to see next line of menu prompt.
11103 Type this character while in a menu prompt to rotate around the lines of it. */);
11104 XSETINT (menu_prompt_more_char, ' ');
11106 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers,
11107 doc: /* A mask of additional modifier keys to use with every keyboard character.
11108 Emacs applies the modifiers of the character stored here to each keyboard
11109 character it reads. For example, after evaluating the expression
11110 (setq extra-keyboard-modifiers ?\\C-x)
11111 all input characters will have the control modifier applied to them.
11113 Note that the character ?\\C-@, equivalent to the integer zero, does
11114 not count as a control character; rather, it counts as a character
11115 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11116 cancels any modification. */);
11117 extra_keyboard_modifiers = 0;
11119 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark,
11120 doc: /* If an editing command sets this to t, deactivate the mark afterward.
11121 The command loop sets this to nil before each command,
11122 and tests the value when the command returns.
11123 Buffer modification stores t in this variable. */);
11124 Vdeactivate_mark = Qnil;
11126 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal,
11127 doc: /* Temporary storage of pre-command-hook or post-command-hook. */);
11128 Vcommand_hook_internal = Qnil;
11130 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook,
11131 doc: /* Normal hook run before each command is executed.
11132 If an unhandled error happens in running this hook,
11133 the hook value is set to nil, since otherwise the error
11134 might happen repeatedly and make Emacs nonfunctional. */);
11135 Vpre_command_hook = Qnil;
11137 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook,
11138 doc: /* Normal hook run after each command is executed.
11139 If an unhandled error happens in running this hook,
11140 the hook value is set to nil, since otherwise the error
11141 might happen repeatedly and make Emacs nonfunctional. */);
11142 Vpost_command_hook = Qnil;
11144 DEFVAR_LISP ("post-command-idle-hook", &Vpost_command_idle_hook,
11145 doc: /* Normal hook run after each command is executed, if idle.
11146 Errors running the hook are caught and ignored. */);
11147 Vpost_command_idle_hook = Qnil;
11149 DEFVAR_INT ("post-command-idle-delay", &post_command_idle_delay,
11150 doc: /* Delay time before running `post-command-idle-hook'.
11151 This is measured in microseconds. */);
11152 post_command_idle_delay = 100000;
11154 #if 0
11155 DEFVAR_LISP ("echo-area-clear-hook", ...,
11156 doc: /* Normal hook run when clearing the echo area. */);
11157 #endif
11158 Qecho_area_clear_hook = intern ("echo-area-clear-hook");
11159 SET_SYMBOL_VALUE (Qecho_area_clear_hook, Qnil);
11161 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag,
11162 doc: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11163 Vlucid_menu_bar_dirty_flag = Qnil;
11165 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items,
11166 doc: /* List of menu bar items to move to the end of the menu bar.
11167 The elements of the list are event types that may have menu bar bindings. */);
11168 Vmenu_bar_final_items = Qnil;
11170 DEFVAR_KBOARD ("overriding-terminal-local-map",
11171 Voverriding_terminal_local_map,
11172 doc: /* Per-terminal keymap that overrides all other local keymaps.
11173 If this variable is non-nil, it is used as a keymap instead of the
11174 buffer's local map, and the minor mode keymaps and text property keymaps.
11175 This variable is intended to let commands such as `universal-argument'
11176 set up a different keymap for reading the next command. */);
11178 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map,
11179 doc: /* Keymap that overrides all other local keymaps.
11180 If this variable is non-nil, it is used as a keymap instead of the
11181 buffer's local map, and the minor mode keymaps and text property keymaps. */);
11182 Voverriding_local_map = Qnil;
11184 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag,
11185 doc: /* Non-nil means `overriding-local-map' applies to the menu bar.
11186 Otherwise, the menu bar continues to reflect the buffer's local map
11187 and the minor mode maps regardless of `overriding-local-map'. */);
11188 Voverriding_local_map_menu_flag = Qnil;
11190 DEFVAR_LISP ("special-event-map", &Vspecial_event_map,
11191 doc: /* Keymap defining bindings for special events to execute at low level. */);
11192 Vspecial_event_map = Fcons (intern ("keymap"), Qnil);
11194 DEFVAR_LISP ("track-mouse", &do_mouse_tracking,
11195 doc: /* *Non-nil means generate motion events for mouse motion. */);
11197 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist,
11198 doc: /* Alist of system-specific X windows key symbols.
11199 Each element should have the form (N . SYMBOL) where N is the
11200 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11201 and SYMBOL is its name. */);
11203 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list,
11204 doc: /* List of deferred actions to be performed at a later time.
11205 The precise format isn't relevant here; we just check whether it is nil. */);
11206 Vdeferred_action_list = Qnil;
11208 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function,
11209 doc: /* Function to call to handle deferred actions, after each command.
11210 This function is called with no arguments after each command
11211 whenever `deferred-action-list' is non-nil. */);
11212 Vdeferred_action_function = Qnil;
11214 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings,
11215 doc: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11216 The value can be a length of time to show the message for.
11217 If the value is non-nil and not a number, we wait 2 seconds. */);
11218 Vsuggest_key_bindings = Qt;
11220 DEFVAR_LISP ("timer-list", &Vtimer_list,
11221 doc: /* List of active absolute time timers in order of increasing time. */);
11222 Vtimer_list = Qnil;
11224 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list,
11225 doc: /* List of active idle-time timers in order of increasing time. */);
11226 Vtimer_idle_list = Qnil;
11228 DEFVAR_LISP ("input-method-function", &Vinput_method_function,
11229 doc: /* If non-nil, the function that implements the current input method.
11230 It's called with one argument, a printing character that was just read.
11231 \(That means a character with code 040...0176.)
11232 Typically this function uses `read-event' to read additional events.
11233 When it does so, it should first bind `input-method-function' to nil
11234 so it will not be called recursively.
11236 The function should return a list of zero or more events
11237 to be used as input. If it wants to put back some events
11238 to be reconsidered, separately, by the input method,
11239 it can add them to the beginning of `unread-command-events'.
11241 The input method function can find in `input-method-previous-method'
11242 the previous echo area message.
11244 The input method function should refer to the variables
11245 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11246 for guidance on what to do. */);
11247 Vinput_method_function = Qnil;
11249 DEFVAR_LISP ("input-method-previous-message",
11250 &Vinput_method_previous_message,
11251 doc: /* When `input-method-function' is called, hold the previous echo area message.
11252 This variable exists because `read-event' clears the echo area
11253 before running the input method. It is nil if there was no message. */);
11254 Vinput_method_previous_message = Qnil;
11256 DEFVAR_LISP ("show-help-function", &Vshow_help_function,
11257 doc: /* If non-nil, the function that implements the display of help.
11258 It's called with one argument, the help string to display. */);
11259 Vshow_help_function = Qnil;
11261 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment,
11262 doc: /* If non-nil, suppress point adjustment after executing a command.
11264 After a command is executed, if point is moved into a region that has
11265 special properties (e.g. composition, display), we adjust point to
11266 the boundary of the region. But, several special commands sets this
11267 variable to non-nil, then we suppress the point adjustment.
11269 This variable is set to nil before reading a command, and is checked
11270 just after executing the command. */);
11271 Vdisable_point_adjustment = Qnil;
11273 DEFVAR_LISP ("global-disable-point-adjustment",
11274 &Vglobal_disable_point_adjustment,
11275 doc: /* *If non-nil, always suppress point adjustment.
11277 The default value is nil, in which case, point adjustment are
11278 suppressed only after special commands that set
11279 `disable-point-adjustment' (which see) to non-nil. */);
11280 Vglobal_disable_point_adjustment = Qnil;
11282 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings,
11283 doc: /* Non-nil means updating menu bindings is allowed.
11284 A value of nil means menu bindings should not be updated.
11285 Used during Emacs' startup. */);
11286 update_menu_bindings = 1;
11288 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout,
11289 doc: /* *How long to display an echo-area message when the minibuffer is active.
11290 If the value is not a number, such messages don't time out. */);
11291 Vminibuffer_message_timeout = make_number (2);
11294 void
11295 keys_of_keyboard ()
11297 initial_define_key (global_map, Ctl ('Z'), "suspend-emacs");
11298 initial_define_key (control_x_map, Ctl ('Z'), "suspend-emacs");
11299 initial_define_key (meta_map, Ctl ('C'), "exit-recursive-edit");
11300 initial_define_key (global_map, Ctl (']'), "abort-recursive-edit");
11301 initial_define_key (meta_map, 'x', "execute-extended-command");
11303 initial_define_lispy_key (Vspecial_event_map, "delete-frame",
11304 "handle-delete-frame");
11305 initial_define_lispy_key (Vspecial_event_map, "iconify-frame",
11306 "ignore-event");
11307 initial_define_lispy_key (Vspecial_event_map, "make-frame-visible",
11308 "ignore-event");
11309 /* Handling it at such a low-level causes read_key_sequence to get
11310 * confused because it doesn't realize that the current_buffer was
11311 * changed by read_char.
11313 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11314 * "handle-select-window"); */
11315 initial_define_lispy_key (Vspecial_event_map, "save-session",
11316 "handle-save-session");
11319 /* Mark the pointers in the kboard objects.
11320 Called by the Fgarbage_collector. */
11321 void
11322 mark_kboards ()
11324 KBOARD *kb;
11325 Lisp_Object *p;
11326 for (kb = all_kboards; kb; kb = kb->next_kboard)
11328 if (kb->kbd_macro_buffer)
11329 for (p = kb->kbd_macro_buffer; p < kb->kbd_macro_ptr; p++)
11330 mark_object (*p);
11331 mark_object (kb->Voverriding_terminal_local_map);
11332 mark_object (kb->Vlast_command);
11333 mark_object (kb->Vreal_last_command);
11334 mark_object (kb->Vprefix_arg);
11335 mark_object (kb->Vlast_prefix_arg);
11336 mark_object (kb->kbd_queue);
11337 mark_object (kb->defining_kbd_macro);
11338 mark_object (kb->Vlast_kbd_macro);
11339 mark_object (kb->Vsystem_key_alist);
11340 mark_object (kb->system_key_syms);
11341 mark_object (kb->Vdefault_minibuffer_frame);
11342 mark_object (kb->echo_string);
11345 struct input_event *event;
11346 for (event = kbd_fetch_ptr; event != kbd_store_ptr; event++)
11348 if (event == kbd_buffer + KBD_BUFFER_SIZE)
11349 event = kbd_buffer;
11350 mark_object (event->x);
11351 mark_object (event->y);
11352 mark_object (event->frame_or_window);
11353 mark_object (event->arg);
11358 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11359 (do not change this comment) */