1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
30 #include "termhooks.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
63 #include <sys/types.h>
72 /* This is to get the definitions of the XK_ symbols. */
79 #endif /* HAVE_NTGUI */
89 /* Variables for blockinput.h: */
91 /* Non-zero if interrupt input is blocked right now. */
92 int interrupt_input_blocked
;
94 /* Nonzero means an input interrupt has arrived
95 during the current critical section. */
96 int interrupt_input_pending
;
99 #ifdef HAVE_WINDOW_SYSTEM
100 /* Make all keyboard buffers much bigger when using X windows. */
102 /* But not too big (local data > 32K error) if on Mac OS Classic. */
103 #define KBD_BUFFER_SIZE 512
105 #define KBD_BUFFER_SIZE 4096
107 #else /* No X-windows, character input */
108 #define KBD_BUFFER_SIZE 4096
109 #endif /* No X-windows */
111 #define abs(x) ((x) >= 0 ? (x) : -(x))
113 /* Following definition copied from eval.c */
117 struct backtrace
*next
;
118 Lisp_Object
*function
;
119 Lisp_Object
*args
; /* Points to vector of args. */
120 int nargs
; /* length of vector. If nargs is UNEVALLED,
121 args points to slot holding list of
124 /* Nonzero means call value of debugger when done with this operation. */
129 KBOARD
*initial_kboard
;
130 KBOARD
*current_kboard
;
134 KBOARD the_only_kboard
;
137 /* Non-nil disable property on a command means
138 do not execute it; call disabled-command-function's value instead. */
139 Lisp_Object Qdisabled
, Qdisabled_command_function
;
141 #define NUM_RECENT_KEYS (100)
142 int recent_keys_index
; /* Index for storing next element into recent_keys */
143 int total_keys
; /* Total number of elements stored into recent_keys */
144 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
146 /* Vector holding the key sequence that invoked the current command.
147 It is reused for each command, and it may be longer than the current
148 sequence; this_command_key_count indicates how many elements
149 actually mean something.
150 It's easier to staticpro a single Lisp_Object than an array. */
151 Lisp_Object this_command_keys
;
152 int this_command_key_count
;
154 /* 1 after calling Freset_this_command_lengths.
156 int this_command_key_count_reset
;
158 /* This vector is used as a buffer to record the events that were actually read
159 by read_key_sequence. */
160 Lisp_Object raw_keybuf
;
161 int raw_keybuf_count
;
163 #define GROW_RAW_KEYBUF \
164 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
166 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
168 new = Fmake_vector (make_number (newsize), Qnil); \
169 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
170 raw_keybuf_count * sizeof (Lisp_Object)); \
174 /* Number of elements of this_command_keys
175 that precede this key sequence. */
176 int this_single_command_key_start
;
178 /* Record values of this_command_key_count and echo_length ()
179 before this command was read. */
180 static int before_command_key_count
;
181 static int before_command_echo_length
;
183 extern int minbuf_level
;
185 extern int message_enable_multibyte
;
187 extern struct backtrace
*backtrace_list
;
189 /* If non-nil, the function that implements the display of help.
190 It's called with one argument, the help string to display. */
192 Lisp_Object Vshow_help_function
;
194 /* If a string, the message displayed before displaying a help-echo
197 Lisp_Object Vpre_help_message
;
199 /* Nonzero means do menu prompting. */
201 static int menu_prompting
;
203 /* Character to see next line of menu prompt. */
205 static Lisp_Object menu_prompt_more_char
;
207 /* For longjmp to where kbd input is being done. */
209 static jmp_buf getcjmp
;
211 /* True while doing kbd input. */
212 int waiting_for_input
;
214 /* True while displaying for echoing. Delays C-g throwing. */
218 /* Non-null means we can start echoing at the next input pause even
219 though there is something in the echo area. */
221 static struct kboard
*ok_to_echo_at_next_pause
;
223 /* The kboard last echoing, or null for none. Reset to 0 in
224 cancel_echoing. If non-null, and a current echo area message
225 exists, and echo_message_buffer is eq to the current message
226 buffer, we know that the message comes from echo_kboard. */
228 struct kboard
*echo_kboard
;
230 /* The buffer used for echoing. Set in echo_now, reset in
233 Lisp_Object echo_message_buffer
;
235 /* Nonzero means disregard local maps for the menu bar. */
236 static int inhibit_local_menu_bar_menus
;
238 /* Nonzero means C-g should cause immediate error-signal. */
241 /* The user's ERASE setting. */
242 Lisp_Object Vtty_erase_char
;
244 /* Character to recognize as the help char. */
245 Lisp_Object Vhelp_char
;
247 /* List of other event types to recognize as meaning "help". */
248 Lisp_Object Vhelp_event_list
;
250 /* Form to execute when help char is typed. */
251 Lisp_Object Vhelp_form
;
253 /* Command to run when the help character follows a prefix key. */
254 Lisp_Object Vprefix_help_command
;
256 /* List of items that should move to the end of the menu bar. */
257 Lisp_Object Vmenu_bar_final_items
;
259 /* Non-nil means show the equivalent key-binding for
260 any M-x command that has one.
261 The value can be a length of time to show the message for.
262 If the value is non-nil and not a number, we wait 2 seconds. */
263 Lisp_Object Vsuggest_key_bindings
;
265 /* How long to display an echo-area message when the minibuffer is active.
266 If the value is not a number, such messages don't time out. */
267 Lisp_Object Vminibuffer_message_timeout
;
269 /* Character that causes a quit. Normally C-g.
271 If we are running on an ordinary terminal, this must be an ordinary
272 ASCII char, since we want to make it our interrupt character.
274 If we are not running on an ordinary terminal, it still needs to be
275 an ordinary ASCII char. This character needs to be recognized in
276 the input interrupt handler. At this point, the keystroke is
277 represented as a struct input_event, while the desired quit
278 character is specified as a lispy event. The mapping from struct
279 input_events to lispy events cannot run in an interrupt handler,
280 and the reverse mapping is difficult for anything but ASCII
283 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
287 extern Lisp_Object current_global_map
;
288 extern int minibuf_level
;
290 /* If non-nil, this is a map that overrides all other local maps. */
291 Lisp_Object Voverriding_local_map
;
293 /* If non-nil, Voverriding_local_map applies to the menu bar. */
294 Lisp_Object Voverriding_local_map_menu_flag
;
296 /* Keymap that defines special misc events that should
297 be processed immediately at a low level. */
298 Lisp_Object Vspecial_event_map
;
300 /* Current depth in recursive edits. */
301 int command_loop_level
;
303 /* Total number of times command_loop has read a key sequence. */
304 EMACS_INT num_input_keys
;
306 /* Last input character read as a command. */
307 Lisp_Object last_command_char
;
309 /* Last input character read as a command, not counting menus
310 reached by the mouse. */
311 Lisp_Object last_nonmenu_event
;
313 /* Last input character read for any purpose. */
314 Lisp_Object last_input_char
;
316 /* If not Qnil, a list of objects to be read as subsequent command input. */
317 Lisp_Object Vunread_command_events
;
319 /* If not Qnil, a list of objects to be read as subsequent command input
320 including input method processing. */
321 Lisp_Object Vunread_input_method_events
;
323 /* If not Qnil, a list of objects to be read as subsequent command input
324 but NOT including input method processing. */
325 Lisp_Object Vunread_post_input_method_events
;
327 /* If not -1, an event to be read as subsequent command input. */
328 EMACS_INT unread_command_char
;
330 /* If not Qnil, this is a switch-frame event which we decided to put
331 off until the end of a key sequence. This should be read as the
332 next command input, after any unread_command_events.
334 read_key_sequence uses this to delay switch-frame events until the
335 end of the key sequence; Fread_char uses it to put off switch-frame
336 events until a non-ASCII event is acceptable as input. */
337 Lisp_Object unread_switch_frame
;
339 /* A mask of extra modifier bits to put into every keyboard char. */
340 EMACS_INT extra_keyboard_modifiers
;
342 /* Char to use as prefix when a meta character is typed in.
343 This is bound on entry to minibuffer in case ESC is changed there. */
345 Lisp_Object meta_prefix_char
;
347 /* Last size recorded for a current buffer which is not a minibuffer. */
348 static int last_non_minibuf_size
;
350 /* Number of idle seconds before an auto-save and garbage collection. */
351 static Lisp_Object Vauto_save_timeout
;
353 /* Total number of times read_char has returned. */
354 int num_input_events
;
356 /* Total number of times read_char has returned, outside of macros. */
357 EMACS_INT num_nonmacro_input_events
;
359 /* Auto-save automatically when this many characters have been typed
360 since the last time. */
362 static EMACS_INT auto_save_interval
;
364 /* Value of num_nonmacro_input_events as of last auto save. */
368 /* The command being executed by the command loop.
369 Commands may set this, and the value set will be copied into
370 current_kboard->Vlast_command instead of the actual command. */
371 Lisp_Object Vthis_command
;
373 /* This is like Vthis_command, except that commands never set it. */
374 Lisp_Object real_this_command
;
376 /* If the lookup of the command returns a binding, the original
377 command is stored in this-original-command. It is nil otherwise. */
378 Lisp_Object Vthis_original_command
;
380 /* The value of point when the last command was executed. */
381 int last_point_position
;
383 /* The buffer that was current when the last command was started. */
384 Lisp_Object last_point_position_buffer
;
386 /* The frame in which the last input event occurred, or Qmacro if the
387 last event came from a macro. We use this to determine when to
388 generate switch-frame events. This may be cleared by functions
389 like Fselect_frame, to make sure that a switch-frame event is
390 generated by the next character. */
391 Lisp_Object internal_last_event_frame
;
393 /* A user-visible version of the above, intended to allow users to
394 figure out where the last event came from, if the event doesn't
395 carry that information itself (i.e. if it was a character). */
396 Lisp_Object Vlast_event_frame
;
398 /* The timestamp of the last input event we received from the X server.
399 X Windows wants this for selection ownership. */
400 unsigned long last_event_timestamp
;
402 Lisp_Object Qself_insert_command
;
403 Lisp_Object Qforward_char
;
404 Lisp_Object Qbackward_char
;
405 Lisp_Object Qundefined
;
406 Lisp_Object Qtimer_event_handler
;
408 /* read_key_sequence stores here the command definition of the
409 key sequence that it reads. */
410 Lisp_Object read_key_sequence_cmd
;
412 /* Echo unfinished commands after this many seconds of pause. */
413 Lisp_Object Vecho_keystrokes
;
415 /* Form to evaluate (if non-nil) when Emacs is started. */
416 Lisp_Object Vtop_level
;
418 /* If non-nil, this implements the current input method. */
419 Lisp_Object Vinput_method_function
;
420 Lisp_Object Qinput_method_function
;
422 /* When we call Vinput_method_function,
423 this holds the echo area message that was just erased. */
424 Lisp_Object Vinput_method_previous_message
;
426 /* Non-nil means deactivate the mark at end of this command. */
427 Lisp_Object Vdeactivate_mark
;
429 /* Menu bar specified in Lucid Emacs fashion. */
431 Lisp_Object Vlucid_menu_bar_dirty_flag
;
432 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
434 Lisp_Object Qecho_area_clear_hook
;
436 /* Hooks to run before and after each command. */
437 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
438 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
439 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
441 /* Parent keymap of terminal-local function-key-map instances. */
442 Lisp_Object Vfunction_key_map
;
444 /* Parent keymap of terminal-local key-translation-map instances. */
445 Lisp_Object Vkey_translation_map
;
447 /* List of deferred actions to be performed at a later time.
448 The precise format isn't relevant here; we just check whether it is nil. */
449 Lisp_Object Vdeferred_action_list
;
451 /* Function to call to handle deferred actions, when there are any. */
452 Lisp_Object Vdeferred_action_function
;
453 Lisp_Object Qdeferred_action_function
;
455 Lisp_Object Qinput_method_exit_on_first_char
;
456 Lisp_Object Qinput_method_use_echo_area
;
458 /* File in which we write all commands we read. */
461 /* Nonzero if input is available. */
464 extern char *pending_malloc_warning
;
466 /* Circular buffer for pre-read keyboard input. */
468 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
470 /* Pointer to next available character in kbd_buffer.
471 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
472 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
473 next available char is in kbd_buffer[0]. */
474 static struct input_event
*kbd_fetch_ptr
;
476 /* Pointer to next place to store character in kbd_buffer. This
477 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
478 character should go in kbd_buffer[0]. */
479 static struct input_event
* volatile kbd_store_ptr
;
481 /* The above pair of variables forms a "queue empty" flag. When we
482 enqueue a non-hook event, we increment kbd_store_ptr. When we
483 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
484 there is input available iff the two pointers are not equal.
486 Why not just have a flag set and cleared by the enqueuing and
487 dequeuing functions? Such a flag could be screwed up by interrupts
488 at inopportune times. */
490 /* If this flag is non-nil, we check mouse_moved to see when the
491 mouse moves, and motion events will appear in the input stream.
492 Otherwise, mouse motion is ignored. */
493 Lisp_Object do_mouse_tracking
;
495 /* Symbols to head events. */
496 Lisp_Object Qmouse_movement
;
497 Lisp_Object Qscroll_bar_movement
;
498 Lisp_Object Qswitch_frame
;
499 Lisp_Object Qdelete_frame
;
500 Lisp_Object Qiconify_frame
;
501 Lisp_Object Qmake_frame_visible
;
502 Lisp_Object Qselect_window
;
503 Lisp_Object Qhelp_echo
;
506 Lisp_Object Qmouse_fixup_help_message
;
509 /* Symbols to denote kinds of events. */
510 Lisp_Object Qfunction_key
;
511 Lisp_Object Qmouse_click
;
512 #if defined (WINDOWSNT) || defined (MAC_OS)
513 Lisp_Object Qlanguage_change
;
515 Lisp_Object Qdrag_n_drop
;
516 Lisp_Object Qsave_session
;
518 /* Lisp_Object Qmouse_movement; - also an event header */
520 /* Properties of event headers. */
521 Lisp_Object Qevent_kind
;
522 Lisp_Object Qevent_symbol_elements
;
524 /* menu item parts */
525 Lisp_Object Qmenu_alias
;
526 Lisp_Object Qmenu_enable
;
527 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
528 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
529 extern Lisp_Object Vdefine_key_rebound_commands
;
530 extern Lisp_Object Qmenu_item
;
532 /* An event header symbol HEAD may have a property named
533 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
534 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
535 mask of modifiers applied to it. If present, this is used to help
536 speed up parse_modifiers. */
537 Lisp_Object Qevent_symbol_element_mask
;
539 /* An unmodified event header BASE may have a property named
540 Qmodifier_cache, which is an alist mapping modifier masks onto
541 modified versions of BASE. If present, this helps speed up
543 Lisp_Object Qmodifier_cache
;
545 /* Symbols to use for parts of windows. */
546 Lisp_Object Qmode_line
;
547 Lisp_Object Qvertical_line
;
548 Lisp_Object Qvertical_scroll_bar
;
549 Lisp_Object Qmenu_bar
;
550 extern Lisp_Object Qleft_margin
, Qright_margin
;
551 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
552 extern Lisp_Object QCmap
;
554 Lisp_Object
recursive_edit_unwind (), command_loop ();
555 Lisp_Object
Fthis_command_keys ();
556 Lisp_Object Qextended_command_history
;
557 EMACS_TIME
timer_check ();
559 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
561 extern char *x_get_keysym_name ();
563 static void record_menu_key ();
564 static int echo_length ();
566 Lisp_Object Qpolling_period
;
568 /* List of absolute timers. Appears in order of next scheduled event. */
569 Lisp_Object Vtimer_list
;
571 /* List of idle time timers. Appears in order of next scheduled event. */
572 Lisp_Object Vtimer_idle_list
;
574 /* Incremented whenever a timer is run. */
577 extern Lisp_Object Vprint_level
, Vprint_length
;
579 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
581 EMACS_TIME
*input_available_clear_time
;
583 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
584 Default is 1 if INTERRUPT_INPUT is defined. */
587 /* Nonzero while interrupts are temporarily deferred during redisplay. */
588 int interrupts_deferred
;
590 /* Allow m- file to inhibit use of FIONREAD. */
591 #ifdef BROKEN_FIONREAD
595 /* We are unable to use interrupts if FIONREAD is not available,
596 so flush SIGIO so we won't try. */
597 #if !defined (FIONREAD)
603 /* If we support a window system, turn on the code to poll periodically
604 to detect C-g. It isn't actually used when doing interrupt input. */
605 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
606 #define POLL_FOR_INPUT
609 /* After a command is executed, if point is moved into a region that
610 has specific properties (e.g. composition, display), we adjust
611 point to the boundary of the region. But, if a command sets this
612 variable to non-nil, we suppress this point adjustment. This
613 variable is set to nil before reading a command. */
615 Lisp_Object Vdisable_point_adjustment
;
617 /* If non-nil, always disable point adjustment. */
619 Lisp_Object Vglobal_disable_point_adjustment
;
621 /* The time when Emacs started being idle. */
623 static EMACS_TIME timer_idleness_start_time
;
625 /* After Emacs stops being idle, this saves the last value
626 of timer_idleness_start_time from when it was idle. */
628 static EMACS_TIME timer_last_idleness_start_time
;
631 /* Global variable declarations. */
633 /* Flags for readable_events. */
634 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
635 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
636 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
638 /* Function for init_keyboard to call with no args (if nonzero). */
639 void (*keyboard_init_hook
) ();
641 static int read_avail_input
P_ ((int));
642 static void get_input_pending
P_ ((int *, int));
643 static int readable_events
P_ ((int));
644 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
645 Lisp_Object
, int *));
646 static Lisp_Object
read_char_x_menu_prompt ();
647 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
649 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
651 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
652 enum scroll_bar_part
,
653 Lisp_Object
, Lisp_Object
,
656 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
657 Lisp_Object
, char **,
658 Lisp_Object
*, unsigned));
659 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
660 static int parse_solitary_modifier
P_ ((Lisp_Object
));
661 static int parse_solitary_modifier ();
662 static void save_getcjmp
P_ ((jmp_buf));
663 static void save_getcjmp ();
664 static void restore_getcjmp
P_ ((jmp_buf));
665 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
666 static void clear_event
P_ ((struct input_event
*));
667 static void any_kboard_state
P_ ((void));
668 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
669 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
670 static void handle_interrupt
P_ ((void));
671 static void timer_start_idle
P_ ((void));
672 static void timer_stop_idle
P_ ((void));
673 static void timer_resume_idle
P_ ((void));
675 /* Nonzero means don't try to suspend even if the operating system seems
677 static int cannot_suspend
;
679 extern Lisp_Object Qidentity
, Qonly
;
681 /* Install the string STR as the beginning of the string of echoing,
682 so that it serves as a prompt for the next character.
683 Also start echoing. */
689 current_kboard
->echo_string
= str
;
690 current_kboard
->echo_after_prompt
= SCHARS (str
);
694 /* Add C to the echo string, if echoing is going on.
695 C can be a character, which is printed prettily ("M-C-x" and all that
696 jazz), or a symbol, whose name is printed. */
702 if (current_kboard
->immediate_echo
)
704 int size
= KEY_DESCRIPTION_SIZE
+ 100;
705 char *buffer
= (char *) alloca (size
);
707 Lisp_Object echo_string
;
709 echo_string
= current_kboard
->echo_string
;
711 /* If someone has passed us a composite event, use its head symbol. */
716 ptr
= push_key_description (XINT (c
), ptr
, 1);
718 else if (SYMBOLP (c
))
720 Lisp_Object name
= SYMBOL_NAME (c
);
721 int nbytes
= SBYTES (name
);
723 if (size
- (ptr
- buffer
) < nbytes
)
725 int offset
= ptr
- buffer
;
726 size
= max (2 * size
, size
+ nbytes
);
727 buffer
= (char *) alloca (size
);
728 ptr
= buffer
+ offset
;
731 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
732 STRING_MULTIBYTE (name
), 1);
735 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
738 const char *text
= " (Type ? for further options)";
739 int len
= strlen (text
);
741 if (size
- (ptr
- buffer
) < len
)
743 int offset
= ptr
- buffer
;
745 buffer
= (char *) alloca (size
);
746 ptr
= buffer
+ offset
;
749 bcopy (text
, ptr
, len
);
753 /* Replace a dash from echo_dash with a space, otherwise
754 add a space at the end as a separator between keys. */
755 if (STRINGP (echo_string
)
756 && SCHARS (echo_string
) > 1)
758 Lisp_Object last_char
, prev_char
, idx
;
760 idx
= make_number (SCHARS (echo_string
) - 2);
761 prev_char
= Faref (echo_string
, idx
);
763 idx
= make_number (SCHARS (echo_string
) - 1);
764 last_char
= Faref (echo_string
, idx
);
766 /* We test PREV_CHAR to make sure this isn't the echoing
768 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
769 Faset (echo_string
, idx
, make_number (' '));
771 echo_string
= concat2 (echo_string
, build_string (" "));
774 current_kboard
->echo_string
775 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
781 /* Temporarily add a dash to the end of the echo string if it's not
782 empty, so that it serves as a mini-prompt for the very next character. */
787 /* Do nothing if not echoing at all. */
788 if (NILP (current_kboard
->echo_string
))
791 if (!current_kboard
->immediate_echo
792 && SCHARS (current_kboard
->echo_string
) == 0)
795 /* Do nothing if we just printed a prompt. */
796 if (current_kboard
->echo_after_prompt
797 == SCHARS (current_kboard
->echo_string
))
800 /* Do nothing if we have already put a dash at the end. */
801 if (SCHARS (current_kboard
->echo_string
) > 1)
803 Lisp_Object last_char
, prev_char
, idx
;
805 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
806 prev_char
= Faref (current_kboard
->echo_string
, idx
);
808 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
809 last_char
= Faref (current_kboard
->echo_string
, idx
);
811 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
815 /* Put a dash at the end of the buffer temporarily,
816 but make it go away when the next character is added. */
817 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
822 /* Display the current echo string, and begin echoing if not already
828 if (!current_kboard
->immediate_echo
)
831 current_kboard
->immediate_echo
= 1;
833 for (i
= 0; i
< this_command_key_count
; i
++)
837 /* Set before_command_echo_length to the value that would
838 have been saved before the start of this subcommand in
839 command_loop_1, if we had already been echoing then. */
840 if (i
== this_single_command_key_start
)
841 before_command_echo_length
= echo_length ();
843 c
= XVECTOR (this_command_keys
)->contents
[i
];
844 if (! (EVENT_HAS_PARAMETERS (c
)
845 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
849 /* Set before_command_echo_length to the value that would
850 have been saved before the start of this subcommand in
851 command_loop_1, if we had already been echoing then. */
852 if (this_command_key_count
== this_single_command_key_start
)
853 before_command_echo_length
= echo_length ();
855 /* Put a dash at the end to invite the user to type more. */
860 message3_nolog (current_kboard
->echo_string
,
861 SBYTES (current_kboard
->echo_string
),
862 STRING_MULTIBYTE (current_kboard
->echo_string
));
865 /* Record in what buffer we echoed, and from which kboard. */
866 echo_message_buffer
= echo_area_buffer
[0];
867 echo_kboard
= current_kboard
;
869 if (waiting_for_input
&& !NILP (Vquit_flag
))
870 quit_throw_to_read_char ();
873 /* Turn off echoing, for the start of a new command. */
878 current_kboard
->immediate_echo
= 0;
879 current_kboard
->echo_after_prompt
= -1;
880 current_kboard
->echo_string
= Qnil
;
881 ok_to_echo_at_next_pause
= NULL
;
883 echo_message_buffer
= Qnil
;
886 /* Return the length of the current echo string. */
891 return (STRINGP (current_kboard
->echo_string
)
892 ? SCHARS (current_kboard
->echo_string
)
896 /* Truncate the current echo message to its first LEN chars.
897 This and echo_char get used by read_key_sequence when the user
898 switches frames while entering a key sequence. */
901 echo_truncate (nchars
)
904 if (STRINGP (current_kboard
->echo_string
))
905 current_kboard
->echo_string
906 = Fsubstring (current_kboard
->echo_string
,
907 make_number (0), make_number (nchars
));
908 truncate_echo_area (nchars
);
912 /* Functions for manipulating this_command_keys. */
914 add_command_key (key
)
917 #if 0 /* Not needed after we made Freset_this_command_lengths
918 do the job immediately. */
919 /* If reset-this-command-length was called recently, obey it now.
920 See the doc string of that function for an explanation of why. */
921 if (before_command_restore_flag
)
923 this_command_key_count
= before_command_key_count_1
;
924 if (this_command_key_count
< this_single_command_key_start
)
925 this_single_command_key_start
= this_command_key_count
;
926 echo_truncate (before_command_echo_length_1
);
927 before_command_restore_flag
= 0;
931 if (this_command_key_count
>= ASIZE (this_command_keys
))
932 this_command_keys
= larger_vector (this_command_keys
,
933 2 * ASIZE (this_command_keys
),
936 AREF (this_command_keys
, this_command_key_count
) = key
;
937 ++this_command_key_count
;
944 int count
= SPECPDL_INDEX ();
947 if (command_loop_level
> 0)
949 specbind (Qstandard_output
, Qt
);
950 specbind (Qstandard_input
, Qt
);
953 #ifdef HAVE_X_WINDOWS
954 /* The command loop has started an hourglass timer, so we have to
955 cancel it here, otherwise it will fire because the recursive edit
956 can take some time. Do not check for display_hourglass_p here,
957 because it could already be nil. */
961 /* This function may have been called from a debugger called from
962 within redisplay, for instance by Edebugging a function called
963 from fontification-functions. We want to allow redisplay in
964 the debugging session.
966 The recursive edit is left with a `(throw exit ...)'. The `exit'
967 tag is not caught anywhere in redisplay, i.e. when we leave the
968 recursive edit, the original redisplay leading to the recursive
969 edit will be unwound. The outcome should therefore be safe. */
970 specbind (Qinhibit_redisplay
, Qnil
);
973 val
= command_loop ();
975 Fsignal (Qquit
, Qnil
);
976 /* Handle throw from read_minibuf when using minibuffer
977 while it's active but we're in another window. */
979 Fsignal (Qerror
, Fcons (val
, Qnil
));
981 return unbind_to (count
, Qnil
);
984 /* When an auto-save happens, record the "time", and don't do again soon. */
989 last_auto_save
= num_nonmacro_input_events
;
992 /* Make an auto save happen as soon as possible at command level. */
995 force_auto_save_soon ()
997 last_auto_save
= - auto_save_interval
- 1;
999 record_asynch_buffer_change ();
1002 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1003 doc
: /* Invoke the editor command loop recursively.
1004 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1005 that tells this function to return.
1006 Alternatively, `(throw 'exit t)' makes this function signal an error.
1007 This function is called by the editor initialization to begin editing. */)
1010 int count
= SPECPDL_INDEX ();
1013 /* If we enter while input is blocked, don't lock up here.
1014 This may happen through the debugger during redisplay. */
1015 if (INPUT_BLOCKED_P
)
1018 command_loop_level
++;
1019 update_mode_lines
= 1;
1021 if (command_loop_level
1022 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1023 buffer
= Fcurrent_buffer ();
1027 /* If we leave recursive_edit_1 below with a `throw' for instance,
1028 like it is done in the splash screen display, we have to
1029 make sure that we restore single_kboard as command_loop_1
1030 would have done if it were left normally. */
1031 temporarily_switch_to_single_kboard (FRAME_KBOARD (SELECTED_FRAME ()));
1032 record_unwind_protect (recursive_edit_unwind
, buffer
);
1034 recursive_edit_1 ();
1035 return unbind_to (count
, Qnil
);
1039 recursive_edit_unwind (buffer
)
1042 if (BUFFERP (buffer
))
1043 Fset_buffer (buffer
);
1045 command_loop_level
--;
1046 update_mode_lines
= 1;
1055 #if 0 /* Theory: if there's anything in Vunread_command_events,
1056 it will right away be read by read_key_sequence,
1057 and then if we do switch KBOARDS, it will go into the side
1058 queue then. So we don't need to do anything special here -- rms. */
1059 if (CONSP (Vunread_command_events
))
1061 current_kboard
->kbd_queue
1062 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1063 current_kboard
->kbd_queue_has_data
= 1;
1065 Vunread_command_events
= Qnil
;
1071 /* Switch to the single-kboard state, making current_kboard
1072 the only KBOARD from which further input is accepted. */
1075 single_kboard_state ()
1082 /* If we're in single_kboard state for kboard KBOARD,
1086 not_single_kboard_state (kboard
)
1090 if (kboard
== current_kboard
)
1095 /* Maintain a stack of kboards, so other parts of Emacs
1096 can switch temporarily to the kboard of a given frame
1097 and then revert to the previous status. */
1102 struct kboard_stack
*next
;
1105 static struct kboard_stack
*kboard_stack
;
1112 struct kboard_stack
*p
1113 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1115 p
->next
= kboard_stack
;
1116 p
->kboard
= current_kboard
;
1124 push_frame_kboard (f
)
1127 push_kboard (f
->device
->kboard
);
1135 struct kboard_stack
*p
= kboard_stack
;
1137 current_kboard
= NULL
;
1138 for (d
= device_list
; d
; d
= d
->next_device
)
1140 if (d
->kboard
== p
->kboard
)
1142 current_kboard
= p
->kboard
;
1146 if (current_kboard
== NULL
)
1148 /* The display we remembered has been deleted. */
1149 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1151 kboard_stack
= p
->next
;
1156 /* Switch to single_kboard mode. If K is non-nil, set it as the
1157 current keyboard. Use record_unwind_protect to return to the
1158 previous state later. */
1161 temporarily_switch_to_single_kboard (k
)
1165 int was_locked
= single_kboard
;
1169 push_kboard (current_kboard
);
1170 single_kboard_state ();
1171 record_unwind_protect (restore_kboard_configuration
,
1172 (was_locked
? Qt
: Qnil
));
1177 record_single_kboard_state ()
1179 push_kboard (current_kboard
);
1180 record_unwind_protect (restore_kboard_configuration
,
1181 (single_kboard
? Qt
: Qnil
));
1185 restore_kboard_configuration (was_locked
)
1186 Lisp_Object was_locked
;
1188 if (NILP (was_locked
))
1189 any_kboard_state ();
1191 single_kboard_state ();
1196 /* Handle errors that are not handled at inner levels
1197 by printing an error message and returning to the editor command loop. */
1203 Lisp_Object old_level
, old_length
;
1204 char macroerror
[50];
1206 #ifdef HAVE_X_WINDOWS
1207 if (display_hourglass_p
)
1208 cancel_hourglass ();
1211 if (!NILP (executing_kbd_macro
))
1213 if (executing_kbd_macro_iterations
== 1)
1214 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1216 sprintf (macroerror
, "After %d kbd macro iterations: ",
1217 executing_kbd_macro_iterations
);
1222 Vstandard_output
= Qt
;
1223 Vstandard_input
= Qt
;
1224 Vexecuting_kbd_macro
= Qnil
;
1225 executing_kbd_macro
= Qnil
;
1226 current_kboard
->Vprefix_arg
= Qnil
;
1227 current_kboard
->Vlast_prefix_arg
= Qnil
;
1230 /* Avoid unquittable loop if data contains a circular list. */
1231 old_level
= Vprint_level
;
1232 old_length
= Vprint_length
;
1233 XSETFASTINT (Vprint_level
, 10);
1234 XSETFASTINT (Vprint_length
, 10);
1235 cmd_error_internal (data
, macroerror
);
1236 Vprint_level
= old_level
;
1237 Vprint_length
= old_length
;
1241 Vinhibit_quit
= Qnil
;
1243 if (command_loop_level
== 0 && minibuf_level
== 0)
1244 any_kboard_state ();
1247 return make_number (0);
1250 /* Take actions on handling an error. DATA is the data that describes
1253 CONTEXT is a C-string containing ASCII characters only which
1254 describes the context in which the error happened. If we need to
1255 generalize CONTEXT to allow multibyte characters, make it a Lisp
1259 cmd_error_internal (data
, context
)
1264 int kill_emacs_p
= 0;
1265 struct frame
*sf
= SELECTED_FRAME ();
1269 clear_message (1, 0);
1271 /* If the window system or terminal frame hasn't been initialized
1272 yet, or we're not interactive, it's best to dump this message out
1273 to stderr and exit. */
1274 if (!sf
->glyphs_initialized_p
1275 || FRAME_INITIAL_P (sf
)
1278 stream
= Qexternal_debugging_output
;
1284 message_log_maybe_newline ();
1289 /* The immediate context is not interesting for Quits,
1290 since they are asyncronous. */
1291 if (EQ (XCAR (data
), Qquit
))
1292 Vsignaling_function
= Qnil
;
1294 print_error_message (data
, stream
, context
, Vsignaling_function
);
1296 Vsignaling_function
= Qnil
;
1298 /* If the window system or terminal frame hasn't been initialized
1299 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1303 Fkill_emacs (make_number (-1));
1307 Lisp_Object
command_loop_1 ();
1308 Lisp_Object
command_loop_2 ();
1309 Lisp_Object
top_level_1 ();
1311 /* Entry to editor-command-loop.
1312 This level has the catches for exiting/returning to editor command loop.
1313 It returns nil to exit recursive edit, t to abort it. */
1318 if (command_loop_level
> 0 || minibuf_level
> 0)
1321 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1322 executing_kbd_macro
= Qnil
;
1328 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1329 /* Reset single_kboard in case top-level set it while
1330 evaluating an -f option, or we are stuck there for some
1332 any_kboard_state ();
1333 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1334 executing_kbd_macro
= Qnil
;
1336 /* End of file in -batch run causes exit here. */
1342 /* Here we catch errors in execution of commands within the
1343 editing loop, and reenter the editing loop.
1344 When there is an error, cmd_error runs and returns a non-nil
1345 value to us. A value of nil means that command_loop_1 itself
1346 returned due to end of file (or end of kbd macro). */
1351 register Lisp_Object val
;
1354 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1355 while (!NILP (val
));
1363 return Feval (Vtop_level
);
1369 /* On entry to the outer level, run the startup file */
1370 if (!NILP (Vtop_level
))
1371 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1372 else if (!NILP (Vpurify_flag
))
1373 message ("Bare impure Emacs (standard Lisp code not loaded)");
1375 message ("Bare Emacs (standard Lisp code not loaded)");
1379 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1380 doc
: /* Exit all recursive editing levels. */)
1383 #ifdef HAVE_X_WINDOWS
1384 if (display_hourglass_p
)
1385 cancel_hourglass ();
1388 /* Unblock input if we enter with input blocked. This may happen if
1389 redisplay traps e.g. during tool-bar update with input blocked. */
1390 while (INPUT_BLOCKED_P
)
1393 return Fthrow (Qtop_level
, Qnil
);
1396 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1397 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1400 if (command_loop_level
> 0 || minibuf_level
> 0)
1401 Fthrow (Qexit
, Qnil
);
1403 error ("No recursive edit is in progress");
1407 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1408 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1411 if (command_loop_level
> 0 || minibuf_level
> 0)
1414 error ("No recursive edit is in progress");
1418 /* This is the actual command reading loop,
1419 sans error-handling encapsulation. */
1421 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1423 void safe_run_hooks
P_ ((Lisp_Object
));
1424 static void adjust_point_for_property
P_ ((int, int));
1426 /* Cancel hourglass from protect_unwind.
1428 #ifdef HAVE_X_WINDOWS
1430 cancel_hourglass_unwind (arg
)
1433 cancel_hourglass ();
1444 Lisp_Object keybuf
[30];
1447 int prev_modiff
= 0;
1448 struct buffer
*prev_buffer
= NULL
;
1450 int was_locked
= single_kboard
;
1452 int already_adjusted
= 0;
1454 current_kboard
->Vprefix_arg
= Qnil
;
1455 current_kboard
->Vlast_prefix_arg
= Qnil
;
1456 Vdeactivate_mark
= Qnil
;
1457 waiting_for_input
= 0;
1461 this_command_key_count
= 0;
1462 this_command_key_count_reset
= 0;
1463 this_single_command_key_start
= 0;
1465 if (NILP (Vmemory_full
))
1467 /* Make sure this hook runs after commands that get errors and
1468 throw to top level. */
1469 /* Note that the value cell will never directly contain nil
1470 if the symbol is a local variable. */
1471 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1472 safe_run_hooks (Qpost_command_hook
);
1474 /* If displaying a message, resize the echo area window to fit
1475 that message's size exactly. */
1476 if (!NILP (echo_area_buffer
[0]))
1477 resize_echo_area_exactly ();
1479 if (!NILP (Vdeferred_action_list
))
1480 safe_run_hooks (Qdeferred_action_function
);
1483 /* Do this after running Vpost_command_hook, for consistency. */
1484 current_kboard
->Vlast_command
= Vthis_command
;
1485 current_kboard
->Vreal_last_command
= real_this_command
;
1489 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1492 /* Make sure the current window's buffer is selected. */
1493 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1494 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1496 /* Display any malloc warning that just came out. Use while because
1497 displaying one warning can cause another. */
1499 while (pending_malloc_warning
)
1500 display_malloc_warning ();
1504 Vdeactivate_mark
= Qnil
;
1506 /* If minibuffer on and echo area in use,
1507 wait a short time and redraw minibuffer. */
1510 && !NILP (echo_area_buffer
[0])
1511 && EQ (minibuf_window
, echo_area_window
)
1512 && NUMBERP (Vminibuffer_message_timeout
))
1514 /* Bind inhibit-quit to t so that C-g gets read in
1515 rather than quitting back to the minibuffer. */
1516 int count
= SPECPDL_INDEX ();
1517 specbind (Qinhibit_quit
, Qt
);
1519 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1520 /* Clear the echo area. */
1522 safe_run_hooks (Qecho_area_clear_hook
);
1524 unbind_to (count
, Qnil
);
1526 /* If a C-g came in before, treat it as input now. */
1527 if (!NILP (Vquit_flag
))
1530 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1535 alloca (0); /* Cause a garbage collection now */
1536 /* Since we can free the most stuff here. */
1537 #endif /* C_ALLOCA */
1540 /* Select the frame that the last event came from. Usually,
1541 switch-frame events will take care of this, but if some lisp
1542 code swallows a switch-frame event, we'll fix things up here.
1543 Is this a good idea? */
1544 if (FRAMEP (internal_last_event_frame
)
1545 && !EQ (internal_last_event_frame
, selected_frame
))
1546 Fselect_frame (internal_last_event_frame
);
1548 /* If it has changed current-menubar from previous value,
1549 really recompute the menubar from the value. */
1550 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1551 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1552 call0 (Qrecompute_lucid_menubar
);
1554 before_command_key_count
= this_command_key_count
;
1555 before_command_echo_length
= echo_length ();
1557 Vthis_command
= Qnil
;
1558 real_this_command
= Qnil
;
1559 Vthis_original_command
= Qnil
;
1561 /* Read next key sequence; i gets its length. */
1562 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1565 /* A filter may have run while we were reading the input. */
1566 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1568 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1569 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1573 /* Now we have read a key sequence of length I,
1574 or else I is 0 and we found end of file. */
1576 if (i
== 0) /* End of file -- happens only in */
1577 return Qnil
; /* a kbd macro, at the end. */
1578 /* -1 means read_key_sequence got a menu that was rejected.
1579 Just loop around and read another command. */
1583 this_command_key_count
= 0;
1584 this_command_key_count_reset
= 0;
1585 this_single_command_key_start
= 0;
1589 last_command_char
= keybuf
[i
- 1];
1591 /* If the previous command tried to force a specific window-start,
1592 forget about that, in case this command moves point far away
1593 from that position. But also throw away beg_unchanged and
1594 end_unchanged information in that case, so that redisplay will
1595 update the whole window properly. */
1596 if (!NILP (XWINDOW (selected_window
)->force_start
))
1599 XWINDOW (selected_window
)->force_start
= Qnil
;
1600 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1601 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1604 cmd
= read_key_sequence_cmd
;
1605 if (!NILP (Vexecuting_kbd_macro
))
1607 if (!NILP (Vquit_flag
))
1609 Vexecuting_kbd_macro
= Qt
;
1610 QUIT
; /* Make some noise. */
1611 /* Will return since macro now empty. */
1615 /* Do redisplay processing after this command except in special
1616 cases identified below. */
1617 prev_buffer
= current_buffer
;
1618 prev_modiff
= MODIFF
;
1619 last_point_position
= PT
;
1620 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1622 /* By default, we adjust point to a boundary of a region that
1623 has such a property that should be treated intangible
1624 (e.g. composition, display). But, some commands will set
1625 this variable differently. */
1626 Vdisable_point_adjustment
= Qnil
;
1628 /* Process filters and timers may have messed with deactivate-mark.
1629 reset it before we execute the command. */
1630 Vdeactivate_mark
= Qnil
;
1632 /* Remap command through active keymaps */
1633 Vthis_original_command
= cmd
;
1637 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1641 /* Execute the command. */
1643 Vthis_command
= cmd
;
1644 real_this_command
= cmd
;
1645 /* Note that the value cell will never directly contain nil
1646 if the symbol is a local variable. */
1647 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1648 safe_run_hooks (Qpre_command_hook
);
1650 already_adjusted
= 0;
1652 if (NILP (Vthis_command
))
1654 /* nil means key is undefined. */
1655 Lisp_Object keys
= Fvector (i
, keybuf
);
1656 keys
= Fkey_description (keys
, Qnil
);
1658 message_with_string ("%s is undefined", keys
, 0);
1659 current_kboard
->defining_kbd_macro
= Qnil
;
1660 update_mode_lines
= 1;
1661 current_kboard
->Vprefix_arg
= Qnil
;
1665 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1667 /* In case we jump to directly_done. */
1668 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1670 /* Recognize some common commands in common situations and
1671 do them directly. */
1672 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1674 struct Lisp_Char_Table
*dp
1675 = window_display_table (XWINDOW (selected_window
));
1676 lose
= FETCH_CHAR (PT_BYTE
);
1678 if (! NILP (Vpost_command_hook
))
1679 /* Put this before calling adjust_point_for_property
1680 so it will only get called once in any case. */
1682 if (current_buffer
== prev_buffer
1683 && last_point_position
!= PT
1684 && NILP (Vdisable_point_adjustment
)
1685 && NILP (Vglobal_disable_point_adjustment
))
1686 adjust_point_for_property (last_point_position
, 0);
1687 already_adjusted
= 1;
1688 if (PT
== last_point_position
+ 1
1690 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1691 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1692 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1693 && (lose
>= 0x20 && lose
< 0x7f)))
1694 : (lose
>= 0x20 && lose
< 0x7f))
1695 /* To extract the case of continuation on
1696 wide-column characters. */
1697 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1698 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1700 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1702 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1704 && !windows_or_buffers_changed
1705 && EQ (current_buffer
->selective_display
, Qnil
)
1706 && !detect_input_pending ()
1707 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1708 && NILP (Vexecuting_kbd_macro
))
1709 direct_output_forward_char (1);
1712 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1714 struct Lisp_Char_Table
*dp
1715 = window_display_table (XWINDOW (selected_window
));
1717 lose
= FETCH_CHAR (PT_BYTE
);
1718 if (! NILP (Vpost_command_hook
))
1720 if (current_buffer
== prev_buffer
1721 && last_point_position
!= PT
1722 && NILP (Vdisable_point_adjustment
)
1723 && NILP (Vglobal_disable_point_adjustment
))
1724 adjust_point_for_property (last_point_position
, 0);
1725 already_adjusted
= 1;
1726 if (PT
== last_point_position
- 1
1728 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1729 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1730 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1731 && (lose
>= 0x20 && lose
< 0x7f)))
1732 : (lose
>= 0x20 && lose
< 0x7f))
1733 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1735 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1737 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1739 && !windows_or_buffers_changed
1740 && EQ (current_buffer
->selective_display
, Qnil
)
1741 && !detect_input_pending ()
1742 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1743 && NILP (Vexecuting_kbd_macro
))
1744 direct_output_forward_char (-1);
1747 else if (EQ (Vthis_command
, Qself_insert_command
)
1748 /* Try this optimization only on char keystrokes. */
1749 && NATNUMP (last_command_char
)
1750 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1753 = translate_char (Vtranslation_table_for_input
,
1754 XFASTINT (last_command_char
), 0, 0, 0);
1756 if (NILP (Vexecuting_kbd_macro
)
1757 && !EQ (minibuf_window
, selected_window
))
1759 if (!nonundocount
|| nonundocount
>= 20)
1767 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1769 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1771 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1773 || MODIFF
<= SAVE_MODIFF
1774 || windows_or_buffers_changed
1775 || !EQ (current_buffer
->selective_display
, Qnil
)
1776 || detect_input_pending ()
1777 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1778 || !NILP (Vexecuting_kbd_macro
));
1780 value
= internal_self_insert (c
, 0);
1785 if (! NILP (Vpost_command_hook
))
1786 /* Put this before calling adjust_point_for_property
1787 so it will only get called once in any case. */
1790 /* VALUE == 1 when AFTER-CHANGE functions are
1791 installed which is the case most of the time
1792 because FONT-LOCK installs one. */
1793 if (!lose
&& !value
)
1794 direct_output_for_insert (c
);
1799 /* Here for a command that isn't executed directly */
1802 #ifdef HAVE_X_WINDOWS
1803 int scount
= SPECPDL_INDEX ();
1805 if (display_hourglass_p
1806 && NILP (Vexecuting_kbd_macro
))
1808 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1814 if (NILP (current_kboard
->Vprefix_arg
))
1816 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1818 #ifdef HAVE_X_WINDOWS
1819 /* Do not check display_hourglass_p here, because
1820 Fcommand_execute could change it, but we should cancel
1821 hourglass cursor anyway.
1822 But don't cancel the hourglass within a macro
1823 just because a command in the macro finishes. */
1824 if (NILP (Vexecuting_kbd_macro
))
1825 unbind_to (scount
, Qnil
);
1830 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1832 /* Note that the value cell will never directly contain nil
1833 if the symbol is a local variable. */
1834 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1835 safe_run_hooks (Qpost_command_hook
);
1837 /* If displaying a message, resize the echo area window to fit
1838 that message's size exactly. */
1839 if (!NILP (echo_area_buffer
[0]))
1840 resize_echo_area_exactly ();
1842 if (!NILP (Vdeferred_action_list
))
1843 safe_run_hooks (Qdeferred_action_function
);
1845 /* If there is a prefix argument,
1846 1) We don't want Vlast_command to be ``universal-argument''
1847 (that would be dumb), so don't set Vlast_command,
1848 2) we want to leave echoing on so that the prefix will be
1849 echoed as part of this key sequence, so don't call
1851 3) we want to leave this_command_key_count non-zero, so that
1852 read_char will realize that it is re-reading a character, and
1853 not echo it a second time.
1855 If the command didn't actually create a prefix arg,
1856 but is merely a frame event that is transparent to prefix args,
1857 then the above doesn't apply. */
1858 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1860 current_kboard
->Vlast_command
= Vthis_command
;
1861 current_kboard
->Vreal_last_command
= real_this_command
;
1863 this_command_key_count
= 0;
1864 this_command_key_count_reset
= 0;
1865 this_single_command_key_start
= 0;
1868 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1870 /* Setting transient-mark-mode to `only' is a way of
1871 turning it on for just one command. */
1873 if (EQ (Vtransient_mark_mode
, Qidentity
))
1874 Vtransient_mark_mode
= Qnil
;
1875 if (EQ (Vtransient_mark_mode
, Qonly
))
1876 Vtransient_mark_mode
= Qidentity
;
1878 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1880 /* We could also call `deactivate'mark'. */
1881 if (EQ (Vtransient_mark_mode
, Qlambda
))
1882 Vtransient_mark_mode
= Qnil
;
1885 current_buffer
->mark_active
= Qnil
;
1886 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1889 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1890 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1895 if (current_buffer
== prev_buffer
1896 && last_point_position
!= PT
1897 && NILP (Vdisable_point_adjustment
)
1898 && NILP (Vglobal_disable_point_adjustment
)
1899 && !already_adjusted
)
1900 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1902 /* Install chars successfully executed in kbd macro. */
1904 if (!NILP (current_kboard
->defining_kbd_macro
)
1905 && NILP (current_kboard
->Vprefix_arg
))
1906 finalize_kbd_macro_chars ();
1910 any_kboard_state ();
1915 extern Lisp_Object Qcomposition
, Qdisplay
;
1917 /* Adjust point to a boundary of a region that has such a property
1918 that should be treated intangible. For the moment, we check
1919 `composition', `display' and `invisible' properties.
1920 LAST_PT is the last position of point. */
1922 extern Lisp_Object Qafter_string
, Qbefore_string
;
1923 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1926 adjust_point_for_property (last_pt
, modified
)
1931 Lisp_Object val
, overlay
, tmp
;
1932 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1935 /* FIXME: cycling is probably not necessary because these properties
1936 can't be usefully combined anyway. */
1937 while (check_composition
|| check_display
|| check_invisible
)
1939 if (check_composition
1940 && PT
> BEGV
&& PT
< ZV
1941 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1942 && COMPOSITION_VALID_P (beg
, end
, val
)
1943 && beg
< PT
/* && end > PT <- It's always the case. */
1944 && (last_pt
<= beg
|| last_pt
>= end
))
1947 SET_PT (PT
< last_pt
? beg
: end
);
1948 check_display
= check_invisible
= 1;
1950 check_composition
= 0;
1952 && PT
> BEGV
&& PT
< ZV
1953 && !NILP (val
= get_char_property_and_overlay
1954 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1955 && display_prop_intangible_p (val
)
1956 && (!OVERLAYP (overlay
)
1957 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1958 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1959 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1960 && (beg
< PT
/* && end > PT <- It's always the case. */
1961 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1964 SET_PT (PT
< last_pt
1965 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1967 check_composition
= check_invisible
= 1;
1970 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1972 int inv
, ellipsis
= 0;
1975 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1977 && !NILP (val
= get_char_property_and_overlay
1978 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1979 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1981 ellipsis
= ellipsis
|| inv
> 1
1982 || (OVERLAYP (overlay
)
1983 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1984 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1985 tmp
= Fnext_single_char_property_change
1986 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1987 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1990 && !NILP (val
= get_char_property_and_overlay
1991 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1992 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1994 ellipsis
= ellipsis
|| inv
> 1
1995 || (OVERLAYP (overlay
)
1996 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1997 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1998 tmp
= Fprevious_single_char_property_change
1999 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2000 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2003 /* Move away from the inside area. */
2004 if (beg
< PT
&& end
> PT
)
2006 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2007 /* We haven't moved yet (so we don't need to fear
2008 infinite-looping) and we were outside the range
2009 before (so either end of the range still corresponds
2010 to a move in the right direction): pretend we moved
2011 less than we actually did, so that we still have
2012 more freedom below in choosing which end of the range
2014 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2015 /* We either have moved already or the last point
2016 was already in the range: we don't get to choose
2017 which end of the range we have to go to. */
2018 : (PT
< last_pt
? beg
: end
));
2019 check_composition
= check_display
= 1;
2021 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2022 the point to something other than its argument, due to
2023 point-motion hooks, intangibility, etc. */
2024 xassert (PT
== beg
|| PT
== end
);
2027 /* Pretend the area doesn't exist if the buffer is not
2029 if (!modified
&& !ellipsis
&& beg
< end
)
2031 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2032 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2033 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2034 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2035 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2036 /* We've already moved as far as we can. Trying to go
2037 to the other end would mean moving backwards and thus
2038 could lead to an infinite loop. */
2040 else if (val
= get_pos_property (make_number (PT
),
2042 TEXT_PROP_MEANS_INVISIBLE (val
)
2043 && (val
= get_pos_property
2044 (make_number (PT
== beg
? end
: beg
),
2046 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2047 (check_composition
= check_display
= 1,
2048 SET_PT (PT
== beg
? end
: beg
));
2051 check_invisible
= 0;
2055 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2058 safe_run_hooks_1 (hook
)
2061 return call1 (Vrun_hooks
, Vinhibit_quit
);
2064 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2067 safe_run_hooks_error (data
)
2070 Lisp_Object args
[3];
2071 args
[0] = build_string ("Error in %s: %s");
2072 args
[1] = Vinhibit_quit
;
2075 return Fset (Vinhibit_quit
, Qnil
);
2078 /* If we get an error while running the hook, cause the hook variable
2079 to be nil. Also inhibit quits, so that C-g won't cause the hook
2080 to mysteriously evaporate. */
2083 safe_run_hooks (hook
)
2086 int count
= SPECPDL_INDEX ();
2087 specbind (Qinhibit_quit
, hook
);
2089 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2091 unbind_to (count
, Qnil
);
2095 /* Number of seconds between polling for input. This is a Lisp
2096 variable that can be bound. */
2098 EMACS_INT polling_period
;
2100 /* Nonzero means polling for input is temporarily suppressed. */
2102 int poll_suppress_count
;
2104 /* Asynchronous timer for polling. */
2106 struct atimer
*poll_timer
;
2109 #ifdef POLL_FOR_INPUT
2111 /* Poll for input, so what we catch a C-g if it comes in. This
2112 function is called from x_make_frame_visible, see comment
2118 if (interrupt_input_blocked
== 0
2119 && !waiting_for_input
)
2120 read_avail_input (0);
2123 /* Timer callback function for poll_timer. TIMER is equal to
2127 poll_for_input (timer
)
2128 struct atimer
*timer
;
2130 if (poll_suppress_count
== 0)
2132 interrupt_input_pending
= 1;
2134 poll_for_input_1 ();
2138 #endif /* POLL_FOR_INPUT */
2140 /* Begin signals to poll for input, if they are appropriate.
2141 This function is called unconditionally from various places. */
2146 #ifdef POLL_FOR_INPUT
2147 /* XXX This condition was (read_socket_hook && !interrupt_input),
2148 but read_socket_hook is not global anymore. Let's pretend that
2150 if (!interrupt_input
)
2152 /* Turn alarm handling on unconditionally. It might have
2153 been turned off in process.c. */
2154 turn_on_atimers (1);
2156 /* If poll timer doesn't exist, are we need one with
2157 a different interval, start a new one. */
2158 if (poll_timer
== NULL
2159 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2161 EMACS_TIME interval
;
2164 cancel_atimer (poll_timer
);
2166 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2167 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2168 poll_for_input
, NULL
);
2171 /* Let the timer's callback function poll for input
2172 if this becomes zero. */
2173 --poll_suppress_count
;
2178 /* Nonzero if we are using polling to handle input asynchronously. */
2181 input_polling_used ()
2183 #ifdef POLL_FOR_INPUT
2184 /* XXX This condition was (read_socket_hook && !interrupt_input),
2185 but read_socket_hook is not global anymore. Let's pretend that
2187 return !interrupt_input
;
2193 /* Turn off polling. */
2198 #ifdef POLL_FOR_INPUT
2199 /* XXX This condition was (read_socket_hook && !interrupt_input),
2200 but read_socket_hook is not global anymore. Let's pretend that
2202 if (!interrupt_input
)
2203 ++poll_suppress_count
;
2207 /* Set the value of poll_suppress_count to COUNT
2208 and start or stop polling accordingly. */
2211 set_poll_suppress_count (count
)
2214 #ifdef POLL_FOR_INPUT
2215 if (count
== 0 && poll_suppress_count
!= 0)
2217 poll_suppress_count
= 1;
2220 else if (count
!= 0 && poll_suppress_count
== 0)
2224 poll_suppress_count
= count
;
2228 /* Bind polling_period to a value at least N.
2229 But don't decrease it. */
2232 bind_polling_period (n
)
2235 #ifdef POLL_FOR_INPUT
2236 int new = polling_period
;
2241 stop_other_atimers (poll_timer
);
2243 specbind (Qpolling_period
, make_number (new));
2244 /* Start a new alarm with the new period. */
2249 /* Apply the control modifier to CHARACTER. */
2255 /* Save the upper bits here. */
2256 int upper
= c
& ~0177;
2260 /* Everything in the columns containing the upper-case letters
2261 denotes a control character. */
2262 if (c
>= 0100 && c
< 0140)
2266 /* Set the shift modifier for a control char
2267 made from a shifted letter. But only for letters! */
2268 if (oc
>= 'A' && oc
<= 'Z')
2269 c
|= shift_modifier
;
2272 /* The lower-case letters denote control characters too. */
2273 else if (c
>= 'a' && c
<= 'z')
2276 /* Include the bits for control and shift
2277 only if the basic ASCII code can't indicate them. */
2281 /* Replace the high bits. */
2282 c
|= (upper
& ~ctrl_modifier
);
2287 /* Display the help-echo property of the character after the mouse pointer.
2288 Either show it in the echo area, or call show-help-function to display
2289 it by other means (maybe in a tooltip).
2291 If HELP is nil, that means clear the previous help echo.
2293 If HELP is a string, display that string. If HELP is a function,
2294 call it with OBJECT and POS as arguments; the function should
2295 return a help string or nil for none. For all other types of HELP,
2296 evaluate it to obtain a string.
2298 WINDOW is the window in which the help was generated, if any.
2299 It is nil if not in a window.
2301 If OBJECT is a buffer, POS is the position in the buffer where the
2302 `help-echo' text property was found.
2304 If OBJECT is an overlay, that overlay has a `help-echo' property,
2305 and POS is the position in the overlay's buffer under the mouse.
2307 If OBJECT is a string (an overlay string or a string displayed with
2308 the `display' property). POS is the position in that string under
2311 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2312 echo overwrites a keystroke echo currently displayed in the echo
2315 Note: this function may only be called with HELP nil or a string
2316 from X code running asynchronously. */
2319 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2320 Lisp_Object help
, window
, object
, pos
;
2321 int ok_to_overwrite_keystroke_echo
;
2323 if (!NILP (help
) && !STRINGP (help
))
2325 if (FUNCTIONP (help
))
2327 Lisp_Object args
[4];
2332 help
= safe_call (4, args
);
2335 help
= safe_eval (help
);
2337 if (!STRINGP (help
))
2342 if (!noninteractive
&& STRINGP (help
))
2343 help
= call1 (Qmouse_fixup_help_message
, help
);
2346 if (STRINGP (help
) || NILP (help
))
2348 if (!NILP (Vshow_help_function
))
2349 call1 (Vshow_help_function
, help
);
2350 else if (/* Don't overwrite minibuffer contents. */
2351 !MINI_WINDOW_P (XWINDOW (selected_window
))
2352 /* Don't overwrite a keystroke echo. */
2353 && (NILP (echo_message_buffer
)
2354 || ok_to_overwrite_keystroke_echo
)
2355 /* Don't overwrite a prompt. */
2356 && !cursor_in_echo_area
)
2360 int count
= SPECPDL_INDEX ();
2362 if (!help_echo_showing_p
)
2363 Vpre_help_message
= current_message ();
2365 specbind (Qmessage_truncate_lines
, Qt
);
2366 message3_nolog (help
, SBYTES (help
),
2367 STRING_MULTIBYTE (help
));
2368 unbind_to (count
, Qnil
);
2370 else if (STRINGP (Vpre_help_message
))
2372 message3_nolog (Vpre_help_message
,
2373 SBYTES (Vpre_help_message
),
2374 STRING_MULTIBYTE (Vpre_help_message
));
2375 Vpre_help_message
= Qnil
;
2381 help_echo_showing_p
= STRINGP (help
);
2387 /* Input of single characters from keyboard */
2389 Lisp_Object
print_help ();
2390 static Lisp_Object
kbd_buffer_get_event ();
2391 static void record_char ();
2394 static jmp_buf wrong_kboard_jmpbuf
;
2397 #define STOP_POLLING \
2398 do { if (! polling_stopped_here) stop_polling (); \
2399 polling_stopped_here = 1; } while (0)
2401 #define RESUME_POLLING \
2402 do { if (polling_stopped_here) start_polling (); \
2403 polling_stopped_here = 0; } while (0)
2405 /* read a character from the keyboard; call the redisplay if needed */
2406 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2407 -1 means do not do redisplay, but do do autosaving.
2410 /* The arguments MAPS and NMAPS are for menu prompting.
2411 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2413 PREV_EVENT is the previous input event, or nil if we are reading
2414 the first event of a key sequence (or not reading a key sequence).
2415 If PREV_EVENT is t, that is a "magic" value that says
2416 not to run input methods, but in other respects to act as if
2417 not reading a key sequence.
2419 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2420 if we used a mouse menu to read the input, or zero otherwise. If
2421 USED_MOUSE_MENU is null, we don't dereference it.
2423 Value is t if we showed a menu and the user rejected it. */
2426 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2430 Lisp_Object prev_event
;
2431 int *used_mouse_menu
;
2433 volatile Lisp_Object c
;
2435 jmp_buf local_getcjmp
;
2437 volatile int key_already_recorded
= 0;
2438 Lisp_Object tem
, save
;
2439 volatile Lisp_Object previous_echo_area_message
;
2440 volatile Lisp_Object also_record
;
2441 volatile int reread
;
2442 struct gcpro gcpro1
, gcpro2
;
2443 int polling_stopped_here
= 0;
2447 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2448 before_command_key_count
= this_command_key_count
;
2449 before_command_echo_length
= echo_length ();
2452 previous_echo_area_message
= Qnil
;
2454 GCPRO2 (c
, previous_echo_area_message
);
2459 if (CONSP (Vunread_post_input_method_events
))
2461 c
= XCAR (Vunread_post_input_method_events
);
2462 Vunread_post_input_method_events
2463 = XCDR (Vunread_post_input_method_events
);
2465 /* Undo what read_char_x_menu_prompt did when it unread
2466 additional keys returned by Fx_popup_menu. */
2468 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2476 if (unread_command_char
!= -1)
2478 XSETINT (c
, unread_command_char
);
2479 unread_command_char
= -1;
2485 if (CONSP (Vunread_command_events
))
2487 c
= XCAR (Vunread_command_events
);
2488 Vunread_command_events
= XCDR (Vunread_command_events
);
2490 /* Undo what read_char_x_menu_prompt did when it unread
2491 additional keys returned by Fx_popup_menu. */
2493 && EQ (XCDR (c
), Qdisabled
)
2494 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2497 /* If the queued event is something that used the mouse,
2498 set used_mouse_menu accordingly. */
2500 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2501 *used_mouse_menu
= 1;
2504 goto reread_for_input_method
;
2507 if (CONSP (Vunread_input_method_events
))
2509 c
= XCAR (Vunread_input_method_events
);
2510 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2512 /* Undo what read_char_x_menu_prompt did when it unread
2513 additional keys returned by Fx_popup_menu. */
2515 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2519 goto reread_for_input_method
;
2522 this_command_key_count_reset
= 0;
2524 if (!NILP (Vexecuting_kbd_macro
))
2526 /* We set this to Qmacro; since that's not a frame, nobody will
2527 try to switch frames on us, and the selected window will
2530 Since this event came from a macro, it would be misleading to
2531 leave internal_last_event_frame set to wherever the last
2532 real event came from. Normally, a switch-frame event selects
2533 internal_last_event_frame after each command is read, but
2534 events read from a macro should never cause a new frame to be
2536 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2538 /* Exit the macro if we are at the end.
2539 Also, some things replace the macro with t
2540 to force an early exit. */
2541 if (EQ (Vexecuting_kbd_macro
, Qt
)
2542 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2548 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2549 if (STRINGP (Vexecuting_kbd_macro
)
2550 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2551 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2553 executing_kbd_macro_index
++;
2558 if (!NILP (unread_switch_frame
))
2560 c
= unread_switch_frame
;
2561 unread_switch_frame
= Qnil
;
2563 /* This event should make it into this_command_keys, and get echoed
2564 again, so we do not set `reread'. */
2568 /* if redisplay was requested */
2569 if (commandflag
>= 0)
2571 /* If there is pending input, process any events which are not
2572 user-visible, such as X selection_request events. */
2574 || detect_input_pending_run_timers (0))
2575 swallow_events (0); /* may clear input_pending */
2577 /* Redisplay if no pending input. */
2578 while (!input_pending
)
2580 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2581 redisplay_preserve_echo_area (5);
2586 /* Normal case: no input arrived during redisplay. */
2589 /* Input arrived and pre-empted redisplay.
2590 Process any events which are not user-visible. */
2592 /* If that cleared input_pending, try again to redisplay. */
2596 /* Message turns off echoing unless more keystrokes turn it on again.
2598 The code in 20.x for the condition was
2600 1. echo_area_glyphs && *echo_area_glyphs
2601 2. && echo_area_glyphs != current_kboard->echobuf
2602 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2604 (1) means there's a current message displayed
2606 (2) means it's not the message from echoing from the current
2609 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2610 is set to a non-null value. This is done in read_char and it is
2611 set to echo_area_glyphs after a call to echo_char. That means
2612 ok_to_echo_at_next_pause is either null or
2613 current_kboard->echobuf with the appropriate current_kboard at
2616 So, condition (3) means in clear text ok_to_echo_at_next_pause
2617 must be either null, or the current message isn't from echoing at
2618 all, or it's from echoing from a different kboard than the
2621 if (/* There currently is something in the echo area. */
2622 !NILP (echo_area_buffer
[0])
2623 && (/* And it's either not from echoing. */
2624 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2625 /* Or it's an echo from a different kboard. */
2626 || echo_kboard
!= current_kboard
2627 /* Or we explicitly allow overwriting whatever there is. */
2628 || ok_to_echo_at_next_pause
== NULL
))
2633 /* Try reading a character via menu prompting in the minibuf.
2634 Try this before the sit-for, because the sit-for
2635 would do the wrong thing if we are supposed to do
2636 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2637 after a mouse event so don't try a minibuf menu. */
2639 if (nmaps
> 0 && INTERACTIVE
2640 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2641 /* Don't bring up a menu if we already have another event. */
2642 && NILP (Vunread_command_events
)
2643 && unread_command_char
< 0
2644 && !detect_input_pending_run_timers (0))
2646 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2649 key_already_recorded
= 1;
2654 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2655 We will do that below, temporarily for short sections of code,
2656 when appropriate. local_getcjmp must be in effect
2657 around any call to sit_for or kbd_buffer_get_event;
2658 it *must not* be in effect when we call redisplay. */
2660 if (_setjmp (local_getcjmp
))
2662 /* We must have saved the outer value of getcjmp here,
2663 so restore it now. */
2664 restore_getcjmp (save_jump
);
2665 XSETINT (c
, quit_char
);
2666 internal_last_event_frame
= selected_frame
;
2667 Vlast_event_frame
= internal_last_event_frame
;
2668 /* If we report the quit char as an event,
2669 don't do so more than once. */
2670 if (!NILP (Vinhibit_quit
))
2675 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2676 if (kb
!= current_kboard
)
2678 Lisp_Object link
= kb
->kbd_queue
;
2679 /* We shouldn't get here if we were in single-kboard mode! */
2684 while (CONSP (XCDR (link
)))
2686 if (!NILP (XCDR (link
)))
2690 kb
->kbd_queue
= Fcons (c
, Qnil
);
2692 XSETCDR (link
, Fcons (c
, Qnil
));
2693 kb
->kbd_queue_has_data
= 1;
2694 current_kboard
= kb
;
2695 /* This is going to exit from read_char
2696 so we had better get rid of this frame's stuff. */
2698 longjmp (wrong_kboard_jmpbuf
, 1);
2705 timer_start_idle ();
2707 /* If in middle of key sequence and minibuffer not active,
2708 start echoing if enough time elapses. */
2710 if (minibuf_level
== 0
2711 && !current_kboard
->immediate_echo
2712 && this_command_key_count
> 0
2714 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2715 && NILP (Fzerop (Vecho_keystrokes
))
2716 && (/* No message. */
2717 NILP (echo_area_buffer
[0])
2718 /* Or empty message. */
2719 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2720 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2721 /* Or already echoing from same kboard. */
2722 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2723 /* Or not echoing before and echoing allowed. */
2724 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2728 /* After a mouse event, start echoing right away.
2729 This is because we are probably about to display a menu,
2730 and we don't want to delay before doing so. */
2731 if (EVENT_HAS_PARAMETERS (prev_event
))
2736 double duration
= extract_float (Vecho_keystrokes
);
2737 sec
= (int) duration
;
2738 usec
= (duration
- sec
) * 1000000;
2739 save_getcjmp (save_jump
);
2740 restore_getcjmp (local_getcjmp
);
2741 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2742 restore_getcjmp (save_jump
);
2744 && ! CONSP (Vunread_command_events
))
2749 /* Maybe auto save due to number of keystrokes. */
2751 if (commandflag
!= 0
2752 && auto_save_interval
> 0
2753 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2754 && !detect_input_pending_run_timers (0))
2756 Fdo_auto_save (Qnil
, Qnil
);
2757 /* Hooks can actually change some buffers in auto save. */
2761 /* Try reading using an X menu.
2762 This is never confused with reading using the minibuf
2763 because the recursive call of read_char in read_char_minibuf_menu_prompt
2764 does not pass on any keymaps. */
2766 if (nmaps
> 0 && INTERACTIVE
2767 && !NILP (prev_event
)
2768 && EVENT_HAS_PARAMETERS (prev_event
)
2769 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2770 && !EQ (XCAR (prev_event
), Qtool_bar
)
2771 /* Don't bring up a menu if we already have another event. */
2772 && NILP (Vunread_command_events
)
2773 && unread_command_char
< 0)
2775 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2777 /* Now that we have read an event, Emacs is not idle. */
2783 /* Maybe autosave and/or garbage collect due to idleness. */
2785 if (INTERACTIVE
&& NILP (c
))
2787 int delay_level
, buffer_size
;
2789 /* Slow down auto saves logarithmically in size of current buffer,
2790 and garbage collect while we're at it. */
2791 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2792 last_non_minibuf_size
= Z
- BEG
;
2793 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2795 while (buffer_size
> 64)
2796 delay_level
++, buffer_size
-= buffer_size
>> 2;
2797 if (delay_level
< 4) delay_level
= 4;
2798 /* delay_level is 4 for files under around 50k, 7 at 100k,
2799 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2801 /* Auto save if enough time goes by without input. */
2802 if (commandflag
!= 0
2803 && num_nonmacro_input_events
> last_auto_save
2804 && INTEGERP (Vauto_save_timeout
)
2805 && XINT (Vauto_save_timeout
) > 0)
2809 save_getcjmp (save_jump
);
2810 restore_getcjmp (local_getcjmp
);
2811 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2813 restore_getcjmp (save_jump
);
2816 && ! CONSP (Vunread_command_events
))
2818 Fdo_auto_save (Qnil
, Qnil
);
2820 /* If we have auto-saved and there is still no input
2821 available, garbage collect if there has been enough
2822 consing going on to make it worthwhile. */
2823 if (!detect_input_pending_run_timers (0)
2824 && consing_since_gc
> gc_cons_threshold
/ 2)
2825 Fgarbage_collect ();
2832 /* If this has become non-nil here, it has been set by a timer
2833 or sentinel or filter. */
2834 if (CONSP (Vunread_command_events
))
2836 c
= XCAR (Vunread_command_events
);
2837 Vunread_command_events
= XCDR (Vunread_command_events
);
2840 /* Read something from current KBOARD's side queue, if possible. */
2844 if (current_kboard
->kbd_queue_has_data
)
2846 if (!CONSP (current_kboard
->kbd_queue
))
2848 c
= XCAR (current_kboard
->kbd_queue
);
2849 current_kboard
->kbd_queue
2850 = XCDR (current_kboard
->kbd_queue
);
2851 if (NILP (current_kboard
->kbd_queue
))
2852 current_kboard
->kbd_queue_has_data
= 0;
2853 input_pending
= readable_events (0);
2854 if (EVENT_HAS_PARAMETERS (c
)
2855 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2856 internal_last_event_frame
= XCAR (XCDR (c
));
2857 Vlast_event_frame
= internal_last_event_frame
;
2862 /* If current_kboard's side queue is empty check the other kboards.
2863 If one of them has data that we have not yet seen here,
2864 switch to it and process the data waiting for it.
2866 Note: if the events queued up for another kboard
2867 have already been seen here, and therefore are not a complete command,
2868 the kbd_queue_has_data field is 0, so we skip that kboard here.
2869 That's to avoid an infinite loop switching between kboards here. */
2870 if (NILP (c
) && !single_kboard
)
2873 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2874 if (kb
->kbd_queue_has_data
)
2876 current_kboard
= kb
;
2877 /* This is going to exit from read_char
2878 so we had better get rid of this frame's stuff. */
2880 longjmp (wrong_kboard_jmpbuf
, 1);
2889 /* Finally, we read from the main queue,
2890 and if that gives us something we can't use yet, we put it on the
2891 appropriate side queue and try again. */
2897 /* Actually read a character, waiting if necessary. */
2898 save_getcjmp (save_jump
);
2899 restore_getcjmp (local_getcjmp
);
2900 timer_start_idle ();
2901 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2902 restore_getcjmp (save_jump
);
2905 if (! NILP (c
) && (kb
!= current_kboard
))
2907 Lisp_Object link
= kb
->kbd_queue
;
2910 while (CONSP (XCDR (link
)))
2912 if (!NILP (XCDR (link
)))
2916 kb
->kbd_queue
= Fcons (c
, Qnil
);
2918 XSETCDR (link
, Fcons (c
, Qnil
));
2919 kb
->kbd_queue_has_data
= 1;
2923 current_kboard
= kb
;
2924 /* This is going to exit from read_char
2925 so we had better get rid of this frame's stuff. */
2927 longjmp (wrong_kboard_jmpbuf
, 1);
2932 /* Terminate Emacs in batch mode if at eof. */
2933 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2934 Fkill_emacs (make_number (1));
2938 /* Add in any extra modifiers, where appropriate. */
2939 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2940 || ((extra_keyboard_modifiers
& 0177) < ' '
2941 && (extra_keyboard_modifiers
& 0177) != 0))
2942 XSETINT (c
, make_ctrl_char (XINT (c
)));
2944 /* Transfer any other modifier bits directly from
2945 extra_keyboard_modifiers to c. Ignore the actual character code
2946 in the low 16 bits of extra_keyboard_modifiers. */
2947 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2957 if (commandflag
>= 0
2958 && !input_pending
&& !detect_input_pending_run_timers (0))
2966 /* Buffer switch events are only for internal wakeups
2967 so don't show them to the user.
2968 Also, don't record a key if we already did. */
2969 if (BUFFERP (c
) || key_already_recorded
)
2972 /* Process special events within read_char
2973 and loop around to read another event. */
2976 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2981 int was_locked
= single_kboard
;
2983 last_input_char
= c
;
2984 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2986 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2987 /* We stopped being idle for this event; undo that. This
2988 prevents automatic window selection (under
2989 mouse_autoselect_window from acting as a real input event, for
2990 example banishing the mouse under mouse-avoidance-mode. */
2991 timer_resume_idle ();
2993 /* Resume allowing input from any kboard, if that was true before. */
2995 any_kboard_state ();
3000 /* Handle things that only apply to characters. */
3003 /* If kbd_buffer_get_event gave us an EOF, return that. */
3007 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3008 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3009 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3010 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3011 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3012 && CHAR_VALID_P (XINT (c
), 0)))
3015 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3016 /* nil in keyboard-translate-table means no translation. */
3022 /* If this event is a mouse click in the menu bar,
3023 return just menu-bar for now. Modify the mouse click event
3024 so we won't do this twice, then queue it up. */
3025 if (EVENT_HAS_PARAMETERS (c
)
3027 && CONSP (EVENT_START (c
))
3028 && CONSP (XCDR (EVENT_START (c
))))
3032 posn
= POSN_POSN (EVENT_START (c
));
3033 /* Handle menu-bar events:
3034 insert the dummy prefix event `menu-bar'. */
3035 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3037 /* Change menu-bar to (menu-bar) as the event "position". */
3038 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3041 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3046 /* Store these characters into recent_keys, the dribble file if any,
3047 and the keyboard macro being defined, if any. */
3049 if (! NILP (also_record
))
3050 record_char (also_record
);
3052 /* Wipe the echo area.
3053 But first, if we are about to use an input method,
3054 save the echo area contents for it to refer to. */
3056 && ! NILP (Vinput_method_function
)
3057 && (unsigned) XINT (c
) >= ' '
3058 && (unsigned) XINT (c
) != 127
3059 && (unsigned) XINT (c
) < 256)
3061 previous_echo_area_message
= Fcurrent_message ();
3062 Vinput_method_previous_message
= previous_echo_area_message
;
3065 /* Now wipe the echo area, except for help events which do their
3066 own stuff with the echo area. */
3068 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3069 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3071 if (!NILP (echo_area_buffer
[0]))
3072 safe_run_hooks (Qecho_area_clear_hook
);
3073 clear_message (1, 0);
3076 reread_for_input_method
:
3078 /* Pass this to the input method, if appropriate. */
3080 && ! NILP (Vinput_method_function
)
3081 /* Don't run the input method within a key sequence,
3082 after the first event of the key sequence. */
3083 && NILP (prev_event
)
3084 && (unsigned) XINT (c
) >= ' '
3085 && (unsigned) XINT (c
) != 127
3086 && (unsigned) XINT (c
) < 256)
3089 int key_count
, key_count_reset
;
3090 struct gcpro gcpro1
;
3091 int count
= SPECPDL_INDEX ();
3093 /* Save the echo status. */
3094 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3095 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3096 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3097 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3100 if (before_command_restore_flag
)
3102 this_command_key_count
= before_command_key_count_1
;
3103 if (this_command_key_count
< this_single_command_key_start
)
3104 this_single_command_key_start
= this_command_key_count
;
3105 echo_truncate (before_command_echo_length_1
);
3106 before_command_restore_flag
= 0;
3110 /* Save the this_command_keys status. */
3111 key_count
= this_command_key_count
;
3112 key_count_reset
= this_command_key_count_reset
;
3115 keys
= Fcopy_sequence (this_command_keys
);
3120 /* Clear out this_command_keys. */
3121 this_command_key_count
= 0;
3122 this_command_key_count_reset
= 0;
3124 /* Now wipe the echo area. */
3125 if (!NILP (echo_area_buffer
[0]))
3126 safe_run_hooks (Qecho_area_clear_hook
);
3127 clear_message (1, 0);
3130 /* If we are not reading a key sequence,
3131 never use the echo area. */
3134 specbind (Qinput_method_use_echo_area
, Qt
);
3137 /* Call the input method. */
3138 tem
= call1 (Vinput_method_function
, c
);
3140 tem
= unbind_to (count
, tem
);
3142 /* Restore the saved echoing state
3143 and this_command_keys state. */
3144 this_command_key_count
= key_count
;
3145 this_command_key_count_reset
= key_count_reset
;
3147 this_command_keys
= keys
;
3150 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3151 current_kboard
->echo_string
= saved_echo_string
;
3152 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3153 if (saved_immediate_echo
)
3158 /* The input method can return no events. */
3161 /* Bring back the previous message, if any. */
3162 if (! NILP (previous_echo_area_message
))
3163 message_with_string ("%s", previous_echo_area_message
, 0);
3166 /* It returned one event or more. */
3168 Vunread_post_input_method_events
3169 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3174 /* Display help if not echoing. */
3175 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3177 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3178 Lisp_Object help
, object
, position
, window
, tem
;
3180 tem
= Fcdr (XCDR (c
));
3183 window
= Fcar (tem
);
3185 object
= Fcar (tem
);
3187 position
= Fcar (tem
);
3189 show_help_echo (help
, window
, object
, position
, 0);
3191 /* We stopped being idle for this event; undo that. */
3192 timer_resume_idle ();
3196 if (! reread
|| this_command_key_count
== 0
3197 || this_command_key_count_reset
)
3200 /* Don't echo mouse motion events. */
3201 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3202 && NILP (Fzerop (Vecho_keystrokes
))
3203 && ! (EVENT_HAS_PARAMETERS (c
)
3204 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3207 if (! NILP (also_record
))
3208 echo_char (also_record
);
3209 /* Once we reread a character, echoing can happen
3210 the next time we pause to read a new one. */
3211 ok_to_echo_at_next_pause
= current_kboard
;
3214 /* Record this character as part of the current key. */
3215 add_command_key (c
);
3216 if (! NILP (also_record
))
3217 add_command_key (also_record
);
3220 last_input_char
= c
;
3223 /* Process the help character specially if enabled */
3224 if (!NILP (Vhelp_form
) && help_char_p (c
))
3227 count
= SPECPDL_INDEX ();
3229 record_unwind_protect (Fset_window_configuration
,
3230 Fcurrent_window_configuration (Qnil
));
3232 tem0
= Feval (Vhelp_form
);
3234 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3238 c
= read_char (0, 0, 0, Qnil
, 0);
3239 while (BUFFERP (c
));
3240 /* Remove the help from the frame */
3241 unbind_to (count
, Qnil
);
3244 if (EQ (c
, make_number (040)))
3248 c
= read_char (0, 0, 0, Qnil
, 0);
3249 while (BUFFERP (c
));
3258 /* Record a key that came from a mouse menu.
3259 Record it for echoing, for this-command-keys, and so on. */
3265 /* Wipe the echo area. */
3266 clear_message (1, 0);
3271 before_command_key_count
= this_command_key_count
;
3272 before_command_echo_length
= echo_length ();
3275 /* Don't echo mouse motion events. */
3276 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3277 && NILP (Fzerop (Vecho_keystrokes
)))
3281 /* Once we reread a character, echoing can happen
3282 the next time we pause to read a new one. */
3283 ok_to_echo_at_next_pause
= 0;
3286 /* Record this character as part of the current key. */
3287 add_command_key (c
);
3289 /* Re-reading in the middle of a command */
3290 last_input_char
= c
;
3294 /* Return 1 if should recognize C as "the help character". */
3302 if (EQ (c
, Vhelp_char
))
3304 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3305 if (EQ (c
, XCAR (tail
)))
3310 /* Record the input event C in various ways. */
3318 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3320 /* To avoid filling recent_keys with help-echo and mouse-movement
3321 events, we filter out repeated help-echo events, only store the
3322 first and last in a series of mouse-movement events, and don't
3323 store repeated help-echo events which are only separated by
3324 mouse-movement events. */
3326 Lisp_Object ev1
, ev2
, ev3
;
3329 if ((ix1
= recent_keys_index
- 1) < 0)
3330 ix1
= NUM_RECENT_KEYS
- 1;
3331 ev1
= AREF (recent_keys
, ix1
);
3333 if ((ix2
= ix1
- 1) < 0)
3334 ix2
= NUM_RECENT_KEYS
- 1;
3335 ev2
= AREF (recent_keys
, ix2
);
3337 if ((ix3
= ix2
- 1) < 0)
3338 ix3
= NUM_RECENT_KEYS
- 1;
3339 ev3
= AREF (recent_keys
, ix3
);
3341 if (EQ (XCAR (c
), Qhelp_echo
))
3343 /* Don't record `help-echo' in recent_keys unless it shows some help
3344 message, and a different help than the previously recorded
3346 Lisp_Object help
, last_help
;
3348 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3349 if (!STRINGP (help
))
3351 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3352 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3354 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3355 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3356 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3358 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3359 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3360 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3361 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3364 else if (EQ (XCAR (c
), Qmouse_movement
))
3366 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3367 So additional mouse movement events replace the last element. */
3368 Lisp_Object last_window
, window
;
3370 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3371 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3372 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3373 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3374 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3376 ASET (recent_keys
, ix1
, c
);
3382 store_kbd_macro_char (c
);
3387 ASET (recent_keys
, recent_keys_index
, c
);
3388 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3389 recent_keys_index
= 0;
3391 else if (recorded
< 0)
3393 /* We need to remove one or two events from recent_keys.
3394 To do this, we simply put nil at those events and move the
3395 recent_keys_index backwards over those events. Usually,
3396 users will never see those nil events, as they will be
3397 overwritten by the command keys entered to see recent_keys
3400 while (recorded
++ < 0 && total_keys
> 0)
3402 if (total_keys
< NUM_RECENT_KEYS
)
3404 if (--recent_keys_index
< 0)
3405 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3406 ASET (recent_keys
, recent_keys_index
, Qnil
);
3410 num_nonmacro_input_events
++;
3412 /* Write c to the dribble file. If c is a lispy event, write
3413 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3414 If you, dear reader, have a better idea, you've got the source. :-) */
3419 if (XUINT (c
) < 0x100)
3420 putc (XINT (c
), dribble
);
3422 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3426 Lisp_Object dribblee
;
3428 /* If it's a structured event, take the event header. */
3429 dribblee
= EVENT_HEAD (c
);
3431 if (SYMBOLP (dribblee
))
3433 putc ('<', dribble
);
3434 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3435 SBYTES (SYMBOL_NAME (dribblee
)),
3437 putc ('>', dribble
);
3449 struct buffer
*old
= current_buffer
;
3450 Fprinc (object
, Qnil
);
3451 set_buffer_internal (XBUFFER (Vstandard_output
));
3452 call0 (intern ("help-mode"));
3453 set_buffer_internal (old
);
3457 /* Copy out or in the info on where C-g should throw to.
3458 This is used when running Lisp code from within get_char,
3459 in case get_char is called recursively.
3460 See read_process_output. */
3466 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3470 restore_getcjmp (temp
)
3473 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3478 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3479 of this function. */
3482 tracking_off (old_value
)
3483 Lisp_Object old_value
;
3485 do_mouse_tracking
= old_value
;
3486 if (NILP (old_value
))
3488 /* Redisplay may have been preempted because there was input
3489 available, and it assumes it will be called again after the
3490 input has been processed. If the only input available was
3491 the sort that we have just disabled, then we need to call
3493 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3495 redisplay_preserve_echo_area (6);
3496 get_input_pending (&input_pending
,
3497 READABLE_EVENTS_DO_TIMERS_NOW
);
3503 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3504 doc
: /* Evaluate BODY with mouse movement events enabled.
3505 Within a `track-mouse' form, mouse motion generates input events that
3506 you can read with `read-event'.
3507 Normally, mouse motion is ignored.
3508 usage: (track-mouse BODY ...) */)
3512 int count
= SPECPDL_INDEX ();
3515 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3517 do_mouse_tracking
= Qt
;
3519 val
= Fprogn (args
);
3520 return unbind_to (count
, val
);
3523 /* If mouse has moved on some frame, return one of those frames.
3524 Return 0 otherwise. */
3529 Lisp_Object tail
, frame
;
3531 FOR_EACH_FRAME (tail
, frame
)
3533 if (XFRAME (frame
)->mouse_moved
)
3534 return XFRAME (frame
);
3540 #endif /* HAVE_MOUSE */
3542 /* Low level keyboard/mouse input.
3543 kbd_buffer_store_event places events in kbd_buffer, and
3544 kbd_buffer_get_event retrieves them. */
3546 /* Return true iff there are any events in the queue that read-char
3547 would return. If this returns false, a read-char would block. */
3549 readable_events (flags
)
3552 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3555 /* If the buffer contains only FOCUS_IN_EVENT events, and
3556 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3557 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3559 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3560 #ifdef USE_TOOLKIT_SCROLL_BARS
3561 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3565 struct input_event
*event
;
3567 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3574 #ifdef USE_TOOLKIT_SCROLL_BARS
3575 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3577 event
->kind
== FOCUS_IN_EVENT
)
3578 #ifdef USE_TOOLKIT_SCROLL_BARS
3579 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3580 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3581 && event
->part
== scroll_bar_handle
3582 && event
->modifiers
== 0)
3587 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3590 while (event
!= kbd_store_ptr
);
3597 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3598 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3603 if (current_kboard
->kbd_queue_has_data
)
3609 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3610 if (kb
->kbd_queue_has_data
)
3616 /* Set this for debugging, to have a way to get out */
3621 event_to_kboard (event
)
3622 struct input_event
*event
;
3625 frame
= event
->frame_or_window
;
3627 frame
= XCAR (frame
);
3628 else if (WINDOWP (frame
))
3629 frame
= WINDOW_FRAME (XWINDOW (frame
));
3631 /* There are still some events that don't set this field.
3632 For now, just ignore the problem.
3633 Also ignore dead frames here. */
3634 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3637 return FRAME_KBOARD (XFRAME (frame
));
3642 Lisp_Object Vthrow_on_input
;
3644 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3647 kbd_buffer_store_event (event
)
3648 register struct input_event
*event
;
3650 kbd_buffer_store_event_hold (event
, 0);
3653 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3655 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3656 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3657 Else, if EVENT is a quit event, store the quit event
3658 in HOLD_QUIT, and return (thus ignoring further events).
3660 This is used in read_avail_input to postpone the processing
3661 of the quit event until all subsequent input events have been
3662 parsed (and discarded).
3666 kbd_buffer_store_event_hold (event
, hold_quit
)
3667 register struct input_event
*event
;
3668 struct input_event
*hold_quit
;
3670 if (event
->kind
== NO_EVENT
)
3673 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3676 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3678 register int c
= event
->code
& 0377;
3680 if (event
->modifiers
& ctrl_modifier
)
3681 c
= make_ctrl_char (c
);
3683 c
|= (event
->modifiers
3684 & (meta_modifier
| alt_modifier
3685 | hyper_modifier
| super_modifier
));
3691 struct input_event
*sp
;
3694 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3695 kb
!= current_kboard
))
3698 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3699 Fcons (make_number (c
), Qnil
));
3700 kb
->kbd_queue_has_data
= 1;
3701 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3703 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3706 if (event_to_kboard (sp
) == kb
)
3708 sp
->kind
= NO_EVENT
;
3709 sp
->frame_or_window
= Qnil
;
3719 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3723 /* If this results in a quit_char being returned to Emacs as
3724 input, set Vlast_event_frame properly. If this doesn't
3725 get returned to Emacs as an event, the next event read
3726 will set Vlast_event_frame again, so this is safe to do. */
3730 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3732 focus
= event
->frame_or_window
;
3733 internal_last_event_frame
= focus
;
3734 Vlast_event_frame
= focus
;
3737 last_event_timestamp
= event
->timestamp
;
3738 handle_interrupt ();
3742 if (c
&& c
== stop_character
)
3748 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3749 Just ignore the second one. */
3750 else if (event
->kind
== BUFFER_SWITCH_EVENT
3751 && kbd_fetch_ptr
!= kbd_store_ptr
3752 && ((kbd_store_ptr
== kbd_buffer
3753 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3754 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3757 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3758 kbd_store_ptr
= kbd_buffer
;
3760 /* Don't let the very last slot in the buffer become full,
3761 since that would make the two pointers equal,
3762 and that is indistinguishable from an empty buffer.
3763 Discard the event if it would fill the last slot. */
3764 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3766 *kbd_store_ptr
= *event
;
3770 /* If we're inside while-no-input, and this event qualifies
3771 as input, set quit-flag to cause an interrupt. */
3772 if (!NILP (Vthrow_on_input
)
3773 && event
->kind
!= FOCUS_IN_EVENT
3774 && event
->kind
!= HELP_EVENT
3775 && event
->kind
!= DEICONIFY_EVENT
)
3777 Vquit_flag
= Vthrow_on_input
;
3778 /* If we're inside a function that wants immediate quits,
3780 if (immediate_quit
&& NILP (Vinhibit_quit
))
3790 /* Put an input event back in the head of the event queue. */
3793 kbd_buffer_unget_event (event
)
3794 register struct input_event
*event
;
3796 if (kbd_fetch_ptr
== kbd_buffer
)
3797 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3799 /* Don't let the very last slot in the buffer become full, */
3800 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3803 *kbd_fetch_ptr
= *event
;
3808 /* Generate HELP_EVENT input_events in BUFP which has room for
3809 SIZE events. If there's not enough room in BUFP, ignore this
3812 HELP is the help form.
3814 FRAME is the frame on which the help is generated. OBJECT is the
3815 Lisp object where the help was found (a buffer, a string, an
3816 overlay, or nil if neither from a string nor from a buffer. POS is
3817 the position within OBJECT where the help was found.
3819 Value is the number of input_events generated. */
3822 gen_help_event (help
, frame
, window
, object
, pos
)
3823 Lisp_Object help
, frame
, object
, window
;
3826 struct input_event event
;
3830 event
.kind
= HELP_EVENT
;
3831 event
.frame_or_window
= frame
;
3833 event
.x
= WINDOWP (window
) ? window
: frame
;
3836 kbd_buffer_store_event (&event
);
3840 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3843 kbd_buffer_store_help_event (frame
, help
)
3844 Lisp_Object frame
, help
;
3846 struct input_event event
;
3848 event
.kind
= HELP_EVENT
;
3849 event
.frame_or_window
= frame
;
3854 kbd_buffer_store_event (&event
);
3858 /* Discard any mouse events in the event buffer by setting them to
3861 discard_mouse_events ()
3863 struct input_event
*sp
;
3864 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3866 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3869 if (sp
->kind
== MOUSE_CLICK_EVENT
3870 || sp
->kind
== WHEEL_EVENT
3872 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3874 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3876 sp
->kind
= NO_EVENT
;
3882 /* Return non-zero if there are any real events waiting in the event
3883 buffer, not counting `NO_EVENT's.
3885 If DISCARD is non-zero, discard NO_EVENT events at the front of
3886 the input queue, possibly leaving the input queue empty if there
3887 are no real input events. */
3890 kbd_buffer_events_waiting (discard
)
3893 struct input_event
*sp
;
3895 for (sp
= kbd_fetch_ptr
;
3896 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3899 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3906 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3910 /* Clear input event EVENT. */
3914 struct input_event
*event
;
3916 event
->kind
= NO_EVENT
;
3920 /* Read one event from the event buffer, waiting if necessary.
3921 The value is a Lisp object representing the event.
3922 The value is nil for an event that should be ignored,
3923 or that was handled here.
3924 We always read and discard one event. */
3927 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3929 int *used_mouse_menu
;
3938 *kbp
= current_kboard
;
3942 /* Wait until there is input available. */
3945 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3948 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3952 /* If the quit flag is set, then read_char will return
3953 quit_char, so that counts as "available input." */
3954 if (!NILP (Vquit_flag
))
3955 quit_throw_to_read_char ();
3957 /* One way or another, wait until input is available; then, if
3958 interrupt handlers have not read it, read it now. */
3961 wait_for_kbd_input ();
3963 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3967 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3970 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3974 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3976 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3977 /* Pass 1 for EXPECT since we just waited to have input. */
3978 read_avail_input (1);
3980 #endif /* not VMS */
3983 if (CONSP (Vunread_command_events
))
3986 first
= XCAR (Vunread_command_events
);
3987 Vunread_command_events
= XCDR (Vunread_command_events
);
3988 *kbp
= current_kboard
;
3992 /* At this point, we know that there is a readable event available
3993 somewhere. If the event queue is empty, then there must be a
3994 mouse movement enabled and available. */
3995 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3997 struct input_event
*event
;
3999 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4003 last_event_timestamp
= event
->timestamp
;
4006 *kbp
= event_to_kboard (event
);
4008 *kbp
= current_kboard
; /* Better than returning null ptr? */
4010 *kbp
= &the_only_kboard
;
4015 /* These two kinds of events get special handling
4016 and don't actually appear to the command loop.
4017 We return nil for them. */
4018 if (event
->kind
== SELECTION_REQUEST_EVENT
4019 || event
->kind
== SELECTION_CLEAR_EVENT
)
4022 struct input_event copy
;
4024 /* Remove it from the buffer before processing it,
4025 since otherwise swallow_events will see it
4026 and process it again. */
4028 kbd_fetch_ptr
= event
+ 1;
4029 input_pending
= readable_events (0);
4030 x_handle_selection_event (©
);
4032 /* We're getting selection request events, but we don't have
4038 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4039 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4041 /* Make an event (delete-frame (FRAME)). */
4042 obj
= Fcons (event
->frame_or_window
, Qnil
);
4043 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4044 kbd_fetch_ptr
= event
+ 1;
4047 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4048 else if (event
->kind
== ICONIFY_EVENT
)
4050 /* Make an event (iconify-frame (FRAME)). */
4051 obj
= Fcons (event
->frame_or_window
, Qnil
);
4052 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4053 kbd_fetch_ptr
= event
+ 1;
4055 else if (event
->kind
== DEICONIFY_EVENT
)
4057 /* Make an event (make-frame-visible (FRAME)). */
4058 obj
= Fcons (event
->frame_or_window
, Qnil
);
4059 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4060 kbd_fetch_ptr
= event
+ 1;
4063 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4065 /* The value doesn't matter here; only the type is tested. */
4066 XSETBUFFER (obj
, current_buffer
);
4067 kbd_fetch_ptr
= event
+ 1;
4069 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4070 || defined (USE_GTK)
4071 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4073 kbd_fetch_ptr
= event
+ 1;
4074 input_pending
= readable_events (0);
4075 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4076 x_activate_menubar (XFRAME (event
->frame_or_window
));
4079 #if defined (WINDOWSNT) || defined (MAC_OS)
4080 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4083 /* Make an event (language-change (KEY_SCRIPT)). */
4084 obj
= Fcons (make_number (event
->code
), Qnil
);
4086 /* Make an event (language-change (FRAME CHARSET LCID)). */
4087 obj
= Fcons (event
->frame_or_window
, Qnil
);
4089 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4090 kbd_fetch_ptr
= event
+ 1;
4093 else if (event
->kind
== SAVE_SESSION_EVENT
)
4095 obj
= Fcons (Qsave_session
, Qnil
);
4096 kbd_fetch_ptr
= event
+ 1;
4098 /* Just discard these, by returning nil.
4099 With MULTI_KBOARD, these events are used as placeholders
4100 when we need to randomly delete events from the queue.
4101 (They shouldn't otherwise be found in the buffer,
4102 but on some machines it appears they do show up
4103 even without MULTI_KBOARD.) */
4104 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4105 mouse events during a popup-menu call. */
4106 else if (event
->kind
== NO_EVENT
)
4107 kbd_fetch_ptr
= event
+ 1;
4108 else if (event
->kind
== HELP_EVENT
)
4110 Lisp_Object object
, position
, help
, frame
, window
;
4112 frame
= event
->frame_or_window
;
4113 object
= event
->arg
;
4114 position
= make_number (event
->code
);
4117 clear_event (event
);
4119 kbd_fetch_ptr
= event
+ 1;
4120 if (!WINDOWP (window
))
4122 obj
= Fcons (Qhelp_echo
,
4123 list5 (frame
, help
, window
, object
, position
));
4125 else if (event
->kind
== FOCUS_IN_EVENT
)
4127 /* Notification of a FocusIn event. The frame receiving the
4128 focus is in event->frame_or_window. Generate a
4129 switch-frame event if necessary. */
4130 Lisp_Object frame
, focus
;
4132 frame
= event
->frame_or_window
;
4133 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4137 if (!EQ (frame
, internal_last_event_frame
)
4138 && !EQ (frame
, selected_frame
))
4139 obj
= make_lispy_switch_frame (frame
);
4140 internal_last_event_frame
= frame
;
4141 kbd_fetch_ptr
= event
+ 1;
4145 /* If this event is on a different frame, return a switch-frame this
4146 time, and leave the event in the queue for next time. */
4150 frame
= event
->frame_or_window
;
4152 frame
= XCAR (frame
);
4153 else if (WINDOWP (frame
))
4154 frame
= WINDOW_FRAME (XWINDOW (frame
));
4156 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4160 if (! EQ (frame
, internal_last_event_frame
)
4161 && !EQ (frame
, selected_frame
))
4162 obj
= make_lispy_switch_frame (frame
);
4163 internal_last_event_frame
= frame
;
4165 /* If we didn't decide to make a switch-frame event, go ahead
4166 and build a real event from the queue entry. */
4170 obj
= make_lispy_event (event
);
4172 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4173 || defined (USE_GTK)
4174 /* If this was a menu selection, then set the flag to inhibit
4175 writing to last_nonmenu_event. Don't do this if the event
4176 we're returning is (menu-bar), though; that indicates the
4177 beginning of the menu sequence, and we might as well leave
4178 that as the `event with parameters' for this selection. */
4180 && !EQ (event
->frame_or_window
, event
->arg
)
4181 && (event
->kind
== MENU_BAR_EVENT
4182 || event
->kind
== TOOL_BAR_EVENT
))
4183 *used_mouse_menu
= 1;
4186 /* Wipe out this event, to catch bugs. */
4187 clear_event (event
);
4188 kbd_fetch_ptr
= event
+ 1;
4193 /* Try generating a mouse motion event. */
4194 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4196 FRAME_PTR f
= some_mouse_moved ();
4197 Lisp_Object bar_window
;
4198 enum scroll_bar_part part
;
4202 *kbp
= current_kboard
;
4203 /* Note that this uses F to determine which display to look at.
4204 If there is no valid info, it does not store anything
4205 so x remains nil. */
4208 /* XXX Can f or mouse_position_hook be NULL here? */
4209 if (f
&& FRAME_DEVICE (f
)->mouse_position_hook
)
4210 (*FRAME_DEVICE (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4211 &part
, &x
, &y
, &time
);
4215 /* Decide if we should generate a switch-frame event. Don't
4216 generate switch-frame events for motion outside of all Emacs
4222 frame
= FRAME_FOCUS_FRAME (f
);
4224 XSETFRAME (frame
, f
);
4226 if (! EQ (frame
, internal_last_event_frame
)
4227 && !EQ (frame
, selected_frame
))
4228 obj
= make_lispy_switch_frame (frame
);
4229 internal_last_event_frame
= frame
;
4232 /* If we didn't decide to make a switch-frame event, go ahead and
4233 return a mouse-motion event. */
4234 if (!NILP (x
) && NILP (obj
))
4235 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4237 #endif /* HAVE_MOUSE */
4239 /* We were promised by the above while loop that there was
4240 something for us to read! */
4243 input_pending
= readable_events (0);
4245 Vlast_event_frame
= internal_last_event_frame
;
4250 /* Process any events that are not user-visible,
4251 then return, without reading any user-visible events. */
4254 swallow_events (do_display
)
4259 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4261 struct input_event
*event
;
4263 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4267 last_event_timestamp
= event
->timestamp
;
4269 /* These two kinds of events get special handling
4270 and don't actually appear to the command loop. */
4271 if (event
->kind
== SELECTION_REQUEST_EVENT
4272 || event
->kind
== SELECTION_CLEAR_EVENT
)
4275 struct input_event copy
;
4277 /* Remove it from the buffer before processing it,
4278 since otherwise swallow_events called recursively could see it
4279 and process it again. */
4281 kbd_fetch_ptr
= event
+ 1;
4282 input_pending
= readable_events (0);
4283 x_handle_selection_event (©
);
4285 /* We're getting selection request events, but we don't have
4294 old_timers_run
= timers_run
;
4295 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4297 if (timers_run
!= old_timers_run
&& do_display
)
4298 redisplay_preserve_echo_area (7);
4301 /* Record the start of when Emacs is idle,
4302 for the sake of running idle-time timers. */
4309 /* If we are already in the idle state, do nothing. */
4310 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4313 EMACS_GET_TIME (timer_idleness_start_time
);
4315 timer_last_idleness_start_time
= timer_idleness_start_time
;
4317 /* Mark all idle-time timers as once again candidates for running. */
4318 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4322 timer
= XCAR (timers
);
4324 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4326 XVECTOR (timer
)->contents
[0] = Qnil
;
4330 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4335 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4338 /* Resume idle timer from last idle start time. */
4341 timer_resume_idle ()
4343 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4346 timer_idleness_start_time
= timer_last_idleness_start_time
;
4349 /* This is only for debugging. */
4350 struct input_event last_timer_event
;
4352 /* Check whether a timer has fired. To prevent larger problems we simply
4353 disregard elements that are not proper timers. Do not make a circular
4354 timer list for the time being.
4356 Returns the number of seconds to wait until the next timer fires. If a
4357 timer is triggering now, return zero seconds.
4358 If no timer is active, return -1 seconds.
4360 If a timer is ripe, we run it, with quitting turned off.
4362 DO_IT_NOW is now ignored. It used to mean that we should
4363 run the timer directly instead of queueing a timer-event.
4364 Now we always run timers directly. */
4367 timer_check (do_it_now
)
4370 EMACS_TIME nexttime
;
4371 EMACS_TIME now
, idleness_now
;
4372 Lisp_Object timers
, idle_timers
, chosen_timer
;
4373 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4375 EMACS_SET_SECS (nexttime
, -1);
4376 EMACS_SET_USECS (nexttime
, -1);
4378 /* Always consider the ordinary timers. */
4379 timers
= Vtimer_list
;
4380 /* Consider the idle timers only if Emacs is idle. */
4381 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4382 idle_timers
= Vtimer_idle_list
;
4385 chosen_timer
= Qnil
;
4386 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4388 if (CONSP (timers
) || CONSP (idle_timers
))
4390 EMACS_GET_TIME (now
);
4391 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4392 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4395 while (CONSP (timers
) || CONSP (idle_timers
))
4397 Lisp_Object
*vector
;
4398 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4399 EMACS_TIME timer_time
, idle_timer_time
;
4400 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4402 /* Skip past invalid timers and timers already handled. */
4405 timer
= XCAR (timers
);
4406 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4408 timers
= XCDR (timers
);
4411 vector
= XVECTOR (timer
)->contents
;
4413 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4414 || !INTEGERP (vector
[3])
4415 || ! NILP (vector
[0]))
4417 timers
= XCDR (timers
);
4421 if (!NILP (idle_timers
))
4423 timer
= XCAR (idle_timers
);
4424 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4426 idle_timers
= XCDR (idle_timers
);
4429 vector
= XVECTOR (timer
)->contents
;
4431 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4432 || !INTEGERP (vector
[3])
4433 || ! NILP (vector
[0]))
4435 idle_timers
= XCDR (idle_timers
);
4440 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4441 based on the next ordinary timer.
4442 TIMER_DIFFERENCE is the distance in time from NOW to when
4443 this timer becomes ripe (negative if it's already ripe). */
4446 timer
= XCAR (timers
);
4447 vector
= XVECTOR (timer
)->contents
;
4448 EMACS_SET_SECS (timer_time
,
4449 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4450 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4451 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4454 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4455 based on the next idle timer. */
4456 if (!NILP (idle_timers
))
4458 idle_timer
= XCAR (idle_timers
);
4459 vector
= XVECTOR (idle_timer
)->contents
;
4460 EMACS_SET_SECS (idle_timer_time
,
4461 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4462 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4463 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4466 /* Decide which timer is the next timer,
4467 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4468 Also step down the list where we found that timer. */
4470 if (! NILP (timers
) && ! NILP (idle_timers
))
4473 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4474 if (EMACS_TIME_NEG_P (temp
))
4476 chosen_timer
= timer
;
4477 timers
= XCDR (timers
);
4478 difference
= timer_difference
;
4482 chosen_timer
= idle_timer
;
4483 idle_timers
= XCDR (idle_timers
);
4484 difference
= idle_timer_difference
;
4487 else if (! NILP (timers
))
4489 chosen_timer
= timer
;
4490 timers
= XCDR (timers
);
4491 difference
= timer_difference
;
4495 chosen_timer
= idle_timer
;
4496 idle_timers
= XCDR (idle_timers
);
4497 difference
= idle_timer_difference
;
4499 vector
= XVECTOR (chosen_timer
)->contents
;
4501 /* If timer is ripe, run it if it hasn't been run. */
4502 if (EMACS_TIME_NEG_P (difference
)
4503 || (EMACS_SECS (difference
) == 0
4504 && EMACS_USECS (difference
) == 0))
4506 if (NILP (vector
[0]))
4508 int count
= SPECPDL_INDEX ();
4509 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4511 /* On unbind_to, resume allowing input from any kboard, if that
4513 record_single_kboard_state ();
4515 /* Mark the timer as triggered to prevent problems if the lisp
4516 code fails to reschedule it right. */
4519 specbind (Qinhibit_quit
, Qt
);
4521 call1 (Qtimer_event_handler
, chosen_timer
);
4522 Vdeactivate_mark
= old_deactivate_mark
;
4524 unbind_to (count
, Qnil
);
4526 /* Since we have handled the event,
4527 we don't need to tell the caller to wake up and do it. */
4531 /* When we encounter a timer that is still waiting,
4532 return the amount of time to wait before it is ripe. */
4539 /* No timers are pending in the future. */
4540 /* Return 0 if we generated an event, and -1 if not. */
4545 /* Caches for modify_event_symbol. */
4546 static Lisp_Object accent_key_syms
;
4547 static Lisp_Object func_key_syms
;
4548 static Lisp_Object mouse_syms
;
4549 static Lisp_Object wheel_syms
;
4550 static Lisp_Object drag_n_drop_syms
;
4552 /* This is a list of keysym codes for special "accent" characters.
4553 It parallels lispy_accent_keys. */
4555 static int lispy_accent_codes
[] =
4557 #ifdef XK_dead_circumflex
4562 #ifdef XK_dead_grave
4567 #ifdef XK_dead_tilde
4572 #ifdef XK_dead_diaeresis
4577 #ifdef XK_dead_macron
4582 #ifdef XK_dead_degree
4587 #ifdef XK_dead_acute
4592 #ifdef XK_dead_cedilla
4597 #ifdef XK_dead_breve
4602 #ifdef XK_dead_ogonek
4607 #ifdef XK_dead_caron
4612 #ifdef XK_dead_doubleacute
4613 XK_dead_doubleacute
,
4617 #ifdef XK_dead_abovedot
4622 #ifdef XK_dead_abovering
4632 #ifdef XK_dead_belowdot
4637 #ifdef XK_dead_voiced_sound
4638 XK_dead_voiced_sound
,
4642 #ifdef XK_dead_semivoiced_sound
4643 XK_dead_semivoiced_sound
,
4659 /* This is a list of Lisp names for special "accent" characters.
4660 It parallels lispy_accent_codes. */
4662 static char *lispy_accent_keys
[] =
4680 "dead-voiced-sound",
4681 "dead-semivoiced-sound",
4687 #define FUNCTION_KEY_OFFSET 0x0
4689 char *lispy_function_keys
[] =
4693 0, /* VK_LBUTTON 0x01 */
4694 0, /* VK_RBUTTON 0x02 */
4695 "cancel", /* VK_CANCEL 0x03 */
4696 0, /* VK_MBUTTON 0x04 */
4698 0, 0, 0, /* 0x05 .. 0x07 */
4700 "backspace", /* VK_BACK 0x08 */
4701 "tab", /* VK_TAB 0x09 */
4703 0, 0, /* 0x0A .. 0x0B */
4705 "clear", /* VK_CLEAR 0x0C */
4706 "return", /* VK_RETURN 0x0D */
4708 0, 0, /* 0x0E .. 0x0F */
4710 0, /* VK_SHIFT 0x10 */
4711 0, /* VK_CONTROL 0x11 */
4712 0, /* VK_MENU 0x12 */
4713 "pause", /* VK_PAUSE 0x13 */
4714 "capslock", /* VK_CAPITAL 0x14 */
4716 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4718 "escape", /* VK_ESCAPE 0x1B */
4720 0, 0, 0, 0, /* 0x1C .. 0x1F */
4722 0, /* VK_SPACE 0x20 */
4723 "prior", /* VK_PRIOR 0x21 */
4724 "next", /* VK_NEXT 0x22 */
4725 "end", /* VK_END 0x23 */
4726 "home", /* VK_HOME 0x24 */
4727 "left", /* VK_LEFT 0x25 */
4728 "up", /* VK_UP 0x26 */
4729 "right", /* VK_RIGHT 0x27 */
4730 "down", /* VK_DOWN 0x28 */
4731 "select", /* VK_SELECT 0x29 */
4732 "print", /* VK_PRINT 0x2A */
4733 "execute", /* VK_EXECUTE 0x2B */
4734 "snapshot", /* VK_SNAPSHOT 0x2C */
4735 "insert", /* VK_INSERT 0x2D */
4736 "delete", /* VK_DELETE 0x2E */
4737 "help", /* VK_HELP 0x2F */
4739 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4741 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4743 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4745 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4747 0, 0, 0, 0, 0, 0, 0, 0, 0,
4748 0, 0, 0, 0, 0, 0, 0, 0, 0,
4749 0, 0, 0, 0, 0, 0, 0, 0,
4751 "lwindow", /* VK_LWIN 0x5B */
4752 "rwindow", /* VK_RWIN 0x5C */
4753 "apps", /* VK_APPS 0x5D */
4755 0, 0, /* 0x5E .. 0x5F */
4757 "kp-0", /* VK_NUMPAD0 0x60 */
4758 "kp-1", /* VK_NUMPAD1 0x61 */
4759 "kp-2", /* VK_NUMPAD2 0x62 */
4760 "kp-3", /* VK_NUMPAD3 0x63 */
4761 "kp-4", /* VK_NUMPAD4 0x64 */
4762 "kp-5", /* VK_NUMPAD5 0x65 */
4763 "kp-6", /* VK_NUMPAD6 0x66 */
4764 "kp-7", /* VK_NUMPAD7 0x67 */
4765 "kp-8", /* VK_NUMPAD8 0x68 */
4766 "kp-9", /* VK_NUMPAD9 0x69 */
4767 "kp-multiply", /* VK_MULTIPLY 0x6A */
4768 "kp-add", /* VK_ADD 0x6B */
4769 "kp-separator", /* VK_SEPARATOR 0x6C */
4770 "kp-subtract", /* VK_SUBTRACT 0x6D */
4771 "kp-decimal", /* VK_DECIMAL 0x6E */
4772 "kp-divide", /* VK_DIVIDE 0x6F */
4773 "f1", /* VK_F1 0x70 */
4774 "f2", /* VK_F2 0x71 */
4775 "f3", /* VK_F3 0x72 */
4776 "f4", /* VK_F4 0x73 */
4777 "f5", /* VK_F5 0x74 */
4778 "f6", /* VK_F6 0x75 */
4779 "f7", /* VK_F7 0x76 */
4780 "f8", /* VK_F8 0x77 */
4781 "f9", /* VK_F9 0x78 */
4782 "f10", /* VK_F10 0x79 */
4783 "f11", /* VK_F11 0x7A */
4784 "f12", /* VK_F12 0x7B */
4785 "f13", /* VK_F13 0x7C */
4786 "f14", /* VK_F14 0x7D */
4787 "f15", /* VK_F15 0x7E */
4788 "f16", /* VK_F16 0x7F */
4789 "f17", /* VK_F17 0x80 */
4790 "f18", /* VK_F18 0x81 */
4791 "f19", /* VK_F19 0x82 */
4792 "f20", /* VK_F20 0x83 */
4793 "f21", /* VK_F21 0x84 */
4794 "f22", /* VK_F22 0x85 */
4795 "f23", /* VK_F23 0x86 */
4796 "f24", /* VK_F24 0x87 */
4798 0, 0, 0, 0, /* 0x88 .. 0x8B */
4799 0, 0, 0, 0, /* 0x8C .. 0x8F */
4801 "kp-numlock", /* VK_NUMLOCK 0x90 */
4802 "scroll", /* VK_SCROLL 0x91 */
4804 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4805 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4806 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4807 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4808 "kp-end", /* VK_NUMPAD_END 0x96 */
4809 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4810 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4811 "kp-up", /* VK_NUMPAD_UP 0x99 */
4812 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4813 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4814 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4815 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4817 0, 0, /* 0x9E .. 0x9F */
4820 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4821 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4822 * No other API or message will distinguish left and right keys this way.
4826 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4827 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4828 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4829 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4830 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4836 "attn", /* VK_ATTN 0xF6 */
4837 "crsel", /* VK_CRSEL 0xF7 */
4838 "exsel", /* VK_EXSEL 0xF8 */
4839 "ereof", /* VK_EREOF 0xF9 */
4840 "play", /* VK_PLAY 0xFA */
4841 "zoom", /* VK_ZOOM 0xFB */
4842 "noname", /* VK_NONAME 0xFC */
4843 "pa1", /* VK_PA1 0xFD */
4844 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4848 #else /* not HAVE_NTGUI */
4850 /* This should be dealt with in XTread_socket now, and that doesn't
4851 depend on the client system having the Kana syms defined. See also
4852 the XK_kana_A case below. */
4855 static char *lispy_kana_keys
[] =
4857 /* X Keysym value */
4858 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4859 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4860 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4861 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4862 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4863 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4864 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4865 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4866 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4867 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4868 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4869 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4870 "kana-i", "kana-u", "kana-e", "kana-o",
4871 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4872 "prolongedsound", "kana-A", "kana-I", "kana-U",
4873 "kana-E", "kana-O", "kana-KA", "kana-KI",
4874 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4875 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4876 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4877 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4878 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4879 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4880 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4881 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4882 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4883 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4884 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4885 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4887 #endif /* XK_kana_A */
4890 #define FUNCTION_KEY_OFFSET 0xff00
4892 /* You'll notice that this table is arranged to be conveniently
4893 indexed by X Windows keysym values. */
4894 static char *lispy_function_keys
[] =
4896 /* X Keysym value */
4898 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4899 "backspace", "tab", "linefeed", "clear",
4901 0, 0, 0, "pause", /* 0xff10...1f */
4902 0, 0, 0, 0, 0, 0, 0, "escape",
4904 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4905 "romaji", "hiragana", "katakana", "hiragana-katakana",
4906 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4907 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4908 "eisu-toggle", /* 0xff30...3f */
4909 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4910 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4912 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4913 "down", "prior", "next", "end",
4914 "begin", 0, 0, 0, 0, 0, 0, 0,
4915 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4926 "break", /* 0xff6b */
4929 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4930 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4931 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4932 0, 0, 0, 0, 0, 0, 0, 0,
4933 "kp-tab", /* 0xff89 */
4935 "kp-enter", /* 0xff8d */
4937 "kp-f1", /* 0xff91 */
4941 "kp-home", /* 0xff95 */
4946 "kp-prior", /* kp-page-up */
4947 "kp-next", /* kp-page-down */
4953 0, 0, 0, 0, 0, 0, 0, 0, 0,
4954 "kp-multiply", /* 0xffaa */
4959 "kp-divide", /* 0xffaf */
4960 "kp-0", /* 0xffb0 */
4961 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4964 "kp-equal", /* 0xffbd */
4965 "f1", /* 0xffbe */ /* IsFunctionKey */
4967 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4968 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4969 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4970 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4971 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4972 0, 0, 0, 0, 0, 0, 0, 0,
4973 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4974 0, 0, 0, 0, 0, 0, 0, "delete"
4977 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4978 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4980 static char *iso_lispy_function_keys
[] =
4982 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4983 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4984 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4985 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4986 "iso-lefttab", /* 0xfe20 */
4987 "iso-move-line-up", "iso-move-line-down",
4988 "iso-partial-line-up", "iso-partial-line-down",
4989 "iso-partial-space-left", "iso-partial-space-right",
4990 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4991 "iso-release-margin-left", "iso-release-margin-right",
4992 "iso-release-both-margins",
4993 "iso-fast-cursor-left", "iso-fast-cursor-right",
4994 "iso-fast-cursor-up", "iso-fast-cursor-down",
4995 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4996 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4999 #endif /* not HAVE_NTGUI */
5001 Lisp_Object Vlispy_mouse_stem
;
5003 static char *lispy_wheel_names
[] =
5005 "wheel-up", "wheel-down"
5008 /* drag-n-drop events are generated when a set of selected files are
5009 dragged from another application and dropped onto an Emacs window. */
5010 static char *lispy_drag_n_drop_names
[] =
5015 /* Scroll bar parts. */
5016 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5017 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5018 Lisp_Object Qtop
, Qratio
;
5020 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5021 Lisp_Object
*scroll_bar_parts
[] = {
5022 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5023 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5026 /* User signal events. */
5027 Lisp_Object Qusr1_signal
, Qusr2_signal
;
5029 Lisp_Object
*lispy_user_signals
[] =
5031 &Qusr1_signal
, &Qusr2_signal
5035 /* A vector, indexed by button number, giving the down-going location
5036 of currently depressed buttons, both scroll bar and non-scroll bar.
5038 The elements have the form
5039 (BUTTON-NUMBER MODIFIER-MASK . REST)
5040 where REST is the cdr of a position as it would be reported in the event.
5042 The make_lispy_event function stores positions here to tell the
5043 difference between click and drag events, and to store the starting
5044 location to be included in drag events. */
5046 static Lisp_Object button_down_location
;
5048 /* Information about the most recent up-going button event: Which
5049 button, what location, and what time. */
5051 static int last_mouse_button
;
5052 static int last_mouse_x
;
5053 static int last_mouse_y
;
5054 static unsigned long button_down_time
;
5056 /* The maximum time between clicks to make a double-click, or Qnil to
5057 disable double-click detection, or Qt for no time limit. */
5059 Lisp_Object Vdouble_click_time
;
5061 /* Maximum number of pixels the mouse may be moved between clicks
5062 to make a double-click. */
5064 EMACS_INT double_click_fuzz
;
5066 /* The number of clicks in this multiple-click. */
5068 int double_click_count
;
5070 /* Return position of a mouse click or wheel event */
5073 make_lispy_position (f
, x
, y
, time
)
5079 enum window_part part
;
5080 Lisp_Object posn
= Qnil
;
5081 Lisp_Object extra_info
= Qnil
;
5084 /* Set `window' to the window under frame pixel coordinates (x,y) */
5086 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5087 &part
, &wx
, &wy
, 0);
5091 if (WINDOWP (window
))
5093 /* It's a click in window window at frame coordinates (x,y) */
5094 struct window
*w
= XWINDOW (window
);
5095 Lisp_Object string_info
= Qnil
;
5096 int textpos
= -1, rx
= -1, ry
= -1;
5097 int dx
= -1, dy
= -1;
5098 int width
= -1, height
= -1;
5099 Lisp_Object object
= Qnil
;
5101 /* Set event coordinates to window-relative coordinates
5102 for constructing the Lisp event below. */
5106 if (part
== ON_TEXT
)
5108 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5110 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5112 /* Mode line or header line. Look for a string under
5113 the mouse that may have a `local-map' property. */
5117 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5119 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5120 &object
, &dx
, &dy
, &width
, &height
);
5121 if (STRINGP (string
))
5122 string_info
= Fcons (string
, make_number (charpos
));
5123 if (w
== XWINDOW (selected_window
))
5126 textpos
= XMARKER (w
->pointm
)->charpos
;
5128 else if (part
== ON_VERTICAL_BORDER
)
5130 posn
= Qvertical_line
;
5135 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5140 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5142 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5143 &object
, &dx
, &dy
, &width
, &height
);
5144 if (STRINGP (string
))
5145 string_info
= Fcons (string
, make_number (charpos
));
5146 if (part
== ON_LEFT_MARGIN
)
5149 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5151 else if (part
== ON_LEFT_FRINGE
)
5153 posn
= Qleft_fringe
;
5156 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5158 : window_box_width (w
, LEFT_MARGIN_AREA
));
5161 else if (part
== ON_RIGHT_FRINGE
)
5163 posn
= Qright_fringe
;
5166 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5167 + window_box_width (w
, TEXT_AREA
)
5168 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5169 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5175 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5176 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5181 Lisp_Object string2
, object2
= Qnil
;
5182 struct display_pos p
;
5184 int width2
, height2
;
5185 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5186 &object2
, &dx2
, &dy2
,
5188 textpos
= CHARPOS (p
.pos
);
5189 if (rx
< 0) rx
= wx
;
5190 if (ry
< 0) ry
= wy
;
5191 if (dx
< 0) dx
= dx2
;
5192 if (dy
< 0) dy
= dy2
;
5193 if (width
< 0) width
= width2
;
5194 if (height
< 0) height
= height2
;
5198 posn
= make_number (textpos
);
5199 if (STRINGP (string2
))
5200 string_info
= Fcons (string2
,
5201 make_number (CHARPOS (p
.string_pos
)));
5207 #ifdef HAVE_WINDOW_SYSTEM
5208 if (IMAGEP (object
))
5210 Lisp_Object image_map
, hotspot
;
5211 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5213 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5215 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5216 posn
= XCAR (hotspot
);
5221 extra_info
= Fcons (object
,
5222 Fcons (Fcons (make_number (dx
),
5224 Fcons (Fcons (make_number (width
),
5225 make_number (height
)),
5229 extra_info
= Fcons (string_info
,
5230 Fcons (make_number (textpos
),
5231 Fcons (Fcons (make_number (rx
),
5237 XSETFRAME (window
, f
);
5242 XSETFASTINT (*x
, 0);
5243 XSETFASTINT (*y
, 0);
5246 return Fcons (window
,
5248 Fcons (Fcons (*x
, *y
),
5249 Fcons (make_number (time
),
5253 /* Given a struct input_event, build the lisp event which represents
5254 it. If EVENT is 0, build a mouse movement event from the mouse
5255 movement buffer, which should have a movement event in it.
5257 Note that events must be passed to this function in the order they
5258 are received; this function stores the location of button presses
5259 in order to build drag events when the button is released. */
5262 make_lispy_event (event
)
5263 struct input_event
*event
;
5267 switch (SWITCH_ENUM_CAST (event
->kind
))
5269 /* A simple keystroke. */
5270 case ASCII_KEYSTROKE_EVENT
:
5272 Lisp_Object lispy_c
;
5273 int c
= event
->code
& 0377;
5274 /* Turn ASCII characters into control characters
5276 if (event
->modifiers
& ctrl_modifier
)
5277 c
= make_ctrl_char (c
);
5279 /* Add in the other modifier bits. We took care of ctrl_modifier
5280 just above, and the shift key was taken care of by the X code,
5281 and applied to control characters by make_ctrl_char. */
5282 c
|= (event
->modifiers
5283 & (meta_modifier
| alt_modifier
5284 | hyper_modifier
| super_modifier
));
5285 /* Distinguish Shift-SPC from SPC. */
5286 if ((event
->code
& 0377) == 040
5287 && event
->modifiers
& shift_modifier
)
5288 c
|= shift_modifier
;
5289 button_down_time
= 0;
5290 XSETFASTINT (lispy_c
, c
);
5294 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5296 Lisp_Object lispy_c
;
5297 int c
= event
->code
;
5299 /* Add in the other modifier bits. We took care of ctrl_modifier
5300 just above, and the shift key was taken care of by the X code,
5301 and applied to control characters by make_ctrl_char. */
5302 c
|= (event
->modifiers
5303 & (meta_modifier
| alt_modifier
5304 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5305 /* What about the `shift' modifier ? */
5306 button_down_time
= 0;
5307 XSETFASTINT (lispy_c
, c
);
5311 /* A function key. The symbol may need to have modifier prefixes
5313 case NON_ASCII_KEYSTROKE_EVENT
:
5314 button_down_time
= 0;
5316 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5317 if (event
->code
== lispy_accent_codes
[i
])
5318 return modify_event_symbol (i
,
5320 Qfunction_key
, Qnil
,
5321 lispy_accent_keys
, &accent_key_syms
,
5322 (sizeof (lispy_accent_keys
)
5323 / sizeof (lispy_accent_keys
[0])));
5327 if (event
->code
>= 0x400 && event
->code
< 0x500)
5328 return modify_event_symbol (event
->code
- 0x400,
5329 event
->modifiers
& ~shift_modifier
,
5330 Qfunction_key
, Qnil
,
5331 lispy_kana_keys
, &func_key_syms
,
5332 (sizeof (lispy_kana_keys
)
5333 / sizeof (lispy_kana_keys
[0])));
5334 #endif /* XK_kana_A */
5337 #ifdef ISO_FUNCTION_KEY_OFFSET
5338 if (event
->code
< FUNCTION_KEY_OFFSET
5339 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5340 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5342 Qfunction_key
, Qnil
,
5343 iso_lispy_function_keys
, &func_key_syms
,
5344 (sizeof (iso_lispy_function_keys
)
5345 / sizeof (iso_lispy_function_keys
[0])));
5348 /* Handle system-specific or unknown keysyms. */
5349 if (event
->code
& (1 << 28)
5350 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5351 || (event
->code
- FUNCTION_KEY_OFFSET
5352 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5353 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5355 /* We need to use an alist rather than a vector as the cache
5356 since we can't make a vector long enuf. */
5357 if (NILP (current_kboard
->system_key_syms
))
5358 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5359 return modify_event_symbol (event
->code
,
5362 current_kboard
->Vsystem_key_alist
,
5363 0, ¤t_kboard
->system_key_syms
,
5367 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5369 Qfunction_key
, Qnil
,
5370 lispy_function_keys
, &func_key_syms
,
5371 (sizeof (lispy_function_keys
)
5372 / sizeof (lispy_function_keys
[0])));
5375 /* A mouse click. Figure out where it is, decide whether it's
5376 a press, click or drag, and build the appropriate structure. */
5377 case MOUSE_CLICK_EVENT
:
5378 #ifndef USE_TOOLKIT_SCROLL_BARS
5379 case SCROLL_BAR_CLICK_EVENT
:
5382 int button
= event
->code
;
5384 Lisp_Object position
;
5385 Lisp_Object
*start_pos_ptr
;
5386 Lisp_Object start_pos
;
5390 /* Build the position as appropriate for this mouse click. */
5391 if (event
->kind
== MOUSE_CLICK_EVENT
)
5393 struct frame
*f
= XFRAME (event
->frame_or_window
);
5394 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5398 /* Ignore mouse events that were made on frame that
5399 have been deleted. */
5400 if (! FRAME_LIVE_P (f
))
5403 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5404 /* EVENT->x and EVENT->y are frame-relative pixel
5405 coordinates at this place. Under old redisplay, COLUMN
5406 and ROW are set to frame relative glyph coordinates
5407 which are then used to determine whether this click is
5408 in a menu (non-toolkit version). */
5409 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5410 &column
, &row
, NULL
, 1);
5412 /* In the non-toolkit version, clicks on the menu bar
5413 are ordinary button events in the event buffer.
5414 Distinguish them, and invoke the menu.
5416 (In the toolkit version, the toolkit handles the menu bar
5417 and Emacs doesn't know about it until after the user
5418 makes a selection.) */
5419 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5420 && (event
->modifiers
& down_modifier
))
5422 Lisp_Object items
, item
;
5427 /* Activate the menu bar on the down event. If the
5428 up event comes in before the menu code can deal with it,
5430 if (! (event
->modifiers
& down_modifier
))
5434 /* Find the menu bar item under `column'. */
5436 items
= FRAME_MENU_BAR_ITEMS (f
);
5437 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5439 Lisp_Object pos
, string
;
5440 string
= AREF (items
, i
+ 1);
5441 pos
= AREF (items
, i
+ 3);
5444 if (column
>= XINT (pos
)
5445 && column
< XINT (pos
) + SCHARS (string
))
5447 item
= AREF (items
, i
);
5452 /* ELisp manual 2.4b says (x y) are window relative but
5453 code says they are frame-relative. */
5455 = Fcons (event
->frame_or_window
,
5457 Fcons (Fcons (event
->x
, event
->y
),
5458 Fcons (make_number (event
->timestamp
),
5461 return Fcons (item
, Fcons (position
, Qnil
));
5463 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5465 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5468 #ifndef USE_TOOLKIT_SCROLL_BARS
5471 /* It's a scrollbar click. */
5473 Lisp_Object portion_whole
;
5476 window
= event
->frame_or_window
;
5477 portion_whole
= Fcons (event
->x
, event
->y
);
5478 part
= *scroll_bar_parts
[(int) event
->part
];
5482 Fcons (Qvertical_scroll_bar
,
5483 Fcons (portion_whole
,
5484 Fcons (make_number (event
->timestamp
),
5485 Fcons (part
, Qnil
)))));
5487 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5489 if (button
>= ASIZE (button_down_location
))
5491 button_down_location
= larger_vector (button_down_location
,
5493 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5496 start_pos_ptr
= &AREF (button_down_location
, button
);
5497 start_pos
= *start_pos_ptr
;
5498 *start_pos_ptr
= Qnil
;
5501 /* On window-system frames, use the value of
5502 double-click-fuzz as is. On other frames, interpret it
5503 as a multiple of 1/8 characters. */
5507 if (WINDOWP (event
->frame_or_window
))
5508 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5509 else if (FRAMEP (event
->frame_or_window
))
5510 f
= XFRAME (event
->frame_or_window
);
5514 if (FRAME_WINDOW_P (f
))
5515 fuzz
= double_click_fuzz
;
5517 fuzz
= double_click_fuzz
/ 8;
5519 is_double
= (button
== last_mouse_button
5520 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5521 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5522 && button_down_time
!= 0
5523 && (EQ (Vdouble_click_time
, Qt
)
5524 || (INTEGERP (Vdouble_click_time
)
5525 && ((int)(event
->timestamp
- button_down_time
)
5526 < XINT (Vdouble_click_time
)))));
5529 last_mouse_button
= button
;
5530 last_mouse_x
= XINT (event
->x
);
5531 last_mouse_y
= XINT (event
->y
);
5533 /* If this is a button press, squirrel away the location, so
5534 we can decide later whether it was a click or a drag. */
5535 if (event
->modifiers
& down_modifier
)
5539 double_click_count
++;
5540 event
->modifiers
|= ((double_click_count
> 2)
5545 double_click_count
= 1;
5546 button_down_time
= event
->timestamp
;
5547 *start_pos_ptr
= Fcopy_alist (position
);
5550 /* Now we're releasing a button - check the co-ordinates to
5551 see if this was a click or a drag. */
5552 else if (event
->modifiers
& up_modifier
)
5554 /* If we did not see a down before this up, ignore the up.
5555 Probably this happened because the down event chose a
5556 menu item. It would be an annoyance to treat the
5557 release of the button that chose the menu item as a
5560 if (!CONSP (start_pos
))
5563 event
->modifiers
&= ~up_modifier
;
5564 #if 0 /* Formerly we treated an up with no down as a click event. */
5565 if (!CONSP (start_pos
))
5566 event
->modifiers
|= click_modifier
;
5571 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5573 /* The third element of every position
5574 should be the (x,y) pair. */
5575 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5577 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5579 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5580 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5583 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5584 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5585 /* Maybe the mouse has moved a lot, caused scrolling, and
5586 eventually ended up at the same screen position (but
5587 not buffer position) in which case it is a drag, not
5589 /* FIXME: OTOH if the buffer position has changed
5590 because of a timer or process filter rather than
5591 because of mouse movement, it should be considered as
5592 a click. But mouse-drag-region completely ignores
5593 this case and it hasn't caused any real problem, so
5594 it's probably OK to ignore it as well. */
5595 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5596 /* Mouse hasn't moved (much). */
5597 event
->modifiers
|= click_modifier
;
5600 button_down_time
= 0;
5601 event
->modifiers
|= drag_modifier
;
5604 /* Don't check is_double; treat this as multiple
5605 if the down-event was multiple. */
5606 if (double_click_count
> 1)
5607 event
->modifiers
|= ((double_click_count
> 2)
5613 /* Every mouse event should either have the down_modifier or
5614 the up_modifier set. */
5618 /* Get the symbol we should use for the mouse click. */
5621 head
= modify_event_symbol (button
,
5623 Qmouse_click
, Vlispy_mouse_stem
,
5626 XVECTOR (mouse_syms
)->size
);
5627 if (event
->modifiers
& drag_modifier
)
5632 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5635 Fcons (make_number (double_click_count
),
5646 Lisp_Object position
;
5649 /* Build the position as appropriate for this mouse click. */
5650 struct frame
*f
= XFRAME (event
->frame_or_window
);
5652 /* Ignore wheel events that were made on frame that have been
5654 if (! FRAME_LIVE_P (f
))
5657 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5660 /* Set double or triple modifiers to indicate the wheel speed. */
5662 /* On window-system frames, use the value of
5663 double-click-fuzz as is. On other frames, interpret it
5664 as a multiple of 1/8 characters. */
5669 if (WINDOWP (event
->frame_or_window
))
5670 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5671 else if (FRAMEP (event
->frame_or_window
))
5672 f
= XFRAME (event
->frame_or_window
);
5676 if (FRAME_WINDOW_P (f
))
5677 fuzz
= double_click_fuzz
;
5679 fuzz
= double_click_fuzz
/ 8;
5681 is_double
= (last_mouse_button
< 0
5682 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5683 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5684 && button_down_time
!= 0
5685 && (EQ (Vdouble_click_time
, Qt
)
5686 || (INTEGERP (Vdouble_click_time
)
5687 && ((int)(event
->timestamp
- button_down_time
)
5688 < XINT (Vdouble_click_time
)))));
5691 double_click_count
++;
5692 event
->modifiers
|= ((double_click_count
> 2)
5698 double_click_count
= 1;
5699 event
->modifiers
|= click_modifier
;
5702 button_down_time
= event
->timestamp
;
5703 /* Use a negative value to distinguish wheel from mouse button. */
5704 last_mouse_button
= -1;
5705 last_mouse_x
= XINT (event
->x
);
5706 last_mouse_y
= XINT (event
->y
);
5712 if (event
->modifiers
& up_modifier
)
5714 /* Emit a wheel-up event. */
5715 event
->modifiers
&= ~up_modifier
;
5718 else if (event
->modifiers
& down_modifier
)
5720 /* Emit a wheel-down event. */
5721 event
->modifiers
&= ~down_modifier
;
5725 /* Every wheel event should either have the down_modifier or
5726 the up_modifier set. */
5729 /* Get the symbol we should use for the wheel event. */
5730 head
= modify_event_symbol (symbol_num
,
5736 ASIZE (wheel_syms
));
5739 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5742 Fcons (make_number (double_click_count
),
5751 #ifdef USE_TOOLKIT_SCROLL_BARS
5753 /* We don't have down and up events if using toolkit scroll bars,
5754 so make this always a click event. Store in the `part' of
5755 the Lisp event a symbol which maps to the following actions:
5757 `above_handle' page up
5758 `below_handle' page down
5762 `bottom' bottom of buffer
5763 `handle' thumb has been dragged.
5764 `end-scroll' end of interaction with scroll bar
5766 The incoming input_event contains in its `part' member an
5767 index of type `enum scroll_bar_part' which we can use as an
5768 index in scroll_bar_parts to get the appropriate symbol. */
5770 case SCROLL_BAR_CLICK_EVENT
:
5772 Lisp_Object position
, head
, window
, portion_whole
, part
;
5774 window
= event
->frame_or_window
;
5775 portion_whole
= Fcons (event
->x
, event
->y
);
5776 part
= *scroll_bar_parts
[(int) event
->part
];
5780 Fcons (Qvertical_scroll_bar
,
5781 Fcons (portion_whole
,
5782 Fcons (make_number (event
->timestamp
),
5783 Fcons (part
, Qnil
)))));
5785 /* Always treat scroll bar events as clicks. */
5786 event
->modifiers
|= click_modifier
;
5787 event
->modifiers
&= ~up_modifier
;
5789 if (event
->code
>= ASIZE (mouse_syms
))
5790 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5792 /* Get the symbol we should use for the mouse click. */
5793 head
= modify_event_symbol (event
->code
,
5798 XVECTOR (mouse_syms
)->size
);
5799 return Fcons (head
, Fcons (position
, Qnil
));
5802 #endif /* USE_TOOLKIT_SCROLL_BARS */
5805 case W32_SCROLL_BAR_CLICK_EVENT
:
5807 int button
= event
->code
;
5809 Lisp_Object position
;
5810 Lisp_Object
*start_pos_ptr
;
5811 Lisp_Object start_pos
;
5815 Lisp_Object portion_whole
;
5818 window
= event
->frame_or_window
;
5819 portion_whole
= Fcons (event
->x
, event
->y
);
5820 part
= *scroll_bar_parts
[(int) event
->part
];
5824 Fcons (Qvertical_scroll_bar
,
5825 Fcons (portion_whole
,
5826 Fcons (make_number (event
->timestamp
),
5827 Fcons (part
, Qnil
)))));
5830 /* Always treat W32 scroll bar events as clicks. */
5831 event
->modifiers
|= click_modifier
;
5834 /* Get the symbol we should use for the mouse click. */
5837 head
= modify_event_symbol (button
,
5842 XVECTOR (mouse_syms
)->size
);
5848 #endif /* WINDOWSNT */
5850 case DRAG_N_DROP_EVENT
:
5853 Lisp_Object head
, position
;
5856 /* The frame_or_window field should be a cons of the frame in
5857 which the event occurred and a list of the filenames
5859 if (! CONSP (event
->frame_or_window
))
5862 f
= XFRAME (XCAR (event
->frame_or_window
));
5863 files
= XCDR (event
->frame_or_window
);
5865 /* Ignore mouse events that were made on frames that
5866 have been deleted. */
5867 if (! FRAME_LIVE_P (f
))
5870 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5873 head
= modify_event_symbol (0, event
->modifiers
,
5875 lispy_drag_n_drop_names
,
5876 &drag_n_drop_syms
, 1);
5882 #endif /* HAVE_MOUSE */
5884 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5885 || defined (USE_GTK)
5886 case MENU_BAR_EVENT
:
5887 if (EQ (event
->arg
, event
->frame_or_window
))
5888 /* This is the prefix key. We translate this to
5889 `(menu_bar)' because the code in keyboard.c for menu
5890 events, which we use, relies on this. */
5891 return Fcons (Qmenu_bar
, Qnil
);
5895 case SELECT_WINDOW_EVENT
:
5896 /* Make an event (select-window (WINDOW)). */
5897 return Fcons (Qselect_window
,
5898 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5901 case TOOL_BAR_EVENT
:
5902 if (EQ (event
->arg
, event
->frame_or_window
))
5903 /* This is the prefix key. We translate this to
5904 `(tool_bar)' because the code in keyboard.c for tool bar
5905 events, which we use, relies on this. */
5906 return Fcons (Qtool_bar
, Qnil
);
5907 else if (SYMBOLP (event
->arg
))
5908 return apply_modifiers (event
->modifiers
, event
->arg
);
5911 case USER_SIGNAL_EVENT
:
5912 /* A user signal. */
5913 return *lispy_user_signals
[event
->code
];
5915 case SAVE_SESSION_EVENT
:
5916 return Qsave_session
;
5918 /* The 'kind' field of the event is something we don't recognize. */
5927 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5929 Lisp_Object bar_window
;
5930 enum scroll_bar_part part
;
5934 /* Is it a scroll bar movement? */
5935 if (frame
&& ! NILP (bar_window
))
5937 Lisp_Object part_sym
;
5939 part_sym
= *scroll_bar_parts
[(int) part
];
5940 return Fcons (Qscroll_bar_movement
,
5941 (Fcons (Fcons (bar_window
,
5942 Fcons (Qvertical_scroll_bar
,
5943 Fcons (Fcons (x
, y
),
5944 Fcons (make_number (time
),
5950 /* Or is it an ordinary mouse movement? */
5953 Lisp_Object position
;
5955 position
= make_lispy_position (frame
, &x
, &y
, time
);
5957 return Fcons (Qmouse_movement
,
5963 #endif /* HAVE_MOUSE */
5965 /* Construct a switch frame event. */
5967 make_lispy_switch_frame (frame
)
5970 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5973 /* Manipulating modifiers. */
5975 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5977 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5978 SYMBOL's name of the end of the modifiers; the string from this
5979 position is the unmodified symbol name.
5981 This doesn't use any caches. */
5984 parse_modifiers_uncached (symbol
, modifier_end
)
5992 CHECK_SYMBOL (symbol
);
5995 name
= SYMBOL_NAME (symbol
);
5997 for (i
= 0; i
+2 <= SBYTES (name
); )
5999 int this_mod_end
= 0;
6002 /* See if the name continues with a modifier word.
6003 Check that the word appears, but don't check what follows it.
6004 Set this_mod and this_mod_end to record what we find. */
6006 switch (SREF (name
, i
))
6008 #define SINGLE_LETTER_MOD(BIT) \
6009 (this_mod_end = i + 1, this_mod = BIT)
6012 SINGLE_LETTER_MOD (alt_modifier
);
6016 SINGLE_LETTER_MOD (ctrl_modifier
);
6020 SINGLE_LETTER_MOD (hyper_modifier
);
6024 SINGLE_LETTER_MOD (meta_modifier
);
6028 SINGLE_LETTER_MOD (shift_modifier
);
6032 SINGLE_LETTER_MOD (super_modifier
);
6035 #undef SINGLE_LETTER_MOD
6037 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6038 if (i + LEN + 1 <= SBYTES (name) \
6039 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6041 this_mod_end = i + LEN; \
6046 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6047 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6048 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6052 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6054 #undef MULTI_LETTER_MOD
6058 /* If we found no modifier, stop looking for them. */
6059 if (this_mod_end
== 0)
6062 /* Check there is a dash after the modifier, so that it
6063 really is a modifier. */
6064 if (this_mod_end
>= SBYTES (name
)
6065 || SREF (name
, this_mod_end
) != '-')
6068 /* This modifier is real; look for another. */
6069 modifiers
|= this_mod
;
6070 i
= this_mod_end
+ 1;
6073 /* Should we include the `click' modifier? */
6074 if (! (modifiers
& (down_modifier
| drag_modifier
6075 | double_modifier
| triple_modifier
))
6076 && i
+ 7 == SBYTES (name
)
6077 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6078 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6079 modifiers
|= click_modifier
;
6087 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6088 prepended to the string BASE[0..BASE_LEN-1].
6089 This doesn't use any caches. */
6091 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6094 int base_len
, base_len_byte
;
6096 /* Since BASE could contain nulls, we can't use intern here; we have
6097 to use Fintern, which expects a genuine Lisp_String, and keeps a
6100 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6106 /* Only the event queue may use the `up' modifier; it should always
6107 be turned into a click or drag event before presented to lisp code. */
6108 if (modifiers
& up_modifier
)
6111 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6112 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6113 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6114 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6115 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6116 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6117 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6118 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6119 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6120 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6121 /* The click modifier is denoted by the absence of other modifiers. */
6125 mod_len
= p
- new_mods
;
6129 Lisp_Object new_name
;
6131 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6132 mod_len
+ base_len_byte
);
6133 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6134 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6136 return Fintern (new_name
, Qnil
);
6141 static char *modifier_names
[] =
6143 "up", "down", "drag", "click", "double", "triple", 0, 0,
6144 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6145 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6147 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6149 static Lisp_Object modifier_symbols
;
6151 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6153 lispy_modifier_list (modifiers
)
6156 Lisp_Object modifier_list
;
6159 modifier_list
= Qnil
;
6160 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6161 if (modifiers
& (1<<i
))
6162 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6165 return modifier_list
;
6169 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6170 where UNMODIFIED is the unmodified form of SYMBOL,
6171 MASK is the set of modifiers present in SYMBOL's name.
6172 This is similar to parse_modifiers_uncached, but uses the cache in
6173 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6174 Qevent_symbol_elements property. */
6177 parse_modifiers (symbol
)
6180 Lisp_Object elements
;
6182 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6183 if (CONSP (elements
))
6188 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6189 Lisp_Object unmodified
;
6192 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6193 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6196 if (modifiers
& ~INTMASK
)
6198 XSETFASTINT (mask
, modifiers
);
6199 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6201 /* Cache the parsing results on SYMBOL. */
6202 Fput (symbol
, Qevent_symbol_element_mask
,
6204 Fput (symbol
, Qevent_symbol_elements
,
6205 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6207 /* Since we know that SYMBOL is modifiers applied to unmodified,
6208 it would be nice to put that in unmodified's cache.
6209 But we can't, since we're not sure that parse_modifiers is
6216 /* Apply the modifiers MODIFIERS to the symbol BASE.
6217 BASE must be unmodified.
6219 This is like apply_modifiers_uncached, but uses BASE's
6220 Qmodifier_cache property, if present. It also builds
6221 Qevent_symbol_elements properties, since it has that info anyway.
6223 apply_modifiers copies the value of BASE's Qevent_kind property to
6224 the modified symbol. */
6226 apply_modifiers (modifiers
, base
)
6230 Lisp_Object cache
, index
, entry
, new_symbol
;
6232 /* Mask out upper bits. We don't know where this value's been. */
6233 modifiers
&= INTMASK
;
6235 /* The click modifier never figures into cache indices. */
6236 cache
= Fget (base
, Qmodifier_cache
);
6237 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6238 entry
= assq_no_quit (index
, cache
);
6241 new_symbol
= XCDR (entry
);
6244 /* We have to create the symbol ourselves. */
6245 new_symbol
= apply_modifiers_uncached (modifiers
,
6246 SDATA (SYMBOL_NAME (base
)),
6247 SCHARS (SYMBOL_NAME (base
)),
6248 SBYTES (SYMBOL_NAME (base
)));
6250 /* Add the new symbol to the base's cache. */
6251 entry
= Fcons (index
, new_symbol
);
6252 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6254 /* We have the parsing info now for free, so we could add it to
6256 XSETFASTINT (index, modifiers);
6257 Fput (new_symbol, Qevent_symbol_element_mask,
6258 Fcons (base, Fcons (index, Qnil)));
6259 Fput (new_symbol, Qevent_symbol_elements,
6260 Fcons (base, lispy_modifier_list (modifiers)));
6261 Sadly, this is only correct if `base' is indeed a base event,
6262 which is not necessarily the case. -stef */
6265 /* Make sure this symbol is of the same kind as BASE.
6267 You'd think we could just set this once and for all when we
6268 intern the symbol above, but reorder_modifiers may call us when
6269 BASE's property isn't set right; we can't assume that just
6270 because it has a Qmodifier_cache property it must have its
6271 Qevent_kind set right as well. */
6272 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6276 kind
= Fget (base
, Qevent_kind
);
6278 Fput (new_symbol
, Qevent_kind
, kind
);
6285 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6286 return a symbol with the modifiers placed in the canonical order.
6287 Canonical order is alphabetical, except for down and drag, which
6288 always come last. The 'click' modifier is never written out.
6290 Fdefine_key calls this to make sure that (for example) C-M-foo
6291 and M-C-foo end up being equivalent in the keymap. */
6294 reorder_modifiers (symbol
)
6297 /* It's hopefully okay to write the code this way, since everything
6298 will soon be in caches, and no consing will be done at all. */
6301 parsed
= parse_modifiers (symbol
);
6302 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6307 /* For handling events, we often want to produce a symbol whose name
6308 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6309 to some base, like the name of a function key or mouse button.
6310 modify_event_symbol produces symbols of this sort.
6312 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6313 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6316 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6317 into symbol names, or a string specifying a name stem used to
6318 construct a symbol name or the form `STEM-N', where N is the decimal
6319 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6320 non-nil; otherwise NAME_TABLE is used.
6322 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6323 persist between calls to modify_event_symbol that it can use to
6324 store a cache of the symbols it's generated for this NAME_TABLE
6325 before. The object stored there may be a vector or an alist.
6327 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6329 MODIFIERS is a set of modifier bits (as given in struct input_events)
6330 whose prefixes should be applied to the symbol name.
6332 SYMBOL_KIND is the value to be placed in the event_kind property of
6333 the returned symbol.
6335 The symbols we create are supposed to have an
6336 `event-symbol-elements' property, which lists the modifiers present
6337 in the symbol's name. */
6340 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6341 name_table
, symbol_table
, table_size
)
6344 Lisp_Object symbol_kind
;
6345 Lisp_Object name_alist_or_stem
;
6347 Lisp_Object
*symbol_table
;
6348 unsigned int table_size
;
6351 Lisp_Object symbol_int
;
6353 /* Get rid of the "vendor-specific" bit here. */
6354 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6356 /* Is this a request for a valid symbol? */
6357 if (symbol_num
< 0 || symbol_num
>= table_size
)
6360 if (CONSP (*symbol_table
))
6361 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6363 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6364 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6365 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6366 we've never used that symbol before. */
6369 if (! VECTORP (*symbol_table
)
6370 || XVECTOR (*symbol_table
)->size
!= table_size
)
6374 XSETFASTINT (size
, table_size
);
6375 *symbol_table
= Fmake_vector (size
, Qnil
);
6378 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6381 /* Have we already used this symbol before? */
6384 /* No; let's create it. */
6385 if (CONSP (name_alist_or_stem
))
6386 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6387 else if (STRINGP (name_alist_or_stem
))
6389 int len
= SBYTES (name_alist_or_stem
);
6390 char *buf
= (char *) alloca (len
+ 50);
6391 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6392 (long) XINT (symbol_int
) + 1);
6393 value
= intern (buf
);
6395 else if (name_table
!= 0 && name_table
[symbol_num
])
6396 value
= intern (name_table
[symbol_num
]);
6398 #ifdef HAVE_WINDOW_SYSTEM
6401 char *name
= x_get_keysym_name (symbol_num
);
6403 value
= intern (name
);
6410 sprintf (buf
, "key-%d", symbol_num
);
6411 value
= intern (buf
);
6414 if (CONSP (*symbol_table
))
6415 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6417 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6419 /* Fill in the cache entries for this symbol; this also
6420 builds the Qevent_symbol_elements property, which the user
6422 apply_modifiers (modifiers
& click_modifier
, value
);
6423 Fput (value
, Qevent_kind
, symbol_kind
);
6426 /* Apply modifiers to that symbol. */
6427 return apply_modifiers (modifiers
, value
);
6430 /* Convert a list that represents an event type,
6431 such as (ctrl meta backspace), into the usual representation of that
6432 event type as a number or a symbol. */
6434 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6435 doc
: /* Convert the event description list EVENT-DESC to an event type.
6436 EVENT-DESC should contain one base event type (a character or symbol)
6437 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6438 drag, down, double or triple). The base must be last.
6439 The return value is an event type (a character or symbol) which
6440 has the same base event type and all the specified modifiers. */)
6442 Lisp_Object event_desc
;
6450 while (CONSP (rest
))
6458 /* Given a symbol, see if it is a modifier name. */
6459 if (SYMBOLP (elt
) && CONSP (rest
))
6460 this = parse_solitary_modifier (elt
);
6464 else if (!NILP (base
))
6465 error ("Two bases given in one event");
6471 /* Let the symbol A refer to the character A. */
6472 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6473 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6475 if (INTEGERP (base
))
6477 /* Turn (shift a) into A. */
6478 if ((modifiers
& shift_modifier
) != 0
6479 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6481 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6482 modifiers
&= ~shift_modifier
;
6485 /* Turn (control a) into C-a. */
6486 if (modifiers
& ctrl_modifier
)
6487 return make_number ((modifiers
& ~ctrl_modifier
)
6488 | make_ctrl_char (XINT (base
)));
6490 return make_number (modifiers
| XINT (base
));
6492 else if (SYMBOLP (base
))
6493 return apply_modifiers (modifiers
, base
);
6496 error ("Invalid base event");
6501 /* Try to recognize SYMBOL as a modifier name.
6502 Return the modifier flag bit, or 0 if not recognized. */
6505 parse_solitary_modifier (symbol
)
6508 Lisp_Object name
= SYMBOL_NAME (symbol
);
6510 switch (SREF (name
, 0))
6512 #define SINGLE_LETTER_MOD(BIT) \
6513 if (SBYTES (name) == 1) \
6516 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6517 if (LEN == SBYTES (name) \
6518 && ! strncmp (SDATA (name), NAME, LEN)) \
6522 SINGLE_LETTER_MOD (alt_modifier
);
6526 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6530 SINGLE_LETTER_MOD (ctrl_modifier
);
6534 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6535 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6539 SINGLE_LETTER_MOD (hyper_modifier
);
6543 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6547 SINGLE_LETTER_MOD (meta_modifier
);
6551 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6555 SINGLE_LETTER_MOD (shift_modifier
);
6559 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6560 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6561 SINGLE_LETTER_MOD (super_modifier
);
6565 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6566 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6567 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6571 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6574 #undef SINGLE_LETTER_MOD
6575 #undef MULTI_LETTER_MOD
6581 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6582 Such a list is not valid as an event,
6583 but it can be a Lucid-style event type list. */
6586 lucid_event_type_list_p (object
)
6591 if (! CONSP (object
))
6594 if (EQ (XCAR (object
), Qhelp_echo
)
6595 || EQ (XCAR (object
), Qvertical_line
)
6596 || EQ (XCAR (object
), Qmode_line
)
6597 || EQ (XCAR (object
), Qheader_line
))
6600 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6604 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6611 /* Store into *addr a value nonzero if terminal input chars are available.
6612 Serves the purpose of ioctl (0, FIONREAD, addr)
6613 but works even if FIONREAD does not exist.
6614 (In fact, this may actually read some input.)
6616 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6617 timer events that are ripe.
6618 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6619 events (FOCUS_IN_EVENT).
6620 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6621 movements and toolkit scroll bar thumb drags. */
6624 get_input_pending (addr
, flags
)
6628 /* First of all, have we already counted some input? */
6629 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6631 /* If input is being read as it arrives, and we have none, there is none. */
6632 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6635 /* Try to read some input and see how much we get. */
6637 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6640 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6643 gobble_input (expected
)
6648 if (interrupt_input
)
6651 mask
= sigblock (sigmask (SIGIO
));
6652 read_avail_input (expected
);
6656 #ifdef POLL_FOR_INPUT
6657 /* XXX This condition was (read_socket_hook && !interrupt_input),
6658 but read_socket_hook is not global anymore. Let's pretend that
6660 if (!interrupt_input
&& poll_suppress_count
== 0)
6663 mask
= sigblock (sigmask (SIGALRM
));
6664 read_avail_input (expected
);
6670 read_avail_input (expected
);
6674 /* Put a BUFFER_SWITCH_EVENT in the buffer
6675 so that read_key_sequence will notice the new current buffer. */
6678 record_asynch_buffer_change ()
6680 struct input_event event
;
6684 event
.kind
= BUFFER_SWITCH_EVENT
;
6685 event
.frame_or_window
= Qnil
;
6689 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6690 The purpose of the event is to make read_key_sequence look up the
6691 keymaps again. If we aren't in read_key_sequence, we don't need one,
6692 and the event could cause trouble by messing up (input-pending-p). */
6693 tem
= Fwaiting_for_user_input_p ();
6697 /* We never need these events if we have no asynchronous subprocesses. */
6701 /* Make sure no interrupt happens while storing the event. */
6703 if (interrupt_input
)
6706 mask
= sigblock (sigmask (SIGIO
));
6707 kbd_buffer_store_event (&event
);
6714 kbd_buffer_store_event (&event
);
6721 /* Read any terminal input already buffered up by the system
6722 into the kbd_buffer, but do not wait.
6724 EXPECTED should be nonzero if the caller knows there is some input.
6726 Except on VMS, all input is read by this function.
6727 If interrupt_input is nonzero, this function MUST be called
6728 only when SIGIO is blocked.
6730 Returns the number of keyboard chars read, or -1 meaning
6731 this is a bad time to try to read input. */
6734 read_avail_input (expected
)
6741 /* Loop through the available devices, and call their input hooks. */
6745 struct device
*next
= d
->next_device
;
6747 if (d
->read_socket_hook
)
6750 struct input_event hold_quit
;
6752 EVENT_INIT (hold_quit
);
6753 hold_quit
.kind
= NO_EVENT
;
6755 /* No need for FIONREAD or fcntl; just say don't wait. */
6756 while (nr
= (*d
->read_socket_hook
) (d
, expected
, &hold_quit
), nr
> 0)
6762 if (nr
== -1) /* Not OK to read input now. */
6766 else if (nr
== -2) /* Non-transient error. */
6768 /* The display device terminated; it should be closed. */
6770 /* Kill Emacs if this was our last display. */
6771 if (! device_list
->next_device
)
6772 /* Formerly simply reported no input, but that
6773 sometimes led to a failure of Emacs to terminate.
6774 SIGHUP seems appropriate if we can't reach the
6776 /* ??? Is it really right to send the signal just to
6777 this process rather than to the whole process
6778 group? Perhaps on systems with FIONREAD Emacs is
6779 alone in its group. */
6780 kill (getpid (), SIGHUP
);
6782 /* XXX Is calling delete_device safe here? It calls Fdelete_frame. */
6783 if (d
->delete_device_hook
)
6784 (*d
->delete_device_hook
) (d
);
6789 if (hold_quit
.kind
!= NO_EVENT
)
6790 kbd_buffer_store_event (&hold_quit
);
6802 /* This is the tty way of reading available input.
6804 Note that each terminal device has its own `struct device' object,
6805 and so this function is called once for each individual termcap
6806 display. The first parameter indicates which device to read from. */
6809 tty_read_avail_input (struct device
*device
,
6811 struct input_event
*hold_quit
)
6813 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6814 the kbd_buffer can really hold. That may prevent loss
6815 of characters on some systems when input is stuffed at us. */
6816 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6818 struct tty_display_info
*tty
= device
->display_info
.tty
;
6821 if (device
->type
!= output_termcap
)
6824 /* XXX I think the following code should be moved to separate hook
6825 functions in system-dependent files. */
6828 #else /* not WINDOWSNT */
6830 n_to_read
= dos_keysns ();
6834 cbuf
[0] = dos_keyread ();
6837 #else /* not MSDOS */
6839 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6843 return 0; /* The terminal is suspended. */
6845 /* Determine how many characters we should *try* to read. */
6847 /* Find out how much input is available. */
6848 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6850 if (! noninteractive
)
6851 return -2; /* Close this device. */
6857 if (n_to_read
> sizeof cbuf
)
6858 n_to_read
= sizeof cbuf
;
6859 #else /* no FIONREAD */
6860 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6861 /* Read some input if available, but don't wait. */
6862 n_to_read
= sizeof cbuf
;
6863 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6869 /* Now read; for one reason or another, this will not block.
6870 NREAD is set to the number of chars read. */
6873 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6874 /* POSIX infers that processes which are not in the session leader's
6875 process group won't get SIGHUP's at logout time. BSDI adheres to
6876 this part standard and returns -1 from read (0) with errno==EIO
6877 when the control tty is taken away.
6878 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6879 if (nread
== -1 && errno
== EIO
)
6880 return -2; /* Close this device. */
6881 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6882 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6883 This looks incorrect, but it isn't, because _BSD causes
6884 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6885 and that causes a value other than 0 when there is no input. */
6887 return -2; /* Close this device. */
6891 /* We used to retry the read if it was interrupted.
6892 But this does the wrong thing when O_NDELAY causes
6893 an EAGAIN error. Does anybody know of a situation
6894 where a retry is actually needed? */
6896 nread
< 0 && (errno
== EAGAIN
6910 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6911 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6912 #endif /* USG or DGUX or CYGWIN */
6913 #endif /* no FIONREAD */
6918 #endif /* not MSDOS */
6919 #endif /* not WINDOWSNT */
6921 for (i
= 0; i
< nread
; i
++)
6923 struct input_event buf
;
6925 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6927 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6928 buf
.modifiers
= meta_modifier
;
6929 if (tty
->meta_key
!= 2)
6933 /* Set the frame corresponding to the active tty. Note that the
6934 value of selected_frame is not reliable here, redisplay tends
6935 to temporarily change it. */
6936 buf
.frame_or_window
= tty
->top_frame
;
6939 kbd_buffer_store_event (&buf
);
6940 /* Don't look at input that follows a C-g too closely.
6941 This reduces lossage due to autorepeat on C-g. */
6942 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6943 && buf
.code
== quit_char
)
6949 #endif /* not VMS */
6952 handle_async_input ()
6955 extern int select_alarmed
;
6958 interrupt_input_pending
= 0;
6963 nread
= read_avail_input (1);
6964 /* -1 means it's not ok to read the input now.
6965 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6966 0 means there was no keyboard input available. */
6971 select_alarmed
= 1; /* Force the select emulator back to life */
6976 #ifdef SIGIO /* for entire page */
6977 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6980 input_available_signal (signo
)
6983 /* Must preserve main program's value of errno. */
6984 int old_errno
= errno
;
6985 #if defined (USG) && !defined (POSIX_SIGNALS)
6986 /* USG systems forget handlers when they are used;
6987 must reestablish each time */
6988 signal (signo
, input_available_signal
);
6996 interrupt_input_pending
= 1;
6998 SIGNAL_THREAD_CHECK (signo
);
7001 if (input_available_clear_time
)
7002 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7005 handle_async_input ();
7015 /* Send ourselves a SIGIO.
7017 This function exists so that the UNBLOCK_INPUT macro in
7018 blockinput.h can have some way to take care of input we put off
7019 dealing with, without assuming that every file which uses
7020 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7022 reinvoke_input_signal ()
7025 handle_async_input ();
7031 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7032 static Lisp_Object menu_bar_one_keymap_changed_items
;
7034 /* These variables hold the vector under construction within
7035 menu_bar_items and its subroutines, and the current index
7036 for storing into that vector. */
7037 static Lisp_Object menu_bar_items_vector
;
7038 static int menu_bar_items_index
;
7040 /* Return a vector of menu items for a menu bar, appropriate
7041 to the current buffer. Each item has three elements in the vector:
7044 OLD is an old vector we can optionally reuse, or nil. */
7047 menu_bar_items (old
)
7050 /* The number of keymaps we're scanning right now, and the number of
7051 keymaps we have allocated space for. */
7054 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7055 in the current keymaps, or nil where it is not a prefix. */
7058 Lisp_Object def
, tail
;
7067 /* In order to build the menus, we need to call the keymap
7068 accessors. They all call QUIT. But this function is called
7069 during redisplay, during which a quit is fatal. So inhibit
7070 quitting while building the menus.
7071 We do this instead of specbind because (1) errors will clear it anyway
7072 and (2) this avoids risk of specpdl overflow. */
7073 oquit
= Vinhibit_quit
;
7077 menu_bar_items_vector
= old
;
7079 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7080 menu_bar_items_index
= 0;
7082 /* Build our list of keymaps.
7083 If we recognize a function key and replace its escape sequence in
7084 keybuf with its symbol, or if the sequence starts with a mouse
7085 click and we need to switch buffers, we jump back here to rebuild
7086 the initial keymaps from the current buffer. */
7090 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7091 if (!NILP (Voverriding_local_map_menu_flag
))
7093 /* Yes, use them (if non-nil) as well as the global map. */
7094 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7096 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7097 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7098 if (!NILP (Voverriding_local_map
))
7099 maps
[nmaps
++] = Voverriding_local_map
;
7103 /* No, so use major and minor mode keymaps and keymap property.
7104 Note that menu-bar bindings in the local-map and keymap
7105 properties may not work reliable, as they are only
7106 recognized when the menu-bar (or mode-line) is updated,
7107 which does not normally happen after every command. */
7110 nminor
= current_minor_maps (NULL
, &tmaps
);
7111 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7113 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7114 maps
[nmaps
++] = tem
;
7115 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7117 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7119 maps
[nmaps
++] = current_global_map
;
7122 /* Look up in each map the dummy prefix key `menu-bar'. */
7126 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7127 if (!NILP (maps
[mapno
]))
7129 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7133 menu_bar_one_keymap_changed_items
= Qnil
;
7134 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7138 /* Move to the end those items that should be at the end. */
7140 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7143 int end
= menu_bar_items_index
;
7145 for (i
= 0; i
< end
; i
+= 4)
7146 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7148 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7149 /* Move the item at index I to the end,
7150 shifting all the others forward. */
7151 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7152 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7153 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7154 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7156 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7157 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7158 (end
- i
- 4) * sizeof (Lisp_Object
));
7159 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7160 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7161 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7162 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7167 /* Add nil, nil, nil, nil at the end. */
7168 i
= menu_bar_items_index
;
7169 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7172 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7173 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7174 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7175 menu_bar_items_vector
= tem
;
7177 /* Add this item. */
7178 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7179 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7180 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7181 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7182 menu_bar_items_index
= i
;
7184 Vinhibit_quit
= oquit
;
7185 return menu_bar_items_vector
;
7188 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7189 If there's already an item for KEY, add this DEF to it. */
7191 Lisp_Object item_properties
;
7194 menu_bar_item (key
, item
, dummy1
, dummy2
)
7195 Lisp_Object key
, item
, dummy1
;
7198 struct gcpro gcpro1
;
7202 if (EQ (item
, Qundefined
))
7204 /* If a map has an explicit `undefined' as definition,
7205 discard any previously made menu bar item. */
7207 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7208 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7210 if (menu_bar_items_index
> i
+ 4)
7211 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7212 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7213 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7214 menu_bar_items_index
-= 4;
7218 /* If this keymap has already contributed to this KEY,
7219 don't contribute to it a second time. */
7220 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7221 if (!NILP (tem
) || NILP (item
))
7224 menu_bar_one_keymap_changed_items
7225 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7227 /* We add to menu_bar_one_keymap_changed_items before doing the
7228 parse_menu_item, so that if it turns out it wasn't a menu item,
7229 it still correctly hides any further menu item. */
7231 i
= parse_menu_item (item
, 0, 1);
7236 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7238 /* Find any existing item for this KEY. */
7239 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7240 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7243 /* If we did not find this KEY, add it at the end. */
7244 if (i
== menu_bar_items_index
)
7246 /* If vector is too small, get a bigger one. */
7247 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7250 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7251 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7252 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7253 menu_bar_items_vector
= tem
;
7256 /* Add this item. */
7257 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7258 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7259 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7260 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7261 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7262 menu_bar_items_index
= i
;
7264 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7268 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7269 /* If the new and the old items are not both keymaps,
7270 the lookup will only find `item'. */
7271 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7272 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7276 /* This is used as the handler when calling menu_item_eval_property. */
7278 menu_item_eval_property_1 (arg
)
7281 /* If we got a quit from within the menu computation,
7282 quit all the way out of it. This takes care of C-] in the debugger. */
7283 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7284 Fsignal (Qquit
, Qnil
);
7289 /* Evaluate an expression and return the result (or nil if something
7290 went wrong). Used to evaluate dynamic parts of menu items. */
7292 menu_item_eval_property (sexpr
)
7295 int count
= SPECPDL_INDEX ();
7297 specbind (Qinhibit_redisplay
, Qt
);
7298 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7299 menu_item_eval_property_1
);
7300 return unbind_to (count
, val
);
7303 /* This function parses a menu item and leaves the result in the
7304 vector item_properties.
7305 ITEM is a key binding, a possible menu item.
7306 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7307 evaluate dynamic expressions in the menu item.
7308 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7310 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7311 parse_menu_item returns true if the item is a menu item and false
7315 parse_menu_item (item
, notreal
, inmenubar
)
7317 int notreal
, inmenubar
;
7319 Lisp_Object def
, tem
, item_string
, start
;
7320 Lisp_Object cachelist
;
7322 Lisp_Object keyhint
;
7333 /* Create item_properties vector if necessary. */
7334 if (NILP (item_properties
))
7336 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7338 /* Initialize optional entries. */
7339 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7340 AREF (item_properties
, i
) = Qnil
;
7341 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7343 /* Save the item here to protect it from GC. */
7344 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7346 item_string
= XCAR (item
);
7350 if (STRINGP (item_string
))
7352 /* Old format menu item. */
7353 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7355 /* Maybe help string. */
7356 if (CONSP (item
) && STRINGP (XCAR (item
)))
7358 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7363 /* Maybe key binding cache. */
7364 if (CONSP (item
) && CONSP (XCAR (item
))
7365 && (NILP (XCAR (XCAR (item
)))
7366 || VECTORP (XCAR (XCAR (item
)))))
7368 cachelist
= XCAR (item
);
7372 /* This is the real definition--the function to run. */
7373 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7375 /* Get enable property, if any. */
7378 tem
= Fget (item
, Qmenu_enable
);
7380 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7383 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7385 /* New format menu item. */
7386 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7387 start
= XCDR (item
);
7390 /* We have a real binding. */
7391 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7393 item
= XCDR (start
);
7394 /* Is there a cache list with key equivalences. */
7395 if (CONSP (item
) && CONSP (XCAR (item
)))
7397 cachelist
= XCAR (item
);
7401 /* Parse properties. */
7402 while (CONSP (item
) && CONSP (XCDR (item
)))
7407 if (EQ (tem
, QCenable
))
7408 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7409 else if (EQ (tem
, QCvisible
) && !notreal
)
7411 /* If got a visible property and that evaluates to nil
7412 then ignore this item. */
7413 tem
= menu_item_eval_property (XCAR (item
));
7417 else if (EQ (tem
, QChelp
))
7418 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7419 else if (EQ (tem
, QCfilter
))
7421 else if (EQ (tem
, QCkey_sequence
))
7424 if (NILP (cachelist
)
7425 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7426 /* Be GC protected. Set keyhint to item instead of tem. */
7429 else if (EQ (tem
, QCkeys
))
7432 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7433 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7435 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7440 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7442 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7444 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7451 else if (inmenubar
|| !NILP (start
))
7455 return 0; /* not a menu item */
7457 /* If item string is not a string, evaluate it to get string.
7458 If we don't get a string, skip this item. */
7459 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7460 if (!(STRINGP (item_string
) || notreal
))
7462 item_string
= menu_item_eval_property (item_string
);
7463 if (!STRINGP (item_string
))
7465 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7468 /* If got a filter apply it on definition. */
7469 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7472 def
= menu_item_eval_property (list2 (XCAR (filter
),
7473 list2 (Qquote
, def
)));
7475 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7478 /* Enable or disable selection of item. */
7479 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7485 tem
= menu_item_eval_property (tem
);
7486 if (inmenubar
&& NILP (tem
))
7487 return 0; /* Ignore disabled items in menu bar. */
7488 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7491 /* If we got no definition, this item is just unselectable text which
7492 is OK in a submenu but not in the menubar. */
7494 return (inmenubar
? 0 : 1);
7496 /* See if this is a separate pane or a submenu. */
7497 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7498 tem
= get_keymap (def
, 0, 1);
7499 /* For a subkeymap, just record its details and exit. */
7502 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7503 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7507 /* At the top level in the menu bar, do likewise for commands also.
7508 The menu bar does not display equivalent key bindings anyway.
7509 ITEM_PROPERTY_DEF is already set up properly. */
7513 /* This is a command. See if there is an equivalent key binding. */
7514 if (NILP (cachelist
))
7516 /* We have to create a cachelist. */
7517 CHECK_IMPURE (start
);
7518 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7519 cachelist
= XCAR (XCDR (start
));
7521 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7522 if (!NILP (keyhint
))
7524 XSETCAR (cachelist
, XCAR (keyhint
));
7527 else if (STRINGP (tem
))
7529 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7530 XSETCAR (cachelist
, Qt
);
7534 tem
= XCAR (cachelist
);
7541 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7543 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7546 def
= XCAR (prefix
);
7547 prefix
= XCDR (prefix
);
7550 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7552 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7554 if (newcache
/* Always check first time. */
7555 /* Should we check everything when precomputing key
7557 /* If something had no key binding before, don't recheck it
7558 because that is too slow--except if we have a list of
7559 rebound commands in Vdefine_key_rebound_commands, do
7560 recheck any command that appears in that list. */
7561 || (CONSP (Vdefine_key_rebound_commands
)
7562 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7565 /* We had a saved key. Is it still bound to the command? */
7568 /* If the command is an alias for another
7569 (such as lmenu.el set it up), check if the
7570 original command matches the cached command. */
7571 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7572 chkcache
= 1; /* Need to recompute key binding. */
7576 /* Recompute equivalent key binding. If the command is an alias
7577 for another (such as lmenu.el set it up), see if the original
7578 command name has equivalent keys. Otherwise look up the
7579 specified command itself. We don't try both, because that
7580 makes lmenu menus slow. */
7582 && SYMBOLP (XSYMBOL (def
)->function
)
7583 && ! NILP (Fget (def
, Qmenu_alias
)))
7584 def
= XSYMBOL (def
)->function
;
7585 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7586 XSETCAR (cachelist
, tem
);
7589 XSETCDR (cachelist
, Qnil
);
7593 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7595 tem
= XCAR (cachelist
);
7599 newcache
= chkcache
;
7602 tem
= Fkey_description (tem
, Qnil
);
7605 if (STRINGP (XCAR (prefix
)))
7606 tem
= concat2 (XCAR (prefix
), tem
);
7607 if (STRINGP (XCDR (prefix
)))
7608 tem
= concat2 (tem
, XCDR (prefix
));
7610 XSETCDR (cachelist
, tem
);
7614 tem
= XCDR (cachelist
);
7615 if (newcache
&& !NILP (tem
))
7617 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7618 XSETCDR (cachelist
, tem
);
7621 /* If we only want to precompute equivalent key bindings, stop here. */
7625 /* If we have an equivalent key binding, use that. */
7626 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7628 /* Include this when menu help is implemented.
7629 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7630 if (!(NILP (tem) || STRINGP (tem)))
7632 tem = menu_item_eval_property (tem);
7635 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7639 /* Handle radio buttons or toggle boxes. */
7640 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7642 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7643 = menu_item_eval_property (tem
);
7650 /***********************************************************************
7652 ***********************************************************************/
7654 /* A vector holding tool bar items while they are parsed in function
7655 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7658 static Lisp_Object tool_bar_items_vector
;
7660 /* A vector holding the result of parse_tool_bar_item. Layout is like
7661 the one for a single item in tool_bar_items_vector. */
7663 static Lisp_Object tool_bar_item_properties
;
7665 /* Next free index in tool_bar_items_vector. */
7667 static int ntool_bar_items
;
7669 /* The symbols `tool-bar', and `:image'. */
7671 extern Lisp_Object Qtool_bar
;
7672 Lisp_Object QCimage
;
7674 /* Function prototypes. */
7676 static void init_tool_bar_items
P_ ((Lisp_Object
));
7677 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7678 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7679 static void append_tool_bar_item
P_ ((void));
7682 /* Return a vector of tool bar items for keymaps currently in effect.
7683 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7684 tool bar items found. */
7687 tool_bar_items (reuse
, nitems
)
7698 /* In order to build the menus, we need to call the keymap
7699 accessors. They all call QUIT. But this function is called
7700 during redisplay, during which a quit is fatal. So inhibit
7701 quitting while building the menus. We do this instead of
7702 specbind because (1) errors will clear it anyway and (2) this
7703 avoids risk of specpdl overflow. */
7704 oquit
= Vinhibit_quit
;
7707 /* Initialize tool_bar_items_vector and protect it from GC. */
7708 init_tool_bar_items (reuse
);
7710 /* Build list of keymaps in maps. Set nmaps to the number of maps
7713 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7714 if (!NILP (Voverriding_local_map_menu_flag
))
7716 /* Yes, use them (if non-nil) as well as the global map. */
7717 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7719 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7720 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7721 if (!NILP (Voverriding_local_map
))
7722 maps
[nmaps
++] = Voverriding_local_map
;
7726 /* No, so use major and minor mode keymaps and keymap property.
7727 Note that tool-bar bindings in the local-map and keymap
7728 properties may not work reliable, as they are only
7729 recognized when the tool-bar (or mode-line) is updated,
7730 which does not normally happen after every command. */
7733 nminor
= current_minor_maps (NULL
, &tmaps
);
7734 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7736 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7737 maps
[nmaps
++] = tem
;
7738 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7740 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7743 /* Add global keymap at the end. */
7744 maps
[nmaps
++] = current_global_map
;
7746 /* Process maps in reverse order and look up in each map the prefix
7748 for (i
= nmaps
- 1; i
>= 0; --i
)
7749 if (!NILP (maps
[i
]))
7753 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7758 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7759 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7761 Lisp_Object keydef
= XCAR (tail
);
7763 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7768 Vinhibit_quit
= oquit
;
7769 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7770 return tool_bar_items_vector
;
7774 /* Process the definition of KEY which is DEF. */
7777 process_tool_bar_item (key
, def
)
7778 Lisp_Object key
, def
;
7781 extern Lisp_Object Qundefined
;
7782 struct gcpro gcpro1
, gcpro2
;
7784 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7788 if (EQ (def
, Qundefined
))
7790 /* If a map has an explicit `undefined' as definition,
7791 discard any previously made item. */
7792 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7794 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7796 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7798 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7799 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7800 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7801 * sizeof (Lisp_Object
)));
7802 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7807 else if (parse_tool_bar_item (key
, def
))
7808 /* Append a new tool bar item to tool_bar_items_vector. Accept
7809 more than one definition for the same key. */
7810 append_tool_bar_item ();
7816 /* Parse a tool bar item specification ITEM for key KEY and return the
7817 result in tool_bar_item_properties. Value is zero if ITEM is
7820 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7822 CAPTION is the caption of the item, If it's not a string, it is
7823 evaluated to get a string.
7825 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7826 as binding are currently ignored.
7828 The following properties are recognized:
7832 FORM is evaluated and specifies whether the tool bar item is
7833 enabled or disabled.
7837 FORM is evaluated and specifies whether the tool bar item is visible.
7839 - `:filter FUNCTION'
7841 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7842 result is stored as the new binding.
7844 - `:button (TYPE SELECTED)'
7846 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7847 and specifies whether the button is selected (pressed) or not.
7851 IMAGES is either a single image specification or a vector of four
7852 image specifications. See enum tool_bar_item_images.
7854 - `:help HELP-STRING'.
7856 Gives a help string to display for the tool bar item. */
7859 parse_tool_bar_item (key
, item
)
7860 Lisp_Object key
, item
;
7862 /* Access slot with index IDX of vector tool_bar_item_properties. */
7863 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7865 Lisp_Object filter
= Qnil
;
7866 Lisp_Object caption
;
7869 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7870 Rule out items that aren't lists, don't start with
7871 `menu-item' or whose rest following `tool-bar-item' is not a
7874 || !EQ (XCAR (item
), Qmenu_item
)
7875 || (item
= XCDR (item
),
7879 /* Create tool_bar_item_properties vector if necessary. Reset it to
7881 if (VECTORP (tool_bar_item_properties
))
7883 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7887 tool_bar_item_properties
7888 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7891 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7892 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7894 /* Get the caption of the item. If the caption is not a string,
7895 evaluate it to get a string. If we don't get a string, skip this
7897 caption
= XCAR (item
);
7898 if (!STRINGP (caption
))
7900 caption
= menu_item_eval_property (caption
);
7901 if (!STRINGP (caption
))
7904 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7906 /* Give up if rest following the caption is not a list. */
7911 /* Store the binding. */
7912 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7915 /* Ignore cached key binding, if any. */
7916 if (CONSP (item
) && CONSP (XCAR (item
)))
7919 /* Process the rest of the properties. */
7920 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7922 Lisp_Object key
, value
;
7925 value
= XCAR (XCDR (item
));
7927 if (EQ (key
, QCenable
))
7928 /* `:enable FORM'. */
7929 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7930 else if (EQ (key
, QCvisible
))
7932 /* `:visible FORM'. If got a visible property and that
7933 evaluates to nil then ignore this item. */
7934 if (NILP (menu_item_eval_property (value
)))
7937 else if (EQ (key
, QChelp
))
7938 /* `:help HELP-STRING'. */
7939 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7940 else if (EQ (key
, QCfilter
))
7941 /* ':filter FORM'. */
7943 else if (EQ (key
, QCbutton
) && CONSP (value
))
7945 /* `:button (TYPE . SELECTED)'. */
7946 Lisp_Object type
, selected
;
7948 type
= XCAR (value
);
7949 selected
= XCDR (value
);
7950 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7952 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7953 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7956 else if (EQ (key
, QCimage
)
7958 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7959 /* Value is either a single image specification or a vector
7960 of 4 such specifications for the different button states. */
7961 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7964 /* If got a filter apply it on binding. */
7966 PROP (TOOL_BAR_ITEM_BINDING
)
7967 = menu_item_eval_property (list2 (filter
,
7969 PROP (TOOL_BAR_ITEM_BINDING
))));
7971 /* See if the binding is a keymap. Give up if it is. */
7972 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7975 /* Enable or disable selection of item. */
7976 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7977 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7978 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7980 /* Handle radio buttons or toggle boxes. */
7981 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7982 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7983 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7991 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7992 that can be reused. */
7995 init_tool_bar_items (reuse
)
7998 if (VECTORP (reuse
))
7999 tool_bar_items_vector
= reuse
;
8001 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8002 ntool_bar_items
= 0;
8006 /* Append parsed tool bar item properties from
8007 tool_bar_item_properties */
8010 append_tool_bar_item ()
8012 Lisp_Object
*to
, *from
;
8014 /* Enlarge tool_bar_items_vector if necessary. */
8015 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8016 >= XVECTOR (tool_bar_items_vector
)->size
)
8018 Lisp_Object new_vector
;
8019 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
8021 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
8022 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
8023 XVECTOR (new_vector
)->contents
,
8024 old_size
* sizeof (Lisp_Object
));
8025 tool_bar_items_vector
= new_vector
;
8028 /* Append entries from tool_bar_item_properties to the end of
8029 tool_bar_items_vector. */
8030 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8031 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8032 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8033 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8040 /* Read a character using menus based on maps in the array MAPS.
8041 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8042 Return t if we displayed a menu but the user rejected it.
8044 PREV_EVENT is the previous input event, or nil if we are reading
8045 the first event of a key sequence.
8047 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8048 if we used a mouse menu to read the input, or zero otherwise. If
8049 USED_MOUSE_MENU is null, we don't dereference it.
8051 The prompting is done based on the prompt-string of the map
8052 and the strings associated with various map elements.
8054 This can be done with X menus or with menus put in the minibuf.
8055 These are done in different ways, depending on how the input will be read.
8056 Menus using X are done after auto-saving in read-char, getting the input
8057 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8058 and do auto-saving in the inner call of read_char. */
8061 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8064 Lisp_Object prev_event
;
8065 int *used_mouse_menu
;
8068 register Lisp_Object name
= Qnil
;
8070 if (used_mouse_menu
)
8071 *used_mouse_menu
= 0;
8073 /* Use local over global Menu maps */
8075 if (! menu_prompting
)
8078 /* Optionally disregard all but the global map. */
8079 if (inhibit_local_menu_bar_menus
)
8081 maps
+= (nmaps
- 1);
8085 /* Get the menu name from the first map that has one (a prompt string). */
8086 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8088 name
= Fkeymap_prompt (maps
[mapno
]);
8093 /* If we don't have any menus, just read a character normally. */
8094 if (!STRINGP (name
))
8098 /* If we got to this point via a mouse click,
8099 use a real menu for mouse selection. */
8100 if (EVENT_HAS_PARAMETERS (prev_event
)
8101 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8102 && !EQ (XCAR (prev_event
), Qtool_bar
))
8104 /* Display the menu and get the selection. */
8105 Lisp_Object
*realmaps
8106 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8110 /* Use the maps that are not nil. */
8111 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8112 if (!NILP (maps
[mapno
]))
8113 realmaps
[nmaps1
++] = maps
[mapno
];
8115 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8120 record_menu_key (XCAR (value
));
8122 /* If we got multiple events, unread all but
8124 There is no way to prevent those unread events
8125 from showing up later in last_nonmenu_event.
8126 So turn symbol and integer events into lists,
8127 to indicate that they came from a mouse menu,
8128 so that when present in last_nonmenu_event
8129 they won't confuse things. */
8130 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8132 record_menu_key (XCAR (tem
));
8133 if (SYMBOLP (XCAR (tem
))
8134 || INTEGERP (XCAR (tem
)))
8135 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8138 /* If we got more than one event, put all but the first
8139 onto this list to be read later.
8140 Return just the first event now. */
8141 Vunread_command_events
8142 = nconc2 (XCDR (value
), Vunread_command_events
);
8143 value
= XCAR (value
);
8145 else if (NILP (value
))
8147 if (used_mouse_menu
)
8148 *used_mouse_menu
= 1;
8151 #endif /* HAVE_MENUS */
8155 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8156 We make this bigger when necessary, and never free it. */
8157 static char *read_char_minibuf_menu_text
;
8158 /* Size of that buffer. */
8159 static int read_char_minibuf_menu_width
;
8162 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8168 register Lisp_Object name
;
8170 /* FIXME: Use the minibuffer's frame width. */
8171 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8174 Lisp_Object rest
, vector
;
8180 if (! menu_prompting
)
8183 /* Make sure we have a big enough buffer for the menu text. */
8184 if (read_char_minibuf_menu_text
== 0)
8186 read_char_minibuf_menu_width
= width
+ 4;
8187 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8189 else if (width
+ 4 > read_char_minibuf_menu_width
)
8191 read_char_minibuf_menu_width
= width
+ 4;
8192 read_char_minibuf_menu_text
8193 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8195 menu
= read_char_minibuf_menu_text
;
8197 /* Get the menu name from the first map that has one (a prompt string). */
8198 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8200 name
= Fkeymap_prompt (maps
[mapno
]);
8205 /* If we don't have any menus, just read a character normally. */
8206 if (!STRINGP (name
))
8209 /* Prompt string always starts with map's prompt, and a space. */
8210 strcpy (menu
, SDATA (name
));
8211 nlength
= SBYTES (name
);
8212 menu
[nlength
++] = ':';
8213 menu
[nlength
++] = ' ';
8216 /* Start prompting at start of first map. */
8220 /* Present the documented bindings, a line at a time. */
8227 Lisp_Object orig_defn_macro
;
8229 /* Loop over elements of map. */
8234 /* If reached end of map, start at beginning of next map. */
8238 /* At end of last map, wrap around to first map if just starting,
8239 or end this line if already have something on it. */
8243 if (notfirst
|| nobindings
) break;
8248 /* Look at the next element of the map. */
8250 elt
= XVECTOR (vector
)->contents
[idx
];
8252 elt
= Fcar_safe (rest
);
8254 if (idx
< 0 && VECTORP (elt
))
8256 /* If we found a dense table in the keymap,
8257 advanced past it, but start scanning its contents. */
8258 rest
= Fcdr_safe (rest
);
8264 /* An ordinary element. */
8265 Lisp_Object event
, tem
;
8269 event
= Fcar_safe (elt
); /* alist */
8270 elt
= Fcdr_safe (elt
);
8274 XSETINT (event
, idx
); /* vector */
8277 /* Ignore the element if it has no prompt string. */
8278 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8280 /* 1 if the char to type matches the string. */
8282 Lisp_Object upcased_event
, downcased_event
;
8283 Lisp_Object desc
= Qnil
;
8285 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8287 upcased_event
= Fupcase (event
);
8288 downcased_event
= Fdowncase (event
);
8289 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8290 || XINT (downcased_event
) == SREF (s
, 0));
8292 desc
= Fsingle_key_description (event
, Qnil
);
8294 #if 0 /* It is redundant to list the equivalent key bindings because
8295 the prefix is what the user has already typed. */
8297 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8299 /* Insert equivalent keybinding. */
8300 s
= concat2 (s
, tem
);
8303 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8304 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8306 /* Insert button prefix. */
8307 Lisp_Object selected
8308 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8309 if (EQ (tem
, QCradio
))
8310 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8312 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8313 s
= concat2 (tem
, s
);
8317 /* If we have room for the prompt string, add it to this line.
8318 If this is the first on the line, always add it. */
8319 if ((SCHARS (s
) + i
+ 2
8320 + (char_matches
? 0 : SCHARS (desc
) + 3))
8326 /* Punctuate between strings. */
8329 strcpy (menu
+ i
, ", ");
8335 /* If the char to type doesn't match the string's
8336 first char, explicitly show what char to type. */
8339 /* Add as much of string as fits. */
8340 thiswidth
= SCHARS (desc
);
8341 if (thiswidth
+ i
> width
)
8342 thiswidth
= width
- i
;
8343 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8345 strcpy (menu
+ i
, " = ");
8349 /* Add as much of string as fits. */
8350 thiswidth
= SCHARS (s
);
8351 if (thiswidth
+ i
> width
)
8352 thiswidth
= width
- i
;
8353 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8359 /* If this element does not fit, end the line now,
8360 and save the element for the next line. */
8361 strcpy (menu
+ i
, "...");
8366 /* Move past this element. */
8367 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8368 /* Handle reaching end of dense table. */
8373 rest
= Fcdr_safe (rest
);
8377 /* Prompt with that and read response. */
8378 message2_nolog (menu
, strlen (menu
),
8379 ! NILP (current_buffer
->enable_multibyte_characters
));
8381 /* Make believe its not a keyboard macro in case the help char
8382 is pressed. Help characters are not recorded because menu prompting
8383 is not used on replay.
8385 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8386 current_kboard
->defining_kbd_macro
= Qnil
;
8388 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8389 while (BUFFERP (obj
));
8390 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8392 if (!INTEGERP (obj
))
8397 if (! EQ (obj
, menu_prompt_more_char
)
8398 && (!INTEGERP (menu_prompt_more_char
)
8399 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8401 if (!NILP (current_kboard
->defining_kbd_macro
))
8402 store_kbd_macro_char (obj
);
8405 /* Help char - go round again */
8409 /* Reading key sequences. */
8411 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8412 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8413 keymap, or nil otherwise. Return the index of the first keymap in
8414 which KEY has any binding, or NMAPS if no map has a binding.
8416 If KEY is a meta ASCII character, treat it like meta-prefix-char
8417 followed by the corresponding non-meta character. Keymaps in
8418 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8421 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8424 NEXT may be the same array as CURRENT. */
8427 follow_key (key
, nmaps
, current
, defs
, next
)
8429 Lisp_Object
*current
, *defs
, *next
;
8432 int i
, first_binding
;
8434 first_binding
= nmaps
;
8435 for (i
= nmaps
- 1; i
>= 0; i
--)
8437 if (! NILP (current
[i
]))
8439 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8440 if (! NILP (defs
[i
]))
8447 /* Given the set of bindings we've found, produce the next set of maps. */
8448 if (first_binding
< nmaps
)
8449 for (i
= 0; i
< nmaps
; i
++)
8450 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8452 return first_binding
;
8455 /* Structure used to keep track of partial application of key remapping
8456 such as Vfunction_key_map and Vkey_translation_map. */
8457 typedef struct keyremap
8459 Lisp_Object map
, parent
;
8463 /* Lookup KEY in MAP.
8464 MAP is a keymap mapping keys to key vectors or functions.
8465 If the mapping is a function and DO_FUNCTION is non-zero, then
8466 the function is called with PROMPT as parameter and its return
8467 value is used as the return value of this function (after checking
8468 that it is indeed a vector). */
8471 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8472 Lisp_Object map
, key
, prompt
;
8477 next
= access_keymap (map
, key
, 1, 0, 1);
8479 /* Handle symbol with autoload definition. */
8480 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8481 && CONSP (XSYMBOL (next
)->function
)
8482 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8483 do_autoload (XSYMBOL (next
)->function
, next
);
8485 /* Handle a symbol whose function definition is a keymap
8487 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8488 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8489 || KEYMAPP (XSYMBOL (next
)->function
)))
8490 next
= XSYMBOL (next
)->function
;
8492 /* If the keymap gives a function, not an
8493 array, then call the function with one arg and use
8494 its value instead. */
8495 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8500 next
= call1 (next
, prompt
);
8501 /* If the function returned something invalid,
8502 barf--don't ignore it.
8503 (To ignore it safely, we would need to gcpro a bunch of
8504 other variables.) */
8505 if (! (VECTORP (next
) || STRINGP (next
)))
8506 error ("Function %s returns invalid key sequence", tem
);
8511 /* Do one step of the key remapping used for function-key-map and
8512 key-translation-map:
8513 KEYBUF is the buffer holding the input events.
8514 BUFSIZE is its maximum size.
8515 FKEY is a pointer to the keyremap structure to use.
8516 INPUT is the index of the last element in KEYBUF.
8517 DOIT if non-zero says that the remapping can actually take place.
8518 DIFF is used to return the number of keys added/removed by the remapping.
8519 PARENT is the root of the keymap.
8520 PROMPT is the prompt to use if the remapping happens through a function.
8521 The return value is non-zero if the remapping actually took place. */
8524 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8525 Lisp_Object
*keybuf
, prompt
;
8527 int input
, doit
, *diff
, bufsize
;
8529 Lisp_Object next
, key
;
8531 key
= keybuf
[fkey
->end
++];
8532 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8534 /* If keybuf[fkey->start..fkey->end] is bound in the
8535 map and we're in a position to do the key remapping, replace it with
8536 the binding and restart with fkey->start at the end. */
8537 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8539 int len
= XFASTINT (Flength (next
));
8542 *diff
= len
- (fkey
->end
- fkey
->start
);
8544 if (input
+ *diff
>= bufsize
)
8545 error ("Key sequence too long");
8547 /* Shift the keys that follow fkey->end. */
8549 for (i
= fkey
->end
; i
< input
; i
++)
8550 keybuf
[i
+ *diff
] = keybuf
[i
];
8552 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8553 keybuf
[i
+ *diff
] = keybuf
[i
];
8554 /* Overwrite the old keys with the new ones. */
8555 for (i
= 0; i
< len
; i
++)
8556 keybuf
[fkey
->start
+ i
]
8557 = Faref (next
, make_number (i
));
8559 fkey
->start
= fkey
->end
+= *diff
;
8560 fkey
->map
= fkey
->parent
;
8565 fkey
->map
= get_keymap (next
, 0, 1);
8567 /* If we no longer have a bound suffix, try a new position for
8569 if (!CONSP (fkey
->map
))
8571 fkey
->end
= ++fkey
->start
;
8572 fkey
->map
= fkey
->parent
;
8577 /* Read a sequence of keys that ends with a non prefix character,
8578 storing it in KEYBUF, a buffer of size BUFSIZE.
8580 Return the length of the key sequence stored.
8581 Return -1 if the user rejected a command menu.
8583 Echo starting immediately unless `prompt' is 0.
8585 Where a key sequence ends depends on the currently active keymaps.
8586 These include any minor mode keymaps active in the current buffer,
8587 the current buffer's local map, and the global map.
8589 If a key sequence has no other bindings, we check Vfunction_key_map
8590 to see if some trailing subsequence might be the beginning of a
8591 function key's sequence. If so, we try to read the whole function
8592 key, and substitute its symbolic name into the key sequence.
8594 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8595 `double-' events into similar click events, if that would make them
8596 bound. We try to turn `triple-' events first into `double-' events,
8599 If we get a mouse click in a mode line, vertical divider, or other
8600 non-text area, we treat the click as if it were prefixed by the
8601 symbol denoting that area - `mode-line', `vertical-line', or
8604 If the sequence starts with a mouse click, we read the key sequence
8605 with respect to the buffer clicked on, not the current buffer.
8607 If the user switches frames in the midst of a key sequence, we put
8608 off the switch-frame event until later; the next call to
8609 read_char will return it.
8611 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8612 from the selected window's buffer. */
8615 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8616 can_return_switch_frame
, fix_current_buffer
)
8617 Lisp_Object
*keybuf
;
8620 int dont_downcase_last
;
8621 int can_return_switch_frame
;
8622 int fix_current_buffer
;
8624 volatile Lisp_Object from_string
;
8625 volatile int count
= SPECPDL_INDEX ();
8627 /* How many keys there are in the current key sequence. */
8630 /* The length of the echo buffer when we started reading, and
8631 the length of this_command_keys when we started reading. */
8632 volatile int echo_start
;
8633 volatile int keys_start
;
8635 /* The number of keymaps we're scanning right now, and the number of
8636 keymaps we have allocated space for. */
8638 volatile int nmaps_allocated
= 0;
8640 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8641 the current keymaps. */
8642 Lisp_Object
*volatile defs
= NULL
;
8644 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8645 in the current keymaps, or nil where it is not a prefix. */
8646 Lisp_Object
*volatile submaps
= NULL
;
8648 /* The local map to start out with at start of key sequence. */
8649 volatile Lisp_Object orig_local_map
;
8651 /* The map from the `keymap' property to start out with at start of
8653 volatile Lisp_Object orig_keymap
;
8655 /* 1 if we have already considered switching to the local-map property
8656 of the place where a mouse click occurred. */
8657 volatile int localized_local_map
= 0;
8659 /* The index in defs[] of the first keymap that has a binding for
8660 this key sequence. In other words, the lowest i such that
8661 defs[i] is non-nil. */
8662 volatile int first_binding
;
8663 /* Index of the first key that has no binding.
8664 It is useless to try fkey.start larger than that. */
8665 volatile int first_unbound
;
8667 /* If t < mock_input, then KEYBUF[t] should be read as the next
8670 We use this to recover after recognizing a function key. Once we
8671 realize that a suffix of the current key sequence is actually a
8672 function key's escape sequence, we replace the suffix with the
8673 function key's binding from Vfunction_key_map. Now keybuf
8674 contains a new and different key sequence, so the echo area,
8675 this_command_keys, and the submaps and defs arrays are wrong. In
8676 this situation, we set mock_input to t, set t to 0, and jump to
8677 restart_sequence; the loop will read keys from keybuf up until
8678 mock_input, thus rebuilding the state; and then it will resume
8679 reading characters from the keyboard. */
8680 volatile int mock_input
= 0;
8682 /* If the sequence is unbound in submaps[], then
8683 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8684 and fkey.map is its binding.
8686 These might be > t, indicating that all function key scanning
8687 should hold off until t reaches them. We do this when we've just
8688 recognized a function key, to avoid searching for the function
8689 key's again in Vfunction_key_map. */
8690 volatile keyremap fkey
;
8692 /* Likewise, for key_translation_map. */
8693 volatile keyremap keytran
;
8695 /* If we receive a `switch-frame' or `select-window' event in the middle of
8696 a key sequence, we put it off for later.
8697 While we're reading, we keep the event here. */
8698 volatile Lisp_Object delayed_switch_frame
;
8700 /* See the comment below... */
8701 #if defined (GOBBLE_FIRST_EVENT)
8702 Lisp_Object first_event
;
8705 volatile Lisp_Object original_uppercase
;
8706 volatile int original_uppercase_position
= -1;
8708 /* Gets around Microsoft compiler limitations. */
8711 struct buffer
*starting_buffer
;
8713 /* List of events for which a fake prefix key has been generated. */
8714 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8716 #if defined (GOBBLE_FIRST_EVENT)
8720 struct gcpro gcpro1
;
8722 GCPRO1 (fake_prefixed_keys
);
8723 raw_keybuf_count
= 0;
8725 last_nonmenu_event
= Qnil
;
8727 delayed_switch_frame
= Qnil
;
8728 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
8729 keytran
.map
= keytran
.parent
= current_kboard
->Vlocal_key_translation_map
;
8730 /* If there is no translation-map, turn off scanning. */
8731 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8732 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8737 echo_prompt (prompt
);
8738 else if (cursor_in_echo_area
8739 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8740 && NILP (Fzerop (Vecho_keystrokes
)))
8741 /* This doesn't put in a dash if the echo buffer is empty, so
8742 you don't always see a dash hanging out in the minibuffer. */
8746 /* Record the initial state of the echo area and this_command_keys;
8747 we will need to restore them if we replay a key sequence. */
8749 echo_start
= echo_length ();
8750 keys_start
= this_command_key_count
;
8751 this_single_command_key_start
= keys_start
;
8753 #if defined (GOBBLE_FIRST_EVENT)
8754 /* This doesn't quite work, because some of the things that read_char
8755 does cannot safely be bypassed. It seems too risky to try to make
8758 /* Read the first char of the sequence specially, before setting
8759 up any keymaps, in case a filter runs and switches buffers on us. */
8760 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8762 #endif /* GOBBLE_FIRST_EVENT */
8764 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8765 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8768 /* We jump here when the key sequence has been thoroughly changed, and
8769 we need to rescan it starting from the beginning. When we jump here,
8770 keybuf[0..mock_input] holds the sequence we should reread. */
8773 starting_buffer
= current_buffer
;
8774 first_unbound
= bufsize
+ 1;
8776 /* Build our list of keymaps.
8777 If we recognize a function key and replace its escape sequence in
8778 keybuf with its symbol, or if the sequence starts with a mouse
8779 click and we need to switch buffers, we jump back here to rebuild
8780 the initial keymaps from the current buffer. */
8783 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8784 || !NILP (Voverriding_local_map
))
8786 if (3 > nmaps_allocated
)
8788 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8789 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8790 nmaps_allocated
= 3;
8792 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8793 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8794 if (!NILP (Voverriding_local_map
))
8795 submaps
[nmaps
++] = Voverriding_local_map
;
8803 nminor
= current_minor_maps (0, &maps
);
8804 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8806 if (total
> nmaps_allocated
)
8808 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8809 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8810 nmaps_allocated
= total
;
8813 if (!NILP (orig_keymap
))
8814 submaps
[nmaps
++] = orig_keymap
;
8816 bcopy (maps
, (void *) (submaps
+ nmaps
),
8817 nminor
* sizeof (submaps
[0]));
8821 submaps
[nmaps
++] = orig_local_map
;
8823 submaps
[nmaps
++] = current_global_map
;
8825 /* Find an accurate initial value for first_binding. */
8826 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8827 if (! NILP (submaps
[first_binding
]))
8830 /* Start from the beginning in keybuf. */
8833 /* These are no-ops the first time through, but if we restart, they
8834 revert the echo area and this_command_keys to their original state. */
8835 this_command_key_count
= keys_start
;
8836 if (INTERACTIVE
&& t
< mock_input
)
8837 echo_truncate (echo_start
);
8839 /* If the best binding for the current key sequence is a keymap, or
8840 we may be looking at a function key's escape sequence, keep on
8842 while (first_binding
< nmaps
8843 /* Keep reading as long as there's a prefix binding. */
8844 ? !NILP (submaps
[first_binding
])
8845 /* Don't return in the middle of a possible function key sequence,
8846 if the only bindings we found were via case conversion.
8847 Thus, if ESC O a has a function-key-map translation
8848 and ESC o has a binding, don't return after ESC O,
8849 so that we can translate ESC O plus the next character. */
8850 : (fkey
.start
< t
|| keytran
.start
< t
))
8853 int used_mouse_menu
= 0;
8855 /* Where the last real key started. If we need to throw away a
8856 key that has expanded into more than one element of keybuf
8857 (say, a mouse click on the mode line which is being treated
8858 as [mode-line (mouse-...)], then we backtrack to this point
8860 volatile int last_real_key_start
;
8862 /* These variables are analogous to echo_start and keys_start;
8863 while those allow us to restart the entire key sequence,
8864 echo_local_start and keys_local_start allow us to throw away
8866 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8868 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8869 eassert (fkey
.start
<= fkey
.end
);
8870 eassert (keytran
.start
<= keytran
.end
);
8871 /* key-translation-map is applied *after* function-key-map. */
8872 eassert (keytran
.end
<= fkey
.start
);
8874 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8875 { /* The prefix upto first_unbound has no binding and has
8876 no translation left to do either, so we know it's unbound.
8877 If we don't stop now, we risk staying here indefinitely
8878 (if the user keeps entering fkey or keytran prefixes
8879 like C-c ESC ESC ESC ESC ...) */
8881 for (i
= first_unbound
+ 1; i
< t
; i
++)
8882 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8883 mock_input
= t
- first_unbound
- 1;
8884 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8885 fkey
.map
= fkey
.parent
;
8886 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8887 keytran
.map
= keytran
.parent
;
8888 goto replay_sequence
;
8892 error ("Key sequence too long");
8895 echo_local_start
= echo_length ();
8896 keys_local_start
= this_command_key_count
;
8897 local_first_binding
= first_binding
;
8900 /* These are no-ops, unless we throw away a keystroke below and
8901 jumped back up to replay_key; in that case, these restore the
8902 variables to their original state, allowing us to replay the
8904 if (INTERACTIVE
&& t
< mock_input
)
8905 echo_truncate (echo_local_start
);
8906 this_command_key_count
= keys_local_start
;
8907 first_binding
= local_first_binding
;
8909 /* By default, assume each event is "real". */
8910 last_real_key_start
= t
;
8912 /* Does mock_input indicate that we are re-reading a key sequence? */
8916 add_command_key (key
);
8917 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8918 && NILP (Fzerop (Vecho_keystrokes
)))
8922 /* If not, we should actually read a character. */
8927 KBOARD
*interrupted_kboard
= current_kboard
;
8928 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8929 if (setjmp (wrong_kboard_jmpbuf
))
8931 if (!NILP (delayed_switch_frame
))
8933 interrupted_kboard
->kbd_queue
8934 = Fcons (delayed_switch_frame
,
8935 interrupted_kboard
->kbd_queue
);
8936 delayed_switch_frame
= Qnil
;
8939 interrupted_kboard
->kbd_queue
8940 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8942 /* If the side queue is non-empty, ensure it begins with a
8943 switch-frame, so we'll replay it in the right context. */
8944 if (CONSP (interrupted_kboard
->kbd_queue
)
8945 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8946 !(EVENT_HAS_PARAMETERS (key
)
8947 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8951 XSETFRAME (frame
, interrupted_frame
);
8952 interrupted_kboard
->kbd_queue
8953 = Fcons (make_lispy_switch_frame (frame
),
8954 interrupted_kboard
->kbd_queue
);
8957 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8958 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8959 goto replay_sequence
;
8962 key
= read_char (NILP (prompt
), nmaps
,
8963 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8967 /* read_char returns t when it shows a menu and the user rejects it.
8971 unbind_to (count
, Qnil
);
8976 /* read_char returns -1 at the end of a macro.
8977 Emacs 18 handles this by returning immediately with a
8978 zero, so that's what we'll do. */
8979 if (INTEGERP (key
) && XINT (key
) == -1)
8982 /* The Microsoft C compiler can't handle the goto that
8988 /* If the current buffer has been changed from under us, the
8989 keymap may have changed, so replay the sequence. */
8992 timer_resume_idle ();
8995 /* Reset the current buffer from the selected window
8996 in case something changed the former and not the latter.
8997 This is to be more consistent with the behavior
8998 of the command_loop_1. */
8999 if (fix_current_buffer
)
9001 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9003 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9004 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9007 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9008 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9009 goto replay_sequence
;
9012 /* If we have a quit that was typed in another frame, and
9013 quit_throw_to_read_char switched buffers,
9014 replay to get the right keymap. */
9016 && XINT (key
) == quit_char
9017 && current_buffer
!= starting_buffer
)
9020 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9024 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9025 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9026 goto replay_sequence
;
9031 if (EVENT_HAS_PARAMETERS (key
)
9032 /* Either a `switch-frame' or a `select-window' event. */
9033 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9035 /* If we're at the beginning of a key sequence, and the caller
9036 says it's okay, go ahead and return this event. If we're
9037 in the midst of a key sequence, delay it until the end. */
9038 if (t
> 0 || !can_return_switch_frame
)
9040 delayed_switch_frame
= key
;
9046 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9049 /* Clicks in non-text areas get prefixed by the symbol
9050 in their CHAR-ADDRESS field. For example, a click on
9051 the mode line is prefixed by the symbol `mode-line'.
9053 Furthermore, key sequences beginning with mouse clicks
9054 are read using the keymaps of the buffer clicked on, not
9055 the current buffer. So we may have to switch the buffer
9058 When we turn one event into two events, we must make sure
9059 that neither of the two looks like the original--so that,
9060 if we replay the events, they won't be expanded again.
9061 If not for this, such reexpansion could happen either here
9062 or when user programs play with this-command-keys. */
9063 if (EVENT_HAS_PARAMETERS (key
))
9068 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9069 if (EQ (kind
, Qmouse_click
))
9071 Lisp_Object window
, posn
;
9073 window
= POSN_WINDOW (EVENT_START (key
));
9074 posn
= POSN_POSN (EVENT_START (key
));
9077 || (!NILP (fake_prefixed_keys
)
9078 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9080 /* We're looking a second time at an event for which
9081 we generated a fake prefix key. Set
9082 last_real_key_start appropriately. */
9084 last_real_key_start
= t
- 1;
9087 /* Key sequences beginning with mouse clicks are
9088 read using the keymaps in the buffer clicked on,
9089 not the current buffer. If we're at the
9090 beginning of a key sequence, switch buffers. */
9091 if (last_real_key_start
== 0
9093 && BUFFERP (XWINDOW (window
)->buffer
)
9094 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9096 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9100 /* Arrange to go back to the original buffer once we're
9101 done reading the key sequence. Note that we can't
9102 use save_excursion_{save,restore} here, because they
9103 save point as well as the current buffer; we don't
9104 want to save point, because redisplay may change it,
9105 to accommodate a Fset_window_start or something. We
9106 don't want to do this at the top of the function,
9107 because we may get input from a subprocess which
9108 wants to change the selected window and stuff (say,
9110 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9112 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9114 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9115 orig_local_map
= get_local_map (PT
, current_buffer
,
9117 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9118 goto replay_sequence
;
9121 /* For a mouse click, get the local text-property keymap
9122 of the place clicked on, rather than point. */
9123 if (last_real_key_start
== 0
9124 && CONSP (XCDR (key
))
9125 && ! localized_local_map
)
9127 Lisp_Object map_here
, start
, pos
;
9129 localized_local_map
= 1;
9130 start
= EVENT_START (key
);
9132 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9134 pos
= POSN_BUFFER_POSN (start
);
9136 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9138 map_here
= get_local_map (XINT (pos
),
9139 current_buffer
, Qlocal_map
);
9140 if (!EQ (map_here
, orig_local_map
))
9142 orig_local_map
= map_here
;
9146 goto replay_sequence
;
9148 map_here
= get_local_map (XINT (pos
),
9149 current_buffer
, Qkeymap
);
9150 if (!EQ (map_here
, orig_keymap
))
9152 orig_keymap
= map_here
;
9156 goto replay_sequence
;
9162 /* Expand mode-line and scroll-bar events into two events:
9163 use posn as a fake prefix key. */
9165 && (NILP (fake_prefixed_keys
)
9166 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9168 if (t
+ 1 >= bufsize
)
9169 error ("Key sequence too long");
9172 keybuf
[t
+ 1] = key
;
9175 /* Record that a fake prefix key has been generated
9176 for KEY. Don't modify the event; this would
9177 prevent proper action when the event is pushed
9178 back into unread-command-events. */
9179 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9181 /* If on a mode line string with a local keymap,
9182 reconsider the key sequence with that keymap. */
9183 if (string
= POSN_STRING (EVENT_START (key
)),
9184 (CONSP (string
) && STRINGP (XCAR (string
))))
9186 Lisp_Object pos
, map
, map2
;
9188 pos
= XCDR (string
);
9189 string
= XCAR (string
);
9191 && XINT (pos
) < SCHARS (string
))
9193 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9195 orig_local_map
= map
;
9196 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9199 if (!NILP (map
) || !NILP (map2
))
9200 goto replay_sequence
;
9206 else if (NILP (from_string
)
9207 && (string
= POSN_STRING (EVENT_START (key
)),
9208 (CONSP (string
) && STRINGP (XCAR (string
)))))
9210 /* For a click on a string, i.e. overlay string or a
9211 string displayed via the `display' property,
9212 consider `local-map' and `keymap' properties of
9214 Lisp_Object pos
, map
, map2
;
9216 pos
= XCDR (string
);
9217 string
= XCAR (string
);
9219 && XINT (pos
) < SCHARS (string
))
9221 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9223 orig_local_map
= map
;
9224 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9228 if (!NILP (map
) || !NILP (map2
))
9230 from_string
= string
;
9231 goto replay_sequence
;
9236 else if (CONSP (XCDR (key
))
9237 && CONSP (EVENT_START (key
))
9238 && CONSP (XCDR (EVENT_START (key
))))
9242 posn
= POSN_POSN (EVENT_START (key
));
9243 /* Handle menu-bar events:
9244 insert the dummy prefix event `menu-bar'. */
9245 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9247 if (t
+ 1 >= bufsize
)
9248 error ("Key sequence too long");
9252 /* Zap the position in key, so we know that we've
9253 expanded it, and don't try to do so again. */
9254 POSN_SET_POSN (EVENT_START (key
),
9255 Fcons (posn
, Qnil
));
9258 goto replay_sequence
;
9260 else if (CONSP (posn
))
9262 /* We're looking at the second event of a
9263 sequence which we expanded before. Set
9264 last_real_key_start appropriately. */
9265 if (last_real_key_start
== t
&& t
> 0)
9266 last_real_key_start
= t
- 1;
9271 /* We have finally decided that KEY is something we might want
9273 first_binding
= (follow_key (key
,
9274 nmaps
- first_binding
,
9275 submaps
+ first_binding
,
9276 defs
+ first_binding
,
9277 submaps
+ first_binding
)
9280 /* If KEY wasn't bound, we'll try some fallbacks. */
9281 if (first_binding
< nmaps
)
9282 /* This is needed for the following scenario:
9283 event 0: a down-event that gets dropped by calling replay_key.
9284 event 1: some normal prefix like C-h.
9285 After event 0, first_unbound is 0, after event 1 fkey.start
9286 and keytran.start are both 1, so when we see that C-h is bound,
9287 we need to update first_unbound. */
9288 first_unbound
= max (t
+ 1, first_unbound
);
9293 /* Remember the position to put an upper bound on fkey.start. */
9294 first_unbound
= min (t
, first_unbound
);
9296 head
= EVENT_HEAD (key
);
9297 if (help_char_p (head
) && t
> 0)
9299 read_key_sequence_cmd
= Vprefix_help_command
;
9301 last_nonmenu_event
= key
;
9302 /* The Microsoft C compiler can't handle the goto that
9310 Lisp_Object breakdown
;
9313 breakdown
= parse_modifiers (head
);
9314 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9315 /* Attempt to reduce an unbound mouse event to a simpler
9316 event that is bound:
9317 Drags reduce to clicks.
9318 Double-clicks reduce to clicks.
9319 Triple-clicks reduce to double-clicks, then to clicks.
9320 Down-clicks are eliminated.
9321 Double-downs reduce to downs, then are eliminated.
9322 Triple-downs reduce to double-downs, then to downs,
9323 then are eliminated. */
9324 if (modifiers
& (down_modifier
| drag_modifier
9325 | double_modifier
| triple_modifier
))
9327 while (modifiers
& (down_modifier
| drag_modifier
9328 | double_modifier
| triple_modifier
))
9330 Lisp_Object new_head
, new_click
;
9331 if (modifiers
& triple_modifier
)
9332 modifiers
^= (double_modifier
| triple_modifier
);
9333 else if (modifiers
& double_modifier
)
9334 modifiers
&= ~double_modifier
;
9335 else if (modifiers
& drag_modifier
)
9336 modifiers
&= ~drag_modifier
;
9339 /* Dispose of this `down' event by simply jumping
9340 back to replay_key, to get another event.
9342 Note that if this event came from mock input,
9343 then just jumping back to replay_key will just
9344 hand it to us again. So we have to wipe out any
9347 We could delete keybuf[t] and shift everything
9348 after that to the left by one spot, but we'd also
9349 have to fix up any variable that points into
9350 keybuf, and shifting isn't really necessary
9353 Adding prefixes for non-textual mouse clicks
9354 creates two characters of mock input, and both
9355 must be thrown away. If we're only looking at
9356 the prefix now, we can just jump back to
9357 replay_key. On the other hand, if we've already
9358 processed the prefix, and now the actual click
9359 itself is giving us trouble, then we've lost the
9360 state of the keymaps we want to backtrack to, and
9361 we need to replay the whole sequence to rebuild
9364 Beyond that, only function key expansion could
9365 create more than two keys, but that should never
9366 generate mouse events, so it's okay to zero
9367 mock_input in that case too.
9369 FIXME: The above paragraph seems just plain
9370 wrong, if you consider things like
9371 xterm-mouse-mode. -stef
9373 Isn't this just the most wonderful code ever? */
9375 /* If mock_input > t + 1, the above simplification
9376 will actually end up dropping keys on the floor.
9377 This is probably OK for now, but even
9378 if mock_input <= t + 1, we need to adjust fkey
9380 Typical case [header-line down-mouse-N]:
9381 mock_input = 2, t = 1, fkey.end = 1,
9382 last_real_key_start = 0. */
9383 if (fkey
.end
> last_real_key_start
)
9385 fkey
.end
= fkey
.start
9386 = min (last_real_key_start
, fkey
.start
);
9387 fkey
.map
= fkey
.parent
;
9388 if (keytran
.end
> last_real_key_start
)
9390 keytran
.end
= keytran
.start
9391 = min (last_real_key_start
, keytran
.start
);
9392 keytran
.map
= keytran
.parent
;
9395 if (t
== last_real_key_start
)
9402 mock_input
= last_real_key_start
;
9403 goto replay_sequence
;
9408 = apply_modifiers (modifiers
, XCAR (breakdown
));
9410 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9412 /* Look for a binding for this new key. follow_key
9413 promises that it didn't munge submaps the
9414 last time we called it, since key was unbound. */
9416 = (follow_key (new_click
,
9417 nmaps
- local_first_binding
,
9418 submaps
+ local_first_binding
,
9419 defs
+ local_first_binding
,
9420 submaps
+ local_first_binding
)
9421 + local_first_binding
);
9423 /* If that click is bound, go for it. */
9424 if (first_binding
< nmaps
)
9429 /* Otherwise, we'll leave key set to the drag event. */
9436 /* Normally, last_nonmenu_event gets the previous key we read.
9437 But when a mouse popup menu is being used,
9438 we don't update last_nonmenu_event; it continues to hold the mouse
9439 event that preceded the first level of menu. */
9440 if (!used_mouse_menu
)
9441 last_nonmenu_event
= key
;
9443 /* Record what part of this_command_keys is the current key sequence. */
9444 this_single_command_key_start
= this_command_key_count
- t
;
9446 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9447 /* There is a binding and it's not a prefix.
9448 There is thus no function-key in this sequence.
9449 Moving fkey.start is important in this case to allow keytran.start
9450 to go over the sequence before we return (since we keep the
9451 invariant that keytran.end <= fkey.start). */
9454 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9457 /* If the sequence is unbound, see if we can hang a function key
9458 off the end of it. */
9459 /* Continue scan from fkey.end until we find a bound suffix. */
9460 while (fkey
.end
< t
)
9462 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9465 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9466 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9467 max (t
, mock_input
),
9468 /* If there's a binding (i.e.
9469 first_binding >= nmaps) we don't want
9470 to apply this function-key-mapping. */
9471 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9476 mock_input
= diff
+ max (t
, mock_input
);
9477 goto replay_sequence
;
9481 /* Look for this sequence in key-translation-map.
9482 Scan from keytran.end until we find a bound suffix. */
9483 while (keytran
.end
< fkey
.start
)
9485 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9488 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9489 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9494 mock_input
= diff
+ max (t
, mock_input
);
9495 /* Adjust the function-key-map counters. */
9499 goto replay_sequence
;
9503 /* If KEY is not defined in any of the keymaps,
9504 and cannot be part of a function key or translation,
9505 and is an upper case letter
9506 use the corresponding lower-case letter instead. */
9507 if (first_binding
>= nmaps
9508 && fkey
.start
>= t
&& keytran
.start
>= t
9510 && ((((XINT (key
) & 0x3ffff)
9511 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9512 && UPPERCASEP (XINT (key
) & 0x3ffff))
9513 || (XINT (key
) & shift_modifier
)))
9515 Lisp_Object new_key
;
9517 original_uppercase
= key
;
9518 original_uppercase_position
= t
- 1;
9520 if (XINT (key
) & shift_modifier
)
9521 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9523 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9524 | (XINT (key
) & ~0x3ffff)));
9526 /* We have to do this unconditionally, regardless of whether
9527 the lower-case char is defined in the keymaps, because they
9528 might get translated through function-key-map. */
9529 keybuf
[t
- 1] = new_key
;
9530 mock_input
= max (t
, mock_input
);
9532 goto replay_sequence
;
9534 /* If KEY is not defined in any of the keymaps,
9535 and cannot be part of a function key or translation,
9536 and is a shifted function key,
9537 use the corresponding unshifted function key instead. */
9538 if (first_binding
>= nmaps
9539 && fkey
.start
>= t
&& keytran
.start
>= t
9542 Lisp_Object breakdown
;
9545 breakdown
= parse_modifiers (key
);
9546 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9547 if (modifiers
& shift_modifier
)
9549 Lisp_Object new_key
;
9551 original_uppercase
= key
;
9552 original_uppercase_position
= t
- 1;
9554 modifiers
&= ~shift_modifier
;
9555 new_key
= apply_modifiers (modifiers
,
9558 keybuf
[t
- 1] = new_key
;
9559 mock_input
= max (t
, mock_input
);
9560 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9561 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9563 goto replay_sequence
;
9569 read_key_sequence_cmd
= (first_binding
< nmaps
9570 ? defs
[first_binding
]
9573 unread_switch_frame
= delayed_switch_frame
;
9574 unbind_to (count
, Qnil
);
9576 /* Don't downcase the last character if the caller says don't.
9577 Don't downcase it if the result is undefined, either. */
9578 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9579 && t
- 1 == original_uppercase_position
)
9580 keybuf
[t
- 1] = original_uppercase
;
9582 /* Occasionally we fabricate events, perhaps by expanding something
9583 according to function-key-map, or by adding a prefix symbol to a
9584 mouse click in the scroll bar or modeline. In this cases, return
9585 the entire generated key sequence, even if we hit an unbound
9586 prefix or a definition before the end. This means that you will
9587 be able to push back the event properly, and also means that
9588 read-key-sequence will always return a logical unit.
9591 for (; t
< mock_input
; t
++)
9593 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9594 && NILP (Fzerop (Vecho_keystrokes
)))
9595 echo_char (keybuf
[t
]);
9596 add_command_key (keybuf
[t
]);
9605 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9606 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9607 The sequence is sufficient to specify a non-prefix command in the
9608 current local and global maps.
9610 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9611 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9612 as a continuation of the previous key.
9614 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9615 convert the last event to lower case. (Normally any upper case event
9616 is converted to lower case if the original event is undefined and the lower
9617 case equivalent is defined.) A non-nil value is appropriate for reading
9618 a key sequence to be defined.
9620 A C-g typed while in this function is treated like any other character,
9621 and `quit-flag' is not set.
9623 If the key sequence starts with a mouse click, then the sequence is read
9624 using the keymaps of the buffer of the window clicked in, not the buffer
9625 of the selected window as normal.
9627 `read-key-sequence' drops unbound button-down events, since you normally
9628 only care about the click or drag events which follow them. If a drag
9629 or multi-click event is unbound, but the corresponding click event would
9630 be bound, `read-key-sequence' turns the event into a click event at the
9631 drag's starting position. This means that you don't have to distinguish
9632 between click and drag, double, or triple events unless you want to.
9634 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9635 lines separating windows, and scroll bars with imaginary keys
9636 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9638 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9639 function will process a switch-frame event if the user switches frames
9640 before typing anything. If the user switches frames in the middle of a
9641 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9642 is nil, then the event will be put off until after the current key sequence.
9644 `read-key-sequence' checks `function-key-map' for function key
9645 sequences, where they wouldn't conflict with ordinary bindings. See
9646 `function-key-map' for more details.
9648 The optional fifth argument COMMAND-LOOP, if non-nil, means
9649 that this key sequence is being read by something that will
9650 read commands one after another. It should be nil if the caller
9651 will read just one key sequence. */)
9652 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9654 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9655 Lisp_Object can_return_switch_frame
, command_loop
;
9657 Lisp_Object keybuf
[30];
9659 struct gcpro gcpro1
;
9660 int count
= SPECPDL_INDEX ();
9663 CHECK_STRING (prompt
);
9666 specbind (Qinput_method_exit_on_first_char
,
9667 (NILP (command_loop
) ? Qt
: Qnil
));
9668 specbind (Qinput_method_use_echo_area
,
9669 (NILP (command_loop
) ? Qt
: Qnil
));
9671 bzero (keybuf
, sizeof keybuf
);
9673 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9675 if (NILP (continue_echo
))
9677 this_command_key_count
= 0;
9678 this_command_key_count_reset
= 0;
9679 this_single_command_key_start
= 0;
9682 #ifdef HAVE_X_WINDOWS
9683 if (display_hourglass_p
)
9684 cancel_hourglass ();
9687 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9688 prompt
, ! NILP (dont_downcase_last
),
9689 ! NILP (can_return_switch_frame
), 0);
9691 #if 0 /* The following is fine for code reading a key sequence and
9692 then proceeding with a lenghty computation, but it's not good
9693 for code reading keys in a loop, like an input method. */
9694 #ifdef HAVE_X_WINDOWS
9695 if (display_hourglass_p
)
9706 return unbind_to (count
, make_event_array (i
, keybuf
));
9709 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9710 Sread_key_sequence_vector
, 1, 5, 0,
9711 doc
: /* Like `read-key-sequence' but always return a vector. */)
9712 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9714 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9715 Lisp_Object can_return_switch_frame
, command_loop
;
9717 Lisp_Object keybuf
[30];
9719 struct gcpro gcpro1
;
9720 int count
= SPECPDL_INDEX ();
9723 CHECK_STRING (prompt
);
9726 specbind (Qinput_method_exit_on_first_char
,
9727 (NILP (command_loop
) ? Qt
: Qnil
));
9728 specbind (Qinput_method_use_echo_area
,
9729 (NILP (command_loop
) ? Qt
: Qnil
));
9731 bzero (keybuf
, sizeof keybuf
);
9733 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9735 if (NILP (continue_echo
))
9737 this_command_key_count
= 0;
9738 this_command_key_count_reset
= 0;
9739 this_single_command_key_start
= 0;
9742 #ifdef HAVE_X_WINDOWS
9743 if (display_hourglass_p
)
9744 cancel_hourglass ();
9747 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9748 prompt
, ! NILP (dont_downcase_last
),
9749 ! NILP (can_return_switch_frame
), 0);
9751 #ifdef HAVE_X_WINDOWS
9752 if (display_hourglass_p
)
9762 return unbind_to (count
, Fvector (i
, keybuf
));
9765 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9766 doc
: /* Execute CMD as an editor command.
9767 CMD must be a symbol that satisfies the `commandp' predicate.
9768 Optional second arg RECORD-FLAG non-nil
9769 means unconditionally put this command in `command-history'.
9770 Otherwise, that is done only if an arg is read using the minibuffer.
9771 The argument KEYS specifies the value to use instead of (this-command-keys)
9772 when reading the arguments; if it is nil, (this-command-keys) is used.
9773 The argument SPECIAL, if non-nil, means that this command is executing
9774 a special event, so ignore the prefix argument and don't clear it. */)
9775 (cmd
, record_flag
, keys
, special
)
9776 Lisp_Object cmd
, record_flag
, keys
, special
;
9778 register Lisp_Object final
;
9779 register Lisp_Object tem
;
9780 Lisp_Object prefixarg
;
9781 struct backtrace backtrace
;
9782 extern int debug_on_next_call
;
9784 debug_on_next_call
= 0;
9788 prefixarg
= current_kboard
->Vprefix_arg
;
9789 Vcurrent_prefix_arg
= prefixarg
;
9790 current_kboard
->Vprefix_arg
= Qnil
;
9797 tem
= Fget (cmd
, Qdisabled
);
9798 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9800 tem
= Fsymbol_value (Qdisabled_command_function
);
9802 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9808 final
= Findirect_function (cmd
);
9810 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9812 struct gcpro gcpro1
, gcpro2
;
9814 GCPRO2 (cmd
, prefixarg
);
9815 do_autoload (final
, cmd
);
9822 if (STRINGP (final
) || VECTORP (final
))
9824 /* If requested, place the macro in the command history. For
9825 other sorts of commands, call-interactively takes care of
9827 if (!NILP (record_flag
))
9830 = Fcons (Fcons (Qexecute_kbd_macro
,
9831 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9834 /* Don't keep command history around forever. */
9835 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9837 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9839 XSETCDR (tem
, Qnil
);
9843 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9846 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9848 backtrace
.next
= backtrace_list
;
9849 backtrace_list
= &backtrace
;
9850 backtrace
.function
= &Qcall_interactively
;
9851 backtrace
.args
= &cmd
;
9852 backtrace
.nargs
= 1;
9853 backtrace
.evalargs
= 0;
9854 backtrace
.debug_on_exit
= 0;
9856 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9858 backtrace_list
= backtrace
.next
;
9866 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9868 doc
: /* Read function name, then read its arguments and call it. */)
9870 Lisp_Object prefixarg
;
9872 Lisp_Object function
;
9874 int saved_last_point_position
;
9875 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9876 Lisp_Object bindings
, value
;
9877 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9878 #ifdef HAVE_X_WINDOWS
9879 /* The call to Fcompleting_read wil start and cancel the hourglass,
9880 but if the hourglass was already scheduled, this means that no
9881 hourglass will be shown for the actual M-x command itself.
9882 So we restart it if it is already scheduled. Note that checking
9883 hourglass_shown_p is not enough, normally the hourglass is not shown,
9884 just scheduled to be shown. */
9885 int hstarted
= hourglass_started ();
9888 saved_keys
= Fvector (this_command_key_count
,
9889 XVECTOR (this_command_keys
)->contents
);
9890 saved_last_point_position_buffer
= last_point_position_buffer
;
9891 saved_last_point_position
= last_point_position
;
9893 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9895 if (EQ (prefixarg
, Qminus
))
9897 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9898 strcpy (buf
, "C-u ");
9899 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9900 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9901 else if (INTEGERP (prefixarg
))
9902 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9904 /* This isn't strictly correct if execute-extended-command
9905 is bound to anything else. Perhaps it should use
9906 this_command_keys? */
9907 strcat (buf
, "M-x ");
9909 /* Prompt with buf, and then read a string, completing from and
9910 restricting to the set of all defined commands. Don't provide
9911 any initial input. Save the command read on the extended-command
9913 function
= Fcompleting_read (build_string (buf
),
9914 Vobarray
, Qcommandp
,
9915 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9918 #ifdef HAVE_X_WINDOWS
9919 if (hstarted
) start_hourglass ();
9922 if (STRINGP (function
) && SCHARS (function
) == 0)
9923 error ("No command name given");
9925 /* Set this_command_keys to the concatenation of saved_keys and
9926 function, followed by a RET. */
9931 this_command_key_count
= 0;
9932 this_command_key_count_reset
= 0;
9933 this_single_command_key_start
= 0;
9935 keys
= XVECTOR (saved_keys
)->contents
;
9936 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9937 add_command_key (keys
[i
]);
9939 for (i
= 0; i
< SCHARS (function
); i
++)
9940 add_command_key (Faref (function
, make_number (i
)));
9942 add_command_key (make_number ('\015'));
9945 last_point_position
= saved_last_point_position
;
9946 last_point_position_buffer
= saved_last_point_position_buffer
;
9950 function
= Fintern (function
, Qnil
);
9951 current_kboard
->Vprefix_arg
= prefixarg
;
9952 Vthis_command
= function
;
9953 real_this_command
= function
;
9955 /* If enabled, show which key runs this command. */
9956 if (!NILP (Vsuggest_key_bindings
)
9957 && NILP (Vexecuting_kbd_macro
)
9958 && SYMBOLP (function
))
9959 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9965 GCPRO2 (bindings
, value
);
9966 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9968 /* If the command has a key binding, print it now. */
9969 if (!NILP (bindings
)
9970 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9973 /* But first wait, and skip the message if there is input. */
9975 if (!NILP (echo_area_buffer
[0]))
9976 /* This command displayed something in the echo area;
9977 so wait a few seconds, then display our suggestion message. */
9978 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9979 ? XINT (Vsuggest_key_bindings
) : 2);
9981 /* This command left the echo area empty,
9982 so display our message immediately. */
9985 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9986 && ! CONSP (Vunread_command_events
))
9988 Lisp_Object binding
;
9990 int message_p
= push_message ();
9991 int count
= SPECPDL_INDEX ();
9993 record_unwind_protect (pop_message_unwind
, Qnil
);
9994 binding
= Fkey_description (bindings
, Qnil
);
9997 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10000 sprintf (newmessage
, "You can run the command `%s' with %s",
10001 SDATA (SYMBOL_NAME (function
)),
10003 message2_nolog (newmessage
,
10004 strlen (newmessage
),
10005 STRING_MULTIBYTE (binding
));
10006 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
10007 ? Vsuggest_key_bindings
: make_number (2)),
10010 restore_message ();
10012 unbind_to (count
, Qnil
);
10016 RETURN_UNGCPRO (value
);
10020 /* Return nonzero if input events are pending. */
10023 detect_input_pending ()
10025 if (!input_pending
)
10026 get_input_pending (&input_pending
, 0);
10028 return input_pending
;
10031 /* Return nonzero if input events other than mouse movements are
10035 detect_input_pending_ignore_squeezables ()
10037 if (!input_pending
)
10038 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10040 return input_pending
;
10043 /* Return nonzero if input events are pending, and run any pending timers. */
10046 detect_input_pending_run_timers (do_display
)
10049 int old_timers_run
= timers_run
;
10051 if (!input_pending
)
10052 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10054 if (old_timers_run
!= timers_run
&& do_display
)
10056 redisplay_preserve_echo_area (8);
10057 /* The following fixes a bug when using lazy-lock with
10058 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10059 from an idle timer function. The symptom of the bug is that
10060 the cursor sometimes doesn't become visible until the next X
10061 event is processed. --gerd. */
10063 Lisp_Object tail
, frame
;
10064 FOR_EACH_FRAME (tail
, frame
)
10065 if (FRAME_RIF (XFRAME (frame
)))
10066 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10070 return input_pending
;
10073 /* This is called in some cases before a possible quit.
10074 It cases the next call to detect_input_pending to recompute input_pending.
10075 So calling this function unnecessarily can't do any harm. */
10078 clear_input_pending ()
10083 /* Return nonzero if there are pending requeued events.
10084 This isn't used yet. The hope is to make wait_reading_process_output
10085 call it, and return if it runs Lisp code that unreads something.
10086 The problem is, kbd_buffer_get_event needs to be fixed to know what
10087 to do in that case. It isn't trivial. */
10090 requeued_events_pending_p ()
10092 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10096 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10097 doc
: /* Return t if command input is currently available with no wait.
10098 Actually, the value is nil only if we can be sure that no input is available;
10099 if there is a doubt, the value is t. */)
10102 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10105 get_input_pending (&input_pending
,
10106 READABLE_EVENTS_DO_TIMERS_NOW
10107 | READABLE_EVENTS_FILTER_EVENTS
);
10108 return input_pending
> 0 ? Qt
: Qnil
;
10111 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10112 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10115 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10118 if (total_keys
< NUM_RECENT_KEYS
)
10119 return Fvector (total_keys
, keys
);
10122 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10123 bcopy (keys
+ recent_keys_index
,
10124 XVECTOR (val
)->contents
,
10125 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10127 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10128 recent_keys_index
* sizeof (Lisp_Object
));
10133 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10134 doc
: /* Return the key sequence that invoked this command.
10135 However, if the command has called `read-key-sequence', it returns
10136 the last key sequence that has been read.
10137 The value is a string or a vector. */)
10140 return make_event_array (this_command_key_count
,
10141 XVECTOR (this_command_keys
)->contents
);
10144 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10145 doc
: /* Return the key sequence that invoked this command, as a vector.
10146 However, if the command has called `read-key-sequence', it returns
10147 the last key sequence that has been read. */)
10150 return Fvector (this_command_key_count
,
10151 XVECTOR (this_command_keys
)->contents
);
10154 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10155 Sthis_single_command_keys
, 0, 0, 0,
10156 doc
: /* Return the key sequence that invoked this command.
10157 More generally, it returns the last key sequence read, either by
10158 the command loop or by `read-key-sequence'.
10159 Unlike `this-command-keys', this function's value
10160 does not include prefix arguments.
10161 The value is always a vector. */)
10164 return Fvector (this_command_key_count
10165 - this_single_command_key_start
,
10166 (XVECTOR (this_command_keys
)->contents
10167 + this_single_command_key_start
));
10170 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10171 Sthis_single_command_raw_keys
, 0, 0, 0,
10172 doc
: /* Return the raw events that were read for this command.
10173 More generally, it returns the last key sequence read, either by
10174 the command loop or by `read-key-sequence'.
10175 Unlike `this-single-command-keys', this function's value
10176 shows the events before all translations (except for input methods).
10177 The value is always a vector. */)
10180 return Fvector (raw_keybuf_count
,
10181 (XVECTOR (raw_keybuf
)->contents
));
10184 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10185 Sreset_this_command_lengths
, 0, 0, 0,
10186 doc
: /* Make the unread events replace the last command and echo.
10187 Used in `universal-argument-other-key'.
10189 `universal-argument-other-key' rereads the event just typed.
10190 It then gets translated through `function-key-map'.
10191 The translated event has to replace the real events,
10192 both in the value of (this-command-keys) and in echoing.
10193 To achieve this, `universal-argument-other-key' calls
10194 `reset-this-command-lengths', which discards the record of reading
10195 these events the first time. */)
10198 this_command_key_count
= before_command_key_count
;
10199 if (this_command_key_count
< this_single_command_key_start
)
10200 this_single_command_key_start
= this_command_key_count
;
10202 echo_truncate (before_command_echo_length
);
10204 /* Cause whatever we put into unread-command-events
10205 to echo as if it were being freshly read from the keyboard. */
10206 this_command_key_count_reset
= 1;
10211 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10212 Sclear_this_command_keys
, 0, 1, 0,
10213 doc
: /* Clear out the vector that `this-command-keys' returns.
10214 Also clear the record of the last 100 events, unless optional arg
10215 KEEP-RECORD is non-nil. */)
10217 Lisp_Object keep_record
;
10221 this_command_key_count
= 0;
10222 this_command_key_count_reset
= 0;
10224 if (NILP (keep_record
))
10226 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10227 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10229 recent_keys_index
= 0;
10234 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10235 doc
: /* Return the current depth in recursive edits. */)
10239 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10243 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10244 "FOpen dribble file: ",
10245 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10246 If FILE is nil, close any open dribble file. */)
10257 file
= Fexpand_file_name (file
, Qnil
);
10258 dribble
= fopen (SDATA (file
), "w");
10260 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10265 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10266 doc
: /* Discard the contents of the terminal input buffer.
10267 Also end any kbd macro being defined. */)
10270 if (!NILP (current_kboard
->defining_kbd_macro
))
10272 /* Discard the last command from the macro. */
10273 Fcancel_kbd_macro_events ();
10277 update_mode_lines
++;
10279 Vunread_command_events
= Qnil
;
10280 unread_command_char
= -1;
10282 discard_tty_input ();
10284 kbd_fetch_ptr
= kbd_store_ptr
;
10290 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10291 doc
: /* Stop Emacs and return to superior process. You can resume later.
10292 If `cannot-suspend' is non-nil, or if the system doesn't support job
10293 control, run a subshell instead.
10295 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10296 to be read as terminal input by Emacs's parent, after suspension.
10298 Before suspending, run the normal hook `suspend-hook'.
10299 After resumption run the normal hook `suspend-resume-hook'.
10301 Some operating systems cannot stop the Emacs process and resume it later.
10302 On such systems, Emacs starts a subshell instead of suspending. */)
10304 Lisp_Object stuffstring
;
10306 int count
= SPECPDL_INDEX ();
10307 int old_height
, old_width
;
10309 struct gcpro gcpro1
;
10311 if (tty_list
&& tty_list
->next
)
10312 error ("There are other tty frames open; close them before suspending Emacs");
10314 if (!NILP (stuffstring
))
10315 CHECK_STRING (stuffstring
);
10317 /* Run the functions in suspend-hook. */
10318 if (!NILP (Vrun_hooks
))
10319 call1 (Vrun_hooks
, intern ("suspend-hook"));
10321 GCPRO1 (stuffstring
);
10322 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10323 reset_all_sys_modes ();
10324 /* sys_suspend can get an error if it tries to fork a subshell
10325 and the system resources aren't available for that. */
10326 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10328 stuff_buffered_input (stuffstring
);
10329 if (cannot_suspend
)
10333 unbind_to (count
, Qnil
);
10335 /* Check if terminal/window size has changed.
10336 Note that this is not useful when we are running directly
10337 with a window system; but suspend should be disabled in that case. */
10338 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10339 if (width
!= old_width
|| height
!= old_height
)
10340 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10342 /* Run suspend-resume-hook. */
10343 if (!NILP (Vrun_hooks
))
10344 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10350 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10351 Then in any case stuff anything Emacs has read ahead and not used. */
10354 stuff_buffered_input (stuffstring
)
10355 Lisp_Object stuffstring
;
10357 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10358 register unsigned char *p
;
10360 if (STRINGP (stuffstring
))
10362 register int count
;
10364 p
= SDATA (stuffstring
);
10365 count
= SBYTES (stuffstring
);
10366 while (count
-- > 0)
10371 /* Anything we have read ahead, put back for the shell to read. */
10372 /* ?? What should this do when we have multiple keyboards??
10373 Should we ignore anything that was typed in at the "wrong" kboard?
10375 rms: we should stuff everything back into the kboard
10377 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10380 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10381 kbd_fetch_ptr
= kbd_buffer
;
10382 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10383 stuff_char (kbd_fetch_ptr
->code
);
10385 clear_event (kbd_fetch_ptr
);
10389 #endif /* SIGTSTP */
10393 set_waiting_for_input (time_to_clear
)
10394 EMACS_TIME
*time_to_clear
;
10396 input_available_clear_time
= time_to_clear
;
10398 /* Tell handle_interrupt to throw back to read_char, */
10399 waiting_for_input
= 1;
10401 /* If handle_interrupt was called before and buffered a C-g,
10402 make it run again now, to avoid timing error. */
10403 if (!NILP (Vquit_flag
))
10404 quit_throw_to_read_char ();
10408 clear_waiting_for_input ()
10410 /* Tell handle_interrupt not to throw back to read_char, */
10411 waiting_for_input
= 0;
10412 input_available_clear_time
= 0;
10415 /* The SIGINT handler.
10417 If we have a frame on the controlling tty, we assume that the
10418 SIGINT was generated by C-g, so we call handle_interrupt.
10419 Otherwise, the handler kills Emacs. */
10422 interrupt_signal (signalnum
) /* If we don't have an argument, */
10423 int signalnum
; /* some compilers complain in signal calls. */
10425 /* Must preserve main program's value of errno. */
10426 int old_errno
= errno
;
10427 struct device
*device
;
10429 #if defined (USG) && !defined (POSIX_SIGNALS)
10430 /* USG systems forget handlers when they are used;
10431 must reestablish each time */
10432 signal (SIGINT
, interrupt_signal
);
10433 signal (SIGQUIT
, interrupt_signal
);
10436 SIGNAL_THREAD_CHECK (signalnum
);
10438 /* See if we have an active display on our controlling terminal. */
10439 device
= get_named_tty (NULL
);
10442 /* If there are no frames there, let's pretend that we are a
10443 well-behaving UN*X program and quit. */
10444 fatal_error_signal (SIGTERM
);
10448 /* Otherwise, the SIGINT was probably generated by C-g. */
10450 /* Set internal_last_event_frame to the top frame of the
10451 controlling tty, if we have a frame there. We disable the
10452 interrupt key on secondary ttys, so the SIGINT must have come
10453 from the controlling tty. */
10454 internal_last_event_frame
= device
->display_info
.tty
->top_frame
;
10456 handle_interrupt ();
10462 /* This routine is called at interrupt level in response to C-g.
10464 It is called from the SIGINT handler or kbd_buffer_store_event.
10466 If `waiting_for_input' is non zero, then unless `echoing' is
10467 nonzero, immediately throw back to read_char.
10469 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10470 eval to throw, when it gets a chance. If quit-flag is already
10471 non-nil, it stops the job right away. */
10474 handle_interrupt ()
10480 /* XXX This code needs to be revised for multi-tty support. */
10481 if (!NILP (Vquit_flag
)
10483 && get_named_tty (NULL
)
10487 /* If SIGINT isn't blocked, don't let us be interrupted by
10488 another SIGINT, it might be harmful due to non-reentrancy
10489 in I/O functions. */
10490 sigblock (sigmask (SIGINT
));
10493 reset_all_sys_modes ();
10495 #ifdef SIGTSTP /* Support possible in later USG versions */
10497 * On systems which can suspend the current process and return to the original
10498 * shell, this command causes the user to end up back at the shell.
10499 * The "Auto-save" and "Abort" questions are not asked until
10500 * the user elects to return to emacs, at which point he can save the current
10501 * job and either dump core or continue.
10506 if (sys_suspend () == -1)
10508 printf ("Not running as a subprocess;\n");
10509 printf ("you can continue or abort.\n");
10511 #else /* not VMS */
10512 /* Perhaps should really fork an inferior shell?
10513 But that would not provide any way to get back
10514 to the original shell, ever. */
10515 printf ("No support for stopping a process on this operating system;\n");
10516 printf ("you can continue or abort.\n");
10517 #endif /* not VMS */
10518 #endif /* not SIGTSTP */
10520 /* We must remain inside the screen area when the internal terminal
10521 is used. Note that [Enter] is not echoed by dos. */
10524 /* It doesn't work to autosave while GC is in progress;
10525 the code used for auto-saving doesn't cope with the mark bit. */
10526 if (!gc_in_progress
)
10528 printf ("Auto-save? (y or n) ");
10530 if (((c
= getchar ()) & ~040) == 'Y')
10532 Fdo_auto_save (Qt
, Qnil
);
10534 printf ("\r\nAuto-save done");
10535 #else /* not MSDOS */
10536 printf ("Auto-save done\n");
10537 #endif /* not MSDOS */
10539 while (c
!= '\n') c
= getchar ();
10543 /* During GC, it must be safe to reenable quitting again. */
10544 Vinhibit_quit
= Qnil
;
10547 #endif /* not MSDOS */
10548 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10549 printf ("but will instead do a real quit after garbage collection ends\r\n");
10554 printf ("\r\nAbort? (y or n) ");
10555 #else /* not MSDOS */
10557 printf ("Abort (and enter debugger)? (y or n) ");
10558 #else /* not VMS */
10559 printf ("Abort (and dump core)? (y or n) ");
10560 #endif /* not VMS */
10561 #endif /* not MSDOS */
10563 if (((c
= getchar ()) & ~040) == 'Y')
10565 while (c
!= '\n') c
= getchar ();
10567 printf ("\r\nContinuing...\r\n");
10568 #else /* not MSDOS */
10569 printf ("Continuing...\n");
10570 #endif /* not MSDOS */
10572 init_all_sys_modes ();
10577 /* If executing a function that wants to be interrupted out of
10578 and the user has not deferred quitting by binding `inhibit-quit'
10579 then quit right away. */
10580 if (immediate_quit
&& NILP (Vinhibit_quit
))
10582 struct gl_state_s saved
;
10583 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10585 immediate_quit
= 0;
10588 GCPRO4 (saved
.object
, saved
.global_code
,
10589 saved
.current_syntax_table
, saved
.old_prop
);
10590 Fsignal (Qquit
, Qnil
);
10595 /* Else request quit when it's safe */
10599 if (waiting_for_input
&& !echoing
)
10600 quit_throw_to_read_char ();
10603 /* Handle a C-g by making read_char return C-g. */
10606 quit_throw_to_read_char ()
10609 /* Prevent another signal from doing this before we finish. */
10610 clear_waiting_for_input ();
10613 Vunread_command_events
= Qnil
;
10614 unread_command_char
= -1;
10616 #if 0 /* Currently, sit_for is called from read_char without turning
10617 off polling. And that can call set_waiting_for_input.
10618 It seems to be harmless. */
10619 #ifdef POLL_FOR_INPUT
10620 /* May be > 1 if in recursive minibuffer. */
10621 if (poll_suppress_count
== 0)
10625 if (FRAMEP (internal_last_event_frame
)
10626 && !EQ (internal_last_event_frame
, selected_frame
))
10627 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10630 _longjmp (getcjmp
, 1);
10633 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10634 doc
: /* Set mode of reading keyboard input.
10635 First arg INTERRUPT non-nil means use input interrupts;
10636 nil means use CBREAK mode.
10637 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10638 (no effect except in CBREAK mode).
10639 Third arg META t means accept 8-bit input (for a Meta key).
10640 META nil means ignore the top bit, on the assumption it is parity.
10641 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10642 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10643 See also `current-input-mode'. */)
10644 (interrupt
, flow
, meta
, quit
)
10645 Lisp_Object interrupt
, flow
, meta
, quit
;
10647 /* XXX This function needs to be revised for multi-device support.
10648 Currently it compiles fine, but its semantics are wrong. It sets
10649 global parameters (e.g. interrupt_input) based on only the
10650 current frame's device. */
10653 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10654 error ("set-input-mode: QUIT must be an ASCII character");
10656 #ifdef POLL_FOR_INPUT
10661 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10662 /* this causes startup screen to be restored and messes with the mouse */
10663 reset_sys_modes (CURTTY ());
10667 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10668 if (FRAME_DEVICE (SELECTED_FRAME ())->read_socket_hook
)
10670 /* When using X, don't give the user a real choice,
10671 because we haven't implemented the mechanisms to support it. */
10672 #ifdef NO_SOCK_SIGIO
10673 interrupt_input
= 0;
10674 #else /* not NO_SOCK_SIGIO */
10675 interrupt_input
= 1;
10676 #endif /* NO_SOCK_SIGIO */
10679 interrupt_input
= !NILP (interrupt
);
10680 #else /* not SIGIO */
10681 interrupt_input
= 0;
10682 #endif /* not SIGIO */
10684 /* Our VMS input only works by interrupts, as of now. */
10686 interrupt_input
= 1;
10689 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10691 struct tty_display_info
*tty
= CURTTY ();
10692 tty
->flow_control
= !NILP (flow
);
10695 else if (EQ (meta
, Qt
))
10702 /* Don't let this value be out of range. */
10703 quit_char
= XINT (quit
) & (NILP (meta
) ? 0177 : 0377);
10706 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10707 init_sys_modes (CURTTY ());
10710 #ifdef POLL_FOR_INPUT
10711 poll_suppress_count
= 1;
10717 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10718 doc
: /* Return information about the way Emacs currently reads keyboard input.
10719 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10720 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10721 nil, Emacs is using CBREAK mode.
10722 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10723 terminal; this does not apply if Emacs uses interrupt-driven input.
10724 META is t if accepting 8-bit input with 8th bit as Meta flag.
10725 META nil means ignoring the top bit, on the assumption it is parity.
10726 META is neither t nor nil if accepting 8-bit input and using
10727 all 8 bits as the character code.
10728 QUIT is the character Emacs currently uses to quit.
10729 The elements of this list correspond to the arguments of
10730 `set-input-mode'. */)
10733 Lisp_Object val
[4];
10734 struct frame
*sf
= XFRAME (selected_frame
);
10736 val
[0] = interrupt_input
? Qt
: Qnil
;
10737 if (FRAME_TERMCAP_P (sf
))
10739 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10740 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10742 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10749 XSETFASTINT (val
[3], quit_char
);
10751 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10754 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10755 doc
: /* Return position information for pixel coordinates X and Y.
10756 By default, X and Y are relative to text area of the selected window.
10757 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10758 If optional fourth arg WHOLE is non-nil, X is relative to the left
10759 edge of the window.
10761 The return value is similar to a mouse click position:
10762 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10763 IMAGE (DX . DY) (WIDTH . HEIGHT))
10764 The `posn-' functions access elements of such lists. */)
10765 (x
, y
, frame_or_window
, whole
)
10766 Lisp_Object x
, y
, frame_or_window
, whole
;
10771 if (NILP (frame_or_window
))
10772 frame_or_window
= selected_window
;
10774 if (WINDOWP (frame_or_window
))
10778 CHECK_LIVE_WINDOW (frame_or_window
);
10780 w
= XWINDOW (frame_or_window
);
10781 XSETINT (x
, (XINT (x
)
10782 + WINDOW_LEFT_EDGE_X (w
)
10784 ? window_box_left_offset (w
, TEXT_AREA
)
10786 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10787 frame_or_window
= w
->frame
;
10790 CHECK_LIVE_FRAME (frame_or_window
);
10792 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10795 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10796 doc
: /* Return position information for buffer POS in WINDOW.
10797 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10799 Return nil if position is not visible in window. Otherwise,
10800 the return value is similar to that returned by `event-start' for
10801 a mouse click at the upper left corner of the glyph corresponding
10802 to the given buffer position:
10803 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10804 IMAGE (DX . DY) (WIDTH . HEIGHT))
10805 The `posn-' functions access elements of such lists. */)
10807 Lisp_Object pos
, window
;
10812 window
= selected_window
;
10814 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10817 Lisp_Object x
= XCAR (tem
);
10818 Lisp_Object y
= XCAR (XCDR (tem
));
10820 /* Point invisible due to hscrolling? */
10823 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10831 * Set up a new kboard object with reasonable initial values.
10837 kb
->Voverriding_terminal_local_map
= Qnil
;
10838 kb
->Vlast_command
= Qnil
;
10839 kb
->Vreal_last_command
= Qnil
;
10840 kb
->Vkeyboard_translate_table
= Qnil
;
10841 kb
->Vprefix_arg
= Qnil
;
10842 kb
->Vlast_prefix_arg
= Qnil
;
10843 kb
->kbd_queue
= Qnil
;
10844 kb
->kbd_queue_has_data
= 0;
10845 kb
->immediate_echo
= 0;
10846 kb
->echo_string
= Qnil
;
10847 kb
->echo_after_prompt
= -1;
10848 kb
->kbd_macro_buffer
= 0;
10849 kb
->kbd_macro_bufsize
= 0;
10850 kb
->defining_kbd_macro
= Qnil
;
10851 kb
->Vlast_kbd_macro
= Qnil
;
10852 kb
->reference_count
= 0;
10853 kb
->Vsystem_key_alist
= Qnil
;
10854 kb
->system_key_syms
= Qnil
;
10855 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
10856 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
10857 kb
->Vlocal_key_translation_map
= Fmake_sparse_keymap (Qnil
);
10858 Fset_keymap_parent (kb
->Vlocal_key_translation_map
, Vkey_translation_map
);
10859 kb
->Vdefault_minibuffer_frame
= Qnil
;
10863 * Destroy the contents of a kboard object, but not the object itself.
10864 * We use this just before deleting it, or if we're going to initialize
10865 * it a second time.
10871 if (kb
->kbd_macro_buffer
)
10872 xfree (kb
->kbd_macro_buffer
);
10875 #ifdef MULTI_KBOARD
10877 /* Free KB and memory referenced from it. */
10885 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10888 *kbp
= kb
->next_kboard
;
10890 /* Prevent a dangling reference to KB. */
10891 if (kb
== current_kboard
10892 && FRAMEP (selected_frame
)
10893 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10895 current_kboard
= XFRAME (selected_frame
)->device
->kboard
;
10896 if (current_kboard
== kb
)
10904 #endif /* MULTI_KBOARD */
10909 /* This is correct before outermost invocation of the editor loop */
10910 command_loop_level
= -1;
10911 immediate_quit
= 0;
10912 quit_char
= Ctl ('g');
10913 Vunread_command_events
= Qnil
;
10914 unread_command_char
= -1;
10915 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10917 recent_keys_index
= 0;
10918 kbd_fetch_ptr
= kbd_buffer
;
10919 kbd_store_ptr
= kbd_buffer
;
10921 do_mouse_tracking
= Qnil
;
10925 /* This means that command_loop_1 won't try to select anything the first
10927 internal_last_event_frame
= Qnil
;
10928 Vlast_event_frame
= internal_last_event_frame
;
10930 #ifdef MULTI_KBOARD
10931 current_kboard
= initial_kboard
;
10933 wipe_kboard (current_kboard
);
10934 init_kboard (current_kboard
);
10936 if (!noninteractive
)
10938 /* Before multi-tty support, these handlers used to be installed
10939 only if the current session was a tty session. Now an Emacs
10940 session may have multiple display types, so we always handle
10941 SIGINT. There is special code in interrupt_signal to exit
10942 Emacs on SIGINT when there are no termcap frames on the
10943 controlling terminal. */
10944 signal (SIGINT
, interrupt_signal
);
10945 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10946 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10947 SIGQUIT and we can't tell which one it will give us. */
10948 signal (SIGQUIT
, interrupt_signal
);
10949 #endif /* HAVE_TERMIO */
10951 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10953 if (!noninteractive
)
10954 signal (SIGIO
, input_available_signal
);
10957 /* Use interrupt input by default, if it works and noninterrupt input
10958 has deficiencies. */
10960 #ifdef INTERRUPT_INPUT
10961 interrupt_input
= 1;
10963 interrupt_input
= 0;
10966 /* Our VMS input only works by interrupts, as of now. */
10968 interrupt_input
= 1;
10974 if (keyboard_init_hook
)
10975 (*keyboard_init_hook
) ();
10977 #ifdef POLL_FOR_INPUT
10978 poll_suppress_count
= 1;
10983 /* This type's only use is in syms_of_keyboard, to initialize the
10984 event header symbols and put properties on them. */
10985 struct event_head
{
10991 struct event_head head_table
[] = {
10992 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10993 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10994 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10995 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10996 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10997 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10998 /* `select-window' should be handled just like `switch-frame'
10999 in read_key_sequence. */
11000 {&Qselect_window
, "select-window", &Qswitch_frame
}
11004 syms_of_keyboard ()
11006 Vpre_help_message
= Qnil
;
11007 staticpro (&Vpre_help_message
);
11009 Vlispy_mouse_stem
= build_string ("mouse");
11010 staticpro (&Vlispy_mouse_stem
);
11013 QCimage
= intern (":image");
11014 staticpro (&QCimage
);
11016 staticpro (&Qhelp_echo
);
11017 Qhelp_echo
= intern ("help-echo");
11019 staticpro (&item_properties
);
11020 item_properties
= Qnil
;
11022 staticpro (&tool_bar_item_properties
);
11023 tool_bar_item_properties
= Qnil
;
11024 staticpro (&tool_bar_items_vector
);
11025 tool_bar_items_vector
= Qnil
;
11027 staticpro (&real_this_command
);
11028 real_this_command
= Qnil
;
11030 Qtimer_event_handler
= intern ("timer-event-handler");
11031 staticpro (&Qtimer_event_handler
);
11033 Qdisabled_command_function
= intern ("disabled-command-function");
11034 staticpro (&Qdisabled_command_function
);
11036 Qself_insert_command
= intern ("self-insert-command");
11037 staticpro (&Qself_insert_command
);
11039 Qforward_char
= intern ("forward-char");
11040 staticpro (&Qforward_char
);
11042 Qbackward_char
= intern ("backward-char");
11043 staticpro (&Qbackward_char
);
11045 Qdisabled
= intern ("disabled");
11046 staticpro (&Qdisabled
);
11048 Qundefined
= intern ("undefined");
11049 staticpro (&Qundefined
);
11051 Qpre_command_hook
= intern ("pre-command-hook");
11052 staticpro (&Qpre_command_hook
);
11054 Qpost_command_hook
= intern ("post-command-hook");
11055 staticpro (&Qpost_command_hook
);
11057 Qdeferred_action_function
= intern ("deferred-action-function");
11058 staticpro (&Qdeferred_action_function
);
11060 Qcommand_hook_internal
= intern ("command-hook-internal");
11061 staticpro (&Qcommand_hook_internal
);
11063 Qfunction_key
= intern ("function-key");
11064 staticpro (&Qfunction_key
);
11065 Qmouse_click
= intern ("mouse-click");
11066 staticpro (&Qmouse_click
);
11067 #if defined (WINDOWSNT) || defined (MAC_OS)
11068 Qlanguage_change
= intern ("language-change");
11069 staticpro (&Qlanguage_change
);
11071 Qdrag_n_drop
= intern ("drag-n-drop");
11072 staticpro (&Qdrag_n_drop
);
11074 Qsave_session
= intern ("save-session");
11075 staticpro (&Qsave_session
);
11077 Qusr1_signal
= intern ("usr1-signal");
11078 staticpro (&Qusr1_signal
);
11079 Qusr2_signal
= intern ("usr2-signal");
11080 staticpro (&Qusr2_signal
);
11082 Qmenu_enable
= intern ("menu-enable");
11083 staticpro (&Qmenu_enable
);
11084 Qmenu_alias
= intern ("menu-alias");
11085 staticpro (&Qmenu_alias
);
11086 QCenable
= intern (":enable");
11087 staticpro (&QCenable
);
11088 QCvisible
= intern (":visible");
11089 staticpro (&QCvisible
);
11090 QChelp
= intern (":help");
11091 staticpro (&QChelp
);
11092 QCfilter
= intern (":filter");
11093 staticpro (&QCfilter
);
11094 QCbutton
= intern (":button");
11095 staticpro (&QCbutton
);
11096 QCkeys
= intern (":keys");
11097 staticpro (&QCkeys
);
11098 QCkey_sequence
= intern (":key-sequence");
11099 staticpro (&QCkey_sequence
);
11100 QCtoggle
= intern (":toggle");
11101 staticpro (&QCtoggle
);
11102 QCradio
= intern (":radio");
11103 staticpro (&QCradio
);
11105 Qmode_line
= intern ("mode-line");
11106 staticpro (&Qmode_line
);
11107 Qvertical_line
= intern ("vertical-line");
11108 staticpro (&Qvertical_line
);
11109 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11110 staticpro (&Qvertical_scroll_bar
);
11111 Qmenu_bar
= intern ("menu-bar");
11112 staticpro (&Qmenu_bar
);
11115 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11116 staticpro (&Qmouse_fixup_help_message
);
11119 Qabove_handle
= intern ("above-handle");
11120 staticpro (&Qabove_handle
);
11121 Qhandle
= intern ("handle");
11122 staticpro (&Qhandle
);
11123 Qbelow_handle
= intern ("below-handle");
11124 staticpro (&Qbelow_handle
);
11125 Qup
= intern ("up");
11127 Qdown
= intern ("down");
11128 staticpro (&Qdown
);
11129 Qtop
= intern ("top");
11131 Qbottom
= intern ("bottom");
11132 staticpro (&Qbottom
);
11133 Qend_scroll
= intern ("end-scroll");
11134 staticpro (&Qend_scroll
);
11135 Qratio
= intern ("ratio");
11136 staticpro (&Qratio
);
11138 Qevent_kind
= intern ("event-kind");
11139 staticpro (&Qevent_kind
);
11140 Qevent_symbol_elements
= intern ("event-symbol-elements");
11141 staticpro (&Qevent_symbol_elements
);
11142 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11143 staticpro (&Qevent_symbol_element_mask
);
11144 Qmodifier_cache
= intern ("modifier-cache");
11145 staticpro (&Qmodifier_cache
);
11147 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11148 staticpro (&Qrecompute_lucid_menubar
);
11149 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11150 staticpro (&Qactivate_menubar_hook
);
11152 Qpolling_period
= intern ("polling-period");
11153 staticpro (&Qpolling_period
);
11155 Qinput_method_function
= intern ("input-method-function");
11156 staticpro (&Qinput_method_function
);
11158 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11159 staticpro (&Qinput_method_exit_on_first_char
);
11160 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11161 staticpro (&Qinput_method_use_echo_area
);
11163 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11164 Fset (Qinput_method_use_echo_area
, Qnil
);
11166 last_point_position_buffer
= Qnil
;
11169 struct event_head
*p
;
11171 for (p
= head_table
;
11172 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11175 *p
->var
= intern (p
->name
);
11176 staticpro (p
->var
);
11177 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11178 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11182 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11183 staticpro (&button_down_location
);
11184 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11185 staticpro (&mouse_syms
);
11186 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11187 staticpro (&wheel_syms
);
11191 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11193 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11194 for (i
= 0; i
< len
; i
++)
11195 if (modifier_names
[i
])
11196 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11197 staticpro (&modifier_symbols
);
11200 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11201 staticpro (&recent_keys
);
11203 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11204 staticpro (&this_command_keys
);
11206 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11207 staticpro (&raw_keybuf
);
11209 Qextended_command_history
= intern ("extended-command-history");
11210 Fset (Qextended_command_history
, Qnil
);
11211 staticpro (&Qextended_command_history
);
11213 accent_key_syms
= Qnil
;
11214 staticpro (&accent_key_syms
);
11216 func_key_syms
= Qnil
;
11217 staticpro (&func_key_syms
);
11219 drag_n_drop_syms
= Qnil
;
11220 staticpro (&drag_n_drop_syms
);
11222 unread_switch_frame
= Qnil
;
11223 staticpro (&unread_switch_frame
);
11225 internal_last_event_frame
= Qnil
;
11226 staticpro (&internal_last_event_frame
);
11228 read_key_sequence_cmd
= Qnil
;
11229 staticpro (&read_key_sequence_cmd
);
11231 menu_bar_one_keymap_changed_items
= Qnil
;
11232 staticpro (&menu_bar_one_keymap_changed_items
);
11234 menu_bar_items_vector
= Qnil
;
11235 staticpro (&menu_bar_items_vector
);
11237 defsubr (&Sevent_convert_list
);
11238 defsubr (&Sread_key_sequence
);
11239 defsubr (&Sread_key_sequence_vector
);
11240 defsubr (&Srecursive_edit
);
11242 defsubr (&Strack_mouse
);
11244 defsubr (&Sinput_pending_p
);
11245 defsubr (&Scommand_execute
);
11246 defsubr (&Srecent_keys
);
11247 defsubr (&Sthis_command_keys
);
11248 defsubr (&Sthis_command_keys_vector
);
11249 defsubr (&Sthis_single_command_keys
);
11250 defsubr (&Sthis_single_command_raw_keys
);
11251 defsubr (&Sreset_this_command_lengths
);
11252 defsubr (&Sclear_this_command_keys
);
11253 defsubr (&Ssuspend_emacs
);
11254 defsubr (&Sabort_recursive_edit
);
11255 defsubr (&Sexit_recursive_edit
);
11256 defsubr (&Srecursion_depth
);
11257 defsubr (&Stop_level
);
11258 defsubr (&Sdiscard_input
);
11259 defsubr (&Sopen_dribble_file
);
11260 defsubr (&Sset_input_mode
);
11261 defsubr (&Scurrent_input_mode
);
11262 defsubr (&Sexecute_extended_command
);
11263 defsubr (&Sposn_at_point
);
11264 defsubr (&Sposn_at_x_y
);
11266 DEFVAR_LISP ("last-command-char", &last_command_char
,
11267 doc
: /* Last input event that was part of a command. */);
11269 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11270 doc
: /* Last input event that was part of a command. */);
11272 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11273 doc
: /* Last input event in a command, except for mouse menu events.
11274 Mouse menus give back keys that don't look like mouse events;
11275 this variable holds the actual mouse event that led to the menu,
11276 so that you can determine whether the command was run by mouse or not. */);
11278 DEFVAR_LISP ("last-input-char", &last_input_char
,
11279 doc
: /* Last input event. */);
11281 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11282 doc
: /* Last input event. */);
11284 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11285 doc
: /* List of events to be read as the command input.
11286 These events are processed first, before actual keyboard input. */);
11287 Vunread_command_events
= Qnil
;
11289 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11290 doc
: /* If not -1, an object to be read as next command input event. */);
11292 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11293 doc
: /* List of events to be processed as input by input methods.
11294 These events are processed after `unread-command-events', but
11295 before actual keyboard input. */);
11296 Vunread_post_input_method_events
= Qnil
;
11298 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11299 doc
: /* List of events to be processed as input by input methods.
11300 These events are processed after `unread-command-events', but
11301 before actual keyboard input. */);
11302 Vunread_input_method_events
= Qnil
;
11304 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11305 doc
: /* Meta-prefix character code.
11306 Meta-foo as command input turns into this character followed by foo. */);
11307 XSETINT (meta_prefix_char
, 033);
11309 DEFVAR_KBOARD ("last-command", Vlast_command
,
11310 doc
: /* The last command executed.
11311 Normally a symbol with a function definition, but can be whatever was found
11312 in the keymap, or whatever the variable `this-command' was set to by that
11315 The value `mode-exit' is special; it means that the previous command
11316 read an event that told it to exit, and it did so and unread that event.
11317 In other words, the present command is the event that made the previous
11320 The value `kill-region' is special; it means that the previous command
11321 was a kill command.
11323 `last-command' has a separate binding for each display device.
11324 See Info node `(elisp)Multiple displays'. */);
11326 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11327 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11329 DEFVAR_LISP ("this-command", &Vthis_command
,
11330 doc
: /* The command now being executed.
11331 The command can set this variable; whatever is put here
11332 will be in `last-command' during the following command. */);
11333 Vthis_command
= Qnil
;
11335 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11336 doc
: /* The command bound to the current key sequence before remapping.
11337 It equals `this-command' if the original command was not remapped through
11338 any of the active keymaps. Otherwise, the value of `this-command' is the
11339 result of looking up the original command in the active keymaps. */);
11340 Vthis_original_command
= Qnil
;
11342 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11343 doc
: /* *Number of input events between auto-saves.
11344 Zero means disable autosaving due to number of characters typed. */);
11345 auto_save_interval
= 300;
11347 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11348 doc
: /* *Number of seconds idle time before auto-save.
11349 Zero or nil means disable auto-saving due to idleness.
11350 After auto-saving due to this many seconds of idle time,
11351 Emacs also does a garbage collection if that seems to be warranted. */);
11352 XSETFASTINT (Vauto_save_timeout
, 30);
11354 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11355 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11356 The value may be integer or floating point. */);
11357 Vecho_keystrokes
= make_number (1);
11359 DEFVAR_INT ("polling-period", &polling_period
,
11360 doc
: /* *Interval between polling for input during Lisp execution.
11361 The reason for polling is to make C-g work to stop a running program.
11362 Polling is needed only when using X windows and SIGIO does not work.
11363 Polling is automatically disabled in all other cases. */);
11364 polling_period
= 2;
11366 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11367 doc
: /* *Maximum time between mouse clicks to make a double-click.
11368 Measured in milliseconds. nil means disable double-click recognition;
11369 t means double-clicks have no time limit and are detected
11370 by position only. */);
11371 Vdouble_click_time
= make_number (500);
11373 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11374 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11375 On window-system frames, value is the number of pixels the mouse may have
11376 moved horizontally or vertically between two clicks to make a double-click.
11377 On non window-system frames, value is interpreted in units of 1/8 characters
11380 This variable is also the threshold for motion of the mouse
11381 to count as a drag. */);
11382 double_click_fuzz
= 3;
11384 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11385 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11386 inhibit_local_menu_bar_menus
= 0;
11388 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11389 doc
: /* Number of complete key sequences read as input so far.
11390 This includes key sequences read from keyboard macros.
11391 The number is effectively the number of interactive command invocations. */);
11392 num_input_keys
= 0;
11394 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11395 doc
: /* Number of input events read from the keyboard so far.
11396 This does not include events generated by keyboard macros. */);
11397 num_nonmacro_input_events
= 0;
11399 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11400 doc
: /* The frame in which the most recently read event occurred.
11401 If the last event came from a keyboard macro, this is set to `macro'. */);
11402 Vlast_event_frame
= Qnil
;
11404 /* This variable is set up in sysdep.c. */
11405 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11406 doc
: /* The ERASE character as set by the user with stty. */);
11408 DEFVAR_LISP ("help-char", &Vhelp_char
,
11409 doc
: /* Character to recognize as meaning Help.
11410 When it is read, do `(eval help-form)', and display result if it's a string.
11411 If the value of `help-form' is nil, this char can be read normally. */);
11412 XSETINT (Vhelp_char
, Ctl ('H'));
11414 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11415 doc
: /* List of input events to recognize as meaning Help.
11416 These work just like the value of `help-char' (see that). */);
11417 Vhelp_event_list
= Qnil
;
11419 DEFVAR_LISP ("help-form", &Vhelp_form
,
11420 doc
: /* Form to execute when character `help-char' is read.
11421 If the form returns a string, that string is displayed.
11422 If `help-form' is nil, the help char is not recognized. */);
11425 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11426 doc
: /* Command to run when `help-char' character follows a prefix key.
11427 This command is used only when there is no actual binding
11428 for that character after that prefix key. */);
11429 Vprefix_help_command
= Qnil
;
11431 DEFVAR_LISP ("top-level", &Vtop_level
,
11432 doc
: /* Form to evaluate when Emacs starts up.
11433 Useful to set before you dump a modified Emacs. */);
11436 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11437 doc
: /* Translate table for local keyboard input, or nil.
11438 If non-nil, the value should be a char-table. Each character read
11439 from the keyboard is looked up in this char-table. If the value found
11440 there is non-nil, then it is used instead of the actual input character.
11442 The value can also be a string or vector, but this is considered obsolete.
11443 If it is a string or vector of length N, character codes N and up are left
11444 untranslated. In a vector, an element which is nil means "no translation".
11446 This is applied to the characters supplied to input methods, not their
11447 output. See also `translation-table-for-input'.
11449 `local-keyboard-translate-table' has a separate binding for each
11450 terminal. See Info node `(elisp)Multiple displays'. */);
11452 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11453 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11454 \(Even if the operating system has support for stopping a process.\) */);
11455 cannot_suspend
= 0;
11457 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11458 doc
: /* Non-nil means prompt with menus when appropriate.
11459 This is done when reading from a keymap that has a prompt string,
11460 for elements that have prompt strings.
11461 The menu is displayed on the screen
11462 if X menus were enabled at configuration
11463 time and the previous event was a mouse click prefix key.
11464 Otherwise, menu prompting uses the echo area. */);
11465 menu_prompting
= 1;
11467 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11468 doc
: /* Character to see next line of menu prompt.
11469 Type this character while in a menu prompt to rotate around the lines of it. */);
11470 XSETINT (menu_prompt_more_char
, ' ');
11472 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11473 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11474 Emacs applies the modifiers of the character stored here to each keyboard
11475 character it reads. For example, after evaluating the expression
11476 (setq extra-keyboard-modifiers ?\\C-x)
11477 all input characters will have the control modifier applied to them.
11479 Note that the character ?\\C-@, equivalent to the integer zero, does
11480 not count as a control character; rather, it counts as a character
11481 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11482 cancels any modification. */);
11483 extra_keyboard_modifiers
= 0;
11485 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11486 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11487 The command loop sets this to nil before each command,
11488 and tests the value when the command returns.
11489 Buffer modification stores t in this variable. */);
11490 Vdeactivate_mark
= Qnil
;
11492 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11493 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11494 Vcommand_hook_internal
= Qnil
;
11496 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11497 doc
: /* Normal hook run before each command is executed.
11498 If an unhandled error happens in running this hook,
11499 the hook value is set to nil, since otherwise the error
11500 might happen repeatedly and make Emacs nonfunctional. */);
11501 Vpre_command_hook
= Qnil
;
11503 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11504 doc
: /* Normal hook run after each command is executed.
11505 If an unhandled error happens in running this hook,
11506 the hook value is set to nil, since otherwise the error
11507 might happen repeatedly and make Emacs nonfunctional. */);
11508 Vpost_command_hook
= Qnil
;
11511 DEFVAR_LISP ("echo-area-clear-hook", ...,
11512 doc
: /* Normal hook run when clearing the echo area. */);
11514 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11515 staticpro (&Qecho_area_clear_hook
);
11516 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11518 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11519 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11520 Vlucid_menu_bar_dirty_flag
= Qnil
;
11522 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11523 doc
: /* List of menu bar items to move to the end of the menu bar.
11524 The elements of the list are event types that may have menu bar bindings. */);
11525 Vmenu_bar_final_items
= Qnil
;
11527 DEFVAR_KBOARD ("overriding-terminal-local-map",
11528 Voverriding_terminal_local_map
,
11529 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11530 If this variable is non-nil, it is used as a keymap instead of the
11531 buffer's local map, and the minor mode keymaps and text property keymaps.
11532 It also replaces `overriding-local-map'.
11534 This variable is intended to let commands such as `universal-argument'
11535 set up a different keymap for reading the next command.
11537 `overriding-terminal-local-map' has a separate binding for each display device.
11538 See Info node `(elisp)Multiple displays'. */);
11540 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11541 doc
: /* Keymap that overrides all other local keymaps.
11542 If this variable is non-nil, it is used as a keymap--replacing the
11543 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11544 Voverriding_local_map
= Qnil
;
11546 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11547 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11548 Otherwise, the menu bar continues to reflect the buffer's local map
11549 and the minor mode maps regardless of `overriding-local-map'. */);
11550 Voverriding_local_map_menu_flag
= Qnil
;
11552 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11553 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11554 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11556 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11557 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11559 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11560 doc
: /* Alist of system-specific X windows key symbols.
11561 Each element should have the form (N . SYMBOL) where N is the
11562 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11563 and SYMBOL is its name.
11565 `system-key-alist' has a separate binding for each display device.
11566 See Info node `(elisp)Multiple displays'.
11568 Note that the currently selected frame has very little to do with
11569 which binding of this variable is active at any given moment. If you
11570 need set or get the binding on a specific display, use
11571 `terminal-local-value' and `set-terminal-local-value'. */);
11573 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11574 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
11575 This allows Emacs to recognize function keys sent from ASCII
11576 terminals at any point in a key sequence.
11578 The `read-key-sequence' function replaces any subsequence bound by
11579 `local-function-key-map' with its binding. More precisely, when the
11580 active keymaps have no binding for the current key sequence but
11581 `local-function-key-map' binds a suffix of the sequence to a vector or
11582 string, `read-key-sequence' replaces the matching suffix with its
11583 binding, and continues with the new sequence.
11585 The events that come from bindings in `local-function-key-map' are not
11586 themselves looked up in `local-function-key-map'.
11588 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11589 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11590 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11591 typing `ESC O P x' would return [f1 x].
11593 `local-function-key-map' has a separate binding for each display
11594 device. See Info node `(elisp)Multiple displays'. If you need to
11595 define a binding on all display devices, change `function-key-map'
11596 instead. Initially, `local-function-key-map' is an empty keymap that
11597 has `function-key-map' as its parent on all display devices.
11599 Note that the currently selected frame has very little to do with
11600 which binding of this variable is active at any given moment. If you
11601 need set or get the binding on a specific display, use
11602 `terminal-local-value' and `set-terminal-local-value'. */);
11604 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
11605 doc
: /* The parent keymap of all `local-function-key-map' instances.
11606 Function key definitions that apply to all display devices should go
11607 here. If a mapping is defined in both the current
11608 `local-function-key-map' binding and this variable, then the local
11609 definition will take precendence. */);
11610 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11612 DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map
,
11613 doc
: /* Keymap of key translations that can override keymaps.
11614 This keymap works like `function-key-map', but comes after that,
11615 and its non-prefix bindings override ordinary bindings.
11617 `key-translation-map' has a separate binding for each display device.
11618 (See Info node `(elisp)Multiple displays'.) If you need to set a key
11619 translation on all devices, change `global-key-translation-map' instead.
11621 Note that the currently selected frame has very little to do with
11622 which binding of this variable is active at any given moment. If you
11623 need set or get the binding on a specific display, use
11624 `terminal-local-value' and `set-terminal-local-value'. */);
11626 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
11627 doc
: /* The parent keymap of all `local-key-translation-map' instances.
11628 Key translations that apply to all display devices should go here. */);
11629 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11631 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11632 doc
: /* List of deferred actions to be performed at a later time.
11633 The precise format isn't relevant here; we just check whether it is nil. */);
11634 Vdeferred_action_list
= Qnil
;
11636 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11637 doc
: /* Function to call to handle deferred actions, after each command.
11638 This function is called with no arguments after each command
11639 whenever `deferred-action-list' is non-nil. */);
11640 Vdeferred_action_function
= Qnil
;
11642 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11643 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11644 The value can be a length of time to show the message for.
11645 If the value is non-nil and not a number, we wait 2 seconds. */);
11646 Vsuggest_key_bindings
= Qt
;
11648 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11649 doc
: /* List of active absolute time timers in order of increasing time. */);
11650 Vtimer_list
= Qnil
;
11652 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11653 doc
: /* List of active idle-time timers in order of increasing time. */);
11654 Vtimer_idle_list
= Qnil
;
11656 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11657 doc
: /* If non-nil, the function that implements the current input method.
11658 It's called with one argument, a printing character that was just read.
11659 \(That means a character with code 040...0176.)
11660 Typically this function uses `read-event' to read additional events.
11661 When it does so, it should first bind `input-method-function' to nil
11662 so it will not be called recursively.
11664 The function should return a list of zero or more events
11665 to be used as input. If it wants to put back some events
11666 to be reconsidered, separately, by the input method,
11667 it can add them to the beginning of `unread-command-events'.
11669 The input method function can find in `input-method-previous-method'
11670 the previous echo area message.
11672 The input method function should refer to the variables
11673 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11674 for guidance on what to do. */);
11675 Vinput_method_function
= Qnil
;
11677 DEFVAR_LISP ("input-method-previous-message",
11678 &Vinput_method_previous_message
,
11679 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11680 This variable exists because `read-event' clears the echo area
11681 before running the input method. It is nil if there was no message. */);
11682 Vinput_method_previous_message
= Qnil
;
11684 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11685 doc
: /* If non-nil, the function that implements the display of help.
11686 It's called with one argument, the help string to display. */);
11687 Vshow_help_function
= Qnil
;
11689 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11690 doc
: /* If non-nil, suppress point adjustment after executing a command.
11692 After a command is executed, if point is moved into a region that has
11693 special properties (e.g. composition, display), we adjust point to
11694 the boundary of the region. But, when a command sets this variable to
11695 non-nil, we suppress the point adjustment.
11697 This variable is set to nil before reading a command, and is checked
11698 just after executing the command. */);
11699 Vdisable_point_adjustment
= Qnil
;
11701 DEFVAR_LISP ("global-disable-point-adjustment",
11702 &Vglobal_disable_point_adjustment
,
11703 doc
: /* *If non-nil, always suppress point adjustment.
11705 The default value is nil, in which case, point adjustment are
11706 suppressed only after special commands that set
11707 `disable-point-adjustment' (which see) to non-nil. */);
11708 Vglobal_disable_point_adjustment
= Qnil
;
11710 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11711 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11712 If the value is not a number, such messages don't time out. */);
11713 Vminibuffer_message_timeout
= make_number (2);
11715 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11716 doc
: /* If non-nil, any keyboard input throws to this symbol.
11717 The value of that variable is passed to `quit-flag' and later causes a
11718 peculiar kind of quitting. */);
11719 Vthrow_on_input
= Qnil
;
11723 keys_of_keyboard ()
11725 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11726 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11727 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11728 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11729 initial_define_key (meta_map
, 'x', "execute-extended-command");
11731 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11732 "handle-delete-frame");
11733 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11734 current-prefix-arg, as is done in `handle-switch-frame'.
11735 But `handle-switch-frame is not run from the special-map.
11736 Commands from that map are run in a special way that automatically
11737 preserves the prefix-arg. Restoring the prefix arg here is not just
11738 redundant but harmful:
11740 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11741 - after the first prompt, the exit-minibuffer-hook is run which may
11742 iconify a frame and thus push a `iconify-frame' event.
11743 - after running exit-minibuffer-hook, current-prefix-arg is
11744 restored to the non-nil value it had before the prompt.
11745 - we enter the second prompt.
11746 current-prefix-arg is non-nil, prefix-arg is nil.
11747 - before running the first real event, we run the special iconify-frame
11748 event, but we pass the `special' arg to execute-command so
11749 current-prefix-arg and prefix-arg are left untouched.
11750 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11751 - the next key event will have a spuriously non-nil current-prefix-arg. */
11752 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11754 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11756 /* Handling it at such a low-level causes read_key_sequence to get
11757 * confused because it doesn't realize that the current_buffer was
11758 * changed by read_char.
11760 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11761 * "handle-select-window"); */
11762 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11763 "handle-save-session");
11766 /* Mark the pointers in the kboard objects.
11767 Called by the Fgarbage_collector. */
11773 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11775 if (kb
->kbd_macro_buffer
)
11776 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11778 mark_object (kb
->Voverriding_terminal_local_map
);
11779 mark_object (kb
->Vlast_command
);
11780 mark_object (kb
->Vreal_last_command
);
11781 mark_object (kb
->Vkeyboard_translate_table
);
11782 mark_object (kb
->Vprefix_arg
);
11783 mark_object (kb
->Vlast_prefix_arg
);
11784 mark_object (kb
->kbd_queue
);
11785 mark_object (kb
->defining_kbd_macro
);
11786 mark_object (kb
->Vlast_kbd_macro
);
11787 mark_object (kb
->Vsystem_key_alist
);
11788 mark_object (kb
->system_key_syms
);
11789 mark_object (kb
->Vlocal_function_key_map
);
11790 mark_object (kb
->Vlocal_key_translation_map
);
11791 mark_object (kb
->Vdefault_minibuffer_frame
);
11792 mark_object (kb
->echo_string
);
11795 struct input_event
*event
;
11796 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11798 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11799 event
= kbd_buffer
;
11800 if (event
->kind
!= SELECTION_REQUEST_EVENT
11801 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11803 mark_object (event
->x
);
11804 mark_object (event
->y
);
11806 mark_object (event
->frame_or_window
);
11807 mark_object (event
->arg
);
11812 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11813 (do not change this comment) */