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, 2006, 2007 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 3, 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"
36 #include "character.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 volatile 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 /* Following definition copied from eval.c */
115 struct backtrace
*next
;
116 Lisp_Object
*function
;
117 Lisp_Object
*args
; /* Points to vector of args. */
118 int nargs
; /* length of vector. If nargs is UNEVALLED,
119 args points to slot holding list of
122 /* Nonzero means call value of debugger when done with this operation. */
127 KBOARD
*initial_kboard
;
128 KBOARD
*current_kboard
;
132 KBOARD the_only_kboard
;
135 /* Non-nil disable property on a command means
136 do not execute it; call disabled-command-function's value instead. */
137 Lisp_Object Qdisabled
, Qdisabled_command_function
;
139 #define NUM_RECENT_KEYS (300)
140 int recent_keys_index
; /* Index for storing next element into recent_keys */
141 int total_keys
; /* Total number of elements stored into recent_keys */
142 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
144 /* Vector holding the key sequence that invoked the current command.
145 It is reused for each command, and it may be longer than the current
146 sequence; this_command_key_count indicates how many elements
147 actually mean something.
148 It's easier to staticpro a single Lisp_Object than an array. */
149 Lisp_Object this_command_keys
;
150 int this_command_key_count
;
152 /* 1 after calling Freset_this_command_lengths.
154 int this_command_key_count_reset
;
156 /* This vector is used as a buffer to record the events that were actually read
157 by read_key_sequence. */
158 Lisp_Object raw_keybuf
;
159 int raw_keybuf_count
;
161 #define GROW_RAW_KEYBUF \
162 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
163 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
165 /* Number of elements of this_command_keys
166 that precede this key sequence. */
167 int this_single_command_key_start
;
169 /* Record values of this_command_key_count and echo_length ()
170 before this command was read. */
171 static int before_command_key_count
;
172 static int before_command_echo_length
;
174 extern int minbuf_level
;
176 extern int message_enable_multibyte
;
178 extern struct backtrace
*backtrace_list
;
180 /* If non-nil, the function that implements the display of help.
181 It's called with one argument, the help string to display. */
183 Lisp_Object Vshow_help_function
;
185 /* If a string, the message displayed before displaying a help-echo
188 Lisp_Object Vpre_help_message
;
190 /* Nonzero means do menu prompting. */
192 static int menu_prompting
;
194 /* Character to see next line of menu prompt. */
196 static Lisp_Object menu_prompt_more_char
;
198 /* For longjmp to where kbd input is being done. */
200 static jmp_buf getcjmp
;
202 /* True while doing kbd input. */
203 int waiting_for_input
;
205 /* True while displaying for echoing. Delays C-g throwing. */
209 /* Non-null means we can start echoing at the next input pause even
210 though there is something in the echo area. */
212 static struct kboard
*ok_to_echo_at_next_pause
;
214 /* The kboard last echoing, or null for none. Reset to 0 in
215 cancel_echoing. If non-null, and a current echo area message
216 exists, and echo_message_buffer is eq to the current message
217 buffer, we know that the message comes from echo_kboard. */
219 struct kboard
*echo_kboard
;
221 /* The buffer used for echoing. Set in echo_now, reset in
224 Lisp_Object echo_message_buffer
;
226 /* Nonzero means disregard local maps for the menu bar. */
227 static int inhibit_local_menu_bar_menus
;
229 /* Nonzero means C-g should cause immediate error-signal. */
232 /* The user's hook function for outputting an error message. */
233 Lisp_Object Vcommand_error_function
;
235 /* The user's ERASE setting. */
236 Lisp_Object Vtty_erase_char
;
238 /* Character to recognize as the help char. */
239 Lisp_Object Vhelp_char
;
241 /* List of other event types to recognize as meaning "help". */
242 Lisp_Object Vhelp_event_list
;
244 /* Form to execute when help char is typed. */
245 Lisp_Object Vhelp_form
;
247 /* Command to run when the help character follows a prefix key. */
248 Lisp_Object Vprefix_help_command
;
250 /* List of items that should move to the end of the menu bar. */
251 Lisp_Object Vmenu_bar_final_items
;
253 /* Non-nil means show the equivalent key-binding for
254 any M-x command that has one.
255 The value can be a length of time to show the message for.
256 If the value is non-nil and not a number, we wait 2 seconds. */
257 Lisp_Object Vsuggest_key_bindings
;
259 /* How long to display an echo-area message when the minibuffer is active.
260 If the value is not a number, such messages don't time out. */
261 Lisp_Object Vminibuffer_message_timeout
;
263 /* Character that causes a quit. Normally C-g.
265 If we are running on an ordinary terminal, this must be an ordinary
266 ASCII char, since we want to make it our interrupt character.
268 If we are not running on an ordinary terminal, it still needs to be
269 an ordinary ASCII char. This character needs to be recognized in
270 the input interrupt handler. At this point, the keystroke is
271 represented as a struct input_event, while the desired quit
272 character is specified as a lispy event. The mapping from struct
273 input_events to lispy events cannot run in an interrupt handler,
274 and the reverse mapping is difficult for anything but ASCII
277 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
281 extern Lisp_Object current_global_map
;
282 extern int minibuf_level
;
284 /* If non-nil, this is a map that overrides all other local maps. */
285 Lisp_Object Voverriding_local_map
;
287 /* If non-nil, Voverriding_local_map applies to the menu bar. */
288 Lisp_Object Voverriding_local_map_menu_flag
;
290 /* Keymap that defines special misc events that should
291 be processed immediately at a low level. */
292 Lisp_Object Vspecial_event_map
;
294 /* Current depth in recursive edits. */
295 int command_loop_level
;
297 /* Total number of times command_loop has read a key sequence. */
298 EMACS_INT num_input_keys
;
300 /* Last input character read as a command. */
301 Lisp_Object last_command_char
;
303 /* Last input character read as a command, not counting menus
304 reached by the mouse. */
305 Lisp_Object last_nonmenu_event
;
307 /* Last input character read for any purpose. */
308 Lisp_Object last_input_char
;
310 /* If not Qnil, a list of objects to be read as subsequent command input. */
311 Lisp_Object Vunread_command_events
;
313 /* If not Qnil, a list of objects to be read as subsequent command input
314 including input method processing. */
315 Lisp_Object Vunread_input_method_events
;
317 /* If not Qnil, a list of objects to be read as subsequent command input
318 but NOT including input method processing. */
319 Lisp_Object Vunread_post_input_method_events
;
321 /* If not -1, an event to be read as subsequent command input. */
322 EMACS_INT unread_command_char
;
324 /* If not Qnil, this is a switch-frame event which we decided to put
325 off until the end of a key sequence. This should be read as the
326 next command input, after any unread_command_events.
328 read_key_sequence uses this to delay switch-frame events until the
329 end of the key sequence; Fread_char uses it to put off switch-frame
330 events until a non-ASCII event is acceptable as input. */
331 Lisp_Object unread_switch_frame
;
333 /* A mask of extra modifier bits to put into every keyboard char. */
334 EMACS_INT extra_keyboard_modifiers
;
336 /* Char to use as prefix when a meta character is typed in.
337 This is bound on entry to minibuffer in case ESC is changed there. */
339 Lisp_Object meta_prefix_char
;
341 /* Last size recorded for a current buffer which is not a minibuffer. */
342 static int last_non_minibuf_size
;
344 /* Number of idle seconds before an auto-save and garbage collection. */
345 static Lisp_Object Vauto_save_timeout
;
347 /* Total number of times read_char has returned. */
348 int num_input_events
;
350 /* Total number of times read_char has returned, outside of macros. */
351 EMACS_INT num_nonmacro_input_events
;
353 /* Auto-save automatically when this many characters have been typed
354 since the last time. */
356 static EMACS_INT auto_save_interval
;
358 /* Value of num_nonmacro_input_events as of last auto save. */
362 /* The command being executed by the command loop.
363 Commands may set this, and the value set will be copied into
364 current_kboard->Vlast_command instead of the actual command. */
365 Lisp_Object Vthis_command
;
367 /* This is like Vthis_command, except that commands never set it. */
368 Lisp_Object real_this_command
;
370 /* If the lookup of the command returns a binding, the original
371 command is stored in this-original-command. It is nil otherwise. */
372 Lisp_Object Vthis_original_command
;
374 /* The value of point when the last command was started. */
375 int last_point_position
;
377 /* The buffer that was current when the last command was started. */
378 Lisp_Object last_point_position_buffer
;
380 /* The window that was selected when the last command was started. */
381 Lisp_Object last_point_position_window
;
383 /* The frame in which the last input event occurred, or Qmacro if the
384 last event came from a macro. We use this to determine when to
385 generate switch-frame events. This may be cleared by functions
386 like Fselect_frame, to make sure that a switch-frame event is
387 generated by the next character. */
388 Lisp_Object internal_last_event_frame
;
390 /* A user-visible version of the above, intended to allow users to
391 figure out where the last event came from, if the event doesn't
392 carry that information itself (i.e. if it was a character). */
393 Lisp_Object Vlast_event_frame
;
395 /* The timestamp of the last input event we received from the X server.
396 X Windows wants this for selection ownership. */
397 unsigned long last_event_timestamp
;
399 Lisp_Object Qself_insert_command
;
400 Lisp_Object Qforward_char
;
401 Lisp_Object Qbackward_char
;
402 Lisp_Object Qundefined
;
403 Lisp_Object Qtimer_event_handler
;
405 /* read_key_sequence stores here the command definition of the
406 key sequence that it reads. */
407 Lisp_Object read_key_sequence_cmd
;
409 /* Echo unfinished commands after this many seconds of pause. */
410 Lisp_Object Vecho_keystrokes
;
412 /* Form to evaluate (if non-nil) when Emacs is started. */
413 Lisp_Object Vtop_level
;
415 /* If non-nil, this implements the current input method. */
416 Lisp_Object Vinput_method_function
;
417 Lisp_Object Qinput_method_function
;
419 /* When we call Vinput_method_function,
420 this holds the echo area message that was just erased. */
421 Lisp_Object Vinput_method_previous_message
;
423 /* Non-nil means deactivate the mark at end of this command. */
424 Lisp_Object Vdeactivate_mark
;
426 /* Menu bar specified in Lucid Emacs fashion. */
428 Lisp_Object Vlucid_menu_bar_dirty_flag
;
429 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
431 Lisp_Object Qecho_area_clear_hook
;
433 /* Hooks to run before and after each command. */
434 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
435 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
436 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
438 /* Parent keymap of terminal-local function-key-map instances. */
439 Lisp_Object Vfunction_key_map
;
441 /* Keymap of key translations that can override keymaps. */
442 Lisp_Object Vkey_translation_map
;
444 /* List of deferred actions to be performed at a later time.
445 The precise format isn't relevant here; we just check whether it is nil. */
446 Lisp_Object Vdeferred_action_list
;
448 /* Function to call to handle deferred actions, when there are any. */
449 Lisp_Object Vdeferred_action_function
;
450 Lisp_Object Qdeferred_action_function
;
452 Lisp_Object Qinput_method_exit_on_first_char
;
453 Lisp_Object Qinput_method_use_echo_area
;
455 /* File in which we write all commands we read. */
458 /* Nonzero if input is available. */
461 extern char *pending_malloc_warning
;
463 /* Circular buffer for pre-read keyboard input. */
465 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
467 /* Pointer to next available character in kbd_buffer.
468 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
469 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
470 next available char is in kbd_buffer[0]. */
471 static struct input_event
*kbd_fetch_ptr
;
473 /* Pointer to next place to store character in kbd_buffer. This
474 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
475 character should go in kbd_buffer[0]. */
476 static struct input_event
* volatile kbd_store_ptr
;
478 /* The above pair of variables forms a "queue empty" flag. When we
479 enqueue a non-hook event, we increment kbd_store_ptr. When we
480 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
481 there is input available if the two pointers are not equal.
483 Why not just have a flag set and cleared by the enqueuing and
484 dequeuing functions? Such a flag could be screwed up by interrupts
485 at inopportune times. */
487 /* If this flag is non-nil, we check mouse_moved to see when the
488 mouse moves, and motion events will appear in the input stream.
489 Otherwise, mouse motion is ignored. */
490 Lisp_Object do_mouse_tracking
;
492 /* Symbols to head events. */
493 Lisp_Object Qmouse_movement
;
494 Lisp_Object Qscroll_bar_movement
;
495 Lisp_Object Qswitch_frame
;
496 Lisp_Object Qdelete_frame
;
497 Lisp_Object Qiconify_frame
;
498 Lisp_Object Qmake_frame_visible
;
499 Lisp_Object Qselect_window
;
500 Lisp_Object Qhelp_echo
;
502 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
503 Lisp_Object Qmouse_fixup_help_message
;
506 /* Symbols to denote kinds of events. */
507 Lisp_Object Qfunction_key
;
508 Lisp_Object Qmouse_click
;
509 #if defined (WINDOWSNT) || defined (MAC_OS)
510 Lisp_Object Qlanguage_change
;
512 Lisp_Object Qdrag_n_drop
;
513 Lisp_Object Qsave_session
;
515 Lisp_Object Qmac_apple_event
;
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
;
630 /* If non-nil, events produced by disabled menu items and tool-bar
631 buttons are not ignored. Help functions bind this to allow help on
632 those items and buttons. */
633 Lisp_Object Venable_disabled_menus_and_buttons
;
636 /* Global variable declarations. */
638 /* Flags for readable_events. */
639 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
640 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
641 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
643 /* Function for init_keyboard to call with no args (if nonzero). */
644 void (*keyboard_init_hook
) ();
646 static int read_avail_input
P_ ((int));
647 static void get_input_pending
P_ ((int *, int));
648 static int readable_events
P_ ((int));
649 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
650 Lisp_Object
, int *));
651 static Lisp_Object
read_char_x_menu_prompt ();
652 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
654 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
655 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
656 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
657 enum scroll_bar_part
,
658 Lisp_Object
, Lisp_Object
,
661 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
662 Lisp_Object
, char **,
663 Lisp_Object
*, unsigned));
664 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
665 static int parse_solitary_modifier
P_ ((Lisp_Object
));
666 static int parse_solitary_modifier ();
667 static void save_getcjmp
P_ ((jmp_buf));
668 static void save_getcjmp ();
669 static void restore_getcjmp
P_ ((jmp_buf));
670 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
671 static void clear_event
P_ ((struct input_event
*));
673 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
675 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
676 static void handle_interrupt
P_ ((void));
677 static void timer_start_idle
P_ ((void));
678 static void timer_stop_idle
P_ ((void));
679 static void timer_resume_idle
P_ ((void));
680 static SIGTYPE handle_user_signal
P_ ((int));
681 static char *find_user_signal_name
P_ ((int));
682 static int store_user_signal_events
P_ ((void));
684 /* Nonzero means don't try to suspend even if the operating system seems
686 static int cannot_suspend
;
688 extern Lisp_Object Qidentity
, Qonly
;
690 /* Install the string STR as the beginning of the string of echoing,
691 so that it serves as a prompt for the next character.
692 Also start echoing. */
698 current_kboard
->echo_string
= str
;
699 current_kboard
->echo_after_prompt
= SCHARS (str
);
703 /* Add C to the echo string, if echoing is going on.
704 C can be a character, which is printed prettily ("M-C-x" and all that
705 jazz), or a symbol, whose name is printed. */
711 if (current_kboard
->immediate_echo
)
713 int size
= KEY_DESCRIPTION_SIZE
+ 100;
714 char *buffer
= (char *) alloca (size
);
716 Lisp_Object echo_string
;
718 echo_string
= current_kboard
->echo_string
;
720 /* If someone has passed us a composite event, use its head symbol. */
725 ptr
= push_key_description (XINT (c
), ptr
, 1);
727 else if (SYMBOLP (c
))
729 Lisp_Object name
= SYMBOL_NAME (c
);
730 int nbytes
= SBYTES (name
);
732 if (size
- (ptr
- buffer
) < nbytes
)
734 int offset
= ptr
- buffer
;
735 size
= max (2 * size
, size
+ nbytes
);
736 buffer
= (char *) alloca (size
);
737 ptr
= buffer
+ offset
;
740 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
741 STRING_MULTIBYTE (name
), 1);
744 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
747 const char *text
= " (Type ? for further options)";
748 int len
= strlen (text
);
750 if (size
- (ptr
- buffer
) < len
)
752 int offset
= ptr
- buffer
;
754 buffer
= (char *) alloca (size
);
755 ptr
= buffer
+ offset
;
758 bcopy (text
, ptr
, len
);
762 /* Replace a dash from echo_dash with a space, otherwise
763 add a space at the end as a separator between keys. */
764 if (STRINGP (echo_string
)
765 && SCHARS (echo_string
) > 1)
767 Lisp_Object last_char
, prev_char
, idx
;
769 idx
= make_number (SCHARS (echo_string
) - 2);
770 prev_char
= Faref (echo_string
, idx
);
772 idx
= make_number (SCHARS (echo_string
) - 1);
773 last_char
= Faref (echo_string
, idx
);
775 /* We test PREV_CHAR to make sure this isn't the echoing
777 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
778 Faset (echo_string
, idx
, make_number (' '));
780 echo_string
= concat2 (echo_string
, build_string (" "));
782 else if (STRINGP (echo_string
))
783 echo_string
= concat2 (echo_string
, build_string (" "));
785 current_kboard
->echo_string
786 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
792 /* Temporarily add a dash to the end of the echo string if it's not
793 empty, so that it serves as a mini-prompt for the very next character. */
798 /* Do nothing if not echoing at all. */
799 if (NILP (current_kboard
->echo_string
))
802 if (!current_kboard
->immediate_echo
803 && SCHARS (current_kboard
->echo_string
) == 0)
806 /* Do nothing if we just printed a prompt. */
807 if (current_kboard
->echo_after_prompt
808 == SCHARS (current_kboard
->echo_string
))
811 /* Do nothing if we have already put a dash at the end. */
812 if (SCHARS (current_kboard
->echo_string
) > 1)
814 Lisp_Object last_char
, prev_char
, idx
;
816 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
817 prev_char
= Faref (current_kboard
->echo_string
, idx
);
819 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
820 last_char
= Faref (current_kboard
->echo_string
, idx
);
822 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
826 /* Put a dash at the end of the buffer temporarily,
827 but make it go away when the next character is added. */
828 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
833 /* Display the current echo string, and begin echoing if not already
839 if (!current_kboard
->immediate_echo
)
842 current_kboard
->immediate_echo
= 1;
844 for (i
= 0; i
< this_command_key_count
; i
++)
848 /* Set before_command_echo_length to the value that would
849 have been saved before the start of this subcommand in
850 command_loop_1, if we had already been echoing then. */
851 if (i
== this_single_command_key_start
)
852 before_command_echo_length
= echo_length ();
854 c
= XVECTOR (this_command_keys
)->contents
[i
];
855 if (! (EVENT_HAS_PARAMETERS (c
)
856 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
860 /* Set before_command_echo_length to the value that would
861 have been saved before the start of this subcommand in
862 command_loop_1, if we had already been echoing then. */
863 if (this_command_key_count
== this_single_command_key_start
)
864 before_command_echo_length
= echo_length ();
866 /* Put a dash at the end to invite the user to type more. */
871 message3_nolog (current_kboard
->echo_string
,
872 SBYTES (current_kboard
->echo_string
),
873 STRING_MULTIBYTE (current_kboard
->echo_string
));
876 /* Record in what buffer we echoed, and from which kboard. */
877 echo_message_buffer
= echo_area_buffer
[0];
878 echo_kboard
= current_kboard
;
880 if (waiting_for_input
&& !NILP (Vquit_flag
))
881 quit_throw_to_read_char ();
884 /* Turn off echoing, for the start of a new command. */
889 current_kboard
->immediate_echo
= 0;
890 current_kboard
->echo_after_prompt
= -1;
891 current_kboard
->echo_string
= Qnil
;
892 ok_to_echo_at_next_pause
= NULL
;
894 echo_message_buffer
= Qnil
;
897 /* Return the length of the current echo string. */
902 return (STRINGP (current_kboard
->echo_string
)
903 ? SCHARS (current_kboard
->echo_string
)
907 /* Truncate the current echo message to its first LEN chars.
908 This and echo_char get used by read_key_sequence when the user
909 switches frames while entering a key sequence. */
912 echo_truncate (nchars
)
915 if (STRINGP (current_kboard
->echo_string
))
916 current_kboard
->echo_string
917 = Fsubstring (current_kboard
->echo_string
,
918 make_number (0), make_number (nchars
));
919 truncate_echo_area (nchars
);
923 /* Functions for manipulating this_command_keys. */
925 add_command_key (key
)
928 #if 0 /* Not needed after we made Freset_this_command_lengths
929 do the job immediately. */
930 /* If reset-this-command-length was called recently, obey it now.
931 See the doc string of that function for an explanation of why. */
932 if (before_command_restore_flag
)
934 this_command_key_count
= before_command_key_count_1
;
935 if (this_command_key_count
< this_single_command_key_start
)
936 this_single_command_key_start
= this_command_key_count
;
937 echo_truncate (before_command_echo_length_1
);
938 before_command_restore_flag
= 0;
942 if (this_command_key_count
>= ASIZE (this_command_keys
))
943 this_command_keys
= larger_vector (this_command_keys
,
944 2 * ASIZE (this_command_keys
),
947 AREF (this_command_keys
, this_command_key_count
) = key
;
948 ++this_command_key_count
;
955 int count
= SPECPDL_INDEX ();
958 if (command_loop_level
> 0)
960 specbind (Qstandard_output
, Qt
);
961 specbind (Qstandard_input
, Qt
);
964 #ifdef HAVE_X_WINDOWS
965 /* The command loop has started an hourglass timer, so we have to
966 cancel it here, otherwise it will fire because the recursive edit
967 can take some time. Do not check for display_hourglass_p here,
968 because it could already be nil. */
972 /* This function may have been called from a debugger called from
973 within redisplay, for instance by Edebugging a function called
974 from fontification-functions. We want to allow redisplay in
975 the debugging session.
977 The recursive edit is left with a `(throw exit ...)'. The `exit'
978 tag is not caught anywhere in redisplay, i.e. when we leave the
979 recursive edit, the original redisplay leading to the recursive
980 edit will be unwound. The outcome should therefore be safe. */
981 specbind (Qinhibit_redisplay
, Qnil
);
984 val
= command_loop ();
986 Fsignal (Qquit
, Qnil
);
987 /* Handle throw from read_minibuf when using minibuffer
988 while it's active but we're in another window. */
990 xsignal1 (Qerror
, val
);
992 return unbind_to (count
, Qnil
);
995 /* When an auto-save happens, record the "time", and don't do again soon. */
1000 last_auto_save
= num_nonmacro_input_events
;
1003 /* Make an auto save happen as soon as possible at command level. */
1006 force_auto_save_soon ()
1008 last_auto_save
= - auto_save_interval
- 1;
1010 record_asynch_buffer_change ();
1013 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1014 doc
: /* Invoke the editor command loop recursively.
1015 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1016 that tells this function to return.
1017 Alternatively, `(throw 'exit t)' makes this function signal an error.
1018 This function is called by the editor initialization to begin editing. */)
1021 int count
= SPECPDL_INDEX ();
1024 /* If we enter while input is blocked, don't lock up here.
1025 This may happen through the debugger during redisplay. */
1026 if (INPUT_BLOCKED_P
)
1029 command_loop_level
++;
1030 update_mode_lines
= 1;
1032 if (command_loop_level
1033 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1034 buffer
= Fcurrent_buffer ();
1038 /* If we leave recursive_edit_1 below with a `throw' for instance,
1039 like it is done in the splash screen display, we have to
1040 make sure that we restore single_kboard as command_loop_1
1041 would have done if it were left normally. */
1042 if (command_loop_level
> 0)
1043 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1044 record_unwind_protect (recursive_edit_unwind
, buffer
);
1046 recursive_edit_1 ();
1047 return unbind_to (count
, Qnil
);
1051 recursive_edit_unwind (buffer
)
1054 if (BUFFERP (buffer
))
1055 Fset_buffer (buffer
);
1057 command_loop_level
--;
1058 update_mode_lines
= 1;
1063 #if 0 /* These two functions are now replaced with
1064 temporarily_switch_to_single_kboard. */
1069 #if 0 /* Theory: if there's anything in Vunread_command_events,
1070 it will right away be read by read_key_sequence,
1071 and then if we do switch KBOARDS, it will go into the side
1072 queue then. So we don't need to do anything special here -- rms. */
1073 if (CONSP (Vunread_command_events
))
1075 current_kboard
->kbd_queue
1076 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1077 current_kboard
->kbd_queue_has_data
= 1;
1079 Vunread_command_events
= Qnil
;
1085 /* Switch to the single-kboard state, making current_kboard
1086 the only KBOARD from which further input is accepted. */
1089 single_kboard_state ()
1097 /* If we're in single_kboard state for kboard KBOARD,
1101 not_single_kboard_state (kboard
)
1105 if (kboard
== current_kboard
)
1110 /* Maintain a stack of kboards, so other parts of Emacs
1111 can switch temporarily to the kboard of a given frame
1112 and then revert to the previous status. */
1117 struct kboard_stack
*next
;
1120 static struct kboard_stack
*kboard_stack
;
1127 struct kboard_stack
*p
1128 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1130 p
->next
= kboard_stack
;
1131 p
->kboard
= current_kboard
;
1143 struct kboard_stack
*p
= kboard_stack
;
1145 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1147 if (t
->kboard
== p
->kboard
)
1149 current_kboard
= p
->kboard
;
1156 /* The terminal we remembered has been deleted. */
1157 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1160 kboard_stack
= p
->next
;
1165 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1166 from which further input is accepted. If F is non-nil, set its
1167 KBOARD as the current keyboard.
1169 This function uses record_unwind_protect to return to the previous
1172 If Emacs is already in single_kboard mode, and F's keyboard is
1173 locked, then this function will throw an errow. */
1176 temporarily_switch_to_single_kboard (f
)
1180 int was_locked
= single_kboard
;
1183 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1184 /* We can not switch keyboards while in single_kboard mode.
1185 In rare cases, Lisp code may call `recursive-edit' (or
1186 `read-minibuffer' or `y-or-n-p') after it switched to a
1187 locked frame. For example, this is likely to happen
1188 when server.el connects to a new terminal while Emacs is in
1189 single_kboard mode. It is best to throw an error instead
1190 of presenting the user with a frozen screen. */
1191 error ("Terminal %d is locked, cannot read from it",
1192 FRAME_TERMINAL (f
)->id
);
1194 /* This call is unnecessary, but helps
1195 `restore_kboard_configuration' discover if somebody changed
1196 `current_kboard' behind our back. */
1197 push_kboard (current_kboard
);
1200 current_kboard
= FRAME_KBOARD (f
);
1202 record_unwind_protect (restore_kboard_configuration
,
1203 (was_locked
? Qt
: Qnil
));
1207 #if 0 /* This function is not needed anymore. */
1209 record_single_kboard_state ()
1212 push_kboard (current_kboard
);
1213 record_unwind_protect (restore_kboard_configuration
,
1214 (single_kboard
? Qt
: Qnil
));
1220 restore_kboard_configuration (was_locked
)
1221 Lisp_Object was_locked
;
1223 if (NILP (was_locked
))
1227 struct kboard
*prev
= current_kboard
;
1230 /* The pop should not change the kboard. */
1231 if (single_kboard
&& current_kboard
!= prev
)
1239 /* Handle errors that are not handled at inner levels
1240 by printing an error message and returning to the editor command loop. */
1246 Lisp_Object old_level
, old_length
;
1247 char macroerror
[50];
1249 #ifdef HAVE_X_WINDOWS
1250 if (display_hourglass_p
)
1251 cancel_hourglass ();
1254 if (!NILP (executing_kbd_macro
))
1256 if (executing_kbd_macro_iterations
== 1)
1257 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1259 sprintf (macroerror
, "After %d kbd macro iterations: ",
1260 executing_kbd_macro_iterations
);
1265 Vstandard_output
= Qt
;
1266 Vstandard_input
= Qt
;
1267 Vexecuting_kbd_macro
= Qnil
;
1268 executing_kbd_macro
= Qnil
;
1269 current_kboard
->Vprefix_arg
= Qnil
;
1270 current_kboard
->Vlast_prefix_arg
= Qnil
;
1273 /* Avoid unquittable loop if data contains a circular list. */
1274 old_level
= Vprint_level
;
1275 old_length
= Vprint_length
;
1276 XSETFASTINT (Vprint_level
, 10);
1277 XSETFASTINT (Vprint_length
, 10);
1278 cmd_error_internal (data
, macroerror
);
1279 Vprint_level
= old_level
;
1280 Vprint_length
= old_length
;
1284 Vinhibit_quit
= Qnil
;
1285 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1287 if (command_loop_level
== 0 && minibuf_level
== 0)
1288 any_kboard_state ();
1292 return make_number (0);
1295 /* Take actions on handling an error. DATA is the data that describes
1298 CONTEXT is a C-string containing ASCII characters only which
1299 describes the context in which the error happened. If we need to
1300 generalize CONTEXT to allow multibyte characters, make it a Lisp
1304 cmd_error_internal (data
, context
)
1308 struct frame
*sf
= SELECTED_FRAME ();
1310 /* The immediate context is not interesting for Quits,
1311 since they are asyncronous. */
1312 if (EQ (XCAR (data
), Qquit
))
1313 Vsignaling_function
= Qnil
;
1318 /* Use user's specified output function if any. */
1319 if (!NILP (Vcommand_error_function
))
1320 call3 (Vcommand_error_function
, data
,
1321 context
? build_string (context
) : empty_unibyte_string
,
1322 Vsignaling_function
);
1323 /* If the window system or terminal frame hasn't been initialized
1324 yet, or we're not interactive, write the message to stderr and exit. */
1325 else if (!sf
->glyphs_initialized_p
1326 || FRAME_INITIAL_P (sf
)
1329 print_error_message (data
, Qexternal_debugging_output
,
1330 context
, Vsignaling_function
);
1331 Fterpri (Qexternal_debugging_output
);
1332 Fkill_emacs (make_number (-1));
1336 clear_message (1, 0);
1338 message_log_maybe_newline ();
1341 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1344 Vsignaling_function
= Qnil
;
1347 Lisp_Object
command_loop_1 ();
1348 Lisp_Object
command_loop_2 ();
1349 Lisp_Object
top_level_1 ();
1351 /* Entry to editor-command-loop.
1352 This level has the catches for exiting/returning to editor command loop.
1353 It returns nil to exit recursive edit, t to abort it. */
1358 if (command_loop_level
> 0 || minibuf_level
> 0)
1361 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1362 executing_kbd_macro
= Qnil
;
1368 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1369 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1370 /* Reset single_kboard in case top-level set it while
1371 evaluating an -f option, or we are stuck there for some
1373 any_kboard_state ();
1375 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1376 executing_kbd_macro
= Qnil
;
1378 /* End of file in -batch run causes exit here. */
1384 /* Here we catch errors in execution of commands within the
1385 editing loop, and reenter the editing loop.
1386 When there is an error, cmd_error runs and returns a non-nil
1387 value to us. A value of nil means that command_loop_1 itself
1388 returned due to end of file (or end of kbd macro). */
1393 register Lisp_Object val
;
1396 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1397 while (!NILP (val
));
1405 return Feval (Vtop_level
);
1411 /* On entry to the outer level, run the startup file */
1412 if (!NILP (Vtop_level
))
1413 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1414 else if (!NILP (Vpurify_flag
))
1415 message ("Bare impure Emacs (standard Lisp code not loaded)");
1417 message ("Bare Emacs (standard Lisp code not loaded)");
1421 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1422 doc
: /* Exit all recursive editing levels. */)
1425 #ifdef HAVE_X_WINDOWS
1426 if (display_hourglass_p
)
1427 cancel_hourglass ();
1430 /* Unblock input if we enter with input blocked. This may happen if
1431 redisplay traps e.g. during tool-bar update with input blocked. */
1432 while (INPUT_BLOCKED_P
)
1435 return Fthrow (Qtop_level
, Qnil
);
1438 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1439 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1442 if (command_loop_level
> 0 || minibuf_level
> 0)
1443 Fthrow (Qexit
, Qnil
);
1445 error ("No recursive edit is in progress");
1449 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1450 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1453 if (command_loop_level
> 0 || minibuf_level
> 0)
1456 error ("No recursive edit is in progress");
1460 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1462 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1463 of this function. */
1466 tracking_off (old_value
)
1467 Lisp_Object old_value
;
1469 do_mouse_tracking
= old_value
;
1470 if (NILP (old_value
))
1472 /* Redisplay may have been preempted because there was input
1473 available, and it assumes it will be called again after the
1474 input has been processed. If the only input available was
1475 the sort that we have just disabled, then we need to call
1477 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1479 redisplay_preserve_echo_area (6);
1480 get_input_pending (&input_pending
,
1481 READABLE_EVENTS_DO_TIMERS_NOW
);
1487 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1488 doc
: /* Evaluate BODY with mouse movement events enabled.
1489 Within a `track-mouse' form, mouse motion generates input events that
1490 you can read with `read-event'.
1491 Normally, mouse motion is ignored.
1492 usage: (track-mouse BODY...) */)
1496 int count
= SPECPDL_INDEX ();
1499 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1501 do_mouse_tracking
= Qt
;
1503 val
= Fprogn (args
);
1504 return unbind_to (count
, val
);
1507 /* If mouse has moved on some frame, return one of those frames.
1511 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1512 after resizing the tool-bar window. */
1514 int ignore_mouse_drag_p
;
1519 Lisp_Object tail
, frame
;
1521 if (ignore_mouse_drag_p
)
1523 /* ignore_mouse_drag_p = 0; */
1527 FOR_EACH_FRAME (tail
, frame
)
1529 if (XFRAME (frame
)->mouse_moved
)
1530 return XFRAME (frame
);
1536 #endif /* HAVE_MOUSE || HAVE_GPM */
1538 /* This is the actual command reading loop,
1539 sans error-handling encapsulation. */
1541 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1543 void safe_run_hooks
P_ ((Lisp_Object
));
1544 static void adjust_point_for_property
P_ ((int, int));
1546 /* Cancel hourglass from protect_unwind.
1548 #ifdef HAVE_X_WINDOWS
1550 cancel_hourglass_unwind (arg
)
1553 cancel_hourglass ();
1564 Lisp_Object keybuf
[30];
1567 int prev_modiff
= 0;
1568 struct buffer
*prev_buffer
= NULL
;
1569 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1571 int was_locked
= single_kboard
;
1574 int already_adjusted
= 0;
1576 current_kboard
->Vprefix_arg
= Qnil
;
1577 current_kboard
->Vlast_prefix_arg
= Qnil
;
1578 Vdeactivate_mark
= Qnil
;
1579 waiting_for_input
= 0;
1583 this_command_key_count
= 0;
1584 this_command_key_count_reset
= 0;
1585 this_single_command_key_start
= 0;
1587 if (NILP (Vmemory_full
))
1589 /* Make sure this hook runs after commands that get errors and
1590 throw to top level. */
1591 /* Note that the value cell will never directly contain nil
1592 if the symbol is a local variable. */
1593 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1594 safe_run_hooks (Qpost_command_hook
);
1596 /* If displaying a message, resize the echo area window to fit
1597 that message's size exactly. */
1598 if (!NILP (echo_area_buffer
[0]))
1599 resize_echo_area_exactly ();
1601 if (!NILP (Vdeferred_action_list
))
1602 safe_run_hooks (Qdeferred_action_function
);
1605 /* Do this after running Vpost_command_hook, for consistency. */
1606 current_kboard
->Vlast_command
= Vthis_command
;
1607 current_kboard
->Vreal_last_command
= real_this_command
;
1608 if (!CONSP (last_command_char
))
1609 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1613 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1616 /* Make sure the current window's buffer is selected. */
1617 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1618 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1620 /* Display any malloc warning that just came out. Use while because
1621 displaying one warning can cause another. */
1623 while (pending_malloc_warning
)
1624 display_malloc_warning ();
1628 Vdeactivate_mark
= Qnil
;
1630 /* If minibuffer on and echo area in use,
1631 wait a short time and redraw minibuffer. */
1634 && !NILP (echo_area_buffer
[0])
1635 && EQ (minibuf_window
, echo_area_window
))
1637 /* Bind inhibit-quit to t so that C-g gets read in
1638 rather than quitting back to the minibuffer. */
1639 int count
= SPECPDL_INDEX ();
1640 specbind (Qinhibit_quit
, Qt
);
1642 if (NUMBERP (Vminibuffer_message_timeout
))
1643 sit_for (Vminibuffer_message_timeout
, 0, 2);
1647 /* Clear the echo area. */
1649 safe_run_hooks (Qecho_area_clear_hook
);
1651 unbind_to (count
, Qnil
);
1653 /* If a C-g came in before, treat it as input now. */
1654 if (!NILP (Vquit_flag
))
1657 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1662 /* Select the frame that the last event came from. Usually,
1663 switch-frame events will take care of this, but if some lisp
1664 code swallows a switch-frame event, we'll fix things up here.
1665 Is this a good idea? */
1666 if (FRAMEP (internal_last_event_frame
)
1667 && !EQ (internal_last_event_frame
, selected_frame
))
1668 Fselect_frame (internal_last_event_frame
);
1670 /* If it has changed current-menubar from previous value,
1671 really recompute the menubar from the value. */
1672 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1673 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1674 call0 (Qrecompute_lucid_menubar
);
1676 before_command_key_count
= this_command_key_count
;
1677 before_command_echo_length
= echo_length ();
1679 Vthis_command
= Qnil
;
1680 real_this_command
= Qnil
;
1681 Vthis_original_command
= Qnil
;
1683 /* Read next key sequence; i gets its length. */
1684 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1687 /* A filter may have run while we were reading the input. */
1688 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1690 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1691 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1695 /* Now we have read a key sequence of length I,
1696 or else I is 0 and we found end of file. */
1698 if (i
== 0) /* End of file -- happens only in */
1699 return Qnil
; /* a kbd macro, at the end. */
1700 /* -1 means read_key_sequence got a menu that was rejected.
1701 Just loop around and read another command. */
1705 this_command_key_count
= 0;
1706 this_command_key_count_reset
= 0;
1707 this_single_command_key_start
= 0;
1711 last_command_char
= keybuf
[i
- 1];
1713 /* If the previous command tried to force a specific window-start,
1714 forget about that, in case this command moves point far away
1715 from that position. But also throw away beg_unchanged and
1716 end_unchanged information in that case, so that redisplay will
1717 update the whole window properly. */
1718 if (!NILP (XWINDOW (selected_window
)->force_start
))
1721 XWINDOW (selected_window
)->force_start
= Qnil
;
1722 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1723 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1726 cmd
= read_key_sequence_cmd
;
1727 if (!NILP (Vexecuting_kbd_macro
))
1729 if (!NILP (Vquit_flag
))
1731 Vexecuting_kbd_macro
= Qt
;
1732 QUIT
; /* Make some noise. */
1733 /* Will return since macro now empty. */
1737 /* Do redisplay processing after this command except in special
1738 cases identified below. */
1739 prev_buffer
= current_buffer
;
1740 prev_modiff
= MODIFF
;
1741 last_point_position
= PT
;
1742 last_point_position_window
= selected_window
;
1743 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1745 /* By default, we adjust point to a boundary of a region that
1746 has such a property that should be treated intangible
1747 (e.g. composition, display). But, some commands will set
1748 this variable differently. */
1749 Vdisable_point_adjustment
= Qnil
;
1751 /* Process filters and timers may have messed with deactivate-mark.
1752 reset it before we execute the command. */
1753 Vdeactivate_mark
= Qnil
;
1755 /* Remap command through active keymaps */
1756 Vthis_original_command
= cmd
;
1760 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1764 /* Execute the command. */
1766 Vthis_command
= cmd
;
1767 real_this_command
= cmd
;
1768 /* Note that the value cell will never directly contain nil
1769 if the symbol is a local variable. */
1770 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1771 safe_run_hooks (Qpre_command_hook
);
1773 already_adjusted
= 0;
1775 if (NILP (Vthis_command
))
1777 /* nil means key is undefined. */
1778 Lisp_Object keys
= Fvector (i
, keybuf
);
1779 keys
= Fkey_description (keys
, Qnil
);
1781 message_with_string ("%s is undefined", keys
, 0);
1782 current_kboard
->defining_kbd_macro
= Qnil
;
1783 update_mode_lines
= 1;
1784 current_kboard
->Vprefix_arg
= Qnil
;
1788 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1790 /* In case we jump to directly_done. */
1791 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1793 /* Recognize some common commands in common situations and
1794 do them directly. */
1795 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1797 struct Lisp_Char_Table
*dp
1798 = window_display_table (XWINDOW (selected_window
));
1799 lose
= FETCH_CHAR (PT_BYTE
);
1801 if (! NILP (Vpost_command_hook
))
1802 /* Put this before calling adjust_point_for_property
1803 so it will only get called once in any case. */
1805 if (current_buffer
== prev_buffer
1806 && last_point_position
!= PT
1807 && NILP (Vdisable_point_adjustment
)
1808 && NILP (Vglobal_disable_point_adjustment
))
1809 adjust_point_for_property (last_point_position
, 0);
1810 already_adjusted
= 1;
1811 if (PT
== last_point_position
+ 1
1813 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1814 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1815 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1816 && (lose
>= 0x20 && lose
< 0x7f)))
1817 : (lose
>= 0x20 && lose
< 0x7f))
1818 /* To extract the case of continuation on
1819 wide-column characters. */
1820 && ASCII_BYTE_P (lose
)
1821 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1823 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1825 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1827 && !windows_or_buffers_changed
1828 && EQ (current_buffer
->selective_display
, Qnil
)
1829 && !detect_input_pending ()
1830 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1831 && NILP (Vexecuting_kbd_macro
))
1832 direct_output_forward_char (1);
1835 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1837 struct Lisp_Char_Table
*dp
1838 = window_display_table (XWINDOW (selected_window
));
1840 lose
= FETCH_CHAR (PT_BYTE
);
1841 if (! NILP (Vpost_command_hook
))
1843 if (current_buffer
== prev_buffer
1844 && last_point_position
!= PT
1845 && NILP (Vdisable_point_adjustment
)
1846 && NILP (Vglobal_disable_point_adjustment
))
1847 adjust_point_for_property (last_point_position
, 0);
1848 already_adjusted
= 1;
1849 if (PT
== last_point_position
- 1
1851 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1852 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1853 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1854 && (lose
>= 0x20 && lose
< 0x7f)))
1855 : (lose
>= 0x20 && lose
< 0x7f))
1856 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1858 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1860 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1862 && !windows_or_buffers_changed
1863 && EQ (current_buffer
->selective_display
, Qnil
)
1864 && !detect_input_pending ()
1865 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1866 && NILP (Vexecuting_kbd_macro
))
1867 direct_output_forward_char (-1);
1870 else if (EQ (Vthis_command
, Qself_insert_command
)
1871 /* Try this optimization only on char keystrokes. */
1872 && NATNUMP (last_command_char
)
1873 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1876 = translate_char (Vtranslation_table_for_input
,
1877 XFASTINT (last_command_char
));
1879 if (NILP (Vexecuting_kbd_macro
)
1880 && !EQ (minibuf_window
, selected_window
))
1882 if (!nonundocount
|| nonundocount
>= 20)
1890 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1892 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1894 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1896 || MODIFF
<= SAVE_MODIFF
1897 || windows_or_buffers_changed
1898 || !EQ (current_buffer
->selective_display
, Qnil
)
1899 || detect_input_pending ()
1900 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1901 || !NILP (Vexecuting_kbd_macro
));
1903 value
= internal_self_insert (c
, 0);
1908 if (! NILP (Vpost_command_hook
))
1909 /* Put this before calling adjust_point_for_property
1910 so it will only get called once in any case. */
1913 /* VALUE == 1 when AFTER-CHANGE functions are
1914 installed which is the case most of the time
1915 because FONT-LOCK installs one. */
1916 if (!lose
&& !value
)
1917 direct_output_for_insert (c
);
1922 /* Here for a command that isn't executed directly */
1925 #ifdef HAVE_X_WINDOWS
1926 int scount
= SPECPDL_INDEX ();
1928 if (display_hourglass_p
1929 && NILP (Vexecuting_kbd_macro
))
1931 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1937 if (NILP (current_kboard
->Vprefix_arg
))
1939 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1941 #ifdef HAVE_X_WINDOWS
1942 /* Do not check display_hourglass_p here, because
1943 Fcommand_execute could change it, but we should cancel
1944 hourglass cursor anyway.
1945 But don't cancel the hourglass within a macro
1946 just because a command in the macro finishes. */
1947 if (NILP (Vexecuting_kbd_macro
))
1948 unbind_to (scount
, Qnil
);
1953 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1955 /* Note that the value cell will never directly contain nil
1956 if the symbol is a local variable. */
1957 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1958 safe_run_hooks (Qpost_command_hook
);
1960 /* If displaying a message, resize the echo area window to fit
1961 that message's size exactly. */
1962 if (!NILP (echo_area_buffer
[0]))
1963 resize_echo_area_exactly ();
1965 if (!NILP (Vdeferred_action_list
))
1966 safe_run_hooks (Qdeferred_action_function
);
1968 /* If there is a prefix argument,
1969 1) We don't want Vlast_command to be ``universal-argument''
1970 (that would be dumb), so don't set Vlast_command,
1971 2) we want to leave echoing on so that the prefix will be
1972 echoed as part of this key sequence, so don't call
1974 3) we want to leave this_command_key_count non-zero, so that
1975 read_char will realize that it is re-reading a character, and
1976 not echo it a second time.
1978 If the command didn't actually create a prefix arg,
1979 but is merely a frame event that is transparent to prefix args,
1980 then the above doesn't apply. */
1981 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1983 current_kboard
->Vlast_command
= Vthis_command
;
1984 current_kboard
->Vreal_last_command
= real_this_command
;
1985 if (!CONSP (last_command_char
))
1986 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1988 this_command_key_count
= 0;
1989 this_command_key_count_reset
= 0;
1990 this_single_command_key_start
= 0;
1993 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1995 /* Setting transient-mark-mode to `only' is a way of
1996 turning it on for just one command. */
1998 if (EQ (Vtransient_mark_mode
, Qidentity
))
1999 Vtransient_mark_mode
= Qnil
;
2000 if (EQ (Vtransient_mark_mode
, Qonly
))
2001 Vtransient_mark_mode
= Qidentity
;
2003 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
2005 /* We could also call `deactivate'mark'. */
2006 if (EQ (Vtransient_mark_mode
, Qlambda
))
2007 Vtransient_mark_mode
= Qnil
;
2010 current_buffer
->mark_active
= Qnil
;
2011 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
2014 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
2015 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
2020 if (current_buffer
== prev_buffer
2021 && last_point_position
!= PT
2022 && NILP (Vdisable_point_adjustment
)
2023 && NILP (Vglobal_disable_point_adjustment
)
2024 && !already_adjusted
)
2025 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
2027 /* Install chars successfully executed in kbd macro. */
2029 if (!NILP (current_kboard
->defining_kbd_macro
)
2030 && NILP (current_kboard
->Vprefix_arg
))
2031 finalize_kbd_macro_chars ();
2032 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2035 any_kboard_state ();
2041 extern Lisp_Object Qcomposition
, Qdisplay
;
2043 /* Adjust point to a boundary of a region that has such a property
2044 that should be treated intangible. For the moment, we check
2045 `composition', `display' and `invisible' properties.
2046 LAST_PT is the last position of point. */
2048 extern Lisp_Object Qafter_string
, Qbefore_string
;
2049 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2052 adjust_point_for_property (last_pt
, modified
)
2057 Lisp_Object val
, overlay
, tmp
;
2058 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2061 /* FIXME: cycling is probably not necessary because these properties
2062 can't be usefully combined anyway. */
2063 while (check_composition
|| check_display
|| check_invisible
)
2065 if (check_composition
2066 && PT
> BEGV
&& PT
< ZV
2067 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2068 && COMPOSITION_VALID_P (beg
, end
, val
)
2069 && beg
< PT
/* && end > PT <- It's always the case. */
2070 && (last_pt
<= beg
|| last_pt
>= end
))
2073 SET_PT (PT
< last_pt
? beg
: end
);
2074 check_display
= check_invisible
= 1;
2076 check_composition
= 0;
2078 && PT
> BEGV
&& PT
< ZV
2079 && !NILP (val
= get_char_property_and_overlay
2080 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2081 && display_prop_intangible_p (val
)
2082 && (!OVERLAYP (overlay
)
2083 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2084 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2085 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2086 && (beg
< PT
/* && end > PT <- It's always the case. */
2087 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2090 SET_PT (PT
< last_pt
2091 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2093 check_composition
= check_invisible
= 1;
2096 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2098 int inv
, ellipsis
= 0;
2101 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2103 && !NILP (val
= get_char_property_and_overlay
2104 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2105 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2107 ellipsis
= ellipsis
|| inv
> 1
2108 || (OVERLAYP (overlay
)
2109 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2110 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2111 tmp
= Fnext_single_char_property_change
2112 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2113 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2116 && !NILP (val
= get_char_property_and_overlay
2117 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2118 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2120 ellipsis
= ellipsis
|| inv
> 1
2121 || (OVERLAYP (overlay
)
2122 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2123 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2124 tmp
= Fprevious_single_char_property_change
2125 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2126 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2129 /* Move away from the inside area. */
2130 if (beg
< PT
&& end
> PT
)
2132 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2133 /* We haven't moved yet (so we don't need to fear
2134 infinite-looping) and we were outside the range
2135 before (so either end of the range still corresponds
2136 to a move in the right direction): pretend we moved
2137 less than we actually did, so that we still have
2138 more freedom below in choosing which end of the range
2140 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2141 /* We either have moved already or the last point
2142 was already in the range: we don't get to choose
2143 which end of the range we have to go to. */
2144 : (PT
< last_pt
? beg
: end
));
2145 check_composition
= check_display
= 1;
2147 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2148 the point to something other than its argument, due to
2149 point-motion hooks, intangibility, etc. */
2150 xassert (PT
== beg
|| PT
== end
);
2153 /* Pretend the area doesn't exist if the buffer is not
2155 if (!modified
&& !ellipsis
&& beg
< end
)
2157 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2158 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2159 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2160 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2161 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2162 /* We've already moved as far as we can. Trying to go
2163 to the other end would mean moving backwards and thus
2164 could lead to an infinite loop. */
2166 else if (val
= get_pos_property (make_number (PT
),
2168 TEXT_PROP_MEANS_INVISIBLE (val
)
2169 && (val
= get_pos_property
2170 (make_number (PT
== beg
? end
: beg
),
2172 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2173 (check_composition
= check_display
= 1,
2174 SET_PT (PT
== beg
? end
: beg
));
2177 check_invisible
= 0;
2181 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2184 safe_run_hooks_1 (hook
)
2187 if (NILP (Vrun_hooks
))
2189 return call1 (Vrun_hooks
, Vinhibit_quit
);
2192 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2195 safe_run_hooks_error (data
)
2198 Lisp_Object args
[3];
2199 args
[0] = build_string ("Error in %s: %s");
2200 args
[1] = Vinhibit_quit
;
2203 return Fset (Vinhibit_quit
, Qnil
);
2206 /* If we get an error while running the hook, cause the hook variable
2207 to be nil. Also inhibit quits, so that C-g won't cause the hook
2208 to mysteriously evaporate. */
2211 safe_run_hooks (hook
)
2214 int count
= SPECPDL_INDEX ();
2215 specbind (Qinhibit_quit
, hook
);
2217 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2219 unbind_to (count
, Qnil
);
2223 /* Number of seconds between polling for input. This is a Lisp
2224 variable that can be bound. */
2226 EMACS_INT polling_period
;
2228 /* Nonzero means polling for input is temporarily suppressed. */
2230 int poll_suppress_count
;
2232 /* Asynchronous timer for polling. */
2234 struct atimer
*poll_timer
;
2237 #ifdef POLL_FOR_INPUT
2239 /* Poll for input, so what we catch a C-g if it comes in. This
2240 function is called from x_make_frame_visible, see comment
2246 if (interrupt_input_blocked
== 0
2247 && !waiting_for_input
)
2248 read_avail_input (0);
2251 /* Timer callback function for poll_timer. TIMER is equal to
2255 poll_for_input (timer
)
2256 struct atimer
*timer
;
2258 if (poll_suppress_count
== 0)
2260 interrupt_input_pending
= 1;
2262 poll_for_input_1 ();
2266 #endif /* POLL_FOR_INPUT */
2268 /* Begin signals to poll for input, if they are appropriate.
2269 This function is called unconditionally from various places. */
2274 #ifdef POLL_FOR_INPUT
2275 /* XXX This condition was (read_socket_hook && !interrupt_input),
2276 but read_socket_hook is not global anymore. Let's pretend that
2278 if (!interrupt_input
)
2280 /* Turn alarm handling on unconditionally. It might have
2281 been turned off in process.c. */
2282 turn_on_atimers (1);
2284 /* If poll timer doesn't exist, are we need one with
2285 a different interval, start a new one. */
2286 if (poll_timer
== NULL
2287 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2289 EMACS_TIME interval
;
2292 cancel_atimer (poll_timer
);
2294 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2295 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2296 poll_for_input
, NULL
);
2299 /* Let the timer's callback function poll for input
2300 if this becomes zero. */
2301 --poll_suppress_count
;
2306 /* Nonzero if we are using polling to handle input asynchronously. */
2309 input_polling_used ()
2311 #ifdef POLL_FOR_INPUT
2312 /* XXX This condition was (read_socket_hook && !interrupt_input),
2313 but read_socket_hook is not global anymore. Let's pretend that
2315 return !interrupt_input
;
2321 /* Turn off polling. */
2326 #ifdef POLL_FOR_INPUT
2327 /* XXX This condition was (read_socket_hook && !interrupt_input),
2328 but read_socket_hook is not global anymore. Let's pretend that
2330 if (!interrupt_input
)
2331 ++poll_suppress_count
;
2335 /* Set the value of poll_suppress_count to COUNT
2336 and start or stop polling accordingly. */
2339 set_poll_suppress_count (count
)
2342 #ifdef POLL_FOR_INPUT
2343 if (count
== 0 && poll_suppress_count
!= 0)
2345 poll_suppress_count
= 1;
2348 else if (count
!= 0 && poll_suppress_count
== 0)
2352 poll_suppress_count
= count
;
2356 /* Bind polling_period to a value at least N.
2357 But don't decrease it. */
2360 bind_polling_period (n
)
2363 #ifdef POLL_FOR_INPUT
2364 int new = polling_period
;
2369 stop_other_atimers (poll_timer
);
2371 specbind (Qpolling_period
, make_number (new));
2372 /* Start a new alarm with the new period. */
2377 /* Apply the control modifier to CHARACTER. */
2383 /* Save the upper bits here. */
2384 int upper
= c
& ~0177;
2388 /* Everything in the columns containing the upper-case letters
2389 denotes a control character. */
2390 if (c
>= 0100 && c
< 0140)
2394 /* Set the shift modifier for a control char
2395 made from a shifted letter. But only for letters! */
2396 if (oc
>= 'A' && oc
<= 'Z')
2397 c
|= shift_modifier
;
2400 /* The lower-case letters denote control characters too. */
2401 else if (c
>= 'a' && c
<= 'z')
2404 /* Include the bits for control and shift
2405 only if the basic ASCII code can't indicate them. */
2409 /* Replace the high bits. */
2410 c
|= (upper
& ~ctrl_modifier
);
2415 /* Display the help-echo property of the character after the mouse pointer.
2416 Either show it in the echo area, or call show-help-function to display
2417 it by other means (maybe in a tooltip).
2419 If HELP is nil, that means clear the previous help echo.
2421 If HELP is a string, display that string. If HELP is a function,
2422 call it with OBJECT and POS as arguments; the function should
2423 return a help string or nil for none. For all other types of HELP,
2424 evaluate it to obtain a string.
2426 WINDOW is the window in which the help was generated, if any.
2427 It is nil if not in a window.
2429 If OBJECT is a buffer, POS is the position in the buffer where the
2430 `help-echo' text property was found.
2432 If OBJECT is an overlay, that overlay has a `help-echo' property,
2433 and POS is the position in the overlay's buffer under the mouse.
2435 If OBJECT is a string (an overlay string or a string displayed with
2436 the `display' property). POS is the position in that string under
2439 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2440 echo overwrites a keystroke echo currently displayed in the echo
2443 Note: this function may only be called with HELP nil or a string
2444 from X code running asynchronously. */
2447 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2448 Lisp_Object help
, window
, object
, pos
;
2449 int ok_to_overwrite_keystroke_echo
;
2451 if (!NILP (help
) && !STRINGP (help
))
2453 if (FUNCTIONP (help
))
2455 Lisp_Object args
[4];
2460 help
= safe_call (4, args
);
2463 help
= safe_eval (help
);
2465 if (!STRINGP (help
))
2469 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2470 if (!noninteractive
&& STRINGP (help
))
2472 /* The mouse-fixup-help-message Lisp function can call
2473 mouse_position_hook, which resets the mouse_moved flags.
2474 This causes trouble if we are trying to read a mouse motion
2475 event (i.e., if we are inside a `track-mouse' form), so we
2476 restore the mouse_moved flag. */
2477 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2478 help
= call1 (Qmouse_fixup_help_message
, help
);
2484 if (STRINGP (help
) || NILP (help
))
2486 if (!NILP (Vshow_help_function
))
2487 call1 (Vshow_help_function
, help
);
2488 else if (/* Don't overwrite minibuffer contents. */
2489 !MINI_WINDOW_P (XWINDOW (selected_window
))
2490 /* Don't overwrite a keystroke echo. */
2491 && (NILP (echo_message_buffer
)
2492 || ok_to_overwrite_keystroke_echo
)
2493 /* Don't overwrite a prompt. */
2494 && !cursor_in_echo_area
)
2498 int count
= SPECPDL_INDEX ();
2500 if (!help_echo_showing_p
)
2501 Vpre_help_message
= current_message ();
2503 specbind (Qmessage_truncate_lines
, Qt
);
2504 message3_nolog (help
, SBYTES (help
),
2505 STRING_MULTIBYTE (help
));
2506 unbind_to (count
, Qnil
);
2508 else if (STRINGP (Vpre_help_message
))
2510 message3_nolog (Vpre_help_message
,
2511 SBYTES (Vpre_help_message
),
2512 STRING_MULTIBYTE (Vpre_help_message
));
2513 Vpre_help_message
= Qnil
;
2519 help_echo_showing_p
= STRINGP (help
);
2525 /* Input of single characters from keyboard */
2527 Lisp_Object
print_help ();
2528 static Lisp_Object
kbd_buffer_get_event ();
2529 static void record_char ();
2531 static Lisp_Object help_form_saved_window_configs
;
2533 read_char_help_form_unwind (arg
)
2535 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2536 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2537 if (!NILP (window_config
))
2538 Fset_window_configuration (window_config
);
2542 #define STOP_POLLING \
2543 do { if (! polling_stopped_here) stop_polling (); \
2544 polling_stopped_here = 1; } while (0)
2546 #define RESUME_POLLING \
2547 do { if (polling_stopped_here) start_polling (); \
2548 polling_stopped_here = 0; } while (0)
2550 /* read a character from the keyboard; call the redisplay if needed */
2551 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2552 -1 means do not do redisplay, but do do autosaving.
2555 /* The arguments MAPS and NMAPS are for menu prompting.
2556 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2558 PREV_EVENT is the previous input event, or nil if we are reading
2559 the first event of a key sequence (or not reading a key sequence).
2560 If PREV_EVENT is t, that is a "magic" value that says
2561 not to run input methods, but in other respects to act as if
2562 not reading a key sequence.
2564 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2565 if we used a mouse menu to read the input, or zero otherwise. If
2566 USED_MOUSE_MENU is null, we don't dereference it.
2568 Value is -2 when we find input on another keyboard. A second call
2569 to read_char will read it.
2571 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2572 specifying the maximum time to wait until. If no input arrives by
2573 that time, stop waiting and return nil.
2575 Value is t if we showed a menu and the user rejected it. */
2578 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2582 Lisp_Object prev_event
;
2583 int *used_mouse_menu
;
2584 EMACS_TIME
*end_time
;
2586 volatile Lisp_Object c
;
2587 int count
, jmpcount
;
2588 jmp_buf local_getcjmp
;
2590 volatile int key_already_recorded
= 0;
2591 Lisp_Object tem
, save
;
2592 volatile Lisp_Object previous_echo_area_message
;
2593 volatile Lisp_Object also_record
;
2594 volatile int reread
;
2595 struct gcpro gcpro1
, gcpro2
;
2596 int polling_stopped_here
= 0;
2597 struct kboard
*orig_kboard
= current_kboard
;
2601 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2602 before_command_key_count
= this_command_key_count
;
2603 before_command_echo_length
= echo_length ();
2606 previous_echo_area_message
= Qnil
;
2608 GCPRO2 (c
, previous_echo_area_message
);
2613 if (CONSP (Vunread_post_input_method_events
))
2615 c
= XCAR (Vunread_post_input_method_events
);
2616 Vunread_post_input_method_events
2617 = XCDR (Vunread_post_input_method_events
);
2619 /* Undo what read_char_x_menu_prompt did when it unread
2620 additional keys returned by Fx_popup_menu. */
2622 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2630 if (unread_command_char
!= -1)
2632 XSETINT (c
, unread_command_char
);
2633 unread_command_char
= -1;
2639 if (CONSP (Vunread_command_events
))
2641 c
= XCAR (Vunread_command_events
);
2642 Vunread_command_events
= XCDR (Vunread_command_events
);
2646 /* Undo what sit-for did when it unread additional keys
2647 inside universal-argument. */
2650 && EQ (XCAR (c
), Qt
))
2656 /* Undo what read_char_x_menu_prompt did when it unread
2657 additional keys returned by Fx_popup_menu. */
2659 && EQ (XCDR (c
), Qdisabled
)
2660 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2663 /* If the queued event is something that used the mouse,
2664 set used_mouse_menu accordingly. */
2666 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2667 *used_mouse_menu
= 1;
2669 goto reread_for_input_method
;
2672 if (CONSP (Vunread_input_method_events
))
2674 c
= XCAR (Vunread_input_method_events
);
2675 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2677 /* Undo what read_char_x_menu_prompt did when it unread
2678 additional keys returned by Fx_popup_menu. */
2680 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2684 goto reread_for_input_method
;
2687 this_command_key_count_reset
= 0;
2689 if (!NILP (Vexecuting_kbd_macro
))
2691 /* We set this to Qmacro; since that's not a frame, nobody will
2692 try to switch frames on us, and the selected window will
2695 Since this event came from a macro, it would be misleading to
2696 leave internal_last_event_frame set to wherever the last
2697 real event came from. Normally, a switch-frame event selects
2698 internal_last_event_frame after each command is read, but
2699 events read from a macro should never cause a new frame to be
2701 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2703 /* Exit the macro if we are at the end.
2704 Also, some things replace the macro with t
2705 to force an early exit. */
2706 if (EQ (Vexecuting_kbd_macro
, Qt
)
2707 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2713 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2714 if (STRINGP (Vexecuting_kbd_macro
)
2715 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2716 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2718 executing_kbd_macro_index
++;
2723 if (!NILP (unread_switch_frame
))
2725 c
= unread_switch_frame
;
2726 unread_switch_frame
= Qnil
;
2728 /* This event should make it into this_command_keys, and get echoed
2729 again, so we do not set `reread'. */
2733 /* if redisplay was requested */
2734 if (commandflag
>= 0)
2736 /* If there is pending input, process any events which are not
2737 user-visible, such as X selection_request events. */
2739 || detect_input_pending_run_timers (0))
2740 swallow_events (0); /* may clear input_pending */
2742 /* Redisplay if no pending input. */
2743 while (!input_pending
)
2745 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2746 redisplay_preserve_echo_area (5);
2751 /* Normal case: no input arrived during redisplay. */
2754 /* Input arrived and pre-empted redisplay.
2755 Process any events which are not user-visible. */
2757 /* If that cleared input_pending, try again to redisplay. */
2761 /* Message turns off echoing unless more keystrokes turn it on again.
2763 The code in 20.x for the condition was
2765 1. echo_area_glyphs && *echo_area_glyphs
2766 2. && echo_area_glyphs != current_kboard->echobuf
2767 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2769 (1) means there's a current message displayed
2771 (2) means it's not the message from echoing from the current
2774 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2775 is set to a non-null value. This is done in read_char and it is
2776 set to echo_area_glyphs after a call to echo_char. That means
2777 ok_to_echo_at_next_pause is either null or
2778 current_kboard->echobuf with the appropriate current_kboard at
2781 So, condition (3) means in clear text ok_to_echo_at_next_pause
2782 must be either null, or the current message isn't from echoing at
2783 all, or it's from echoing from a different kboard than the
2786 if (/* There currently is something in the echo area. */
2787 !NILP (echo_area_buffer
[0])
2788 && (/* And it's either not from echoing. */
2789 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2790 /* Or it's an echo from a different kboard. */
2791 || echo_kboard
!= current_kboard
2792 /* Or we explicitly allow overwriting whatever there is. */
2793 || ok_to_echo_at_next_pause
== NULL
))
2798 /* Try reading a character via menu prompting in the minibuf.
2799 Try this before the sit-for, because the sit-for
2800 would do the wrong thing if we are supposed to do
2801 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2802 after a mouse event so don't try a minibuf menu. */
2804 if (nmaps
> 0 && INTERACTIVE
2805 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2806 /* Don't bring up a menu if we already have another event. */
2807 && NILP (Vunread_command_events
)
2808 && unread_command_char
< 0
2809 && !detect_input_pending_run_timers (0))
2811 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2813 if (INTEGERP (c
) && XINT (c
) == -2)
2814 return c
; /* wrong_kboard_jmpbuf */
2818 key_already_recorded
= 1;
2823 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2824 We will do that below, temporarily for short sections of code,
2825 when appropriate. local_getcjmp must be in effect
2826 around any call to sit_for or kbd_buffer_get_event;
2827 it *must not* be in effect when we call redisplay. */
2829 jmpcount
= SPECPDL_INDEX ();
2830 if (_setjmp (local_getcjmp
))
2832 /* Handle quits while reading the keyboard. */
2833 /* We must have saved the outer value of getcjmp here,
2834 so restore it now. */
2835 restore_getcjmp (save_jump
);
2836 unbind_to (jmpcount
, Qnil
);
2837 XSETINT (c
, quit_char
);
2838 internal_last_event_frame
= selected_frame
;
2839 Vlast_event_frame
= internal_last_event_frame
;
2840 /* If we report the quit char as an event,
2841 don't do so more than once. */
2842 if (!NILP (Vinhibit_quit
))
2847 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2848 if (kb
!= current_kboard
)
2850 Lisp_Object link
= kb
->kbd_queue
;
2851 /* We shouldn't get here if we were in single-kboard mode! */
2856 while (CONSP (XCDR (link
)))
2858 if (!NILP (XCDR (link
)))
2862 kb
->kbd_queue
= Fcons (c
, Qnil
);
2864 XSETCDR (link
, Fcons (c
, Qnil
));
2865 kb
->kbd_queue_has_data
= 1;
2866 current_kboard
= kb
;
2867 /* This is going to exit from read_char
2868 so we had better get rid of this frame's stuff. */
2870 return make_number (-2); /* wrong_kboard_jmpbuf */
2877 /* Start idle timers if no time limit is supplied. We don't do it
2878 if a time limit is supplied to avoid an infinite recursion in the
2879 situation where an idle timer calls `sit-for'. */
2882 timer_start_idle ();
2884 /* If in middle of key sequence and minibuffer not active,
2885 start echoing if enough time elapses. */
2887 if (minibuf_level
== 0
2889 && !current_kboard
->immediate_echo
2890 && this_command_key_count
> 0
2892 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2893 && NILP (Fzerop (Vecho_keystrokes
))
2894 && (/* No message. */
2895 NILP (echo_area_buffer
[0])
2896 /* Or empty message. */
2897 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2898 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2899 /* Or already echoing from same kboard. */
2900 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2901 /* Or not echoing before and echoing allowed. */
2902 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2904 /* After a mouse event, start echoing right away.
2905 This is because we are probably about to display a menu,
2906 and we don't want to delay before doing so. */
2907 if (EVENT_HAS_PARAMETERS (prev_event
))
2913 save_getcjmp (save_jump
);
2914 restore_getcjmp (local_getcjmp
);
2915 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2916 restore_getcjmp (save_jump
);
2918 && ! CONSP (Vunread_command_events
))
2923 /* Maybe auto save due to number of keystrokes. */
2925 if (commandflag
!= 0
2926 && auto_save_interval
> 0
2927 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2928 && !detect_input_pending_run_timers (0))
2930 Fdo_auto_save (Qnil
, Qnil
);
2931 /* Hooks can actually change some buffers in auto save. */
2935 /* Try reading using an X menu.
2936 This is never confused with reading using the minibuf
2937 because the recursive call of read_char in read_char_minibuf_menu_prompt
2938 does not pass on any keymaps. */
2940 if (nmaps
> 0 && INTERACTIVE
2941 && !NILP (prev_event
)
2942 && EVENT_HAS_PARAMETERS (prev_event
)
2943 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2944 && !EQ (XCAR (prev_event
), Qtool_bar
)
2945 /* Don't bring up a menu if we already have another event. */
2946 && NILP (Vunread_command_events
)
2947 && unread_command_char
< 0)
2949 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2951 /* Now that we have read an event, Emacs is not idle. */
2958 /* Maybe autosave and/or garbage collect due to idleness. */
2960 if (INTERACTIVE
&& NILP (c
))
2962 int delay_level
, buffer_size
;
2964 /* Slow down auto saves logarithmically in size of current buffer,
2965 and garbage collect while we're at it. */
2966 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2967 last_non_minibuf_size
= Z
- BEG
;
2968 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2970 while (buffer_size
> 64)
2971 delay_level
++, buffer_size
-= buffer_size
>> 2;
2972 if (delay_level
< 4) delay_level
= 4;
2973 /* delay_level is 4 for files under around 50k, 7 at 100k,
2974 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2976 /* Auto save if enough time goes by without input. */
2977 if (commandflag
!= 0
2978 && num_nonmacro_input_events
> last_auto_save
2979 && INTEGERP (Vauto_save_timeout
)
2980 && XINT (Vauto_save_timeout
) > 0)
2983 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2985 save_getcjmp (save_jump
);
2986 restore_getcjmp (local_getcjmp
);
2987 tem0
= sit_for (make_number (timeout
), 1, 1);
2988 restore_getcjmp (save_jump
);
2991 && ! CONSP (Vunread_command_events
))
2993 Fdo_auto_save (Qnil
, Qnil
);
2995 /* If we have auto-saved and there is still no input
2996 available, garbage collect if there has been enough
2997 consing going on to make it worthwhile. */
2998 if (!detect_input_pending_run_timers (0)
2999 && consing_since_gc
> gc_cons_threshold
/ 2)
3000 Fgarbage_collect ();
3007 /* Notify the caller if an autosave hook, or a timer, sentinel or
3008 filter in the sit_for calls above have changed the current
3009 kboard. This could happen if they use the minibuffer or start a
3010 recursive edit, like the fancy splash screen in server.el's
3011 filter. If this longjmp wasn't here, read_key_sequence would
3012 interpret the next key sequence using the wrong translation
3013 tables and function keymaps. */
3014 if (NILP (c
) && current_kboard
!= orig_kboard
)
3017 return make_number (-2); /* wrong_kboard_jmpbuf */
3020 /* If this has become non-nil here, it has been set by a timer
3021 or sentinel or filter. */
3022 if (CONSP (Vunread_command_events
))
3024 c
= XCAR (Vunread_command_events
);
3025 Vunread_command_events
= XCDR (Vunread_command_events
);
3028 /* Read something from current KBOARD's side queue, if possible. */
3032 if (current_kboard
->kbd_queue_has_data
)
3034 if (!CONSP (current_kboard
->kbd_queue
))
3036 c
= XCAR (current_kboard
->kbd_queue
);
3037 current_kboard
->kbd_queue
3038 = XCDR (current_kboard
->kbd_queue
);
3039 if (NILP (current_kboard
->kbd_queue
))
3040 current_kboard
->kbd_queue_has_data
= 0;
3041 input_pending
= readable_events (0);
3042 if (EVENT_HAS_PARAMETERS (c
)
3043 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
3044 internal_last_event_frame
= XCAR (XCDR (c
));
3045 Vlast_event_frame
= internal_last_event_frame
;
3050 /* If current_kboard's side queue is empty check the other kboards.
3051 If one of them has data that we have not yet seen here,
3052 switch to it and process the data waiting for it.
3054 Note: if the events queued up for another kboard
3055 have already been seen here, and therefore are not a complete command,
3056 the kbd_queue_has_data field is 0, so we skip that kboard here.
3057 That's to avoid an infinite loop switching between kboards here. */
3058 if (NILP (c
) && !single_kboard
)
3061 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3062 if (kb
->kbd_queue_has_data
)
3064 current_kboard
= kb
;
3065 /* This is going to exit from read_char
3066 so we had better get rid of this frame's stuff. */
3068 return make_number (-2); /* wrong_kboard_jmpbuf */
3077 /* Finally, we read from the main queue,
3078 and if that gives us something we can't use yet, we put it on the
3079 appropriate side queue and try again. */
3088 EMACS_GET_TIME (now
);
3089 if (EMACS_TIME_GE (now
, *end_time
))
3093 /* Actually read a character, waiting if necessary. */
3094 save_getcjmp (save_jump
);
3095 restore_getcjmp (local_getcjmp
);
3097 timer_start_idle ();
3098 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3099 restore_getcjmp (save_jump
);
3102 if (! NILP (c
) && (kb
!= current_kboard
))
3104 Lisp_Object link
= kb
->kbd_queue
;
3107 while (CONSP (XCDR (link
)))
3109 if (!NILP (XCDR (link
)))
3113 kb
->kbd_queue
= Fcons (c
, Qnil
);
3115 XSETCDR (link
, Fcons (c
, Qnil
));
3116 kb
->kbd_queue_has_data
= 1;
3120 current_kboard
= kb
;
3121 /* This is going to exit from read_char
3122 so we had better get rid of this frame's stuff. */
3124 return make_number (-2);
3129 /* Terminate Emacs in batch mode if at eof. */
3130 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3131 Fkill_emacs (make_number (1));
3135 /* Add in any extra modifiers, where appropriate. */
3136 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3137 || ((extra_keyboard_modifiers
& 0177) < ' '
3138 && (extra_keyboard_modifiers
& 0177) != 0))
3139 XSETINT (c
, make_ctrl_char (XINT (c
)));
3141 /* Transfer any other modifier bits directly from
3142 extra_keyboard_modifiers to c. Ignore the actual character code
3143 in the low 16 bits of extra_keyboard_modifiers. */
3144 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3155 if (commandflag
>= 0
3156 && !input_pending
&& !detect_input_pending_run_timers (0))
3164 /* Buffer switch events are only for internal wakeups
3165 so don't show them to the user.
3166 Also, don't record a key if we already did. */
3167 if (BUFFERP (c
) || key_already_recorded
)
3170 /* Process special events within read_char
3171 and loop around to read another event. */
3174 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3179 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3180 int was_locked
= single_kboard
;
3181 int count
= SPECPDL_INDEX ();
3182 record_single_kboard_state ();
3185 last_input_char
= c
;
3186 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3188 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3189 /* We stopped being idle for this event; undo that. This
3190 prevents automatic window selection (under
3191 mouse_autoselect_window from acting as a real input event, for
3192 example banishing the mouse under mouse-avoidance-mode. */
3193 timer_resume_idle ();
3195 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3196 /* Resume allowing input from any kboard, if that was true before. */
3198 any_kboard_state ();
3199 unbind_to (count
, Qnil
);
3205 /* Handle things that only apply to characters. */
3208 /* If kbd_buffer_get_event gave us an EOF, return that. */
3212 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3213 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3214 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3215 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3216 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3220 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3221 /* nil in keyboard-translate-table means no translation. */
3227 /* If this event is a mouse click in the menu bar,
3228 return just menu-bar for now. Modify the mouse click event
3229 so we won't do this twice, then queue it up. */
3230 if (EVENT_HAS_PARAMETERS (c
)
3232 && CONSP (EVENT_START (c
))
3233 && CONSP (XCDR (EVENT_START (c
))))
3237 posn
= POSN_POSN (EVENT_START (c
));
3238 /* Handle menu-bar events:
3239 insert the dummy prefix event `menu-bar'. */
3240 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3242 /* Change menu-bar to (menu-bar) as the event "position". */
3243 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3246 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3251 /* Store these characters into recent_keys, the dribble file if any,
3252 and the keyboard macro being defined, if any. */
3254 if (! NILP (also_record
))
3255 record_char (also_record
);
3257 /* Wipe the echo area.
3258 But first, if we are about to use an input method,
3259 save the echo area contents for it to refer to. */
3261 && ! NILP (Vinput_method_function
)
3262 && (unsigned) XINT (c
) >= ' '
3263 && (unsigned) XINT (c
) != 127
3264 && (unsigned) XINT (c
) < 256)
3266 previous_echo_area_message
= Fcurrent_message ();
3267 Vinput_method_previous_message
= previous_echo_area_message
;
3270 /* Now wipe the echo area, except for help events which do their
3271 own stuff with the echo area. */
3273 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3274 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3276 if (!NILP (echo_area_buffer
[0]))
3277 safe_run_hooks (Qecho_area_clear_hook
);
3278 clear_message (1, 0);
3281 reread_for_input_method
:
3283 /* Pass this to the input method, if appropriate. */
3285 && ! NILP (Vinput_method_function
)
3286 /* Don't run the input method within a key sequence,
3287 after the first event of the key sequence. */
3288 && NILP (prev_event
)
3289 && (unsigned) XINT (c
) >= ' '
3290 && (unsigned) XINT (c
) != 127
3291 && (unsigned) XINT (c
) < 256)
3294 int key_count
, key_count_reset
;
3295 struct gcpro gcpro1
;
3296 int count
= SPECPDL_INDEX ();
3298 /* Save the echo status. */
3299 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3300 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3301 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3302 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3305 if (before_command_restore_flag
)
3307 this_command_key_count
= before_command_key_count_1
;
3308 if (this_command_key_count
< this_single_command_key_start
)
3309 this_single_command_key_start
= this_command_key_count
;
3310 echo_truncate (before_command_echo_length_1
);
3311 before_command_restore_flag
= 0;
3315 /* Save the this_command_keys status. */
3316 key_count
= this_command_key_count
;
3317 key_count_reset
= this_command_key_count_reset
;
3320 keys
= Fcopy_sequence (this_command_keys
);
3325 /* Clear out this_command_keys. */
3326 this_command_key_count
= 0;
3327 this_command_key_count_reset
= 0;
3329 /* Now wipe the echo area. */
3330 if (!NILP (echo_area_buffer
[0]))
3331 safe_run_hooks (Qecho_area_clear_hook
);
3332 clear_message (1, 0);
3335 /* If we are not reading a key sequence,
3336 never use the echo area. */
3339 specbind (Qinput_method_use_echo_area
, Qt
);
3342 /* Call the input method. */
3343 tem
= call1 (Vinput_method_function
, c
);
3345 tem
= unbind_to (count
, tem
);
3347 /* Restore the saved echoing state
3348 and this_command_keys state. */
3349 this_command_key_count
= key_count
;
3350 this_command_key_count_reset
= key_count_reset
;
3352 this_command_keys
= keys
;
3355 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3356 current_kboard
->echo_string
= saved_echo_string
;
3357 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3358 if (saved_immediate_echo
)
3363 /* The input method can return no events. */
3366 /* Bring back the previous message, if any. */
3367 if (! NILP (previous_echo_area_message
))
3368 message_with_string ("%s", previous_echo_area_message
, 0);
3371 /* It returned one event or more. */
3373 Vunread_post_input_method_events
3374 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3379 /* Display help if not echoing. */
3380 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3382 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3383 Lisp_Object help
, object
, position
, window
, tem
;
3385 tem
= Fcdr (XCDR (c
));
3388 window
= Fcar (tem
);
3390 object
= Fcar (tem
);
3392 position
= Fcar (tem
);
3394 show_help_echo (help
, window
, object
, position
, 0);
3396 /* We stopped being idle for this event; undo that. */
3398 timer_resume_idle ();
3402 if ((! reread
|| this_command_key_count
== 0
3403 || this_command_key_count_reset
)
3407 /* Don't echo mouse motion events. */
3408 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3409 && NILP (Fzerop (Vecho_keystrokes
))
3410 && ! (EVENT_HAS_PARAMETERS (c
)
3411 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3414 if (! NILP (also_record
))
3415 echo_char (also_record
);
3416 /* Once we reread a character, echoing can happen
3417 the next time we pause to read a new one. */
3418 ok_to_echo_at_next_pause
= current_kboard
;
3421 /* Record this character as part of the current key. */
3422 add_command_key (c
);
3423 if (! NILP (also_record
))
3424 add_command_key (also_record
);
3427 last_input_char
= c
;
3430 /* Process the help character specially if enabled */
3431 if (!NILP (Vhelp_form
) && help_char_p (c
))
3434 count
= SPECPDL_INDEX ();
3436 help_form_saved_window_configs
3437 = Fcons (Fcurrent_window_configuration (Qnil
),
3438 help_form_saved_window_configs
);
3439 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3441 tem0
= Feval (Vhelp_form
);
3443 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3448 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3449 if (EVENT_HAS_PARAMETERS (c
)
3450 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3451 XSETCAR (help_form_saved_window_configs
, Qnil
);
3453 while (BUFFERP (c
));
3454 /* Remove the help from the frame */
3455 unbind_to (count
, Qnil
);
3458 if (EQ (c
, make_number (040)))
3462 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3463 while (BUFFERP (c
));
3472 /* Record a key that came from a mouse menu.
3473 Record it for echoing, for this-command-keys, and so on. */
3479 /* Wipe the echo area. */
3480 clear_message (1, 0);
3485 before_command_key_count
= this_command_key_count
;
3486 before_command_echo_length
= echo_length ();
3489 /* Don't echo mouse motion events. */
3490 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3491 && NILP (Fzerop (Vecho_keystrokes
)))
3495 /* Once we reread a character, echoing can happen
3496 the next time we pause to read a new one. */
3497 ok_to_echo_at_next_pause
= 0;
3500 /* Record this character as part of the current key. */
3501 add_command_key (c
);
3503 /* Re-reading in the middle of a command */
3504 last_input_char
= c
;
3508 /* Return 1 if should recognize C as "the help character". */
3516 if (EQ (c
, Vhelp_char
))
3518 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3519 if (EQ (c
, XCAR (tail
)))
3524 /* Record the input event C in various ways. */
3532 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3534 /* To avoid filling recent_keys with help-echo and mouse-movement
3535 events, we filter out repeated help-echo events, only store the
3536 first and last in a series of mouse-movement events, and don't
3537 store repeated help-echo events which are only separated by
3538 mouse-movement events. */
3540 Lisp_Object ev1
, ev2
, ev3
;
3543 if ((ix1
= recent_keys_index
- 1) < 0)
3544 ix1
= NUM_RECENT_KEYS
- 1;
3545 ev1
= AREF (recent_keys
, ix1
);
3547 if ((ix2
= ix1
- 1) < 0)
3548 ix2
= NUM_RECENT_KEYS
- 1;
3549 ev2
= AREF (recent_keys
, ix2
);
3551 if ((ix3
= ix2
- 1) < 0)
3552 ix3
= NUM_RECENT_KEYS
- 1;
3553 ev3
= AREF (recent_keys
, ix3
);
3555 if (EQ (XCAR (c
), Qhelp_echo
))
3557 /* Don't record `help-echo' in recent_keys unless it shows some help
3558 message, and a different help than the previously recorded
3560 Lisp_Object help
, last_help
;
3562 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3563 if (!STRINGP (help
))
3565 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3566 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3568 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3569 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3570 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3572 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3573 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3574 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3575 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3578 else if (EQ (XCAR (c
), Qmouse_movement
))
3580 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3581 So additional mouse movement events replace the last element. */
3582 Lisp_Object last_window
, window
;
3584 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3585 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3586 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3587 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3588 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3590 ASET (recent_keys
, ix1
, c
);
3596 store_kbd_macro_char (c
);
3601 ASET (recent_keys
, recent_keys_index
, c
);
3602 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3603 recent_keys_index
= 0;
3605 else if (recorded
< 0)
3607 /* We need to remove one or two events from recent_keys.
3608 To do this, we simply put nil at those events and move the
3609 recent_keys_index backwards over those events. Usually,
3610 users will never see those nil events, as they will be
3611 overwritten by the command keys entered to see recent_keys
3614 while (recorded
++ < 0 && total_keys
> 0)
3616 if (total_keys
< NUM_RECENT_KEYS
)
3618 if (--recent_keys_index
< 0)
3619 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3620 ASET (recent_keys
, recent_keys_index
, Qnil
);
3624 num_nonmacro_input_events
++;
3626 /* Write c to the dribble file. If c is a lispy event, write
3627 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3628 If you, dear reader, have a better idea, you've got the source. :-) */
3634 if (XUINT (c
) < 0x100)
3635 putc (XINT (c
), dribble
);
3637 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3641 Lisp_Object dribblee
;
3643 /* If it's a structured event, take the event header. */
3644 dribblee
= EVENT_HEAD (c
);
3646 if (SYMBOLP (dribblee
))
3648 putc ('<', dribble
);
3649 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3650 SBYTES (SYMBOL_NAME (dribblee
)),
3652 putc ('>', dribble
);
3665 struct buffer
*old
= current_buffer
;
3666 Fprinc (object
, Qnil
);
3667 set_buffer_internal (XBUFFER (Vstandard_output
));
3668 call0 (intern ("help-mode"));
3669 set_buffer_internal (old
);
3673 /* Copy out or in the info on where C-g should throw to.
3674 This is used when running Lisp code from within get_char,
3675 in case get_char is called recursively.
3676 See read_process_output. */
3682 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3686 restore_getcjmp (temp
)
3689 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3692 /* Low level keyboard/mouse input.
3693 kbd_buffer_store_event places events in kbd_buffer, and
3694 kbd_buffer_get_event retrieves them. */
3696 /* Return true if there are any events in the queue that read-char
3697 would return. If this returns false, a read-char would block. */
3699 readable_events (flags
)
3702 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3705 /* If the buffer contains only FOCUS_IN_EVENT events, and
3706 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3707 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3709 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3710 #ifdef USE_TOOLKIT_SCROLL_BARS
3711 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3715 struct input_event
*event
;
3717 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3724 #ifdef USE_TOOLKIT_SCROLL_BARS
3725 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3727 event
->kind
== FOCUS_IN_EVENT
)
3728 #ifdef USE_TOOLKIT_SCROLL_BARS
3729 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3730 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3731 && event
->part
== scroll_bar_handle
3732 && event
->modifiers
== 0)
3737 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3740 while (event
!= kbd_store_ptr
);
3746 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3747 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3748 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3753 if (current_kboard
->kbd_queue_has_data
)
3759 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3760 if (kb
->kbd_queue_has_data
)
3766 /* Set this for debugging, to have a way to get out */
3771 event_to_kboard (event
)
3772 struct input_event
*event
;
3775 frame
= event
->frame_or_window
;
3777 frame
= XCAR (frame
);
3778 else if (WINDOWP (frame
))
3779 frame
= WINDOW_FRAME (XWINDOW (frame
));
3781 /* There are still some events that don't set this field.
3782 For now, just ignore the problem.
3783 Also ignore dead frames here. */
3784 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3787 return FRAME_KBOARD (XFRAME (frame
));
3792 Lisp_Object Vthrow_on_input
;
3794 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3797 kbd_buffer_store_event (event
)
3798 register struct input_event
*event
;
3800 kbd_buffer_store_event_hold (event
, 0);
3803 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3805 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3806 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3807 Else, if EVENT is a quit event, store the quit event
3808 in HOLD_QUIT, and return (thus ignoring further events).
3810 This is used in read_avail_input to postpone the processing
3811 of the quit event until all subsequent input events have been
3812 parsed (and discarded).
3816 kbd_buffer_store_event_hold (event
, hold_quit
)
3817 register struct input_event
*event
;
3818 struct input_event
*hold_quit
;
3820 if (event
->kind
== NO_EVENT
)
3823 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3826 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3828 register int c
= event
->code
& 0377;
3830 if (event
->modifiers
& ctrl_modifier
)
3831 c
= make_ctrl_char (c
);
3833 c
|= (event
->modifiers
3834 & (meta_modifier
| alt_modifier
3835 | hyper_modifier
| super_modifier
));
3840 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3841 struct input_event
*sp
;
3843 if (single_kboard
&& kb
!= current_kboard
)
3846 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3847 Fcons (make_number (c
), Qnil
));
3848 kb
->kbd_queue_has_data
= 1;
3849 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3851 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3854 if (event_to_kboard (sp
) == kb
)
3856 sp
->kind
= NO_EVENT
;
3857 sp
->frame_or_window
= Qnil
;
3867 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3871 /* If this results in a quit_char being returned to Emacs as
3872 input, set Vlast_event_frame properly. If this doesn't
3873 get returned to Emacs as an event, the next event read
3874 will set Vlast_event_frame again, so this is safe to do. */
3878 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3880 focus
= event
->frame_or_window
;
3881 internal_last_event_frame
= focus
;
3882 Vlast_event_frame
= focus
;
3885 last_event_timestamp
= event
->timestamp
;
3886 handle_interrupt ();
3890 if (c
&& c
== stop_character
)
3896 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3897 Just ignore the second one. */
3898 else if (event
->kind
== BUFFER_SWITCH_EVENT
3899 && kbd_fetch_ptr
!= kbd_store_ptr
3900 && ((kbd_store_ptr
== kbd_buffer
3901 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3902 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3905 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3906 kbd_store_ptr
= kbd_buffer
;
3908 /* Don't let the very last slot in the buffer become full,
3909 since that would make the two pointers equal,
3910 and that is indistinguishable from an empty buffer.
3911 Discard the event if it would fill the last slot. */
3912 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3914 *kbd_store_ptr
= *event
;
3918 /* If we're inside while-no-input, and this event qualifies
3919 as input, set quit-flag to cause an interrupt. */
3920 if (!NILP (Vthrow_on_input
)
3921 && event
->kind
!= FOCUS_IN_EVENT
3922 && event
->kind
!= HELP_EVENT
3923 && event
->kind
!= DEICONIFY_EVENT
)
3925 Vquit_flag
= Vthrow_on_input
;
3926 /* If we're inside a function that wants immediate quits,
3928 if (immediate_quit
&& NILP (Vinhibit_quit
))
3938 /* Put an input event back in the head of the event queue. */
3941 kbd_buffer_unget_event (event
)
3942 register struct input_event
*event
;
3944 if (kbd_fetch_ptr
== kbd_buffer
)
3945 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3947 /* Don't let the very last slot in the buffer become full, */
3948 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3951 *kbd_fetch_ptr
= *event
;
3956 /* Generate HELP_EVENT input_events in BUFP which has room for
3957 SIZE events. If there's not enough room in BUFP, ignore this
3960 HELP is the help form.
3962 FRAME is the frame on which the help is generated. OBJECT is the
3963 Lisp object where the help was found (a buffer, a string, an
3964 overlay, or nil if neither from a string nor from a buffer. POS is
3965 the position within OBJECT where the help was found.
3967 Value is the number of input_events generated. */
3970 gen_help_event (help
, frame
, window
, object
, pos
)
3971 Lisp_Object help
, frame
, object
, window
;
3974 struct input_event event
;
3978 event
.kind
= HELP_EVENT
;
3979 event
.frame_or_window
= frame
;
3981 event
.x
= WINDOWP (window
) ? window
: frame
;
3984 kbd_buffer_store_event (&event
);
3988 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3991 kbd_buffer_store_help_event (frame
, help
)
3992 Lisp_Object frame
, help
;
3994 struct input_event event
;
3996 event
.kind
= HELP_EVENT
;
3997 event
.frame_or_window
= frame
;
4002 kbd_buffer_store_event (&event
);
4006 /* Discard any mouse events in the event buffer by setting them to
4009 discard_mouse_events ()
4011 struct input_event
*sp
;
4012 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
4014 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4017 if (sp
->kind
== MOUSE_CLICK_EVENT
4018 || sp
->kind
== WHEEL_EVENT
4019 || sp
->kind
== HORIZ_WHEEL_EVENT
4021 || sp
->kind
== GPM_CLICK_EVENT
4023 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
4025 sp
->kind
= NO_EVENT
;
4031 /* Return non-zero if there are any real events waiting in the event
4032 buffer, not counting `NO_EVENT's.
4034 If DISCARD is non-zero, discard NO_EVENT events at the front of
4035 the input queue, possibly leaving the input queue empty if there
4036 are no real input events. */
4039 kbd_buffer_events_waiting (discard
)
4042 struct input_event
*sp
;
4044 for (sp
= kbd_fetch_ptr
;
4045 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4048 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4055 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4059 /* Clear input event EVENT. */
4063 struct input_event
*event
;
4065 event
->kind
= NO_EVENT
;
4069 /* Read one event from the event buffer, waiting if necessary.
4070 The value is a Lisp object representing the event.
4071 The value is nil for an event that should be ignored,
4072 or that was handled here.
4073 We always read and discard one event. */
4076 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4078 int *used_mouse_menu
;
4079 EMACS_TIME
*end_time
;
4088 *kbp
= current_kboard
;
4092 /* Wait until there is input available. */
4095 /* Break loop if there's an unread command event. Needed in
4096 moused window autoselection which uses a timer to insert such
4098 if (CONSP (Vunread_command_events
))
4101 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4103 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4104 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4108 /* If the quit flag is set, then read_char will return
4109 quit_char, so that counts as "available input." */
4110 if (!NILP (Vquit_flag
))
4111 quit_throw_to_read_char ();
4113 /* One way or another, wait until input is available; then, if
4114 interrupt handlers have not read it, read it now. */
4117 wait_for_kbd_input ();
4119 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4123 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4125 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4126 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4131 EMACS_TIME duration
;
4132 EMACS_GET_TIME (duration
);
4133 if (EMACS_TIME_GE (duration
, *end_time
))
4134 return Qnil
; /* finished waiting */
4137 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4138 wait_reading_process_output (EMACS_SECS (duration
),
4139 EMACS_USECS (duration
),
4140 -1, 1, Qnil
, NULL
, 0);
4144 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4146 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4147 /* Pass 1 for EXPECT since we just waited to have input. */
4148 read_avail_input (1);
4149 #endif /* not VMS */
4152 if (CONSP (Vunread_command_events
))
4155 first
= XCAR (Vunread_command_events
);
4156 Vunread_command_events
= XCDR (Vunread_command_events
);
4157 *kbp
= current_kboard
;
4161 /* At this point, we know that there is a readable event available
4162 somewhere. If the event queue is empty, then there must be a
4163 mouse movement enabled and available. */
4164 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4166 struct input_event
*event
;
4168 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4172 last_event_timestamp
= event
->timestamp
;
4175 *kbp
= event_to_kboard (event
);
4177 *kbp
= current_kboard
; /* Better than returning null ptr? */
4179 *kbp
= &the_only_kboard
;
4184 /* These two kinds of events get special handling
4185 and don't actually appear to the command loop.
4186 We return nil for them. */
4187 if (event
->kind
== SELECTION_REQUEST_EVENT
4188 || event
->kind
== SELECTION_CLEAR_EVENT
)
4191 struct input_event copy
;
4193 /* Remove it from the buffer before processing it,
4194 since otherwise swallow_events will see it
4195 and process it again. */
4197 kbd_fetch_ptr
= event
+ 1;
4198 input_pending
= readable_events (0);
4199 x_handle_selection_event (©
);
4201 /* We're getting selection request events, but we don't have
4207 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4208 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4210 /* Make an event (delete-frame (FRAME)). */
4211 obj
= Fcons (event
->frame_or_window
, Qnil
);
4212 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4213 kbd_fetch_ptr
= event
+ 1;
4216 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4217 else if (event
->kind
== ICONIFY_EVENT
)
4219 /* Make an event (iconify-frame (FRAME)). */
4220 obj
= Fcons (event
->frame_or_window
, Qnil
);
4221 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4222 kbd_fetch_ptr
= event
+ 1;
4224 else if (event
->kind
== DEICONIFY_EVENT
)
4226 /* Make an event (make-frame-visible (FRAME)). */
4227 obj
= Fcons (event
->frame_or_window
, Qnil
);
4228 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4229 kbd_fetch_ptr
= event
+ 1;
4232 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4234 /* The value doesn't matter here; only the type is tested. */
4235 XSETBUFFER (obj
, current_buffer
);
4236 kbd_fetch_ptr
= event
+ 1;
4238 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4239 || defined (USE_GTK)
4240 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4242 kbd_fetch_ptr
= event
+ 1;
4243 input_pending
= readable_events (0);
4244 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4245 x_activate_menubar (XFRAME (event
->frame_or_window
));
4248 #if defined (WINDOWSNT) || defined (MAC_OS)
4249 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4252 /* Make an event (language-change (KEY_SCRIPT)). */
4253 obj
= Fcons (make_number (event
->code
), Qnil
);
4255 /* Make an event (language-change (FRAME CHARSET LCID)). */
4256 obj
= Fcons (event
->frame_or_window
, Qnil
);
4258 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4259 kbd_fetch_ptr
= event
+ 1;
4262 else if (event
->kind
== SAVE_SESSION_EVENT
)
4264 obj
= Fcons (Qsave_session
, Qnil
);
4265 kbd_fetch_ptr
= event
+ 1;
4267 /* Just discard these, by returning nil.
4268 With MULTI_KBOARD, these events are used as placeholders
4269 when we need to randomly delete events from the queue.
4270 (They shouldn't otherwise be found in the buffer,
4271 but on some machines it appears they do show up
4272 even without MULTI_KBOARD.) */
4273 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4274 mouse events during a popup-menu call. */
4275 else if (event
->kind
== NO_EVENT
)
4276 kbd_fetch_ptr
= event
+ 1;
4277 else if (event
->kind
== HELP_EVENT
)
4279 Lisp_Object object
, position
, help
, frame
, window
;
4281 frame
= event
->frame_or_window
;
4282 object
= event
->arg
;
4283 position
= make_number (event
->code
);
4286 clear_event (event
);
4288 kbd_fetch_ptr
= event
+ 1;
4289 if (!WINDOWP (window
))
4291 obj
= Fcons (Qhelp_echo
,
4292 list5 (frame
, help
, window
, object
, position
));
4294 else if (event
->kind
== FOCUS_IN_EVENT
)
4296 /* Notification of a FocusIn event. The frame receiving the
4297 focus is in event->frame_or_window. Generate a
4298 switch-frame event if necessary. */
4299 Lisp_Object frame
, focus
;
4301 frame
= event
->frame_or_window
;
4302 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4306 if (!EQ (frame
, internal_last_event_frame
)
4307 && !EQ (frame
, selected_frame
))
4308 obj
= make_lispy_switch_frame (frame
);
4309 internal_last_event_frame
= frame
;
4310 kbd_fetch_ptr
= event
+ 1;
4314 /* If this event is on a different frame, return a switch-frame this
4315 time, and leave the event in the queue for next time. */
4319 frame
= event
->frame_or_window
;
4321 frame
= XCAR (frame
);
4322 else if (WINDOWP (frame
))
4323 frame
= WINDOW_FRAME (XWINDOW (frame
));
4325 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4329 if (! EQ (frame
, internal_last_event_frame
)
4330 && !EQ (frame
, selected_frame
))
4331 obj
= make_lispy_switch_frame (frame
);
4332 internal_last_event_frame
= frame
;
4334 /* If we didn't decide to make a switch-frame event, go ahead
4335 and build a real event from the queue entry. */
4339 obj
= make_lispy_event (event
);
4341 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4342 || defined (USE_GTK)
4343 /* If this was a menu selection, then set the flag to inhibit
4344 writing to last_nonmenu_event. Don't do this if the event
4345 we're returning is (menu-bar), though; that indicates the
4346 beginning of the menu sequence, and we might as well leave
4347 that as the `event with parameters' for this selection. */
4349 && !EQ (event
->frame_or_window
, event
->arg
)
4350 && (event
->kind
== MENU_BAR_EVENT
4351 || event
->kind
== TOOL_BAR_EVENT
))
4352 *used_mouse_menu
= 1;
4355 /* Wipe out this event, to catch bugs. */
4356 clear_event (event
);
4357 kbd_fetch_ptr
= event
+ 1;
4361 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4362 /* Try generating a mouse motion event. */
4363 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4365 FRAME_PTR f
= some_mouse_moved ();
4366 Lisp_Object bar_window
;
4367 enum scroll_bar_part part
;
4371 *kbp
= current_kboard
;
4372 /* Note that this uses F to determine which terminal to look at.
4373 If there is no valid info, it does not store anything
4374 so x remains nil. */
4377 /* XXX Can f or mouse_position_hook be NULL here? */
4378 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4379 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4380 &part
, &x
, &y
, &time
);
4384 /* Decide if we should generate a switch-frame event. Don't
4385 generate switch-frame events for motion outside of all Emacs
4391 frame
= FRAME_FOCUS_FRAME (f
);
4393 XSETFRAME (frame
, f
);
4395 if (! EQ (frame
, internal_last_event_frame
)
4396 && !EQ (frame
, selected_frame
))
4397 obj
= make_lispy_switch_frame (frame
);
4398 internal_last_event_frame
= frame
;
4401 /* If we didn't decide to make a switch-frame event, go ahead and
4402 return a mouse-motion event. */
4403 if (!NILP (x
) && NILP (obj
))
4404 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4406 #endif /* HAVE_MOUSE || HAVE GPM */
4408 /* We were promised by the above while loop that there was
4409 something for us to read! */
4412 input_pending
= readable_events (0);
4414 Vlast_event_frame
= internal_last_event_frame
;
4419 /* Process any events that are not user-visible,
4420 then return, without reading any user-visible events. */
4423 swallow_events (do_display
)
4428 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4430 struct input_event
*event
;
4432 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4436 last_event_timestamp
= event
->timestamp
;
4438 /* These two kinds of events get special handling
4439 and don't actually appear to the command loop. */
4440 if (event
->kind
== SELECTION_REQUEST_EVENT
4441 || event
->kind
== SELECTION_CLEAR_EVENT
)
4444 struct input_event copy
;
4446 /* Remove it from the buffer before processing it,
4447 since otherwise swallow_events called recursively could see it
4448 and process it again. */
4450 kbd_fetch_ptr
= event
+ 1;
4451 input_pending
= readable_events (0);
4452 x_handle_selection_event (©
);
4454 /* We're getting selection request events, but we don't have
4463 old_timers_run
= timers_run
;
4464 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4466 if (timers_run
!= old_timers_run
&& do_display
)
4467 redisplay_preserve_echo_area (7);
4470 /* Record the start of when Emacs is idle,
4471 for the sake of running idle-time timers. */
4478 /* If we are already in the idle state, do nothing. */
4479 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4482 EMACS_GET_TIME (timer_idleness_start_time
);
4484 timer_last_idleness_start_time
= timer_idleness_start_time
;
4486 /* Mark all idle-time timers as once again candidates for running. */
4487 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4491 timer
= XCAR (timers
);
4493 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4495 XVECTOR (timer
)->contents
[0] = Qnil
;
4499 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4504 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4507 /* Resume idle timer from last idle start time. */
4510 timer_resume_idle ()
4512 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4515 timer_idleness_start_time
= timer_last_idleness_start_time
;
4518 /* This is only for debugging. */
4519 struct input_event last_timer_event
;
4521 /* Check whether a timer has fired. To prevent larger problems we simply
4522 disregard elements that are not proper timers. Do not make a circular
4523 timer list for the time being.
4525 Returns the number of seconds to wait until the next timer fires. If a
4526 timer is triggering now, return zero seconds.
4527 If no timer is active, return -1 seconds.
4529 If a timer is ripe, we run it, with quitting turned off.
4531 DO_IT_NOW is now ignored. It used to mean that we should
4532 run the timer directly instead of queueing a timer-event.
4533 Now we always run timers directly. */
4536 timer_check (do_it_now
)
4539 EMACS_TIME nexttime
;
4540 EMACS_TIME now
, idleness_now
;
4541 Lisp_Object timers
, idle_timers
, chosen_timer
;
4542 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4544 EMACS_SET_SECS (nexttime
, -1);
4545 EMACS_SET_USECS (nexttime
, -1);
4547 /* Always consider the ordinary timers. */
4548 timers
= Vtimer_list
;
4549 /* Consider the idle timers only if Emacs is idle. */
4550 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4551 idle_timers
= Vtimer_idle_list
;
4554 chosen_timer
= Qnil
;
4555 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4557 if (CONSP (timers
) || CONSP (idle_timers
))
4559 EMACS_GET_TIME (now
);
4560 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4561 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4564 while (CONSP (timers
) || CONSP (idle_timers
))
4566 Lisp_Object
*vector
;
4567 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4568 EMACS_TIME timer_time
, idle_timer_time
;
4569 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4571 /* Skip past invalid timers and timers already handled. */
4574 timer
= XCAR (timers
);
4575 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4577 timers
= XCDR (timers
);
4580 vector
= XVECTOR (timer
)->contents
;
4582 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4583 || !INTEGERP (vector
[3])
4584 || ! NILP (vector
[0]))
4586 timers
= XCDR (timers
);
4590 if (!NILP (idle_timers
))
4592 timer
= XCAR (idle_timers
);
4593 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4595 idle_timers
= XCDR (idle_timers
);
4598 vector
= XVECTOR (timer
)->contents
;
4600 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4601 || !INTEGERP (vector
[3])
4602 || ! NILP (vector
[0]))
4604 idle_timers
= XCDR (idle_timers
);
4609 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4610 based on the next ordinary timer.
4611 TIMER_DIFFERENCE is the distance in time from NOW to when
4612 this timer becomes ripe (negative if it's already ripe). */
4615 timer
= XCAR (timers
);
4616 vector
= XVECTOR (timer
)->contents
;
4617 EMACS_SET_SECS (timer_time
,
4618 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4619 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4620 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4623 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4624 based on the next idle timer. */
4625 if (!NILP (idle_timers
))
4627 idle_timer
= XCAR (idle_timers
);
4628 vector
= XVECTOR (idle_timer
)->contents
;
4629 EMACS_SET_SECS (idle_timer_time
,
4630 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4631 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4632 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4635 /* Decide which timer is the next timer,
4636 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4637 Also step down the list where we found that timer. */
4639 if (! NILP (timers
) && ! NILP (idle_timers
))
4642 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4643 if (EMACS_TIME_NEG_P (temp
))
4645 chosen_timer
= timer
;
4646 timers
= XCDR (timers
);
4647 difference
= timer_difference
;
4651 chosen_timer
= idle_timer
;
4652 idle_timers
= XCDR (idle_timers
);
4653 difference
= idle_timer_difference
;
4656 else if (! NILP (timers
))
4658 chosen_timer
= timer
;
4659 timers
= XCDR (timers
);
4660 difference
= timer_difference
;
4664 chosen_timer
= idle_timer
;
4665 idle_timers
= XCDR (idle_timers
);
4666 difference
= idle_timer_difference
;
4668 vector
= XVECTOR (chosen_timer
)->contents
;
4670 /* If timer is ripe, run it if it hasn't been run. */
4671 if (EMACS_TIME_NEG_P (difference
)
4672 || (EMACS_SECS (difference
) == 0
4673 && EMACS_USECS (difference
) == 0))
4675 if (NILP (vector
[0]))
4677 int count
= SPECPDL_INDEX ();
4678 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4680 #if 0 /* This shouldn't be necessary anymore. --lorentey */
4681 /* On unbind_to, resume allowing input from any kboard, if that
4683 record_single_kboard_state ();
4685 /* Mark the timer as triggered to prevent problems if the lisp
4686 code fails to reschedule it right. */
4689 specbind (Qinhibit_quit
, Qt
);
4691 call1 (Qtimer_event_handler
, chosen_timer
);
4692 Vdeactivate_mark
= old_deactivate_mark
;
4694 unbind_to (count
, Qnil
);
4696 /* Since we have handled the event,
4697 we don't need to tell the caller to wake up and do it. */
4701 /* When we encounter a timer that is still waiting,
4702 return the amount of time to wait before it is ripe. */
4709 /* No timers are pending in the future. */
4710 /* Return 0 if we generated an event, and -1 if not. */
4715 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4716 doc
: /* Return the current length of Emacs idleness, or nil.
4717 The value when Emacs is idle is a list of three integers. The first has the
4718 most significant 16 bits of the seconds, while the second has the
4719 least significant 16 bits. The third integer gives the microsecond
4722 The value when Emacs is not idle is nil.
4724 The microsecond count is zero on systems that do not provide
4725 resolution finer than a second. */)
4728 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4730 EMACS_TIME now
, idleness_now
;
4732 EMACS_GET_TIME (now
);
4733 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4735 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4736 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4737 make_number (EMACS_USECS (idleness_now
)));
4743 /* Caches for modify_event_symbol. */
4744 static Lisp_Object accent_key_syms
;
4745 static Lisp_Object func_key_syms
;
4746 static Lisp_Object mouse_syms
;
4747 static Lisp_Object wheel_syms
;
4748 static Lisp_Object drag_n_drop_syms
;
4750 /* This is a list of keysym codes for special "accent" characters.
4751 It parallels lispy_accent_keys. */
4753 static int lispy_accent_codes
[] =
4755 #ifdef XK_dead_circumflex
4760 #ifdef XK_dead_grave
4765 #ifdef XK_dead_tilde
4770 #ifdef XK_dead_diaeresis
4775 #ifdef XK_dead_macron
4780 #ifdef XK_dead_degree
4785 #ifdef XK_dead_acute
4790 #ifdef XK_dead_cedilla
4795 #ifdef XK_dead_breve
4800 #ifdef XK_dead_ogonek
4805 #ifdef XK_dead_caron
4810 #ifdef XK_dead_doubleacute
4811 XK_dead_doubleacute
,
4815 #ifdef XK_dead_abovedot
4820 #ifdef XK_dead_abovering
4830 #ifdef XK_dead_belowdot
4835 #ifdef XK_dead_voiced_sound
4836 XK_dead_voiced_sound
,
4840 #ifdef XK_dead_semivoiced_sound
4841 XK_dead_semivoiced_sound
,
4857 /* This is a list of Lisp names for special "accent" characters.
4858 It parallels lispy_accent_codes. */
4860 static char *lispy_accent_keys
[] =
4878 "dead-voiced-sound",
4879 "dead-semivoiced-sound",
4885 #define FUNCTION_KEY_OFFSET 0x0
4887 char *lispy_function_keys
[] =
4891 0, /* VK_LBUTTON 0x01 */
4892 0, /* VK_RBUTTON 0x02 */
4893 "cancel", /* VK_CANCEL 0x03 */
4894 0, /* VK_MBUTTON 0x04 */
4896 0, 0, 0, /* 0x05 .. 0x07 */
4898 "backspace", /* VK_BACK 0x08 */
4899 "tab", /* VK_TAB 0x09 */
4901 0, 0, /* 0x0A .. 0x0B */
4903 "clear", /* VK_CLEAR 0x0C */
4904 "return", /* VK_RETURN 0x0D */
4906 0, 0, /* 0x0E .. 0x0F */
4908 0, /* VK_SHIFT 0x10 */
4909 0, /* VK_CONTROL 0x11 */
4910 0, /* VK_MENU 0x12 */
4911 "pause", /* VK_PAUSE 0x13 */
4912 "capslock", /* VK_CAPITAL 0x14 */
4913 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4915 "junja", /* VK_JUNJA 0x17 */
4916 "final", /* VK_FINAL 0x18 */
4917 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4919 "escape", /* VK_ESCAPE 0x1B */
4920 "convert", /* VK_CONVERT 0x1C */
4921 "non-convert", /* VK_NONCONVERT 0x1D */
4922 "accept", /* VK_ACCEPT 0x1E */
4923 "mode-change", /* VK_MODECHANGE 0x1F */
4924 0, /* VK_SPACE 0x20 */
4925 "prior", /* VK_PRIOR 0x21 */
4926 "next", /* VK_NEXT 0x22 */
4927 "end", /* VK_END 0x23 */
4928 "home", /* VK_HOME 0x24 */
4929 "left", /* VK_LEFT 0x25 */
4930 "up", /* VK_UP 0x26 */
4931 "right", /* VK_RIGHT 0x27 */
4932 "down", /* VK_DOWN 0x28 */
4933 "select", /* VK_SELECT 0x29 */
4934 "print", /* VK_PRINT 0x2A */
4935 "execute", /* VK_EXECUTE 0x2B */
4936 "snapshot", /* VK_SNAPSHOT 0x2C */
4937 "insert", /* VK_INSERT 0x2D */
4938 "delete", /* VK_DELETE 0x2E */
4939 "help", /* VK_HELP 0x2F */
4941 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4943 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4945 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4947 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4949 0, 0, 0, 0, 0, 0, 0, 0, 0,
4950 0, 0, 0, 0, 0, 0, 0, 0, 0,
4951 0, 0, 0, 0, 0, 0, 0, 0,
4953 "lwindow", /* VK_LWIN 0x5B */
4954 "rwindow", /* VK_RWIN 0x5C */
4955 "apps", /* VK_APPS 0x5D */
4958 "kp-0", /* VK_NUMPAD0 0x60 */
4959 "kp-1", /* VK_NUMPAD1 0x61 */
4960 "kp-2", /* VK_NUMPAD2 0x62 */
4961 "kp-3", /* VK_NUMPAD3 0x63 */
4962 "kp-4", /* VK_NUMPAD4 0x64 */
4963 "kp-5", /* VK_NUMPAD5 0x65 */
4964 "kp-6", /* VK_NUMPAD6 0x66 */
4965 "kp-7", /* VK_NUMPAD7 0x67 */
4966 "kp-8", /* VK_NUMPAD8 0x68 */
4967 "kp-9", /* VK_NUMPAD9 0x69 */
4968 "kp-multiply", /* VK_MULTIPLY 0x6A */
4969 "kp-add", /* VK_ADD 0x6B */
4970 "kp-separator", /* VK_SEPARATOR 0x6C */
4971 "kp-subtract", /* VK_SUBTRACT 0x6D */
4972 "kp-decimal", /* VK_DECIMAL 0x6E */
4973 "kp-divide", /* VK_DIVIDE 0x6F */
4974 "f1", /* VK_F1 0x70 */
4975 "f2", /* VK_F2 0x71 */
4976 "f3", /* VK_F3 0x72 */
4977 "f4", /* VK_F4 0x73 */
4978 "f5", /* VK_F5 0x74 */
4979 "f6", /* VK_F6 0x75 */
4980 "f7", /* VK_F7 0x76 */
4981 "f8", /* VK_F8 0x77 */
4982 "f9", /* VK_F9 0x78 */
4983 "f10", /* VK_F10 0x79 */
4984 "f11", /* VK_F11 0x7A */
4985 "f12", /* VK_F12 0x7B */
4986 "f13", /* VK_F13 0x7C */
4987 "f14", /* VK_F14 0x7D */
4988 "f15", /* VK_F15 0x7E */
4989 "f16", /* VK_F16 0x7F */
4990 "f17", /* VK_F17 0x80 */
4991 "f18", /* VK_F18 0x81 */
4992 "f19", /* VK_F19 0x82 */
4993 "f20", /* VK_F20 0x83 */
4994 "f21", /* VK_F21 0x84 */
4995 "f22", /* VK_F22 0x85 */
4996 "f23", /* VK_F23 0x86 */
4997 "f24", /* VK_F24 0x87 */
4999 0, 0, 0, 0, /* 0x88 .. 0x8B */
5000 0, 0, 0, 0, /* 0x8C .. 0x8F */
5002 "kp-numlock", /* VK_NUMLOCK 0x90 */
5003 "scroll", /* VK_SCROLL 0x91 */
5004 /* Not sure where the following block comes from.
5005 Windows headers have NEC and Fujitsu specific keys in
5006 this block, but nothing generic. */
5007 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
5008 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
5009 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
5010 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
5011 "kp-end", /* VK_NUMPAD_END 0x96 */
5012 "kp-home", /* VK_NUMPAD_HOME 0x97 */
5013 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
5014 "kp-up", /* VK_NUMPAD_UP 0x99 */
5015 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
5016 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
5017 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
5018 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
5020 0, 0, /* 0x9E .. 0x9F */
5023 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5024 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5025 * No other API or message will distinguish left and right keys this way.
5030 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5031 to enable them selectively, and gives access to a few more functions.
5032 See lispy_multimedia_keys below. */
5033 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5034 0, 0, 0, /* 0xAD .. 0xAF Volume */
5035 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5036 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5038 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5039 0, 0, 0, 0, 0, 0, 0, 0, 0,
5041 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5042 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5043 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5046 "ax", /* VK_OEM_AX 0xE1 */
5047 0, /* VK_OEM_102 0xE2 */
5048 "ico-help", /* VK_ICO_HELP 0xE3 */
5049 "ico-00", /* VK_ICO_00 0xE4 */
5050 0, /* VK_PROCESSKEY 0xE5 */
5051 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5052 "packet", /* VK_PACKET 0xE7 */
5054 "reset", /* VK_OEM_RESET 0xE9 */
5055 "jump", /* VK_OEM_JUMP 0xEA */
5056 "oem-pa1", /* VK_OEM_PA1 0xEB */
5057 "oem-pa2", /* VK_OEM_PA2 0xEC */
5058 "oem-pa3", /* VK_OEM_PA3 0xED */
5059 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5060 "cusel", /* VK_OEM_CUSEL 0xEF */
5061 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5062 "finish", /* VK_OEM_FINISH 0xF1 */
5063 "copy", /* VK_OEM_COPY 0xF2 */
5064 "auto", /* VK_OEM_AUTO 0xF3 */
5065 "enlw", /* VK_OEM_ENLW 0xF4 */
5066 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5067 "attn", /* VK_ATTN 0xF6 */
5068 "crsel", /* VK_CRSEL 0xF7 */
5069 "exsel", /* VK_EXSEL 0xF8 */
5070 "ereof", /* VK_EREOF 0xF9 */
5071 "play", /* VK_PLAY 0xFA */
5072 "zoom", /* VK_ZOOM 0xFB */
5073 "noname", /* VK_NONAME 0xFC */
5074 "pa1", /* VK_PA1 0xFD */
5075 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5079 /* Some of these duplicate the "Media keys" on newer keyboards,
5080 but they are delivered to the application in a different way. */
5081 static char *lispy_multimedia_keys
[] =
5089 "browser-favorites",
5126 "toggle-dictate-command",
5132 "media-fast-forward",
5135 "media-channel-down"
5138 #else /* not HAVE_NTGUI */
5140 /* This should be dealt with in XTread_socket now, and that doesn't
5141 depend on the client system having the Kana syms defined. See also
5142 the XK_kana_A case below. */
5145 static char *lispy_kana_keys
[] =
5147 /* X Keysym value */
5148 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5149 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5150 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5151 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5152 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5153 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5154 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5155 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5156 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5157 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5158 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5159 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5160 "kana-i", "kana-u", "kana-e", "kana-o",
5161 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5162 "prolongedsound", "kana-A", "kana-I", "kana-U",
5163 "kana-E", "kana-O", "kana-KA", "kana-KI",
5164 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5165 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5166 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5167 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5168 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5169 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5170 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5171 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5172 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5173 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5174 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5175 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5177 #endif /* XK_kana_A */
5180 #define FUNCTION_KEY_OFFSET 0xff00
5182 /* You'll notice that this table is arranged to be conveniently
5183 indexed by X Windows keysym values. */
5184 static char *lispy_function_keys
[] =
5186 /* X Keysym value */
5188 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5189 "backspace", "tab", "linefeed", "clear",
5191 0, 0, 0, "pause", /* 0xff10...1f */
5192 0, 0, 0, 0, 0, 0, 0, "escape",
5194 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5195 "romaji", "hiragana", "katakana", "hiragana-katakana",
5196 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5197 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5198 "eisu-toggle", /* 0xff30...3f */
5199 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5200 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5202 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5203 "down", "prior", "next", "end",
5204 "begin", 0, 0, 0, 0, 0, 0, 0,
5205 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5216 "break", /* 0xff6b */
5219 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5220 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5221 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5222 0, 0, 0, 0, 0, 0, 0, 0,
5223 "kp-tab", /* 0xff89 */
5225 "kp-enter", /* 0xff8d */
5227 "kp-f1", /* 0xff91 */
5231 "kp-home", /* 0xff95 */
5236 "kp-prior", /* kp-page-up */
5237 "kp-next", /* kp-page-down */
5243 0, 0, 0, 0, 0, 0, 0, 0, 0,
5244 "kp-multiply", /* 0xffaa */
5249 "kp-divide", /* 0xffaf */
5250 "kp-0", /* 0xffb0 */
5251 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5254 "kp-equal", /* 0xffbd */
5255 "f1", /* 0xffbe */ /* IsFunctionKey */
5257 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5258 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5259 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5260 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5261 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5262 0, 0, 0, 0, 0, 0, 0, 0,
5263 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5264 0, 0, 0, 0, 0, 0, 0, "delete"
5267 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5268 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5270 static char *iso_lispy_function_keys
[] =
5272 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5273 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5274 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5275 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5276 "iso-lefttab", /* 0xfe20 */
5277 "iso-move-line-up", "iso-move-line-down",
5278 "iso-partial-line-up", "iso-partial-line-down",
5279 "iso-partial-space-left", "iso-partial-space-right",
5280 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5281 "iso-release-margin-left", "iso-release-margin-right",
5282 "iso-release-both-margins",
5283 "iso-fast-cursor-left", "iso-fast-cursor-right",
5284 "iso-fast-cursor-up", "iso-fast-cursor-down",
5285 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5286 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5289 #endif /* not HAVE_NTGUI */
5291 Lisp_Object Vlispy_mouse_stem
;
5293 static char *lispy_wheel_names
[] =
5295 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5298 /* drag-n-drop events are generated when a set of selected files are
5299 dragged from another application and dropped onto an Emacs window. */
5300 static char *lispy_drag_n_drop_names
[] =
5305 /* Scroll bar parts. */
5306 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5307 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5308 Lisp_Object Qtop
, Qratio
;
5310 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5311 Lisp_Object
*scroll_bar_parts
[] = {
5312 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5313 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5316 /* A vector, indexed by button number, giving the down-going location
5317 of currently depressed buttons, both scroll bar and non-scroll bar.
5319 The elements have the form
5320 (BUTTON-NUMBER MODIFIER-MASK . REST)
5321 where REST is the cdr of a position as it would be reported in the event.
5323 The make_lispy_event function stores positions here to tell the
5324 difference between click and drag events, and to store the starting
5325 location to be included in drag events. */
5327 static Lisp_Object button_down_location
;
5329 /* Information about the most recent up-going button event: Which
5330 button, what location, and what time. */
5332 static int last_mouse_button
;
5333 static int last_mouse_x
;
5334 static int last_mouse_y
;
5335 static unsigned long button_down_time
;
5337 /* The maximum time between clicks to make a double-click, or Qnil to
5338 disable double-click detection, or Qt for no time limit. */
5340 Lisp_Object Vdouble_click_time
;
5342 /* Maximum number of pixels the mouse may be moved between clicks
5343 to make a double-click. */
5345 EMACS_INT double_click_fuzz
;
5347 /* The number of clicks in this multiple-click. */
5349 int double_click_count
;
5351 /* Return position of a mouse click or wheel event */
5354 make_lispy_position (f
, x
, y
, time
)
5360 enum window_part part
;
5361 Lisp_Object posn
= Qnil
;
5362 Lisp_Object extra_info
= Qnil
;
5365 /* Set `window' to the window under frame pixel coordinates (x,y) */
5367 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5368 &part
, &wx
, &wy
, 0);
5372 if (WINDOWP (window
))
5374 /* It's a click in window window at frame coordinates (x,y) */
5375 struct window
*w
= XWINDOW (window
);
5376 Lisp_Object string_info
= Qnil
;
5377 int textpos
= -1, rx
= -1, ry
= -1;
5378 int dx
= -1, dy
= -1;
5379 int width
= -1, height
= -1;
5380 Lisp_Object object
= Qnil
;
5382 /* Set event coordinates to window-relative coordinates
5383 for constructing the Lisp event below. */
5387 if (part
== ON_TEXT
)
5389 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5391 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5393 /* Mode line or header line. Look for a string under
5394 the mouse that may have a `local-map' property. */
5398 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5400 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5401 &object
, &dx
, &dy
, &width
, &height
);
5402 if (STRINGP (string
))
5403 string_info
= Fcons (string
, make_number (charpos
));
5404 if (w
== XWINDOW (selected_window
))
5407 textpos
= XMARKER (w
->pointm
)->charpos
;
5409 else if (part
== ON_VERTICAL_BORDER
)
5411 posn
= Qvertical_line
;
5416 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5421 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5423 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5424 &object
, &dx
, &dy
, &width
, &height
);
5425 if (STRINGP (string
))
5426 string_info
= Fcons (string
, make_number (charpos
));
5427 if (part
== ON_LEFT_MARGIN
)
5430 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5432 else if (part
== ON_LEFT_FRINGE
)
5434 posn
= Qleft_fringe
;
5437 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5439 : window_box_width (w
, LEFT_MARGIN_AREA
));
5442 else if (part
== ON_RIGHT_FRINGE
)
5444 posn
= Qright_fringe
;
5447 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5448 + window_box_width (w
, TEXT_AREA
)
5449 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5450 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5456 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5457 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5462 Lisp_Object string2
, object2
= Qnil
;
5463 struct display_pos p
;
5465 int width2
, height2
;
5466 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5467 &object2
, &dx2
, &dy2
,
5469 textpos
= CHARPOS (p
.pos
);
5470 if (rx
< 0) rx
= wx
;
5471 if (ry
< 0) ry
= wy
;
5472 if (dx
< 0) dx
= dx2
;
5473 if (dy
< 0) dy
= dy2
;
5474 if (width
< 0) width
= width2
;
5475 if (height
< 0) height
= height2
;
5479 posn
= make_number (textpos
);
5480 if (STRINGP (string2
))
5481 string_info
= Fcons (string2
,
5482 make_number (CHARPOS (p
.string_pos
)));
5488 #ifdef HAVE_WINDOW_SYSTEM
5489 if (IMAGEP (object
))
5491 Lisp_Object image_map
, hotspot
;
5492 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5494 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5496 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5497 posn
= XCAR (hotspot
);
5502 extra_info
= Fcons (object
,
5503 Fcons (Fcons (make_number (dx
),
5505 Fcons (Fcons (make_number (width
),
5506 make_number (height
)),
5510 extra_info
= Fcons (string_info
,
5511 Fcons (make_number (textpos
),
5512 Fcons (Fcons (make_number (rx
),
5518 XSETFRAME (window
, f
);
5523 XSETFASTINT (*x
, 0);
5524 XSETFASTINT (*y
, 0);
5527 return Fcons (window
,
5529 Fcons (Fcons (*x
, *y
),
5530 Fcons (make_number (time
),
5534 /* Given a struct input_event, build the lisp event which represents
5535 it. If EVENT is 0, build a mouse movement event from the mouse
5536 movement buffer, which should have a movement event in it.
5538 Note that events must be passed to this function in the order they
5539 are received; this function stores the location of button presses
5540 in order to build drag events when the button is released. */
5543 make_lispy_event (event
)
5544 struct input_event
*event
;
5548 switch (SWITCH_ENUM_CAST (event
->kind
))
5550 /* A simple keystroke. */
5551 case ASCII_KEYSTROKE_EVENT
:
5553 Lisp_Object lispy_c
;
5554 int c
= event
->code
& 0377;
5555 /* Turn ASCII characters into control characters
5557 if (event
->modifiers
& ctrl_modifier
)
5558 c
= make_ctrl_char (c
);
5560 /* Add in the other modifier bits. We took care of ctrl_modifier
5561 just above, and the shift key was taken care of by the X code,
5562 and applied to control characters by make_ctrl_char. */
5563 c
|= (event
->modifiers
5564 & (meta_modifier
| alt_modifier
5565 | hyper_modifier
| super_modifier
));
5566 /* Distinguish Shift-SPC from SPC. */
5567 if ((event
->code
& 0377) == 040
5568 && event
->modifiers
& shift_modifier
)
5569 c
|= shift_modifier
;
5570 button_down_time
= 0;
5571 XSETFASTINT (lispy_c
, c
);
5575 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5577 Lisp_Object lispy_c
;
5578 int c
= event
->code
;
5580 /* Add in the other modifier bits. We took care of ctrl_modifier
5581 just above, and the shift key was taken care of by the X code,
5582 and applied to control characters by make_ctrl_char. */
5583 c
|= (event
->modifiers
5584 & (meta_modifier
| alt_modifier
5585 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5586 /* What about the `shift' modifier ? */
5587 button_down_time
= 0;
5588 XSETFASTINT (lispy_c
, c
);
5592 /* A function key. The symbol may need to have modifier prefixes
5594 case NON_ASCII_KEYSTROKE_EVENT
:
5595 button_down_time
= 0;
5597 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5598 if (event
->code
== lispy_accent_codes
[i
])
5599 return modify_event_symbol (i
,
5601 Qfunction_key
, Qnil
,
5602 lispy_accent_keys
, &accent_key_syms
,
5603 (sizeof (lispy_accent_keys
)
5604 / sizeof (lispy_accent_keys
[0])));
5608 if (event
->code
>= 0x400 && event
->code
< 0x500)
5609 return modify_event_symbol (event
->code
- 0x400,
5610 event
->modifiers
& ~shift_modifier
,
5611 Qfunction_key
, Qnil
,
5612 lispy_kana_keys
, &func_key_syms
,
5613 (sizeof (lispy_kana_keys
)
5614 / sizeof (lispy_kana_keys
[0])));
5615 #endif /* XK_kana_A */
5618 #ifdef ISO_FUNCTION_KEY_OFFSET
5619 if (event
->code
< FUNCTION_KEY_OFFSET
5620 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5621 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5623 Qfunction_key
, Qnil
,
5624 iso_lispy_function_keys
, &func_key_syms
,
5625 (sizeof (iso_lispy_function_keys
)
5626 / sizeof (iso_lispy_function_keys
[0])));
5629 /* Handle system-specific or unknown keysyms. */
5630 if (event
->code
& (1 << 28)
5631 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5632 || (event
->code
- FUNCTION_KEY_OFFSET
5633 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5634 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5636 /* We need to use an alist rather than a vector as the cache
5637 since we can't make a vector long enuf. */
5638 if (NILP (current_kboard
->system_key_syms
))
5639 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5640 return modify_event_symbol (event
->code
,
5643 current_kboard
->Vsystem_key_alist
,
5644 0, ¤t_kboard
->system_key_syms
,
5648 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5650 Qfunction_key
, Qnil
,
5651 lispy_function_keys
, &func_key_syms
,
5652 (sizeof (lispy_function_keys
)
5653 / sizeof (lispy_function_keys
[0])));
5656 case MULTIMEDIA_KEY_EVENT
:
5657 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5658 / sizeof (lispy_multimedia_keys
[0]))
5659 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5661 return modify_event_symbol (event
->code
, event
->modifiers
,
5662 Qfunction_key
, Qnil
,
5663 lispy_multimedia_keys
, &func_key_syms
,
5664 (sizeof (lispy_multimedia_keys
)
5665 / sizeof (lispy_multimedia_keys
[0])));
5671 /* A mouse click. Figure out where it is, decide whether it's
5672 a press, click or drag, and build the appropriate structure. */
5673 case MOUSE_CLICK_EVENT
:
5674 #ifndef USE_TOOLKIT_SCROLL_BARS
5675 case SCROLL_BAR_CLICK_EVENT
:
5678 int button
= event
->code
;
5680 Lisp_Object position
;
5681 Lisp_Object
*start_pos_ptr
;
5682 Lisp_Object start_pos
;
5686 /* Build the position as appropriate for this mouse click. */
5687 if (event
->kind
== MOUSE_CLICK_EVENT
)
5689 struct frame
*f
= XFRAME (event
->frame_or_window
);
5690 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5694 /* Ignore mouse events that were made on frame that
5695 have been deleted. */
5696 if (! FRAME_LIVE_P (f
))
5699 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5700 /* EVENT->x and EVENT->y are frame-relative pixel
5701 coordinates at this place. Under old redisplay, COLUMN
5702 and ROW are set to frame relative glyph coordinates
5703 which are then used to determine whether this click is
5704 in a menu (non-toolkit version). */
5705 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5706 &column
, &row
, NULL
, 1);
5708 /* In the non-toolkit version, clicks on the menu bar
5709 are ordinary button events in the event buffer.
5710 Distinguish them, and invoke the menu.
5712 (In the toolkit version, the toolkit handles the menu bar
5713 and Emacs doesn't know about it until after the user
5714 makes a selection.) */
5715 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5716 && (event
->modifiers
& down_modifier
))
5718 Lisp_Object items
, item
;
5723 /* Activate the menu bar on the down event. If the
5724 up event comes in before the menu code can deal with it,
5726 if (! (event
->modifiers
& down_modifier
))
5730 /* Find the menu bar item under `column'. */
5732 items
= FRAME_MENU_BAR_ITEMS (f
);
5733 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5735 Lisp_Object pos
, string
;
5736 string
= AREF (items
, i
+ 1);
5737 pos
= AREF (items
, i
+ 3);
5740 if (column
>= XINT (pos
)
5741 && column
< XINT (pos
) + SCHARS (string
))
5743 item
= AREF (items
, i
);
5748 /* ELisp manual 2.4b says (x y) are window relative but
5749 code says they are frame-relative. */
5751 = Fcons (event
->frame_or_window
,
5753 Fcons (Fcons (event
->x
, event
->y
),
5754 Fcons (make_number (event
->timestamp
),
5757 return Fcons (item
, Fcons (position
, Qnil
));
5759 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5761 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5764 #ifndef USE_TOOLKIT_SCROLL_BARS
5767 /* It's a scrollbar click. */
5769 Lisp_Object portion_whole
;
5772 window
= event
->frame_or_window
;
5773 portion_whole
= Fcons (event
->x
, event
->y
);
5774 part
= *scroll_bar_parts
[(int) event
->part
];
5778 Fcons (Qvertical_scroll_bar
,
5779 Fcons (portion_whole
,
5780 Fcons (make_number (event
->timestamp
),
5781 Fcons (part
, Qnil
)))));
5783 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5785 if (button
>= ASIZE (button_down_location
))
5787 button_down_location
= larger_vector (button_down_location
,
5789 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5792 start_pos_ptr
= &AREF (button_down_location
, button
);
5793 start_pos
= *start_pos_ptr
;
5794 *start_pos_ptr
= Qnil
;
5797 /* On window-system frames, use the value of
5798 double-click-fuzz as is. On other frames, interpret it
5799 as a multiple of 1/8 characters. */
5803 if (WINDOWP (event
->frame_or_window
))
5804 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5805 else if (FRAMEP (event
->frame_or_window
))
5806 f
= XFRAME (event
->frame_or_window
);
5810 if (FRAME_WINDOW_P (f
))
5811 fuzz
= double_click_fuzz
;
5813 fuzz
= double_click_fuzz
/ 8;
5815 is_double
= (button
== last_mouse_button
5816 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5817 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5818 && button_down_time
!= 0
5819 && (EQ (Vdouble_click_time
, Qt
)
5820 || (INTEGERP (Vdouble_click_time
)
5821 && ((int)(event
->timestamp
- button_down_time
)
5822 < XINT (Vdouble_click_time
)))));
5825 last_mouse_button
= button
;
5826 last_mouse_x
= XINT (event
->x
);
5827 last_mouse_y
= XINT (event
->y
);
5829 /* If this is a button press, squirrel away the location, so
5830 we can decide later whether it was a click or a drag. */
5831 if (event
->modifiers
& down_modifier
)
5835 double_click_count
++;
5836 event
->modifiers
|= ((double_click_count
> 2)
5841 double_click_count
= 1;
5842 button_down_time
= event
->timestamp
;
5843 *start_pos_ptr
= Fcopy_alist (position
);
5844 ignore_mouse_drag_p
= 0;
5847 /* Now we're releasing a button - check the co-ordinates to
5848 see if this was a click or a drag. */
5849 else if (event
->modifiers
& up_modifier
)
5851 /* If we did not see a down before this up, ignore the up.
5852 Probably this happened because the down event chose a
5853 menu item. It would be an annoyance to treat the
5854 release of the button that chose the menu item as a
5857 if (!CONSP (start_pos
))
5860 event
->modifiers
&= ~up_modifier
;
5861 #if 0 /* Formerly we treated an up with no down as a click event. */
5862 if (!CONSP (start_pos
))
5863 event
->modifiers
|= click_modifier
;
5868 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5870 /* The third element of every position
5871 should be the (x,y) pair. */
5872 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5874 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5876 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5877 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5880 if (ignore_mouse_drag_p
)
5882 event
->modifiers
|= click_modifier
;
5883 ignore_mouse_drag_p
= 0;
5885 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5886 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5887 /* Maybe the mouse has moved a lot, caused scrolling, and
5888 eventually ended up at the same screen position (but
5889 not buffer position) in which case it is a drag, not
5891 /* FIXME: OTOH if the buffer position has changed
5892 because of a timer or process filter rather than
5893 because of mouse movement, it should be considered as
5894 a click. But mouse-drag-region completely ignores
5895 this case and it hasn't caused any real problem, so
5896 it's probably OK to ignore it as well. */
5897 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5898 /* Mouse hasn't moved (much). */
5899 event
->modifiers
|= click_modifier
;
5902 button_down_time
= 0;
5903 event
->modifiers
|= drag_modifier
;
5906 /* Don't check is_double; treat this as multiple
5907 if the down-event was multiple. */
5908 if (double_click_count
> 1)
5909 event
->modifiers
|= ((double_click_count
> 2)
5915 /* Every mouse event should either have the down_modifier or
5916 the up_modifier set. */
5920 /* Get the symbol we should use for the mouse click. */
5923 head
= modify_event_symbol (button
,
5925 Qmouse_click
, Vlispy_mouse_stem
,
5928 XVECTOR (mouse_syms
)->size
);
5929 if (event
->modifiers
& drag_modifier
)
5934 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5937 Fcons (make_number (double_click_count
),
5947 case HORIZ_WHEEL_EVENT
:
5949 Lisp_Object position
;
5952 /* Build the position as appropriate for this mouse click. */
5953 struct frame
*f
= XFRAME (event
->frame_or_window
);
5955 /* Ignore wheel events that were made on frame that have been
5957 if (! FRAME_LIVE_P (f
))
5960 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5963 /* Set double or triple modifiers to indicate the wheel speed. */
5965 /* On window-system frames, use the value of
5966 double-click-fuzz as is. On other frames, interpret it
5967 as a multiple of 1/8 characters. */
5972 if (WINDOWP (event
->frame_or_window
))
5973 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5974 else if (FRAMEP (event
->frame_or_window
))
5975 f
= XFRAME (event
->frame_or_window
);
5979 if (FRAME_WINDOW_P (f
))
5980 fuzz
= double_click_fuzz
;
5982 fuzz
= double_click_fuzz
/ 8;
5984 is_double
= (last_mouse_button
< 0
5985 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5986 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5987 && button_down_time
!= 0
5988 && (EQ (Vdouble_click_time
, Qt
)
5989 || (INTEGERP (Vdouble_click_time
)
5990 && ((int)(event
->timestamp
- button_down_time
)
5991 < XINT (Vdouble_click_time
)))));
5994 double_click_count
++;
5995 event
->modifiers
|= ((double_click_count
> 2)
6001 double_click_count
= 1;
6002 event
->modifiers
|= click_modifier
;
6005 button_down_time
= event
->timestamp
;
6006 /* Use a negative value to distinguish wheel from mouse button. */
6007 last_mouse_button
= -1;
6008 last_mouse_x
= XINT (event
->x
);
6009 last_mouse_y
= XINT (event
->y
);
6015 if (event
->modifiers
& up_modifier
)
6017 /* Emit a wheel-up event. */
6018 event
->modifiers
&= ~up_modifier
;
6021 else if (event
->modifiers
& down_modifier
)
6023 /* Emit a wheel-down event. */
6024 event
->modifiers
&= ~down_modifier
;
6028 /* Every wheel event should either have the down_modifier or
6029 the up_modifier set. */
6032 if (event
->kind
== HORIZ_WHEEL_EVENT
)
6035 /* Get the symbol we should use for the wheel event. */
6036 head
= modify_event_symbol (symbol_num
,
6042 ASIZE (wheel_syms
));
6045 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6048 Fcons (make_number (double_click_count
),
6057 #ifdef USE_TOOLKIT_SCROLL_BARS
6059 /* We don't have down and up events if using toolkit scroll bars,
6060 so make this always a click event. Store in the `part' of
6061 the Lisp event a symbol which maps to the following actions:
6063 `above_handle' page up
6064 `below_handle' page down
6068 `bottom' bottom of buffer
6069 `handle' thumb has been dragged.
6070 `end-scroll' end of interaction with scroll bar
6072 The incoming input_event contains in its `part' member an
6073 index of type `enum scroll_bar_part' which we can use as an
6074 index in scroll_bar_parts to get the appropriate symbol. */
6076 case SCROLL_BAR_CLICK_EVENT
:
6078 Lisp_Object position
, head
, window
, portion_whole
, part
;
6080 window
= event
->frame_or_window
;
6081 portion_whole
= Fcons (event
->x
, event
->y
);
6082 part
= *scroll_bar_parts
[(int) event
->part
];
6086 Fcons (Qvertical_scroll_bar
,
6087 Fcons (portion_whole
,
6088 Fcons (make_number (event
->timestamp
),
6089 Fcons (part
, Qnil
)))));
6091 /* Always treat scroll bar events as clicks. */
6092 event
->modifiers
|= click_modifier
;
6093 event
->modifiers
&= ~up_modifier
;
6095 if (event
->code
>= ASIZE (mouse_syms
))
6096 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6098 /* Get the symbol we should use for the mouse click. */
6099 head
= modify_event_symbol (event
->code
,
6104 XVECTOR (mouse_syms
)->size
);
6105 return Fcons (head
, Fcons (position
, Qnil
));
6108 #endif /* USE_TOOLKIT_SCROLL_BARS */
6110 case DRAG_N_DROP_EVENT
:
6113 Lisp_Object head
, position
;
6116 f
= XFRAME (event
->frame_or_window
);
6119 /* Ignore mouse events that were made on frames that
6120 have been deleted. */
6121 if (! FRAME_LIVE_P (f
))
6124 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6127 head
= modify_event_symbol (0, event
->modifiers
,
6129 lispy_drag_n_drop_names
,
6130 &drag_n_drop_syms
, 1);
6136 #endif /* HAVE_MOUSE */
6138 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
6139 || defined (USE_GTK)
6140 case MENU_BAR_EVENT
:
6141 if (EQ (event
->arg
, event
->frame_or_window
))
6142 /* This is the prefix key. We translate this to
6143 `(menu_bar)' because the code in keyboard.c for menu
6144 events, which we use, relies on this. */
6145 return Fcons (Qmenu_bar
, Qnil
);
6149 case SELECT_WINDOW_EVENT
:
6150 /* Make an event (select-window (WINDOW)). */
6151 return Fcons (Qselect_window
,
6152 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6155 case TOOL_BAR_EVENT
:
6156 if (EQ (event
->arg
, event
->frame_or_window
))
6157 /* This is the prefix key. We translate this to
6158 `(tool_bar)' because the code in keyboard.c for tool bar
6159 events, which we use, relies on this. */
6160 return Fcons (Qtool_bar
, Qnil
);
6161 else if (SYMBOLP (event
->arg
))
6162 return apply_modifiers (event
->modifiers
, event
->arg
);
6165 case USER_SIGNAL_EVENT
:
6166 /* A user signal. */
6168 char *name
= find_user_signal_name (event
->code
);
6171 return intern (name
);
6174 case SAVE_SESSION_EVENT
:
6175 return Qsave_session
;
6178 case MAC_APPLE_EVENT
:
6180 Lisp_Object spec
[2];
6184 return Fcons (Qmac_apple_event
,
6185 Fcons (Fvector (2, spec
),
6186 Fcons (event
->arg
, Qnil
)));
6191 case GPM_CLICK_EVENT
:
6193 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6194 Lisp_Object head
, position
;
6195 Lisp_Object
*start_pos_ptr
;
6196 Lisp_Object start_pos
;
6197 int button
= event
->code
;
6199 if (button
>= ASIZE (button_down_location
))
6201 button_down_location
= larger_vector (button_down_location
,
6203 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6206 start_pos_ptr
= &AREF (button_down_location
, button
);
6207 start_pos
= *start_pos_ptr
;
6209 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6212 if (event
->modifiers
& down_modifier
)
6213 *start_pos_ptr
= Fcopy_alist (position
);
6214 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6216 if (!CONSP (start_pos
))
6218 event
->modifiers
&= ~up_modifier
;
6221 head
= modify_event_symbol (button
,
6223 Qmouse_click
, Vlispy_mouse_stem
,
6226 XVECTOR (mouse_syms
)->size
);
6228 if (event
->modifiers
& drag_modifier
)
6233 else if (event
->modifiers
& double_modifier
)
6236 Fcons (make_number (2),
6238 else if (event
->modifiers
& triple_modifier
)
6241 Fcons (make_number (3),
6248 #endif /* HAVE_GPM */
6250 /* The 'kind' field of the event is something we don't recognize. */
6256 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6259 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6261 Lisp_Object bar_window
;
6262 enum scroll_bar_part part
;
6266 /* Is it a scroll bar movement? */
6267 if (frame
&& ! NILP (bar_window
))
6269 Lisp_Object part_sym
;
6271 part_sym
= *scroll_bar_parts
[(int) part
];
6272 return Fcons (Qscroll_bar_movement
,
6273 (Fcons (Fcons (bar_window
,
6274 Fcons (Qvertical_scroll_bar
,
6275 Fcons (Fcons (x
, y
),
6276 Fcons (make_number (time
),
6282 /* Or is it an ordinary mouse movement? */
6285 Lisp_Object position
;
6287 position
= make_lispy_position (frame
, &x
, &y
, time
);
6289 return Fcons (Qmouse_movement
,
6295 #endif /* HAVE_MOUSE || HAVE GPM */
6297 /* Construct a switch frame event. */
6299 make_lispy_switch_frame (frame
)
6302 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6305 /* Manipulating modifiers. */
6307 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6309 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6310 SYMBOL's name of the end of the modifiers; the string from this
6311 position is the unmodified symbol name.
6313 This doesn't use any caches. */
6316 parse_modifiers_uncached (symbol
, modifier_end
)
6324 CHECK_SYMBOL (symbol
);
6327 name
= SYMBOL_NAME (symbol
);
6329 for (i
= 0; i
+2 <= SBYTES (name
); )
6331 int this_mod_end
= 0;
6334 /* See if the name continues with a modifier word.
6335 Check that the word appears, but don't check what follows it.
6336 Set this_mod and this_mod_end to record what we find. */
6338 switch (SREF (name
, i
))
6340 #define SINGLE_LETTER_MOD(BIT) \
6341 (this_mod_end = i + 1, this_mod = BIT)
6344 SINGLE_LETTER_MOD (alt_modifier
);
6348 SINGLE_LETTER_MOD (ctrl_modifier
);
6352 SINGLE_LETTER_MOD (hyper_modifier
);
6356 SINGLE_LETTER_MOD (meta_modifier
);
6360 SINGLE_LETTER_MOD (shift_modifier
);
6364 SINGLE_LETTER_MOD (super_modifier
);
6367 #undef SINGLE_LETTER_MOD
6369 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6370 if (i + LEN + 1 <= SBYTES (name) \
6371 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6373 this_mod_end = i + LEN; \
6378 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6379 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6380 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6384 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6386 #undef MULTI_LETTER_MOD
6390 /* If we found no modifier, stop looking for them. */
6391 if (this_mod_end
== 0)
6394 /* Check there is a dash after the modifier, so that it
6395 really is a modifier. */
6396 if (this_mod_end
>= SBYTES (name
)
6397 || SREF (name
, this_mod_end
) != '-')
6400 /* This modifier is real; look for another. */
6401 modifiers
|= this_mod
;
6402 i
= this_mod_end
+ 1;
6405 /* Should we include the `click' modifier? */
6406 if (! (modifiers
& (down_modifier
| drag_modifier
6407 | double_modifier
| triple_modifier
))
6408 && i
+ 7 == SBYTES (name
)
6409 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6410 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6411 modifiers
|= click_modifier
;
6419 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6420 prepended to the string BASE[0..BASE_LEN-1].
6421 This doesn't use any caches. */
6423 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6426 int base_len
, base_len_byte
;
6428 /* Since BASE could contain nulls, we can't use intern here; we have
6429 to use Fintern, which expects a genuine Lisp_String, and keeps a
6432 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6438 /* Only the event queue may use the `up' modifier; it should always
6439 be turned into a click or drag event before presented to lisp code. */
6440 if (modifiers
& up_modifier
)
6443 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6444 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6445 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6446 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6447 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6448 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6449 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6450 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6451 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6452 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6453 /* The click modifier is denoted by the absence of other modifiers. */
6457 mod_len
= p
- new_mods
;
6461 Lisp_Object new_name
;
6463 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6464 mod_len
+ base_len_byte
);
6465 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6466 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6468 return Fintern (new_name
, Qnil
);
6473 static char *modifier_names
[] =
6475 "up", "down", "drag", "click", "double", "triple", 0, 0,
6476 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6477 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6479 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6481 static Lisp_Object modifier_symbols
;
6483 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6485 lispy_modifier_list (modifiers
)
6488 Lisp_Object modifier_list
;
6491 modifier_list
= Qnil
;
6492 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6493 if (modifiers
& (1<<i
))
6494 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6497 return modifier_list
;
6501 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6502 where UNMODIFIED is the unmodified form of SYMBOL,
6503 MASK is the set of modifiers present in SYMBOL's name.
6504 This is similar to parse_modifiers_uncached, but uses the cache in
6505 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6506 Qevent_symbol_elements property. */
6509 parse_modifiers (symbol
)
6512 Lisp_Object elements
;
6514 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6515 if (CONSP (elements
))
6520 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6521 Lisp_Object unmodified
;
6524 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6525 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6528 if (modifiers
& ~INTMASK
)
6530 XSETFASTINT (mask
, modifiers
);
6531 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6533 /* Cache the parsing results on SYMBOL. */
6534 Fput (symbol
, Qevent_symbol_element_mask
,
6536 Fput (symbol
, Qevent_symbol_elements
,
6537 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6539 /* Since we know that SYMBOL is modifiers applied to unmodified,
6540 it would be nice to put that in unmodified's cache.
6541 But we can't, since we're not sure that parse_modifiers is
6548 /* Apply the modifiers MODIFIERS to the symbol BASE.
6549 BASE must be unmodified.
6551 This is like apply_modifiers_uncached, but uses BASE's
6552 Qmodifier_cache property, if present. It also builds
6553 Qevent_symbol_elements properties, since it has that info anyway.
6555 apply_modifiers copies the value of BASE's Qevent_kind property to
6556 the modified symbol. */
6558 apply_modifiers (modifiers
, base
)
6562 Lisp_Object cache
, index
, entry
, new_symbol
;
6564 /* Mask out upper bits. We don't know where this value's been. */
6565 modifiers
&= INTMASK
;
6567 /* The click modifier never figures into cache indices. */
6568 cache
= Fget (base
, Qmodifier_cache
);
6569 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6570 entry
= assq_no_quit (index
, cache
);
6573 new_symbol
= XCDR (entry
);
6576 /* We have to create the symbol ourselves. */
6577 new_symbol
= apply_modifiers_uncached (modifiers
,
6578 SDATA (SYMBOL_NAME (base
)),
6579 SCHARS (SYMBOL_NAME (base
)),
6580 SBYTES (SYMBOL_NAME (base
)));
6582 /* Add the new symbol to the base's cache. */
6583 entry
= Fcons (index
, new_symbol
);
6584 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6586 /* We have the parsing info now for free, so we could add it to
6588 XSETFASTINT (index, modifiers);
6589 Fput (new_symbol, Qevent_symbol_element_mask,
6590 Fcons (base, Fcons (index, Qnil)));
6591 Fput (new_symbol, Qevent_symbol_elements,
6592 Fcons (base, lispy_modifier_list (modifiers)));
6593 Sadly, this is only correct if `base' is indeed a base event,
6594 which is not necessarily the case. -stef */
6597 /* Make sure this symbol is of the same kind as BASE.
6599 You'd think we could just set this once and for all when we
6600 intern the symbol above, but reorder_modifiers may call us when
6601 BASE's property isn't set right; we can't assume that just
6602 because it has a Qmodifier_cache property it must have its
6603 Qevent_kind set right as well. */
6604 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6608 kind
= Fget (base
, Qevent_kind
);
6610 Fput (new_symbol
, Qevent_kind
, kind
);
6617 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6618 return a symbol with the modifiers placed in the canonical order.
6619 Canonical order is alphabetical, except for down and drag, which
6620 always come last. The 'click' modifier is never written out.
6622 Fdefine_key calls this to make sure that (for example) C-M-foo
6623 and M-C-foo end up being equivalent in the keymap. */
6626 reorder_modifiers (symbol
)
6629 /* It's hopefully okay to write the code this way, since everything
6630 will soon be in caches, and no consing will be done at all. */
6633 parsed
= parse_modifiers (symbol
);
6634 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6639 /* For handling events, we often want to produce a symbol whose name
6640 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6641 to some base, like the name of a function key or mouse button.
6642 modify_event_symbol produces symbols of this sort.
6644 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6645 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6648 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6649 into symbol names, or a string specifying a name stem used to
6650 construct a symbol name or the form `STEM-N', where N is the decimal
6651 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6652 non-nil; otherwise NAME_TABLE is used.
6654 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6655 persist between calls to modify_event_symbol that it can use to
6656 store a cache of the symbols it's generated for this NAME_TABLE
6657 before. The object stored there may be a vector or an alist.
6659 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6661 MODIFIERS is a set of modifier bits (as given in struct input_events)
6662 whose prefixes should be applied to the symbol name.
6664 SYMBOL_KIND is the value to be placed in the event_kind property of
6665 the returned symbol.
6667 The symbols we create are supposed to have an
6668 `event-symbol-elements' property, which lists the modifiers present
6669 in the symbol's name. */
6672 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6673 name_table
, symbol_table
, table_size
)
6676 Lisp_Object symbol_kind
;
6677 Lisp_Object name_alist_or_stem
;
6679 Lisp_Object
*symbol_table
;
6680 unsigned int table_size
;
6683 Lisp_Object symbol_int
;
6685 /* Get rid of the "vendor-specific" bit here. */
6686 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6688 /* Is this a request for a valid symbol? */
6689 if (symbol_num
< 0 || symbol_num
>= table_size
)
6692 if (CONSP (*symbol_table
))
6693 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6695 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6696 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6697 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6698 we've never used that symbol before. */
6701 if (! VECTORP (*symbol_table
)
6702 || XVECTOR (*symbol_table
)->size
!= table_size
)
6706 XSETFASTINT (size
, table_size
);
6707 *symbol_table
= Fmake_vector (size
, Qnil
);
6710 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6713 /* Have we already used this symbol before? */
6716 /* No; let's create it. */
6717 if (CONSP (name_alist_or_stem
))
6718 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6719 else if (STRINGP (name_alist_or_stem
))
6721 int len
= SBYTES (name_alist_or_stem
);
6722 char *buf
= (char *) alloca (len
+ 50);
6723 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6724 (long) XINT (symbol_int
) + 1);
6725 value
= intern (buf
);
6727 else if (name_table
!= 0 && name_table
[symbol_num
])
6728 value
= intern (name_table
[symbol_num
]);
6730 #ifdef HAVE_WINDOW_SYSTEM
6733 char *name
= x_get_keysym_name (symbol_num
);
6735 value
= intern (name
);
6742 sprintf (buf
, "key-%d", symbol_num
);
6743 value
= intern (buf
);
6746 if (CONSP (*symbol_table
))
6747 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6749 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6751 /* Fill in the cache entries for this symbol; this also
6752 builds the Qevent_symbol_elements property, which the user
6754 apply_modifiers (modifiers
& click_modifier
, value
);
6755 Fput (value
, Qevent_kind
, symbol_kind
);
6758 /* Apply modifiers to that symbol. */
6759 return apply_modifiers (modifiers
, value
);
6762 /* Convert a list that represents an event type,
6763 such as (ctrl meta backspace), into the usual representation of that
6764 event type as a number or a symbol. */
6766 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6767 doc
: /* Convert the event description list EVENT-DESC to an event type.
6768 EVENT-DESC should contain one base event type (a character or symbol)
6769 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6770 drag, down, double or triple). The base must be last.
6771 The return value is an event type (a character or symbol) which
6772 has the same base event type and all the specified modifiers. */)
6774 Lisp_Object event_desc
;
6782 while (CONSP (rest
))
6790 /* Given a symbol, see if it is a modifier name. */
6791 if (SYMBOLP (elt
) && CONSP (rest
))
6792 this = parse_solitary_modifier (elt
);
6796 else if (!NILP (base
))
6797 error ("Two bases given in one event");
6803 /* Let the symbol A refer to the character A. */
6804 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6805 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6807 if (INTEGERP (base
))
6809 /* Turn (shift a) into A. */
6810 if ((modifiers
& shift_modifier
) != 0
6811 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6813 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6814 modifiers
&= ~shift_modifier
;
6817 /* Turn (control a) into C-a. */
6818 if (modifiers
& ctrl_modifier
)
6819 return make_number ((modifiers
& ~ctrl_modifier
)
6820 | make_ctrl_char (XINT (base
)));
6822 return make_number (modifiers
| XINT (base
));
6824 else if (SYMBOLP (base
))
6825 return apply_modifiers (modifiers
, base
);
6828 error ("Invalid base event");
6833 /* Try to recognize SYMBOL as a modifier name.
6834 Return the modifier flag bit, or 0 if not recognized. */
6837 parse_solitary_modifier (symbol
)
6840 Lisp_Object name
= SYMBOL_NAME (symbol
);
6842 switch (SREF (name
, 0))
6844 #define SINGLE_LETTER_MOD(BIT) \
6845 if (SBYTES (name) == 1) \
6848 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6849 if (LEN == SBYTES (name) \
6850 && ! strncmp (SDATA (name), NAME, LEN)) \
6854 SINGLE_LETTER_MOD (alt_modifier
);
6858 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6862 SINGLE_LETTER_MOD (ctrl_modifier
);
6866 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6867 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6871 SINGLE_LETTER_MOD (hyper_modifier
);
6875 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6879 SINGLE_LETTER_MOD (meta_modifier
);
6883 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6887 SINGLE_LETTER_MOD (shift_modifier
);
6891 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6892 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6893 SINGLE_LETTER_MOD (super_modifier
);
6897 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6898 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6899 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6903 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6906 #undef SINGLE_LETTER_MOD
6907 #undef MULTI_LETTER_MOD
6913 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6914 Such a list is not valid as an event,
6915 but it can be a Lucid-style event type list. */
6918 lucid_event_type_list_p (object
)
6923 if (! CONSP (object
))
6926 if (EQ (XCAR (object
), Qhelp_echo
)
6927 || EQ (XCAR (object
), Qvertical_line
)
6928 || EQ (XCAR (object
), Qmode_line
)
6929 || EQ (XCAR (object
), Qheader_line
))
6932 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6936 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6943 /* Store into *addr a value nonzero if terminal input chars are available.
6944 Serves the purpose of ioctl (0, FIONREAD, addr)
6945 but works even if FIONREAD does not exist.
6946 (In fact, this may actually read some input.)
6948 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6949 timer events that are ripe.
6950 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6951 events (FOCUS_IN_EVENT).
6952 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6953 movements and toolkit scroll bar thumb drags. */
6956 get_input_pending (addr
, flags
)
6960 /* First of all, have we already counted some input? */
6961 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6963 /* If input is being read as it arrives, and we have none, there is none. */
6964 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6967 /* Try to read some input and see how much we get. */
6969 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6972 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6975 gobble_input (expected
)
6980 if (interrupt_input
)
6983 mask
= sigblock (sigmask (SIGIO
));
6984 read_avail_input (expected
);
6988 #ifdef POLL_FOR_INPUT
6989 /* XXX This condition was (read_socket_hook && !interrupt_input),
6990 but read_socket_hook is not global anymore. Let's pretend that
6992 if (!interrupt_input
&& poll_suppress_count
== 0)
6995 mask
= sigblock (sigmask (SIGALRM
));
6996 read_avail_input (expected
);
7002 read_avail_input (expected
);
7006 /* Put a BUFFER_SWITCH_EVENT in the buffer
7007 so that read_key_sequence will notice the new current buffer. */
7010 record_asynch_buffer_change ()
7012 struct input_event event
;
7016 event
.kind
= BUFFER_SWITCH_EVENT
;
7017 event
.frame_or_window
= Qnil
;
7021 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7022 The purpose of the event is to make read_key_sequence look up the
7023 keymaps again. If we aren't in read_key_sequence, we don't need one,
7024 and the event could cause trouble by messing up (input-pending-p). */
7025 tem
= Fwaiting_for_user_input_p ();
7029 /* We never need these events if we have no asynchronous subprocesses. */
7033 /* Make sure no interrupt happens while storing the event. */
7035 if (interrupt_input
)
7038 mask
= sigblock (sigmask (SIGIO
));
7039 kbd_buffer_store_event (&event
);
7046 kbd_buffer_store_event (&event
);
7053 /* Read any terminal input already buffered up by the system
7054 into the kbd_buffer, but do not wait.
7056 EXPECTED should be nonzero if the caller knows there is some input.
7058 Except on VMS, all input is read by this function.
7059 If interrupt_input is nonzero, this function MUST be called
7060 only when SIGIO is blocked.
7062 Returns the number of keyboard chars read, or -1 meaning
7063 this is a bad time to try to read input. */
7066 read_avail_input (expected
)
7073 /* Store pending user signal events, if any. */
7074 if (store_user_signal_events ())
7077 /* Loop through the available terminals, and call their input hooks. */
7081 struct terminal
*next
= t
->next_terminal
;
7083 if (t
->read_socket_hook
)
7086 struct input_event hold_quit
;
7088 EVENT_INIT (hold_quit
);
7089 hold_quit
.kind
= NO_EVENT
;
7091 /* No need for FIONREAD or fcntl; just say don't wait. */
7092 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7098 if (nr
== -1) /* Not OK to read input now. */
7102 else if (nr
== -2) /* Non-transient error. */
7104 /* The terminal device terminated; it should be closed. */
7106 /* Kill Emacs if this was our last terminal. */
7107 if (!terminal_list
->next_terminal
)
7108 /* Formerly simply reported no input, but that
7109 sometimes led to a failure of Emacs to terminate.
7110 SIGHUP seems appropriate if we can't reach the
7112 /* ??? Is it really right to send the signal just to
7113 this process rather than to the whole process
7114 group? Perhaps on systems with FIONREAD Emacs is
7115 alone in its group. */
7116 kill (getpid (), SIGHUP
);
7118 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
7119 if (t
->delete_terminal_hook
)
7120 (*t
->delete_terminal_hook
) (t
);
7122 delete_terminal (t
);
7125 if (hold_quit
.kind
!= NO_EVENT
)
7126 kbd_buffer_store_event (&hold_quit
);
7138 /* This is the tty way of reading available input.
7140 Note that each terminal device has its own `struct terminal' object,
7141 and so this function is called once for each individual termcap
7142 terminal. The first parameter indicates which terminal to read from. */
7145 tty_read_avail_input (struct terminal
*terminal
,
7147 struct input_event
*hold_quit
)
7149 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7150 the kbd_buffer can really hold. That may prevent loss
7151 of characters on some systems when input is stuffed at us. */
7152 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7154 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7157 if (!terminal
->name
) /* Don't read from a dead terminal. */
7160 if (terminal
->type
!= output_termcap
)
7163 /* XXX I think the following code should be moved to separate hook
7164 functions in system-dependent files. */
7167 #else /* not WINDOWSNT */
7169 n_to_read
= dos_keysns ();
7173 cbuf
[0] = dos_keyread ();
7176 #else /* not MSDOS */
7178 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7182 return 0; /* The terminal is suspended. */
7188 struct input_event hold_quit
;
7191 EVENT_INIT (hold_quit
);
7192 hold_quit
.kind
= NO_EVENT
;
7194 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7195 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7197 if (hold_quit
.kind
!= NO_EVENT
)
7198 kbd_buffer_store_event (&hold_quit
);
7202 #endif /* HAVE_GPM */
7204 /* Determine how many characters we should *try* to read. */
7206 /* Find out how much input is available. */
7207 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7209 if (! noninteractive
)
7210 return -2; /* Close this terminal. */
7216 if (n_to_read
> sizeof cbuf
)
7217 n_to_read
= sizeof cbuf
;
7218 #else /* no FIONREAD */
7219 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
7220 /* Read some input if available, but don't wait. */
7221 n_to_read
= sizeof cbuf
;
7222 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7228 /* Now read; for one reason or another, this will not block.
7229 NREAD is set to the number of chars read. */
7232 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7233 /* POSIX infers that processes which are not in the session leader's
7234 process group won't get SIGHUP's at logout time. BSDI adheres to
7235 this part standard and returns -1 from read (0) with errno==EIO
7236 when the control tty is taken away.
7237 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7238 if (nread
== -1 && errno
== EIO
)
7239 return -2; /* Close this terminal. */
7240 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
7241 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7242 This looks incorrect, but it isn't, because _BSD causes
7243 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7244 and that causes a value other than 0 when there is no input. */
7246 return -2; /* Close this terminal. */
7250 /* We used to retry the read if it was interrupted.
7251 But this does the wrong thing when O_NDELAY causes
7252 an EAGAIN error. Does anybody know of a situation
7253 where a retry is actually needed? */
7255 nread
< 0 && (errno
== EAGAIN
7269 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
7270 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7271 #endif /* USG or DGUX or CYGWIN */
7272 #endif /* no FIONREAD */
7277 #endif /* not MSDOS */
7278 #endif /* not WINDOWSNT */
7280 for (i
= 0; i
< nread
; i
++)
7282 struct input_event buf
;
7284 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7286 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7287 buf
.modifiers
= meta_modifier
;
7288 if (tty
->meta_key
!= 2)
7292 /* Set the frame corresponding to the active tty. Note that the
7293 value of selected_frame is not reliable here, redisplay tends
7294 to temporarily change it. */
7295 buf
.frame_or_window
= tty
->top_frame
;
7298 kbd_buffer_store_event (&buf
);
7299 /* Don't look at input that follows a C-g too closely.
7300 This reduces lossage due to autorepeat on C-g. */
7301 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7302 && buf
.code
== quit_char
)
7308 #endif /* not VMS */
7311 handle_async_input ()
7314 extern int select_alarmed
;
7317 interrupt_input_pending
= 0;
7322 nread
= read_avail_input (1);
7323 /* -1 means it's not ok to read the input now.
7324 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7325 0 means there was no keyboard input available. */
7330 select_alarmed
= 1; /* Force the select emulator back to life */
7335 #ifdef SIGIO /* for entire page */
7336 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7339 input_available_signal (signo
)
7342 /* Must preserve main program's value of errno. */
7343 int old_errno
= errno
;
7344 #if defined (USG) && !defined (POSIX_SIGNALS)
7345 /* USG systems forget handlers when they are used;
7346 must reestablish each time */
7347 signal (signo
, input_available_signal
);
7355 interrupt_input_pending
= 1;
7357 SIGNAL_THREAD_CHECK (signo
);
7360 if (input_available_clear_time
)
7361 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7364 handle_async_input ();
7374 /* Send ourselves a SIGIO.
7376 This function exists so that the UNBLOCK_INPUT macro in
7377 blockinput.h can have some way to take care of input we put off
7378 dealing with, without assuming that every file which uses
7379 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7381 reinvoke_input_signal ()
7384 handle_async_input ();
7390 /* User signal events. */
7392 struct user_signal_info
7394 /* Signal number. */
7397 /* Name of the signal. */
7400 /* Number of pending signals. */
7403 struct user_signal_info
*next
;
7406 /* List of user signals. */
7407 static struct user_signal_info
*user_signals
= NULL
;
7410 add_user_signal (sig
, name
)
7414 struct user_signal_info
*p
;
7416 for (p
= user_signals
; p
; p
= p
->next
)
7418 /* Already added. */
7421 p
= xmalloc (sizeof (struct user_signal_info
));
7423 p
->name
= xstrdup (name
);
7425 p
->next
= user_signals
;
7428 signal (sig
, handle_user_signal
);
7432 handle_user_signal (sig
)
7435 int old_errno
= errno
;
7436 struct user_signal_info
*p
;
7438 #if defined (USG) && !defined (POSIX_SIGNALS)
7439 /* USG systems forget handlers when they are used;
7440 must reestablish each time */
7441 signal (sig
, handle_user_signal
);
7444 SIGNAL_THREAD_CHECK (sig
);
7446 for (p
= user_signals
; p
; p
= p
->next
)
7451 if (interrupt_input
)
7452 kill (getpid (), SIGIO
);
7456 /* Tell wait_reading_process_output that it needs to wake
7457 up and look around. */
7458 if (input_available_clear_time
)
7459 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7468 find_user_signal_name (sig
)
7471 struct user_signal_info
*p
;
7473 for (p
= user_signals
; p
; p
= p
->next
)
7481 store_user_signal_events ()
7483 struct user_signal_info
*p
;
7484 struct input_event buf
;
7487 for (p
= user_signals
; p
; p
= p
->next
)
7488 if (p
->npending
> 0)
7494 bzero (&buf
, sizeof buf
);
7495 buf
.kind
= USER_SIGNAL_EVENT
;
7496 buf
.frame_or_window
= selected_frame
;
7498 nstored
+= p
->npending
;
7500 mask
= sigblock (sigmask (p
->sig
));
7504 kbd_buffer_store_event (&buf
);
7507 while (p
->npending
> 0);
7515 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7516 static Lisp_Object menu_bar_one_keymap_changed_items
;
7518 /* These variables hold the vector under construction within
7519 menu_bar_items and its subroutines, and the current index
7520 for storing into that vector. */
7521 static Lisp_Object menu_bar_items_vector
;
7522 static int menu_bar_items_index
;
7524 /* Return a vector of menu items for a menu bar, appropriate
7525 to the current buffer. Each item has three elements in the vector:
7528 OLD is an old vector we can optionally reuse, or nil. */
7531 menu_bar_items (old
)
7534 /* The number of keymaps we're scanning right now, and the number of
7535 keymaps we have allocated space for. */
7538 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7539 in the current keymaps, or nil where it is not a prefix. */
7542 Lisp_Object def
, tail
;
7551 /* In order to build the menus, we need to call the keymap
7552 accessors. They all call QUIT. But this function is called
7553 during redisplay, during which a quit is fatal. So inhibit
7554 quitting while building the menus.
7555 We do this instead of specbind because (1) errors will clear it anyway
7556 and (2) this avoids risk of specpdl overflow. */
7557 oquit
= Vinhibit_quit
;
7561 menu_bar_items_vector
= old
;
7563 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7564 menu_bar_items_index
= 0;
7566 /* Build our list of keymaps.
7567 If we recognize a function key and replace its escape sequence in
7568 keybuf with its symbol, or if the sequence starts with a mouse
7569 click and we need to switch buffers, we jump back here to rebuild
7570 the initial keymaps from the current buffer. */
7574 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7575 if (!NILP (Voverriding_local_map_menu_flag
))
7577 /* Yes, use them (if non-nil) as well as the global map. */
7578 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7580 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7581 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7582 if (!NILP (Voverriding_local_map
))
7583 maps
[nmaps
++] = Voverriding_local_map
;
7587 /* No, so use major and minor mode keymaps and keymap property.
7588 Note that menu-bar bindings in the local-map and keymap
7589 properties may not work reliable, as they are only
7590 recognized when the menu-bar (or mode-line) is updated,
7591 which does not normally happen after every command. */
7594 nminor
= current_minor_maps (NULL
, &tmaps
);
7595 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7597 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7598 maps
[nmaps
++] = tem
;
7599 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7601 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7603 maps
[nmaps
++] = current_global_map
;
7606 /* Look up in each map the dummy prefix key `menu-bar'. */
7610 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7611 if (!NILP (maps
[mapno
]))
7613 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7617 menu_bar_one_keymap_changed_items
= Qnil
;
7618 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7622 /* Move to the end those items that should be at the end. */
7624 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7627 int end
= menu_bar_items_index
;
7629 for (i
= 0; i
< end
; i
+= 4)
7630 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7632 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7633 /* Move the item at index I to the end,
7634 shifting all the others forward. */
7635 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7636 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7637 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7638 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7640 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7641 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7642 (end
- i
- 4) * sizeof (Lisp_Object
));
7643 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7644 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7645 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7646 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7651 /* Add nil, nil, nil, nil at the end. */
7652 i
= menu_bar_items_index
;
7653 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7654 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7655 /* Add this item. */
7656 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7657 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7658 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7659 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7660 menu_bar_items_index
= i
;
7662 Vinhibit_quit
= oquit
;
7663 return menu_bar_items_vector
;
7666 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7667 If there's already an item for KEY, add this DEF to it. */
7669 Lisp_Object item_properties
;
7672 menu_bar_item (key
, item
, dummy1
, dummy2
)
7673 Lisp_Object key
, item
, dummy1
;
7676 struct gcpro gcpro1
;
7680 if (EQ (item
, Qundefined
))
7682 /* If a map has an explicit `undefined' as definition,
7683 discard any previously made menu bar item. */
7685 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7686 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7688 if (menu_bar_items_index
> i
+ 4)
7689 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7690 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7691 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7692 menu_bar_items_index
-= 4;
7696 /* If this keymap has already contributed to this KEY,
7697 don't contribute to it a second time. */
7698 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7699 if (!NILP (tem
) || NILP (item
))
7702 menu_bar_one_keymap_changed_items
7703 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7705 /* We add to menu_bar_one_keymap_changed_items before doing the
7706 parse_menu_item, so that if it turns out it wasn't a menu item,
7707 it still correctly hides any further menu item. */
7709 i
= parse_menu_item (item
, 0, 1);
7714 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7716 /* Find any existing item for this KEY. */
7717 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7718 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7721 /* If we did not find this KEY, add it at the end. */
7722 if (i
== menu_bar_items_index
)
7724 /* If vector is too small, get a bigger one. */
7725 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7726 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7727 /* Add this item. */
7728 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7729 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7730 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7731 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7732 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7733 menu_bar_items_index
= i
;
7735 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7739 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7740 /* If the new and the old items are not both keymaps,
7741 the lookup will only find `item'. */
7742 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7743 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7747 /* This is used as the handler when calling menu_item_eval_property. */
7749 menu_item_eval_property_1 (arg
)
7752 /* If we got a quit from within the menu computation,
7753 quit all the way out of it. This takes care of C-] in the debugger. */
7754 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7755 Fsignal (Qquit
, Qnil
);
7760 /* Evaluate an expression and return the result (or nil if something
7761 went wrong). Used to evaluate dynamic parts of menu items. */
7763 menu_item_eval_property (sexpr
)
7766 int count
= SPECPDL_INDEX ();
7768 specbind (Qinhibit_redisplay
, Qt
);
7769 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7770 menu_item_eval_property_1
);
7771 return unbind_to (count
, val
);
7774 /* This function parses a menu item and leaves the result in the
7775 vector item_properties.
7776 ITEM is a key binding, a possible menu item.
7777 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7778 evaluate dynamic expressions in the menu item.
7779 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7781 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7782 parse_menu_item returns true if the item is a menu item and false
7786 parse_menu_item (item
, notreal
, inmenubar
)
7788 int notreal
, inmenubar
;
7790 Lisp_Object def
, tem
, item_string
, start
;
7791 Lisp_Object cachelist
;
7793 Lisp_Object keyhint
;
7804 /* Create item_properties vector if necessary. */
7805 if (NILP (item_properties
))
7807 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7809 /* Initialize optional entries. */
7810 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7811 AREF (item_properties
, i
) = Qnil
;
7812 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7814 /* Save the item here to protect it from GC. */
7815 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7817 item_string
= XCAR (item
);
7821 if (STRINGP (item_string
))
7823 /* Old format menu item. */
7824 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7826 /* Maybe help string. */
7827 if (CONSP (item
) && STRINGP (XCAR (item
)))
7829 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7834 /* Maybe key binding cache. */
7835 if (CONSP (item
) && CONSP (XCAR (item
))
7836 && (NILP (XCAR (XCAR (item
)))
7837 || VECTORP (XCAR (XCAR (item
)))))
7839 cachelist
= XCAR (item
);
7843 /* This is the real definition--the function to run. */
7844 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7846 /* Get enable property, if any. */
7849 tem
= Fget (item
, Qmenu_enable
);
7850 if (!NILP (Venable_disabled_menus_and_buttons
))
7851 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7852 else if (!NILP (tem
))
7853 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7856 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7858 /* New format menu item. */
7859 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7860 start
= XCDR (item
);
7863 /* We have a real binding. */
7864 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7866 item
= XCDR (start
);
7867 /* Is there a cache list with key equivalences. */
7868 if (CONSP (item
) && CONSP (XCAR (item
)))
7870 cachelist
= XCAR (item
);
7874 /* Parse properties. */
7875 while (CONSP (item
) && CONSP (XCDR (item
)))
7880 if (EQ (tem
, QCenable
))
7882 if (!NILP (Venable_disabled_menus_and_buttons
))
7883 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7885 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7887 else if (EQ (tem
, QCvisible
) && !notreal
)
7889 /* If got a visible property and that evaluates to nil
7890 then ignore this item. */
7891 tem
= menu_item_eval_property (XCAR (item
));
7895 else if (EQ (tem
, QChelp
))
7896 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7897 else if (EQ (tem
, QCfilter
))
7899 else if (EQ (tem
, QCkey_sequence
))
7902 if (NILP (cachelist
)
7903 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7904 /* Be GC protected. Set keyhint to item instead of tem. */
7907 else if (EQ (tem
, QCkeys
))
7910 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7911 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7913 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7918 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7920 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7922 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7929 else if (inmenubar
|| !NILP (start
))
7933 return 0; /* not a menu item */
7935 /* If item string is not a string, evaluate it to get string.
7936 If we don't get a string, skip this item. */
7937 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7938 if (!(STRINGP (item_string
) || notreal
))
7940 item_string
= menu_item_eval_property (item_string
);
7941 if (!STRINGP (item_string
))
7943 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7946 /* If got a filter apply it on definition. */
7947 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7950 def
= menu_item_eval_property (list2 (XCAR (filter
),
7951 list2 (Qquote
, def
)));
7953 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7956 /* Enable or disable selection of item. */
7957 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7963 tem
= menu_item_eval_property (tem
);
7964 if (inmenubar
&& NILP (tem
))
7965 return 0; /* Ignore disabled items in menu bar. */
7966 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7969 /* If we got no definition, this item is just unselectable text which
7970 is OK in a submenu but not in the menubar. */
7972 return (inmenubar
? 0 : 1);
7974 /* See if this is a separate pane or a submenu. */
7975 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7976 tem
= get_keymap (def
, 0, 1);
7977 /* For a subkeymap, just record its details and exit. */
7980 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7981 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7985 /* At the top level in the menu bar, do likewise for commands also.
7986 The menu bar does not display equivalent key bindings anyway.
7987 ITEM_PROPERTY_DEF is already set up properly. */
7991 /* This is a command. See if there is an equivalent key binding. */
7992 if (NILP (cachelist
))
7994 /* We have to create a cachelist. */
7995 CHECK_IMPURE (start
);
7996 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7997 cachelist
= XCAR (XCDR (start
));
7999 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8000 if (!NILP (keyhint
))
8002 XSETCAR (cachelist
, XCAR (keyhint
));
8005 else if (STRINGP (tem
))
8007 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
8008 XSETCAR (cachelist
, Qt
);
8012 tem
= XCAR (cachelist
);
8019 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
8021 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8024 def
= XCAR (prefix
);
8025 prefix
= XCDR (prefix
);
8028 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8030 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
8032 if (newcache
/* Always check first time. */
8033 /* Should we check everything when precomputing key
8035 /* If something had no key binding before, don't recheck it
8036 because that is too slow--except if we have a list of
8037 rebound commands in Vdefine_key_rebound_commands, do
8038 recheck any command that appears in that list. */
8039 || (CONSP (Vdefine_key_rebound_commands
)
8040 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
8043 /* We had a saved key. Is it still bound to the command? */
8046 /* If the command is an alias for another
8047 (such as lmenu.el set it up), check if the
8048 original command matches the cached command. */
8049 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8050 chkcache
= 1; /* Need to recompute key binding. */
8054 /* Recompute equivalent key binding. If the command is an alias
8055 for another (such as lmenu.el set it up), see if the original
8056 command name has equivalent keys. Otherwise look up the
8057 specified command itself. We don't try both, because that
8058 makes lmenu menus slow. */
8060 && SYMBOLP (XSYMBOL (def
)->function
)
8061 && ! NILP (Fget (def
, Qmenu_alias
)))
8062 def
= XSYMBOL (def
)->function
;
8063 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8064 XSETCAR (cachelist
, tem
);
8067 XSETCDR (cachelist
, Qnil
);
8071 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8073 tem
= XCAR (cachelist
);
8077 newcache
= chkcache
;
8080 tem
= Fkey_description (tem
, Qnil
);
8083 if (STRINGP (XCAR (prefix
)))
8084 tem
= concat2 (XCAR (prefix
), tem
);
8085 if (STRINGP (XCDR (prefix
)))
8086 tem
= concat2 (tem
, XCDR (prefix
));
8088 XSETCDR (cachelist
, tem
);
8092 tem
= XCDR (cachelist
);
8093 if (newcache
&& !NILP (tem
))
8095 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
8096 XSETCDR (cachelist
, tem
);
8099 /* If we only want to precompute equivalent key bindings, stop here. */
8103 /* If we have an equivalent key binding, use that. */
8104 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
8106 /* Include this when menu help is implemented.
8107 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8108 if (!(NILP (tem) || STRINGP (tem)))
8110 tem = menu_item_eval_property (tem);
8113 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8117 /* Handle radio buttons or toggle boxes. */
8118 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8120 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
8121 = menu_item_eval_property (tem
);
8128 /***********************************************************************
8130 ***********************************************************************/
8132 /* A vector holding tool bar items while they are parsed in function
8133 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8136 static Lisp_Object tool_bar_items_vector
;
8138 /* A vector holding the result of parse_tool_bar_item. Layout is like
8139 the one for a single item in tool_bar_items_vector. */
8141 static Lisp_Object tool_bar_item_properties
;
8143 /* Next free index in tool_bar_items_vector. */
8145 static int ntool_bar_items
;
8147 /* The symbols `tool-bar', `:image' and `:rtl'. */
8149 extern Lisp_Object Qtool_bar
;
8150 Lisp_Object QCimage
;
8153 /* Function prototypes. */
8155 static void init_tool_bar_items
P_ ((Lisp_Object
));
8156 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8157 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8158 static void append_tool_bar_item
P_ ((void));
8161 /* Return a vector of tool bar items for keymaps currently in effect.
8162 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8163 tool bar items found. */
8166 tool_bar_items (reuse
, nitems
)
8177 /* In order to build the menus, we need to call the keymap
8178 accessors. They all call QUIT. But this function is called
8179 during redisplay, during which a quit is fatal. So inhibit
8180 quitting while building the menus. We do this instead of
8181 specbind because (1) errors will clear it anyway and (2) this
8182 avoids risk of specpdl overflow. */
8183 oquit
= Vinhibit_quit
;
8186 /* Initialize tool_bar_items_vector and protect it from GC. */
8187 init_tool_bar_items (reuse
);
8189 /* Build list of keymaps in maps. Set nmaps to the number of maps
8192 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8193 if (!NILP (Voverriding_local_map_menu_flag
))
8195 /* Yes, use them (if non-nil) as well as the global map. */
8196 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8198 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8199 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8200 if (!NILP (Voverriding_local_map
))
8201 maps
[nmaps
++] = Voverriding_local_map
;
8205 /* No, so use major and minor mode keymaps and keymap property.
8206 Note that tool-bar bindings in the local-map and keymap
8207 properties may not work reliable, as they are only
8208 recognized when the tool-bar (or mode-line) is updated,
8209 which does not normally happen after every command. */
8212 nminor
= current_minor_maps (NULL
, &tmaps
);
8213 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8215 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8216 maps
[nmaps
++] = tem
;
8217 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8219 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8222 /* Add global keymap at the end. */
8223 maps
[nmaps
++] = current_global_map
;
8225 /* Process maps in reverse order and look up in each map the prefix
8227 for (i
= nmaps
- 1; i
>= 0; --i
)
8228 if (!NILP (maps
[i
]))
8232 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8234 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8237 Vinhibit_quit
= oquit
;
8238 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8239 return tool_bar_items_vector
;
8243 /* Process the definition of KEY which is DEF. */
8246 process_tool_bar_item (key
, def
, data
, args
)
8247 Lisp_Object key
, def
, data
;
8251 extern Lisp_Object Qundefined
;
8252 struct gcpro gcpro1
, gcpro2
;
8254 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8258 if (EQ (def
, Qundefined
))
8260 /* If a map has an explicit `undefined' as definition,
8261 discard any previously made item. */
8262 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8264 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8266 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8268 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8269 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8270 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8271 * sizeof (Lisp_Object
)));
8272 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8277 else if (parse_tool_bar_item (key
, def
))
8278 /* Append a new tool bar item to tool_bar_items_vector. Accept
8279 more than one definition for the same key. */
8280 append_tool_bar_item ();
8286 /* Parse a tool bar item specification ITEM for key KEY and return the
8287 result in tool_bar_item_properties. Value is zero if ITEM is
8290 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8292 CAPTION is the caption of the item, If it's not a string, it is
8293 evaluated to get a string.
8295 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8296 as binding are currently ignored.
8298 The following properties are recognized:
8302 FORM is evaluated and specifies whether the tool bar item is
8303 enabled or disabled.
8307 FORM is evaluated and specifies whether the tool bar item is visible.
8309 - `:filter FUNCTION'
8311 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8312 result is stored as the new binding.
8314 - `:button (TYPE SELECTED)'
8316 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8317 and specifies whether the button is selected (pressed) or not.
8321 IMAGES is either a single image specification or a vector of four
8322 image specifications. See enum tool_bar_item_images.
8324 - `:help HELP-STRING'.
8326 Gives a help string to display for the tool bar item. */
8329 parse_tool_bar_item (key
, item
)
8330 Lisp_Object key
, item
;
8332 /* Access slot with index IDX of vector tool_bar_item_properties. */
8333 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8335 Lisp_Object filter
= Qnil
;
8336 Lisp_Object caption
;
8339 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8340 Rule out items that aren't lists, don't start with
8341 `menu-item' or whose rest following `tool-bar-item' is not a
8344 || !EQ (XCAR (item
), Qmenu_item
)
8345 || (item
= XCDR (item
),
8349 /* Create tool_bar_item_properties vector if necessary. Reset it to
8351 if (VECTORP (tool_bar_item_properties
))
8353 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8357 tool_bar_item_properties
8358 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8361 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8362 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8364 /* Get the caption of the item. If the caption is not a string,
8365 evaluate it to get a string. If we don't get a string, skip this
8367 caption
= XCAR (item
);
8368 if (!STRINGP (caption
))
8370 caption
= menu_item_eval_property (caption
);
8371 if (!STRINGP (caption
))
8374 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8376 /* Give up if rest following the caption is not a list. */
8381 /* Store the binding. */
8382 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8385 /* Ignore cached key binding, if any. */
8386 if (CONSP (item
) && CONSP (XCAR (item
)))
8389 /* Process the rest of the properties. */
8390 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8392 Lisp_Object key
, value
;
8395 value
= XCAR (XCDR (item
));
8397 if (EQ (key
, QCenable
))
8399 /* `:enable FORM'. */
8400 if (!NILP (Venable_disabled_menus_and_buttons
))
8401 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8403 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8405 else if (EQ (key
, QCvisible
))
8407 /* `:visible FORM'. If got a visible property and that
8408 evaluates to nil then ignore this item. */
8409 if (NILP (menu_item_eval_property (value
)))
8412 else if (EQ (key
, QChelp
))
8413 /* `:help HELP-STRING'. */
8414 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8415 else if (EQ (key
, QCfilter
))
8416 /* ':filter FORM'. */
8418 else if (EQ (key
, QCbutton
) && CONSP (value
))
8420 /* `:button (TYPE . SELECTED)'. */
8421 Lisp_Object type
, selected
;
8423 type
= XCAR (value
);
8424 selected
= XCDR (value
);
8425 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8427 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8428 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8431 else if (EQ (key
, QCimage
)
8433 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8434 /* Value is either a single image specification or a vector
8435 of 4 such specifications for the different button states. */
8436 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8437 else if (EQ (key
, Qrtl
))
8439 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8442 /* If got a filter apply it on binding. */
8444 PROP (TOOL_BAR_ITEM_BINDING
)
8445 = menu_item_eval_property (list2 (filter
,
8447 PROP (TOOL_BAR_ITEM_BINDING
))));
8449 /* See if the binding is a keymap. Give up if it is. */
8450 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8453 /* Enable or disable selection of item. */
8454 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8455 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8456 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8458 /* Handle radio buttons or toggle boxes. */
8459 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8460 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8461 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8469 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8470 that can be reused. */
8473 init_tool_bar_items (reuse
)
8476 if (VECTORP (reuse
))
8477 tool_bar_items_vector
= reuse
;
8479 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8480 ntool_bar_items
= 0;
8484 /* Append parsed tool bar item properties from
8485 tool_bar_item_properties */
8488 append_tool_bar_item ()
8490 Lisp_Object
*to
, *from
;
8492 /* Enlarge tool_bar_items_vector if necessary. */
8493 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8494 >= XVECTOR (tool_bar_items_vector
)->size
)
8495 tool_bar_items_vector
8496 = larger_vector (tool_bar_items_vector
,
8497 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8499 /* Append entries from tool_bar_item_properties to the end of
8500 tool_bar_items_vector. */
8501 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8502 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8503 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8504 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8511 /* Read a character using menus based on maps in the array MAPS.
8512 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8513 Return t if we displayed a menu but the user rejected it.
8515 PREV_EVENT is the previous input event, or nil if we are reading
8516 the first event of a key sequence.
8518 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8519 if we used a mouse menu to read the input, or zero otherwise. If
8520 USED_MOUSE_MENU is null, we don't dereference it.
8522 The prompting is done based on the prompt-string of the map
8523 and the strings associated with various map elements.
8525 This can be done with X menus or with menus put in the minibuf.
8526 These are done in different ways, depending on how the input will be read.
8527 Menus using X are done after auto-saving in read-char, getting the input
8528 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8529 and do auto-saving in the inner call of read_char. */
8532 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8535 Lisp_Object prev_event
;
8536 int *used_mouse_menu
;
8539 register Lisp_Object name
= Qnil
;
8541 if (used_mouse_menu
)
8542 *used_mouse_menu
= 0;
8544 /* Use local over global Menu maps */
8546 if (! menu_prompting
)
8549 /* Optionally disregard all but the global map. */
8550 if (inhibit_local_menu_bar_menus
)
8552 maps
+= (nmaps
- 1);
8556 /* Get the menu name from the first map that has one (a prompt string). */
8557 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8559 name
= Fkeymap_prompt (maps
[mapno
]);
8564 /* If we don't have any menus, just read a character normally. */
8565 if (!STRINGP (name
))
8569 /* If we got to this point via a mouse click,
8570 use a real menu for mouse selection. */
8571 if (EVENT_HAS_PARAMETERS (prev_event
)
8572 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8573 && !EQ (XCAR (prev_event
), Qtool_bar
))
8575 /* Display the menu and get the selection. */
8576 Lisp_Object
*realmaps
8577 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8581 /* Use the maps that are not nil. */
8582 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8583 if (!NILP (maps
[mapno
]))
8584 realmaps
[nmaps1
++] = maps
[mapno
];
8586 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8591 record_menu_key (XCAR (value
));
8593 /* If we got multiple events, unread all but
8595 There is no way to prevent those unread events
8596 from showing up later in last_nonmenu_event.
8597 So turn symbol and integer events into lists,
8598 to indicate that they came from a mouse menu,
8599 so that when present in last_nonmenu_event
8600 they won't confuse things. */
8601 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8603 record_menu_key (XCAR (tem
));
8604 if (SYMBOLP (XCAR (tem
))
8605 || INTEGERP (XCAR (tem
)))
8606 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8609 /* If we got more than one event, put all but the first
8610 onto this list to be read later.
8611 Return just the first event now. */
8612 Vunread_command_events
8613 = nconc2 (XCDR (value
), Vunread_command_events
);
8614 value
= XCAR (value
);
8616 else if (NILP (value
))
8618 if (used_mouse_menu
)
8619 *used_mouse_menu
= 1;
8622 #endif /* HAVE_MENUS */
8626 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8627 We make this bigger when necessary, and never free it. */
8628 static char *read_char_minibuf_menu_text
;
8629 /* Size of that buffer. */
8630 static int read_char_minibuf_menu_width
;
8633 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8639 register Lisp_Object name
;
8641 /* FIXME: Use the minibuffer's frame width. */
8642 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8645 Lisp_Object rest
, vector
;
8651 if (! menu_prompting
)
8654 /* Make sure we have a big enough buffer for the menu text. */
8655 if (read_char_minibuf_menu_text
== 0)
8657 read_char_minibuf_menu_width
= width
+ 4;
8658 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8660 else if (width
+ 4 > read_char_minibuf_menu_width
)
8662 read_char_minibuf_menu_width
= width
+ 4;
8663 read_char_minibuf_menu_text
8664 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8666 menu
= read_char_minibuf_menu_text
;
8668 /* Get the menu name from the first map that has one (a prompt string). */
8669 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8671 name
= Fkeymap_prompt (maps
[mapno
]);
8676 /* If we don't have any menus, just read a character normally. */
8677 if (!STRINGP (name
))
8680 /* Prompt string always starts with map's prompt, and a space. */
8681 strcpy (menu
, SDATA (name
));
8682 nlength
= SBYTES (name
);
8683 menu
[nlength
++] = ':';
8684 menu
[nlength
++] = ' ';
8687 /* Start prompting at start of first map. */
8691 /* Present the documented bindings, a line at a time. */
8698 Lisp_Object orig_defn_macro
;
8700 /* Loop over elements of map. */
8705 /* If reached end of map, start at beginning of next map. */
8709 /* At end of last map, wrap around to first map if just starting,
8710 or end this line if already have something on it. */
8714 if (notfirst
|| nobindings
) break;
8719 /* Look at the next element of the map. */
8721 elt
= XVECTOR (vector
)->contents
[idx
];
8723 elt
= Fcar_safe (rest
);
8725 if (idx
< 0 && VECTORP (elt
))
8727 /* If we found a dense table in the keymap,
8728 advanced past it, but start scanning its contents. */
8729 rest
= Fcdr_safe (rest
);
8735 /* An ordinary element. */
8736 Lisp_Object event
, tem
;
8740 event
= Fcar_safe (elt
); /* alist */
8741 elt
= Fcdr_safe (elt
);
8745 XSETINT (event
, idx
); /* vector */
8748 /* Ignore the element if it has no prompt string. */
8749 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8751 /* 1 if the char to type matches the string. */
8753 Lisp_Object upcased_event
, downcased_event
;
8754 Lisp_Object desc
= Qnil
;
8756 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8758 upcased_event
= Fupcase (event
);
8759 downcased_event
= Fdowncase (event
);
8760 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8761 || XINT (downcased_event
) == SREF (s
, 0));
8763 desc
= Fsingle_key_description (event
, Qnil
);
8765 #if 0 /* It is redundant to list the equivalent key bindings because
8766 the prefix is what the user has already typed. */
8768 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8770 /* Insert equivalent keybinding. */
8771 s
= concat2 (s
, tem
);
8774 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8775 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8777 /* Insert button prefix. */
8778 Lisp_Object selected
8779 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8780 if (EQ (tem
, QCradio
))
8781 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8783 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8784 s
= concat2 (tem
, s
);
8788 /* If we have room for the prompt string, add it to this line.
8789 If this is the first on the line, always add it. */
8790 if ((SCHARS (s
) + i
+ 2
8791 + (char_matches
? 0 : SCHARS (desc
) + 3))
8797 /* Punctuate between strings. */
8800 strcpy (menu
+ i
, ", ");
8806 /* If the char to type doesn't match the string's
8807 first char, explicitly show what char to type. */
8810 /* Add as much of string as fits. */
8811 thiswidth
= SCHARS (desc
);
8812 if (thiswidth
+ i
> width
)
8813 thiswidth
= width
- i
;
8814 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8816 strcpy (menu
+ i
, " = ");
8820 /* Add as much of string as fits. */
8821 thiswidth
= SCHARS (s
);
8822 if (thiswidth
+ i
> width
)
8823 thiswidth
= width
- i
;
8824 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8830 /* If this element does not fit, end the line now,
8831 and save the element for the next line. */
8832 strcpy (menu
+ i
, "...");
8837 /* Move past this element. */
8838 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8839 /* Handle reaching end of dense table. */
8844 rest
= Fcdr_safe (rest
);
8848 /* Prompt with that and read response. */
8849 message2_nolog (menu
, strlen (menu
),
8850 ! NILP (current_buffer
->enable_multibyte_characters
));
8852 /* Make believe its not a keyboard macro in case the help char
8853 is pressed. Help characters are not recorded because menu prompting
8854 is not used on replay.
8856 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8857 current_kboard
->defining_kbd_macro
= Qnil
;
8859 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8860 while (BUFFERP (obj
));
8861 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8863 if (!INTEGERP (obj
))
8865 else if (XINT (obj
) == -2)
8870 if (! EQ (obj
, menu_prompt_more_char
)
8871 && (!INTEGERP (menu_prompt_more_char
)
8872 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8874 if (!NILP (current_kboard
->defining_kbd_macro
))
8875 store_kbd_macro_char (obj
);
8878 /* Help char - go round again */
8882 /* Reading key sequences. */
8884 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8885 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8886 keymap, or nil otherwise. Return the index of the first keymap in
8887 which KEY has any binding, or NMAPS if no map has a binding.
8889 If KEY is a meta ASCII character, treat it like meta-prefix-char
8890 followed by the corresponding non-meta character. Keymaps in
8891 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8894 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8897 NEXT may be the same array as CURRENT. */
8900 follow_key (key
, nmaps
, current
, defs
, next
)
8902 Lisp_Object
*current
, *defs
, *next
;
8905 int i
, first_binding
;
8907 first_binding
= nmaps
;
8908 for (i
= nmaps
- 1; i
>= 0; i
--)
8910 if (! NILP (current
[i
]))
8912 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8913 if (! NILP (defs
[i
]))
8920 /* Given the set of bindings we've found, produce the next set of maps. */
8921 if (first_binding
< nmaps
)
8922 for (i
= 0; i
< nmaps
; i
++)
8923 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8925 return first_binding
;
8928 /* Structure used to keep track of partial application of key remapping
8929 such as Vfunction_key_map and Vkey_translation_map. */
8930 typedef struct keyremap
8932 /* This is the map originally specified for this use. */
8934 /* This is a submap reached by looking up, in PARENT,
8935 the events from START to END. */
8937 /* Positions [START, END) in the key sequence buffer
8938 are the key that we have scanned so far.
8939 Those events are the ones that we will replace
8940 if PAREHT maps them into a key sequence. */
8944 /* Lookup KEY in MAP.
8945 MAP is a keymap mapping keys to key vectors or functions.
8946 If the mapping is a function and DO_FUNCTION is non-zero, then
8947 the function is called with PROMPT as parameter and its return
8948 value is used as the return value of this function (after checking
8949 that it is indeed a vector). */
8952 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8953 Lisp_Object map
, key
, prompt
;
8958 next
= access_keymap (map
, key
, 1, 0, 1);
8960 /* Handle symbol with autoload definition. */
8961 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8962 && CONSP (XSYMBOL (next
)->function
)
8963 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8964 do_autoload (XSYMBOL (next
)->function
, next
);
8966 /* Handle a symbol whose function definition is a keymap
8968 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8969 && (ARRAYP (XSYMBOL (next
)->function
)
8970 || KEYMAPP (XSYMBOL (next
)->function
)))
8971 next
= XSYMBOL (next
)->function
;
8973 /* If the keymap gives a function, not an
8974 array, then call the function with one arg and use
8975 its value instead. */
8976 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8981 next
= call1 (next
, prompt
);
8982 /* If the function returned something invalid,
8983 barf--don't ignore it.
8984 (To ignore it safely, we would need to gcpro a bunch of
8985 other variables.) */
8986 if (! (VECTORP (next
) || STRINGP (next
)))
8987 error ("Function %s returns invalid key sequence", tem
);
8992 /* Do one step of the key remapping used for function-key-map and
8993 key-translation-map:
8994 KEYBUF is the buffer holding the input events.
8995 BUFSIZE is its maximum size.
8996 FKEY is a pointer to the keyremap structure to use.
8997 INPUT is the index of the last element in KEYBUF.
8998 DOIT if non-zero says that the remapping can actually take place.
8999 DIFF is used to return the number of keys added/removed by the remapping.
9000 PARENT is the root of the keymap.
9001 PROMPT is the prompt to use if the remapping happens through a function.
9002 The return value is non-zero if the remapping actually took place. */
9005 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
9006 Lisp_Object
*keybuf
, prompt
;
9008 int input
, doit
, *diff
, bufsize
;
9010 Lisp_Object next
, key
;
9012 key
= keybuf
[fkey
->end
++];
9014 if (KEYMAPP (fkey
->parent
))
9015 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9019 /* If keybuf[fkey->start..fkey->end] is bound in the
9020 map and we're in a position to do the key remapping, replace it with
9021 the binding and restart with fkey->start at the end. */
9022 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9024 int len
= XFASTINT (Flength (next
));
9027 *diff
= len
- (fkey
->end
- fkey
->start
);
9029 if (input
+ *diff
>= bufsize
)
9030 error ("Key sequence too long");
9032 /* Shift the keys that follow fkey->end. */
9034 for (i
= fkey
->end
; i
< input
; i
++)
9035 keybuf
[i
+ *diff
] = keybuf
[i
];
9037 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9038 keybuf
[i
+ *diff
] = keybuf
[i
];
9039 /* Overwrite the old keys with the new ones. */
9040 for (i
= 0; i
< len
; i
++)
9041 keybuf
[fkey
->start
+ i
]
9042 = Faref (next
, make_number (i
));
9044 fkey
->start
= fkey
->end
+= *diff
;
9045 fkey
->map
= fkey
->parent
;
9050 fkey
->map
= get_keymap (next
, 0, 1);
9052 /* If we no longer have a bound suffix, try a new position for
9054 if (!CONSP (fkey
->map
))
9056 fkey
->end
= ++fkey
->start
;
9057 fkey
->map
= fkey
->parent
;
9062 /* Read a sequence of keys that ends with a non prefix character,
9063 storing it in KEYBUF, a buffer of size BUFSIZE.
9065 Return the length of the key sequence stored.
9066 Return -1 if the user rejected a command menu.
9068 Echo starting immediately unless `prompt' is 0.
9070 Where a key sequence ends depends on the currently active keymaps.
9071 These include any minor mode keymaps active in the current buffer,
9072 the current buffer's local map, and the global map.
9074 If a key sequence has no other bindings, we check Vfunction_key_map
9075 to see if some trailing subsequence might be the beginning of a
9076 function key's sequence. If so, we try to read the whole function
9077 key, and substitute its symbolic name into the key sequence.
9079 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9080 `double-' events into similar click events, if that would make them
9081 bound. We try to turn `triple-' events first into `double-' events,
9084 If we get a mouse click in a mode line, vertical divider, or other
9085 non-text area, we treat the click as if it were prefixed by the
9086 symbol denoting that area - `mode-line', `vertical-line', or
9089 If the sequence starts with a mouse click, we read the key sequence
9090 with respect to the buffer clicked on, not the current buffer.
9092 If the user switches frames in the midst of a key sequence, we put
9093 off the switch-frame event until later; the next call to
9094 read_char will return it.
9096 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9097 from the selected window's buffer. */
9100 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9101 can_return_switch_frame
, fix_current_buffer
)
9102 Lisp_Object
*keybuf
;
9105 int dont_downcase_last
;
9106 int can_return_switch_frame
;
9107 int fix_current_buffer
;
9109 volatile Lisp_Object from_string
;
9110 volatile int count
= SPECPDL_INDEX ();
9112 /* How many keys there are in the current key sequence. */
9115 /* The length of the echo buffer when we started reading, and
9116 the length of this_command_keys when we started reading. */
9117 volatile int echo_start
;
9118 volatile int keys_start
;
9120 /* The number of keymaps we're scanning right now, and the number of
9121 keymaps we have allocated space for. */
9123 volatile int nmaps_allocated
= 0;
9125 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9126 the current keymaps. */
9127 Lisp_Object
*volatile defs
= NULL
;
9129 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9130 in the current keymaps, or nil where it is not a prefix. */
9131 Lisp_Object
*volatile submaps
= NULL
;
9133 /* The local map to start out with at start of key sequence. */
9134 volatile Lisp_Object orig_local_map
;
9136 /* The map from the `keymap' property to start out with at start of
9138 volatile Lisp_Object orig_keymap
;
9140 /* 1 if we have already considered switching to the local-map property
9141 of the place where a mouse click occurred. */
9142 volatile int localized_local_map
= 0;
9144 /* The index in submaps[] of the first keymap that has a binding for
9145 this key sequence. In other words, the lowest i such that
9146 submaps[i] is non-nil. */
9147 volatile int first_binding
;
9148 /* Index of the first key that has no binding.
9149 It is useless to try fkey.start larger than that. */
9150 volatile int first_unbound
;
9152 /* If t < mock_input, then KEYBUF[t] should be read as the next
9155 We use this to recover after recognizing a function key. Once we
9156 realize that a suffix of the current key sequence is actually a
9157 function key's escape sequence, we replace the suffix with the
9158 function key's binding from Vfunction_key_map. Now keybuf
9159 contains a new and different key sequence, so the echo area,
9160 this_command_keys, and the submaps and defs arrays are wrong. In
9161 this situation, we set mock_input to t, set t to 0, and jump to
9162 restart_sequence; the loop will read keys from keybuf up until
9163 mock_input, thus rebuilding the state; and then it will resume
9164 reading characters from the keyboard. */
9165 volatile int mock_input
= 0;
9167 /* If the sequence is unbound in submaps[], then
9168 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9169 and fkey.map is its binding.
9171 These might be > t, indicating that all function key scanning
9172 should hold off until t reaches them. We do this when we've just
9173 recognized a function key, to avoid searching for the function
9174 key's again in Vfunction_key_map. */
9175 volatile keyremap fkey
;
9177 /* Likewise, for key_translation_map and input-decode-map. */
9178 volatile keyremap keytran
, indec
;
9180 /* If we receive a `switch-frame' or `select-window' event in the middle of
9181 a key sequence, we put it off for later.
9182 While we're reading, we keep the event here. */
9183 volatile Lisp_Object delayed_switch_frame
;
9185 /* See the comment below... */
9186 #if defined (GOBBLE_FIRST_EVENT)
9187 Lisp_Object first_event
;
9190 volatile Lisp_Object original_uppercase
;
9191 volatile int original_uppercase_position
= -1;
9193 /* Gets around Microsoft compiler limitations. */
9196 struct buffer
*starting_buffer
;
9198 /* List of events for which a fake prefix key has been generated. */
9199 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9201 #if defined (GOBBLE_FIRST_EVENT)
9205 struct gcpro gcpro1
;
9207 GCPRO1 (fake_prefixed_keys
);
9208 raw_keybuf_count
= 0;
9210 last_nonmenu_event
= Qnil
;
9212 delayed_switch_frame
= Qnil
;
9217 echo_prompt (prompt
);
9218 else if (cursor_in_echo_area
9219 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9220 && NILP (Fzerop (Vecho_keystrokes
)))
9221 /* This doesn't put in a dash if the echo buffer is empty, so
9222 you don't always see a dash hanging out in the minibuffer. */
9226 /* Record the initial state of the echo area and this_command_keys;
9227 we will need to restore them if we replay a key sequence. */
9229 echo_start
= echo_length ();
9230 keys_start
= this_command_key_count
;
9231 this_single_command_key_start
= keys_start
;
9233 #if defined (GOBBLE_FIRST_EVENT)
9234 /* This doesn't quite work, because some of the things that read_char
9235 does cannot safely be bypassed. It seems too risky to try to make
9238 /* Read the first char of the sequence specially, before setting
9239 up any keymaps, in case a filter runs and switches buffers on us. */
9240 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9242 #endif /* GOBBLE_FIRST_EVENT */
9244 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9245 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9248 /* The multi-tty merge moved the code below to right after
9249 `replay_sequence' which caused all these translation maps to be applied
9250 repeatedly, even tho their doc says very clearly they are not applied to
9252 The reason for this move was: "We may switch keyboards between rescans,
9253 so we need to reinitialize fkey and keytran before each replay".
9254 This move was wrong (even if we switch keyboards, keybuf still holds the
9255 keys we've read already from the original keyboard and some of those keys
9256 may have already been translated). So there may still be a bug out there
9258 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9259 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9260 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9261 indec
.start
= indec
.end
= 0;
9262 fkey
.start
= fkey
.end
= 0;
9263 keytran
.start
= keytran
.end
= 0;
9265 /* We jump here when the key sequence has been thoroughly changed, and
9266 we need to rescan it starting from the beginning. When we jump here,
9267 keybuf[0..mock_input] holds the sequence we should reread. */
9270 starting_buffer
= current_buffer
;
9271 first_unbound
= bufsize
+ 1;
9273 /* Build our list of keymaps.
9274 If we recognize a function key and replace its escape sequence in
9275 keybuf with its symbol, or if the sequence starts with a mouse
9276 click and we need to switch buffers, we jump back here to rebuild
9277 the initial keymaps from the current buffer. */
9280 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9282 if (2 > nmaps_allocated
)
9284 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9285 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9286 nmaps_allocated
= 2;
9288 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9289 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9291 else if (!NILP (Voverriding_local_map
))
9293 if (2 > nmaps_allocated
)
9295 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9296 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9297 nmaps_allocated
= 2;
9299 if (!NILP (Voverriding_local_map
))
9300 submaps
[nmaps
++] = Voverriding_local_map
;
9308 nminor
= current_minor_maps (0, &maps
);
9309 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9311 if (total
> nmaps_allocated
)
9313 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9314 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9315 nmaps_allocated
= total
;
9318 if (!NILP (orig_keymap
))
9319 submaps
[nmaps
++] = orig_keymap
;
9321 bcopy (maps
, (void *) (submaps
+ nmaps
),
9322 nminor
* sizeof (submaps
[0]));
9326 submaps
[nmaps
++] = orig_local_map
;
9328 submaps
[nmaps
++] = current_global_map
;
9330 /* Find an accurate initial value for first_binding. */
9331 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9332 if (! NILP (submaps
[first_binding
]))
9335 /* Start from the beginning in keybuf. */
9338 /* These are no-ops the first time through, but if we restart, they
9339 revert the echo area and this_command_keys to their original state. */
9340 this_command_key_count
= keys_start
;
9341 if (INTERACTIVE
&& t
< mock_input
)
9342 echo_truncate (echo_start
);
9344 /* If the best binding for the current key sequence is a keymap, or
9345 we may be looking at a function key's escape sequence, keep on
9347 while (first_binding
< nmaps
9348 /* Keep reading as long as there's a prefix binding. */
9349 ? !NILP (submaps
[first_binding
])
9350 /* Don't return in the middle of a possible function key sequence,
9351 if the only bindings we found were via case conversion.
9352 Thus, if ESC O a has a function-key-map translation
9353 and ESC o has a binding, don't return after ESC O,
9354 so that we can translate ESC O plus the next character. */
9355 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9358 int used_mouse_menu
= 0;
9360 /* Where the last real key started. If we need to throw away a
9361 key that has expanded into more than one element of keybuf
9362 (say, a mouse click on the mode line which is being treated
9363 as [mode-line (mouse-...)], then we backtrack to this point
9365 volatile int last_real_key_start
;
9367 /* These variables are analogous to echo_start and keys_start;
9368 while those allow us to restart the entire key sequence,
9369 echo_local_start and keys_local_start allow us to throw away
9371 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9373 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9374 eassert (indec
.start
<= indec
.end
);
9375 eassert (fkey
.start
<= fkey
.end
);
9376 eassert (keytran
.start
<= keytran
.end
);
9377 /* key-translation-map is applied *after* function-key-map
9378 which is itself applied *after* input-decode-map. */
9379 eassert (fkey
.end
<= indec
.start
);
9380 eassert (keytran
.end
<= fkey
.start
);
9382 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9383 first_unbound
< keytran
.start
)
9384 { /* The prefix upto first_unbound has no binding and has
9385 no translation left to do either, so we know it's unbound.
9386 If we don't stop now, we risk staying here indefinitely
9387 (if the user keeps entering fkey or keytran prefixes
9388 like C-c ESC ESC ESC ESC ...) */
9390 for (i
= first_unbound
+ 1; i
< t
; i
++)
9391 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9392 mock_input
= t
- first_unbound
- 1;
9393 indec
.end
= indec
.start
-= first_unbound
+ 1;
9394 indec
.map
= indec
.parent
;
9395 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9396 fkey
.map
= fkey
.parent
;
9397 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9398 keytran
.map
= keytran
.parent
;
9399 goto replay_sequence
;
9403 error ("Key sequence too long");
9406 echo_local_start
= echo_length ();
9407 keys_local_start
= this_command_key_count
;
9408 local_first_binding
= first_binding
;
9411 /* These are no-ops, unless we throw away a keystroke below and
9412 jumped back up to replay_key; in that case, these restore the
9413 variables to their original state, allowing us to replay the
9415 if (INTERACTIVE
&& t
< mock_input
)
9416 echo_truncate (echo_local_start
);
9417 this_command_key_count
= keys_local_start
;
9418 first_binding
= local_first_binding
;
9420 /* By default, assume each event is "real". */
9421 last_real_key_start
= t
;
9423 /* Does mock_input indicate that we are re-reading a key sequence? */
9427 add_command_key (key
);
9428 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9429 && NILP (Fzerop (Vecho_keystrokes
)))
9433 /* If not, we should actually read a character. */
9438 KBOARD
*interrupted_kboard
= current_kboard
;
9439 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9441 key
= read_char (NILP (prompt
), nmaps
,
9442 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9443 &used_mouse_menu
, NULL
);
9445 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9450 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9451 if (k
== interrupted_kboard
)
9456 /* Don't touch interrupted_kboard when it's been
9458 delayed_switch_frame
= Qnil
;
9459 goto replay_sequence
;
9462 if (!NILP (delayed_switch_frame
))
9464 interrupted_kboard
->kbd_queue
9465 = Fcons (delayed_switch_frame
,
9466 interrupted_kboard
->kbd_queue
);
9467 delayed_switch_frame
= Qnil
;
9471 interrupted_kboard
->kbd_queue
9472 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9474 /* If the side queue is non-empty, ensure it begins with a
9475 switch-frame, so we'll replay it in the right context. */
9476 if (CONSP (interrupted_kboard
->kbd_queue
)
9477 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9478 !(EVENT_HAS_PARAMETERS (key
)
9479 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9483 XSETFRAME (frame
, interrupted_frame
);
9484 interrupted_kboard
->kbd_queue
9485 = Fcons (make_lispy_switch_frame (frame
),
9486 interrupted_kboard
->kbd_queue
);
9489 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9490 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9491 goto replay_sequence
;
9496 /* read_char returns t when it shows a menu and the user rejects it.
9500 unbind_to (count
, Qnil
);
9505 /* read_char returns -1 at the end of a macro.
9506 Emacs 18 handles this by returning immediately with a
9507 zero, so that's what we'll do. */
9508 if (INTEGERP (key
) && XINT (key
) == -1)
9511 /* The Microsoft C compiler can't handle the goto that
9517 /* If the current buffer has been changed from under us, the
9518 keymap may have changed, so replay the sequence. */
9521 timer_resume_idle ();
9524 /* Reset the current buffer from the selected window
9525 in case something changed the former and not the latter.
9526 This is to be more consistent with the behavior
9527 of the command_loop_1. */
9528 if (fix_current_buffer
)
9530 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9532 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9533 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9536 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9537 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9538 goto replay_sequence
;
9541 /* If we have a quit that was typed in another frame, and
9542 quit_throw_to_read_char switched buffers,
9543 replay to get the right keymap. */
9545 && XINT (key
) == quit_char
9546 && current_buffer
!= starting_buffer
)
9549 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9553 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9554 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9555 goto replay_sequence
;
9560 if (EVENT_HAS_PARAMETERS (key
)
9561 /* Either a `switch-frame' or a `select-window' event. */
9562 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9564 /* If we're at the beginning of a key sequence, and the caller
9565 says it's okay, go ahead and return this event. If we're
9566 in the midst of a key sequence, delay it until the end. */
9567 if (t
> 0 || !can_return_switch_frame
)
9569 delayed_switch_frame
= key
;
9575 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9578 /* Clicks in non-text areas get prefixed by the symbol
9579 in their CHAR-ADDRESS field. For example, a click on
9580 the mode line is prefixed by the symbol `mode-line'.
9582 Furthermore, key sequences beginning with mouse clicks
9583 are read using the keymaps of the buffer clicked on, not
9584 the current buffer. So we may have to switch the buffer
9587 When we turn one event into two events, we must make sure
9588 that neither of the two looks like the original--so that,
9589 if we replay the events, they won't be expanded again.
9590 If not for this, such reexpansion could happen either here
9591 or when user programs play with this-command-keys. */
9592 if (EVENT_HAS_PARAMETERS (key
))
9597 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9598 if (EQ (kind
, Qmouse_click
))
9600 Lisp_Object window
, posn
;
9602 window
= POSN_WINDOW (EVENT_START (key
));
9603 posn
= POSN_POSN (EVENT_START (key
));
9606 || (!NILP (fake_prefixed_keys
)
9607 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9609 /* We're looking a second time at an event for which
9610 we generated a fake prefix key. Set
9611 last_real_key_start appropriately. */
9613 last_real_key_start
= t
- 1;
9616 /* Key sequences beginning with mouse clicks are
9617 read using the keymaps in the buffer clicked on,
9618 not the current buffer. If we're at the
9619 beginning of a key sequence, switch buffers. */
9620 if (last_real_key_start
== 0
9622 && BUFFERP (XWINDOW (window
)->buffer
)
9623 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9625 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9629 /* Arrange to go back to the original buffer once we're
9630 done reading the key sequence. Note that we can't
9631 use save_excursion_{save,restore} here, because they
9632 save point as well as the current buffer; we don't
9633 want to save point, because redisplay may change it,
9634 to accommodate a Fset_window_start or something. We
9635 don't want to do this at the top of the function,
9636 because we may get input from a subprocess which
9637 wants to change the selected window and stuff (say,
9639 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9641 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9643 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9644 orig_local_map
= get_local_map (PT
, current_buffer
,
9646 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9647 goto replay_sequence
;
9650 /* For a mouse click, get the local text-property keymap
9651 of the place clicked on, rather than point. */
9652 if (last_real_key_start
== 0
9653 && CONSP (XCDR (key
))
9654 && ! localized_local_map
)
9656 Lisp_Object map_here
, start
, pos
;
9658 localized_local_map
= 1;
9659 start
= EVENT_START (key
);
9661 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9663 pos
= POSN_BUFFER_POSN (start
);
9665 && XINT (pos
) >= BEGV
9666 && XINT (pos
) <= ZV
)
9668 map_here
= get_local_map (XINT (pos
),
9669 current_buffer
, Qlocal_map
);
9670 if (!EQ (map_here
, orig_local_map
))
9672 orig_local_map
= map_here
;
9673 ++localized_local_map
;
9676 map_here
= get_local_map (XINT (pos
),
9677 current_buffer
, Qkeymap
);
9678 if (!EQ (map_here
, orig_keymap
))
9680 orig_keymap
= map_here
;
9681 ++localized_local_map
;
9684 if (localized_local_map
> 1)
9689 goto replay_sequence
;
9695 /* Expand mode-line and scroll-bar events into two events:
9696 use posn as a fake prefix key. */
9698 && (NILP (fake_prefixed_keys
)
9699 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9701 if (t
+ 1 >= bufsize
)
9702 error ("Key sequence too long");
9705 keybuf
[t
+ 1] = key
;
9708 /* Record that a fake prefix key has been generated
9709 for KEY. Don't modify the event; this would
9710 prevent proper action when the event is pushed
9711 back into unread-command-events. */
9712 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9714 /* If on a mode line string with a local keymap,
9715 reconsider the key sequence with that keymap. */
9716 if (string
= POSN_STRING (EVENT_START (key
)),
9717 (CONSP (string
) && STRINGP (XCAR (string
))))
9719 Lisp_Object pos
, map
, map2
;
9721 pos
= XCDR (string
);
9722 string
= XCAR (string
);
9724 && XINT (pos
) < SCHARS (string
))
9726 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9728 orig_local_map
= map
;
9729 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9732 if (!NILP (map
) || !NILP (map2
))
9733 goto replay_sequence
;
9739 else if (NILP (from_string
)
9740 && (string
= POSN_STRING (EVENT_START (key
)),
9741 (CONSP (string
) && STRINGP (XCAR (string
)))))
9743 /* For a click on a string, i.e. overlay string or a
9744 string displayed via the `display' property,
9745 consider `local-map' and `keymap' properties of
9747 Lisp_Object pos
, map
, map2
;
9749 pos
= XCDR (string
);
9750 string
= XCAR (string
);
9752 && XINT (pos
) < SCHARS (string
))
9754 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9756 orig_local_map
= map
;
9757 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9761 if (!NILP (map
) || !NILP (map2
))
9763 from_string
= string
;
9766 goto replay_sequence
;
9771 else if (CONSP (XCDR (key
))
9772 && CONSP (EVENT_START (key
))
9773 && CONSP (XCDR (EVENT_START (key
))))
9777 posn
= POSN_POSN (EVENT_START (key
));
9778 /* Handle menu-bar events:
9779 insert the dummy prefix event `menu-bar'. */
9780 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9782 if (t
+ 1 >= bufsize
)
9783 error ("Key sequence too long");
9787 /* Zap the position in key, so we know that we've
9788 expanded it, and don't try to do so again. */
9789 POSN_SET_POSN (EVENT_START (key
),
9790 Fcons (posn
, Qnil
));
9793 goto replay_sequence
;
9795 else if (CONSP (posn
))
9797 /* We're looking at the second event of a
9798 sequence which we expanded before. Set
9799 last_real_key_start appropriately. */
9800 if (last_real_key_start
== t
&& t
> 0)
9801 last_real_key_start
= t
- 1;
9806 /* We have finally decided that KEY is something we might want
9808 first_binding
= (follow_key (key
,
9809 nmaps
- first_binding
,
9810 submaps
+ first_binding
,
9811 defs
+ first_binding
,
9812 submaps
+ first_binding
)
9815 /* If KEY wasn't bound, we'll try some fallbacks. */
9816 if (first_binding
< nmaps
)
9817 /* This is needed for the following scenario:
9818 event 0: a down-event that gets dropped by calling replay_key.
9819 event 1: some normal prefix like C-h.
9820 After event 0, first_unbound is 0, after event 1 indec.start,
9821 fkey.start, and keytran.start are all 1, so when we see that
9822 C-h is bound, we need to update first_unbound. */
9823 first_unbound
= max (t
+ 1, first_unbound
);
9828 /* Remember the position to put an upper bound on indec.start. */
9829 first_unbound
= min (t
, first_unbound
);
9831 head
= EVENT_HEAD (key
);
9832 if (help_char_p (head
) && t
> 0)
9834 read_key_sequence_cmd
= Vprefix_help_command
;
9836 last_nonmenu_event
= key
;
9837 /* The Microsoft C compiler can't handle the goto that
9845 Lisp_Object breakdown
;
9848 breakdown
= parse_modifiers (head
);
9849 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9850 /* Attempt to reduce an unbound mouse event to a simpler
9851 event that is bound:
9852 Drags reduce to clicks.
9853 Double-clicks reduce to clicks.
9854 Triple-clicks reduce to double-clicks, then to clicks.
9855 Down-clicks are eliminated.
9856 Double-downs reduce to downs, then are eliminated.
9857 Triple-downs reduce to double-downs, then to downs,
9858 then are eliminated. */
9859 if (modifiers
& (down_modifier
| drag_modifier
9860 | double_modifier
| triple_modifier
))
9862 while (modifiers
& (down_modifier
| drag_modifier
9863 | double_modifier
| triple_modifier
))
9865 Lisp_Object new_head
, new_click
;
9866 if (modifiers
& triple_modifier
)
9867 modifiers
^= (double_modifier
| triple_modifier
);
9868 else if (modifiers
& double_modifier
)
9869 modifiers
&= ~double_modifier
;
9870 else if (modifiers
& drag_modifier
)
9871 modifiers
&= ~drag_modifier
;
9874 /* Dispose of this `down' event by simply jumping
9875 back to replay_key, to get another event.
9877 Note that if this event came from mock input,
9878 then just jumping back to replay_key will just
9879 hand it to us again. So we have to wipe out any
9882 We could delete keybuf[t] and shift everything
9883 after that to the left by one spot, but we'd also
9884 have to fix up any variable that points into
9885 keybuf, and shifting isn't really necessary
9888 Adding prefixes for non-textual mouse clicks
9889 creates two characters of mock input, and both
9890 must be thrown away. If we're only looking at
9891 the prefix now, we can just jump back to
9892 replay_key. On the other hand, if we've already
9893 processed the prefix, and now the actual click
9894 itself is giving us trouble, then we've lost the
9895 state of the keymaps we want to backtrack to, and
9896 we need to replay the whole sequence to rebuild
9899 Beyond that, only function key expansion could
9900 create more than two keys, but that should never
9901 generate mouse events, so it's okay to zero
9902 mock_input in that case too.
9904 FIXME: The above paragraph seems just plain
9905 wrong, if you consider things like
9906 xterm-mouse-mode. -stef
9908 Isn't this just the most wonderful code ever? */
9910 /* If mock_input > t + 1, the above simplification
9911 will actually end up dropping keys on the floor.
9912 This is probably OK for now, but even
9913 if mock_input <= t + 1, we need to adjust indec,
9915 Typical case [header-line down-mouse-N]:
9916 mock_input = 2, t = 1, fkey.end = 1,
9917 last_real_key_start = 0. */
9918 if (indec
.end
> last_real_key_start
)
9920 indec
.end
= indec
.start
9921 = min (last_real_key_start
, indec
.start
);
9922 indec
.map
= indec
.parent
;
9923 if (fkey
.end
> last_real_key_start
)
9925 fkey
.end
= fkey
.start
9926 = min (last_real_key_start
, fkey
.start
);
9927 fkey
.map
= fkey
.parent
;
9928 if (keytran
.end
> last_real_key_start
)
9930 keytran
.end
= keytran
.start
9931 = min (last_real_key_start
, keytran
.start
);
9932 keytran
.map
= keytran
.parent
;
9936 if (t
== last_real_key_start
)
9943 mock_input
= last_real_key_start
;
9944 goto replay_sequence
;
9949 = apply_modifiers (modifiers
, XCAR (breakdown
));
9951 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9953 /* Look for a binding for this new key. follow_key
9954 promises that it didn't munge submaps the
9955 last time we called it, since key was unbound. */
9957 = (follow_key (new_click
,
9958 nmaps
- local_first_binding
,
9959 submaps
+ local_first_binding
,
9960 defs
+ local_first_binding
,
9961 submaps
+ local_first_binding
)
9962 + local_first_binding
);
9964 /* If that click is bound, go for it. */
9965 if (first_binding
< nmaps
)
9970 /* Otherwise, we'll leave key set to the drag event. */
9977 /* Normally, last_nonmenu_event gets the previous key we read.
9978 But when a mouse popup menu is being used,
9979 we don't update last_nonmenu_event; it continues to hold the mouse
9980 event that preceded the first level of menu. */
9981 if (!used_mouse_menu
)
9982 last_nonmenu_event
= key
;
9984 /* Record what part of this_command_keys is the current key sequence. */
9985 this_single_command_key_start
= this_command_key_count
- t
;
9987 /* Look for this sequence in input-decode-map.
9988 Scan from indec.end until we find a bound suffix. */
9989 while (indec
.end
< t
)
9991 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9994 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9995 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
10000 mock_input
= diff
+ max (t
, mock_input
);
10001 goto replay_sequence
;
10005 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
10006 && indec
.start
>= t
)
10007 /* There is a binding and it's not a prefix.
10008 (and it doesn't have any input-decode-map translation pending).
10009 There is thus no function-key in this sequence.
10010 Moving fkey.start is important in this case to allow keytran.start
10011 to go over the sequence before we return (since we keep the
10012 invariant that keytran.end <= fkey.start). */
10014 if (fkey
.start
< t
)
10015 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10018 /* If the sequence is unbound, see if we can hang a function key
10019 off the end of it. */
10020 /* Continue scan from fkey.end until we find a bound suffix. */
10021 while (fkey
.end
< indec
.start
)
10023 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10026 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10027 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10028 max (t
, mock_input
),
10029 /* If there's a binding (i.e.
10030 first_binding >= nmaps) we don't want
10031 to apply this function-key-mapping. */
10032 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10037 mock_input
= diff
+ max (t
, mock_input
);
10038 /* Adjust the input-decode-map counters. */
10040 indec
.start
+= diff
;
10042 goto replay_sequence
;
10046 /* Look for this sequence in key-translation-map.
10047 Scan from keytran.end until we find a bound suffix. */
10048 while (keytran
.end
< fkey
.start
)
10050 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10053 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10054 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10059 mock_input
= diff
+ max (t
, mock_input
);
10060 /* Adjust the function-key-map and input-decode-map counters. */
10062 indec
.start
+= diff
;
10064 fkey
.start
+= diff
;
10066 goto replay_sequence
;
10070 /* If KEY is not defined in any of the keymaps,
10071 and cannot be part of a function key or translation,
10072 and is an upper case letter
10073 use the corresponding lower-case letter instead. */
10074 if (first_binding
>= nmaps
10075 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10077 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10078 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10079 || (XINT (key
) & shift_modifier
)))
10081 Lisp_Object new_key
;
10083 original_uppercase
= key
;
10084 original_uppercase_position
= t
- 1;
10086 if (XINT (key
) & shift_modifier
)
10087 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10089 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10090 | (XINT (key
) & ~CHAR_MODIFIER_MASK
)));
10092 /* We have to do this unconditionally, regardless of whether
10093 the lower-case char is defined in the keymaps, because they
10094 might get translated through function-key-map. */
10095 keybuf
[t
- 1] = new_key
;
10096 mock_input
= max (t
, mock_input
);
10098 goto replay_sequence
;
10100 /* If KEY is not defined in any of the keymaps,
10101 and cannot be part of a function key or translation,
10102 and is a shifted function key,
10103 use the corresponding unshifted function key instead. */
10104 if (first_binding
>= nmaps
10105 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10108 Lisp_Object breakdown
;
10111 breakdown
= parse_modifiers (key
);
10112 modifiers
= XINT (XCAR (XCDR (breakdown
)));
10113 if (modifiers
& shift_modifier
)
10115 Lisp_Object new_key
;
10117 original_uppercase
= key
;
10118 original_uppercase_position
= t
- 1;
10120 modifiers
&= ~shift_modifier
;
10121 new_key
= apply_modifiers (modifiers
,
10124 keybuf
[t
- 1] = new_key
;
10125 mock_input
= max (t
, mock_input
);
10126 goto replay_sequence
;
10132 read_key_sequence_cmd
= (first_binding
< nmaps
10133 ? defs
[first_binding
]
10136 unread_switch_frame
= delayed_switch_frame
;
10137 unbind_to (count
, Qnil
);
10139 /* Don't downcase the last character if the caller says don't.
10140 Don't downcase it if the result is undefined, either. */
10141 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10143 && t
- 1 == original_uppercase_position
)
10144 keybuf
[t
- 1] = original_uppercase
;
10146 /* Occasionally we fabricate events, perhaps by expanding something
10147 according to function-key-map, or by adding a prefix symbol to a
10148 mouse click in the scroll bar or modeline. In this cases, return
10149 the entire generated key sequence, even if we hit an unbound
10150 prefix or a definition before the end. This means that you will
10151 be able to push back the event properly, and also means that
10152 read-key-sequence will always return a logical unit.
10155 for (; t
< mock_input
; t
++)
10157 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10158 && NILP (Fzerop (Vecho_keystrokes
)))
10159 echo_char (keybuf
[t
]);
10160 add_command_key (keybuf
[t
]);
10169 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10170 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10171 The sequence is sufficient to specify a non-prefix command in the
10172 current local and global maps.
10174 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10175 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10176 as a continuation of the previous key.
10178 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10179 convert the last event to lower case. (Normally any upper case event
10180 is converted to lower case if the original event is undefined and the lower
10181 case equivalent is defined.) A non-nil value is appropriate for reading
10182 a key sequence to be defined.
10184 A C-g typed while in this function is treated like any other character,
10185 and `quit-flag' is not set.
10187 If the key sequence starts with a mouse click, then the sequence is read
10188 using the keymaps of the buffer of the window clicked in, not the buffer
10189 of the selected window as normal.
10191 `read-key-sequence' drops unbound button-down events, since you normally
10192 only care about the click or drag events which follow them. If a drag
10193 or multi-click event is unbound, but the corresponding click event would
10194 be bound, `read-key-sequence' turns the event into a click event at the
10195 drag's starting position. This means that you don't have to distinguish
10196 between click and drag, double, or triple events unless you want to.
10198 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10199 lines separating windows, and scroll bars with imaginary keys
10200 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10202 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10203 function will process a switch-frame event if the user switches frames
10204 before typing anything. If the user switches frames in the middle of a
10205 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10206 is nil, then the event will be put off until after the current key sequence.
10208 `read-key-sequence' checks `function-key-map' for function key
10209 sequences, where they wouldn't conflict with ordinary bindings. See
10210 `function-key-map' for more details.
10212 The optional fifth argument COMMAND-LOOP, if non-nil, means
10213 that this key sequence is being read by something that will
10214 read commands one after another. It should be nil if the caller
10215 will read just one key sequence. */)
10216 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10218 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10219 Lisp_Object can_return_switch_frame
, command_loop
;
10221 Lisp_Object keybuf
[30];
10223 struct gcpro gcpro1
;
10224 int count
= SPECPDL_INDEX ();
10226 if (!NILP (prompt
))
10227 CHECK_STRING (prompt
);
10230 specbind (Qinput_method_exit_on_first_char
,
10231 (NILP (command_loop
) ? Qt
: Qnil
));
10232 specbind (Qinput_method_use_echo_area
,
10233 (NILP (command_loop
) ? Qt
: Qnil
));
10235 bzero (keybuf
, sizeof keybuf
);
10236 GCPRO1 (keybuf
[0]);
10237 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10239 if (NILP (continue_echo
))
10241 this_command_key_count
= 0;
10242 this_command_key_count_reset
= 0;
10243 this_single_command_key_start
= 0;
10246 #ifdef HAVE_X_WINDOWS
10247 if (display_hourglass_p
)
10248 cancel_hourglass ();
10251 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10252 prompt
, ! NILP (dont_downcase_last
),
10253 ! NILP (can_return_switch_frame
), 0);
10255 #if 0 /* The following is fine for code reading a key sequence and
10256 then proceeding with a lenghty computation, but it's not good
10257 for code reading keys in a loop, like an input method. */
10258 #ifdef HAVE_X_WINDOWS
10259 if (display_hourglass_p
)
10260 start_hourglass ();
10270 return unbind_to (count
, make_event_array (i
, keybuf
));
10273 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10274 Sread_key_sequence_vector
, 1, 5, 0,
10275 doc
: /* Like `read-key-sequence' but always return a vector. */)
10276 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10278 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10279 Lisp_Object can_return_switch_frame
, command_loop
;
10281 Lisp_Object keybuf
[30];
10283 struct gcpro gcpro1
;
10284 int count
= SPECPDL_INDEX ();
10286 if (!NILP (prompt
))
10287 CHECK_STRING (prompt
);
10290 specbind (Qinput_method_exit_on_first_char
,
10291 (NILP (command_loop
) ? Qt
: Qnil
));
10292 specbind (Qinput_method_use_echo_area
,
10293 (NILP (command_loop
) ? Qt
: Qnil
));
10295 bzero (keybuf
, sizeof keybuf
);
10296 GCPRO1 (keybuf
[0]);
10297 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10299 if (NILP (continue_echo
))
10301 this_command_key_count
= 0;
10302 this_command_key_count_reset
= 0;
10303 this_single_command_key_start
= 0;
10306 #ifdef HAVE_X_WINDOWS
10307 if (display_hourglass_p
)
10308 cancel_hourglass ();
10311 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10312 prompt
, ! NILP (dont_downcase_last
),
10313 ! NILP (can_return_switch_frame
), 0);
10315 #ifdef HAVE_X_WINDOWS
10316 if (display_hourglass_p
)
10317 start_hourglass ();
10326 return unbind_to (count
, Fvector (i
, keybuf
));
10329 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10330 doc
: /* Execute CMD as an editor command.
10331 CMD must be a symbol that satisfies the `commandp' predicate.
10332 Optional second arg RECORD-FLAG non-nil
10333 means unconditionally put this command in `command-history'.
10334 Otherwise, that is done only if an arg is read using the minibuffer.
10335 The argument KEYS specifies the value to use instead of (this-command-keys)
10336 when reading the arguments; if it is nil, (this-command-keys) is used.
10337 The argument SPECIAL, if non-nil, means that this command is executing
10338 a special event, so ignore the prefix argument and don't clear it. */)
10339 (cmd
, record_flag
, keys
, special
)
10340 Lisp_Object cmd
, record_flag
, keys
, special
;
10342 register Lisp_Object final
;
10343 register Lisp_Object tem
;
10344 Lisp_Object prefixarg
;
10345 struct backtrace backtrace
;
10346 extern int debug_on_next_call
;
10348 debug_on_next_call
= 0;
10350 if (NILP (special
))
10352 prefixarg
= current_kboard
->Vprefix_arg
;
10353 Vcurrent_prefix_arg
= prefixarg
;
10354 current_kboard
->Vprefix_arg
= Qnil
;
10361 tem
= Fget (cmd
, Qdisabled
);
10362 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10364 tem
= Fsymbol_value (Qdisabled_command_function
);
10366 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10372 final
= Findirect_function (cmd
, Qnil
);
10374 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10376 struct gcpro gcpro1
, gcpro2
;
10378 GCPRO2 (cmd
, prefixarg
);
10379 do_autoload (final
, cmd
);
10386 if (STRINGP (final
) || VECTORP (final
))
10388 /* If requested, place the macro in the command history. For
10389 other sorts of commands, call-interactively takes care of
10391 if (!NILP (record_flag
))
10394 = Fcons (Fcons (Qexecute_kbd_macro
,
10395 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10398 /* Don't keep command history around forever. */
10399 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10401 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10403 XSETCDR (tem
, Qnil
);
10407 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10410 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10412 backtrace
.next
= backtrace_list
;
10413 backtrace_list
= &backtrace
;
10414 backtrace
.function
= &Qcall_interactively
;
10415 backtrace
.args
= &cmd
;
10416 backtrace
.nargs
= 1;
10417 backtrace
.evalargs
= 0;
10418 backtrace
.debug_on_exit
= 0;
10420 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
10422 backtrace_list
= backtrace
.next
;
10430 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10432 doc
: /* Read function name, then read its arguments and call it.
10434 To pass a numeric argument to the command you are invoking with, specify
10435 the numeric argument to this command.
10437 Noninteractively, the argument PREFIXARG is the prefix argument to
10438 give to the command you invoke, if it asks for an argument. */)
10440 Lisp_Object prefixarg
;
10442 Lisp_Object function
;
10444 int saved_last_point_position
;
10445 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10446 Lisp_Object bindings
, value
;
10447 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10448 #ifdef HAVE_X_WINDOWS
10449 /* The call to Fcompleting_read wil start and cancel the hourglass,
10450 but if the hourglass was already scheduled, this means that no
10451 hourglass will be shown for the actual M-x command itself.
10452 So we restart it if it is already scheduled. Note that checking
10453 hourglass_shown_p is not enough, normally the hourglass is not shown,
10454 just scheduled to be shown. */
10455 int hstarted
= hourglass_started ();
10458 saved_keys
= Fvector (this_command_key_count
,
10459 XVECTOR (this_command_keys
)->contents
);
10460 saved_last_point_position_buffer
= last_point_position_buffer
;
10461 saved_last_point_position
= last_point_position
;
10463 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10465 if (EQ (prefixarg
, Qminus
))
10466 strcpy (buf
, "- ");
10467 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10468 strcpy (buf
, "C-u ");
10469 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10470 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10471 else if (INTEGERP (prefixarg
))
10472 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10474 /* This isn't strictly correct if execute-extended-command
10475 is bound to anything else. Perhaps it should use
10476 this_command_keys? */
10477 strcat (buf
, "M-x ");
10479 /* Prompt with buf, and then read a string, completing from and
10480 restricting to the set of all defined commands. Don't provide
10481 any initial input. Save the command read on the extended-command
10483 function
= Fcompleting_read (build_string (buf
),
10484 Vobarray
, Qcommandp
,
10485 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10488 #ifdef HAVE_X_WINDOWS
10489 if (hstarted
) start_hourglass ();
10492 if (STRINGP (function
) && SCHARS (function
) == 0)
10493 error ("No command name given");
10495 /* Set this_command_keys to the concatenation of saved_keys and
10496 function, followed by a RET. */
10501 this_command_key_count
= 0;
10502 this_command_key_count_reset
= 0;
10503 this_single_command_key_start
= 0;
10505 keys
= XVECTOR (saved_keys
)->contents
;
10506 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10507 add_command_key (keys
[i
]);
10509 for (i
= 0; i
< SCHARS (function
); i
++)
10510 add_command_key (Faref (function
, make_number (i
)));
10512 add_command_key (make_number ('\015'));
10515 last_point_position
= saved_last_point_position
;
10516 last_point_position_buffer
= saved_last_point_position_buffer
;
10520 function
= Fintern (function
, Qnil
);
10521 current_kboard
->Vprefix_arg
= prefixarg
;
10522 Vthis_command
= function
;
10523 real_this_command
= function
;
10525 /* If enabled, show which key runs this command. */
10526 if (!NILP (Vsuggest_key_bindings
)
10527 && NILP (Vexecuting_kbd_macro
)
10528 && SYMBOLP (function
))
10529 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10535 GCPRO2 (bindings
, value
);
10536 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10538 /* If the command has a key binding, print it now. */
10539 if (!NILP (bindings
)
10540 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10543 /* But first wait, and skip the message if there is input. */
10544 Lisp_Object waited
;
10546 /* If this command displayed something in the echo area;
10547 wait a few seconds, then display our suggestion message. */
10548 if (NILP (echo_area_buffer
[0]))
10549 waited
= sit_for (make_number (0), 0, 2);
10550 else if (NUMBERP (Vsuggest_key_bindings
))
10551 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10553 waited
= sit_for (make_number (2), 0, 2);
10555 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10557 Lisp_Object binding
;
10559 int message_p
= push_message ();
10560 int count
= SPECPDL_INDEX ();
10562 record_unwind_protect (pop_message_unwind
, Qnil
);
10563 binding
= Fkey_description (bindings
, Qnil
);
10566 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10569 sprintf (newmessage
, "You can run the command `%s' with %s",
10570 SDATA (SYMBOL_NAME (function
)),
10572 message2_nolog (newmessage
,
10573 strlen (newmessage
),
10574 STRING_MULTIBYTE (binding
));
10575 if (NUMBERP (Vsuggest_key_bindings
))
10576 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10578 waited
= sit_for (make_number (2), 0, 2);
10580 if (!NILP (waited
) && message_p
)
10581 restore_message ();
10583 unbind_to (count
, Qnil
);
10587 RETURN_UNGCPRO (value
);
10591 /* Return nonzero if input events are pending. */
10594 detect_input_pending ()
10596 if (!input_pending
)
10597 get_input_pending (&input_pending
, 0);
10599 return input_pending
;
10602 /* Return nonzero if input events other than mouse movements are
10606 detect_input_pending_ignore_squeezables ()
10608 if (!input_pending
)
10609 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10611 return input_pending
;
10614 /* Return nonzero if input events are pending, and run any pending timers. */
10617 detect_input_pending_run_timers (do_display
)
10620 int old_timers_run
= timers_run
;
10622 if (!input_pending
)
10623 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10625 if (old_timers_run
!= timers_run
&& do_display
)
10627 redisplay_preserve_echo_area (8);
10628 /* The following fixes a bug when using lazy-lock with
10629 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10630 from an idle timer function. The symptom of the bug is that
10631 the cursor sometimes doesn't become visible until the next X
10632 event is processed. --gerd. */
10634 Lisp_Object tail
, frame
;
10635 FOR_EACH_FRAME (tail
, frame
)
10636 if (FRAME_RIF (XFRAME (frame
)))
10637 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10641 return input_pending
;
10644 /* This is called in some cases before a possible quit.
10645 It cases the next call to detect_input_pending to recompute input_pending.
10646 So calling this function unnecessarily can't do any harm. */
10649 clear_input_pending ()
10654 /* Return nonzero if there are pending requeued events.
10655 This isn't used yet. The hope is to make wait_reading_process_output
10656 call it, and return if it runs Lisp code that unreads something.
10657 The problem is, kbd_buffer_get_event needs to be fixed to know what
10658 to do in that case. It isn't trivial. */
10661 requeued_events_pending_p ()
10663 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10667 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10668 doc
: /* Return t if command input is currently available with no wait.
10669 Actually, the value is nil only if we can be sure that no input is available;
10670 if there is a doubt, the value is t. */)
10673 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10674 || !NILP (Vunread_post_input_method_events
)
10675 || !NILP (Vunread_input_method_events
))
10678 get_input_pending (&input_pending
,
10679 READABLE_EVENTS_DO_TIMERS_NOW
10680 | READABLE_EVENTS_FILTER_EVENTS
);
10681 return input_pending
> 0 ? Qt
: Qnil
;
10684 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10685 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10688 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10691 if (total_keys
< NUM_RECENT_KEYS
)
10692 return Fvector (total_keys
, keys
);
10695 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10696 bcopy (keys
+ recent_keys_index
,
10697 XVECTOR (val
)->contents
,
10698 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10700 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10701 recent_keys_index
* sizeof (Lisp_Object
));
10706 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10707 doc
: /* Return the key sequence that invoked this command.
10708 However, if the command has called `read-key-sequence', it returns
10709 the last key sequence that has been read.
10710 The value is a string or a vector.
10712 See also `this-command-keys-vector'. */)
10715 return make_event_array (this_command_key_count
,
10716 XVECTOR (this_command_keys
)->contents
);
10719 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10720 doc
: /* Return the key sequence that invoked this command, as a vector.
10721 However, if the command has called `read-key-sequence', it returns
10722 the last key sequence that has been read.
10724 See also `this-command-keys'. */)
10727 return Fvector (this_command_key_count
,
10728 XVECTOR (this_command_keys
)->contents
);
10731 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10732 Sthis_single_command_keys
, 0, 0, 0,
10733 doc
: /* Return the key sequence that invoked this command.
10734 More generally, it returns the last key sequence read, either by
10735 the command loop or by `read-key-sequence'.
10736 Unlike `this-command-keys', this function's value
10737 does not include prefix arguments.
10738 The value is always a vector. */)
10741 return Fvector (this_command_key_count
10742 - this_single_command_key_start
,
10743 (XVECTOR (this_command_keys
)->contents
10744 + this_single_command_key_start
));
10747 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10748 Sthis_single_command_raw_keys
, 0, 0, 0,
10749 doc
: /* Return the raw events that were read for this command.
10750 More generally, it returns the last key sequence read, either by
10751 the command loop or by `read-key-sequence'.
10752 Unlike `this-single-command-keys', this function's value
10753 shows the events before all translations (except for input methods).
10754 The value is always a vector. */)
10757 return Fvector (raw_keybuf_count
,
10758 (XVECTOR (raw_keybuf
)->contents
));
10761 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10762 Sreset_this_command_lengths
, 0, 0, 0,
10763 doc
: /* Make the unread events replace the last command and echo.
10764 Used in `universal-argument-other-key'.
10766 `universal-argument-other-key' rereads the event just typed.
10767 It then gets translated through `function-key-map'.
10768 The translated event has to replace the real events,
10769 both in the value of (this-command-keys) and in echoing.
10770 To achieve this, `universal-argument-other-key' calls
10771 `reset-this-command-lengths', which discards the record of reading
10772 these events the first time. */)
10775 this_command_key_count
= before_command_key_count
;
10776 if (this_command_key_count
< this_single_command_key_start
)
10777 this_single_command_key_start
= this_command_key_count
;
10779 echo_truncate (before_command_echo_length
);
10781 /* Cause whatever we put into unread-command-events
10782 to echo as if it were being freshly read from the keyboard. */
10783 this_command_key_count_reset
= 1;
10788 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10789 Sclear_this_command_keys
, 0, 1, 0,
10790 doc
: /* Clear out the vector that `this-command-keys' returns.
10791 Also clear the record of the last 100 events, unless optional arg
10792 KEEP-RECORD is non-nil. */)
10794 Lisp_Object keep_record
;
10798 this_command_key_count
= 0;
10799 this_command_key_count_reset
= 0;
10801 if (NILP (keep_record
))
10803 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10804 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10806 recent_keys_index
= 0;
10811 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10812 doc
: /* Return the current depth in recursive edits. */)
10816 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10820 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10821 "FOpen dribble file: ",
10822 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10823 If FILE is nil, close any open dribble file. */)
10836 file
= Fexpand_file_name (file
, Qnil
);
10837 dribble
= fopen (SDATA (file
), "w");
10839 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10844 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10845 doc
: /* Discard the contents of the terminal input buffer.
10846 Also end any kbd macro being defined. */)
10849 if (!NILP (current_kboard
->defining_kbd_macro
))
10851 /* Discard the last command from the macro. */
10852 Fcancel_kbd_macro_events ();
10856 update_mode_lines
++;
10858 Vunread_command_events
= Qnil
;
10859 unread_command_char
= -1;
10861 discard_tty_input ();
10863 kbd_fetch_ptr
= kbd_store_ptr
;
10869 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10870 doc
: /* Stop Emacs and return to superior process. You can resume later.
10871 If `cannot-suspend' is non-nil, or if the system doesn't support job
10872 control, run a subshell instead.
10874 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10875 to be read as terminal input by Emacs's parent, after suspension.
10877 Before suspending, run the normal hook `suspend-hook'.
10878 After resumption run the normal hook `suspend-resume-hook'.
10880 Some operating systems cannot stop the Emacs process and resume it later.
10881 On such systems, Emacs starts a subshell instead of suspending. */)
10883 Lisp_Object stuffstring
;
10885 int count
= SPECPDL_INDEX ();
10886 int old_height
, old_width
;
10888 struct gcpro gcpro1
;
10890 if (tty_list
&& tty_list
->next
)
10891 error ("There are other tty frames open; close them before suspending Emacs");
10893 if (!NILP (stuffstring
))
10894 CHECK_STRING (stuffstring
);
10896 /* Run the functions in suspend-hook. */
10897 if (!NILP (Vrun_hooks
))
10898 call1 (Vrun_hooks
, intern ("suspend-hook"));
10900 GCPRO1 (stuffstring
);
10901 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10902 reset_all_sys_modes ();
10903 /* sys_suspend can get an error if it tries to fork a subshell
10904 and the system resources aren't available for that. */
10905 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10907 stuff_buffered_input (stuffstring
);
10908 if (cannot_suspend
)
10912 unbind_to (count
, Qnil
);
10914 /* Check if terminal/window size has changed.
10915 Note that this is not useful when we are running directly
10916 with a window system; but suspend should be disabled in that case. */
10917 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10918 if (width
!= old_width
|| height
!= old_height
)
10919 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10921 /* Run suspend-resume-hook. */
10922 if (!NILP (Vrun_hooks
))
10923 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10929 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10930 Then in any case stuff anything Emacs has read ahead and not used. */
10933 stuff_buffered_input (stuffstring
)
10934 Lisp_Object stuffstring
;
10936 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10937 register unsigned char *p
;
10939 if (STRINGP (stuffstring
))
10941 register int count
;
10943 p
= SDATA (stuffstring
);
10944 count
= SBYTES (stuffstring
);
10945 while (count
-- > 0)
10950 /* Anything we have read ahead, put back for the shell to read. */
10951 /* ?? What should this do when we have multiple keyboards??
10952 Should we ignore anything that was typed in at the "wrong" kboard?
10954 rms: we should stuff everything back into the kboard
10956 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10959 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10960 kbd_fetch_ptr
= kbd_buffer
;
10961 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10962 stuff_char (kbd_fetch_ptr
->code
);
10964 clear_event (kbd_fetch_ptr
);
10968 #endif /* SIGTSTP */
10972 set_waiting_for_input (time_to_clear
)
10973 EMACS_TIME
*time_to_clear
;
10975 input_available_clear_time
= time_to_clear
;
10977 /* Tell handle_interrupt to throw back to read_char, */
10978 waiting_for_input
= 1;
10980 /* If handle_interrupt was called before and buffered a C-g,
10981 make it run again now, to avoid timing error. */
10982 if (!NILP (Vquit_flag
))
10983 quit_throw_to_read_char ();
10987 clear_waiting_for_input ()
10989 /* Tell handle_interrupt not to throw back to read_char, */
10990 waiting_for_input
= 0;
10991 input_available_clear_time
= 0;
10994 /* The SIGINT handler.
10996 If we have a frame on the controlling tty, we assume that the
10997 SIGINT was generated by C-g, so we call handle_interrupt.
10998 Otherwise, the handler kills Emacs. */
11001 interrupt_signal (signalnum
) /* If we don't have an argument, */
11002 int signalnum
; /* some compilers complain in signal calls. */
11004 /* Must preserve main program's value of errno. */
11005 int old_errno
= errno
;
11006 struct terminal
*terminal
;
11008 #if defined (USG) && !defined (POSIX_SIGNALS)
11009 /* USG systems forget handlers when they are used;
11010 must reestablish each time */
11011 signal (SIGINT
, interrupt_signal
);
11012 signal (SIGQUIT
, interrupt_signal
);
11015 SIGNAL_THREAD_CHECK (signalnum
);
11017 /* See if we have an active terminal on our controlling tty. */
11018 terminal
= get_named_tty ("/dev/tty");
11021 /* If there are no frames there, let's pretend that we are a
11022 well-behaving UN*X program and quit. */
11023 Fkill_emacs (Qnil
);
11027 /* Otherwise, the SIGINT was probably generated by C-g. */
11029 /* Set internal_last_event_frame to the top frame of the
11030 controlling tty, if we have a frame there. We disable the
11031 interrupt key on secondary ttys, so the SIGINT must have come
11032 from the controlling tty. */
11033 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11035 handle_interrupt ();
11041 /* This routine is called at interrupt level in response to C-g.
11043 It is called from the SIGINT handler or kbd_buffer_store_event.
11045 If `waiting_for_input' is non zero, then unless `echoing' is
11046 nonzero, immediately throw back to read_char.
11048 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11049 eval to throw, when it gets a chance. If quit-flag is already
11050 non-nil, it stops the job right away. */
11053 handle_interrupt ()
11059 /* XXX This code needs to be revised for multi-tty support. */
11060 if (!NILP (Vquit_flag
)
11062 && get_named_tty ("/dev/tty")
11066 /* If SIGINT isn't blocked, don't let us be interrupted by
11067 another SIGINT, it might be harmful due to non-reentrancy
11068 in I/O functions. */
11069 sigblock (sigmask (SIGINT
));
11072 reset_all_sys_modes ();
11074 #ifdef SIGTSTP /* Support possible in later USG versions */
11076 * On systems which can suspend the current process and return to the original
11077 * shell, this command causes the user to end up back at the shell.
11078 * The "Auto-save" and "Abort" questions are not asked until
11079 * the user elects to return to emacs, at which point he can save the current
11080 * job and either dump core or continue.
11085 if (sys_suspend () == -1)
11087 printf ("Not running as a subprocess;\n");
11088 printf ("you can continue or abort.\n");
11090 #else /* not VMS */
11091 /* Perhaps should really fork an inferior shell?
11092 But that would not provide any way to get back
11093 to the original shell, ever. */
11094 printf ("No support for stopping a process on this operating system;\n");
11095 printf ("you can continue or abort.\n");
11096 #endif /* not VMS */
11097 #endif /* not SIGTSTP */
11099 /* We must remain inside the screen area when the internal terminal
11100 is used. Note that [Enter] is not echoed by dos. */
11103 /* It doesn't work to autosave while GC is in progress;
11104 the code used for auto-saving doesn't cope with the mark bit. */
11105 if (!gc_in_progress
)
11107 printf ("Auto-save? (y or n) ");
11109 if (((c
= getchar ()) & ~040) == 'Y')
11111 Fdo_auto_save (Qt
, Qnil
);
11113 printf ("\r\nAuto-save done");
11114 #else /* not MSDOS */
11115 printf ("Auto-save done\n");
11116 #endif /* not MSDOS */
11118 while (c
!= '\n') c
= getchar ();
11122 /* During GC, it must be safe to reenable quitting again. */
11123 Vinhibit_quit
= Qnil
;
11126 #endif /* not MSDOS */
11127 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11128 printf ("but will instead do a real quit after garbage collection ends\r\n");
11133 printf ("\r\nAbort? (y or n) ");
11134 #else /* not MSDOS */
11136 printf ("Abort (and enter debugger)? (y or n) ");
11137 #else /* not VMS */
11138 printf ("Abort (and dump core)? (y or n) ");
11139 #endif /* not VMS */
11140 #endif /* not MSDOS */
11142 if (((c
= getchar ()) & ~040) == 'Y')
11144 while (c
!= '\n') c
= getchar ();
11146 printf ("\r\nContinuing...\r\n");
11147 #else /* not MSDOS */
11148 printf ("Continuing...\n");
11149 #endif /* not MSDOS */
11151 init_all_sys_modes ();
11156 /* If executing a function that wants to be interrupted out of
11157 and the user has not deferred quitting by binding `inhibit-quit'
11158 then quit right away. */
11159 if (immediate_quit
&& NILP (Vinhibit_quit
))
11161 struct gl_state_s saved
;
11162 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11164 immediate_quit
= 0;
11167 GCPRO4 (saved
.object
, saved
.global_code
,
11168 saved
.current_syntax_table
, saved
.old_prop
);
11169 Fsignal (Qquit
, Qnil
);
11174 /* Else request quit when it's safe */
11178 if (waiting_for_input
&& !echoing
)
11179 quit_throw_to_read_char ();
11182 /* Handle a C-g by making read_char return C-g. */
11185 quit_throw_to_read_char ()
11188 /* Prevent another signal from doing this before we finish. */
11189 clear_waiting_for_input ();
11192 Vunread_command_events
= Qnil
;
11193 unread_command_char
= -1;
11195 #if 0 /* Currently, sit_for is called from read_char without turning
11196 off polling. And that can call set_waiting_for_input.
11197 It seems to be harmless. */
11198 #ifdef POLL_FOR_INPUT
11199 /* May be > 1 if in recursive minibuffer. */
11200 if (poll_suppress_count
== 0)
11204 if (FRAMEP (internal_last_event_frame
)
11205 && !EQ (internal_last_event_frame
, selected_frame
))
11206 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11209 _longjmp (getcjmp
, 1);
11212 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11213 doc
: /* Set interrupt mode of reading keyboard input.
11214 If INTERRUPT is non-nil, Emacs will use input interrupts;
11215 otherwise Emacs uses CBREAK mode.
11217 See also `current-input-mode'. */)
11219 Lisp_Object interrupt
;
11221 int new_interrupt_input
;
11223 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11224 #ifdef HAVE_X_WINDOWS
11225 if (x_display_list
!= NULL
)
11227 /* When using X, don't give the user a real choice,
11228 because we haven't implemented the mechanisms to support it. */
11229 #ifdef NO_SOCK_SIGIO
11230 new_interrupt_input
= 0;
11231 #else /* not NO_SOCK_SIGIO */
11232 new_interrupt_input
= 1;
11233 #endif /* NO_SOCK_SIGIO */
11237 new_interrupt_input
= !NILP (interrupt
);
11238 #else /* not SIGIO */
11239 new_interrupt_input
= 0;
11240 #endif /* not SIGIO */
11242 /* Our VMS input only works by interrupts, as of now. */
11244 new_interrupt_input
= 1;
11247 if (new_interrupt_input
!= interrupt_input
)
11249 #ifdef POLL_FOR_INPUT
11253 /* this causes startup screen to be restored and messes with the mouse */
11254 reset_all_sys_modes ();
11256 interrupt_input
= new_interrupt_input
;
11258 init_all_sys_modes ();
11261 #ifdef POLL_FOR_INPUT
11262 poll_suppress_count
= 1;
11269 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11270 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11271 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11272 C-q in key sequences.
11274 This setting only has an effect on tty terminals and only when
11275 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11277 See also `current-input-mode'. */)
11279 Lisp_Object flow
, terminal
;
11281 struct terminal
*t
= get_terminal (terminal
, 1);
11282 struct tty_display_info
*tty
;
11283 if (t
== NULL
|| t
->type
!= output_termcap
)
11285 tty
= t
->display_info
.tty
;
11287 if (tty
->flow_control
!= !NILP (flow
))
11290 /* this causes startup screen to be restored and messes with the mouse */
11291 reset_sys_modes (tty
);
11294 tty
->flow_control
= !NILP (flow
);
11297 init_sys_modes (tty
);
11303 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11304 doc
: /* Enable or disable 8-bit input on TERMINAL.
11305 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11306 bit as the Meta modifier.
11308 If META is nil, Emacs will ignore the top bit, on the assumption it is
11311 Otherwise, Emacs will accept and pass through 8-bit input without
11312 specially interpreting the top bit.
11314 This setting only has an effect on tty terminal devices.
11316 Optional parameter TERMINAL specifies the tty terminal device to use.
11317 It may be a terminal id, a frame, or nil for the terminal used by the
11318 currently selected frame.
11320 See also `current-input-mode'. */)
11322 Lisp_Object meta
, terminal
;
11324 struct terminal
*t
= get_terminal (terminal
, 1);
11325 struct tty_display_info
*tty
;
11328 if (t
== NULL
|| t
->type
!= output_termcap
)
11330 tty
= t
->display_info
.tty
;
11334 else if (EQ (meta
, Qt
))
11339 if (tty
->meta_key
!= new_meta
)
11342 /* this causes startup screen to be restored and messes with the mouse */
11343 reset_sys_modes (tty
);
11346 tty
->meta_key
= new_meta
;
11349 init_sys_modes (tty
);
11355 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11356 doc
: /* Specify character used for quitting.
11357 QUIT must be an ASCII character.
11359 This function only has an effect on the controlling tty of the Emacs
11362 See also `current-input-mode'. */)
11366 struct terminal
*t
= get_named_tty ("/dev/tty");
11367 struct tty_display_info
*tty
;
11368 if (t
== NULL
|| t
->type
!= output_termcap
)
11370 tty
= t
->display_info
.tty
;
11372 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11373 error ("QUIT must be an ASCII character");
11376 /* this causes startup screen to be restored and messes with the mouse */
11377 reset_sys_modes (tty
);
11380 /* Don't let this value be out of range. */
11381 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11384 init_sys_modes (tty
);
11390 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11391 doc
: /* Set mode of reading keyboard input.
11392 First arg INTERRUPT non-nil means use input interrupts;
11393 nil means use CBREAK mode.
11394 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11395 (no effect except in CBREAK mode).
11396 Third arg META t means accept 8-bit input (for a Meta key).
11397 META nil means ignore the top bit, on the assumption it is parity.
11398 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11399 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11400 See also `current-input-mode'. */)
11401 (interrupt
, flow
, meta
, quit
)
11402 Lisp_Object interrupt
, flow
, meta
, quit
;
11404 Fset_input_interrupt_mode (interrupt
);
11405 Fset_output_flow_control (flow
, Qnil
);
11406 Fset_input_meta_mode (meta
, Qnil
);
11408 Fset_quit_char (quit
);
11412 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11413 doc
: /* Return information about the way Emacs currently reads keyboard input.
11414 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11415 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11416 nil, Emacs is using CBREAK mode.
11417 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11418 terminal; this does not apply if Emacs uses interrupt-driven input.
11419 META is t if accepting 8-bit input with 8th bit as Meta flag.
11420 META nil means ignoring the top bit, on the assumption it is parity.
11421 META is neither t nor nil if accepting 8-bit input and using
11422 all 8 bits as the character code.
11423 QUIT is the character Emacs currently uses to quit.
11424 The elements of this list correspond to the arguments of
11425 `set-input-mode'. */)
11428 Lisp_Object val
[4];
11429 struct frame
*sf
= XFRAME (selected_frame
);
11431 val
[0] = interrupt_input
? Qt
: Qnil
;
11432 if (FRAME_TERMCAP_P (sf
))
11434 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11435 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11437 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11444 XSETFASTINT (val
[3], quit_char
);
11446 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11449 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11450 doc
: /* Return position information for pixel coordinates X and Y.
11451 By default, X and Y are relative to text area of the selected window.
11452 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11453 If optional fourth arg WHOLE is non-nil, X is relative to the left
11454 edge of the window.
11456 The return value is similar to a mouse click position:
11457 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11458 IMAGE (DX . DY) (WIDTH . HEIGHT))
11459 The `posn-' functions access elements of such lists. */)
11460 (x
, y
, frame_or_window
, whole
)
11461 Lisp_Object x
, y
, frame_or_window
, whole
;
11466 if (NILP (frame_or_window
))
11467 frame_or_window
= selected_window
;
11469 if (WINDOWP (frame_or_window
))
11473 CHECK_LIVE_WINDOW (frame_or_window
);
11475 w
= XWINDOW (frame_or_window
);
11476 XSETINT (x
, (XINT (x
)
11477 + WINDOW_LEFT_EDGE_X (w
)
11479 ? window_box_left_offset (w
, TEXT_AREA
)
11481 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11482 frame_or_window
= w
->frame
;
11485 CHECK_LIVE_FRAME (frame_or_window
);
11487 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11490 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11491 doc
: /* Return position information for buffer POS in WINDOW.
11492 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11494 Return nil if position is not visible in window. Otherwise,
11495 the return value is similar to that returned by `event-start' for
11496 a mouse click at the upper left corner of the glyph corresponding
11497 to the given buffer position:
11498 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11499 IMAGE (DX . DY) (WIDTH . HEIGHT))
11500 The `posn-' functions access elements of such lists. */)
11502 Lisp_Object pos
, window
;
11507 window
= selected_window
;
11509 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11512 Lisp_Object x
= XCAR (tem
);
11513 Lisp_Object y
= XCAR (XCDR (tem
));
11515 /* Point invisible due to hscrolling? */
11518 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11526 * Set up a new kboard object with reasonable initial values.
11532 kb
->Voverriding_terminal_local_map
= Qnil
;
11533 kb
->Vlast_command
= Qnil
;
11534 kb
->Vreal_last_command
= Qnil
;
11535 kb
->Vkeyboard_translate_table
= Qnil
;
11536 kb
->Vlast_repeatable_command
= Qnil
;
11537 kb
->Vprefix_arg
= Qnil
;
11538 kb
->Vlast_prefix_arg
= Qnil
;
11539 kb
->kbd_queue
= Qnil
;
11540 kb
->kbd_queue_has_data
= 0;
11541 kb
->immediate_echo
= 0;
11542 kb
->echo_string
= Qnil
;
11543 kb
->echo_after_prompt
= -1;
11544 kb
->kbd_macro_buffer
= 0;
11545 kb
->kbd_macro_bufsize
= 0;
11546 kb
->defining_kbd_macro
= Qnil
;
11547 kb
->Vlast_kbd_macro
= Qnil
;
11548 kb
->reference_count
= 0;
11549 kb
->Vsystem_key_alist
= Qnil
;
11550 kb
->system_key_syms
= Qnil
;
11551 kb
->Vwindow_system
= Qt
; /* Unset. */
11552 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11553 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11554 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11555 kb
->Vdefault_minibuffer_frame
= Qnil
;
11559 * Destroy the contents of a kboard object, but not the object itself.
11560 * We use this just before deleting it, or if we're going to initialize
11561 * it a second time.
11567 if (kb
->kbd_macro_buffer
)
11568 xfree (kb
->kbd_macro_buffer
);
11571 #ifdef MULTI_KBOARD
11573 /* Free KB and memory referenced from it. */
11581 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11584 *kbp
= kb
->next_kboard
;
11586 /* Prevent a dangling reference to KB. */
11587 if (kb
== current_kboard
11588 && FRAMEP (selected_frame
)
11589 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11591 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11593 if (current_kboard
== kb
)
11601 #endif /* MULTI_KBOARD */
11606 /* This is correct before outermost invocation of the editor loop */
11607 command_loop_level
= -1;
11608 immediate_quit
= 0;
11609 quit_char
= Ctl ('g');
11610 Vunread_command_events
= Qnil
;
11611 unread_command_char
= -1;
11612 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11614 recent_keys_index
= 0;
11615 kbd_fetch_ptr
= kbd_buffer
;
11616 kbd_store_ptr
= kbd_buffer
;
11617 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11618 do_mouse_tracking
= Qnil
;
11621 interrupt_input_blocked
= 0;
11622 interrupt_input_pending
= 0;
11624 /* This means that command_loop_1 won't try to select anything the first
11626 internal_last_event_frame
= Qnil
;
11627 Vlast_event_frame
= internal_last_event_frame
;
11629 #ifdef MULTI_KBOARD
11630 current_kboard
= initial_kboard
;
11632 /* Re-initialize the keyboard again. */
11633 wipe_kboard (current_kboard
);
11634 init_kboard (current_kboard
);
11635 /* A value of nil for Vwindow_system normally means a tty, but we also use
11636 it for the initial terminal since there is no window system there. */
11637 current_kboard
->Vwindow_system
= Qnil
;
11639 if (!noninteractive
)
11641 /* Before multi-tty support, these handlers used to be installed
11642 only if the current session was a tty session. Now an Emacs
11643 session may have multiple display types, so we always handle
11644 SIGINT. There is special code in interrupt_signal to exit
11645 Emacs on SIGINT when there are no termcap frames on the
11646 controlling terminal. */
11647 signal (SIGINT
, interrupt_signal
);
11648 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11649 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11650 SIGQUIT and we can't tell which one it will give us. */
11651 signal (SIGQUIT
, interrupt_signal
);
11652 #endif /* HAVE_TERMIO */
11654 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11656 if (!noninteractive
)
11657 signal (SIGIO
, input_available_signal
);
11660 /* Use interrupt input by default, if it works and noninterrupt input
11661 has deficiencies. */
11663 #ifdef INTERRUPT_INPUT
11664 interrupt_input
= 1;
11666 interrupt_input
= 0;
11669 /* Our VMS input only works by interrupts, as of now. */
11671 interrupt_input
= 1;
11677 if (keyboard_init_hook
)
11678 (*keyboard_init_hook
) ();
11680 #ifdef POLL_FOR_INPUT
11681 poll_suppress_count
= 1;
11686 /* This type's only use is in syms_of_keyboard, to initialize the
11687 event header symbols and put properties on them. */
11688 struct event_head
{
11694 struct event_head head_table
[] = {
11695 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11696 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11697 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11698 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11699 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11700 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11701 /* `select-window' should be handled just like `switch-frame'
11702 in read_key_sequence. */
11703 {&Qselect_window
, "select-window", &Qswitch_frame
}
11707 syms_of_keyboard ()
11709 Vpre_help_message
= Qnil
;
11710 staticpro (&Vpre_help_message
);
11712 Vlispy_mouse_stem
= build_string ("mouse");
11713 staticpro (&Vlispy_mouse_stem
);
11716 QCimage
= intern (":image");
11717 staticpro (&QCimage
);
11719 staticpro (&Qhelp_echo
);
11720 Qhelp_echo
= intern ("help-echo");
11723 Qrtl
= intern (":rtl");
11725 staticpro (&item_properties
);
11726 item_properties
= Qnil
;
11728 staticpro (&tool_bar_item_properties
);
11729 tool_bar_item_properties
= Qnil
;
11730 staticpro (&tool_bar_items_vector
);
11731 tool_bar_items_vector
= Qnil
;
11733 staticpro (&real_this_command
);
11734 real_this_command
= Qnil
;
11736 Qtimer_event_handler
= intern ("timer-event-handler");
11737 staticpro (&Qtimer_event_handler
);
11739 Qdisabled_command_function
= intern ("disabled-command-function");
11740 staticpro (&Qdisabled_command_function
);
11742 Qself_insert_command
= intern ("self-insert-command");
11743 staticpro (&Qself_insert_command
);
11745 Qforward_char
= intern ("forward-char");
11746 staticpro (&Qforward_char
);
11748 Qbackward_char
= intern ("backward-char");
11749 staticpro (&Qbackward_char
);
11751 Qdisabled
= intern ("disabled");
11752 staticpro (&Qdisabled
);
11754 Qundefined
= intern ("undefined");
11755 staticpro (&Qundefined
);
11757 Qpre_command_hook
= intern ("pre-command-hook");
11758 staticpro (&Qpre_command_hook
);
11760 Qpost_command_hook
= intern ("post-command-hook");
11761 staticpro (&Qpost_command_hook
);
11763 Qdeferred_action_function
= intern ("deferred-action-function");
11764 staticpro (&Qdeferred_action_function
);
11766 Qcommand_hook_internal
= intern ("command-hook-internal");
11767 staticpro (&Qcommand_hook_internal
);
11769 Qfunction_key
= intern ("function-key");
11770 staticpro (&Qfunction_key
);
11771 Qmouse_click
= intern ("mouse-click");
11772 staticpro (&Qmouse_click
);
11773 #if defined (WINDOWSNT) || defined (MAC_OS)
11774 Qlanguage_change
= intern ("language-change");
11775 staticpro (&Qlanguage_change
);
11777 Qdrag_n_drop
= intern ("drag-n-drop");
11778 staticpro (&Qdrag_n_drop
);
11780 Qsave_session
= intern ("save-session");
11781 staticpro (&Qsave_session
);
11784 Qmac_apple_event
= intern ("mac-apple-event");
11785 staticpro (&Qmac_apple_event
);
11788 Qmenu_enable
= intern ("menu-enable");
11789 staticpro (&Qmenu_enable
);
11790 Qmenu_alias
= intern ("menu-alias");
11791 staticpro (&Qmenu_alias
);
11792 QCenable
= intern (":enable");
11793 staticpro (&QCenable
);
11794 QCvisible
= intern (":visible");
11795 staticpro (&QCvisible
);
11796 QChelp
= intern (":help");
11797 staticpro (&QChelp
);
11798 QCfilter
= intern (":filter");
11799 staticpro (&QCfilter
);
11800 QCbutton
= intern (":button");
11801 staticpro (&QCbutton
);
11802 QCkeys
= intern (":keys");
11803 staticpro (&QCkeys
);
11804 QCkey_sequence
= intern (":key-sequence");
11805 staticpro (&QCkey_sequence
);
11806 QCtoggle
= intern (":toggle");
11807 staticpro (&QCtoggle
);
11808 QCradio
= intern (":radio");
11809 staticpro (&QCradio
);
11811 Qmode_line
= intern ("mode-line");
11812 staticpro (&Qmode_line
);
11813 Qvertical_line
= intern ("vertical-line");
11814 staticpro (&Qvertical_line
);
11815 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11816 staticpro (&Qvertical_scroll_bar
);
11817 Qmenu_bar
= intern ("menu-bar");
11818 staticpro (&Qmenu_bar
);
11820 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11821 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11822 staticpro (&Qmouse_fixup_help_message
);
11825 Qabove_handle
= intern ("above-handle");
11826 staticpro (&Qabove_handle
);
11827 Qhandle
= intern ("handle");
11828 staticpro (&Qhandle
);
11829 Qbelow_handle
= intern ("below-handle");
11830 staticpro (&Qbelow_handle
);
11831 Qup
= intern ("up");
11833 Qdown
= intern ("down");
11834 staticpro (&Qdown
);
11835 Qtop
= intern ("top");
11837 Qbottom
= intern ("bottom");
11838 staticpro (&Qbottom
);
11839 Qend_scroll
= intern ("end-scroll");
11840 staticpro (&Qend_scroll
);
11841 Qratio
= intern ("ratio");
11842 staticpro (&Qratio
);
11844 Qevent_kind
= intern ("event-kind");
11845 staticpro (&Qevent_kind
);
11846 Qevent_symbol_elements
= intern ("event-symbol-elements");
11847 staticpro (&Qevent_symbol_elements
);
11848 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11849 staticpro (&Qevent_symbol_element_mask
);
11850 Qmodifier_cache
= intern ("modifier-cache");
11851 staticpro (&Qmodifier_cache
);
11853 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11854 staticpro (&Qrecompute_lucid_menubar
);
11855 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11856 staticpro (&Qactivate_menubar_hook
);
11858 Qpolling_period
= intern ("polling-period");
11859 staticpro (&Qpolling_period
);
11861 Qinput_method_function
= intern ("input-method-function");
11862 staticpro (&Qinput_method_function
);
11864 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11865 staticpro (&Qinput_method_exit_on_first_char
);
11866 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11867 staticpro (&Qinput_method_use_echo_area
);
11869 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11870 Fset (Qinput_method_use_echo_area
, Qnil
);
11872 last_point_position_buffer
= Qnil
;
11873 last_point_position_window
= Qnil
;
11876 struct event_head
*p
;
11878 for (p
= head_table
;
11879 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11882 *p
->var
= intern (p
->name
);
11883 staticpro (p
->var
);
11884 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11885 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11889 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11890 staticpro (&button_down_location
);
11891 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11892 staticpro (&mouse_syms
);
11893 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11894 staticpro (&wheel_syms
);
11898 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11900 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11901 for (i
= 0; i
< len
; i
++)
11902 if (modifier_names
[i
])
11903 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11904 staticpro (&modifier_symbols
);
11907 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11908 staticpro (&recent_keys
);
11910 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11911 staticpro (&this_command_keys
);
11913 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11914 staticpro (&raw_keybuf
);
11916 Qextended_command_history
= intern ("extended-command-history");
11917 Fset (Qextended_command_history
, Qnil
);
11918 staticpro (&Qextended_command_history
);
11920 accent_key_syms
= Qnil
;
11921 staticpro (&accent_key_syms
);
11923 func_key_syms
= Qnil
;
11924 staticpro (&func_key_syms
);
11926 drag_n_drop_syms
= Qnil
;
11927 staticpro (&drag_n_drop_syms
);
11929 unread_switch_frame
= Qnil
;
11930 staticpro (&unread_switch_frame
);
11932 internal_last_event_frame
= Qnil
;
11933 staticpro (&internal_last_event_frame
);
11935 read_key_sequence_cmd
= Qnil
;
11936 staticpro (&read_key_sequence_cmd
);
11938 menu_bar_one_keymap_changed_items
= Qnil
;
11939 staticpro (&menu_bar_one_keymap_changed_items
);
11941 menu_bar_items_vector
= Qnil
;
11942 staticpro (&menu_bar_items_vector
);
11944 help_form_saved_window_configs
= Qnil
;
11945 staticpro (&help_form_saved_window_configs
);
11947 defsubr (&Scurrent_idle_time
);
11948 defsubr (&Sevent_convert_list
);
11949 defsubr (&Sread_key_sequence
);
11950 defsubr (&Sread_key_sequence_vector
);
11951 defsubr (&Srecursive_edit
);
11952 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11953 defsubr (&Strack_mouse
);
11955 defsubr (&Sinput_pending_p
);
11956 defsubr (&Scommand_execute
);
11957 defsubr (&Srecent_keys
);
11958 defsubr (&Sthis_command_keys
);
11959 defsubr (&Sthis_command_keys_vector
);
11960 defsubr (&Sthis_single_command_keys
);
11961 defsubr (&Sthis_single_command_raw_keys
);
11962 defsubr (&Sreset_this_command_lengths
);
11963 defsubr (&Sclear_this_command_keys
);
11964 defsubr (&Ssuspend_emacs
);
11965 defsubr (&Sabort_recursive_edit
);
11966 defsubr (&Sexit_recursive_edit
);
11967 defsubr (&Srecursion_depth
);
11968 defsubr (&Stop_level
);
11969 defsubr (&Sdiscard_input
);
11970 defsubr (&Sopen_dribble_file
);
11971 defsubr (&Sset_input_interrupt_mode
);
11972 defsubr (&Sset_output_flow_control
);
11973 defsubr (&Sset_input_meta_mode
);
11974 defsubr (&Sset_quit_char
);
11975 defsubr (&Sset_input_mode
);
11976 defsubr (&Scurrent_input_mode
);
11977 defsubr (&Sexecute_extended_command
);
11978 defsubr (&Sposn_at_point
);
11979 defsubr (&Sposn_at_x_y
);
11981 DEFVAR_LISP ("last-command-char", &last_command_char
,
11982 doc
: /* Last input event that was part of a command. */);
11984 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11985 doc
: /* Last input event that was part of a command. */);
11987 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11988 doc
: /* Last input event in a command, except for mouse menu events.
11989 Mouse menus give back keys that don't look like mouse events;
11990 this variable holds the actual mouse event that led to the menu,
11991 so that you can determine whether the command was run by mouse or not. */);
11993 DEFVAR_LISP ("last-input-char", &last_input_char
,
11994 doc
: /* Last input event. */);
11996 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11997 doc
: /* Last input event. */);
11999 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
12000 doc
: /* List of events to be read as the command input.
12001 These events are processed first, before actual keyboard input.
12002 Events read from this list are not normally added to `this-command-keys',
12003 as they will already have been added once as they were read for the first time.
12004 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12005 Vunread_command_events
= Qnil
;
12007 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12008 doc
: /* If not -1, an object to be read as next command input event. */);
12010 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12011 doc
: /* List of events to be processed as input by input methods.
12012 These events are processed before `unread-command-events'
12013 and actual keyboard input, but are not given to `input-method-function'. */);
12014 Vunread_post_input_method_events
= Qnil
;
12016 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12017 doc
: /* List of events to be processed as input by input methods.
12018 These events are processed after `unread-command-events', but
12019 before actual keyboard input.
12020 If there's an active input method, the events are given to
12021 `input-method-function'. */);
12022 Vunread_input_method_events
= Qnil
;
12024 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12025 doc
: /* Meta-prefix character code.
12026 Meta-foo as command input turns into this character followed by foo. */);
12027 XSETINT (meta_prefix_char
, 033);
12029 DEFVAR_KBOARD ("last-command", Vlast_command
,
12030 doc
: /* The last command executed.
12031 Normally a symbol with a function definition, but can be whatever was found
12032 in the keymap, or whatever the variable `this-command' was set to by that
12035 The value `mode-exit' is special; it means that the previous command
12036 read an event that told it to exit, and it did so and unread that event.
12037 In other words, the present command is the event that made the previous
12040 The value `kill-region' is special; it means that the previous command
12041 was a kill command.
12043 `last-command' has a separate binding for each terminal device.
12044 See Info node `(elisp)Multiple displays'. */);
12046 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12047 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12049 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12050 doc
: /* Last command that may be repeated.
12051 The last command executed that was not bound to an input event.
12052 This is the command `repeat' will try to repeat. */);
12054 DEFVAR_LISP ("this-command", &Vthis_command
,
12055 doc
: /* The command now being executed.
12056 The command can set this variable; whatever is put here
12057 will be in `last-command' during the following command. */);
12058 Vthis_command
= Qnil
;
12060 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12061 doc
: /* The command bound to the current key sequence before remapping.
12062 It equals `this-command' if the original command was not remapped through
12063 any of the active keymaps. Otherwise, the value of `this-command' is the
12064 result of looking up the original command in the active keymaps. */);
12065 Vthis_original_command
= Qnil
;
12067 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12068 doc
: /* *Number of input events between auto-saves.
12069 Zero means disable autosaving due to number of characters typed. */);
12070 auto_save_interval
= 300;
12072 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12073 doc
: /* *Number of seconds idle time before auto-save.
12074 Zero or nil means disable auto-saving due to idleness.
12075 After auto-saving due to this many seconds of idle time,
12076 Emacs also does a garbage collection if that seems to be warranted. */);
12077 XSETFASTINT (Vauto_save_timeout
, 30);
12079 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12080 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12081 The value may be integer or floating point. */);
12082 Vecho_keystrokes
= make_number (1);
12084 DEFVAR_INT ("polling-period", &polling_period
,
12085 doc
: /* *Interval between polling for input during Lisp execution.
12086 The reason for polling is to make C-g work to stop a running program.
12087 Polling is needed only when using X windows and SIGIO does not work.
12088 Polling is automatically disabled in all other cases. */);
12089 polling_period
= 2;
12091 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12092 doc
: /* *Maximum time between mouse clicks to make a double-click.
12093 Measured in milliseconds. The value nil means disable double-click
12094 recognition; t means double-clicks have no time limit and are detected
12095 by position only. */);
12096 Vdouble_click_time
= make_number (500);
12098 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12099 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12100 On window-system frames, value is the number of pixels the mouse may have
12101 moved horizontally or vertically between two clicks to make a double-click.
12102 On non window-system frames, value is interpreted in units of 1/8 characters
12105 This variable is also the threshold for motion of the mouse
12106 to count as a drag. */);
12107 double_click_fuzz
= 3;
12109 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12110 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12111 inhibit_local_menu_bar_menus
= 0;
12113 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12114 doc
: /* Number of complete key sequences read as input so far.
12115 This includes key sequences read from keyboard macros.
12116 The number is effectively the number of interactive command invocations. */);
12117 num_input_keys
= 0;
12119 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12120 doc
: /* Number of input events read from the keyboard so far.
12121 This does not include events generated by keyboard macros. */);
12122 num_nonmacro_input_events
= 0;
12124 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12125 doc
: /* The frame in which the most recently read event occurred.
12126 If the last event came from a keyboard macro, this is set to `macro'. */);
12127 Vlast_event_frame
= Qnil
;
12129 /* This variable is set up in sysdep.c. */
12130 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12131 doc
: /* The ERASE character as set by the user with stty. */);
12133 DEFVAR_LISP ("help-char", &Vhelp_char
,
12134 doc
: /* Character to recognize as meaning Help.
12135 When it is read, do `(eval help-form)', and display result if it's a string.
12136 If the value of `help-form' is nil, this char can be read normally. */);
12137 XSETINT (Vhelp_char
, Ctl ('H'));
12139 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12140 doc
: /* List of input events to recognize as meaning Help.
12141 These work just like the value of `help-char' (see that). */);
12142 Vhelp_event_list
= Qnil
;
12144 DEFVAR_LISP ("help-form", &Vhelp_form
,
12145 doc
: /* Form to execute when character `help-char' is read.
12146 If the form returns a string, that string is displayed.
12147 If `help-form' is nil, the help char is not recognized. */);
12150 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12151 doc
: /* Command to run when `help-char' character follows a prefix key.
12152 This command is used only when there is no actual binding
12153 for that character after that prefix key. */);
12154 Vprefix_help_command
= Qnil
;
12156 DEFVAR_LISP ("top-level", &Vtop_level
,
12157 doc
: /* Form to evaluate when Emacs starts up.
12158 Useful to set before you dump a modified Emacs. */);
12161 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12162 doc
: /* Translate table for local keyboard input, or nil.
12163 If non-nil, the value should be a char-table. Each character read
12164 from the keyboard is looked up in this char-table. If the value found
12165 there is non-nil, then it is used instead of the actual input character.
12167 The value can also be a string or vector, but this is considered obsolete.
12168 If it is a string or vector of length N, character codes N and up are left
12169 untranslated. In a vector, an element which is nil means "no translation".
12171 This is applied to the characters supplied to input methods, not their
12172 output. See also `translation-table-for-input'.
12174 This variable has a separate binding for each terminal. See Info node
12175 `(elisp)Multiple displays'. */);
12177 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12178 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12179 \(Even if the operating system has support for stopping a process.\) */);
12180 cannot_suspend
= 0;
12182 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12183 doc
: /* Non-nil means prompt with menus when appropriate.
12184 This is done when reading from a keymap that has a prompt string,
12185 for elements that have prompt strings.
12186 The menu is displayed on the screen
12187 if X menus were enabled at configuration
12188 time and the previous event was a mouse click prefix key.
12189 Otherwise, menu prompting uses the echo area. */);
12190 menu_prompting
= 1;
12192 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12193 doc
: /* Character to see next line of menu prompt.
12194 Type this character while in a menu prompt to rotate around the lines of it. */);
12195 XSETINT (menu_prompt_more_char
, ' ');
12197 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12198 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12199 Emacs applies the modifiers of the character stored here to each keyboard
12200 character it reads. For example, after evaluating the expression
12201 (setq extra-keyboard-modifiers ?\\C-x)
12202 all input characters will have the control modifier applied to them.
12204 Note that the character ?\\C-@, equivalent to the integer zero, does
12205 not count as a control character; rather, it counts as a character
12206 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12207 cancels any modification. */);
12208 extra_keyboard_modifiers
= 0;
12210 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12211 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12212 The command loop sets this to nil before each command,
12213 and tests the value when the command returns.
12214 Buffer modification stores t in this variable. */);
12215 Vdeactivate_mark
= Qnil
;
12217 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12218 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
12219 Vcommand_hook_internal
= Qnil
;
12221 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12222 doc
: /* Normal hook run before each command is executed.
12223 If an unhandled error happens in running this hook,
12224 the hook value is set to nil, since otherwise the error
12225 might happen repeatedly and make Emacs nonfunctional. */);
12226 Vpre_command_hook
= Qnil
;
12228 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12229 doc
: /* Normal hook run after each command is executed.
12230 If an unhandled error happens in running this hook,
12231 the hook value is set to nil, since otherwise the error
12232 might happen repeatedly and make Emacs nonfunctional. */);
12233 Vpost_command_hook
= Qnil
;
12236 DEFVAR_LISP ("echo-area-clear-hook", ...,
12237 doc
: /* Normal hook run when clearing the echo area. */);
12239 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12240 staticpro (&Qecho_area_clear_hook
);
12241 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12243 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12244 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12245 Vlucid_menu_bar_dirty_flag
= Qnil
;
12247 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12248 doc
: /* List of menu bar items to move to the end of the menu bar.
12249 The elements of the list are event types that may have menu bar bindings. */);
12250 Vmenu_bar_final_items
= Qnil
;
12252 DEFVAR_KBOARD ("overriding-terminal-local-map",
12253 Voverriding_terminal_local_map
,
12254 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12255 If this variable is non-nil, it is used as a keymap instead of the
12256 buffer's local map, and the minor mode keymaps and text property keymaps.
12257 It also replaces `overriding-local-map'.
12259 This variable is intended to let commands such as `universal-argument'
12260 set up a different keymap for reading the next command.
12262 `overriding-terminal-local-map' has a separate binding for each
12264 See Info node `(elisp)Multiple displays'. */);
12266 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12267 doc
: /* Keymap that overrides all other local keymaps.
12268 If this variable is non-nil, it is used as a keymap--replacing the
12269 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12270 Voverriding_local_map
= Qnil
;
12272 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12273 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12274 Otherwise, the menu bar continues to reflect the buffer's local map
12275 and the minor mode maps regardless of `overriding-local-map'. */);
12276 Voverriding_local_map_menu_flag
= Qnil
;
12278 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12279 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12280 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12282 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12283 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12285 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12286 doc
: /* Alist of system-specific X windows key symbols.
12287 Each element should have the form (N . SYMBOL) where N is the
12288 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12289 and SYMBOL is its name.
12291 `system-key-alist' has a separate binding for each terminal device.
12292 See Info node `(elisp)Multiple displays'. */);
12294 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12295 doc
: /* Keymap that translates key sequences to key sequences during input.
12296 This is used mainly for mapping key sequences into some preferred
12297 key events (symbols).
12299 The `read-key-sequence' function replaces any subsequence bound by
12300 `local-function-key-map' with its binding. More precisely, when the
12301 active keymaps have no binding for the current key sequence but
12302 `local-function-key-map' binds a suffix of the sequence to a vector or
12303 string, `read-key-sequence' replaces the matching suffix with its
12304 binding, and continues with the new sequence.
12306 If the binding is a function, it is called with one argument (the prompt)
12307 and its return value (a key sequence) is used.
12309 The events that come from bindings in `local-function-key-map' are not
12310 themselves looked up in `local-function-key-map'.
12312 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12313 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12314 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12315 typing `ESC O P x' would return [f1 x].
12317 `local-function-key-map' has a separate binding for each terminal
12318 device. See Info node `(elisp)Multiple displays'. If you need to
12319 define a binding on all terminals, change `function-key-map'
12320 instead. Initially, `local-function-key-map' is an empty keymap that
12321 has `function-key-map' as its parent on all terminal devices. */);
12323 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12324 doc
: /* Keymap that decodes input escape sequences.
12325 This is used mainly for mapping ASCII function key sequences into
12326 real Emacs function key events (symbols).
12328 The `read-key-sequence' function replaces any subsequence bound by
12329 `local-function-key-map' with its binding. Contrary to `function-key-map',
12330 this map applies its rebinding regardless of the presence of an ordinary
12331 binding. So it is more like `key-translation-map' except that it applies
12332 before `function-key-map' rather than after.
12334 If the binding is a function, it is called with one argument (the prompt)
12335 and its return value (a key sequence) is used.
12337 The events that come from bindings in `input-decode-map' are not
12338 themselves looked up in `input-decode-map'.
12340 This variable is keyboard-local. */);
12342 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12343 doc
: /* The parent keymap of all `local-function-key-map' instances.
12344 Function key definitions that apply to all terminal devices should go
12345 here. If a mapping is defined in both the current
12346 `local-function-key-map' binding and this variable, then the local
12347 definition will take precendence. */);
12348 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12350 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12351 doc
: /* Keymap of key translations that can override keymaps.
12352 This keymap works like `function-key-map', but comes after that,
12353 and its non-prefix bindings override ordinary bindings.
12354 Another difference is that it is global rather than keyboard-local. */);
12355 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12357 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12358 doc
: /* List of deferred actions to be performed at a later time.
12359 The precise format isn't relevant here; we just check whether it is nil. */);
12360 Vdeferred_action_list
= Qnil
;
12362 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12363 doc
: /* Function to call to handle deferred actions, after each command.
12364 This function is called with no arguments after each command
12365 whenever `deferred-action-list' is non-nil. */);
12366 Vdeferred_action_function
= Qnil
;
12368 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12369 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12370 The value can be a length of time to show the message for.
12371 If the value is non-nil and not a number, we wait 2 seconds. */);
12372 Vsuggest_key_bindings
= Qt
;
12374 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12375 doc
: /* List of active absolute time timers in order of increasing time. */);
12376 Vtimer_list
= Qnil
;
12378 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12379 doc
: /* List of active idle-time timers in order of increasing time. */);
12380 Vtimer_idle_list
= Qnil
;
12382 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12383 doc
: /* If non-nil, the function that implements the current input method.
12384 It's called with one argument, a printing character that was just read.
12385 \(That means a character with code 040...0176.)
12386 Typically this function uses `read-event' to read additional events.
12387 When it does so, it should first bind `input-method-function' to nil
12388 so it will not be called recursively.
12390 The function should return a list of zero or more events
12391 to be used as input. If it wants to put back some events
12392 to be reconsidered, separately, by the input method,
12393 it can add them to the beginning of `unread-command-events'.
12395 The input method function can find in `input-method-previous-method'
12396 the previous echo area message.
12398 The input method function should refer to the variables
12399 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12400 for guidance on what to do. */);
12401 Vinput_method_function
= Qnil
;
12403 DEFVAR_LISP ("input-method-previous-message",
12404 &Vinput_method_previous_message
,
12405 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12406 This variable exists because `read-event' clears the echo area
12407 before running the input method. It is nil if there was no message. */);
12408 Vinput_method_previous_message
= Qnil
;
12410 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12411 doc
: /* If non-nil, the function that implements the display of help.
12412 It's called with one argument, the help string to display. */);
12413 Vshow_help_function
= Qnil
;
12415 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12416 doc
: /* If non-nil, suppress point adjustment after executing a command.
12418 After a command is executed, if point is moved into a region that has
12419 special properties (e.g. composition, display), we adjust point to
12420 the boundary of the region. But, when a command sets this variable to
12421 non-nil, we suppress the point adjustment.
12423 This variable is set to nil before reading a command, and is checked
12424 just after executing the command. */);
12425 Vdisable_point_adjustment
= Qnil
;
12427 DEFVAR_LISP ("global-disable-point-adjustment",
12428 &Vglobal_disable_point_adjustment
,
12429 doc
: /* *If non-nil, always suppress point adjustment.
12431 The default value is nil, in which case, point adjustment are
12432 suppressed only after special commands that set
12433 `disable-point-adjustment' (which see) to non-nil. */);
12434 Vglobal_disable_point_adjustment
= Qnil
;
12436 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12437 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12438 If the value is not a number, such messages don't time out. */);
12439 Vminibuffer_message_timeout
= make_number (2);
12441 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12442 doc
: /* If non-nil, any keyboard input throws to this symbol.
12443 The value of that variable is passed to `quit-flag' and later causes a
12444 peculiar kind of quitting. */);
12445 Vthrow_on_input
= Qnil
;
12447 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12448 doc
: /* If non-nil, function to output error messages.
12449 The arguments are the error data, a list of the form
12450 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12451 such as just as `condition-case' would bind its variable to,
12452 the context (a string which normally goes at the start of the message),
12453 and the Lisp function within which the error was signaled. */);
12454 Vcommand_error_function
= Qnil
;
12456 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12457 &Venable_disabled_menus_and_buttons
,
12458 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12460 Help functions bind this to allow help on disabled menu items
12461 and tool-bar buttons. */);
12462 Venable_disabled_menus_and_buttons
= Qnil
;
12464 #ifdef MULTI_KBOARD
12465 /* Create the initial keyboard. */
12466 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12467 init_kboard (initial_kboard
);
12468 /* Vwindow_system is left at t for now. */
12469 initial_kboard
->next_kboard
= all_kboards
;
12470 all_kboards
= initial_kboard
;
12475 keys_of_keyboard ()
12477 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12478 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12479 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12480 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12481 initial_define_key (meta_map
, 'x', "execute-extended-command");
12483 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12484 "handle-delete-frame");
12485 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12486 current-prefix-arg, as is done in `handle-switch-frame'.
12487 But `handle-switch-frame is not run from the special-map.
12488 Commands from that map are run in a special way that automatically
12489 preserves the prefix-arg. Restoring the prefix arg here is not just
12490 redundant but harmful:
12492 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12493 - after the first prompt, the exit-minibuffer-hook is run which may
12494 iconify a frame and thus push a `iconify-frame' event.
12495 - after running exit-minibuffer-hook, current-prefix-arg is
12496 restored to the non-nil value it had before the prompt.
12497 - we enter the second prompt.
12498 current-prefix-arg is non-nil, prefix-arg is nil.
12499 - before running the first real event, we run the special iconify-frame
12500 event, but we pass the `special' arg to execute-command so
12501 current-prefix-arg and prefix-arg are left untouched.
12502 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12503 - the next key event will have a spuriously non-nil current-prefix-arg. */
12504 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12506 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12508 /* Handling it at such a low-level causes read_key_sequence to get
12509 * confused because it doesn't realize that the current_buffer was
12510 * changed by read_char.
12512 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12513 * "handle-select-window"); */
12514 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12515 "handle-save-session");
12518 /* Mark the pointers in the kboard objects.
12519 Called by the Fgarbage_collector. */
12525 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12527 if (kb
->kbd_macro_buffer
)
12528 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12530 mark_object (kb
->Voverriding_terminal_local_map
);
12531 mark_object (kb
->Vlast_command
);
12532 mark_object (kb
->Vreal_last_command
);
12533 mark_object (kb
->Vkeyboard_translate_table
);
12534 mark_object (kb
->Vlast_repeatable_command
);
12535 mark_object (kb
->Vprefix_arg
);
12536 mark_object (kb
->Vlast_prefix_arg
);
12537 mark_object (kb
->kbd_queue
);
12538 mark_object (kb
->defining_kbd_macro
);
12539 mark_object (kb
->Vlast_kbd_macro
);
12540 mark_object (kb
->Vsystem_key_alist
);
12541 mark_object (kb
->system_key_syms
);
12542 mark_object (kb
->Vwindow_system
);
12543 mark_object (kb
->Vinput_decode_map
);
12544 mark_object (kb
->Vlocal_function_key_map
);
12545 mark_object (kb
->Vdefault_minibuffer_frame
);
12546 mark_object (kb
->echo_string
);
12549 struct input_event
*event
;
12550 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12552 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12553 event
= kbd_buffer
;
12554 if (event
->kind
!= SELECTION_REQUEST_EVENT
12555 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12557 mark_object (event
->x
);
12558 mark_object (event
->y
);
12560 mark_object (event
->frame_or_window
);
12561 mark_object (event
->arg
);
12566 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12567 (do not change this comment) */