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"
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) \
164 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
166 new = Fmake_vector (make_number (newsize), Qnil); \
167 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
168 raw_keybuf_count * sizeof (Lisp_Object)); \
172 /* Number of elements of this_command_keys
173 that precede this key sequence. */
174 int this_single_command_key_start
;
176 /* Record values of this_command_key_count and echo_length ()
177 before this command was read. */
178 static int before_command_key_count
;
179 static int before_command_echo_length
;
181 extern int minbuf_level
;
183 extern int message_enable_multibyte
;
185 extern struct backtrace
*backtrace_list
;
187 /* If non-nil, the function that implements the display of help.
188 It's called with one argument, the help string to display. */
190 Lisp_Object Vshow_help_function
;
192 /* If a string, the message displayed before displaying a help-echo
195 Lisp_Object Vpre_help_message
;
197 /* Nonzero means do menu prompting. */
199 static int menu_prompting
;
201 /* Character to see next line of menu prompt. */
203 static Lisp_Object menu_prompt_more_char
;
205 /* For longjmp to where kbd input is being done. */
207 static jmp_buf getcjmp
;
209 /* True while doing kbd input. */
210 int waiting_for_input
;
212 /* True while displaying for echoing. Delays C-g throwing. */
216 /* Non-null means we can start echoing at the next input pause even
217 though there is something in the echo area. */
219 static struct kboard
*ok_to_echo_at_next_pause
;
221 /* The kboard last echoing, or null for none. Reset to 0 in
222 cancel_echoing. If non-null, and a current echo area message
223 exists, and echo_message_buffer is eq to the current message
224 buffer, we know that the message comes from echo_kboard. */
226 struct kboard
*echo_kboard
;
228 /* The buffer used for echoing. Set in echo_now, reset in
231 Lisp_Object echo_message_buffer
;
233 /* Nonzero means disregard local maps for the menu bar. */
234 static int inhibit_local_menu_bar_menus
;
236 /* Nonzero means C-g should cause immediate error-signal. */
239 /* The user's hook function for outputting an error message. */
240 Lisp_Object Vcommand_error_function
;
242 /* The user's ERASE setting. */
243 Lisp_Object Vtty_erase_char
;
245 /* Character to recognize as the help char. */
246 Lisp_Object Vhelp_char
;
248 /* List of other event types to recognize as meaning "help". */
249 Lisp_Object Vhelp_event_list
;
251 /* Form to execute when help char is typed. */
252 Lisp_Object Vhelp_form
;
254 /* Command to run when the help character follows a prefix key. */
255 Lisp_Object Vprefix_help_command
;
257 /* List of items that should move to the end of the menu bar. */
258 Lisp_Object Vmenu_bar_final_items
;
260 /* Non-nil means show the equivalent key-binding for
261 any M-x command that has one.
262 The value can be a length of time to show the message for.
263 If the value is non-nil and not a number, we wait 2 seconds. */
264 Lisp_Object Vsuggest_key_bindings
;
266 /* How long to display an echo-area message when the minibuffer is active.
267 If the value is not a number, such messages don't time out. */
268 Lisp_Object Vminibuffer_message_timeout
;
270 /* Character that causes a quit. Normally C-g.
272 If we are running on an ordinary terminal, this must be an ordinary
273 ASCII char, since we want to make it our interrupt character.
275 If we are not running on an ordinary terminal, it still needs to be
276 an ordinary ASCII char. This character needs to be recognized in
277 the input interrupt handler. At this point, the keystroke is
278 represented as a struct input_event, while the desired quit
279 character is specified as a lispy event. The mapping from struct
280 input_events to lispy events cannot run in an interrupt handler,
281 and the reverse mapping is difficult for anything but ASCII
284 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
288 extern Lisp_Object current_global_map
;
289 extern int minibuf_level
;
291 /* If non-nil, this is a map that overrides all other local maps. */
292 Lisp_Object Voverriding_local_map
;
294 /* If non-nil, Voverriding_local_map applies to the menu bar. */
295 Lisp_Object Voverriding_local_map_menu_flag
;
297 /* Keymap that defines special misc events that should
298 be processed immediately at a low level. */
299 Lisp_Object Vspecial_event_map
;
301 /* Current depth in recursive edits. */
302 int command_loop_level
;
304 /* Total number of times command_loop has read a key sequence. */
305 EMACS_INT num_input_keys
;
307 /* Last input character read as a command. */
308 Lisp_Object last_command_char
;
310 /* Last input character read as a command, not counting menus
311 reached by the mouse. */
312 Lisp_Object last_nonmenu_event
;
314 /* Last input character read for any purpose. */
315 Lisp_Object last_input_char
;
317 /* If not Qnil, a list of objects to be read as subsequent command input. */
318 Lisp_Object Vunread_command_events
;
320 /* If not Qnil, a list of objects to be read as subsequent command input
321 including input method processing. */
322 Lisp_Object Vunread_input_method_events
;
324 /* If not Qnil, a list of objects to be read as subsequent command input
325 but NOT including input method processing. */
326 Lisp_Object Vunread_post_input_method_events
;
328 /* If not -1, an event to be read as subsequent command input. */
329 EMACS_INT unread_command_char
;
331 /* If not Qnil, this is a switch-frame event which we decided to put
332 off until the end of a key sequence. This should be read as the
333 next command input, after any unread_command_events.
335 read_key_sequence uses this to delay switch-frame events until the
336 end of the key sequence; Fread_char uses it to put off switch-frame
337 events until a non-ASCII event is acceptable as input. */
338 Lisp_Object unread_switch_frame
;
340 /* A mask of extra modifier bits to put into every keyboard char. */
341 EMACS_INT extra_keyboard_modifiers
;
343 /* Char to use as prefix when a meta character is typed in.
344 This is bound on entry to minibuffer in case ESC is changed there. */
346 Lisp_Object meta_prefix_char
;
348 /* Last size recorded for a current buffer which is not a minibuffer. */
349 static int last_non_minibuf_size
;
351 /* Number of idle seconds before an auto-save and garbage collection. */
352 static Lisp_Object Vauto_save_timeout
;
354 /* Total number of times read_char has returned. */
355 int num_input_events
;
357 /* Total number of times read_char has returned, outside of macros. */
358 EMACS_INT num_nonmacro_input_events
;
360 /* Auto-save automatically when this many characters have been typed
361 since the last time. */
363 static EMACS_INT auto_save_interval
;
365 /* Value of num_nonmacro_input_events as of last auto save. */
369 /* The command being executed by the command loop.
370 Commands may set this, and the value set will be copied into
371 current_kboard->Vlast_command instead of the actual command. */
372 Lisp_Object Vthis_command
;
374 /* This is like Vthis_command, except that commands never set it. */
375 Lisp_Object real_this_command
;
377 /* If the lookup of the command returns a binding, the original
378 command is stored in this-original-command. It is nil otherwise. */
379 Lisp_Object Vthis_original_command
;
381 /* The value of point when the last command was started. */
382 int last_point_position
;
384 /* The buffer that was current when the last command was started. */
385 Lisp_Object last_point_position_buffer
;
387 /* The window that was selected when the last command was started. */
388 Lisp_Object last_point_position_window
;
390 /* The frame in which the last input event occurred, or Qmacro if the
391 last event came from a macro. We use this to determine when to
392 generate switch-frame events. This may be cleared by functions
393 like Fselect_frame, to make sure that a switch-frame event is
394 generated by the next character. */
395 Lisp_Object internal_last_event_frame
;
397 /* A user-visible version of the above, intended to allow users to
398 figure out where the last event came from, if the event doesn't
399 carry that information itself (i.e. if it was a character). */
400 Lisp_Object Vlast_event_frame
;
402 /* The timestamp of the last input event we received from the X server.
403 X Windows wants this for selection ownership. */
404 unsigned long last_event_timestamp
;
406 Lisp_Object Qself_insert_command
;
407 Lisp_Object Qforward_char
;
408 Lisp_Object Qbackward_char
;
409 Lisp_Object Qundefined
;
410 Lisp_Object Qtimer_event_handler
;
412 /* read_key_sequence stores here the command definition of the
413 key sequence that it reads. */
414 Lisp_Object read_key_sequence_cmd
;
416 /* Echo unfinished commands after this many seconds of pause. */
417 Lisp_Object Vecho_keystrokes
;
419 /* Form to evaluate (if non-nil) when Emacs is started. */
420 Lisp_Object Vtop_level
;
422 /* If non-nil, this implements the current input method. */
423 Lisp_Object Vinput_method_function
;
424 Lisp_Object Qinput_method_function
;
426 /* When we call Vinput_method_function,
427 this holds the echo area message that was just erased. */
428 Lisp_Object Vinput_method_previous_message
;
430 /* Non-nil means deactivate the mark at end of this command. */
431 Lisp_Object Vdeactivate_mark
;
433 /* Menu bar specified in Lucid Emacs fashion. */
435 Lisp_Object Vlucid_menu_bar_dirty_flag
;
436 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
438 Lisp_Object Qecho_area_clear_hook
;
440 /* Hooks to run before and after each command. */
441 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
442 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
443 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
445 /* Parent keymap of terminal-local function-key-map instances. */
446 Lisp_Object Vfunction_key_map
;
448 /* Parent keymap of terminal-local key-translation-map instances. */
449 Lisp_Object Vkey_translation_map
;
451 /* List of deferred actions to be performed at a later time.
452 The precise format isn't relevant here; we just check whether it is nil. */
453 Lisp_Object Vdeferred_action_list
;
455 /* Function to call to handle deferred actions, when there are any. */
456 Lisp_Object Vdeferred_action_function
;
457 Lisp_Object Qdeferred_action_function
;
459 Lisp_Object Qinput_method_exit_on_first_char
;
460 Lisp_Object Qinput_method_use_echo_area
;
462 /* File in which we write all commands we read. */
465 /* Nonzero if input is available. */
468 extern char *pending_malloc_warning
;
470 /* Circular buffer for pre-read keyboard input. */
472 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
474 /* Pointer to next available character in kbd_buffer.
475 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
476 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
477 next available char is in kbd_buffer[0]. */
478 static struct input_event
*kbd_fetch_ptr
;
480 /* Pointer to next place to store character in kbd_buffer. This
481 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
482 character should go in kbd_buffer[0]. */
483 static struct input_event
* volatile kbd_store_ptr
;
485 /* The above pair of variables forms a "queue empty" flag. When we
486 enqueue a non-hook event, we increment kbd_store_ptr. When we
487 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
488 there is input available if the two pointers are not equal.
490 Why not just have a flag set and cleared by the enqueuing and
491 dequeuing functions? Such a flag could be screwed up by interrupts
492 at inopportune times. */
494 /* If this flag is non-nil, we check mouse_moved to see when the
495 mouse moves, and motion events will appear in the input stream.
496 Otherwise, mouse motion is ignored. */
497 Lisp_Object do_mouse_tracking
;
499 /* Symbols to head events. */
500 Lisp_Object Qmouse_movement
;
501 Lisp_Object Qscroll_bar_movement
;
502 Lisp_Object Qswitch_frame
;
503 Lisp_Object Qdelete_frame
;
504 Lisp_Object Qiconify_frame
;
505 Lisp_Object Qmake_frame_visible
;
506 Lisp_Object Qselect_window
;
507 Lisp_Object Qhelp_echo
;
509 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
510 Lisp_Object Qmouse_fixup_help_message
;
513 /* Symbols to denote kinds of events. */
514 Lisp_Object Qfunction_key
;
515 Lisp_Object Qmouse_click
;
516 #if defined (WINDOWSNT) || defined (MAC_OS)
517 Lisp_Object Qlanguage_change
;
519 Lisp_Object Qdrag_n_drop
;
520 Lisp_Object Qsave_session
;
522 Lisp_Object Qmac_apple_event
;
525 /* Lisp_Object Qmouse_movement; - also an event header */
527 /* Properties of event headers. */
528 Lisp_Object Qevent_kind
;
529 Lisp_Object Qevent_symbol_elements
;
531 /* menu item parts */
532 Lisp_Object Qmenu_alias
;
533 Lisp_Object Qmenu_enable
;
534 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
535 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
536 extern Lisp_Object Vdefine_key_rebound_commands
;
537 extern Lisp_Object Qmenu_item
;
539 /* An event header symbol HEAD may have a property named
540 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
541 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
542 mask of modifiers applied to it. If present, this is used to help
543 speed up parse_modifiers. */
544 Lisp_Object Qevent_symbol_element_mask
;
546 /* An unmodified event header BASE may have a property named
547 Qmodifier_cache, which is an alist mapping modifier masks onto
548 modified versions of BASE. If present, this helps speed up
550 Lisp_Object Qmodifier_cache
;
552 /* Symbols to use for parts of windows. */
553 Lisp_Object Qmode_line
;
554 Lisp_Object Qvertical_line
;
555 Lisp_Object Qvertical_scroll_bar
;
556 Lisp_Object Qmenu_bar
;
557 extern Lisp_Object Qleft_margin
, Qright_margin
;
558 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
559 extern Lisp_Object QCmap
;
561 Lisp_Object
recursive_edit_unwind (), command_loop ();
562 Lisp_Object
Fthis_command_keys ();
563 Lisp_Object Qextended_command_history
;
564 EMACS_TIME
timer_check ();
566 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
568 extern char *x_get_keysym_name ();
570 static void record_menu_key ();
571 static int echo_length ();
573 Lisp_Object Qpolling_period
;
575 /* List of absolute timers. Appears in order of next scheduled event. */
576 Lisp_Object Vtimer_list
;
578 /* List of idle time timers. Appears in order of next scheduled event. */
579 Lisp_Object Vtimer_idle_list
;
581 /* Incremented whenever a timer is run. */
584 extern Lisp_Object Vprint_level
, Vprint_length
;
586 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
588 EMACS_TIME
*input_available_clear_time
;
590 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
591 Default is 1 if INTERRUPT_INPUT is defined. */
594 /* Nonzero while interrupts are temporarily deferred during redisplay. */
595 int interrupts_deferred
;
597 /* Allow m- file to inhibit use of FIONREAD. */
598 #ifdef BROKEN_FIONREAD
602 /* We are unable to use interrupts if FIONREAD is not available,
603 so flush SIGIO so we won't try. */
604 #if !defined (FIONREAD)
610 /* If we support a window system, turn on the code to poll periodically
611 to detect C-g. It isn't actually used when doing interrupt input. */
612 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
613 #define POLL_FOR_INPUT
616 /* After a command is executed, if point is moved into a region that
617 has specific properties (e.g. composition, display), we adjust
618 point to the boundary of the region. But, if a command sets this
619 variable to non-nil, we suppress this point adjustment. This
620 variable is set to nil before reading a command. */
622 Lisp_Object Vdisable_point_adjustment
;
624 /* If non-nil, always disable point adjustment. */
626 Lisp_Object Vglobal_disable_point_adjustment
;
628 /* The time when Emacs started being idle. */
630 static EMACS_TIME timer_idleness_start_time
;
632 /* After Emacs stops being idle, this saves the last value
633 of timer_idleness_start_time from when it was idle. */
635 static EMACS_TIME timer_last_idleness_start_time
;
637 /* If non-nil, events produced by disabled menu items and tool-bar
638 buttons are not ignored. Help functions bind this to allow help on
639 those items and buttons. */
640 Lisp_Object Venable_disabled_menus_and_buttons
;
643 /* Global variable declarations. */
645 /* Flags for readable_events. */
646 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
647 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
648 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
650 /* Function for init_keyboard to call with no args (if nonzero). */
651 void (*keyboard_init_hook
) ();
653 static int read_avail_input
P_ ((int));
654 static void get_input_pending
P_ ((int *, int));
655 static int readable_events
P_ ((int));
656 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
657 Lisp_Object
, int *));
658 static Lisp_Object
read_char_x_menu_prompt ();
659 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
661 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
662 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
663 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
664 enum scroll_bar_part
,
665 Lisp_Object
, Lisp_Object
,
668 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
669 Lisp_Object
, char **,
670 Lisp_Object
*, unsigned));
671 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
672 static int parse_solitary_modifier
P_ ((Lisp_Object
));
673 static int parse_solitary_modifier ();
674 static void save_getcjmp
P_ ((jmp_buf));
675 static void save_getcjmp ();
676 static void restore_getcjmp
P_ ((jmp_buf));
677 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
678 static void clear_event
P_ ((struct input_event
*));
680 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
682 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
683 static void handle_interrupt
P_ ((void));
684 static void timer_start_idle
P_ ((void));
685 static void timer_stop_idle
P_ ((void));
686 static void timer_resume_idle
P_ ((void));
687 static SIGTYPE handle_user_signal
P_ ((int));
688 static char *find_user_signal_name
P_ ((int));
689 static int store_user_signal_events
P_ ((void));
691 /* Nonzero means don't try to suspend even if the operating system seems
693 static int cannot_suspend
;
695 extern Lisp_Object Qidentity
, Qonly
;
697 /* Install the string STR as the beginning of the string of echoing,
698 so that it serves as a prompt for the next character.
699 Also start echoing. */
705 current_kboard
->echo_string
= str
;
706 current_kboard
->echo_after_prompt
= SCHARS (str
);
710 /* Add C to the echo string, if echoing is going on.
711 C can be a character, which is printed prettily ("M-C-x" and all that
712 jazz), or a symbol, whose name is printed. */
718 if (current_kboard
->immediate_echo
)
720 int size
= KEY_DESCRIPTION_SIZE
+ 100;
721 char *buffer
= (char *) alloca (size
);
723 Lisp_Object echo_string
;
725 echo_string
= current_kboard
->echo_string
;
727 /* If someone has passed us a composite event, use its head symbol. */
732 ptr
= push_key_description (XINT (c
), ptr
, 1);
734 else if (SYMBOLP (c
))
736 Lisp_Object name
= SYMBOL_NAME (c
);
737 int nbytes
= SBYTES (name
);
739 if (size
- (ptr
- buffer
) < nbytes
)
741 int offset
= ptr
- buffer
;
742 size
= max (2 * size
, size
+ nbytes
);
743 buffer
= (char *) alloca (size
);
744 ptr
= buffer
+ offset
;
747 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
748 STRING_MULTIBYTE (name
), 1);
751 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
754 const char *text
= " (Type ? for further options)";
755 int len
= strlen (text
);
757 if (size
- (ptr
- buffer
) < len
)
759 int offset
= ptr
- buffer
;
761 buffer
= (char *) alloca (size
);
762 ptr
= buffer
+ offset
;
765 bcopy (text
, ptr
, len
);
769 /* Replace a dash from echo_dash with a space, otherwise
770 add a space at the end as a separator between keys. */
771 if (STRINGP (echo_string
)
772 && SCHARS (echo_string
) > 1)
774 Lisp_Object last_char
, prev_char
, idx
;
776 idx
= make_number (SCHARS (echo_string
) - 2);
777 prev_char
= Faref (echo_string
, idx
);
779 idx
= make_number (SCHARS (echo_string
) - 1);
780 last_char
= Faref (echo_string
, idx
);
782 /* We test PREV_CHAR to make sure this isn't the echoing
784 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
785 Faset (echo_string
, idx
, make_number (' '));
787 echo_string
= concat2 (echo_string
, build_string (" "));
789 else if (STRINGP (echo_string
))
790 echo_string
= concat2 (echo_string
, build_string (" "));
792 current_kboard
->echo_string
793 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
799 /* Temporarily add a dash to the end of the echo string if it's not
800 empty, so that it serves as a mini-prompt for the very next character. */
805 /* Do nothing if not echoing at all. */
806 if (NILP (current_kboard
->echo_string
))
809 if (!current_kboard
->immediate_echo
810 && SCHARS (current_kboard
->echo_string
) == 0)
813 /* Do nothing if we just printed a prompt. */
814 if (current_kboard
->echo_after_prompt
815 == SCHARS (current_kboard
->echo_string
))
818 /* Do nothing if we have already put a dash at the end. */
819 if (SCHARS (current_kboard
->echo_string
) > 1)
821 Lisp_Object last_char
, prev_char
, idx
;
823 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
824 prev_char
= Faref (current_kboard
->echo_string
, idx
);
826 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
827 last_char
= Faref (current_kboard
->echo_string
, idx
);
829 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
833 /* Put a dash at the end of the buffer temporarily,
834 but make it go away when the next character is added. */
835 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
840 /* Display the current echo string, and begin echoing if not already
846 if (!current_kboard
->immediate_echo
)
849 current_kboard
->immediate_echo
= 1;
851 for (i
= 0; i
< this_command_key_count
; i
++)
855 /* Set before_command_echo_length to the value that would
856 have been saved before the start of this subcommand in
857 command_loop_1, if we had already been echoing then. */
858 if (i
== this_single_command_key_start
)
859 before_command_echo_length
= echo_length ();
861 c
= XVECTOR (this_command_keys
)->contents
[i
];
862 if (! (EVENT_HAS_PARAMETERS (c
)
863 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
867 /* Set before_command_echo_length to the value that would
868 have been saved before the start of this subcommand in
869 command_loop_1, if we had already been echoing then. */
870 if (this_command_key_count
== this_single_command_key_start
)
871 before_command_echo_length
= echo_length ();
873 /* Put a dash at the end to invite the user to type more. */
878 message3_nolog (current_kboard
->echo_string
,
879 SBYTES (current_kboard
->echo_string
),
880 STRING_MULTIBYTE (current_kboard
->echo_string
));
883 /* Record in what buffer we echoed, and from which kboard. */
884 echo_message_buffer
= echo_area_buffer
[0];
885 echo_kboard
= current_kboard
;
887 if (waiting_for_input
&& !NILP (Vquit_flag
))
888 quit_throw_to_read_char ();
891 /* Turn off echoing, for the start of a new command. */
896 current_kboard
->immediate_echo
= 0;
897 current_kboard
->echo_after_prompt
= -1;
898 current_kboard
->echo_string
= Qnil
;
899 ok_to_echo_at_next_pause
= NULL
;
901 echo_message_buffer
= Qnil
;
904 /* Return the length of the current echo string. */
909 return (STRINGP (current_kboard
->echo_string
)
910 ? SCHARS (current_kboard
->echo_string
)
914 /* Truncate the current echo message to its first LEN chars.
915 This and echo_char get used by read_key_sequence when the user
916 switches frames while entering a key sequence. */
919 echo_truncate (nchars
)
922 if (STRINGP (current_kboard
->echo_string
))
923 current_kboard
->echo_string
924 = Fsubstring (current_kboard
->echo_string
,
925 make_number (0), make_number (nchars
));
926 truncate_echo_area (nchars
);
930 /* Functions for manipulating this_command_keys. */
932 add_command_key (key
)
935 #if 0 /* Not needed after we made Freset_this_command_lengths
936 do the job immediately. */
937 /* If reset-this-command-length was called recently, obey it now.
938 See the doc string of that function for an explanation of why. */
939 if (before_command_restore_flag
)
941 this_command_key_count
= before_command_key_count_1
;
942 if (this_command_key_count
< this_single_command_key_start
)
943 this_single_command_key_start
= this_command_key_count
;
944 echo_truncate (before_command_echo_length_1
);
945 before_command_restore_flag
= 0;
949 if (this_command_key_count
>= ASIZE (this_command_keys
))
950 this_command_keys
= larger_vector (this_command_keys
,
951 2 * ASIZE (this_command_keys
),
954 AREF (this_command_keys
, this_command_key_count
) = key
;
955 ++this_command_key_count
;
962 int count
= SPECPDL_INDEX ();
965 if (command_loop_level
> 0)
967 specbind (Qstandard_output
, Qt
);
968 specbind (Qstandard_input
, Qt
);
971 #ifdef HAVE_X_WINDOWS
972 /* The command loop has started an hourglass timer, so we have to
973 cancel it here, otherwise it will fire because the recursive edit
974 can take some time. Do not check for display_hourglass_p here,
975 because it could already be nil. */
979 /* This function may have been called from a debugger called from
980 within redisplay, for instance by Edebugging a function called
981 from fontification-functions. We want to allow redisplay in
982 the debugging session.
984 The recursive edit is left with a `(throw exit ...)'. The `exit'
985 tag is not caught anywhere in redisplay, i.e. when we leave the
986 recursive edit, the original redisplay leading to the recursive
987 edit will be unwound. The outcome should therefore be safe. */
988 specbind (Qinhibit_redisplay
, Qnil
);
991 val
= command_loop ();
993 Fsignal (Qquit
, Qnil
);
994 /* Handle throw from read_minibuf when using minibuffer
995 while it's active but we're in another window. */
997 xsignal1 (Qerror
, val
);
999 return unbind_to (count
, Qnil
);
1002 /* When an auto-save happens, record the "time", and don't do again soon. */
1007 last_auto_save
= num_nonmacro_input_events
;
1010 /* Make an auto save happen as soon as possible at command level. */
1013 force_auto_save_soon ()
1015 last_auto_save
= - auto_save_interval
- 1;
1017 record_asynch_buffer_change ();
1020 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1021 doc
: /* Invoke the editor command loop recursively.
1022 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1023 that tells this function to return.
1024 Alternatively, `(throw 'exit t)' makes this function signal an error.
1025 This function is called by the editor initialization to begin editing. */)
1028 int count
= SPECPDL_INDEX ();
1031 /* If we enter while input is blocked, don't lock up here.
1032 This may happen through the debugger during redisplay. */
1033 if (INPUT_BLOCKED_P
)
1036 command_loop_level
++;
1037 update_mode_lines
= 1;
1039 if (command_loop_level
1040 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1041 buffer
= Fcurrent_buffer ();
1045 /* If we leave recursive_edit_1 below with a `throw' for instance,
1046 like it is done in the splash screen display, we have to
1047 make sure that we restore single_kboard as command_loop_1
1048 would have done if it were left normally. */
1049 if (command_loop_level
> 0)
1050 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1051 record_unwind_protect (recursive_edit_unwind
, buffer
);
1053 recursive_edit_1 ();
1054 return unbind_to (count
, Qnil
);
1058 recursive_edit_unwind (buffer
)
1061 if (BUFFERP (buffer
))
1062 Fset_buffer (buffer
);
1064 command_loop_level
--;
1065 update_mode_lines
= 1;
1070 #if 0 /* These two functions are now replaced with
1071 temporarily_switch_to_single_kboard. */
1076 #if 0 /* Theory: if there's anything in Vunread_command_events,
1077 it will right away be read by read_key_sequence,
1078 and then if we do switch KBOARDS, it will go into the side
1079 queue then. So we don't need to do anything special here -- rms. */
1080 if (CONSP (Vunread_command_events
))
1082 current_kboard
->kbd_queue
1083 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1084 current_kboard
->kbd_queue_has_data
= 1;
1086 Vunread_command_events
= Qnil
;
1092 /* Switch to the single-kboard state, making current_kboard
1093 the only KBOARD from which further input is accepted. */
1096 single_kboard_state ()
1104 /* If we're in single_kboard state for kboard KBOARD,
1108 not_single_kboard_state (kboard
)
1112 if (kboard
== current_kboard
)
1117 /* Maintain a stack of kboards, so other parts of Emacs
1118 can switch temporarily to the kboard of a given frame
1119 and then revert to the previous status. */
1124 struct kboard_stack
*next
;
1127 static struct kboard_stack
*kboard_stack
;
1134 struct kboard_stack
*p
1135 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1137 p
->next
= kboard_stack
;
1138 p
->kboard
= current_kboard
;
1150 struct kboard_stack
*p
= kboard_stack
;
1152 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1154 if (t
->kboard
== p
->kboard
)
1156 current_kboard
= p
->kboard
;
1163 /* The terminal we remembered has been deleted. */
1164 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1167 kboard_stack
= p
->next
;
1172 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1173 from which further input is accepted. If F is non-nil, set its
1174 KBOARD as the current keyboard.
1176 This function uses record_unwind_protect to return to the previous
1179 If Emacs is already in single_kboard mode, and F's keyboard is
1180 locked, then this function will throw an errow. */
1183 temporarily_switch_to_single_kboard (f
)
1187 int was_locked
= single_kboard
;
1190 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1191 /* We can not switch keyboards while in single_kboard mode.
1192 In rare cases, Lisp code may call `recursive-edit' (or
1193 `read-minibuffer' or `y-or-n-p') after it switched to a
1194 locked frame. For example, this is likely to happen
1195 when server.el connects to a new terminal while Emacs is in
1196 single_kboard mode. It is best to throw an error instead
1197 of presenting the user with a frozen screen. */
1198 error ("Terminal %d is locked, cannot read from it",
1199 FRAME_TERMINAL (f
)->id
);
1201 /* This call is unnecessary, but helps
1202 `restore_kboard_configuration' discover if somebody changed
1203 `current_kboard' behind our back. */
1204 push_kboard (current_kboard
);
1207 current_kboard
= FRAME_KBOARD (f
);
1209 record_unwind_protect (restore_kboard_configuration
,
1210 (was_locked
? Qt
: Qnil
));
1214 #if 0 /* This function is not needed anymore. */
1216 record_single_kboard_state ()
1219 push_kboard (current_kboard
);
1220 record_unwind_protect (restore_kboard_configuration
,
1221 (single_kboard
? Qt
: Qnil
));
1227 restore_kboard_configuration (was_locked
)
1228 Lisp_Object was_locked
;
1230 if (NILP (was_locked
))
1234 struct kboard
*prev
= current_kboard
;
1237 /* The pop should not change the kboard. */
1238 if (single_kboard
&& current_kboard
!= prev
)
1246 /* Handle errors that are not handled at inner levels
1247 by printing an error message and returning to the editor command loop. */
1253 Lisp_Object old_level
, old_length
;
1254 char macroerror
[50];
1256 #ifdef HAVE_X_WINDOWS
1257 if (display_hourglass_p
)
1258 cancel_hourglass ();
1261 if (!NILP (executing_kbd_macro
))
1263 if (executing_kbd_macro_iterations
== 1)
1264 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1266 sprintf (macroerror
, "After %d kbd macro iterations: ",
1267 executing_kbd_macro_iterations
);
1272 Vstandard_output
= Qt
;
1273 Vstandard_input
= Qt
;
1274 Vexecuting_kbd_macro
= Qnil
;
1275 executing_kbd_macro
= Qnil
;
1276 current_kboard
->Vprefix_arg
= Qnil
;
1277 current_kboard
->Vlast_prefix_arg
= Qnil
;
1280 /* Avoid unquittable loop if data contains a circular list. */
1281 old_level
= Vprint_level
;
1282 old_length
= Vprint_length
;
1283 XSETFASTINT (Vprint_level
, 10);
1284 XSETFASTINT (Vprint_length
, 10);
1285 cmd_error_internal (data
, macroerror
);
1286 Vprint_level
= old_level
;
1287 Vprint_length
= old_length
;
1291 Vinhibit_quit
= Qnil
;
1292 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1294 if (command_loop_level
== 0 && minibuf_level
== 0)
1295 any_kboard_state ();
1299 return make_number (0);
1302 /* Take actions on handling an error. DATA is the data that describes
1305 CONTEXT is a C-string containing ASCII characters only which
1306 describes the context in which the error happened. If we need to
1307 generalize CONTEXT to allow multibyte characters, make it a Lisp
1311 cmd_error_internal (data
, context
)
1315 struct frame
*sf
= SELECTED_FRAME ();
1317 /* The immediate context is not interesting for Quits,
1318 since they are asyncronous. */
1319 if (EQ (XCAR (data
), Qquit
))
1320 Vsignaling_function
= Qnil
;
1325 /* Use user's specified output function if any. */
1326 if (!NILP (Vcommand_error_function
))
1327 call3 (Vcommand_error_function
, data
,
1328 context
? build_string (context
) : empty_unibyte_string
,
1329 Vsignaling_function
);
1330 /* If the window system or terminal frame hasn't been initialized
1331 yet, or we're not interactive, write the message to stderr and exit. */
1332 else if (!sf
->glyphs_initialized_p
1333 || FRAME_INITIAL_P (sf
)
1336 print_error_message (data
, Qexternal_debugging_output
,
1337 context
, Vsignaling_function
);
1338 Fterpri (Qexternal_debugging_output
);
1339 Fkill_emacs (make_number (-1));
1343 clear_message (1, 0);
1345 message_log_maybe_newline ();
1348 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1351 Vsignaling_function
= Qnil
;
1354 Lisp_Object
command_loop_1 ();
1355 Lisp_Object
command_loop_2 ();
1356 Lisp_Object
top_level_1 ();
1358 /* Entry to editor-command-loop.
1359 This level has the catches for exiting/returning to editor command loop.
1360 It returns nil to exit recursive edit, t to abort it. */
1365 if (command_loop_level
> 0 || minibuf_level
> 0)
1368 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1369 executing_kbd_macro
= Qnil
;
1375 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1376 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1377 /* Reset single_kboard in case top-level set it while
1378 evaluating an -f option, or we are stuck there for some
1380 any_kboard_state ();
1382 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1383 executing_kbd_macro
= Qnil
;
1385 /* End of file in -batch run causes exit here. */
1391 /* Here we catch errors in execution of commands within the
1392 editing loop, and reenter the editing loop.
1393 When there is an error, cmd_error runs and returns a non-nil
1394 value to us. A value of nil means that command_loop_1 itself
1395 returned due to end of file (or end of kbd macro). */
1400 register Lisp_Object val
;
1403 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1404 while (!NILP (val
));
1412 return Feval (Vtop_level
);
1418 /* On entry to the outer level, run the startup file */
1419 if (!NILP (Vtop_level
))
1420 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1421 else if (!NILP (Vpurify_flag
))
1422 message ("Bare impure Emacs (standard Lisp code not loaded)");
1424 message ("Bare Emacs (standard Lisp code not loaded)");
1428 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1429 doc
: /* Exit all recursive editing levels. */)
1432 #ifdef HAVE_X_WINDOWS
1433 if (display_hourglass_p
)
1434 cancel_hourglass ();
1437 /* Unblock input if we enter with input blocked. This may happen if
1438 redisplay traps e.g. during tool-bar update with input blocked. */
1439 while (INPUT_BLOCKED_P
)
1442 return Fthrow (Qtop_level
, Qnil
);
1445 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1446 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1449 if (command_loop_level
> 0 || minibuf_level
> 0)
1450 Fthrow (Qexit
, Qnil
);
1452 error ("No recursive edit is in progress");
1456 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1457 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1460 if (command_loop_level
> 0 || minibuf_level
> 0)
1463 error ("No recursive edit is in progress");
1467 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1469 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1470 of this function. */
1473 tracking_off (old_value
)
1474 Lisp_Object old_value
;
1476 do_mouse_tracking
= old_value
;
1477 if (NILP (old_value
))
1479 /* Redisplay may have been preempted because there was input
1480 available, and it assumes it will be called again after the
1481 input has been processed. If the only input available was
1482 the sort that we have just disabled, then we need to call
1484 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1486 redisplay_preserve_echo_area (6);
1487 get_input_pending (&input_pending
,
1488 READABLE_EVENTS_DO_TIMERS_NOW
);
1494 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1495 doc
: /* Evaluate BODY with mouse movement events enabled.
1496 Within a `track-mouse' form, mouse motion generates input events that
1497 you can read with `read-event'.
1498 Normally, mouse motion is ignored.
1499 usage: (track-mouse BODY...) */)
1503 int count
= SPECPDL_INDEX ();
1506 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1508 do_mouse_tracking
= Qt
;
1510 val
= Fprogn (args
);
1511 return unbind_to (count
, val
);
1514 /* If mouse has moved on some frame, return one of those frames.
1518 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1519 after resizing the tool-bar window. */
1521 int ignore_mouse_drag_p
;
1526 Lisp_Object tail
, frame
;
1528 if (ignore_mouse_drag_p
)
1530 /* ignore_mouse_drag_p = 0; */
1534 FOR_EACH_FRAME (tail
, frame
)
1536 if (XFRAME (frame
)->mouse_moved
)
1537 return XFRAME (frame
);
1543 #endif /* HAVE_MOUSE || HAVE_GPM */
1545 /* This is the actual command reading loop,
1546 sans error-handling encapsulation. */
1548 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1550 void safe_run_hooks
P_ ((Lisp_Object
));
1551 static void adjust_point_for_property
P_ ((int, int));
1553 /* Cancel hourglass from protect_unwind.
1555 #ifdef HAVE_X_WINDOWS
1557 cancel_hourglass_unwind (arg
)
1560 cancel_hourglass ();
1571 Lisp_Object keybuf
[30];
1574 int prev_modiff
= 0;
1575 struct buffer
*prev_buffer
= NULL
;
1576 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1578 int was_locked
= single_kboard
;
1581 int already_adjusted
= 0;
1583 current_kboard
->Vprefix_arg
= Qnil
;
1584 current_kboard
->Vlast_prefix_arg
= Qnil
;
1585 Vdeactivate_mark
= Qnil
;
1586 waiting_for_input
= 0;
1590 this_command_key_count
= 0;
1591 this_command_key_count_reset
= 0;
1592 this_single_command_key_start
= 0;
1594 if (NILP (Vmemory_full
))
1596 /* Make sure this hook runs after commands that get errors and
1597 throw to top level. */
1598 /* Note that the value cell will never directly contain nil
1599 if the symbol is a local variable. */
1600 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1601 safe_run_hooks (Qpost_command_hook
);
1603 /* If displaying a message, resize the echo area window to fit
1604 that message's size exactly. */
1605 if (!NILP (echo_area_buffer
[0]))
1606 resize_echo_area_exactly ();
1608 if (!NILP (Vdeferred_action_list
))
1609 safe_run_hooks (Qdeferred_action_function
);
1612 /* Do this after running Vpost_command_hook, for consistency. */
1613 current_kboard
->Vlast_command
= Vthis_command
;
1614 current_kboard
->Vreal_last_command
= real_this_command
;
1618 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1621 /* Make sure the current window's buffer is selected. */
1622 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1623 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1625 /* Display any malloc warning that just came out. Use while because
1626 displaying one warning can cause another. */
1628 while (pending_malloc_warning
)
1629 display_malloc_warning ();
1633 Vdeactivate_mark
= Qnil
;
1635 /* If minibuffer on and echo area in use,
1636 wait a short time and redraw minibuffer. */
1639 && !NILP (echo_area_buffer
[0])
1640 && EQ (minibuf_window
, echo_area_window
))
1642 /* Bind inhibit-quit to t so that C-g gets read in
1643 rather than quitting back to the minibuffer. */
1644 int count
= SPECPDL_INDEX ();
1645 specbind (Qinhibit_quit
, Qt
);
1647 if (NUMBERP (Vminibuffer_message_timeout
))
1648 sit_for (Vminibuffer_message_timeout
, 0, 2);
1652 /* Clear the echo area. */
1654 safe_run_hooks (Qecho_area_clear_hook
);
1656 unbind_to (count
, Qnil
);
1658 /* If a C-g came in before, treat it as input now. */
1659 if (!NILP (Vquit_flag
))
1662 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1667 /* Select the frame that the last event came from. Usually,
1668 switch-frame events will take care of this, but if some lisp
1669 code swallows a switch-frame event, we'll fix things up here.
1670 Is this a good idea? */
1671 if (FRAMEP (internal_last_event_frame
)
1672 && !EQ (internal_last_event_frame
, selected_frame
))
1673 Fselect_frame (internal_last_event_frame
);
1675 /* If it has changed current-menubar from previous value,
1676 really recompute the menubar from the value. */
1677 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1678 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1679 call0 (Qrecompute_lucid_menubar
);
1681 before_command_key_count
= this_command_key_count
;
1682 before_command_echo_length
= echo_length ();
1684 Vthis_command
= Qnil
;
1685 real_this_command
= Qnil
;
1686 Vthis_original_command
= Qnil
;
1688 /* Read next key sequence; i gets its length. */
1689 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1692 /* A filter may have run while we were reading the input. */
1693 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1695 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1696 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1700 /* Now we have read a key sequence of length I,
1701 or else I is 0 and we found end of file. */
1703 if (i
== 0) /* End of file -- happens only in */
1704 return Qnil
; /* a kbd macro, at the end. */
1705 /* -1 means read_key_sequence got a menu that was rejected.
1706 Just loop around and read another command. */
1710 this_command_key_count
= 0;
1711 this_command_key_count_reset
= 0;
1712 this_single_command_key_start
= 0;
1716 last_command_char
= keybuf
[i
- 1];
1718 /* If the previous command tried to force a specific window-start,
1719 forget about that, in case this command moves point far away
1720 from that position. But also throw away beg_unchanged and
1721 end_unchanged information in that case, so that redisplay will
1722 update the whole window properly. */
1723 if (!NILP (XWINDOW (selected_window
)->force_start
))
1726 XWINDOW (selected_window
)->force_start
= Qnil
;
1727 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1728 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1731 cmd
= read_key_sequence_cmd
;
1732 if (!NILP (Vexecuting_kbd_macro
))
1734 if (!NILP (Vquit_flag
))
1736 Vexecuting_kbd_macro
= Qt
;
1737 QUIT
; /* Make some noise. */
1738 /* Will return since macro now empty. */
1742 /* Do redisplay processing after this command except in special
1743 cases identified below. */
1744 prev_buffer
= current_buffer
;
1745 prev_modiff
= MODIFF
;
1746 last_point_position
= PT
;
1747 last_point_position_window
= selected_window
;
1748 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1750 /* By default, we adjust point to a boundary of a region that
1751 has such a property that should be treated intangible
1752 (e.g. composition, display). But, some commands will set
1753 this variable differently. */
1754 Vdisable_point_adjustment
= Qnil
;
1756 /* Process filters and timers may have messed with deactivate-mark.
1757 reset it before we execute the command. */
1758 Vdeactivate_mark
= Qnil
;
1760 /* Remap command through active keymaps */
1761 Vthis_original_command
= cmd
;
1765 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1769 /* Execute the command. */
1771 Vthis_command
= cmd
;
1772 real_this_command
= cmd
;
1773 /* Note that the value cell will never directly contain nil
1774 if the symbol is a local variable. */
1775 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1776 safe_run_hooks (Qpre_command_hook
);
1778 already_adjusted
= 0;
1780 if (NILP (Vthis_command
))
1782 /* nil means key is undefined. */
1783 Lisp_Object keys
= Fvector (i
, keybuf
);
1784 keys
= Fkey_description (keys
, Qnil
);
1786 message_with_string ("%s is undefined", keys
, 0);
1787 current_kboard
->defining_kbd_macro
= Qnil
;
1788 update_mode_lines
= 1;
1789 current_kboard
->Vprefix_arg
= Qnil
;
1793 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1795 /* In case we jump to directly_done. */
1796 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1798 /* Recognize some common commands in common situations and
1799 do them directly. */
1800 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1802 struct Lisp_Char_Table
*dp
1803 = window_display_table (XWINDOW (selected_window
));
1804 lose
= FETCH_CHAR (PT_BYTE
);
1806 if (! NILP (Vpost_command_hook
))
1807 /* Put this before calling adjust_point_for_property
1808 so it will only get called once in any case. */
1810 if (current_buffer
== prev_buffer
1811 && last_point_position
!= PT
1812 && NILP (Vdisable_point_adjustment
)
1813 && NILP (Vglobal_disable_point_adjustment
))
1814 adjust_point_for_property (last_point_position
, 0);
1815 already_adjusted
= 1;
1816 if (PT
== last_point_position
+ 1
1818 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1819 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1820 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1821 && (lose
>= 0x20 && lose
< 0x7f)))
1822 : (lose
>= 0x20 && lose
< 0x7f))
1823 /* To extract the case of continuation on
1824 wide-column characters. */
1825 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1826 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1828 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1830 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1832 && !windows_or_buffers_changed
1833 && EQ (current_buffer
->selective_display
, Qnil
)
1834 && !detect_input_pending ()
1835 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1836 && NILP (Vexecuting_kbd_macro
))
1837 direct_output_forward_char (1);
1840 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1842 struct Lisp_Char_Table
*dp
1843 = window_display_table (XWINDOW (selected_window
));
1845 lose
= FETCH_CHAR (PT_BYTE
);
1846 if (! NILP (Vpost_command_hook
))
1848 if (current_buffer
== prev_buffer
1849 && last_point_position
!= PT
1850 && NILP (Vdisable_point_adjustment
)
1851 && NILP (Vglobal_disable_point_adjustment
))
1852 adjust_point_for_property (last_point_position
, 0);
1853 already_adjusted
= 1;
1854 if (PT
== last_point_position
- 1
1856 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1857 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1858 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1859 && (lose
>= 0x20 && lose
< 0x7f)))
1860 : (lose
>= 0x20 && lose
< 0x7f))
1861 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1863 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1865 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1867 && !windows_or_buffers_changed
1868 && EQ (current_buffer
->selective_display
, Qnil
)
1869 && !detect_input_pending ()
1870 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1871 && NILP (Vexecuting_kbd_macro
))
1872 direct_output_forward_char (-1);
1875 else if (EQ (Vthis_command
, Qself_insert_command
)
1876 /* Try this optimization only on char keystrokes. */
1877 && NATNUMP (last_command_char
)
1878 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1881 = translate_char (Vtranslation_table_for_input
,
1882 XFASTINT (last_command_char
), 0, 0, 0);
1884 if (NILP (Vexecuting_kbd_macro
)
1885 && !EQ (minibuf_window
, selected_window
))
1887 if (!nonundocount
|| nonundocount
>= 20)
1895 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1897 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1899 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1901 || MODIFF
<= SAVE_MODIFF
1902 || windows_or_buffers_changed
1903 || !EQ (current_buffer
->selective_display
, Qnil
)
1904 || detect_input_pending ()
1905 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1906 || !NILP (Vexecuting_kbd_macro
));
1908 value
= internal_self_insert (c
, 0);
1913 if (! NILP (Vpost_command_hook
))
1914 /* Put this before calling adjust_point_for_property
1915 so it will only get called once in any case. */
1918 /* VALUE == 1 when AFTER-CHANGE functions are
1919 installed which is the case most of the time
1920 because FONT-LOCK installs one. */
1921 if (!lose
&& !value
)
1922 direct_output_for_insert (c
);
1927 /* Here for a command that isn't executed directly */
1930 #ifdef HAVE_X_WINDOWS
1931 int scount
= SPECPDL_INDEX ();
1933 if (display_hourglass_p
1934 && NILP (Vexecuting_kbd_macro
))
1936 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1942 if (NILP (current_kboard
->Vprefix_arg
))
1944 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1946 #ifdef HAVE_X_WINDOWS
1947 /* Do not check display_hourglass_p here, because
1948 Fcommand_execute could change it, but we should cancel
1949 hourglass cursor anyway.
1950 But don't cancel the hourglass within a macro
1951 just because a command in the macro finishes. */
1952 if (NILP (Vexecuting_kbd_macro
))
1953 unbind_to (scount
, Qnil
);
1958 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1960 /* Note that the value cell will never directly contain nil
1961 if the symbol is a local variable. */
1962 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1963 safe_run_hooks (Qpost_command_hook
);
1965 /* If displaying a message, resize the echo area window to fit
1966 that message's size exactly. */
1967 if (!NILP (echo_area_buffer
[0]))
1968 resize_echo_area_exactly ();
1970 if (!NILP (Vdeferred_action_list
))
1971 safe_run_hooks (Qdeferred_action_function
);
1973 /* If there is a prefix argument,
1974 1) We don't want Vlast_command to be ``universal-argument''
1975 (that would be dumb), so don't set Vlast_command,
1976 2) we want to leave echoing on so that the prefix will be
1977 echoed as part of this key sequence, so don't call
1979 3) we want to leave this_command_key_count non-zero, so that
1980 read_char will realize that it is re-reading a character, and
1981 not echo it a second time.
1983 If the command didn't actually create a prefix arg,
1984 but is merely a frame event that is transparent to prefix args,
1985 then the above doesn't apply. */
1986 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1988 current_kboard
->Vlast_command
= Vthis_command
;
1989 current_kboard
->Vreal_last_command
= real_this_command
;
1991 this_command_key_count
= 0;
1992 this_command_key_count_reset
= 0;
1993 this_single_command_key_start
= 0;
1996 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1998 /* Setting transient-mark-mode to `only' is a way of
1999 turning it on for just one command. */
2001 if (EQ (Vtransient_mark_mode
, Qidentity
))
2002 Vtransient_mark_mode
= Qnil
;
2003 if (EQ (Vtransient_mark_mode
, Qonly
))
2004 Vtransient_mark_mode
= Qidentity
;
2006 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
2008 /* We could also call `deactivate'mark'. */
2009 if (EQ (Vtransient_mark_mode
, Qlambda
))
2010 Vtransient_mark_mode
= Qnil
;
2013 current_buffer
->mark_active
= Qnil
;
2014 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
2017 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
2018 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
2023 if (current_buffer
== prev_buffer
2024 && last_point_position
!= PT
2025 && NILP (Vdisable_point_adjustment
)
2026 && NILP (Vglobal_disable_point_adjustment
)
2027 && !already_adjusted
)
2028 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
2030 /* Install chars successfully executed in kbd macro. */
2032 if (!NILP (current_kboard
->defining_kbd_macro
)
2033 && NILP (current_kboard
->Vprefix_arg
))
2034 finalize_kbd_macro_chars ();
2035 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2038 any_kboard_state ();
2044 extern Lisp_Object Qcomposition
, Qdisplay
;
2046 /* Adjust point to a boundary of a region that has such a property
2047 that should be treated intangible. For the moment, we check
2048 `composition', `display' and `invisible' properties.
2049 LAST_PT is the last position of point. */
2051 extern Lisp_Object Qafter_string
, Qbefore_string
;
2052 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2055 adjust_point_for_property (last_pt
, modified
)
2060 Lisp_Object val
, overlay
, tmp
;
2061 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2064 /* FIXME: cycling is probably not necessary because these properties
2065 can't be usefully combined anyway. */
2066 while (check_composition
|| check_display
|| check_invisible
)
2068 if (check_composition
2069 && PT
> BEGV
&& PT
< ZV
2070 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2071 && COMPOSITION_VALID_P (beg
, end
, val
)
2072 && beg
< PT
/* && end > PT <- It's always the case. */
2073 && (last_pt
<= beg
|| last_pt
>= end
))
2076 SET_PT (PT
< last_pt
? beg
: end
);
2077 check_display
= check_invisible
= 1;
2079 check_composition
= 0;
2081 && PT
> BEGV
&& PT
< ZV
2082 && !NILP (val
= get_char_property_and_overlay
2083 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2084 && display_prop_intangible_p (val
)
2085 && (!OVERLAYP (overlay
)
2086 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2087 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2088 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2089 && (beg
< PT
/* && end > PT <- It's always the case. */
2090 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2093 SET_PT (PT
< last_pt
2094 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2096 check_composition
= check_invisible
= 1;
2099 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2101 int inv
, ellipsis
= 0;
2104 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2106 && !NILP (val
= get_char_property_and_overlay
2107 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2108 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2110 ellipsis
= ellipsis
|| inv
> 1
2111 || (OVERLAYP (overlay
)
2112 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2113 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2114 tmp
= Fnext_single_char_property_change
2115 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2116 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2119 && !NILP (val
= get_char_property_and_overlay
2120 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2121 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2123 ellipsis
= ellipsis
|| inv
> 1
2124 || (OVERLAYP (overlay
)
2125 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2126 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2127 tmp
= Fprevious_single_char_property_change
2128 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2129 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2132 /* Move away from the inside area. */
2133 if (beg
< PT
&& end
> PT
)
2135 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2136 /* We haven't moved yet (so we don't need to fear
2137 infinite-looping) and we were outside the range
2138 before (so either end of the range still corresponds
2139 to a move in the right direction): pretend we moved
2140 less than we actually did, so that we still have
2141 more freedom below in choosing which end of the range
2143 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2144 /* We either have moved already or the last point
2145 was already in the range: we don't get to choose
2146 which end of the range we have to go to. */
2147 : (PT
< last_pt
? beg
: end
));
2148 check_composition
= check_display
= 1;
2150 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2151 the point to something other than its argument, due to
2152 point-motion hooks, intangibility, etc. */
2153 xassert (PT
== beg
|| PT
== end
);
2156 /* Pretend the area doesn't exist if the buffer is not
2158 if (!modified
&& !ellipsis
&& beg
< end
)
2160 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2161 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2162 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2163 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2164 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2165 /* We've already moved as far as we can. Trying to go
2166 to the other end would mean moving backwards and thus
2167 could lead to an infinite loop. */
2169 else if (val
= get_pos_property (make_number (PT
),
2171 TEXT_PROP_MEANS_INVISIBLE (val
)
2172 && (val
= get_pos_property
2173 (make_number (PT
== beg
? end
: beg
),
2175 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2176 (check_composition
= check_display
= 1,
2177 SET_PT (PT
== beg
? end
: beg
));
2180 check_invisible
= 0;
2184 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2187 safe_run_hooks_1 (hook
)
2190 if (NILP (Vrun_hooks
))
2192 return call1 (Vrun_hooks
, Vinhibit_quit
);
2195 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2198 safe_run_hooks_error (data
)
2201 Lisp_Object args
[3];
2202 args
[0] = build_string ("Error in %s: %s");
2203 args
[1] = Vinhibit_quit
;
2206 return Fset (Vinhibit_quit
, Qnil
);
2209 /* If we get an error while running the hook, cause the hook variable
2210 to be nil. Also inhibit quits, so that C-g won't cause the hook
2211 to mysteriously evaporate. */
2214 safe_run_hooks (hook
)
2217 int count
= SPECPDL_INDEX ();
2218 specbind (Qinhibit_quit
, hook
);
2220 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2222 unbind_to (count
, Qnil
);
2226 /* Number of seconds between polling for input. This is a Lisp
2227 variable that can be bound. */
2229 EMACS_INT polling_period
;
2231 /* Nonzero means polling for input is temporarily suppressed. */
2233 int poll_suppress_count
;
2235 /* Asynchronous timer for polling. */
2237 struct atimer
*poll_timer
;
2240 #ifdef POLL_FOR_INPUT
2242 /* Poll for input, so what we catch a C-g if it comes in. This
2243 function is called from x_make_frame_visible, see comment
2249 if (interrupt_input_blocked
== 0
2250 && !waiting_for_input
)
2251 read_avail_input (0);
2254 /* Timer callback function for poll_timer. TIMER is equal to
2258 poll_for_input (timer
)
2259 struct atimer
*timer
;
2261 if (poll_suppress_count
== 0)
2263 interrupt_input_pending
= 1;
2265 poll_for_input_1 ();
2269 #endif /* POLL_FOR_INPUT */
2271 /* Begin signals to poll for input, if they are appropriate.
2272 This function is called unconditionally from various places. */
2277 #ifdef POLL_FOR_INPUT
2278 /* XXX This condition was (read_socket_hook && !interrupt_input),
2279 but read_socket_hook is not global anymore. Let's pretend that
2281 if (!interrupt_input
)
2283 /* Turn alarm handling on unconditionally. It might have
2284 been turned off in process.c. */
2285 turn_on_atimers (1);
2287 /* If poll timer doesn't exist, are we need one with
2288 a different interval, start a new one. */
2289 if (poll_timer
== NULL
2290 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2292 EMACS_TIME interval
;
2295 cancel_atimer (poll_timer
);
2297 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2298 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2299 poll_for_input
, NULL
);
2302 /* Let the timer's callback function poll for input
2303 if this becomes zero. */
2304 --poll_suppress_count
;
2309 /* Nonzero if we are using polling to handle input asynchronously. */
2312 input_polling_used ()
2314 #ifdef POLL_FOR_INPUT
2315 /* XXX This condition was (read_socket_hook && !interrupt_input),
2316 but read_socket_hook is not global anymore. Let's pretend that
2318 return !interrupt_input
;
2324 /* Turn off polling. */
2329 #ifdef POLL_FOR_INPUT
2330 /* XXX This condition was (read_socket_hook && !interrupt_input),
2331 but read_socket_hook is not global anymore. Let's pretend that
2333 if (!interrupt_input
)
2334 ++poll_suppress_count
;
2338 /* Set the value of poll_suppress_count to COUNT
2339 and start or stop polling accordingly. */
2342 set_poll_suppress_count (count
)
2345 #ifdef POLL_FOR_INPUT
2346 if (count
== 0 && poll_suppress_count
!= 0)
2348 poll_suppress_count
= 1;
2351 else if (count
!= 0 && poll_suppress_count
== 0)
2355 poll_suppress_count
= count
;
2359 /* Bind polling_period to a value at least N.
2360 But don't decrease it. */
2363 bind_polling_period (n
)
2366 #ifdef POLL_FOR_INPUT
2367 int new = polling_period
;
2372 stop_other_atimers (poll_timer
);
2374 specbind (Qpolling_period
, make_number (new));
2375 /* Start a new alarm with the new period. */
2380 /* Apply the control modifier to CHARACTER. */
2386 /* Save the upper bits here. */
2387 int upper
= c
& ~0177;
2391 /* Everything in the columns containing the upper-case letters
2392 denotes a control character. */
2393 if (c
>= 0100 && c
< 0140)
2397 /* Set the shift modifier for a control char
2398 made from a shifted letter. But only for letters! */
2399 if (oc
>= 'A' && oc
<= 'Z')
2400 c
|= shift_modifier
;
2403 /* The lower-case letters denote control characters too. */
2404 else if (c
>= 'a' && c
<= 'z')
2407 /* Include the bits for control and shift
2408 only if the basic ASCII code can't indicate them. */
2412 /* Replace the high bits. */
2413 c
|= (upper
& ~ctrl_modifier
);
2418 /* Display the help-echo property of the character after the mouse pointer.
2419 Either show it in the echo area, or call show-help-function to display
2420 it by other means (maybe in a tooltip).
2422 If HELP is nil, that means clear the previous help echo.
2424 If HELP is a string, display that string. If HELP is a function,
2425 call it with OBJECT and POS as arguments; the function should
2426 return a help string or nil for none. For all other types of HELP,
2427 evaluate it to obtain a string.
2429 WINDOW is the window in which the help was generated, if any.
2430 It is nil if not in a window.
2432 If OBJECT is a buffer, POS is the position in the buffer where the
2433 `help-echo' text property was found.
2435 If OBJECT is an overlay, that overlay has a `help-echo' property,
2436 and POS is the position in the overlay's buffer under the mouse.
2438 If OBJECT is a string (an overlay string or a string displayed with
2439 the `display' property). POS is the position in that string under
2442 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2443 echo overwrites a keystroke echo currently displayed in the echo
2446 Note: this function may only be called with HELP nil or a string
2447 from X code running asynchronously. */
2450 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2451 Lisp_Object help
, window
, object
, pos
;
2452 int ok_to_overwrite_keystroke_echo
;
2454 if (!NILP (help
) && !STRINGP (help
))
2456 if (FUNCTIONP (help
))
2458 Lisp_Object args
[4];
2463 help
= safe_call (4, args
);
2466 help
= safe_eval (help
);
2468 if (!STRINGP (help
))
2472 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2473 if (!noninteractive
&& STRINGP (help
))
2475 /* The mouse-fixup-help-message Lisp function can call
2476 mouse_position_hook, which resets the mouse_moved flags.
2477 This causes trouble if we are trying to read a mouse motion
2478 event (i.e., if we are inside a `track-mouse' form), so we
2479 restore the mouse_moved flag. */
2480 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2481 help
= call1 (Qmouse_fixup_help_message
, help
);
2487 if (STRINGP (help
) || NILP (help
))
2489 if (!NILP (Vshow_help_function
))
2490 call1 (Vshow_help_function
, help
);
2491 else if (/* Don't overwrite minibuffer contents. */
2492 !MINI_WINDOW_P (XWINDOW (selected_window
))
2493 /* Don't overwrite a keystroke echo. */
2494 && (NILP (echo_message_buffer
)
2495 || ok_to_overwrite_keystroke_echo
)
2496 /* Don't overwrite a prompt. */
2497 && !cursor_in_echo_area
)
2501 int count
= SPECPDL_INDEX ();
2503 if (!help_echo_showing_p
)
2504 Vpre_help_message
= current_message ();
2506 specbind (Qmessage_truncate_lines
, Qt
);
2507 message3_nolog (help
, SBYTES (help
),
2508 STRING_MULTIBYTE (help
));
2509 unbind_to (count
, Qnil
);
2511 else if (STRINGP (Vpre_help_message
))
2513 message3_nolog (Vpre_help_message
,
2514 SBYTES (Vpre_help_message
),
2515 STRING_MULTIBYTE (Vpre_help_message
));
2516 Vpre_help_message
= Qnil
;
2522 help_echo_showing_p
= STRINGP (help
);
2528 /* Input of single characters from keyboard */
2530 Lisp_Object
print_help ();
2531 static Lisp_Object
kbd_buffer_get_event ();
2532 static void record_char ();
2534 static Lisp_Object help_form_saved_window_configs
;
2536 read_char_help_form_unwind (arg
)
2538 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2539 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2540 if (!NILP (window_config
))
2541 Fset_window_configuration (window_config
);
2545 #define STOP_POLLING \
2546 do { if (! polling_stopped_here) stop_polling (); \
2547 polling_stopped_here = 1; } while (0)
2549 #define RESUME_POLLING \
2550 do { if (polling_stopped_here) start_polling (); \
2551 polling_stopped_here = 0; } while (0)
2553 /* read a character from the keyboard; call the redisplay if needed */
2554 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2555 -1 means do not do redisplay, but do do autosaving.
2558 /* The arguments MAPS and NMAPS are for menu prompting.
2559 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2561 PREV_EVENT is the previous input event, or nil if we are reading
2562 the first event of a key sequence (or not reading a key sequence).
2563 If PREV_EVENT is t, that is a "magic" value that says
2564 not to run input methods, but in other respects to act as if
2565 not reading a key sequence.
2567 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2568 if we used a mouse menu to read the input, or zero otherwise. If
2569 USED_MOUSE_MENU is null, we don't dereference it.
2571 Value is -2 when we find input on another keyboard. A second call
2572 to read_char will read it.
2574 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2575 specifying the maximum time to wait until. If no input arrives by
2576 that time, stop waiting and return nil.
2578 Value is t if we showed a menu and the user rejected it. */
2581 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2585 Lisp_Object prev_event
;
2586 int *used_mouse_menu
;
2587 EMACS_TIME
*end_time
;
2589 volatile Lisp_Object c
;
2590 int count
, jmpcount
;
2591 jmp_buf local_getcjmp
;
2593 volatile int key_already_recorded
= 0;
2594 Lisp_Object tem
, save
;
2595 volatile Lisp_Object previous_echo_area_message
;
2596 volatile Lisp_Object also_record
;
2597 volatile int reread
;
2598 struct gcpro gcpro1
, gcpro2
;
2599 int polling_stopped_here
= 0;
2600 struct kboard
*orig_kboard
= current_kboard
;
2604 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2605 before_command_key_count
= this_command_key_count
;
2606 before_command_echo_length
= echo_length ();
2609 previous_echo_area_message
= Qnil
;
2611 GCPRO2 (c
, previous_echo_area_message
);
2616 if (CONSP (Vunread_post_input_method_events
))
2618 c
= XCAR (Vunread_post_input_method_events
);
2619 Vunread_post_input_method_events
2620 = XCDR (Vunread_post_input_method_events
);
2622 /* Undo what read_char_x_menu_prompt did when it unread
2623 additional keys returned by Fx_popup_menu. */
2625 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2633 if (unread_command_char
!= -1)
2635 XSETINT (c
, unread_command_char
);
2636 unread_command_char
= -1;
2642 if (CONSP (Vunread_command_events
))
2644 c
= XCAR (Vunread_command_events
);
2645 Vunread_command_events
= XCDR (Vunread_command_events
);
2649 /* Undo what sit-for did when it unread additional keys
2650 inside universal-argument. */
2653 && EQ (XCAR (c
), Qt
))
2659 /* Undo what read_char_x_menu_prompt did when it unread
2660 additional keys returned by Fx_popup_menu. */
2662 && EQ (XCDR (c
), Qdisabled
)
2663 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2666 /* If the queued event is something that used the mouse,
2667 set used_mouse_menu accordingly. */
2669 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2670 *used_mouse_menu
= 1;
2672 goto reread_for_input_method
;
2675 if (CONSP (Vunread_input_method_events
))
2677 c
= XCAR (Vunread_input_method_events
);
2678 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2680 /* Undo what read_char_x_menu_prompt did when it unread
2681 additional keys returned by Fx_popup_menu. */
2683 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2687 goto reread_for_input_method
;
2690 this_command_key_count_reset
= 0;
2692 if (!NILP (Vexecuting_kbd_macro
))
2694 /* We set this to Qmacro; since that's not a frame, nobody will
2695 try to switch frames on us, and the selected window will
2698 Since this event came from a macro, it would be misleading to
2699 leave internal_last_event_frame set to wherever the last
2700 real event came from. Normally, a switch-frame event selects
2701 internal_last_event_frame after each command is read, but
2702 events read from a macro should never cause a new frame to be
2704 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2706 /* Exit the macro if we are at the end.
2707 Also, some things replace the macro with t
2708 to force an early exit. */
2709 if (EQ (Vexecuting_kbd_macro
, Qt
)
2710 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2716 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2717 if (STRINGP (Vexecuting_kbd_macro
)
2718 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2719 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2721 executing_kbd_macro_index
++;
2726 if (!NILP (unread_switch_frame
))
2728 c
= unread_switch_frame
;
2729 unread_switch_frame
= Qnil
;
2731 /* This event should make it into this_command_keys, and get echoed
2732 again, so we do not set `reread'. */
2736 /* if redisplay was requested */
2737 if (commandflag
>= 0)
2739 /* If there is pending input, process any events which are not
2740 user-visible, such as X selection_request events. */
2742 || detect_input_pending_run_timers (0))
2743 swallow_events (0); /* may clear input_pending */
2745 /* Redisplay if no pending input. */
2746 while (!input_pending
)
2748 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2749 redisplay_preserve_echo_area (5);
2754 /* Normal case: no input arrived during redisplay. */
2757 /* Input arrived and pre-empted redisplay.
2758 Process any events which are not user-visible. */
2760 /* If that cleared input_pending, try again to redisplay. */
2764 /* Message turns off echoing unless more keystrokes turn it on again.
2766 The code in 20.x for the condition was
2768 1. echo_area_glyphs && *echo_area_glyphs
2769 2. && echo_area_glyphs != current_kboard->echobuf
2770 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2772 (1) means there's a current message displayed
2774 (2) means it's not the message from echoing from the current
2777 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2778 is set to a non-null value. This is done in read_char and it is
2779 set to echo_area_glyphs after a call to echo_char. That means
2780 ok_to_echo_at_next_pause is either null or
2781 current_kboard->echobuf with the appropriate current_kboard at
2784 So, condition (3) means in clear text ok_to_echo_at_next_pause
2785 must be either null, or the current message isn't from echoing at
2786 all, or it's from echoing from a different kboard than the
2789 if (/* There currently is something in the echo area. */
2790 !NILP (echo_area_buffer
[0])
2791 && (/* And it's either not from echoing. */
2792 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2793 /* Or it's an echo from a different kboard. */
2794 || echo_kboard
!= current_kboard
2795 /* Or we explicitly allow overwriting whatever there is. */
2796 || ok_to_echo_at_next_pause
== NULL
))
2801 /* Try reading a character via menu prompting in the minibuf.
2802 Try this before the sit-for, because the sit-for
2803 would do the wrong thing if we are supposed to do
2804 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2805 after a mouse event so don't try a minibuf menu. */
2807 if (nmaps
> 0 && INTERACTIVE
2808 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2809 /* Don't bring up a menu if we already have another event. */
2810 && NILP (Vunread_command_events
)
2811 && unread_command_char
< 0
2812 && !detect_input_pending_run_timers (0))
2814 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2816 if (INTEGERP (c
) && XINT (c
) == -2)
2817 return c
; /* wrong_kboard_jmpbuf */
2821 key_already_recorded
= 1;
2826 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2827 We will do that below, temporarily for short sections of code,
2828 when appropriate. local_getcjmp must be in effect
2829 around any call to sit_for or kbd_buffer_get_event;
2830 it *must not* be in effect when we call redisplay. */
2832 jmpcount
= SPECPDL_INDEX ();
2833 if (_setjmp (local_getcjmp
))
2835 /* Handle quits while reading the keyboard. */
2836 /* We must have saved the outer value of getcjmp here,
2837 so restore it now. */
2838 restore_getcjmp (save_jump
);
2839 unbind_to (jmpcount
, Qnil
);
2840 XSETINT (c
, quit_char
);
2841 internal_last_event_frame
= selected_frame
;
2842 Vlast_event_frame
= internal_last_event_frame
;
2843 /* If we report the quit char as an event,
2844 don't do so more than once. */
2845 if (!NILP (Vinhibit_quit
))
2850 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2851 if (kb
!= current_kboard
)
2853 Lisp_Object link
= kb
->kbd_queue
;
2854 /* We shouldn't get here if we were in single-kboard mode! */
2859 while (CONSP (XCDR (link
)))
2861 if (!NILP (XCDR (link
)))
2865 kb
->kbd_queue
= Fcons (c
, Qnil
);
2867 XSETCDR (link
, Fcons (c
, Qnil
));
2868 kb
->kbd_queue_has_data
= 1;
2869 current_kboard
= kb
;
2870 /* This is going to exit from read_char
2871 so we had better get rid of this frame's stuff. */
2873 return make_number (-2); /* wrong_kboard_jmpbuf */
2880 /* Start idle timers if no time limit is supplied. We don't do it
2881 if a time limit is supplied to avoid an infinite recursion in the
2882 situation where an idle timer calls `sit-for'. */
2885 timer_start_idle ();
2887 /* If in middle of key sequence and minibuffer not active,
2888 start echoing if enough time elapses. */
2890 if (minibuf_level
== 0
2892 && !current_kboard
->immediate_echo
2893 && this_command_key_count
> 0
2895 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2896 && NILP (Fzerop (Vecho_keystrokes
))
2897 && (/* No message. */
2898 NILP (echo_area_buffer
[0])
2899 /* Or empty message. */
2900 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2901 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2902 /* Or already echoing from same kboard. */
2903 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2904 /* Or not echoing before and echoing allowed. */
2905 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2907 /* After a mouse event, start echoing right away.
2908 This is because we are probably about to display a menu,
2909 and we don't want to delay before doing so. */
2910 if (EVENT_HAS_PARAMETERS (prev_event
))
2916 save_getcjmp (save_jump
);
2917 restore_getcjmp (local_getcjmp
);
2918 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2919 restore_getcjmp (save_jump
);
2921 && ! CONSP (Vunread_command_events
))
2926 /* Maybe auto save due to number of keystrokes. */
2928 if (commandflag
!= 0
2929 && auto_save_interval
> 0
2930 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2931 && !detect_input_pending_run_timers (0))
2933 Fdo_auto_save (Qnil
, Qnil
);
2934 /* Hooks can actually change some buffers in auto save. */
2938 /* Try reading using an X menu.
2939 This is never confused with reading using the minibuf
2940 because the recursive call of read_char in read_char_minibuf_menu_prompt
2941 does not pass on any keymaps. */
2943 if (nmaps
> 0 && INTERACTIVE
2944 && !NILP (prev_event
)
2945 && EVENT_HAS_PARAMETERS (prev_event
)
2946 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2947 && !EQ (XCAR (prev_event
), Qtool_bar
)
2948 /* Don't bring up a menu if we already have another event. */
2949 && NILP (Vunread_command_events
)
2950 && unread_command_char
< 0)
2952 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2954 /* Now that we have read an event, Emacs is not idle. */
2961 /* Maybe autosave and/or garbage collect due to idleness. */
2963 if (INTERACTIVE
&& NILP (c
))
2965 int delay_level
, buffer_size
;
2967 /* Slow down auto saves logarithmically in size of current buffer,
2968 and garbage collect while we're at it. */
2969 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2970 last_non_minibuf_size
= Z
- BEG
;
2971 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2973 while (buffer_size
> 64)
2974 delay_level
++, buffer_size
-= buffer_size
>> 2;
2975 if (delay_level
< 4) delay_level
= 4;
2976 /* delay_level is 4 for files under around 50k, 7 at 100k,
2977 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2979 /* Auto save if enough time goes by without input. */
2980 if (commandflag
!= 0
2981 && num_nonmacro_input_events
> last_auto_save
2982 && INTEGERP (Vauto_save_timeout
)
2983 && XINT (Vauto_save_timeout
) > 0)
2986 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2988 save_getcjmp (save_jump
);
2989 restore_getcjmp (local_getcjmp
);
2990 tem0
= sit_for (make_number (timeout
), 1, 1);
2991 restore_getcjmp (save_jump
);
2994 && ! CONSP (Vunread_command_events
))
2996 Fdo_auto_save (Qnil
, Qnil
);
2998 /* If we have auto-saved and there is still no input
2999 available, garbage collect if there has been enough
3000 consing going on to make it worthwhile. */
3001 if (!detect_input_pending_run_timers (0)
3002 && consing_since_gc
> gc_cons_threshold
/ 2)
3003 Fgarbage_collect ();
3010 /* Notify the caller if an autosave hook, or a timer, sentinel or
3011 filter in the sit_for calls above have changed the current
3012 kboard. This could happen if they use the minibuffer or start a
3013 recursive edit, like the fancy splash screen in server.el's
3014 filter. If this longjmp wasn't here, read_key_sequence would
3015 interpret the next key sequence using the wrong translation
3016 tables and function keymaps. */
3017 if (NILP (c
) && current_kboard
!= orig_kboard
)
3020 return make_number (-2); /* wrong_kboard_jmpbuf */
3023 /* If this has become non-nil here, it has been set by a timer
3024 or sentinel or filter. */
3025 if (CONSP (Vunread_command_events
))
3027 c
= XCAR (Vunread_command_events
);
3028 Vunread_command_events
= XCDR (Vunread_command_events
);
3031 /* Read something from current KBOARD's side queue, if possible. */
3035 if (current_kboard
->kbd_queue_has_data
)
3037 if (!CONSP (current_kboard
->kbd_queue
))
3039 c
= XCAR (current_kboard
->kbd_queue
);
3040 current_kboard
->kbd_queue
3041 = XCDR (current_kboard
->kbd_queue
);
3042 if (NILP (current_kboard
->kbd_queue
))
3043 current_kboard
->kbd_queue_has_data
= 0;
3044 input_pending
= readable_events (0);
3045 if (EVENT_HAS_PARAMETERS (c
)
3046 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
3047 internal_last_event_frame
= XCAR (XCDR (c
));
3048 Vlast_event_frame
= internal_last_event_frame
;
3053 /* If current_kboard's side queue is empty check the other kboards.
3054 If one of them has data that we have not yet seen here,
3055 switch to it and process the data waiting for it.
3057 Note: if the events queued up for another kboard
3058 have already been seen here, and therefore are not a complete command,
3059 the kbd_queue_has_data field is 0, so we skip that kboard here.
3060 That's to avoid an infinite loop switching between kboards here. */
3061 if (NILP (c
) && !single_kboard
)
3064 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3065 if (kb
->kbd_queue_has_data
)
3067 current_kboard
= kb
;
3068 /* This is going to exit from read_char
3069 so we had better get rid of this frame's stuff. */
3071 return make_number (-2); /* wrong_kboard_jmpbuf */
3080 /* Finally, we read from the main queue,
3081 and if that gives us something we can't use yet, we put it on the
3082 appropriate side queue and try again. */
3091 EMACS_GET_TIME (now
);
3092 if (EMACS_TIME_GE (now
, *end_time
))
3096 /* Actually read a character, waiting if necessary. */
3097 save_getcjmp (save_jump
);
3098 restore_getcjmp (local_getcjmp
);
3100 timer_start_idle ();
3101 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3102 restore_getcjmp (save_jump
);
3105 if (! NILP (c
) && (kb
!= current_kboard
))
3107 Lisp_Object link
= kb
->kbd_queue
;
3110 while (CONSP (XCDR (link
)))
3112 if (!NILP (XCDR (link
)))
3116 kb
->kbd_queue
= Fcons (c
, Qnil
);
3118 XSETCDR (link
, Fcons (c
, Qnil
));
3119 kb
->kbd_queue_has_data
= 1;
3123 current_kboard
= kb
;
3124 /* This is going to exit from read_char
3125 so we had better get rid of this frame's stuff. */
3127 return make_number (-2);
3132 /* Terminate Emacs in batch mode if at eof. */
3133 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3134 Fkill_emacs (make_number (1));
3138 /* Add in any extra modifiers, where appropriate. */
3139 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3140 || ((extra_keyboard_modifiers
& 0177) < ' '
3141 && (extra_keyboard_modifiers
& 0177) != 0))
3142 XSETINT (c
, make_ctrl_char (XINT (c
)));
3144 /* Transfer any other modifier bits directly from
3145 extra_keyboard_modifiers to c. Ignore the actual character code
3146 in the low 16 bits of extra_keyboard_modifiers. */
3147 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3158 if (commandflag
>= 0
3159 && !input_pending
&& !detect_input_pending_run_timers (0))
3167 /* Buffer switch events are only for internal wakeups
3168 so don't show them to the user.
3169 Also, don't record a key if we already did. */
3170 if (BUFFERP (c
) || key_already_recorded
)
3173 /* Process special events within read_char
3174 and loop around to read another event. */
3177 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3182 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3183 int was_locked
= single_kboard
;
3184 int count
= SPECPDL_INDEX ();
3185 record_single_kboard_state ();
3188 last_input_char
= c
;
3189 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3191 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3192 /* We stopped being idle for this event; undo that. This
3193 prevents automatic window selection (under
3194 mouse_autoselect_window from acting as a real input event, for
3195 example banishing the mouse under mouse-avoidance-mode. */
3196 timer_resume_idle ();
3198 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3199 /* Resume allowing input from any kboard, if that was true before. */
3201 any_kboard_state ();
3202 unbind_to (count
, Qnil
);
3208 /* Handle things that only apply to characters. */
3211 /* If kbd_buffer_get_event gave us an EOF, return that. */
3215 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3216 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3217 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3218 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3219 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3220 && CHAR_VALID_P (XINT (c
), 0)))
3223 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3224 /* nil in keyboard-translate-table means no translation. */
3230 /* If this event is a mouse click in the menu bar,
3231 return just menu-bar for now. Modify the mouse click event
3232 so we won't do this twice, then queue it up. */
3233 if (EVENT_HAS_PARAMETERS (c
)
3235 && CONSP (EVENT_START (c
))
3236 && CONSP (XCDR (EVENT_START (c
))))
3240 posn
= POSN_POSN (EVENT_START (c
));
3241 /* Handle menu-bar events:
3242 insert the dummy prefix event `menu-bar'. */
3243 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3245 /* Change menu-bar to (menu-bar) as the event "position". */
3246 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3249 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3254 /* Store these characters into recent_keys, the dribble file if any,
3255 and the keyboard macro being defined, if any. */
3257 if (! NILP (also_record
))
3258 record_char (also_record
);
3260 /* Wipe the echo area.
3261 But first, if we are about to use an input method,
3262 save the echo area contents for it to refer to. */
3264 && ! NILP (Vinput_method_function
)
3265 && (unsigned) XINT (c
) >= ' '
3266 && (unsigned) XINT (c
) != 127
3267 && (unsigned) XINT (c
) < 256)
3269 previous_echo_area_message
= Fcurrent_message ();
3270 Vinput_method_previous_message
= previous_echo_area_message
;
3273 /* Now wipe the echo area, except for help events which do their
3274 own stuff with the echo area. */
3276 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3277 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3279 if (!NILP (echo_area_buffer
[0]))
3280 safe_run_hooks (Qecho_area_clear_hook
);
3281 clear_message (1, 0);
3284 reread_for_input_method
:
3286 /* Pass this to the input method, if appropriate. */
3288 && ! NILP (Vinput_method_function
)
3289 /* Don't run the input method within a key sequence,
3290 after the first event of the key sequence. */
3291 && NILP (prev_event
)
3292 && (unsigned) XINT (c
) >= ' '
3293 && (unsigned) XINT (c
) != 127
3294 && (unsigned) XINT (c
) < 256)
3297 int key_count
, key_count_reset
;
3298 struct gcpro gcpro1
;
3299 int count
= SPECPDL_INDEX ();
3301 /* Save the echo status. */
3302 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3303 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3304 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3305 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3308 if (before_command_restore_flag
)
3310 this_command_key_count
= before_command_key_count_1
;
3311 if (this_command_key_count
< this_single_command_key_start
)
3312 this_single_command_key_start
= this_command_key_count
;
3313 echo_truncate (before_command_echo_length_1
);
3314 before_command_restore_flag
= 0;
3318 /* Save the this_command_keys status. */
3319 key_count
= this_command_key_count
;
3320 key_count_reset
= this_command_key_count_reset
;
3323 keys
= Fcopy_sequence (this_command_keys
);
3328 /* Clear out this_command_keys. */
3329 this_command_key_count
= 0;
3330 this_command_key_count_reset
= 0;
3332 /* Now wipe the echo area. */
3333 if (!NILP (echo_area_buffer
[0]))
3334 safe_run_hooks (Qecho_area_clear_hook
);
3335 clear_message (1, 0);
3338 /* If we are not reading a key sequence,
3339 never use the echo area. */
3342 specbind (Qinput_method_use_echo_area
, Qt
);
3345 /* Call the input method. */
3346 tem
= call1 (Vinput_method_function
, c
);
3348 tem
= unbind_to (count
, tem
);
3350 /* Restore the saved echoing state
3351 and this_command_keys state. */
3352 this_command_key_count
= key_count
;
3353 this_command_key_count_reset
= key_count_reset
;
3355 this_command_keys
= keys
;
3358 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3359 current_kboard
->echo_string
= saved_echo_string
;
3360 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3361 if (saved_immediate_echo
)
3366 /* The input method can return no events. */
3369 /* Bring back the previous message, if any. */
3370 if (! NILP (previous_echo_area_message
))
3371 message_with_string ("%s", previous_echo_area_message
, 0);
3374 /* It returned one event or more. */
3376 Vunread_post_input_method_events
3377 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3382 /* Display help if not echoing. */
3383 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3385 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3386 Lisp_Object help
, object
, position
, window
, tem
;
3388 tem
= Fcdr (XCDR (c
));
3391 window
= Fcar (tem
);
3393 object
= Fcar (tem
);
3395 position
= Fcar (tem
);
3397 show_help_echo (help
, window
, object
, position
, 0);
3399 /* We stopped being idle for this event; undo that. */
3401 timer_resume_idle ();
3405 if ((! reread
|| this_command_key_count
== 0
3406 || this_command_key_count_reset
)
3410 /* Don't echo mouse motion events. */
3411 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3412 && NILP (Fzerop (Vecho_keystrokes
))
3413 && ! (EVENT_HAS_PARAMETERS (c
)
3414 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3417 if (! NILP (also_record
))
3418 echo_char (also_record
);
3419 /* Once we reread a character, echoing can happen
3420 the next time we pause to read a new one. */
3421 ok_to_echo_at_next_pause
= current_kboard
;
3424 /* Record this character as part of the current key. */
3425 add_command_key (c
);
3426 if (! NILP (also_record
))
3427 add_command_key (also_record
);
3430 last_input_char
= c
;
3433 /* Process the help character specially if enabled */
3434 if (!NILP (Vhelp_form
) && help_char_p (c
))
3437 count
= SPECPDL_INDEX ();
3439 help_form_saved_window_configs
3440 = Fcons (Fcurrent_window_configuration (Qnil
),
3441 help_form_saved_window_configs
);
3442 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3444 tem0
= Feval (Vhelp_form
);
3446 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3451 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3452 if (EVENT_HAS_PARAMETERS (c
)
3453 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3454 XSETCAR (help_form_saved_window_configs
, Qnil
);
3456 while (BUFFERP (c
));
3457 /* Remove the help from the frame */
3458 unbind_to (count
, Qnil
);
3461 if (EQ (c
, make_number (040)))
3465 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3466 while (BUFFERP (c
));
3475 /* Record a key that came from a mouse menu.
3476 Record it for echoing, for this-command-keys, and so on. */
3482 /* Wipe the echo area. */
3483 clear_message (1, 0);
3488 before_command_key_count
= this_command_key_count
;
3489 before_command_echo_length
= echo_length ();
3492 /* Don't echo mouse motion events. */
3493 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3494 && NILP (Fzerop (Vecho_keystrokes
)))
3498 /* Once we reread a character, echoing can happen
3499 the next time we pause to read a new one. */
3500 ok_to_echo_at_next_pause
= 0;
3503 /* Record this character as part of the current key. */
3504 add_command_key (c
);
3506 /* Re-reading in the middle of a command */
3507 last_input_char
= c
;
3511 /* Return 1 if should recognize C as "the help character". */
3519 if (EQ (c
, Vhelp_char
))
3521 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3522 if (EQ (c
, XCAR (tail
)))
3527 /* Record the input event C in various ways. */
3535 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3537 /* To avoid filling recent_keys with help-echo and mouse-movement
3538 events, we filter out repeated help-echo events, only store the
3539 first and last in a series of mouse-movement events, and don't
3540 store repeated help-echo events which are only separated by
3541 mouse-movement events. */
3543 Lisp_Object ev1
, ev2
, ev3
;
3546 if ((ix1
= recent_keys_index
- 1) < 0)
3547 ix1
= NUM_RECENT_KEYS
- 1;
3548 ev1
= AREF (recent_keys
, ix1
);
3550 if ((ix2
= ix1
- 1) < 0)
3551 ix2
= NUM_RECENT_KEYS
- 1;
3552 ev2
= AREF (recent_keys
, ix2
);
3554 if ((ix3
= ix2
- 1) < 0)
3555 ix3
= NUM_RECENT_KEYS
- 1;
3556 ev3
= AREF (recent_keys
, ix3
);
3558 if (EQ (XCAR (c
), Qhelp_echo
))
3560 /* Don't record `help-echo' in recent_keys unless it shows some help
3561 message, and a different help than the previously recorded
3563 Lisp_Object help
, last_help
;
3565 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3566 if (!STRINGP (help
))
3568 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3569 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3571 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3572 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3573 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3575 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3576 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3577 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3578 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3581 else if (EQ (XCAR (c
), Qmouse_movement
))
3583 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3584 So additional mouse movement events replace the last element. */
3585 Lisp_Object last_window
, window
;
3587 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3588 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3589 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3590 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3591 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3593 ASET (recent_keys
, ix1
, c
);
3599 store_kbd_macro_char (c
);
3604 ASET (recent_keys
, recent_keys_index
, c
);
3605 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3606 recent_keys_index
= 0;
3608 else if (recorded
< 0)
3610 /* We need to remove one or two events from recent_keys.
3611 To do this, we simply put nil at those events and move the
3612 recent_keys_index backwards over those events. Usually,
3613 users will never see those nil events, as they will be
3614 overwritten by the command keys entered to see recent_keys
3617 while (recorded
++ < 0 && total_keys
> 0)
3619 if (total_keys
< NUM_RECENT_KEYS
)
3621 if (--recent_keys_index
< 0)
3622 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3623 ASET (recent_keys
, recent_keys_index
, Qnil
);
3627 num_nonmacro_input_events
++;
3629 /* Write c to the dribble file. If c is a lispy event, write
3630 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3631 If you, dear reader, have a better idea, you've got the source. :-) */
3637 if (XUINT (c
) < 0x100)
3638 putc (XINT (c
), dribble
);
3640 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3644 Lisp_Object dribblee
;
3646 /* If it's a structured event, take the event header. */
3647 dribblee
= EVENT_HEAD (c
);
3649 if (SYMBOLP (dribblee
))
3651 putc ('<', dribble
);
3652 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3653 SBYTES (SYMBOL_NAME (dribblee
)),
3655 putc ('>', dribble
);
3668 struct buffer
*old
= current_buffer
;
3669 Fprinc (object
, Qnil
);
3670 set_buffer_internal (XBUFFER (Vstandard_output
));
3671 call0 (intern ("help-mode"));
3672 set_buffer_internal (old
);
3676 /* Copy out or in the info on where C-g should throw to.
3677 This is used when running Lisp code from within get_char,
3678 in case get_char is called recursively.
3679 See read_process_output. */
3685 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3689 restore_getcjmp (temp
)
3692 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3695 /* Low level keyboard/mouse input.
3696 kbd_buffer_store_event places events in kbd_buffer, and
3697 kbd_buffer_get_event retrieves them. */
3699 /* Return true if there are any events in the queue that read-char
3700 would return. If this returns false, a read-char would block. */
3702 readable_events (flags
)
3705 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3708 /* If the buffer contains only FOCUS_IN_EVENT events, and
3709 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3710 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3712 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3713 #ifdef USE_TOOLKIT_SCROLL_BARS
3714 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3718 struct input_event
*event
;
3720 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3727 #ifdef USE_TOOLKIT_SCROLL_BARS
3728 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3730 event
->kind
== FOCUS_IN_EVENT
)
3731 #ifdef USE_TOOLKIT_SCROLL_BARS
3732 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3733 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3734 && event
->part
== scroll_bar_handle
3735 && event
->modifiers
== 0)
3740 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3743 while (event
!= kbd_store_ptr
);
3749 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3750 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3751 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3756 if (current_kboard
->kbd_queue_has_data
)
3762 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3763 if (kb
->kbd_queue_has_data
)
3769 /* Set this for debugging, to have a way to get out */
3774 event_to_kboard (event
)
3775 struct input_event
*event
;
3778 frame
= event
->frame_or_window
;
3780 frame
= XCAR (frame
);
3781 else if (WINDOWP (frame
))
3782 frame
= WINDOW_FRAME (XWINDOW (frame
));
3784 /* There are still some events that don't set this field.
3785 For now, just ignore the problem.
3786 Also ignore dead frames here. */
3787 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3790 return FRAME_KBOARD (XFRAME (frame
));
3795 Lisp_Object Vthrow_on_input
;
3797 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3800 kbd_buffer_store_event (event
)
3801 register struct input_event
*event
;
3803 kbd_buffer_store_event_hold (event
, 0);
3806 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3808 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3809 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3810 Else, if EVENT is a quit event, store the quit event
3811 in HOLD_QUIT, and return (thus ignoring further events).
3813 This is used in read_avail_input to postpone the processing
3814 of the quit event until all subsequent input events have been
3815 parsed (and discarded).
3819 kbd_buffer_store_event_hold (event
, hold_quit
)
3820 register struct input_event
*event
;
3821 struct input_event
*hold_quit
;
3823 if (event
->kind
== NO_EVENT
)
3826 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3829 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3831 register int c
= event
->code
& 0377;
3833 if (event
->modifiers
& ctrl_modifier
)
3834 c
= make_ctrl_char (c
);
3836 c
|= (event
->modifiers
3837 & (meta_modifier
| alt_modifier
3838 | hyper_modifier
| super_modifier
));
3843 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3844 struct input_event
*sp
;
3846 if (single_kboard
&& kb
!= current_kboard
)
3849 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3850 Fcons (make_number (c
), Qnil
));
3851 kb
->kbd_queue_has_data
= 1;
3852 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3854 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3857 if (event_to_kboard (sp
) == kb
)
3859 sp
->kind
= NO_EVENT
;
3860 sp
->frame_or_window
= Qnil
;
3870 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3874 /* If this results in a quit_char being returned to Emacs as
3875 input, set Vlast_event_frame properly. If this doesn't
3876 get returned to Emacs as an event, the next event read
3877 will set Vlast_event_frame again, so this is safe to do. */
3881 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3883 focus
= event
->frame_or_window
;
3884 internal_last_event_frame
= focus
;
3885 Vlast_event_frame
= focus
;
3888 last_event_timestamp
= event
->timestamp
;
3889 handle_interrupt ();
3893 if (c
&& c
== stop_character
)
3899 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3900 Just ignore the second one. */
3901 else if (event
->kind
== BUFFER_SWITCH_EVENT
3902 && kbd_fetch_ptr
!= kbd_store_ptr
3903 && ((kbd_store_ptr
== kbd_buffer
3904 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3905 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3908 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3909 kbd_store_ptr
= kbd_buffer
;
3911 /* Don't let the very last slot in the buffer become full,
3912 since that would make the two pointers equal,
3913 and that is indistinguishable from an empty buffer.
3914 Discard the event if it would fill the last slot. */
3915 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3917 *kbd_store_ptr
= *event
;
3921 /* If we're inside while-no-input, and this event qualifies
3922 as input, set quit-flag to cause an interrupt. */
3923 if (!NILP (Vthrow_on_input
)
3924 && event
->kind
!= FOCUS_IN_EVENT
3925 && event
->kind
!= HELP_EVENT
3926 && event
->kind
!= DEICONIFY_EVENT
)
3928 Vquit_flag
= Vthrow_on_input
;
3929 /* If we're inside a function that wants immediate quits,
3931 if (immediate_quit
&& NILP (Vinhibit_quit
))
3941 /* Put an input event back in the head of the event queue. */
3944 kbd_buffer_unget_event (event
)
3945 register struct input_event
*event
;
3947 if (kbd_fetch_ptr
== kbd_buffer
)
3948 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3950 /* Don't let the very last slot in the buffer become full, */
3951 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3954 *kbd_fetch_ptr
= *event
;
3959 /* Generate HELP_EVENT input_events in BUFP which has room for
3960 SIZE events. If there's not enough room in BUFP, ignore this
3963 HELP is the help form.
3965 FRAME is the frame on which the help is generated. OBJECT is the
3966 Lisp object where the help was found (a buffer, a string, an
3967 overlay, or nil if neither from a string nor from a buffer. POS is
3968 the position within OBJECT where the help was found.
3970 Value is the number of input_events generated. */
3973 gen_help_event (help
, frame
, window
, object
, pos
)
3974 Lisp_Object help
, frame
, object
, window
;
3977 struct input_event event
;
3981 event
.kind
= HELP_EVENT
;
3982 event
.frame_or_window
= frame
;
3984 event
.x
= WINDOWP (window
) ? window
: frame
;
3987 kbd_buffer_store_event (&event
);
3991 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3994 kbd_buffer_store_help_event (frame
, help
)
3995 Lisp_Object frame
, help
;
3997 struct input_event event
;
3999 event
.kind
= HELP_EVENT
;
4000 event
.frame_or_window
= frame
;
4005 kbd_buffer_store_event (&event
);
4009 /* Discard any mouse events in the event buffer by setting them to
4012 discard_mouse_events ()
4014 struct input_event
*sp
;
4015 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
4017 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4020 if (sp
->kind
== MOUSE_CLICK_EVENT
4021 || sp
->kind
== WHEEL_EVENT
4022 || sp
->kind
== HORIZ_WHEEL_EVENT
4024 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
4027 || sp
->kind
== GPM_CLICK_EVENT
4029 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
4031 sp
->kind
= NO_EVENT
;
4037 /* Return non-zero if there are any real events waiting in the event
4038 buffer, not counting `NO_EVENT's.
4040 If DISCARD is non-zero, discard NO_EVENT events at the front of
4041 the input queue, possibly leaving the input queue empty if there
4042 are no real input events. */
4045 kbd_buffer_events_waiting (discard
)
4048 struct input_event
*sp
;
4050 for (sp
= kbd_fetch_ptr
;
4051 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4054 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4061 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4065 /* Clear input event EVENT. */
4069 struct input_event
*event
;
4071 event
->kind
= NO_EVENT
;
4075 /* Read one event from the event buffer, waiting if necessary.
4076 The value is a Lisp object representing the event.
4077 The value is nil for an event that should be ignored,
4078 or that was handled here.
4079 We always read and discard one event. */
4082 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4084 int *used_mouse_menu
;
4085 EMACS_TIME
*end_time
;
4094 *kbp
= current_kboard
;
4098 /* Wait until there is input available. */
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.
4717 The value is returned as 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 microsecond count is zero on systems that do not provide
4723 resolution finer than a second. */)
4726 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4728 EMACS_TIME now
, idleness_now
;
4730 EMACS_GET_TIME (now
);
4731 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4733 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4734 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4735 make_number (EMACS_USECS (idleness_now
)));
4741 /* Caches for modify_event_symbol. */
4742 static Lisp_Object accent_key_syms
;
4743 static Lisp_Object func_key_syms
;
4744 static Lisp_Object mouse_syms
;
4745 static Lisp_Object wheel_syms
;
4746 static Lisp_Object drag_n_drop_syms
;
4748 /* This is a list of keysym codes for special "accent" characters.
4749 It parallels lispy_accent_keys. */
4751 static int lispy_accent_codes
[] =
4753 #ifdef XK_dead_circumflex
4758 #ifdef XK_dead_grave
4763 #ifdef XK_dead_tilde
4768 #ifdef XK_dead_diaeresis
4773 #ifdef XK_dead_macron
4778 #ifdef XK_dead_degree
4783 #ifdef XK_dead_acute
4788 #ifdef XK_dead_cedilla
4793 #ifdef XK_dead_breve
4798 #ifdef XK_dead_ogonek
4803 #ifdef XK_dead_caron
4808 #ifdef XK_dead_doubleacute
4809 XK_dead_doubleacute
,
4813 #ifdef XK_dead_abovedot
4818 #ifdef XK_dead_abovering
4828 #ifdef XK_dead_belowdot
4833 #ifdef XK_dead_voiced_sound
4834 XK_dead_voiced_sound
,
4838 #ifdef XK_dead_semivoiced_sound
4839 XK_dead_semivoiced_sound
,
4855 /* This is a list of Lisp names for special "accent" characters.
4856 It parallels lispy_accent_codes. */
4858 static char *lispy_accent_keys
[] =
4876 "dead-voiced-sound",
4877 "dead-semivoiced-sound",
4883 #define FUNCTION_KEY_OFFSET 0x0
4885 char *lispy_function_keys
[] =
4889 0, /* VK_LBUTTON 0x01 */
4890 0, /* VK_RBUTTON 0x02 */
4891 "cancel", /* VK_CANCEL 0x03 */
4892 0, /* VK_MBUTTON 0x04 */
4894 0, 0, 0, /* 0x05 .. 0x07 */
4896 "backspace", /* VK_BACK 0x08 */
4897 "tab", /* VK_TAB 0x09 */
4899 0, 0, /* 0x0A .. 0x0B */
4901 "clear", /* VK_CLEAR 0x0C */
4902 "return", /* VK_RETURN 0x0D */
4904 0, 0, /* 0x0E .. 0x0F */
4906 0, /* VK_SHIFT 0x10 */
4907 0, /* VK_CONTROL 0x11 */
4908 0, /* VK_MENU 0x12 */
4909 "pause", /* VK_PAUSE 0x13 */
4910 "capslock", /* VK_CAPITAL 0x14 */
4912 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4914 "escape", /* VK_ESCAPE 0x1B */
4916 0, 0, 0, 0, /* 0x1C .. 0x1F */
4918 0, /* VK_SPACE 0x20 */
4919 "prior", /* VK_PRIOR 0x21 */
4920 "next", /* VK_NEXT 0x22 */
4921 "end", /* VK_END 0x23 */
4922 "home", /* VK_HOME 0x24 */
4923 "left", /* VK_LEFT 0x25 */
4924 "up", /* VK_UP 0x26 */
4925 "right", /* VK_RIGHT 0x27 */
4926 "down", /* VK_DOWN 0x28 */
4927 "select", /* VK_SELECT 0x29 */
4928 "print", /* VK_PRINT 0x2A */
4929 "execute", /* VK_EXECUTE 0x2B */
4930 "snapshot", /* VK_SNAPSHOT 0x2C */
4931 "insert", /* VK_INSERT 0x2D */
4932 "delete", /* VK_DELETE 0x2E */
4933 "help", /* VK_HELP 0x2F */
4935 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4937 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4939 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4941 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4943 0, 0, 0, 0, 0, 0, 0, 0, 0,
4944 0, 0, 0, 0, 0, 0, 0, 0, 0,
4945 0, 0, 0, 0, 0, 0, 0, 0,
4947 "lwindow", /* VK_LWIN 0x5B */
4948 "rwindow", /* VK_RWIN 0x5C */
4949 "apps", /* VK_APPS 0x5D */
4951 0, 0, /* 0x5E .. 0x5F */
4953 "kp-0", /* VK_NUMPAD0 0x60 */
4954 "kp-1", /* VK_NUMPAD1 0x61 */
4955 "kp-2", /* VK_NUMPAD2 0x62 */
4956 "kp-3", /* VK_NUMPAD3 0x63 */
4957 "kp-4", /* VK_NUMPAD4 0x64 */
4958 "kp-5", /* VK_NUMPAD5 0x65 */
4959 "kp-6", /* VK_NUMPAD6 0x66 */
4960 "kp-7", /* VK_NUMPAD7 0x67 */
4961 "kp-8", /* VK_NUMPAD8 0x68 */
4962 "kp-9", /* VK_NUMPAD9 0x69 */
4963 "kp-multiply", /* VK_MULTIPLY 0x6A */
4964 "kp-add", /* VK_ADD 0x6B */
4965 "kp-separator", /* VK_SEPARATOR 0x6C */
4966 "kp-subtract", /* VK_SUBTRACT 0x6D */
4967 "kp-decimal", /* VK_DECIMAL 0x6E */
4968 "kp-divide", /* VK_DIVIDE 0x6F */
4969 "f1", /* VK_F1 0x70 */
4970 "f2", /* VK_F2 0x71 */
4971 "f3", /* VK_F3 0x72 */
4972 "f4", /* VK_F4 0x73 */
4973 "f5", /* VK_F5 0x74 */
4974 "f6", /* VK_F6 0x75 */
4975 "f7", /* VK_F7 0x76 */
4976 "f8", /* VK_F8 0x77 */
4977 "f9", /* VK_F9 0x78 */
4978 "f10", /* VK_F10 0x79 */
4979 "f11", /* VK_F11 0x7A */
4980 "f12", /* VK_F12 0x7B */
4981 "f13", /* VK_F13 0x7C */
4982 "f14", /* VK_F14 0x7D */
4983 "f15", /* VK_F15 0x7E */
4984 "f16", /* VK_F16 0x7F */
4985 "f17", /* VK_F17 0x80 */
4986 "f18", /* VK_F18 0x81 */
4987 "f19", /* VK_F19 0x82 */
4988 "f20", /* VK_F20 0x83 */
4989 "f21", /* VK_F21 0x84 */
4990 "f22", /* VK_F22 0x85 */
4991 "f23", /* VK_F23 0x86 */
4992 "f24", /* VK_F24 0x87 */
4994 0, 0, 0, 0, /* 0x88 .. 0x8B */
4995 0, 0, 0, 0, /* 0x8C .. 0x8F */
4997 "kp-numlock", /* VK_NUMLOCK 0x90 */
4998 "scroll", /* VK_SCROLL 0x91 */
5000 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
5001 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
5002 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
5003 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
5004 "kp-end", /* VK_NUMPAD_END 0x96 */
5005 "kp-home", /* VK_NUMPAD_HOME 0x97 */
5006 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
5007 "kp-up", /* VK_NUMPAD_UP 0x99 */
5008 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
5009 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
5010 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
5011 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
5013 0, 0, /* 0x9E .. 0x9F */
5016 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5017 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5018 * No other API or message will distinguish left and right keys this way.
5022 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5023 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5024 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5025 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5026 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5032 "attn", /* VK_ATTN 0xF6 */
5033 "crsel", /* VK_CRSEL 0xF7 */
5034 "exsel", /* VK_EXSEL 0xF8 */
5035 "ereof", /* VK_EREOF 0xF9 */
5036 "play", /* VK_PLAY 0xFA */
5037 "zoom", /* VK_ZOOM 0xFB */
5038 "noname", /* VK_NONAME 0xFC */
5039 "pa1", /* VK_PA1 0xFD */
5040 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5044 #else /* not HAVE_NTGUI */
5046 /* This should be dealt with in XTread_socket now, and that doesn't
5047 depend on the client system having the Kana syms defined. See also
5048 the XK_kana_A case below. */
5051 static char *lispy_kana_keys
[] =
5053 /* X Keysym value */
5054 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5055 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5056 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5057 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5058 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5059 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5060 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5061 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5062 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5063 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5064 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5065 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5066 "kana-i", "kana-u", "kana-e", "kana-o",
5067 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5068 "prolongedsound", "kana-A", "kana-I", "kana-U",
5069 "kana-E", "kana-O", "kana-KA", "kana-KI",
5070 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5071 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5072 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5073 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5074 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5075 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5076 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5077 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5078 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5079 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5080 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5081 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5083 #endif /* XK_kana_A */
5086 #define FUNCTION_KEY_OFFSET 0xff00
5088 /* You'll notice that this table is arranged to be conveniently
5089 indexed by X Windows keysym values. */
5090 static char *lispy_function_keys
[] =
5092 /* X Keysym value */
5094 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5095 "backspace", "tab", "linefeed", "clear",
5097 0, 0, 0, "pause", /* 0xff10...1f */
5098 0, 0, 0, 0, 0, 0, 0, "escape",
5100 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5101 "romaji", "hiragana", "katakana", "hiragana-katakana",
5102 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5103 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5104 "eisu-toggle", /* 0xff30...3f */
5105 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5106 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5108 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5109 "down", "prior", "next", "end",
5110 "begin", 0, 0, 0, 0, 0, 0, 0,
5111 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5122 "break", /* 0xff6b */
5125 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5126 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5127 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5128 0, 0, 0, 0, 0, 0, 0, 0,
5129 "kp-tab", /* 0xff89 */
5131 "kp-enter", /* 0xff8d */
5133 "kp-f1", /* 0xff91 */
5137 "kp-home", /* 0xff95 */
5142 "kp-prior", /* kp-page-up */
5143 "kp-next", /* kp-page-down */
5149 0, 0, 0, 0, 0, 0, 0, 0, 0,
5150 "kp-multiply", /* 0xffaa */
5155 "kp-divide", /* 0xffaf */
5156 "kp-0", /* 0xffb0 */
5157 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5160 "kp-equal", /* 0xffbd */
5161 "f1", /* 0xffbe */ /* IsFunctionKey */
5163 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5164 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5165 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5166 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5167 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5168 0, 0, 0, 0, 0, 0, 0, 0,
5169 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5170 0, 0, 0, 0, 0, 0, 0, "delete"
5173 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5174 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5176 static char *iso_lispy_function_keys
[] =
5178 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5179 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5180 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5181 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5182 "iso-lefttab", /* 0xfe20 */
5183 "iso-move-line-up", "iso-move-line-down",
5184 "iso-partial-line-up", "iso-partial-line-down",
5185 "iso-partial-space-left", "iso-partial-space-right",
5186 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5187 "iso-release-margin-left", "iso-release-margin-right",
5188 "iso-release-both-margins",
5189 "iso-fast-cursor-left", "iso-fast-cursor-right",
5190 "iso-fast-cursor-up", "iso-fast-cursor-down",
5191 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5192 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5195 #endif /* not HAVE_NTGUI */
5197 Lisp_Object Vlispy_mouse_stem
;
5199 static char *lispy_wheel_names
[] =
5201 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5204 /* drag-n-drop events are generated when a set of selected files are
5205 dragged from another application and dropped onto an Emacs window. */
5206 static char *lispy_drag_n_drop_names
[] =
5211 /* Scroll bar parts. */
5212 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5213 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5214 Lisp_Object Qtop
, Qratio
;
5216 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5217 Lisp_Object
*scroll_bar_parts
[] = {
5218 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5219 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5222 /* A vector, indexed by button number, giving the down-going location
5223 of currently depressed buttons, both scroll bar and non-scroll bar.
5225 The elements have the form
5226 (BUTTON-NUMBER MODIFIER-MASK . REST)
5227 where REST is the cdr of a position as it would be reported in the event.
5229 The make_lispy_event function stores positions here to tell the
5230 difference between click and drag events, and to store the starting
5231 location to be included in drag events. */
5233 static Lisp_Object button_down_location
;
5235 /* Information about the most recent up-going button event: Which
5236 button, what location, and what time. */
5238 static int last_mouse_button
;
5239 static int last_mouse_x
;
5240 static int last_mouse_y
;
5241 static unsigned long button_down_time
;
5243 /* The maximum time between clicks to make a double-click, or Qnil to
5244 disable double-click detection, or Qt for no time limit. */
5246 Lisp_Object Vdouble_click_time
;
5248 /* Maximum number of pixels the mouse may be moved between clicks
5249 to make a double-click. */
5251 EMACS_INT double_click_fuzz
;
5253 /* The number of clicks in this multiple-click. */
5255 int double_click_count
;
5257 /* Return position of a mouse click or wheel event */
5260 make_lispy_position (f
, x
, y
, time
)
5266 enum window_part part
;
5267 Lisp_Object posn
= Qnil
;
5268 Lisp_Object extra_info
= Qnil
;
5271 /* Set `window' to the window under frame pixel coordinates (x,y) */
5273 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5274 &part
, &wx
, &wy
, 0);
5278 if (WINDOWP (window
))
5280 /* It's a click in window window at frame coordinates (x,y) */
5281 struct window
*w
= XWINDOW (window
);
5282 Lisp_Object string_info
= Qnil
;
5283 int textpos
= -1, rx
= -1, ry
= -1;
5284 int dx
= -1, dy
= -1;
5285 int width
= -1, height
= -1;
5286 Lisp_Object object
= Qnil
;
5288 /* Set event coordinates to window-relative coordinates
5289 for constructing the Lisp event below. */
5293 if (part
== ON_TEXT
)
5295 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5297 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5299 /* Mode line or header line. Look for a string under
5300 the mouse that may have a `local-map' property. */
5304 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5306 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5307 &object
, &dx
, &dy
, &width
, &height
);
5308 if (STRINGP (string
))
5309 string_info
= Fcons (string
, make_number (charpos
));
5310 if (w
== XWINDOW (selected_window
))
5313 textpos
= XMARKER (w
->pointm
)->charpos
;
5315 else if (part
== ON_VERTICAL_BORDER
)
5317 posn
= Qvertical_line
;
5322 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5327 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5329 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5330 &object
, &dx
, &dy
, &width
, &height
);
5331 if (STRINGP (string
))
5332 string_info
= Fcons (string
, make_number (charpos
));
5333 if (part
== ON_LEFT_MARGIN
)
5336 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5338 else if (part
== ON_LEFT_FRINGE
)
5340 posn
= Qleft_fringe
;
5343 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5345 : window_box_width (w
, LEFT_MARGIN_AREA
));
5348 else if (part
== ON_RIGHT_FRINGE
)
5350 posn
= Qright_fringe
;
5353 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5354 + window_box_width (w
, TEXT_AREA
)
5355 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5356 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5362 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5363 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5368 Lisp_Object string2
, object2
= Qnil
;
5369 struct display_pos p
;
5371 int width2
, height2
;
5372 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5373 &object2
, &dx2
, &dy2
,
5375 textpos
= CHARPOS (p
.pos
);
5376 if (rx
< 0) rx
= wx
;
5377 if (ry
< 0) ry
= wy
;
5378 if (dx
< 0) dx
= dx2
;
5379 if (dy
< 0) dy
= dy2
;
5380 if (width
< 0) width
= width2
;
5381 if (height
< 0) height
= height2
;
5385 posn
= make_number (textpos
);
5386 if (STRINGP (string2
))
5387 string_info
= Fcons (string2
,
5388 make_number (CHARPOS (p
.string_pos
)));
5394 #ifdef HAVE_WINDOW_SYSTEM
5395 if (IMAGEP (object
))
5397 Lisp_Object image_map
, hotspot
;
5398 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5400 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5402 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5403 posn
= XCAR (hotspot
);
5408 extra_info
= Fcons (object
,
5409 Fcons (Fcons (make_number (dx
),
5411 Fcons (Fcons (make_number (width
),
5412 make_number (height
)),
5416 extra_info
= Fcons (string_info
,
5417 Fcons (make_number (textpos
),
5418 Fcons (Fcons (make_number (rx
),
5424 XSETFRAME (window
, f
);
5429 XSETFASTINT (*x
, 0);
5430 XSETFASTINT (*y
, 0);
5433 return Fcons (window
,
5435 Fcons (Fcons (*x
, *y
),
5436 Fcons (make_number (time
),
5440 /* Given a struct input_event, build the lisp event which represents
5441 it. If EVENT is 0, build a mouse movement event from the mouse
5442 movement buffer, which should have a movement event in it.
5444 Note that events must be passed to this function in the order they
5445 are received; this function stores the location of button presses
5446 in order to build drag events when the button is released. */
5449 make_lispy_event (event
)
5450 struct input_event
*event
;
5454 switch (SWITCH_ENUM_CAST (event
->kind
))
5456 /* A simple keystroke. */
5457 case ASCII_KEYSTROKE_EVENT
:
5459 Lisp_Object lispy_c
;
5460 int c
= event
->code
& 0377;
5461 /* Turn ASCII characters into control characters
5463 if (event
->modifiers
& ctrl_modifier
)
5464 c
= make_ctrl_char (c
);
5466 /* Add in the other modifier bits. We took care of ctrl_modifier
5467 just above, and the shift key was taken care of by the X code,
5468 and applied to control characters by make_ctrl_char. */
5469 c
|= (event
->modifiers
5470 & (meta_modifier
| alt_modifier
5471 | hyper_modifier
| super_modifier
));
5472 /* Distinguish Shift-SPC from SPC. */
5473 if ((event
->code
& 0377) == 040
5474 && event
->modifiers
& shift_modifier
)
5475 c
|= shift_modifier
;
5476 button_down_time
= 0;
5477 XSETFASTINT (lispy_c
, c
);
5481 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5483 Lisp_Object lispy_c
;
5484 int c
= event
->code
;
5486 /* Add in the other modifier bits. We took care of ctrl_modifier
5487 just above, and the shift key was taken care of by the X code,
5488 and applied to control characters by make_ctrl_char. */
5489 c
|= (event
->modifiers
5490 & (meta_modifier
| alt_modifier
5491 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5492 /* What about the `shift' modifier ? */
5493 button_down_time
= 0;
5494 XSETFASTINT (lispy_c
, c
);
5498 /* A function key. The symbol may need to have modifier prefixes
5500 case NON_ASCII_KEYSTROKE_EVENT
:
5501 button_down_time
= 0;
5503 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5504 if (event
->code
== lispy_accent_codes
[i
])
5505 return modify_event_symbol (i
,
5507 Qfunction_key
, Qnil
,
5508 lispy_accent_keys
, &accent_key_syms
,
5509 (sizeof (lispy_accent_keys
)
5510 / sizeof (lispy_accent_keys
[0])));
5514 if (event
->code
>= 0x400 && event
->code
< 0x500)
5515 return modify_event_symbol (event
->code
- 0x400,
5516 event
->modifiers
& ~shift_modifier
,
5517 Qfunction_key
, Qnil
,
5518 lispy_kana_keys
, &func_key_syms
,
5519 (sizeof (lispy_kana_keys
)
5520 / sizeof (lispy_kana_keys
[0])));
5521 #endif /* XK_kana_A */
5524 #ifdef ISO_FUNCTION_KEY_OFFSET
5525 if (event
->code
< FUNCTION_KEY_OFFSET
5526 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5527 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5529 Qfunction_key
, Qnil
,
5530 iso_lispy_function_keys
, &func_key_syms
,
5531 (sizeof (iso_lispy_function_keys
)
5532 / sizeof (iso_lispy_function_keys
[0])));
5535 /* Handle system-specific or unknown keysyms. */
5536 if (event
->code
& (1 << 28)
5537 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5538 || (event
->code
- FUNCTION_KEY_OFFSET
5539 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5540 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5542 /* We need to use an alist rather than a vector as the cache
5543 since we can't make a vector long enuf. */
5544 if (NILP (current_kboard
->system_key_syms
))
5545 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5546 return modify_event_symbol (event
->code
,
5549 current_kboard
->Vsystem_key_alist
,
5550 0, ¤t_kboard
->system_key_syms
,
5554 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5556 Qfunction_key
, Qnil
,
5557 lispy_function_keys
, &func_key_syms
,
5558 (sizeof (lispy_function_keys
)
5559 / sizeof (lispy_function_keys
[0])));
5562 /* A mouse click. Figure out where it is, decide whether it's
5563 a press, click or drag, and build the appropriate structure. */
5564 case MOUSE_CLICK_EVENT
:
5565 #ifndef USE_TOOLKIT_SCROLL_BARS
5566 case SCROLL_BAR_CLICK_EVENT
:
5569 int button
= event
->code
;
5571 Lisp_Object position
;
5572 Lisp_Object
*start_pos_ptr
;
5573 Lisp_Object start_pos
;
5577 /* Build the position as appropriate for this mouse click. */
5578 if (event
->kind
== MOUSE_CLICK_EVENT
)
5580 struct frame
*f
= XFRAME (event
->frame_or_window
);
5581 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5585 /* Ignore mouse events that were made on frame that
5586 have been deleted. */
5587 if (! FRAME_LIVE_P (f
))
5590 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5591 /* EVENT->x and EVENT->y are frame-relative pixel
5592 coordinates at this place. Under old redisplay, COLUMN
5593 and ROW are set to frame relative glyph coordinates
5594 which are then used to determine whether this click is
5595 in a menu (non-toolkit version). */
5596 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5597 &column
, &row
, NULL
, 1);
5599 /* In the non-toolkit version, clicks on the menu bar
5600 are ordinary button events in the event buffer.
5601 Distinguish them, and invoke the menu.
5603 (In the toolkit version, the toolkit handles the menu bar
5604 and Emacs doesn't know about it until after the user
5605 makes a selection.) */
5606 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5607 && (event
->modifiers
& down_modifier
))
5609 Lisp_Object items
, item
;
5614 /* Activate the menu bar on the down event. If the
5615 up event comes in before the menu code can deal with it,
5617 if (! (event
->modifiers
& down_modifier
))
5621 /* Find the menu bar item under `column'. */
5623 items
= FRAME_MENU_BAR_ITEMS (f
);
5624 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5626 Lisp_Object pos
, string
;
5627 string
= AREF (items
, i
+ 1);
5628 pos
= AREF (items
, i
+ 3);
5631 if (column
>= XINT (pos
)
5632 && column
< XINT (pos
) + SCHARS (string
))
5634 item
= AREF (items
, i
);
5639 /* ELisp manual 2.4b says (x y) are window relative but
5640 code says they are frame-relative. */
5642 = Fcons (event
->frame_or_window
,
5644 Fcons (Fcons (event
->x
, event
->y
),
5645 Fcons (make_number (event
->timestamp
),
5648 return Fcons (item
, Fcons (position
, Qnil
));
5650 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5652 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5655 #ifndef USE_TOOLKIT_SCROLL_BARS
5658 /* It's a scrollbar click. */
5660 Lisp_Object portion_whole
;
5663 window
= event
->frame_or_window
;
5664 portion_whole
= Fcons (event
->x
, event
->y
);
5665 part
= *scroll_bar_parts
[(int) event
->part
];
5669 Fcons (Qvertical_scroll_bar
,
5670 Fcons (portion_whole
,
5671 Fcons (make_number (event
->timestamp
),
5672 Fcons (part
, Qnil
)))));
5674 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5676 if (button
>= ASIZE (button_down_location
))
5678 button_down_location
= larger_vector (button_down_location
,
5680 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5683 start_pos_ptr
= &AREF (button_down_location
, button
);
5684 start_pos
= *start_pos_ptr
;
5685 *start_pos_ptr
= Qnil
;
5688 /* On window-system frames, use the value of
5689 double-click-fuzz as is. On other frames, interpret it
5690 as a multiple of 1/8 characters. */
5694 if (WINDOWP (event
->frame_or_window
))
5695 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5696 else if (FRAMEP (event
->frame_or_window
))
5697 f
= XFRAME (event
->frame_or_window
);
5701 if (FRAME_WINDOW_P (f
))
5702 fuzz
= double_click_fuzz
;
5704 fuzz
= double_click_fuzz
/ 8;
5706 is_double
= (button
== last_mouse_button
5707 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5708 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5709 && button_down_time
!= 0
5710 && (EQ (Vdouble_click_time
, Qt
)
5711 || (INTEGERP (Vdouble_click_time
)
5712 && ((int)(event
->timestamp
- button_down_time
)
5713 < XINT (Vdouble_click_time
)))));
5716 last_mouse_button
= button
;
5717 last_mouse_x
= XINT (event
->x
);
5718 last_mouse_y
= XINT (event
->y
);
5720 /* If this is a button press, squirrel away the location, so
5721 we can decide later whether it was a click or a drag. */
5722 if (event
->modifiers
& down_modifier
)
5726 double_click_count
++;
5727 event
->modifiers
|= ((double_click_count
> 2)
5732 double_click_count
= 1;
5733 button_down_time
= event
->timestamp
;
5734 *start_pos_ptr
= Fcopy_alist (position
);
5735 ignore_mouse_drag_p
= 0;
5738 /* Now we're releasing a button - check the co-ordinates to
5739 see if this was a click or a drag. */
5740 else if (event
->modifiers
& up_modifier
)
5742 /* If we did not see a down before this up, ignore the up.
5743 Probably this happened because the down event chose a
5744 menu item. It would be an annoyance to treat the
5745 release of the button that chose the menu item as a
5748 if (!CONSP (start_pos
))
5751 event
->modifiers
&= ~up_modifier
;
5752 #if 0 /* Formerly we treated an up with no down as a click event. */
5753 if (!CONSP (start_pos
))
5754 event
->modifiers
|= click_modifier
;
5759 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5761 /* The third element of every position
5762 should be the (x,y) pair. */
5763 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5765 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5767 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5768 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5771 if (ignore_mouse_drag_p
)
5773 event
->modifiers
|= click_modifier
;
5774 ignore_mouse_drag_p
= 0;
5776 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5777 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5778 /* Maybe the mouse has moved a lot, caused scrolling, and
5779 eventually ended up at the same screen position (but
5780 not buffer position) in which case it is a drag, not
5782 /* FIXME: OTOH if the buffer position has changed
5783 because of a timer or process filter rather than
5784 because of mouse movement, it should be considered as
5785 a click. But mouse-drag-region completely ignores
5786 this case and it hasn't caused any real problem, so
5787 it's probably OK to ignore it as well. */
5788 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5789 /* Mouse hasn't moved (much). */
5790 event
->modifiers
|= click_modifier
;
5793 button_down_time
= 0;
5794 event
->modifiers
|= drag_modifier
;
5797 /* Don't check is_double; treat this as multiple
5798 if the down-event was multiple. */
5799 if (double_click_count
> 1)
5800 event
->modifiers
|= ((double_click_count
> 2)
5806 /* Every mouse event should either have the down_modifier or
5807 the up_modifier set. */
5811 /* Get the symbol we should use for the mouse click. */
5814 head
= modify_event_symbol (button
,
5816 Qmouse_click
, Vlispy_mouse_stem
,
5819 XVECTOR (mouse_syms
)->size
);
5820 if (event
->modifiers
& drag_modifier
)
5825 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5828 Fcons (make_number (double_click_count
),
5838 case HORIZ_WHEEL_EVENT
:
5840 Lisp_Object position
;
5843 /* Build the position as appropriate for this mouse click. */
5844 struct frame
*f
= XFRAME (event
->frame_or_window
);
5846 /* Ignore wheel events that were made on frame that have been
5848 if (! FRAME_LIVE_P (f
))
5851 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5854 /* Set double or triple modifiers to indicate the wheel speed. */
5856 /* On window-system frames, use the value of
5857 double-click-fuzz as is. On other frames, interpret it
5858 as a multiple of 1/8 characters. */
5863 if (WINDOWP (event
->frame_or_window
))
5864 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5865 else if (FRAMEP (event
->frame_or_window
))
5866 f
= XFRAME (event
->frame_or_window
);
5870 if (FRAME_WINDOW_P (f
))
5871 fuzz
= double_click_fuzz
;
5873 fuzz
= double_click_fuzz
/ 8;
5875 is_double
= (last_mouse_button
< 0
5876 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5877 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5878 && button_down_time
!= 0
5879 && (EQ (Vdouble_click_time
, Qt
)
5880 || (INTEGERP (Vdouble_click_time
)
5881 && ((int)(event
->timestamp
- button_down_time
)
5882 < XINT (Vdouble_click_time
)))));
5885 double_click_count
++;
5886 event
->modifiers
|= ((double_click_count
> 2)
5892 double_click_count
= 1;
5893 event
->modifiers
|= click_modifier
;
5896 button_down_time
= event
->timestamp
;
5897 /* Use a negative value to distinguish wheel from mouse button. */
5898 last_mouse_button
= -1;
5899 last_mouse_x
= XINT (event
->x
);
5900 last_mouse_y
= XINT (event
->y
);
5906 if (event
->modifiers
& up_modifier
)
5908 /* Emit a wheel-up event. */
5909 event
->modifiers
&= ~up_modifier
;
5912 else if (event
->modifiers
& down_modifier
)
5914 /* Emit a wheel-down event. */
5915 event
->modifiers
&= ~down_modifier
;
5919 /* Every wheel event should either have the down_modifier or
5920 the up_modifier set. */
5923 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5926 /* Get the symbol we should use for the wheel event. */
5927 head
= modify_event_symbol (symbol_num
,
5933 ASIZE (wheel_syms
));
5936 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5939 Fcons (make_number (double_click_count
),
5948 #ifdef USE_TOOLKIT_SCROLL_BARS
5950 /* We don't have down and up events if using toolkit scroll bars,
5951 so make this always a click event. Store in the `part' of
5952 the Lisp event a symbol which maps to the following actions:
5954 `above_handle' page up
5955 `below_handle' page down
5959 `bottom' bottom of buffer
5960 `handle' thumb has been dragged.
5961 `end-scroll' end of interaction with scroll bar
5963 The incoming input_event contains in its `part' member an
5964 index of type `enum scroll_bar_part' which we can use as an
5965 index in scroll_bar_parts to get the appropriate symbol. */
5967 case SCROLL_BAR_CLICK_EVENT
:
5969 Lisp_Object position
, head
, window
, portion_whole
, part
;
5971 window
= event
->frame_or_window
;
5972 portion_whole
= Fcons (event
->x
, event
->y
);
5973 part
= *scroll_bar_parts
[(int) event
->part
];
5977 Fcons (Qvertical_scroll_bar
,
5978 Fcons (portion_whole
,
5979 Fcons (make_number (event
->timestamp
),
5980 Fcons (part
, Qnil
)))));
5982 /* Always treat scroll bar events as clicks. */
5983 event
->modifiers
|= click_modifier
;
5984 event
->modifiers
&= ~up_modifier
;
5986 if (event
->code
>= ASIZE (mouse_syms
))
5987 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5989 /* Get the symbol we should use for the mouse click. */
5990 head
= modify_event_symbol (event
->code
,
5995 XVECTOR (mouse_syms
)->size
);
5996 return Fcons (head
, Fcons (position
, Qnil
));
5999 #endif /* USE_TOOLKIT_SCROLL_BARS */
6002 case W32_SCROLL_BAR_CLICK_EVENT
:
6004 int button
= event
->code
;
6006 Lisp_Object position
;
6007 Lisp_Object
*start_pos_ptr
;
6008 Lisp_Object start_pos
;
6012 Lisp_Object portion_whole
;
6015 window
= event
->frame_or_window
;
6016 portion_whole
= Fcons (event
->x
, event
->y
);
6017 part
= *scroll_bar_parts
[(int) event
->part
];
6021 Fcons (Qvertical_scroll_bar
,
6022 Fcons (portion_whole
,
6023 Fcons (make_number (event
->timestamp
),
6024 Fcons (part
, Qnil
)))));
6027 /* Always treat W32 scroll bar events as clicks. */
6028 event
->modifiers
|= click_modifier
;
6031 /* Get the symbol we should use for the mouse click. */
6034 head
= modify_event_symbol (button
,
6039 XVECTOR (mouse_syms
)->size
);
6045 #endif /* WINDOWSNT */
6047 case DRAG_N_DROP_EVENT
:
6050 Lisp_Object head
, position
;
6053 f
= XFRAME (event
->frame_or_window
);
6056 /* Ignore mouse events that were made on frames that
6057 have been deleted. */
6058 if (! FRAME_LIVE_P (f
))
6061 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6064 head
= modify_event_symbol (0, event
->modifiers
,
6066 lispy_drag_n_drop_names
,
6067 &drag_n_drop_syms
, 1);
6073 #endif /* HAVE_MOUSE */
6075 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
6076 || defined (USE_GTK)
6077 case MENU_BAR_EVENT
:
6078 if (EQ (event
->arg
, event
->frame_or_window
))
6079 /* This is the prefix key. We translate this to
6080 `(menu_bar)' because the code in keyboard.c for menu
6081 events, which we use, relies on this. */
6082 return Fcons (Qmenu_bar
, Qnil
);
6086 case SELECT_WINDOW_EVENT
:
6087 /* Make an event (select-window (WINDOW)). */
6088 return Fcons (Qselect_window
,
6089 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6092 case TOOL_BAR_EVENT
:
6093 if (EQ (event
->arg
, event
->frame_or_window
))
6094 /* This is the prefix key. We translate this to
6095 `(tool_bar)' because the code in keyboard.c for tool bar
6096 events, which we use, relies on this. */
6097 return Fcons (Qtool_bar
, Qnil
);
6098 else if (SYMBOLP (event
->arg
))
6099 return apply_modifiers (event
->modifiers
, event
->arg
);
6102 case USER_SIGNAL_EVENT
:
6103 /* A user signal. */
6105 char *name
= find_user_signal_name (event
->code
);
6108 return intern (name
);
6111 case SAVE_SESSION_EVENT
:
6112 return Qsave_session
;
6115 case MAC_APPLE_EVENT
:
6117 Lisp_Object spec
[2];
6121 return Fcons (Qmac_apple_event
,
6122 Fcons (Fvector (2, spec
),
6123 Fcons (event
->arg
, Qnil
)));
6128 case GPM_CLICK_EVENT
:
6130 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6131 Lisp_Object head
, position
;
6132 Lisp_Object
*start_pos_ptr
;
6133 Lisp_Object start_pos
;
6134 int button
= event
->code
;
6136 if (button
>= ASIZE (button_down_location
))
6138 button_down_location
= larger_vector (button_down_location
,
6140 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6143 start_pos_ptr
= &AREF (button_down_location
, button
);
6144 start_pos
= *start_pos_ptr
;
6146 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6149 if (event
->modifiers
& down_modifier
)
6150 *start_pos_ptr
= Fcopy_alist (position
);
6151 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6153 if (!CONSP (start_pos
))
6155 event
->modifiers
&= ~up_modifier
;
6158 head
= modify_event_symbol (button
,
6160 Qmouse_click
, Vlispy_mouse_stem
,
6163 XVECTOR (mouse_syms
)->size
);
6165 if (event
->modifiers
& drag_modifier
)
6170 else if (event
->modifiers
& double_modifier
)
6173 Fcons (make_number (2),
6175 else if (event
->modifiers
& triple_modifier
)
6178 Fcons (make_number (3),
6185 #endif /* HAVE_GPM */
6187 /* The 'kind' field of the event is something we don't recognize. */
6193 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6196 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6198 Lisp_Object bar_window
;
6199 enum scroll_bar_part part
;
6203 /* Is it a scroll bar movement? */
6204 if (frame
&& ! NILP (bar_window
))
6206 Lisp_Object part_sym
;
6208 part_sym
= *scroll_bar_parts
[(int) part
];
6209 return Fcons (Qscroll_bar_movement
,
6210 (Fcons (Fcons (bar_window
,
6211 Fcons (Qvertical_scroll_bar
,
6212 Fcons (Fcons (x
, y
),
6213 Fcons (make_number (time
),
6219 /* Or is it an ordinary mouse movement? */
6222 Lisp_Object position
;
6224 position
= make_lispy_position (frame
, &x
, &y
, time
);
6226 return Fcons (Qmouse_movement
,
6232 #endif /* HAVE_MOUSE || HAVE GPM */
6234 /* Construct a switch frame event. */
6236 make_lispy_switch_frame (frame
)
6239 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6242 /* Manipulating modifiers. */
6244 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6246 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6247 SYMBOL's name of the end of the modifiers; the string from this
6248 position is the unmodified symbol name.
6250 This doesn't use any caches. */
6253 parse_modifiers_uncached (symbol
, modifier_end
)
6261 CHECK_SYMBOL (symbol
);
6264 name
= SYMBOL_NAME (symbol
);
6266 for (i
= 0; i
+2 <= SBYTES (name
); )
6268 int this_mod_end
= 0;
6271 /* See if the name continues with a modifier word.
6272 Check that the word appears, but don't check what follows it.
6273 Set this_mod and this_mod_end to record what we find. */
6275 switch (SREF (name
, i
))
6277 #define SINGLE_LETTER_MOD(BIT) \
6278 (this_mod_end = i + 1, this_mod = BIT)
6281 SINGLE_LETTER_MOD (alt_modifier
);
6285 SINGLE_LETTER_MOD (ctrl_modifier
);
6289 SINGLE_LETTER_MOD (hyper_modifier
);
6293 SINGLE_LETTER_MOD (meta_modifier
);
6297 SINGLE_LETTER_MOD (shift_modifier
);
6301 SINGLE_LETTER_MOD (super_modifier
);
6304 #undef SINGLE_LETTER_MOD
6306 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6307 if (i + LEN + 1 <= SBYTES (name) \
6308 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6310 this_mod_end = i + LEN; \
6315 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6316 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6317 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6321 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6323 #undef MULTI_LETTER_MOD
6327 /* If we found no modifier, stop looking for them. */
6328 if (this_mod_end
== 0)
6331 /* Check there is a dash after the modifier, so that it
6332 really is a modifier. */
6333 if (this_mod_end
>= SBYTES (name
)
6334 || SREF (name
, this_mod_end
) != '-')
6337 /* This modifier is real; look for another. */
6338 modifiers
|= this_mod
;
6339 i
= this_mod_end
+ 1;
6342 /* Should we include the `click' modifier? */
6343 if (! (modifiers
& (down_modifier
| drag_modifier
6344 | double_modifier
| triple_modifier
))
6345 && i
+ 7 == SBYTES (name
)
6346 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6347 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6348 modifiers
|= click_modifier
;
6356 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6357 prepended to the string BASE[0..BASE_LEN-1].
6358 This doesn't use any caches. */
6360 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6363 int base_len
, base_len_byte
;
6365 /* Since BASE could contain nulls, we can't use intern here; we have
6366 to use Fintern, which expects a genuine Lisp_String, and keeps a
6369 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6375 /* Only the event queue may use the `up' modifier; it should always
6376 be turned into a click or drag event before presented to lisp code. */
6377 if (modifiers
& up_modifier
)
6380 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6381 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6382 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6383 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6384 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6385 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6386 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6387 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6388 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6389 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6390 /* The click modifier is denoted by the absence of other modifiers. */
6394 mod_len
= p
- new_mods
;
6398 Lisp_Object new_name
;
6400 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6401 mod_len
+ base_len_byte
);
6402 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6403 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6405 return Fintern (new_name
, Qnil
);
6410 static char *modifier_names
[] =
6412 "up", "down", "drag", "click", "double", "triple", 0, 0,
6413 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6414 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6416 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6418 static Lisp_Object modifier_symbols
;
6420 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6422 lispy_modifier_list (modifiers
)
6425 Lisp_Object modifier_list
;
6428 modifier_list
= Qnil
;
6429 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6430 if (modifiers
& (1<<i
))
6431 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6434 return modifier_list
;
6438 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6439 where UNMODIFIED is the unmodified form of SYMBOL,
6440 MASK is the set of modifiers present in SYMBOL's name.
6441 This is similar to parse_modifiers_uncached, but uses the cache in
6442 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6443 Qevent_symbol_elements property. */
6446 parse_modifiers (symbol
)
6449 Lisp_Object elements
;
6451 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6452 if (CONSP (elements
))
6457 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6458 Lisp_Object unmodified
;
6461 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6462 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6465 if (modifiers
& ~INTMASK
)
6467 XSETFASTINT (mask
, modifiers
);
6468 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6470 /* Cache the parsing results on SYMBOL. */
6471 Fput (symbol
, Qevent_symbol_element_mask
,
6473 Fput (symbol
, Qevent_symbol_elements
,
6474 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6476 /* Since we know that SYMBOL is modifiers applied to unmodified,
6477 it would be nice to put that in unmodified's cache.
6478 But we can't, since we're not sure that parse_modifiers is
6485 /* Apply the modifiers MODIFIERS to the symbol BASE.
6486 BASE must be unmodified.
6488 This is like apply_modifiers_uncached, but uses BASE's
6489 Qmodifier_cache property, if present. It also builds
6490 Qevent_symbol_elements properties, since it has that info anyway.
6492 apply_modifiers copies the value of BASE's Qevent_kind property to
6493 the modified symbol. */
6495 apply_modifiers (modifiers
, base
)
6499 Lisp_Object cache
, index
, entry
, new_symbol
;
6501 /* Mask out upper bits. We don't know where this value's been. */
6502 modifiers
&= INTMASK
;
6504 /* The click modifier never figures into cache indices. */
6505 cache
= Fget (base
, Qmodifier_cache
);
6506 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6507 entry
= assq_no_quit (index
, cache
);
6510 new_symbol
= XCDR (entry
);
6513 /* We have to create the symbol ourselves. */
6514 new_symbol
= apply_modifiers_uncached (modifiers
,
6515 SDATA (SYMBOL_NAME (base
)),
6516 SCHARS (SYMBOL_NAME (base
)),
6517 SBYTES (SYMBOL_NAME (base
)));
6519 /* Add the new symbol to the base's cache. */
6520 entry
= Fcons (index
, new_symbol
);
6521 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6523 /* We have the parsing info now for free, so we could add it to
6525 XSETFASTINT (index, modifiers);
6526 Fput (new_symbol, Qevent_symbol_element_mask,
6527 Fcons (base, Fcons (index, Qnil)));
6528 Fput (new_symbol, Qevent_symbol_elements,
6529 Fcons (base, lispy_modifier_list (modifiers)));
6530 Sadly, this is only correct if `base' is indeed a base event,
6531 which is not necessarily the case. -stef */
6534 /* Make sure this symbol is of the same kind as BASE.
6536 You'd think we could just set this once and for all when we
6537 intern the symbol above, but reorder_modifiers may call us when
6538 BASE's property isn't set right; we can't assume that just
6539 because it has a Qmodifier_cache property it must have its
6540 Qevent_kind set right as well. */
6541 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6545 kind
= Fget (base
, Qevent_kind
);
6547 Fput (new_symbol
, Qevent_kind
, kind
);
6554 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6555 return a symbol with the modifiers placed in the canonical order.
6556 Canonical order is alphabetical, except for down and drag, which
6557 always come last. The 'click' modifier is never written out.
6559 Fdefine_key calls this to make sure that (for example) C-M-foo
6560 and M-C-foo end up being equivalent in the keymap. */
6563 reorder_modifiers (symbol
)
6566 /* It's hopefully okay to write the code this way, since everything
6567 will soon be in caches, and no consing will be done at all. */
6570 parsed
= parse_modifiers (symbol
);
6571 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6576 /* For handling events, we often want to produce a symbol whose name
6577 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6578 to some base, like the name of a function key or mouse button.
6579 modify_event_symbol produces symbols of this sort.
6581 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6582 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6585 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6586 into symbol names, or a string specifying a name stem used to
6587 construct a symbol name or the form `STEM-N', where N is the decimal
6588 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6589 non-nil; otherwise NAME_TABLE is used.
6591 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6592 persist between calls to modify_event_symbol that it can use to
6593 store a cache of the symbols it's generated for this NAME_TABLE
6594 before. The object stored there may be a vector or an alist.
6596 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6598 MODIFIERS is a set of modifier bits (as given in struct input_events)
6599 whose prefixes should be applied to the symbol name.
6601 SYMBOL_KIND is the value to be placed in the event_kind property of
6602 the returned symbol.
6604 The symbols we create are supposed to have an
6605 `event-symbol-elements' property, which lists the modifiers present
6606 in the symbol's name. */
6609 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6610 name_table
, symbol_table
, table_size
)
6613 Lisp_Object symbol_kind
;
6614 Lisp_Object name_alist_or_stem
;
6616 Lisp_Object
*symbol_table
;
6617 unsigned int table_size
;
6620 Lisp_Object symbol_int
;
6622 /* Get rid of the "vendor-specific" bit here. */
6623 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6625 /* Is this a request for a valid symbol? */
6626 if (symbol_num
< 0 || symbol_num
>= table_size
)
6629 if (CONSP (*symbol_table
))
6630 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6632 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6633 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6634 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6635 we've never used that symbol before. */
6638 if (! VECTORP (*symbol_table
)
6639 || XVECTOR (*symbol_table
)->size
!= table_size
)
6643 XSETFASTINT (size
, table_size
);
6644 *symbol_table
= Fmake_vector (size
, Qnil
);
6647 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6650 /* Have we already used this symbol before? */
6653 /* No; let's create it. */
6654 if (CONSP (name_alist_or_stem
))
6655 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6656 else if (STRINGP (name_alist_or_stem
))
6658 int len
= SBYTES (name_alist_or_stem
);
6659 char *buf
= (char *) alloca (len
+ 50);
6660 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6661 (long) XINT (symbol_int
) + 1);
6662 value
= intern (buf
);
6664 else if (name_table
!= 0 && name_table
[symbol_num
])
6665 value
= intern (name_table
[symbol_num
]);
6667 #ifdef HAVE_WINDOW_SYSTEM
6670 char *name
= x_get_keysym_name (symbol_num
);
6672 value
= intern (name
);
6679 sprintf (buf
, "key-%d", symbol_num
);
6680 value
= intern (buf
);
6683 if (CONSP (*symbol_table
))
6684 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6686 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6688 /* Fill in the cache entries for this symbol; this also
6689 builds the Qevent_symbol_elements property, which the user
6691 apply_modifiers (modifiers
& click_modifier
, value
);
6692 Fput (value
, Qevent_kind
, symbol_kind
);
6695 /* Apply modifiers to that symbol. */
6696 return apply_modifiers (modifiers
, value
);
6699 /* Convert a list that represents an event type,
6700 such as (ctrl meta backspace), into the usual representation of that
6701 event type as a number or a symbol. */
6703 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6704 doc
: /* Convert the event description list EVENT-DESC to an event type.
6705 EVENT-DESC should contain one base event type (a character or symbol)
6706 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6707 drag, down, double or triple). The base must be last.
6708 The return value is an event type (a character or symbol) which
6709 has the same base event type and all the specified modifiers. */)
6711 Lisp_Object event_desc
;
6719 while (CONSP (rest
))
6727 /* Given a symbol, see if it is a modifier name. */
6728 if (SYMBOLP (elt
) && CONSP (rest
))
6729 this = parse_solitary_modifier (elt
);
6733 else if (!NILP (base
))
6734 error ("Two bases given in one event");
6740 /* Let the symbol A refer to the character A. */
6741 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6742 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6744 if (INTEGERP (base
))
6746 /* Turn (shift a) into A. */
6747 if ((modifiers
& shift_modifier
) != 0
6748 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6750 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6751 modifiers
&= ~shift_modifier
;
6754 /* Turn (control a) into C-a. */
6755 if (modifiers
& ctrl_modifier
)
6756 return make_number ((modifiers
& ~ctrl_modifier
)
6757 | make_ctrl_char (XINT (base
)));
6759 return make_number (modifiers
| XINT (base
));
6761 else if (SYMBOLP (base
))
6762 return apply_modifiers (modifiers
, base
);
6765 error ("Invalid base event");
6770 /* Try to recognize SYMBOL as a modifier name.
6771 Return the modifier flag bit, or 0 if not recognized. */
6774 parse_solitary_modifier (symbol
)
6777 Lisp_Object name
= SYMBOL_NAME (symbol
);
6779 switch (SREF (name
, 0))
6781 #define SINGLE_LETTER_MOD(BIT) \
6782 if (SBYTES (name) == 1) \
6785 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6786 if (LEN == SBYTES (name) \
6787 && ! strncmp (SDATA (name), NAME, LEN)) \
6791 SINGLE_LETTER_MOD (alt_modifier
);
6795 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6799 SINGLE_LETTER_MOD (ctrl_modifier
);
6803 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6804 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6808 SINGLE_LETTER_MOD (hyper_modifier
);
6812 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6816 SINGLE_LETTER_MOD (meta_modifier
);
6820 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6824 SINGLE_LETTER_MOD (shift_modifier
);
6828 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6829 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6830 SINGLE_LETTER_MOD (super_modifier
);
6834 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6835 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6836 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6840 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6843 #undef SINGLE_LETTER_MOD
6844 #undef MULTI_LETTER_MOD
6850 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6851 Such a list is not valid as an event,
6852 but it can be a Lucid-style event type list. */
6855 lucid_event_type_list_p (object
)
6860 if (! CONSP (object
))
6863 if (EQ (XCAR (object
), Qhelp_echo
)
6864 || EQ (XCAR (object
), Qvertical_line
)
6865 || EQ (XCAR (object
), Qmode_line
)
6866 || EQ (XCAR (object
), Qheader_line
))
6869 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6873 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6880 /* Store into *addr a value nonzero if terminal input chars are available.
6881 Serves the purpose of ioctl (0, FIONREAD, addr)
6882 but works even if FIONREAD does not exist.
6883 (In fact, this may actually read some input.)
6885 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6886 timer events that are ripe.
6887 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6888 events (FOCUS_IN_EVENT).
6889 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6890 movements and toolkit scroll bar thumb drags. */
6893 get_input_pending (addr
, flags
)
6897 /* First of all, have we already counted some input? */
6898 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6900 /* If input is being read as it arrives, and we have none, there is none. */
6901 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6904 /* Try to read some input and see how much we get. */
6906 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6909 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6912 gobble_input (expected
)
6917 if (interrupt_input
)
6920 mask
= sigblock (sigmask (SIGIO
));
6921 read_avail_input (expected
);
6925 #ifdef POLL_FOR_INPUT
6926 /* XXX This condition was (read_socket_hook && !interrupt_input),
6927 but read_socket_hook is not global anymore. Let's pretend that
6929 if (!interrupt_input
&& poll_suppress_count
== 0)
6932 mask
= sigblock (sigmask (SIGALRM
));
6933 read_avail_input (expected
);
6939 read_avail_input (expected
);
6943 /* Put a BUFFER_SWITCH_EVENT in the buffer
6944 so that read_key_sequence will notice the new current buffer. */
6947 record_asynch_buffer_change ()
6949 struct input_event event
;
6953 event
.kind
= BUFFER_SWITCH_EVENT
;
6954 event
.frame_or_window
= Qnil
;
6958 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6959 The purpose of the event is to make read_key_sequence look up the
6960 keymaps again. If we aren't in read_key_sequence, we don't need one,
6961 and the event could cause trouble by messing up (input-pending-p). */
6962 tem
= Fwaiting_for_user_input_p ();
6966 /* We never need these events if we have no asynchronous subprocesses. */
6970 /* Make sure no interrupt happens while storing the event. */
6972 if (interrupt_input
)
6975 mask
= sigblock (sigmask (SIGIO
));
6976 kbd_buffer_store_event (&event
);
6983 kbd_buffer_store_event (&event
);
6990 /* Read any terminal input already buffered up by the system
6991 into the kbd_buffer, but do not wait.
6993 EXPECTED should be nonzero if the caller knows there is some input.
6995 Except on VMS, all input is read by this function.
6996 If interrupt_input is nonzero, this function MUST be called
6997 only when SIGIO is blocked.
6999 Returns the number of keyboard chars read, or -1 meaning
7000 this is a bad time to try to read input. */
7003 read_avail_input (expected
)
7010 /* Store pending user signal events, if any. */
7011 if (store_user_signal_events ())
7014 /* Loop through the available terminals, and call their input hooks. */
7018 struct terminal
*next
= t
->next_terminal
;
7020 if (t
->read_socket_hook
)
7023 struct input_event hold_quit
;
7025 EVENT_INIT (hold_quit
);
7026 hold_quit
.kind
= NO_EVENT
;
7028 /* No need for FIONREAD or fcntl; just say don't wait. */
7029 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7035 if (nr
== -1) /* Not OK to read input now. */
7039 else if (nr
== -2) /* Non-transient error. */
7041 /* The terminal device terminated; it should be closed. */
7043 /* Kill Emacs if this was our last terminal. */
7044 if (!terminal_list
->next_terminal
)
7045 /* Formerly simply reported no input, but that
7046 sometimes led to a failure of Emacs to terminate.
7047 SIGHUP seems appropriate if we can't reach the
7049 /* ??? Is it really right to send the signal just to
7050 this process rather than to the whole process
7051 group? Perhaps on systems with FIONREAD Emacs is
7052 alone in its group. */
7053 kill (getpid (), SIGHUP
);
7055 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
7056 if (t
->delete_terminal_hook
)
7057 (*t
->delete_terminal_hook
) (t
);
7059 delete_terminal (t
);
7062 if (hold_quit
.kind
!= NO_EVENT
)
7063 kbd_buffer_store_event (&hold_quit
);
7075 /* This is the tty way of reading available input.
7077 Note that each terminal device has its own `struct terminal' object,
7078 and so this function is called once for each individual termcap
7079 terminal. The first parameter indicates which terminal to read from. */
7082 tty_read_avail_input (struct terminal
*terminal
,
7084 struct input_event
*hold_quit
)
7086 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7087 the kbd_buffer can really hold. That may prevent loss
7088 of characters on some systems when input is stuffed at us. */
7089 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7091 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7094 if (!terminal
->name
) /* Don't read from a dead terminal. */
7097 if (terminal
->type
!= output_termcap
)
7100 /* XXX I think the following code should be moved to separate hook
7101 functions in system-dependent files. */
7104 #else /* not WINDOWSNT */
7106 n_to_read
= dos_keysns ();
7110 cbuf
[0] = dos_keyread ();
7113 #else /* not MSDOS */
7115 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7119 return 0; /* The terminal is suspended. */
7125 struct input_event hold_quit
;
7128 EVENT_INIT (hold_quit
);
7129 hold_quit
.kind
= NO_EVENT
;
7131 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7132 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7134 if (hold_quit
.kind
!= NO_EVENT
)
7135 kbd_buffer_store_event (&hold_quit
);
7139 #endif /* HAVE_GPM */
7141 /* Determine how many characters we should *try* to read. */
7143 /* Find out how much input is available. */
7144 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7146 if (! noninteractive
)
7147 return -2; /* Close this terminal. */
7153 if (n_to_read
> sizeof cbuf
)
7154 n_to_read
= sizeof cbuf
;
7155 #else /* no FIONREAD */
7156 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
7157 /* Read some input if available, but don't wait. */
7158 n_to_read
= sizeof cbuf
;
7159 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7165 /* Now read; for one reason or another, this will not block.
7166 NREAD is set to the number of chars read. */
7169 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7170 /* POSIX infers that processes which are not in the session leader's
7171 process group won't get SIGHUP's at logout time. BSDI adheres to
7172 this part standard and returns -1 from read (0) with errno==EIO
7173 when the control tty is taken away.
7174 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7175 if (nread
== -1 && errno
== EIO
)
7176 return -2; /* Close this terminal. */
7177 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
7178 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7179 This looks incorrect, but it isn't, because _BSD causes
7180 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7181 and that causes a value other than 0 when there is no input. */
7183 return -2; /* Close this terminal. */
7187 /* We used to retry the read if it was interrupted.
7188 But this does the wrong thing when O_NDELAY causes
7189 an EAGAIN error. Does anybody know of a situation
7190 where a retry is actually needed? */
7192 nread
< 0 && (errno
== EAGAIN
7206 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
7207 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7208 #endif /* USG or DGUX or CYGWIN */
7209 #endif /* no FIONREAD */
7214 #endif /* not MSDOS */
7215 #endif /* not WINDOWSNT */
7217 for (i
= 0; i
< nread
; i
++)
7219 struct input_event buf
;
7221 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7223 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7224 buf
.modifiers
= meta_modifier
;
7225 if (tty
->meta_key
!= 2)
7229 /* Set the frame corresponding to the active tty. Note that the
7230 value of selected_frame is not reliable here, redisplay tends
7231 to temporarily change it. */
7232 buf
.frame_or_window
= tty
->top_frame
;
7235 kbd_buffer_store_event (&buf
);
7236 /* Don't look at input that follows a C-g too closely.
7237 This reduces lossage due to autorepeat on C-g. */
7238 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7239 && buf
.code
== quit_char
)
7245 #endif /* not VMS */
7248 handle_async_input ()
7251 extern int select_alarmed
;
7254 interrupt_input_pending
= 0;
7259 nread
= read_avail_input (1);
7260 /* -1 means it's not ok to read the input now.
7261 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7262 0 means there was no keyboard input available. */
7267 select_alarmed
= 1; /* Force the select emulator back to life */
7272 #ifdef SIGIO /* for entire page */
7273 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7276 input_available_signal (signo
)
7279 /* Must preserve main program's value of errno. */
7280 int old_errno
= errno
;
7281 #if defined (USG) && !defined (POSIX_SIGNALS)
7282 /* USG systems forget handlers when they are used;
7283 must reestablish each time */
7284 signal (signo
, input_available_signal
);
7292 interrupt_input_pending
= 1;
7294 SIGNAL_THREAD_CHECK (signo
);
7297 if (input_available_clear_time
)
7298 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7301 handle_async_input ();
7311 /* Send ourselves a SIGIO.
7313 This function exists so that the UNBLOCK_INPUT macro in
7314 blockinput.h can have some way to take care of input we put off
7315 dealing with, without assuming that every file which uses
7316 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7318 reinvoke_input_signal ()
7321 handle_async_input ();
7327 /* User signal events. */
7329 struct user_signal_info
7331 /* Signal number. */
7334 /* Name of the signal. */
7337 /* Number of pending signals. */
7340 struct user_signal_info
*next
;
7343 /* List of user signals. */
7344 static struct user_signal_info
*user_signals
= NULL
;
7347 add_user_signal (sig
, name
)
7351 struct user_signal_info
*p
;
7353 for (p
= user_signals
; p
; p
= p
->next
)
7355 /* Already added. */
7358 p
= xmalloc (sizeof (struct user_signal_info
));
7360 p
->name
= xstrdup (name
);
7362 p
->next
= user_signals
;
7365 signal (sig
, handle_user_signal
);
7369 handle_user_signal (sig
)
7372 int old_errno
= errno
;
7373 struct user_signal_info
*p
;
7375 #if defined (USG) && !defined (POSIX_SIGNALS)
7376 /* USG systems forget handlers when they are used;
7377 must reestablish each time */
7378 signal (sig
, handle_user_signal
);
7381 SIGNAL_THREAD_CHECK (sig
);
7383 for (p
= user_signals
; p
; p
= p
->next
)
7388 if (interrupt_input
)
7389 kill (getpid (), SIGIO
);
7393 /* Tell wait_reading_process_output that it needs to wake
7394 up and look around. */
7395 if (input_available_clear_time
)
7396 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7405 find_user_signal_name (sig
)
7408 struct user_signal_info
*p
;
7410 for (p
= user_signals
; p
; p
= p
->next
)
7418 store_user_signal_events ()
7420 struct user_signal_info
*p
;
7421 struct input_event buf
;
7424 for (p
= user_signals
; p
; p
= p
->next
)
7425 if (p
->npending
> 0)
7431 bzero (&buf
, sizeof buf
);
7432 buf
.kind
= USER_SIGNAL_EVENT
;
7433 buf
.frame_or_window
= selected_frame
;
7435 nstored
+= p
->npending
;
7437 mask
= sigblock (sigmask (p
->sig
));
7441 kbd_buffer_store_event (&buf
);
7444 while (p
->npending
> 0);
7452 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7453 static Lisp_Object menu_bar_one_keymap_changed_items
;
7455 /* These variables hold the vector under construction within
7456 menu_bar_items and its subroutines, and the current index
7457 for storing into that vector. */
7458 static Lisp_Object menu_bar_items_vector
;
7459 static int menu_bar_items_index
;
7461 /* Return a vector of menu items for a menu bar, appropriate
7462 to the current buffer. Each item has three elements in the vector:
7465 OLD is an old vector we can optionally reuse, or nil. */
7468 menu_bar_items (old
)
7471 /* The number of keymaps we're scanning right now, and the number of
7472 keymaps we have allocated space for. */
7475 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7476 in the current keymaps, or nil where it is not a prefix. */
7479 Lisp_Object def
, tail
;
7488 /* In order to build the menus, we need to call the keymap
7489 accessors. They all call QUIT. But this function is called
7490 during redisplay, during which a quit is fatal. So inhibit
7491 quitting while building the menus.
7492 We do this instead of specbind because (1) errors will clear it anyway
7493 and (2) this avoids risk of specpdl overflow. */
7494 oquit
= Vinhibit_quit
;
7498 menu_bar_items_vector
= old
;
7500 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7501 menu_bar_items_index
= 0;
7503 /* Build our list of keymaps.
7504 If we recognize a function key and replace its escape sequence in
7505 keybuf with its symbol, or if the sequence starts with a mouse
7506 click and we need to switch buffers, we jump back here to rebuild
7507 the initial keymaps from the current buffer. */
7511 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7512 if (!NILP (Voverriding_local_map_menu_flag
))
7514 /* Yes, use them (if non-nil) as well as the global map. */
7515 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7517 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7518 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7519 if (!NILP (Voverriding_local_map
))
7520 maps
[nmaps
++] = Voverriding_local_map
;
7524 /* No, so use major and minor mode keymaps and keymap property.
7525 Note that menu-bar bindings in the local-map and keymap
7526 properties may not work reliable, as they are only
7527 recognized when the menu-bar (or mode-line) is updated,
7528 which does not normally happen after every command. */
7531 nminor
= current_minor_maps (NULL
, &tmaps
);
7532 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7534 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7535 maps
[nmaps
++] = tem
;
7536 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7538 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7540 maps
[nmaps
++] = current_global_map
;
7543 /* Look up in each map the dummy prefix key `menu-bar'. */
7547 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7548 if (!NILP (maps
[mapno
]))
7550 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7554 menu_bar_one_keymap_changed_items
= Qnil
;
7555 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7559 /* Move to the end those items that should be at the end. */
7561 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7564 int end
= menu_bar_items_index
;
7566 for (i
= 0; i
< end
; i
+= 4)
7567 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7569 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7570 /* Move the item at index I to the end,
7571 shifting all the others forward. */
7572 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7573 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7574 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7575 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7577 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7578 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7579 (end
- i
- 4) * sizeof (Lisp_Object
));
7580 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7581 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7582 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7583 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7588 /* Add nil, nil, nil, nil at the end. */
7589 i
= menu_bar_items_index
;
7590 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7593 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7594 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7595 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7596 menu_bar_items_vector
= tem
;
7598 /* Add this item. */
7599 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7600 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7601 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7602 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7603 menu_bar_items_index
= i
;
7605 Vinhibit_quit
= oquit
;
7606 return menu_bar_items_vector
;
7609 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7610 If there's already an item for KEY, add this DEF to it. */
7612 Lisp_Object item_properties
;
7615 menu_bar_item (key
, item
, dummy1
, dummy2
)
7616 Lisp_Object key
, item
, dummy1
;
7619 struct gcpro gcpro1
;
7623 if (EQ (item
, Qundefined
))
7625 /* If a map has an explicit `undefined' as definition,
7626 discard any previously made menu bar item. */
7628 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7629 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7631 if (menu_bar_items_index
> i
+ 4)
7632 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7633 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7634 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7635 menu_bar_items_index
-= 4;
7639 /* If this keymap has already contributed to this KEY,
7640 don't contribute to it a second time. */
7641 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7642 if (!NILP (tem
) || NILP (item
))
7645 menu_bar_one_keymap_changed_items
7646 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7648 /* We add to menu_bar_one_keymap_changed_items before doing the
7649 parse_menu_item, so that if it turns out it wasn't a menu item,
7650 it still correctly hides any further menu item. */
7652 i
= parse_menu_item (item
, 0, 1);
7657 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7659 /* Find any existing item for this KEY. */
7660 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7661 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7664 /* If we did not find this KEY, add it at the end. */
7665 if (i
== menu_bar_items_index
)
7667 /* If vector is too small, get a bigger one. */
7668 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7671 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7672 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7673 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7674 menu_bar_items_vector
= tem
;
7677 /* Add this item. */
7678 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7679 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7680 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7681 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7682 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7683 menu_bar_items_index
= i
;
7685 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7689 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7690 /* If the new and the old items are not both keymaps,
7691 the lookup will only find `item'. */
7692 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7693 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7697 /* This is used as the handler when calling menu_item_eval_property. */
7699 menu_item_eval_property_1 (arg
)
7702 /* If we got a quit from within the menu computation,
7703 quit all the way out of it. This takes care of C-] in the debugger. */
7704 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7705 Fsignal (Qquit
, Qnil
);
7710 /* Evaluate an expression and return the result (or nil if something
7711 went wrong). Used to evaluate dynamic parts of menu items. */
7713 menu_item_eval_property (sexpr
)
7716 int count
= SPECPDL_INDEX ();
7718 specbind (Qinhibit_redisplay
, Qt
);
7719 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7720 menu_item_eval_property_1
);
7721 return unbind_to (count
, val
);
7724 /* This function parses a menu item and leaves the result in the
7725 vector item_properties.
7726 ITEM is a key binding, a possible menu item.
7727 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7728 evaluate dynamic expressions in the menu item.
7729 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7731 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7732 parse_menu_item returns true if the item is a menu item and false
7736 parse_menu_item (item
, notreal
, inmenubar
)
7738 int notreal
, inmenubar
;
7740 Lisp_Object def
, tem
, item_string
, start
;
7741 Lisp_Object cachelist
;
7743 Lisp_Object keyhint
;
7754 /* Create item_properties vector if necessary. */
7755 if (NILP (item_properties
))
7757 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7759 /* Initialize optional entries. */
7760 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7761 AREF (item_properties
, i
) = Qnil
;
7762 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7764 /* Save the item here to protect it from GC. */
7765 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7767 item_string
= XCAR (item
);
7771 if (STRINGP (item_string
))
7773 /* Old format menu item. */
7774 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7776 /* Maybe help string. */
7777 if (CONSP (item
) && STRINGP (XCAR (item
)))
7779 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7784 /* Maybe key binding cache. */
7785 if (CONSP (item
) && CONSP (XCAR (item
))
7786 && (NILP (XCAR (XCAR (item
)))
7787 || VECTORP (XCAR (XCAR (item
)))))
7789 cachelist
= XCAR (item
);
7793 /* This is the real definition--the function to run. */
7794 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7796 /* Get enable property, if any. */
7799 tem
= Fget (item
, Qmenu_enable
);
7800 if (!NILP (Venable_disabled_menus_and_buttons
))
7801 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7802 else if (!NILP (tem
))
7803 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7806 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7808 /* New format menu item. */
7809 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7810 start
= XCDR (item
);
7813 /* We have a real binding. */
7814 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7816 item
= XCDR (start
);
7817 /* Is there a cache list with key equivalences. */
7818 if (CONSP (item
) && CONSP (XCAR (item
)))
7820 cachelist
= XCAR (item
);
7824 /* Parse properties. */
7825 while (CONSP (item
) && CONSP (XCDR (item
)))
7830 if (EQ (tem
, QCenable
))
7832 if (!NILP (Venable_disabled_menus_and_buttons
))
7833 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7835 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7837 else if (EQ (tem
, QCvisible
) && !notreal
)
7839 /* If got a visible property and that evaluates to nil
7840 then ignore this item. */
7841 tem
= menu_item_eval_property (XCAR (item
));
7845 else if (EQ (tem
, QChelp
))
7846 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7847 else if (EQ (tem
, QCfilter
))
7849 else if (EQ (tem
, QCkey_sequence
))
7852 if (NILP (cachelist
)
7853 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7854 /* Be GC protected. Set keyhint to item instead of tem. */
7857 else if (EQ (tem
, QCkeys
))
7860 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7861 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7863 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7868 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7870 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7872 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7879 else if (inmenubar
|| !NILP (start
))
7883 return 0; /* not a menu item */
7885 /* If item string is not a string, evaluate it to get string.
7886 If we don't get a string, skip this item. */
7887 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7888 if (!(STRINGP (item_string
) || notreal
))
7890 item_string
= menu_item_eval_property (item_string
);
7891 if (!STRINGP (item_string
))
7893 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7896 /* If got a filter apply it on definition. */
7897 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7900 def
= menu_item_eval_property (list2 (XCAR (filter
),
7901 list2 (Qquote
, def
)));
7903 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7906 /* Enable or disable selection of item. */
7907 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7913 tem
= menu_item_eval_property (tem
);
7914 if (inmenubar
&& NILP (tem
))
7915 return 0; /* Ignore disabled items in menu bar. */
7916 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7919 /* If we got no definition, this item is just unselectable text which
7920 is OK in a submenu but not in the menubar. */
7922 return (inmenubar
? 0 : 1);
7924 /* See if this is a separate pane or a submenu. */
7925 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7926 tem
= get_keymap (def
, 0, 1);
7927 /* For a subkeymap, just record its details and exit. */
7930 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7931 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7935 /* At the top level in the menu bar, do likewise for commands also.
7936 The menu bar does not display equivalent key bindings anyway.
7937 ITEM_PROPERTY_DEF is already set up properly. */
7941 /* This is a command. See if there is an equivalent key binding. */
7942 if (NILP (cachelist
))
7944 /* We have to create a cachelist. */
7945 CHECK_IMPURE (start
);
7946 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7947 cachelist
= XCAR (XCDR (start
));
7949 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7950 if (!NILP (keyhint
))
7952 XSETCAR (cachelist
, XCAR (keyhint
));
7955 else if (STRINGP (tem
))
7957 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7958 XSETCAR (cachelist
, Qt
);
7962 tem
= XCAR (cachelist
);
7969 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
7971 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7974 def
= XCAR (prefix
);
7975 prefix
= XCDR (prefix
);
7978 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7980 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7982 if (newcache
/* Always check first time. */
7983 /* Should we check everything when precomputing key
7985 /* If something had no key binding before, don't recheck it
7986 because that is too slow--except if we have a list of
7987 rebound commands in Vdefine_key_rebound_commands, do
7988 recheck any command that appears in that list. */
7989 || (CONSP (Vdefine_key_rebound_commands
)
7990 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7993 /* We had a saved key. Is it still bound to the command? */
7996 /* If the command is an alias for another
7997 (such as lmenu.el set it up), check if the
7998 original command matches the cached command. */
7999 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8000 chkcache
= 1; /* Need to recompute key binding. */
8004 /* Recompute equivalent key binding. If the command is an alias
8005 for another (such as lmenu.el set it up), see if the original
8006 command name has equivalent keys. Otherwise look up the
8007 specified command itself. We don't try both, because that
8008 makes lmenu menus slow. */
8010 && SYMBOLP (XSYMBOL (def
)->function
)
8011 && ! NILP (Fget (def
, Qmenu_alias
)))
8012 def
= XSYMBOL (def
)->function
;
8013 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8014 XSETCAR (cachelist
, tem
);
8017 XSETCDR (cachelist
, Qnil
);
8021 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8023 tem
= XCAR (cachelist
);
8027 newcache
= chkcache
;
8030 tem
= Fkey_description (tem
, Qnil
);
8033 if (STRINGP (XCAR (prefix
)))
8034 tem
= concat2 (XCAR (prefix
), tem
);
8035 if (STRINGP (XCDR (prefix
)))
8036 tem
= concat2 (tem
, XCDR (prefix
));
8038 XSETCDR (cachelist
, tem
);
8042 tem
= XCDR (cachelist
);
8043 if (newcache
&& !NILP (tem
))
8045 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
8046 XSETCDR (cachelist
, tem
);
8049 /* If we only want to precompute equivalent key bindings, stop here. */
8053 /* If we have an equivalent key binding, use that. */
8054 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
8056 /* Include this when menu help is implemented.
8057 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8058 if (!(NILP (tem) || STRINGP (tem)))
8060 tem = menu_item_eval_property (tem);
8063 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8067 /* Handle radio buttons or toggle boxes. */
8068 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8070 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
8071 = menu_item_eval_property (tem
);
8078 /***********************************************************************
8080 ***********************************************************************/
8082 /* A vector holding tool bar items while they are parsed in function
8083 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8086 static Lisp_Object tool_bar_items_vector
;
8088 /* A vector holding the result of parse_tool_bar_item. Layout is like
8089 the one for a single item in tool_bar_items_vector. */
8091 static Lisp_Object tool_bar_item_properties
;
8093 /* Next free index in tool_bar_items_vector. */
8095 static int ntool_bar_items
;
8097 /* The symbols `tool-bar', `:image' and `:rtl'. */
8099 extern Lisp_Object Qtool_bar
;
8100 Lisp_Object QCimage
;
8103 /* Function prototypes. */
8105 static void init_tool_bar_items
P_ ((Lisp_Object
));
8106 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8107 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8108 static void append_tool_bar_item
P_ ((void));
8111 /* Return a vector of tool bar items for keymaps currently in effect.
8112 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8113 tool bar items found. */
8116 tool_bar_items (reuse
, nitems
)
8127 /* In order to build the menus, we need to call the keymap
8128 accessors. They all call QUIT. But this function is called
8129 during redisplay, during which a quit is fatal. So inhibit
8130 quitting while building the menus. We do this instead of
8131 specbind because (1) errors will clear it anyway and (2) this
8132 avoids risk of specpdl overflow. */
8133 oquit
= Vinhibit_quit
;
8136 /* Initialize tool_bar_items_vector and protect it from GC. */
8137 init_tool_bar_items (reuse
);
8139 /* Build list of keymaps in maps. Set nmaps to the number of maps
8142 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8143 if (!NILP (Voverriding_local_map_menu_flag
))
8145 /* Yes, use them (if non-nil) as well as the global map. */
8146 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8148 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8149 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8150 if (!NILP (Voverriding_local_map
))
8151 maps
[nmaps
++] = Voverriding_local_map
;
8155 /* No, so use major and minor mode keymaps and keymap property.
8156 Note that tool-bar bindings in the local-map and keymap
8157 properties may not work reliable, as they are only
8158 recognized when the tool-bar (or mode-line) is updated,
8159 which does not normally happen after every command. */
8162 nminor
= current_minor_maps (NULL
, &tmaps
);
8163 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8165 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8166 maps
[nmaps
++] = tem
;
8167 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8169 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8172 /* Add global keymap at the end. */
8173 maps
[nmaps
++] = current_global_map
;
8175 /* Process maps in reverse order and look up in each map the prefix
8177 for (i
= nmaps
- 1; i
>= 0; --i
)
8178 if (!NILP (maps
[i
]))
8182 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8184 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8187 Vinhibit_quit
= oquit
;
8188 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8189 return tool_bar_items_vector
;
8193 /* Process the definition of KEY which is DEF. */
8196 process_tool_bar_item (key
, def
, data
, args
)
8197 Lisp_Object key
, def
, data
;
8201 extern Lisp_Object Qundefined
;
8202 struct gcpro gcpro1
, gcpro2
;
8204 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8208 if (EQ (def
, Qundefined
))
8210 /* If a map has an explicit `undefined' as definition,
8211 discard any previously made item. */
8212 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8214 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8216 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8218 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8219 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8220 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8221 * sizeof (Lisp_Object
)));
8222 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8227 else if (parse_tool_bar_item (key
, def
))
8228 /* Append a new tool bar item to tool_bar_items_vector. Accept
8229 more than one definition for the same key. */
8230 append_tool_bar_item ();
8236 /* Parse a tool bar item specification ITEM for key KEY and return the
8237 result in tool_bar_item_properties. Value is zero if ITEM is
8240 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8242 CAPTION is the caption of the item, If it's not a string, it is
8243 evaluated to get a string.
8245 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8246 as binding are currently ignored.
8248 The following properties are recognized:
8252 FORM is evaluated and specifies whether the tool bar item is
8253 enabled or disabled.
8257 FORM is evaluated and specifies whether the tool bar item is visible.
8259 - `:filter FUNCTION'
8261 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8262 result is stored as the new binding.
8264 - `:button (TYPE SELECTED)'
8266 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8267 and specifies whether the button is selected (pressed) or not.
8271 IMAGES is either a single image specification or a vector of four
8272 image specifications. See enum tool_bar_item_images.
8274 - `:help HELP-STRING'.
8276 Gives a help string to display for the tool bar item. */
8279 parse_tool_bar_item (key
, item
)
8280 Lisp_Object key
, item
;
8282 /* Access slot with index IDX of vector tool_bar_item_properties. */
8283 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8285 Lisp_Object filter
= Qnil
;
8286 Lisp_Object caption
;
8289 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8290 Rule out items that aren't lists, don't start with
8291 `menu-item' or whose rest following `tool-bar-item' is not a
8294 || !EQ (XCAR (item
), Qmenu_item
)
8295 || (item
= XCDR (item
),
8299 /* Create tool_bar_item_properties vector if necessary. Reset it to
8301 if (VECTORP (tool_bar_item_properties
))
8303 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8307 tool_bar_item_properties
8308 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8311 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8312 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8314 /* Get the caption of the item. If the caption is not a string,
8315 evaluate it to get a string. If we don't get a string, skip this
8317 caption
= XCAR (item
);
8318 if (!STRINGP (caption
))
8320 caption
= menu_item_eval_property (caption
);
8321 if (!STRINGP (caption
))
8324 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8326 /* Give up if rest following the caption is not a list. */
8331 /* Store the binding. */
8332 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8335 /* Ignore cached key binding, if any. */
8336 if (CONSP (item
) && CONSP (XCAR (item
)))
8339 /* Process the rest of the properties. */
8340 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8342 Lisp_Object key
, value
;
8345 value
= XCAR (XCDR (item
));
8347 if (EQ (key
, QCenable
))
8349 /* `:enable FORM'. */
8350 if (!NILP (Venable_disabled_menus_and_buttons
))
8351 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8353 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8355 else if (EQ (key
, QCvisible
))
8357 /* `:visible FORM'. If got a visible property and that
8358 evaluates to nil then ignore this item. */
8359 if (NILP (menu_item_eval_property (value
)))
8362 else if (EQ (key
, QChelp
))
8363 /* `:help HELP-STRING'. */
8364 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8365 else if (EQ (key
, QCfilter
))
8366 /* ':filter FORM'. */
8368 else if (EQ (key
, QCbutton
) && CONSP (value
))
8370 /* `:button (TYPE . SELECTED)'. */
8371 Lisp_Object type
, selected
;
8373 type
= XCAR (value
);
8374 selected
= XCDR (value
);
8375 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8377 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8378 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8381 else if (EQ (key
, QCimage
)
8383 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8384 /* Value is either a single image specification or a vector
8385 of 4 such specifications for the different button states. */
8386 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8387 else if (EQ (key
, Qrtl
))
8389 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8392 /* If got a filter apply it on binding. */
8394 PROP (TOOL_BAR_ITEM_BINDING
)
8395 = menu_item_eval_property (list2 (filter
,
8397 PROP (TOOL_BAR_ITEM_BINDING
))));
8399 /* See if the binding is a keymap. Give up if it is. */
8400 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8403 /* Enable or disable selection of item. */
8404 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8405 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8406 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8408 /* Handle radio buttons or toggle boxes. */
8409 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8410 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8411 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8419 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8420 that can be reused. */
8423 init_tool_bar_items (reuse
)
8426 if (VECTORP (reuse
))
8427 tool_bar_items_vector
= reuse
;
8429 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8430 ntool_bar_items
= 0;
8434 /* Append parsed tool bar item properties from
8435 tool_bar_item_properties */
8438 append_tool_bar_item ()
8440 Lisp_Object
*to
, *from
;
8442 /* Enlarge tool_bar_items_vector if necessary. */
8443 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8444 >= XVECTOR (tool_bar_items_vector
)->size
)
8446 Lisp_Object new_vector
;
8447 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
8449 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
8450 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
8451 XVECTOR (new_vector
)->contents
,
8452 old_size
* sizeof (Lisp_Object
));
8453 tool_bar_items_vector
= new_vector
;
8456 /* Append entries from tool_bar_item_properties to the end of
8457 tool_bar_items_vector. */
8458 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8459 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8460 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8461 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8468 /* Read a character using menus based on maps in the array MAPS.
8469 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8470 Return t if we displayed a menu but the user rejected it.
8472 PREV_EVENT is the previous input event, or nil if we are reading
8473 the first event of a key sequence.
8475 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8476 if we used a mouse menu to read the input, or zero otherwise. If
8477 USED_MOUSE_MENU is null, we don't dereference it.
8479 The prompting is done based on the prompt-string of the map
8480 and the strings associated with various map elements.
8482 This can be done with X menus or with menus put in the minibuf.
8483 These are done in different ways, depending on how the input will be read.
8484 Menus using X are done after auto-saving in read-char, getting the input
8485 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8486 and do auto-saving in the inner call of read_char. */
8489 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8492 Lisp_Object prev_event
;
8493 int *used_mouse_menu
;
8496 register Lisp_Object name
= Qnil
;
8498 if (used_mouse_menu
)
8499 *used_mouse_menu
= 0;
8501 /* Use local over global Menu maps */
8503 if (! menu_prompting
)
8506 /* Optionally disregard all but the global map. */
8507 if (inhibit_local_menu_bar_menus
)
8509 maps
+= (nmaps
- 1);
8513 /* Get the menu name from the first map that has one (a prompt string). */
8514 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8516 name
= Fkeymap_prompt (maps
[mapno
]);
8521 /* If we don't have any menus, just read a character normally. */
8522 if (!STRINGP (name
))
8526 /* If we got to this point via a mouse click,
8527 use a real menu for mouse selection. */
8528 if (EVENT_HAS_PARAMETERS (prev_event
)
8529 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8530 && !EQ (XCAR (prev_event
), Qtool_bar
))
8532 /* Display the menu and get the selection. */
8533 Lisp_Object
*realmaps
8534 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8538 /* Use the maps that are not nil. */
8539 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8540 if (!NILP (maps
[mapno
]))
8541 realmaps
[nmaps1
++] = maps
[mapno
];
8543 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8548 record_menu_key (XCAR (value
));
8550 /* If we got multiple events, unread all but
8552 There is no way to prevent those unread events
8553 from showing up later in last_nonmenu_event.
8554 So turn symbol and integer events into lists,
8555 to indicate that they came from a mouse menu,
8556 so that when present in last_nonmenu_event
8557 they won't confuse things. */
8558 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8560 record_menu_key (XCAR (tem
));
8561 if (SYMBOLP (XCAR (tem
))
8562 || INTEGERP (XCAR (tem
)))
8563 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8566 /* If we got more than one event, put all but the first
8567 onto this list to be read later.
8568 Return just the first event now. */
8569 Vunread_command_events
8570 = nconc2 (XCDR (value
), Vunread_command_events
);
8571 value
= XCAR (value
);
8573 else if (NILP (value
))
8575 if (used_mouse_menu
)
8576 *used_mouse_menu
= 1;
8579 #endif /* HAVE_MENUS */
8583 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8584 We make this bigger when necessary, and never free it. */
8585 static char *read_char_minibuf_menu_text
;
8586 /* Size of that buffer. */
8587 static int read_char_minibuf_menu_width
;
8590 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8596 register Lisp_Object name
;
8598 /* FIXME: Use the minibuffer's frame width. */
8599 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8602 Lisp_Object rest
, vector
;
8608 if (! menu_prompting
)
8611 /* Make sure we have a big enough buffer for the menu text. */
8612 if (read_char_minibuf_menu_text
== 0)
8614 read_char_minibuf_menu_width
= width
+ 4;
8615 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8617 else if (width
+ 4 > read_char_minibuf_menu_width
)
8619 read_char_minibuf_menu_width
= width
+ 4;
8620 read_char_minibuf_menu_text
8621 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8623 menu
= read_char_minibuf_menu_text
;
8625 /* Get the menu name from the first map that has one (a prompt string). */
8626 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8628 name
= Fkeymap_prompt (maps
[mapno
]);
8633 /* If we don't have any menus, just read a character normally. */
8634 if (!STRINGP (name
))
8637 /* Prompt string always starts with map's prompt, and a space. */
8638 strcpy (menu
, SDATA (name
));
8639 nlength
= SBYTES (name
);
8640 menu
[nlength
++] = ':';
8641 menu
[nlength
++] = ' ';
8644 /* Start prompting at start of first map. */
8648 /* Present the documented bindings, a line at a time. */
8655 Lisp_Object orig_defn_macro
;
8657 /* Loop over elements of map. */
8662 /* If reached end of map, start at beginning of next map. */
8666 /* At end of last map, wrap around to first map if just starting,
8667 or end this line if already have something on it. */
8671 if (notfirst
|| nobindings
) break;
8676 /* Look at the next element of the map. */
8678 elt
= XVECTOR (vector
)->contents
[idx
];
8680 elt
= Fcar_safe (rest
);
8682 if (idx
< 0 && VECTORP (elt
))
8684 /* If we found a dense table in the keymap,
8685 advanced past it, but start scanning its contents. */
8686 rest
= Fcdr_safe (rest
);
8692 /* An ordinary element. */
8693 Lisp_Object event
, tem
;
8697 event
= Fcar_safe (elt
); /* alist */
8698 elt
= Fcdr_safe (elt
);
8702 XSETINT (event
, idx
); /* vector */
8705 /* Ignore the element if it has no prompt string. */
8706 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8708 /* 1 if the char to type matches the string. */
8710 Lisp_Object upcased_event
, downcased_event
;
8711 Lisp_Object desc
= Qnil
;
8713 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8715 upcased_event
= Fupcase (event
);
8716 downcased_event
= Fdowncase (event
);
8717 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8718 || XINT (downcased_event
) == SREF (s
, 0));
8720 desc
= Fsingle_key_description (event
, Qnil
);
8722 #if 0 /* It is redundant to list the equivalent key bindings because
8723 the prefix is what the user has already typed. */
8725 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8727 /* Insert equivalent keybinding. */
8728 s
= concat2 (s
, tem
);
8731 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8732 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8734 /* Insert button prefix. */
8735 Lisp_Object selected
8736 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8737 if (EQ (tem
, QCradio
))
8738 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8740 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8741 s
= concat2 (tem
, s
);
8745 /* If we have room for the prompt string, add it to this line.
8746 If this is the first on the line, always add it. */
8747 if ((SCHARS (s
) + i
+ 2
8748 + (char_matches
? 0 : SCHARS (desc
) + 3))
8754 /* Punctuate between strings. */
8757 strcpy (menu
+ i
, ", ");
8763 /* If the char to type doesn't match the string's
8764 first char, explicitly show what char to type. */
8767 /* Add as much of string as fits. */
8768 thiswidth
= SCHARS (desc
);
8769 if (thiswidth
+ i
> width
)
8770 thiswidth
= width
- i
;
8771 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8773 strcpy (menu
+ i
, " = ");
8777 /* Add as much of string as fits. */
8778 thiswidth
= SCHARS (s
);
8779 if (thiswidth
+ i
> width
)
8780 thiswidth
= width
- i
;
8781 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8787 /* If this element does not fit, end the line now,
8788 and save the element for the next line. */
8789 strcpy (menu
+ i
, "...");
8794 /* Move past this element. */
8795 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8796 /* Handle reaching end of dense table. */
8801 rest
= Fcdr_safe (rest
);
8805 /* Prompt with that and read response. */
8806 message2_nolog (menu
, strlen (menu
),
8807 ! NILP (current_buffer
->enable_multibyte_characters
));
8809 /* Make believe its not a keyboard macro in case the help char
8810 is pressed. Help characters are not recorded because menu prompting
8811 is not used on replay.
8813 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8814 current_kboard
->defining_kbd_macro
= Qnil
;
8816 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8817 while (BUFFERP (obj
));
8818 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8820 if (!INTEGERP (obj
))
8822 else if (XINT (obj
) == -2)
8827 if (! EQ (obj
, menu_prompt_more_char
)
8828 && (!INTEGERP (menu_prompt_more_char
)
8829 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8831 if (!NILP (current_kboard
->defining_kbd_macro
))
8832 store_kbd_macro_char (obj
);
8835 /* Help char - go round again */
8839 /* Reading key sequences. */
8841 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8842 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8843 keymap, or nil otherwise. Return the index of the first keymap in
8844 which KEY has any binding, or NMAPS if no map has a binding.
8846 If KEY is a meta ASCII character, treat it like meta-prefix-char
8847 followed by the corresponding non-meta character. Keymaps in
8848 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8851 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8854 NEXT may be the same array as CURRENT. */
8857 follow_key (key
, nmaps
, current
, defs
, next
)
8859 Lisp_Object
*current
, *defs
, *next
;
8862 int i
, first_binding
;
8864 first_binding
= nmaps
;
8865 for (i
= nmaps
- 1; i
>= 0; i
--)
8867 if (! NILP (current
[i
]))
8869 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8870 if (! NILP (defs
[i
]))
8877 /* Given the set of bindings we've found, produce the next set of maps. */
8878 if (first_binding
< nmaps
)
8879 for (i
= 0; i
< nmaps
; i
++)
8880 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8882 return first_binding
;
8885 /* Structure used to keep track of partial application of key remapping
8886 such as Vfunction_key_map and Vkey_translation_map. */
8887 typedef struct keyremap
8889 /* This is the map originally specified for this use. */
8891 /* This is a submap reached by looking up, in PARENT,
8892 the events from START to END. */
8894 /* Positions [START, END) in the key sequence buffer
8895 are the key that we have scanned so far.
8896 Those events are the ones that we will replace
8897 if PAREHT maps them into a key sequence. */
8901 /* Lookup KEY in MAP.
8902 MAP is a keymap mapping keys to key vectors or functions.
8903 If the mapping is a function and DO_FUNCTION is non-zero, then
8904 the function is called with PROMPT as parameter and its return
8905 value is used as the return value of this function (after checking
8906 that it is indeed a vector). */
8909 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8910 Lisp_Object map
, key
, prompt
;
8915 next
= access_keymap (map
, key
, 1, 0, 1);
8917 /* Handle symbol with autoload definition. */
8918 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8919 && CONSP (XSYMBOL (next
)->function
)
8920 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8921 do_autoload (XSYMBOL (next
)->function
, next
);
8923 /* Handle a symbol whose function definition is a keymap
8925 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8926 && (ARRAYP (XSYMBOL (next
)->function
)
8927 || KEYMAPP (XSYMBOL (next
)->function
)))
8928 next
= XSYMBOL (next
)->function
;
8930 /* If the keymap gives a function, not an
8931 array, then call the function with one arg and use
8932 its value instead. */
8933 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8938 next
= call1 (next
, prompt
);
8939 /* If the function returned something invalid,
8940 barf--don't ignore it.
8941 (To ignore it safely, we would need to gcpro a bunch of
8942 other variables.) */
8943 if (! (VECTORP (next
) || STRINGP (next
)))
8944 error ("Function %s returns invalid key sequence", tem
);
8949 /* Do one step of the key remapping used for function-key-map and
8950 key-translation-map:
8951 KEYBUF is the buffer holding the input events.
8952 BUFSIZE is its maximum size.
8953 FKEY is a pointer to the keyremap structure to use.
8954 INPUT is the index of the last element in KEYBUF.
8955 DOIT if non-zero says that the remapping can actually take place.
8956 DIFF is used to return the number of keys added/removed by the remapping.
8957 PARENT is the root of the keymap.
8958 PROMPT is the prompt to use if the remapping happens through a function.
8959 The return value is non-zero if the remapping actually took place. */
8962 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8963 Lisp_Object
*keybuf
, prompt
;
8965 int input
, doit
, *diff
, bufsize
;
8967 Lisp_Object next
, key
;
8969 key
= keybuf
[fkey
->end
++];
8971 if (KEYMAPP (fkey
->parent
))
8972 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8976 /* If keybuf[fkey->start..fkey->end] is bound in the
8977 map and we're in a position to do the key remapping, replace it with
8978 the binding and restart with fkey->start at the end. */
8979 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8981 int len
= XFASTINT (Flength (next
));
8984 *diff
= len
- (fkey
->end
- fkey
->start
);
8986 if (input
+ *diff
>= bufsize
)
8987 error ("Key sequence too long");
8989 /* Shift the keys that follow fkey->end. */
8991 for (i
= fkey
->end
; i
< input
; i
++)
8992 keybuf
[i
+ *diff
] = keybuf
[i
];
8994 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8995 keybuf
[i
+ *diff
] = keybuf
[i
];
8996 /* Overwrite the old keys with the new ones. */
8997 for (i
= 0; i
< len
; i
++)
8998 keybuf
[fkey
->start
+ i
]
8999 = Faref (next
, make_number (i
));
9001 fkey
->start
= fkey
->end
+= *diff
;
9002 fkey
->map
= fkey
->parent
;
9007 fkey
->map
= get_keymap (next
, 0, 1);
9009 /* If we no longer have a bound suffix, try a new position for
9011 if (!CONSP (fkey
->map
))
9013 fkey
->end
= ++fkey
->start
;
9014 fkey
->map
= fkey
->parent
;
9019 /* Read a sequence of keys that ends with a non prefix character,
9020 storing it in KEYBUF, a buffer of size BUFSIZE.
9022 Return the length of the key sequence stored.
9023 Return -1 if the user rejected a command menu.
9025 Echo starting immediately unless `prompt' is 0.
9027 Where a key sequence ends depends on the currently active keymaps.
9028 These include any minor mode keymaps active in the current buffer,
9029 the current buffer's local map, and the global map.
9031 If a key sequence has no other bindings, we check Vfunction_key_map
9032 to see if some trailing subsequence might be the beginning of a
9033 function key's sequence. If so, we try to read the whole function
9034 key, and substitute its symbolic name into the key sequence.
9036 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9037 `double-' events into similar click events, if that would make them
9038 bound. We try to turn `triple-' events first into `double-' events,
9041 If we get a mouse click in a mode line, vertical divider, or other
9042 non-text area, we treat the click as if it were prefixed by the
9043 symbol denoting that area - `mode-line', `vertical-line', or
9046 If the sequence starts with a mouse click, we read the key sequence
9047 with respect to the buffer clicked on, not the current buffer.
9049 If the user switches frames in the midst of a key sequence, we put
9050 off the switch-frame event until later; the next call to
9051 read_char will return it.
9053 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9054 from the selected window's buffer. */
9057 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9058 can_return_switch_frame
, fix_current_buffer
)
9059 Lisp_Object
*keybuf
;
9062 int dont_downcase_last
;
9063 int can_return_switch_frame
;
9064 int fix_current_buffer
;
9066 volatile Lisp_Object from_string
;
9067 volatile int count
= SPECPDL_INDEX ();
9069 /* How many keys there are in the current key sequence. */
9072 /* The length of the echo buffer when we started reading, and
9073 the length of this_command_keys when we started reading. */
9074 volatile int echo_start
;
9075 volatile int keys_start
;
9077 /* The number of keymaps we're scanning right now, and the number of
9078 keymaps we have allocated space for. */
9080 volatile int nmaps_allocated
= 0;
9082 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9083 the current keymaps. */
9084 Lisp_Object
*volatile defs
= NULL
;
9086 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9087 in the current keymaps, or nil where it is not a prefix. */
9088 Lisp_Object
*volatile submaps
= NULL
;
9090 /* The local map to start out with at start of key sequence. */
9091 volatile Lisp_Object orig_local_map
;
9093 /* The map from the `keymap' property to start out with at start of
9095 volatile Lisp_Object orig_keymap
;
9097 /* 1 if we have already considered switching to the local-map property
9098 of the place where a mouse click occurred. */
9099 volatile int localized_local_map
= 0;
9101 /* The index in submaps[] of the first keymap that has a binding for
9102 this key sequence. In other words, the lowest i such that
9103 submaps[i] is non-nil. */
9104 volatile int first_binding
;
9105 /* Index of the first key that has no binding.
9106 It is useless to try fkey.start larger than that. */
9107 volatile int first_unbound
;
9109 /* If t < mock_input, then KEYBUF[t] should be read as the next
9112 We use this to recover after recognizing a function key. Once we
9113 realize that a suffix of the current key sequence is actually a
9114 function key's escape sequence, we replace the suffix with the
9115 function key's binding from Vfunction_key_map. Now keybuf
9116 contains a new and different key sequence, so the echo area,
9117 this_command_keys, and the submaps and defs arrays are wrong. In
9118 this situation, we set mock_input to t, set t to 0, and jump to
9119 restart_sequence; the loop will read keys from keybuf up until
9120 mock_input, thus rebuilding the state; and then it will resume
9121 reading characters from the keyboard. */
9122 volatile int mock_input
= 0;
9124 /* If the sequence is unbound in submaps[], then
9125 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9126 and fkey.map is its binding.
9128 These might be > t, indicating that all function key scanning
9129 should hold off until t reaches them. We do this when we've just
9130 recognized a function key, to avoid searching for the function
9131 key's again in Vfunction_key_map. */
9132 volatile keyremap fkey
;
9134 /* Likewise, for key_translation_map. */
9135 volatile keyremap keytran
;
9137 /* If we receive a `switch-frame' or `select-window' event in the middle of
9138 a key sequence, we put it off for later.
9139 While we're reading, we keep the event here. */
9140 volatile Lisp_Object delayed_switch_frame
;
9142 /* See the comment below... */
9143 #if defined (GOBBLE_FIRST_EVENT)
9144 Lisp_Object first_event
;
9147 volatile Lisp_Object original_uppercase
;
9148 volatile int original_uppercase_position
= -1;
9150 /* Gets around Microsoft compiler limitations. */
9153 struct buffer
*starting_buffer
;
9155 /* List of events for which a fake prefix key has been generated. */
9156 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9158 #if defined (GOBBLE_FIRST_EVENT)
9162 struct gcpro gcpro1
;
9164 GCPRO1 (fake_prefixed_keys
);
9165 raw_keybuf_count
= 0;
9167 last_nonmenu_event
= Qnil
;
9169 delayed_switch_frame
= Qnil
;
9174 echo_prompt (prompt
);
9175 else if (cursor_in_echo_area
9176 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9177 && NILP (Fzerop (Vecho_keystrokes
)))
9178 /* This doesn't put in a dash if the echo buffer is empty, so
9179 you don't always see a dash hanging out in the minibuffer. */
9183 /* Record the initial state of the echo area and this_command_keys;
9184 we will need to restore them if we replay a key sequence. */
9186 echo_start
= echo_length ();
9187 keys_start
= this_command_key_count
;
9188 this_single_command_key_start
= keys_start
;
9190 #if defined (GOBBLE_FIRST_EVENT)
9191 /* This doesn't quite work, because some of the things that read_char
9192 does cannot safely be bypassed. It seems too risky to try to make
9195 /* Read the first char of the sequence specially, before setting
9196 up any keymaps, in case a filter runs and switches buffers on us. */
9197 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9199 #endif /* GOBBLE_FIRST_EVENT */
9201 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9202 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9205 /* We jump here when the key sequence has been thoroughly changed, and
9206 we need to rescan it starting from the beginning. When we jump here,
9207 keybuf[0..mock_input] holds the sequence we should reread. */
9210 /* We may switch keyboards between rescans, so we need to
9211 reinitialize fkey and keytran before each replay. */
9212 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9213 keytran
.map
= keytran
.parent
= current_kboard
->Vlocal_key_translation_map
;
9214 fkey
.start
= fkey
.end
= 0;
9215 keytran
.start
= keytran
.end
= 0;
9217 starting_buffer
= current_buffer
;
9218 first_unbound
= bufsize
+ 1;
9220 /* Build our list of keymaps.
9221 If we recognize a function key and replace its escape sequence in
9222 keybuf with its symbol, or if the sequence starts with a mouse
9223 click and we need to switch buffers, we jump back here to rebuild
9224 the initial keymaps from the current buffer. */
9227 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9229 if (2 > nmaps_allocated
)
9231 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9232 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9233 nmaps_allocated
= 2;
9235 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9236 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9238 else if (!NILP (Voverriding_local_map
))
9240 if (2 > nmaps_allocated
)
9242 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9243 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9244 nmaps_allocated
= 2;
9246 if (!NILP (Voverriding_local_map
))
9247 submaps
[nmaps
++] = Voverriding_local_map
;
9255 nminor
= current_minor_maps (0, &maps
);
9256 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9258 if (total
> nmaps_allocated
)
9260 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9261 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9262 nmaps_allocated
= total
;
9265 if (!NILP (orig_keymap
))
9266 submaps
[nmaps
++] = orig_keymap
;
9268 bcopy (maps
, (void *) (submaps
+ nmaps
),
9269 nminor
* sizeof (submaps
[0]));
9273 submaps
[nmaps
++] = orig_local_map
;
9275 submaps
[nmaps
++] = current_global_map
;
9277 /* Find an accurate initial value for first_binding. */
9278 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9279 if (! NILP (submaps
[first_binding
]))
9282 /* Start from the beginning in keybuf. */
9285 /* These are no-ops the first time through, but if we restart, they
9286 revert the echo area and this_command_keys to their original state. */
9287 this_command_key_count
= keys_start
;
9288 if (INTERACTIVE
&& t
< mock_input
)
9289 echo_truncate (echo_start
);
9291 /* If the best binding for the current key sequence is a keymap, or
9292 we may be looking at a function key's escape sequence, keep on
9294 while (first_binding
< nmaps
9295 /* Keep reading as long as there's a prefix binding. */
9296 ? !NILP (submaps
[first_binding
])
9297 /* Don't return in the middle of a possible function key sequence,
9298 if the only bindings we found were via case conversion.
9299 Thus, if ESC O a has a function-key-map translation
9300 and ESC o has a binding, don't return after ESC O,
9301 so that we can translate ESC O plus the next character. */
9302 : (fkey
.start
< t
|| keytran
.start
< t
))
9305 int used_mouse_menu
= 0;
9307 /* Where the last real key started. If we need to throw away a
9308 key that has expanded into more than one element of keybuf
9309 (say, a mouse click on the mode line which is being treated
9310 as [mode-line (mouse-...)], then we backtrack to this point
9312 volatile int last_real_key_start
;
9314 /* These variables are analogous to echo_start and keys_start;
9315 while those allow us to restart the entire key sequence,
9316 echo_local_start and keys_local_start allow us to throw away
9318 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9320 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
9321 eassert (fkey
.start
<= fkey
.end
);
9322 eassert (keytran
.start
<= keytran
.end
);
9323 /* key-translation-map is applied *after* function-key-map. */
9324 eassert (keytran
.end
<= fkey
.start
);
9326 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
9327 { /* The prefix upto first_unbound has no binding and has
9328 no translation left to do either, so we know it's unbound.
9329 If we don't stop now, we risk staying here indefinitely
9330 (if the user keeps entering fkey or keytran prefixes
9331 like C-c ESC ESC ESC ESC ...) */
9333 for (i
= first_unbound
+ 1; i
< t
; i
++)
9334 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9335 mock_input
= t
- first_unbound
- 1;
9336 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9337 fkey
.map
= fkey
.parent
;
9338 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9339 keytran
.map
= keytran
.parent
;
9340 goto replay_sequence
;
9344 error ("Key sequence too long");
9347 echo_local_start
= echo_length ();
9348 keys_local_start
= this_command_key_count
;
9349 local_first_binding
= first_binding
;
9352 /* These are no-ops, unless we throw away a keystroke below and
9353 jumped back up to replay_key; in that case, these restore the
9354 variables to their original state, allowing us to replay the
9356 if (INTERACTIVE
&& t
< mock_input
)
9357 echo_truncate (echo_local_start
);
9358 this_command_key_count
= keys_local_start
;
9359 first_binding
= local_first_binding
;
9361 /* By default, assume each event is "real". */
9362 last_real_key_start
= t
;
9364 /* Does mock_input indicate that we are re-reading a key sequence? */
9368 add_command_key (key
);
9369 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9370 && NILP (Fzerop (Vecho_keystrokes
)))
9374 /* If not, we should actually read a character. */
9379 KBOARD
*interrupted_kboard
= current_kboard
;
9380 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9382 key
= read_char (NILP (prompt
), nmaps
,
9383 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9384 &used_mouse_menu
, NULL
);
9386 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9391 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9392 if (k
== interrupted_kboard
)
9397 /* Don't touch interrupted_kboard when it's been
9399 delayed_switch_frame
= Qnil
;
9400 goto replay_sequence
;
9403 if (!NILP (delayed_switch_frame
))
9405 interrupted_kboard
->kbd_queue
9406 = Fcons (delayed_switch_frame
,
9407 interrupted_kboard
->kbd_queue
);
9408 delayed_switch_frame
= Qnil
;
9412 interrupted_kboard
->kbd_queue
9413 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9415 /* If the side queue is non-empty, ensure it begins with a
9416 switch-frame, so we'll replay it in the right context. */
9417 if (CONSP (interrupted_kboard
->kbd_queue
)
9418 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9419 !(EVENT_HAS_PARAMETERS (key
)
9420 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9424 XSETFRAME (frame
, interrupted_frame
);
9425 interrupted_kboard
->kbd_queue
9426 = Fcons (make_lispy_switch_frame (frame
),
9427 interrupted_kboard
->kbd_queue
);
9430 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9431 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9432 goto replay_sequence
;
9437 /* read_char returns t when it shows a menu and the user rejects it.
9441 unbind_to (count
, Qnil
);
9446 /* read_char returns -1 at the end of a macro.
9447 Emacs 18 handles this by returning immediately with a
9448 zero, so that's what we'll do. */
9449 if (INTEGERP (key
) && XINT (key
) == -1)
9452 /* The Microsoft C compiler can't handle the goto that
9458 /* If the current buffer has been changed from under us, the
9459 keymap may have changed, so replay the sequence. */
9462 timer_resume_idle ();
9465 /* Reset the current buffer from the selected window
9466 in case something changed the former and not the latter.
9467 This is to be more consistent with the behavior
9468 of the command_loop_1. */
9469 if (fix_current_buffer
)
9471 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9473 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9474 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9477 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9478 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9479 goto replay_sequence
;
9482 /* If we have a quit that was typed in another frame, and
9483 quit_throw_to_read_char switched buffers,
9484 replay to get the right keymap. */
9486 && XINT (key
) == quit_char
9487 && current_buffer
!= starting_buffer
)
9490 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9494 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9495 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9496 goto replay_sequence
;
9501 if (EVENT_HAS_PARAMETERS (key
)
9502 /* Either a `switch-frame' or a `select-window' event. */
9503 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9505 /* If we're at the beginning of a key sequence, and the caller
9506 says it's okay, go ahead and return this event. If we're
9507 in the midst of a key sequence, delay it until the end. */
9508 if (t
> 0 || !can_return_switch_frame
)
9510 delayed_switch_frame
= key
;
9516 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9519 /* Clicks in non-text areas get prefixed by the symbol
9520 in their CHAR-ADDRESS field. For example, a click on
9521 the mode line is prefixed by the symbol `mode-line'.
9523 Furthermore, key sequences beginning with mouse clicks
9524 are read using the keymaps of the buffer clicked on, not
9525 the current buffer. So we may have to switch the buffer
9528 When we turn one event into two events, we must make sure
9529 that neither of the two looks like the original--so that,
9530 if we replay the events, they won't be expanded again.
9531 If not for this, such reexpansion could happen either here
9532 or when user programs play with this-command-keys. */
9533 if (EVENT_HAS_PARAMETERS (key
))
9538 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9539 if (EQ (kind
, Qmouse_click
))
9541 Lisp_Object window
, posn
;
9543 window
= POSN_WINDOW (EVENT_START (key
));
9544 posn
= POSN_POSN (EVENT_START (key
));
9547 || (!NILP (fake_prefixed_keys
)
9548 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9550 /* We're looking a second time at an event for which
9551 we generated a fake prefix key. Set
9552 last_real_key_start appropriately. */
9554 last_real_key_start
= t
- 1;
9557 /* Key sequences beginning with mouse clicks are
9558 read using the keymaps in the buffer clicked on,
9559 not the current buffer. If we're at the
9560 beginning of a key sequence, switch buffers. */
9561 if (last_real_key_start
== 0
9563 && BUFFERP (XWINDOW (window
)->buffer
)
9564 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9566 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9570 /* Arrange to go back to the original buffer once we're
9571 done reading the key sequence. Note that we can't
9572 use save_excursion_{save,restore} here, because they
9573 save point as well as the current buffer; we don't
9574 want to save point, because redisplay may change it,
9575 to accommodate a Fset_window_start or something. We
9576 don't want to do this at the top of the function,
9577 because we may get input from a subprocess which
9578 wants to change the selected window and stuff (say,
9580 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9582 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9584 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9585 orig_local_map
= get_local_map (PT
, current_buffer
,
9587 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9588 goto replay_sequence
;
9591 /* For a mouse click, get the local text-property keymap
9592 of the place clicked on, rather than point. */
9593 if (last_real_key_start
== 0
9594 && CONSP (XCDR (key
))
9595 && ! localized_local_map
)
9597 Lisp_Object map_here
, start
, pos
;
9599 localized_local_map
= 1;
9600 start
= EVENT_START (key
);
9602 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9604 pos
= POSN_BUFFER_POSN (start
);
9606 && XINT (pos
) >= BEGV
9607 && XINT (pos
) <= ZV
)
9609 map_here
= get_local_map (XINT (pos
),
9610 current_buffer
, Qlocal_map
);
9611 if (!EQ (map_here
, orig_local_map
))
9613 orig_local_map
= map_here
;
9614 ++localized_local_map
;
9617 map_here
= get_local_map (XINT (pos
),
9618 current_buffer
, Qkeymap
);
9619 if (!EQ (map_here
, orig_keymap
))
9621 orig_keymap
= map_here
;
9622 ++localized_local_map
;
9625 if (localized_local_map
> 1)
9630 goto replay_sequence
;
9636 /* Expand mode-line and scroll-bar events into two events:
9637 use posn as a fake prefix key. */
9639 && (NILP (fake_prefixed_keys
)
9640 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9642 if (t
+ 1 >= bufsize
)
9643 error ("Key sequence too long");
9646 keybuf
[t
+ 1] = key
;
9649 /* Record that a fake prefix key has been generated
9650 for KEY. Don't modify the event; this would
9651 prevent proper action when the event is pushed
9652 back into unread-command-events. */
9653 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9655 /* If on a mode line string with a local keymap,
9656 reconsider the key sequence with that keymap. */
9657 if (string
= POSN_STRING (EVENT_START (key
)),
9658 (CONSP (string
) && STRINGP (XCAR (string
))))
9660 Lisp_Object pos
, map
, map2
;
9662 pos
= XCDR (string
);
9663 string
= XCAR (string
);
9665 && XINT (pos
) < SCHARS (string
))
9667 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9669 orig_local_map
= map
;
9670 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9673 if (!NILP (map
) || !NILP (map2
))
9674 goto replay_sequence
;
9680 else if (NILP (from_string
)
9681 && (string
= POSN_STRING (EVENT_START (key
)),
9682 (CONSP (string
) && STRINGP (XCAR (string
)))))
9684 /* For a click on a string, i.e. overlay string or a
9685 string displayed via the `display' property,
9686 consider `local-map' and `keymap' properties of
9688 Lisp_Object pos
, map
, map2
;
9690 pos
= XCDR (string
);
9691 string
= XCAR (string
);
9693 && XINT (pos
) < SCHARS (string
))
9695 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9697 orig_local_map
= map
;
9698 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9702 if (!NILP (map
) || !NILP (map2
))
9704 from_string
= string
;
9707 goto replay_sequence
;
9712 else if (CONSP (XCDR (key
))
9713 && CONSP (EVENT_START (key
))
9714 && CONSP (XCDR (EVENT_START (key
))))
9718 posn
= POSN_POSN (EVENT_START (key
));
9719 /* Handle menu-bar events:
9720 insert the dummy prefix event `menu-bar'. */
9721 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9723 if (t
+ 1 >= bufsize
)
9724 error ("Key sequence too long");
9728 /* Zap the position in key, so we know that we've
9729 expanded it, and don't try to do so again. */
9730 POSN_SET_POSN (EVENT_START (key
),
9731 Fcons (posn
, Qnil
));
9734 goto replay_sequence
;
9736 else if (CONSP (posn
))
9738 /* We're looking at the second event of a
9739 sequence which we expanded before. Set
9740 last_real_key_start appropriately. */
9741 if (last_real_key_start
== t
&& t
> 0)
9742 last_real_key_start
= t
- 1;
9747 /* We have finally decided that KEY is something we might want
9749 first_binding
= (follow_key (key
,
9750 nmaps
- first_binding
,
9751 submaps
+ first_binding
,
9752 defs
+ first_binding
,
9753 submaps
+ first_binding
)
9756 /* If KEY wasn't bound, we'll try some fallbacks. */
9757 if (first_binding
< nmaps
)
9758 /* This is needed for the following scenario:
9759 event 0: a down-event that gets dropped by calling replay_key.
9760 event 1: some normal prefix like C-h.
9761 After event 0, first_unbound is 0, after event 1 fkey.start
9762 and keytran.start are both 1, so when we see that C-h is bound,
9763 we need to update first_unbound. */
9764 first_unbound
= max (t
+ 1, first_unbound
);
9769 /* Remember the position to put an upper bound on fkey.start. */
9770 first_unbound
= min (t
, first_unbound
);
9772 head
= EVENT_HEAD (key
);
9773 if (help_char_p (head
) && t
> 0)
9775 read_key_sequence_cmd
= Vprefix_help_command
;
9777 last_nonmenu_event
= key
;
9778 /* The Microsoft C compiler can't handle the goto that
9786 Lisp_Object breakdown
;
9789 breakdown
= parse_modifiers (head
);
9790 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9791 /* Attempt to reduce an unbound mouse event to a simpler
9792 event that is bound:
9793 Drags reduce to clicks.
9794 Double-clicks reduce to clicks.
9795 Triple-clicks reduce to double-clicks, then to clicks.
9796 Down-clicks are eliminated.
9797 Double-downs reduce to downs, then are eliminated.
9798 Triple-downs reduce to double-downs, then to downs,
9799 then are eliminated. */
9800 if (modifiers
& (down_modifier
| drag_modifier
9801 | double_modifier
| triple_modifier
))
9803 while (modifiers
& (down_modifier
| drag_modifier
9804 | double_modifier
| triple_modifier
))
9806 Lisp_Object new_head
, new_click
;
9807 if (modifiers
& triple_modifier
)
9808 modifiers
^= (double_modifier
| triple_modifier
);
9809 else if (modifiers
& double_modifier
)
9810 modifiers
&= ~double_modifier
;
9811 else if (modifiers
& drag_modifier
)
9812 modifiers
&= ~drag_modifier
;
9815 /* Dispose of this `down' event by simply jumping
9816 back to replay_key, to get another event.
9818 Note that if this event came from mock input,
9819 then just jumping back to replay_key will just
9820 hand it to us again. So we have to wipe out any
9823 We could delete keybuf[t] and shift everything
9824 after that to the left by one spot, but we'd also
9825 have to fix up any variable that points into
9826 keybuf, and shifting isn't really necessary
9829 Adding prefixes for non-textual mouse clicks
9830 creates two characters of mock input, and both
9831 must be thrown away. If we're only looking at
9832 the prefix now, we can just jump back to
9833 replay_key. On the other hand, if we've already
9834 processed the prefix, and now the actual click
9835 itself is giving us trouble, then we've lost the
9836 state of the keymaps we want to backtrack to, and
9837 we need to replay the whole sequence to rebuild
9840 Beyond that, only function key expansion could
9841 create more than two keys, but that should never
9842 generate mouse events, so it's okay to zero
9843 mock_input in that case too.
9845 FIXME: The above paragraph seems just plain
9846 wrong, if you consider things like
9847 xterm-mouse-mode. -stef
9849 Isn't this just the most wonderful code ever? */
9851 /* If mock_input > t + 1, the above simplification
9852 will actually end up dropping keys on the floor.
9853 This is probably OK for now, but even
9854 if mock_input <= t + 1, we need to adjust fkey
9856 Typical case [header-line down-mouse-N]:
9857 mock_input = 2, t = 1, fkey.end = 1,
9858 last_real_key_start = 0. */
9859 if (fkey
.end
> last_real_key_start
)
9861 fkey
.end
= fkey
.start
9862 = min (last_real_key_start
, fkey
.start
);
9863 fkey
.map
= fkey
.parent
;
9864 if (keytran
.end
> last_real_key_start
)
9866 keytran
.end
= keytran
.start
9867 = min (last_real_key_start
, keytran
.start
);
9868 keytran
.map
= keytran
.parent
;
9871 if (t
== last_real_key_start
)
9878 mock_input
= last_real_key_start
;
9879 goto replay_sequence
;
9884 = apply_modifiers (modifiers
, XCAR (breakdown
));
9886 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9888 /* Look for a binding for this new key. follow_key
9889 promises that it didn't munge submaps the
9890 last time we called it, since key was unbound. */
9892 = (follow_key (new_click
,
9893 nmaps
- local_first_binding
,
9894 submaps
+ local_first_binding
,
9895 defs
+ local_first_binding
,
9896 submaps
+ local_first_binding
)
9897 + local_first_binding
);
9899 /* If that click is bound, go for it. */
9900 if (first_binding
< nmaps
)
9905 /* Otherwise, we'll leave key set to the drag event. */
9912 /* Normally, last_nonmenu_event gets the previous key we read.
9913 But when a mouse popup menu is being used,
9914 we don't update last_nonmenu_event; it continues to hold the mouse
9915 event that preceded the first level of menu. */
9916 if (!used_mouse_menu
)
9917 last_nonmenu_event
= key
;
9919 /* Record what part of this_command_keys is the current key sequence. */
9920 this_single_command_key_start
= this_command_key_count
- t
;
9922 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9923 /* There is a binding and it's not a prefix.
9924 There is thus no function-key in this sequence.
9925 Moving fkey.start is important in this case to allow keytran.start
9926 to go over the sequence before we return (since we keep the
9927 invariant that keytran.end <= fkey.start). */
9930 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9933 /* If the sequence is unbound, see if we can hang a function key
9934 off the end of it. */
9935 /* Continue scan from fkey.end until we find a bound suffix. */
9936 while (fkey
.end
< t
)
9938 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9941 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9942 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9943 max (t
, mock_input
),
9944 /* If there's a binding (i.e.
9945 first_binding >= nmaps) we don't want
9946 to apply this function-key-mapping. */
9947 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9952 mock_input
= diff
+ max (t
, mock_input
);
9953 goto replay_sequence
;
9957 /* Look for this sequence in key-translation-map.
9958 Scan from keytran.end until we find a bound suffix. */
9959 while (keytran
.end
< fkey
.start
)
9961 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9964 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9965 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9970 mock_input
= diff
+ max (t
, mock_input
);
9971 /* Adjust the function-key-map counters. */
9975 goto replay_sequence
;
9979 /* If KEY is not defined in any of the keymaps,
9980 and cannot be part of a function key or translation,
9981 and is an upper case letter
9982 use the corresponding lower-case letter instead. */
9983 if (first_binding
>= nmaps
9984 && fkey
.start
>= t
&& keytran
.start
>= t
9986 && ((((XINT (key
) & 0x3ffff)
9987 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9988 && UPPERCASEP (XINT (key
) & 0x3ffff))
9989 || (XINT (key
) & shift_modifier
)))
9991 Lisp_Object new_key
;
9993 original_uppercase
= key
;
9994 original_uppercase_position
= t
- 1;
9996 if (XINT (key
) & shift_modifier
)
9997 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9999 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
10000 | (XINT (key
) & ~0x3ffff)));
10002 /* We have to do this unconditionally, regardless of whether
10003 the lower-case char is defined in the keymaps, because they
10004 might get translated through function-key-map. */
10005 keybuf
[t
- 1] = new_key
;
10006 mock_input
= max (t
, mock_input
);
10008 goto replay_sequence
;
10010 /* If KEY is not defined in any of the keymaps,
10011 and cannot be part of a function key or translation,
10012 and is a shifted function key,
10013 use the corresponding unshifted function key instead. */
10014 if (first_binding
>= nmaps
10015 && fkey
.start
>= t
&& keytran
.start
>= t
10018 Lisp_Object breakdown
;
10021 breakdown
= parse_modifiers (key
);
10022 modifiers
= XINT (XCAR (XCDR (breakdown
)));
10023 if (modifiers
& shift_modifier
)
10025 Lisp_Object new_key
;
10027 original_uppercase
= key
;
10028 original_uppercase_position
= t
- 1;
10030 modifiers
&= ~shift_modifier
;
10031 new_key
= apply_modifiers (modifiers
,
10034 keybuf
[t
- 1] = new_key
;
10035 mock_input
= max (t
, mock_input
);
10036 fkey
.start
= fkey
.end
= 0;
10037 keytran
.start
= keytran
.end
= 0;
10039 goto replay_sequence
;
10045 read_key_sequence_cmd
= (first_binding
< nmaps
10046 ? defs
[first_binding
]
10049 unread_switch_frame
= delayed_switch_frame
;
10050 unbind_to (count
, Qnil
);
10052 /* Don't downcase the last character if the caller says don't.
10053 Don't downcase it if the result is undefined, either. */
10054 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10056 && t
- 1 == original_uppercase_position
)
10057 keybuf
[t
- 1] = original_uppercase
;
10059 /* Occasionally we fabricate events, perhaps by expanding something
10060 according to function-key-map, or by adding a prefix symbol to a
10061 mouse click in the scroll bar or modeline. In this cases, return
10062 the entire generated key sequence, even if we hit an unbound
10063 prefix or a definition before the end. This means that you will
10064 be able to push back the event properly, and also means that
10065 read-key-sequence will always return a logical unit.
10068 for (; t
< mock_input
; t
++)
10070 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10071 && NILP (Fzerop (Vecho_keystrokes
)))
10072 echo_char (keybuf
[t
]);
10073 add_command_key (keybuf
[t
]);
10082 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10083 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10084 The sequence is sufficient to specify a non-prefix command in the
10085 current local and global maps.
10087 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10088 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10089 as a continuation of the previous key.
10091 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10092 convert the last event to lower case. (Normally any upper case event
10093 is converted to lower case if the original event is undefined and the lower
10094 case equivalent is defined.) A non-nil value is appropriate for reading
10095 a key sequence to be defined.
10097 A C-g typed while in this function is treated like any other character,
10098 and `quit-flag' is not set.
10100 If the key sequence starts with a mouse click, then the sequence is read
10101 using the keymaps of the buffer of the window clicked in, not the buffer
10102 of the selected window as normal.
10104 `read-key-sequence' drops unbound button-down events, since you normally
10105 only care about the click or drag events which follow them. If a drag
10106 or multi-click event is unbound, but the corresponding click event would
10107 be bound, `read-key-sequence' turns the event into a click event at the
10108 drag's starting position. This means that you don't have to distinguish
10109 between click and drag, double, or triple events unless you want to.
10111 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10112 lines separating windows, and scroll bars with imaginary keys
10113 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10115 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10116 function will process a switch-frame event if the user switches frames
10117 before typing anything. If the user switches frames in the middle of a
10118 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10119 is nil, then the event will be put off until after the current key sequence.
10121 `read-key-sequence' checks `function-key-map' for function key
10122 sequences, where they wouldn't conflict with ordinary bindings. See
10123 `function-key-map' for more details.
10125 The optional fifth argument COMMAND-LOOP, if non-nil, means
10126 that this key sequence is being read by something that will
10127 read commands one after another. It should be nil if the caller
10128 will read just one key sequence. */)
10129 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10131 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10132 Lisp_Object can_return_switch_frame
, command_loop
;
10134 Lisp_Object keybuf
[30];
10136 struct gcpro gcpro1
;
10137 int count
= SPECPDL_INDEX ();
10139 if (!NILP (prompt
))
10140 CHECK_STRING (prompt
);
10143 specbind (Qinput_method_exit_on_first_char
,
10144 (NILP (command_loop
) ? Qt
: Qnil
));
10145 specbind (Qinput_method_use_echo_area
,
10146 (NILP (command_loop
) ? Qt
: Qnil
));
10148 bzero (keybuf
, sizeof keybuf
);
10149 GCPRO1 (keybuf
[0]);
10150 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10152 if (NILP (continue_echo
))
10154 this_command_key_count
= 0;
10155 this_command_key_count_reset
= 0;
10156 this_single_command_key_start
= 0;
10159 #ifdef HAVE_X_WINDOWS
10160 if (display_hourglass_p
)
10161 cancel_hourglass ();
10164 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10165 prompt
, ! NILP (dont_downcase_last
),
10166 ! NILP (can_return_switch_frame
), 0);
10168 #if 0 /* The following is fine for code reading a key sequence and
10169 then proceeding with a lenghty computation, but it's not good
10170 for code reading keys in a loop, like an input method. */
10171 #ifdef HAVE_X_WINDOWS
10172 if (display_hourglass_p
)
10173 start_hourglass ();
10183 return unbind_to (count
, make_event_array (i
, keybuf
));
10186 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10187 Sread_key_sequence_vector
, 1, 5, 0,
10188 doc
: /* Like `read-key-sequence' but always return a vector. */)
10189 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10191 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10192 Lisp_Object can_return_switch_frame
, command_loop
;
10194 Lisp_Object keybuf
[30];
10196 struct gcpro gcpro1
;
10197 int count
= SPECPDL_INDEX ();
10199 if (!NILP (prompt
))
10200 CHECK_STRING (prompt
);
10203 specbind (Qinput_method_exit_on_first_char
,
10204 (NILP (command_loop
) ? Qt
: Qnil
));
10205 specbind (Qinput_method_use_echo_area
,
10206 (NILP (command_loop
) ? Qt
: Qnil
));
10208 bzero (keybuf
, sizeof keybuf
);
10209 GCPRO1 (keybuf
[0]);
10210 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10212 if (NILP (continue_echo
))
10214 this_command_key_count
= 0;
10215 this_command_key_count_reset
= 0;
10216 this_single_command_key_start
= 0;
10219 #ifdef HAVE_X_WINDOWS
10220 if (display_hourglass_p
)
10221 cancel_hourglass ();
10224 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10225 prompt
, ! NILP (dont_downcase_last
),
10226 ! NILP (can_return_switch_frame
), 0);
10228 #ifdef HAVE_X_WINDOWS
10229 if (display_hourglass_p
)
10230 start_hourglass ();
10239 return unbind_to (count
, Fvector (i
, keybuf
));
10242 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10243 doc
: /* Execute CMD as an editor command.
10244 CMD must be a symbol that satisfies the `commandp' predicate.
10245 Optional second arg RECORD-FLAG non-nil
10246 means unconditionally put this command in `command-history'.
10247 Otherwise, that is done only if an arg is read using the minibuffer.
10248 The argument KEYS specifies the value to use instead of (this-command-keys)
10249 when reading the arguments; if it is nil, (this-command-keys) is used.
10250 The argument SPECIAL, if non-nil, means that this command is executing
10251 a special event, so ignore the prefix argument and don't clear it. */)
10252 (cmd
, record_flag
, keys
, special
)
10253 Lisp_Object cmd
, record_flag
, keys
, special
;
10255 register Lisp_Object final
;
10256 register Lisp_Object tem
;
10257 Lisp_Object prefixarg
;
10258 struct backtrace backtrace
;
10259 extern int debug_on_next_call
;
10261 debug_on_next_call
= 0;
10263 if (NILP (special
))
10265 prefixarg
= current_kboard
->Vprefix_arg
;
10266 Vcurrent_prefix_arg
= prefixarg
;
10267 current_kboard
->Vprefix_arg
= Qnil
;
10274 tem
= Fget (cmd
, Qdisabled
);
10275 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10277 tem
= Fsymbol_value (Qdisabled_command_function
);
10279 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10285 final
= Findirect_function (cmd
, Qnil
);
10287 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10289 struct gcpro gcpro1
, gcpro2
;
10291 GCPRO2 (cmd
, prefixarg
);
10292 do_autoload (final
, cmd
);
10299 if (STRINGP (final
) || VECTORP (final
))
10301 /* If requested, place the macro in the command history. For
10302 other sorts of commands, call-interactively takes care of
10304 if (!NILP (record_flag
))
10307 = Fcons (Fcons (Qexecute_kbd_macro
,
10308 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10311 /* Don't keep command history around forever. */
10312 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10314 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10316 XSETCDR (tem
, Qnil
);
10320 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10323 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10325 backtrace
.next
= backtrace_list
;
10326 backtrace_list
= &backtrace
;
10327 backtrace
.function
= &Qcall_interactively
;
10328 backtrace
.args
= &cmd
;
10329 backtrace
.nargs
= 1;
10330 backtrace
.evalargs
= 0;
10331 backtrace
.debug_on_exit
= 0;
10333 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
10335 backtrace_list
= backtrace
.next
;
10343 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10345 doc
: /* Read function name, then read its arguments and call it.
10347 To pass a numeric argument to the command you are invoking with, specify
10348 the numeric argument to this command.
10350 Noninteractively, the argument PREFIXARG is the prefix argument to
10351 give to the command you invoke, if it asks for an argument. */)
10353 Lisp_Object prefixarg
;
10355 Lisp_Object function
;
10357 int saved_last_point_position
;
10358 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10359 Lisp_Object bindings
, value
;
10360 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10361 #ifdef HAVE_X_WINDOWS
10362 /* The call to Fcompleting_read wil start and cancel the hourglass,
10363 but if the hourglass was already scheduled, this means that no
10364 hourglass will be shown for the actual M-x command itself.
10365 So we restart it if it is already scheduled. Note that checking
10366 hourglass_shown_p is not enough, normally the hourglass is not shown,
10367 just scheduled to be shown. */
10368 int hstarted
= hourglass_started ();
10371 saved_keys
= Fvector (this_command_key_count
,
10372 XVECTOR (this_command_keys
)->contents
);
10373 saved_last_point_position_buffer
= last_point_position_buffer
;
10374 saved_last_point_position
= last_point_position
;
10376 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10378 if (EQ (prefixarg
, Qminus
))
10379 strcpy (buf
, "- ");
10380 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10381 strcpy (buf
, "C-u ");
10382 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10383 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10384 else if (INTEGERP (prefixarg
))
10385 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10387 /* This isn't strictly correct if execute-extended-command
10388 is bound to anything else. Perhaps it should use
10389 this_command_keys? */
10390 strcat (buf
, "M-x ");
10392 /* Prompt with buf, and then read a string, completing from and
10393 restricting to the set of all defined commands. Don't provide
10394 any initial input. Save the command read on the extended-command
10396 function
= Fcompleting_read (build_string (buf
),
10397 Vobarray
, Qcommandp
,
10398 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10401 #ifdef HAVE_X_WINDOWS
10402 if (hstarted
) start_hourglass ();
10405 if (STRINGP (function
) && SCHARS (function
) == 0)
10406 error ("No command name given");
10408 /* Set this_command_keys to the concatenation of saved_keys and
10409 function, followed by a RET. */
10414 this_command_key_count
= 0;
10415 this_command_key_count_reset
= 0;
10416 this_single_command_key_start
= 0;
10418 keys
= XVECTOR (saved_keys
)->contents
;
10419 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10420 add_command_key (keys
[i
]);
10422 for (i
= 0; i
< SCHARS (function
); i
++)
10423 add_command_key (Faref (function
, make_number (i
)));
10425 add_command_key (make_number ('\015'));
10428 last_point_position
= saved_last_point_position
;
10429 last_point_position_buffer
= saved_last_point_position_buffer
;
10433 function
= Fintern (function
, Qnil
);
10434 current_kboard
->Vprefix_arg
= prefixarg
;
10435 Vthis_command
= function
;
10436 real_this_command
= function
;
10438 /* If enabled, show which key runs this command. */
10439 if (!NILP (Vsuggest_key_bindings
)
10440 && NILP (Vexecuting_kbd_macro
)
10441 && SYMBOLP (function
))
10442 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10448 GCPRO2 (bindings
, value
);
10449 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10451 /* If the command has a key binding, print it now. */
10452 if (!NILP (bindings
)
10453 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10456 /* But first wait, and skip the message if there is input. */
10457 Lisp_Object waited
;
10459 /* If this command displayed something in the echo area;
10460 wait a few seconds, then display our suggestion message. */
10461 if (NILP (echo_area_buffer
[0]))
10462 waited
= sit_for (make_number (0), 0, 2);
10463 else if (NUMBERP (Vsuggest_key_bindings
))
10464 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10466 waited
= sit_for (make_number (2), 0, 2);
10468 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10470 Lisp_Object binding
;
10472 int message_p
= push_message ();
10473 int count
= SPECPDL_INDEX ();
10475 record_unwind_protect (pop_message_unwind
, Qnil
);
10476 binding
= Fkey_description (bindings
, Qnil
);
10479 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10482 sprintf (newmessage
, "You can run the command `%s' with %s",
10483 SDATA (SYMBOL_NAME (function
)),
10485 message2_nolog (newmessage
,
10486 strlen (newmessage
),
10487 STRING_MULTIBYTE (binding
));
10488 if (NUMBERP (Vsuggest_key_bindings
))
10489 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10491 waited
= sit_for (make_number (2), 0, 2);
10493 if (!NILP (waited
) && message_p
)
10494 restore_message ();
10496 unbind_to (count
, Qnil
);
10500 RETURN_UNGCPRO (value
);
10504 /* Return nonzero if input events are pending. */
10507 detect_input_pending ()
10509 if (!input_pending
)
10510 get_input_pending (&input_pending
, 0);
10512 return input_pending
;
10515 /* Return nonzero if input events other than mouse movements are
10519 detect_input_pending_ignore_squeezables ()
10521 if (!input_pending
)
10522 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10524 return input_pending
;
10527 /* Return nonzero if input events are pending, and run any pending timers. */
10530 detect_input_pending_run_timers (do_display
)
10533 int old_timers_run
= timers_run
;
10535 if (!input_pending
)
10536 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10538 if (old_timers_run
!= timers_run
&& do_display
)
10540 redisplay_preserve_echo_area (8);
10541 /* The following fixes a bug when using lazy-lock with
10542 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10543 from an idle timer function. The symptom of the bug is that
10544 the cursor sometimes doesn't become visible until the next X
10545 event is processed. --gerd. */
10547 Lisp_Object tail
, frame
;
10548 FOR_EACH_FRAME (tail
, frame
)
10549 if (FRAME_RIF (XFRAME (frame
)))
10550 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10554 return input_pending
;
10557 /* This is called in some cases before a possible quit.
10558 It cases the next call to detect_input_pending to recompute input_pending.
10559 So calling this function unnecessarily can't do any harm. */
10562 clear_input_pending ()
10567 /* Return nonzero if there are pending requeued events.
10568 This isn't used yet. The hope is to make wait_reading_process_output
10569 call it, and return if it runs Lisp code that unreads something.
10570 The problem is, kbd_buffer_get_event needs to be fixed to know what
10571 to do in that case. It isn't trivial. */
10574 requeued_events_pending_p ()
10576 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10580 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10581 doc
: /* Return t if command input is currently available with no wait.
10582 Actually, the value is nil only if we can be sure that no input is available;
10583 if there is a doubt, the value is t. */)
10586 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10587 || !NILP (Vunread_post_input_method_events
)
10588 || !NILP (Vunread_input_method_events
))
10591 get_input_pending (&input_pending
,
10592 READABLE_EVENTS_DO_TIMERS_NOW
10593 | READABLE_EVENTS_FILTER_EVENTS
);
10594 return input_pending
> 0 ? Qt
: Qnil
;
10597 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10598 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10601 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10604 if (total_keys
< NUM_RECENT_KEYS
)
10605 return Fvector (total_keys
, keys
);
10608 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10609 bcopy (keys
+ recent_keys_index
,
10610 XVECTOR (val
)->contents
,
10611 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10613 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10614 recent_keys_index
* sizeof (Lisp_Object
));
10619 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10620 doc
: /* Return the key sequence that invoked this command.
10621 However, if the command has called `read-key-sequence', it returns
10622 the last key sequence that has been read.
10623 The value is a string or a vector.
10625 See also `this-command-keys-vector'. */)
10628 return make_event_array (this_command_key_count
,
10629 XVECTOR (this_command_keys
)->contents
);
10632 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10633 doc
: /* Return the key sequence that invoked this command, as a vector.
10634 However, if the command has called `read-key-sequence', it returns
10635 the last key sequence that has been read.
10637 See also `this-command-keys'. */)
10640 return Fvector (this_command_key_count
,
10641 XVECTOR (this_command_keys
)->contents
);
10644 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10645 Sthis_single_command_keys
, 0, 0, 0,
10646 doc
: /* Return the key sequence that invoked this command.
10647 More generally, it returns the last key sequence read, either by
10648 the command loop or by `read-key-sequence'.
10649 Unlike `this-command-keys', this function's value
10650 does not include prefix arguments.
10651 The value is always a vector. */)
10654 return Fvector (this_command_key_count
10655 - this_single_command_key_start
,
10656 (XVECTOR (this_command_keys
)->contents
10657 + this_single_command_key_start
));
10660 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10661 Sthis_single_command_raw_keys
, 0, 0, 0,
10662 doc
: /* Return the raw events that were read for this command.
10663 More generally, it returns the last key sequence read, either by
10664 the command loop or by `read-key-sequence'.
10665 Unlike `this-single-command-keys', this function's value
10666 shows the events before all translations (except for input methods).
10667 The value is always a vector. */)
10670 return Fvector (raw_keybuf_count
,
10671 (XVECTOR (raw_keybuf
)->contents
));
10674 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10675 Sreset_this_command_lengths
, 0, 0, 0,
10676 doc
: /* Make the unread events replace the last command and echo.
10677 Used in `universal-argument-other-key'.
10679 `universal-argument-other-key' rereads the event just typed.
10680 It then gets translated through `function-key-map'.
10681 The translated event has to replace the real events,
10682 both in the value of (this-command-keys) and in echoing.
10683 To achieve this, `universal-argument-other-key' calls
10684 `reset-this-command-lengths', which discards the record of reading
10685 these events the first time. */)
10688 this_command_key_count
= before_command_key_count
;
10689 if (this_command_key_count
< this_single_command_key_start
)
10690 this_single_command_key_start
= this_command_key_count
;
10692 echo_truncate (before_command_echo_length
);
10694 /* Cause whatever we put into unread-command-events
10695 to echo as if it were being freshly read from the keyboard. */
10696 this_command_key_count_reset
= 1;
10701 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10702 Sclear_this_command_keys
, 0, 1, 0,
10703 doc
: /* Clear out the vector that `this-command-keys' returns.
10704 Also clear the record of the last 100 events, unless optional arg
10705 KEEP-RECORD is non-nil. */)
10707 Lisp_Object keep_record
;
10711 this_command_key_count
= 0;
10712 this_command_key_count_reset
= 0;
10714 if (NILP (keep_record
))
10716 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10717 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10719 recent_keys_index
= 0;
10724 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10725 doc
: /* Return the current depth in recursive edits. */)
10729 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10733 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10734 "FOpen dribble file: ",
10735 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10736 If FILE is nil, close any open dribble file. */)
10749 file
= Fexpand_file_name (file
, Qnil
);
10750 dribble
= fopen (SDATA (file
), "w");
10752 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10757 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10758 doc
: /* Discard the contents of the terminal input buffer.
10759 Also end any kbd macro being defined. */)
10762 if (!NILP (current_kboard
->defining_kbd_macro
))
10764 /* Discard the last command from the macro. */
10765 Fcancel_kbd_macro_events ();
10769 update_mode_lines
++;
10771 Vunread_command_events
= Qnil
;
10772 unread_command_char
= -1;
10774 discard_tty_input ();
10776 kbd_fetch_ptr
= kbd_store_ptr
;
10782 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10783 doc
: /* Stop Emacs and return to superior process. You can resume later.
10784 If `cannot-suspend' is non-nil, or if the system doesn't support job
10785 control, run a subshell instead.
10787 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10788 to be read as terminal input by Emacs's parent, after suspension.
10790 Before suspending, run the normal hook `suspend-hook'.
10791 After resumption run the normal hook `suspend-resume-hook'.
10793 Some operating systems cannot stop the Emacs process and resume it later.
10794 On such systems, Emacs starts a subshell instead of suspending. */)
10796 Lisp_Object stuffstring
;
10798 int count
= SPECPDL_INDEX ();
10799 int old_height
, old_width
;
10801 struct gcpro gcpro1
;
10803 if (tty_list
&& tty_list
->next
)
10804 error ("There are other tty frames open; close them before suspending Emacs");
10806 if (!NILP (stuffstring
))
10807 CHECK_STRING (stuffstring
);
10809 /* Run the functions in suspend-hook. */
10810 if (!NILP (Vrun_hooks
))
10811 call1 (Vrun_hooks
, intern ("suspend-hook"));
10813 GCPRO1 (stuffstring
);
10814 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10815 reset_all_sys_modes ();
10816 /* sys_suspend can get an error if it tries to fork a subshell
10817 and the system resources aren't available for that. */
10818 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10820 stuff_buffered_input (stuffstring
);
10821 if (cannot_suspend
)
10825 unbind_to (count
, Qnil
);
10827 /* Check if terminal/window size has changed.
10828 Note that this is not useful when we are running directly
10829 with a window system; but suspend should be disabled in that case. */
10830 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10831 if (width
!= old_width
|| height
!= old_height
)
10832 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10834 /* Run suspend-resume-hook. */
10835 if (!NILP (Vrun_hooks
))
10836 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10842 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10843 Then in any case stuff anything Emacs has read ahead and not used. */
10846 stuff_buffered_input (stuffstring
)
10847 Lisp_Object stuffstring
;
10849 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10850 register unsigned char *p
;
10852 if (STRINGP (stuffstring
))
10854 register int count
;
10856 p
= SDATA (stuffstring
);
10857 count
= SBYTES (stuffstring
);
10858 while (count
-- > 0)
10863 /* Anything we have read ahead, put back for the shell to read. */
10864 /* ?? What should this do when we have multiple keyboards??
10865 Should we ignore anything that was typed in at the "wrong" kboard?
10867 rms: we should stuff everything back into the kboard
10869 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10872 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10873 kbd_fetch_ptr
= kbd_buffer
;
10874 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10875 stuff_char (kbd_fetch_ptr
->code
);
10877 clear_event (kbd_fetch_ptr
);
10881 #endif /* SIGTSTP */
10885 set_waiting_for_input (time_to_clear
)
10886 EMACS_TIME
*time_to_clear
;
10888 input_available_clear_time
= time_to_clear
;
10890 /* Tell handle_interrupt to throw back to read_char, */
10891 waiting_for_input
= 1;
10893 /* If handle_interrupt was called before and buffered a C-g,
10894 make it run again now, to avoid timing error. */
10895 if (!NILP (Vquit_flag
))
10896 quit_throw_to_read_char ();
10900 clear_waiting_for_input ()
10902 /* Tell handle_interrupt not to throw back to read_char, */
10903 waiting_for_input
= 0;
10904 input_available_clear_time
= 0;
10907 /* The SIGINT handler.
10909 If we have a frame on the controlling tty, we assume that the
10910 SIGINT was generated by C-g, so we call handle_interrupt.
10911 Otherwise, the handler kills Emacs. */
10914 interrupt_signal (signalnum
) /* If we don't have an argument, */
10915 int signalnum
; /* some compilers complain in signal calls. */
10917 /* Must preserve main program's value of errno. */
10918 int old_errno
= errno
;
10919 struct terminal
*terminal
;
10921 #if defined (USG) && !defined (POSIX_SIGNALS)
10922 /* USG systems forget handlers when they are used;
10923 must reestablish each time */
10924 signal (SIGINT
, interrupt_signal
);
10925 signal (SIGQUIT
, interrupt_signal
);
10928 SIGNAL_THREAD_CHECK (signalnum
);
10930 /* See if we have an active terminal on our controlling tty. */
10931 terminal
= get_named_tty ("/dev/tty");
10934 /* If there are no frames there, let's pretend that we are a
10935 well-behaving UN*X program and quit. */
10936 Fkill_emacs (Qnil
);
10940 /* Otherwise, the SIGINT was probably generated by C-g. */
10942 /* Set internal_last_event_frame to the top frame of the
10943 controlling tty, if we have a frame there. We disable the
10944 interrupt key on secondary ttys, so the SIGINT must have come
10945 from the controlling tty. */
10946 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10948 handle_interrupt ();
10954 /* This routine is called at interrupt level in response to C-g.
10956 It is called from the SIGINT handler or kbd_buffer_store_event.
10958 If `waiting_for_input' is non zero, then unless `echoing' is
10959 nonzero, immediately throw back to read_char.
10961 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10962 eval to throw, when it gets a chance. If quit-flag is already
10963 non-nil, it stops the job right away. */
10966 handle_interrupt ()
10972 /* XXX This code needs to be revised for multi-tty support. */
10973 if (!NILP (Vquit_flag
)
10975 && get_named_tty ("/dev/tty")
10979 /* If SIGINT isn't blocked, don't let us be interrupted by
10980 another SIGINT, it might be harmful due to non-reentrancy
10981 in I/O functions. */
10982 sigblock (sigmask (SIGINT
));
10985 reset_all_sys_modes ();
10987 #ifdef SIGTSTP /* Support possible in later USG versions */
10989 * On systems which can suspend the current process and return to the original
10990 * shell, this command causes the user to end up back at the shell.
10991 * The "Auto-save" and "Abort" questions are not asked until
10992 * the user elects to return to emacs, at which point he can save the current
10993 * job and either dump core or continue.
10998 if (sys_suspend () == -1)
11000 printf ("Not running as a subprocess;\n");
11001 printf ("you can continue or abort.\n");
11003 #else /* not VMS */
11004 /* Perhaps should really fork an inferior shell?
11005 But that would not provide any way to get back
11006 to the original shell, ever. */
11007 printf ("No support for stopping a process on this operating system;\n");
11008 printf ("you can continue or abort.\n");
11009 #endif /* not VMS */
11010 #endif /* not SIGTSTP */
11012 /* We must remain inside the screen area when the internal terminal
11013 is used. Note that [Enter] is not echoed by dos. */
11016 /* It doesn't work to autosave while GC is in progress;
11017 the code used for auto-saving doesn't cope with the mark bit. */
11018 if (!gc_in_progress
)
11020 printf ("Auto-save? (y or n) ");
11022 if (((c
= getchar ()) & ~040) == 'Y')
11024 Fdo_auto_save (Qt
, Qnil
);
11026 printf ("\r\nAuto-save done");
11027 #else /* not MSDOS */
11028 printf ("Auto-save done\n");
11029 #endif /* not MSDOS */
11031 while (c
!= '\n') c
= getchar ();
11035 /* During GC, it must be safe to reenable quitting again. */
11036 Vinhibit_quit
= Qnil
;
11039 #endif /* not MSDOS */
11040 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11041 printf ("but will instead do a real quit after garbage collection ends\r\n");
11046 printf ("\r\nAbort? (y or n) ");
11047 #else /* not MSDOS */
11049 printf ("Abort (and enter debugger)? (y or n) ");
11050 #else /* not VMS */
11051 printf ("Abort (and dump core)? (y or n) ");
11052 #endif /* not VMS */
11053 #endif /* not MSDOS */
11055 if (((c
= getchar ()) & ~040) == 'Y')
11057 while (c
!= '\n') c
= getchar ();
11059 printf ("\r\nContinuing...\r\n");
11060 #else /* not MSDOS */
11061 printf ("Continuing...\n");
11062 #endif /* not MSDOS */
11064 init_all_sys_modes ();
11069 /* If executing a function that wants to be interrupted out of
11070 and the user has not deferred quitting by binding `inhibit-quit'
11071 then quit right away. */
11072 if (immediate_quit
&& NILP (Vinhibit_quit
))
11074 struct gl_state_s saved
;
11075 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11077 immediate_quit
= 0;
11080 GCPRO4 (saved
.object
, saved
.global_code
,
11081 saved
.current_syntax_table
, saved
.old_prop
);
11082 Fsignal (Qquit
, Qnil
);
11087 /* Else request quit when it's safe */
11091 if (waiting_for_input
&& !echoing
)
11092 quit_throw_to_read_char ();
11095 /* Handle a C-g by making read_char return C-g. */
11098 quit_throw_to_read_char ()
11101 /* Prevent another signal from doing this before we finish. */
11102 clear_waiting_for_input ();
11105 Vunread_command_events
= Qnil
;
11106 unread_command_char
= -1;
11108 #if 0 /* Currently, sit_for is called from read_char without turning
11109 off polling. And that can call set_waiting_for_input.
11110 It seems to be harmless. */
11111 #ifdef POLL_FOR_INPUT
11112 /* May be > 1 if in recursive minibuffer. */
11113 if (poll_suppress_count
== 0)
11117 if (FRAMEP (internal_last_event_frame
)
11118 && !EQ (internal_last_event_frame
, selected_frame
))
11119 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11122 _longjmp (getcjmp
, 1);
11125 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11126 doc
: /* Set interrupt mode of reading keyboard input.
11127 If INTERRUPT is non-nil, Emacs will use input interrupts;
11128 otherwise Emacs uses CBREAK mode.
11130 See also `current-input-mode'. */)
11132 Lisp_Object interrupt
;
11134 int new_interrupt_input
;
11136 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11137 #ifdef HAVE_X_WINDOWS
11138 if (x_display_list
!= NULL
)
11140 /* When using X, don't give the user a real choice,
11141 because we haven't implemented the mechanisms to support it. */
11142 #ifdef NO_SOCK_SIGIO
11143 new_interrupt_input
= 0;
11144 #else /* not NO_SOCK_SIGIO */
11145 new_interrupt_input
= 1;
11146 #endif /* NO_SOCK_SIGIO */
11150 new_interrupt_input
= !NILP (interrupt
);
11151 #else /* not SIGIO */
11152 new_interrupt_input
= 0;
11153 #endif /* not SIGIO */
11155 /* Our VMS input only works by interrupts, as of now. */
11157 new_interrupt_input
= 1;
11160 if (new_interrupt_input
!= interrupt_input
)
11162 #ifdef POLL_FOR_INPUT
11166 /* this causes startup screen to be restored and messes with the mouse */
11167 reset_all_sys_modes ();
11169 interrupt_input
= new_interrupt_input
;
11171 init_all_sys_modes ();
11174 #ifdef POLL_FOR_INPUT
11175 poll_suppress_count
= 1;
11182 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11183 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11184 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11185 C-q in key sequences.
11187 This setting only has an effect on tty terminals and only when
11188 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11190 See also `current-input-mode'. */)
11192 Lisp_Object flow
, terminal
;
11194 struct terminal
*t
= get_terminal (terminal
, 1);
11195 struct tty_display_info
*tty
;
11196 if (t
== NULL
|| t
->type
!= output_termcap
)
11198 tty
= t
->display_info
.tty
;
11200 if (tty
->flow_control
!= !NILP (flow
))
11203 /* this causes startup screen to be restored and messes with the mouse */
11204 reset_sys_modes (tty
);
11207 tty
->flow_control
= !NILP (flow
);
11210 init_sys_modes (tty
);
11216 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11217 doc
: /* Enable or disable 8-bit input on TERMINAL.
11218 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11219 bit as the Meta modifier.
11221 If META is nil, Emacs will ignore the top bit, on the assumption it is
11224 Otherwise, Emacs will accept and pass through 8-bit input without
11225 specially interpreting the top bit.
11227 This setting only has an effect on tty terminal devices.
11229 Optional parameter TERMINAL specifies the tty terminal device to use.
11230 It may be a terminal id, a frame, or nil for the terminal used by the
11231 currently selected frame.
11233 See also `current-input-mode'. */)
11235 Lisp_Object meta
, terminal
;
11237 struct terminal
*t
= get_terminal (terminal
, 1);
11238 struct tty_display_info
*tty
;
11241 if (t
== NULL
|| t
->type
!= output_termcap
)
11243 tty
= t
->display_info
.tty
;
11247 else if (EQ (meta
, Qt
))
11252 if (tty
->meta_key
!= new_meta
)
11255 /* this causes startup screen to be restored and messes with the mouse */
11256 reset_sys_modes (tty
);
11259 tty
->meta_key
= new_meta
;
11262 init_sys_modes (tty
);
11268 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11269 doc
: /* Specify character used for quitting.
11270 QUIT must be an ASCII character.
11272 This function only has an effect on the controlling tty of the Emacs
11275 See also `current-input-mode'. */)
11279 struct terminal
*t
= get_named_tty ("/dev/tty");
11280 struct tty_display_info
*tty
;
11281 if (t
== NULL
|| t
->type
!= output_termcap
)
11283 tty
= t
->display_info
.tty
;
11285 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11286 error ("QUIT must be an ASCII character");
11289 /* this causes startup screen to be restored and messes with the mouse */
11290 reset_sys_modes (tty
);
11293 /* Don't let this value be out of range. */
11294 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11297 init_sys_modes (tty
);
11303 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11304 doc
: /* Set mode of reading keyboard input.
11305 First arg INTERRUPT non-nil means use input interrupts;
11306 nil means use CBREAK mode.
11307 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11308 (no effect except in CBREAK mode).
11309 Third arg META t means accept 8-bit input (for a Meta key).
11310 META nil means ignore the top bit, on the assumption it is parity.
11311 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11312 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11313 See also `current-input-mode'. */)
11314 (interrupt
, flow
, meta
, quit
)
11315 Lisp_Object interrupt
, flow
, meta
, quit
;
11317 Fset_input_interrupt_mode (interrupt
);
11318 Fset_output_flow_control (flow
, Qnil
);
11319 Fset_input_meta_mode (meta
, Qnil
);
11321 Fset_quit_char (quit
);
11325 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11326 doc
: /* Return information about the way Emacs currently reads keyboard input.
11327 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11328 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11329 nil, Emacs is using CBREAK mode.
11330 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11331 terminal; this does not apply if Emacs uses interrupt-driven input.
11332 META is t if accepting 8-bit input with 8th bit as Meta flag.
11333 META nil means ignoring the top bit, on the assumption it is parity.
11334 META is neither t nor nil if accepting 8-bit input and using
11335 all 8 bits as the character code.
11336 QUIT is the character Emacs currently uses to quit.
11337 The elements of this list correspond to the arguments of
11338 `set-input-mode'. */)
11341 Lisp_Object val
[4];
11342 struct frame
*sf
= XFRAME (selected_frame
);
11344 val
[0] = interrupt_input
? Qt
: Qnil
;
11345 if (FRAME_TERMCAP_P (sf
))
11347 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11348 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11350 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11357 XSETFASTINT (val
[3], quit_char
);
11359 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11362 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11363 doc
: /* Return position information for pixel coordinates X and Y.
11364 By default, X and Y are relative to text area of the selected window.
11365 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11366 If optional fourth arg WHOLE is non-nil, X is relative to the left
11367 edge of the window.
11369 The return value is similar to a mouse click position:
11370 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11371 IMAGE (DX . DY) (WIDTH . HEIGHT))
11372 The `posn-' functions access elements of such lists. */)
11373 (x
, y
, frame_or_window
, whole
)
11374 Lisp_Object x
, y
, frame_or_window
, whole
;
11379 if (NILP (frame_or_window
))
11380 frame_or_window
= selected_window
;
11382 if (WINDOWP (frame_or_window
))
11386 CHECK_LIVE_WINDOW (frame_or_window
);
11388 w
= XWINDOW (frame_or_window
);
11389 XSETINT (x
, (XINT (x
)
11390 + WINDOW_LEFT_EDGE_X (w
)
11392 ? window_box_left_offset (w
, TEXT_AREA
)
11394 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11395 frame_or_window
= w
->frame
;
11398 CHECK_LIVE_FRAME (frame_or_window
);
11400 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11403 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11404 doc
: /* Return position information for buffer POS in WINDOW.
11405 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11407 Return nil if position is not visible in window. Otherwise,
11408 the return value is similar to that returned by `event-start' for
11409 a mouse click at the upper left corner of the glyph corresponding
11410 to the given buffer position:
11411 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11412 IMAGE (DX . DY) (WIDTH . HEIGHT))
11413 The `posn-' functions access elements of such lists. */)
11415 Lisp_Object pos
, window
;
11420 window
= selected_window
;
11422 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11425 Lisp_Object x
= XCAR (tem
);
11426 Lisp_Object y
= XCAR (XCDR (tem
));
11428 /* Point invisible due to hscrolling? */
11431 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11439 * Set up a new kboard object with reasonable initial values.
11445 kb
->Voverriding_terminal_local_map
= Qnil
;
11446 kb
->Vlast_command
= Qnil
;
11447 kb
->Vreal_last_command
= Qnil
;
11448 kb
->Vkeyboard_translate_table
= Qnil
;
11449 kb
->Vprefix_arg
= Qnil
;
11450 kb
->Vlast_prefix_arg
= Qnil
;
11451 kb
->kbd_queue
= Qnil
;
11452 kb
->kbd_queue_has_data
= 0;
11453 kb
->immediate_echo
= 0;
11454 kb
->echo_string
= Qnil
;
11455 kb
->echo_after_prompt
= -1;
11456 kb
->kbd_macro_buffer
= 0;
11457 kb
->kbd_macro_bufsize
= 0;
11458 kb
->defining_kbd_macro
= Qnil
;
11459 kb
->Vlast_kbd_macro
= Qnil
;
11460 kb
->reference_count
= 0;
11461 kb
->Vsystem_key_alist
= Qnil
;
11462 kb
->system_key_syms
= Qnil
;
11463 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11464 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11465 kb
->Vlocal_key_translation_map
= Fmake_sparse_keymap (Qnil
);
11466 Fset_keymap_parent (kb
->Vlocal_key_translation_map
, Vkey_translation_map
);
11467 kb
->Vdefault_minibuffer_frame
= Qnil
;
11471 * Destroy the contents of a kboard object, but not the object itself.
11472 * We use this just before deleting it, or if we're going to initialize
11473 * it a second time.
11479 if (kb
->kbd_macro_buffer
)
11480 xfree (kb
->kbd_macro_buffer
);
11483 #ifdef MULTI_KBOARD
11485 /* Free KB and memory referenced from it. */
11493 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11496 *kbp
= kb
->next_kboard
;
11498 /* Prevent a dangling reference to KB. */
11499 if (kb
== current_kboard
11500 && FRAMEP (selected_frame
)
11501 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11503 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11505 if (current_kboard
== kb
)
11513 #endif /* MULTI_KBOARD */
11518 /* This is correct before outermost invocation of the editor loop */
11519 command_loop_level
= -1;
11520 immediate_quit
= 0;
11521 quit_char
= Ctl ('g');
11522 Vunread_command_events
= Qnil
;
11523 unread_command_char
= -1;
11524 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11526 recent_keys_index
= 0;
11527 kbd_fetch_ptr
= kbd_buffer
;
11528 kbd_store_ptr
= kbd_buffer
;
11529 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11530 do_mouse_tracking
= Qnil
;
11533 interrupt_input_blocked
= 0;
11534 interrupt_input_pending
= 0;
11536 /* This means that command_loop_1 won't try to select anything the first
11538 internal_last_event_frame
= Qnil
;
11539 Vlast_event_frame
= internal_last_event_frame
;
11541 #ifdef MULTI_KBOARD
11542 current_kboard
= initial_kboard
;
11544 wipe_kboard (current_kboard
);
11545 init_kboard (current_kboard
);
11547 if (!noninteractive
)
11549 /* Before multi-tty support, these handlers used to be installed
11550 only if the current session was a tty session. Now an Emacs
11551 session may have multiple display types, so we always handle
11552 SIGINT. There is special code in interrupt_signal to exit
11553 Emacs on SIGINT when there are no termcap frames on the
11554 controlling terminal. */
11555 signal (SIGINT
, interrupt_signal
);
11556 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11557 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11558 SIGQUIT and we can't tell which one it will give us. */
11559 signal (SIGQUIT
, interrupt_signal
);
11560 #endif /* HAVE_TERMIO */
11562 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11564 if (!noninteractive
)
11565 signal (SIGIO
, input_available_signal
);
11568 /* Use interrupt input by default, if it works and noninterrupt input
11569 has deficiencies. */
11571 #ifdef INTERRUPT_INPUT
11572 interrupt_input
= 1;
11574 interrupt_input
= 0;
11577 /* Our VMS input only works by interrupts, as of now. */
11579 interrupt_input
= 1;
11585 if (keyboard_init_hook
)
11586 (*keyboard_init_hook
) ();
11588 #ifdef POLL_FOR_INPUT
11589 poll_suppress_count
= 1;
11594 /* This type's only use is in syms_of_keyboard, to initialize the
11595 event header symbols and put properties on them. */
11596 struct event_head
{
11602 struct event_head head_table
[] = {
11603 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11604 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11605 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11606 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11607 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11608 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11609 /* `select-window' should be handled just like `switch-frame'
11610 in read_key_sequence. */
11611 {&Qselect_window
, "select-window", &Qswitch_frame
}
11615 syms_of_keyboard ()
11617 Vpre_help_message
= Qnil
;
11618 staticpro (&Vpre_help_message
);
11620 Vlispy_mouse_stem
= build_string ("mouse");
11621 staticpro (&Vlispy_mouse_stem
);
11624 QCimage
= intern (":image");
11625 staticpro (&QCimage
);
11627 staticpro (&Qhelp_echo
);
11628 Qhelp_echo
= intern ("help-echo");
11631 Qrtl
= intern (":rtl");
11633 staticpro (&item_properties
);
11634 item_properties
= Qnil
;
11636 staticpro (&tool_bar_item_properties
);
11637 tool_bar_item_properties
= Qnil
;
11638 staticpro (&tool_bar_items_vector
);
11639 tool_bar_items_vector
= Qnil
;
11641 staticpro (&real_this_command
);
11642 real_this_command
= Qnil
;
11644 Qtimer_event_handler
= intern ("timer-event-handler");
11645 staticpro (&Qtimer_event_handler
);
11647 Qdisabled_command_function
= intern ("disabled-command-function");
11648 staticpro (&Qdisabled_command_function
);
11650 Qself_insert_command
= intern ("self-insert-command");
11651 staticpro (&Qself_insert_command
);
11653 Qforward_char
= intern ("forward-char");
11654 staticpro (&Qforward_char
);
11656 Qbackward_char
= intern ("backward-char");
11657 staticpro (&Qbackward_char
);
11659 Qdisabled
= intern ("disabled");
11660 staticpro (&Qdisabled
);
11662 Qundefined
= intern ("undefined");
11663 staticpro (&Qundefined
);
11665 Qpre_command_hook
= intern ("pre-command-hook");
11666 staticpro (&Qpre_command_hook
);
11668 Qpost_command_hook
= intern ("post-command-hook");
11669 staticpro (&Qpost_command_hook
);
11671 Qdeferred_action_function
= intern ("deferred-action-function");
11672 staticpro (&Qdeferred_action_function
);
11674 Qcommand_hook_internal
= intern ("command-hook-internal");
11675 staticpro (&Qcommand_hook_internal
);
11677 Qfunction_key
= intern ("function-key");
11678 staticpro (&Qfunction_key
);
11679 Qmouse_click
= intern ("mouse-click");
11680 staticpro (&Qmouse_click
);
11681 #if defined (WINDOWSNT) || defined (MAC_OS)
11682 Qlanguage_change
= intern ("language-change");
11683 staticpro (&Qlanguage_change
);
11685 Qdrag_n_drop
= intern ("drag-n-drop");
11686 staticpro (&Qdrag_n_drop
);
11688 Qsave_session
= intern ("save-session");
11689 staticpro (&Qsave_session
);
11692 Qmac_apple_event
= intern ("mac-apple-event");
11693 staticpro (&Qmac_apple_event
);
11696 Qmenu_enable
= intern ("menu-enable");
11697 staticpro (&Qmenu_enable
);
11698 Qmenu_alias
= intern ("menu-alias");
11699 staticpro (&Qmenu_alias
);
11700 QCenable
= intern (":enable");
11701 staticpro (&QCenable
);
11702 QCvisible
= intern (":visible");
11703 staticpro (&QCvisible
);
11704 QChelp
= intern (":help");
11705 staticpro (&QChelp
);
11706 QCfilter
= intern (":filter");
11707 staticpro (&QCfilter
);
11708 QCbutton
= intern (":button");
11709 staticpro (&QCbutton
);
11710 QCkeys
= intern (":keys");
11711 staticpro (&QCkeys
);
11712 QCkey_sequence
= intern (":key-sequence");
11713 staticpro (&QCkey_sequence
);
11714 QCtoggle
= intern (":toggle");
11715 staticpro (&QCtoggle
);
11716 QCradio
= intern (":radio");
11717 staticpro (&QCradio
);
11719 Qmode_line
= intern ("mode-line");
11720 staticpro (&Qmode_line
);
11721 Qvertical_line
= intern ("vertical-line");
11722 staticpro (&Qvertical_line
);
11723 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11724 staticpro (&Qvertical_scroll_bar
);
11725 Qmenu_bar
= intern ("menu-bar");
11726 staticpro (&Qmenu_bar
);
11728 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11729 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11730 staticpro (&Qmouse_fixup_help_message
);
11733 Qabove_handle
= intern ("above-handle");
11734 staticpro (&Qabove_handle
);
11735 Qhandle
= intern ("handle");
11736 staticpro (&Qhandle
);
11737 Qbelow_handle
= intern ("below-handle");
11738 staticpro (&Qbelow_handle
);
11739 Qup
= intern ("up");
11741 Qdown
= intern ("down");
11742 staticpro (&Qdown
);
11743 Qtop
= intern ("top");
11745 Qbottom
= intern ("bottom");
11746 staticpro (&Qbottom
);
11747 Qend_scroll
= intern ("end-scroll");
11748 staticpro (&Qend_scroll
);
11749 Qratio
= intern ("ratio");
11750 staticpro (&Qratio
);
11752 Qevent_kind
= intern ("event-kind");
11753 staticpro (&Qevent_kind
);
11754 Qevent_symbol_elements
= intern ("event-symbol-elements");
11755 staticpro (&Qevent_symbol_elements
);
11756 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11757 staticpro (&Qevent_symbol_element_mask
);
11758 Qmodifier_cache
= intern ("modifier-cache");
11759 staticpro (&Qmodifier_cache
);
11761 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11762 staticpro (&Qrecompute_lucid_menubar
);
11763 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11764 staticpro (&Qactivate_menubar_hook
);
11766 Qpolling_period
= intern ("polling-period");
11767 staticpro (&Qpolling_period
);
11769 Qinput_method_function
= intern ("input-method-function");
11770 staticpro (&Qinput_method_function
);
11772 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11773 staticpro (&Qinput_method_exit_on_first_char
);
11774 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11775 staticpro (&Qinput_method_use_echo_area
);
11777 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11778 Fset (Qinput_method_use_echo_area
, Qnil
);
11780 last_point_position_buffer
= Qnil
;
11781 last_point_position_window
= Qnil
;
11784 struct event_head
*p
;
11786 for (p
= head_table
;
11787 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11790 *p
->var
= intern (p
->name
);
11791 staticpro (p
->var
);
11792 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11793 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11797 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11798 staticpro (&button_down_location
);
11799 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11800 staticpro (&mouse_syms
);
11801 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11802 staticpro (&wheel_syms
);
11806 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11808 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11809 for (i
= 0; i
< len
; i
++)
11810 if (modifier_names
[i
])
11811 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11812 staticpro (&modifier_symbols
);
11815 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11816 staticpro (&recent_keys
);
11818 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11819 staticpro (&this_command_keys
);
11821 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11822 staticpro (&raw_keybuf
);
11824 Qextended_command_history
= intern ("extended-command-history");
11825 Fset (Qextended_command_history
, Qnil
);
11826 staticpro (&Qextended_command_history
);
11828 accent_key_syms
= Qnil
;
11829 staticpro (&accent_key_syms
);
11831 func_key_syms
= Qnil
;
11832 staticpro (&func_key_syms
);
11834 drag_n_drop_syms
= Qnil
;
11835 staticpro (&drag_n_drop_syms
);
11837 unread_switch_frame
= Qnil
;
11838 staticpro (&unread_switch_frame
);
11840 internal_last_event_frame
= Qnil
;
11841 staticpro (&internal_last_event_frame
);
11843 read_key_sequence_cmd
= Qnil
;
11844 staticpro (&read_key_sequence_cmd
);
11846 menu_bar_one_keymap_changed_items
= Qnil
;
11847 staticpro (&menu_bar_one_keymap_changed_items
);
11849 menu_bar_items_vector
= Qnil
;
11850 staticpro (&menu_bar_items_vector
);
11852 help_form_saved_window_configs
= Qnil
;
11853 staticpro (&help_form_saved_window_configs
);
11855 defsubr (&Scurrent_idle_time
);
11856 defsubr (&Sevent_convert_list
);
11857 defsubr (&Sread_key_sequence
);
11858 defsubr (&Sread_key_sequence_vector
);
11859 defsubr (&Srecursive_edit
);
11860 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11861 defsubr (&Strack_mouse
);
11863 defsubr (&Sinput_pending_p
);
11864 defsubr (&Scommand_execute
);
11865 defsubr (&Srecent_keys
);
11866 defsubr (&Sthis_command_keys
);
11867 defsubr (&Sthis_command_keys_vector
);
11868 defsubr (&Sthis_single_command_keys
);
11869 defsubr (&Sthis_single_command_raw_keys
);
11870 defsubr (&Sreset_this_command_lengths
);
11871 defsubr (&Sclear_this_command_keys
);
11872 defsubr (&Ssuspend_emacs
);
11873 defsubr (&Sabort_recursive_edit
);
11874 defsubr (&Sexit_recursive_edit
);
11875 defsubr (&Srecursion_depth
);
11876 defsubr (&Stop_level
);
11877 defsubr (&Sdiscard_input
);
11878 defsubr (&Sopen_dribble_file
);
11879 defsubr (&Sset_input_interrupt_mode
);
11880 defsubr (&Sset_output_flow_control
);
11881 defsubr (&Sset_input_meta_mode
);
11882 defsubr (&Sset_quit_char
);
11883 defsubr (&Sset_input_mode
);
11884 defsubr (&Scurrent_input_mode
);
11885 defsubr (&Sexecute_extended_command
);
11886 defsubr (&Sposn_at_point
);
11887 defsubr (&Sposn_at_x_y
);
11889 DEFVAR_LISP ("last-command-char", &last_command_char
,
11890 doc
: /* Last input event that was part of a command. */);
11892 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11893 doc
: /* Last input event that was part of a command. */);
11895 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11896 doc
: /* Last input event in a command, except for mouse menu events.
11897 Mouse menus give back keys that don't look like mouse events;
11898 this variable holds the actual mouse event that led to the menu,
11899 so that you can determine whether the command was run by mouse or not. */);
11901 DEFVAR_LISP ("last-input-char", &last_input_char
,
11902 doc
: /* Last input event. */);
11904 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11905 doc
: /* Last input event. */);
11907 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11908 doc
: /* List of events to be read as the command input.
11909 These events are processed first, before actual keyboard input.
11910 Events read from this list are not normally added to `this-command-keys',
11911 as they will already have been added once as they were read for the first time.
11912 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11913 Vunread_command_events
= Qnil
;
11915 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11916 doc
: /* If not -1, an object to be read as next command input event. */);
11918 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11919 doc
: /* List of events to be processed as input by input methods.
11920 These events are processed before `unread-command-events'
11921 and actual keyboard input, but are not given to `input-method-function'. */);
11922 Vunread_post_input_method_events
= Qnil
;
11924 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11925 doc
: /* List of events to be processed as input by input methods.
11926 These events are processed after `unread-command-events', but
11927 before actual keyboard input.
11928 If there's an active input method, the events are given to
11929 `input-method-function'. */);
11930 Vunread_input_method_events
= Qnil
;
11932 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11933 doc
: /* Meta-prefix character code.
11934 Meta-foo as command input turns into this character followed by foo. */);
11935 XSETINT (meta_prefix_char
, 033);
11937 DEFVAR_KBOARD ("last-command", Vlast_command
,
11938 doc
: /* The last command executed.
11939 Normally a symbol with a function definition, but can be whatever was found
11940 in the keymap, or whatever the variable `this-command' was set to by that
11943 The value `mode-exit' is special; it means that the previous command
11944 read an event that told it to exit, and it did so and unread that event.
11945 In other words, the present command is the event that made the previous
11948 The value `kill-region' is special; it means that the previous command
11949 was a kill command.
11951 `last-command' has a separate binding for each terminal device.
11952 See Info node `(elisp)Multiple displays'. */);
11954 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11955 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11957 DEFVAR_LISP ("this-command", &Vthis_command
,
11958 doc
: /* The command now being executed.
11959 The command can set this variable; whatever is put here
11960 will be in `last-command' during the following command. */);
11961 Vthis_command
= Qnil
;
11963 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11964 doc
: /* The command bound to the current key sequence before remapping.
11965 It equals `this-command' if the original command was not remapped through
11966 any of the active keymaps. Otherwise, the value of `this-command' is the
11967 result of looking up the original command in the active keymaps. */);
11968 Vthis_original_command
= Qnil
;
11970 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11971 doc
: /* *Number of input events between auto-saves.
11972 Zero means disable autosaving due to number of characters typed. */);
11973 auto_save_interval
= 300;
11975 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11976 doc
: /* *Number of seconds idle time before auto-save.
11977 Zero or nil means disable auto-saving due to idleness.
11978 After auto-saving due to this many seconds of idle time,
11979 Emacs also does a garbage collection if that seems to be warranted. */);
11980 XSETFASTINT (Vauto_save_timeout
, 30);
11982 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11983 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11984 The value may be integer or floating point. */);
11985 Vecho_keystrokes
= make_number (1);
11987 DEFVAR_INT ("polling-period", &polling_period
,
11988 doc
: /* *Interval between polling for input during Lisp execution.
11989 The reason for polling is to make C-g work to stop a running program.
11990 Polling is needed only when using X windows and SIGIO does not work.
11991 Polling is automatically disabled in all other cases. */);
11992 polling_period
= 2;
11994 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11995 doc
: /* *Maximum time between mouse clicks to make a double-click.
11996 Measured in milliseconds. The value nil means disable double-click
11997 recognition; t means double-clicks have no time limit and are detected
11998 by position only. */);
11999 Vdouble_click_time
= make_number (500);
12001 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12002 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12003 On window-system frames, value is the number of pixels the mouse may have
12004 moved horizontally or vertically between two clicks to make a double-click.
12005 On non window-system frames, value is interpreted in units of 1/8 characters
12008 This variable is also the threshold for motion of the mouse
12009 to count as a drag. */);
12010 double_click_fuzz
= 3;
12012 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12013 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12014 inhibit_local_menu_bar_menus
= 0;
12016 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12017 doc
: /* Number of complete key sequences read as input so far.
12018 This includes key sequences read from keyboard macros.
12019 The number is effectively the number of interactive command invocations. */);
12020 num_input_keys
= 0;
12022 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12023 doc
: /* Number of input events read from the keyboard so far.
12024 This does not include events generated by keyboard macros. */);
12025 num_nonmacro_input_events
= 0;
12027 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12028 doc
: /* The frame in which the most recently read event occurred.
12029 If the last event came from a keyboard macro, this is set to `macro'. */);
12030 Vlast_event_frame
= Qnil
;
12032 /* This variable is set up in sysdep.c. */
12033 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12034 doc
: /* The ERASE character as set by the user with stty. */);
12036 DEFVAR_LISP ("help-char", &Vhelp_char
,
12037 doc
: /* Character to recognize as meaning Help.
12038 When it is read, do `(eval help-form)', and display result if it's a string.
12039 If the value of `help-form' is nil, this char can be read normally. */);
12040 XSETINT (Vhelp_char
, Ctl ('H'));
12042 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12043 doc
: /* List of input events to recognize as meaning Help.
12044 These work just like the value of `help-char' (see that). */);
12045 Vhelp_event_list
= Qnil
;
12047 DEFVAR_LISP ("help-form", &Vhelp_form
,
12048 doc
: /* Form to execute when character `help-char' is read.
12049 If the form returns a string, that string is displayed.
12050 If `help-form' is nil, the help char is not recognized. */);
12053 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12054 doc
: /* Command to run when `help-char' character follows a prefix key.
12055 This command is used only when there is no actual binding
12056 for that character after that prefix key. */);
12057 Vprefix_help_command
= Qnil
;
12059 DEFVAR_LISP ("top-level", &Vtop_level
,
12060 doc
: /* Form to evaluate when Emacs starts up.
12061 Useful to set before you dump a modified Emacs. */);
12064 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12065 doc
: /* Translate table for local keyboard input, or nil.
12066 If non-nil, the value should be a char-table. Each character read
12067 from the keyboard is looked up in this char-table. If the value found
12068 there is non-nil, then it is used instead of the actual input character.
12070 The value can also be a string or vector, but this is considered obsolete.
12071 If it is a string or vector of length N, character codes N and up are left
12072 untranslated. In a vector, an element which is nil means "no translation".
12074 This is applied to the characters supplied to input methods, not their
12075 output. See also `translation-table-for-input'.
12077 This variable has a separate binding for each terminal. See Info node
12078 `(elisp)Multiple displays'. */);
12080 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12081 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12082 \(Even if the operating system has support for stopping a process.\) */);
12083 cannot_suspend
= 0;
12085 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12086 doc
: /* Non-nil means prompt with menus when appropriate.
12087 This is done when reading from a keymap that has a prompt string,
12088 for elements that have prompt strings.
12089 The menu is displayed on the screen
12090 if X menus were enabled at configuration
12091 time and the previous event was a mouse click prefix key.
12092 Otherwise, menu prompting uses the echo area. */);
12093 menu_prompting
= 1;
12095 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12096 doc
: /* Character to see next line of menu prompt.
12097 Type this character while in a menu prompt to rotate around the lines of it. */);
12098 XSETINT (menu_prompt_more_char
, ' ');
12100 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12101 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12102 Emacs applies the modifiers of the character stored here to each keyboard
12103 character it reads. For example, after evaluating the expression
12104 (setq extra-keyboard-modifiers ?\\C-x)
12105 all input characters will have the control modifier applied to them.
12107 Note that the character ?\\C-@, equivalent to the integer zero, does
12108 not count as a control character; rather, it counts as a character
12109 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12110 cancels any modification. */);
12111 extra_keyboard_modifiers
= 0;
12113 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12114 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12115 The command loop sets this to nil before each command,
12116 and tests the value when the command returns.
12117 Buffer modification stores t in this variable. */);
12118 Vdeactivate_mark
= Qnil
;
12120 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12121 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
12122 Vcommand_hook_internal
= Qnil
;
12124 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12125 doc
: /* Normal hook run before each command is executed.
12126 If an unhandled error happens in running this hook,
12127 the hook value is set to nil, since otherwise the error
12128 might happen repeatedly and make Emacs nonfunctional. */);
12129 Vpre_command_hook
= Qnil
;
12131 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12132 doc
: /* Normal hook run after each command is executed.
12133 If an unhandled error happens in running this hook,
12134 the hook value is set to nil, since otherwise the error
12135 might happen repeatedly and make Emacs nonfunctional. */);
12136 Vpost_command_hook
= Qnil
;
12139 DEFVAR_LISP ("echo-area-clear-hook", ...,
12140 doc
: /* Normal hook run when clearing the echo area. */);
12142 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12143 staticpro (&Qecho_area_clear_hook
);
12144 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12146 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12147 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12148 Vlucid_menu_bar_dirty_flag
= Qnil
;
12150 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12151 doc
: /* List of menu bar items to move to the end of the menu bar.
12152 The elements of the list are event types that may have menu bar bindings. */);
12153 Vmenu_bar_final_items
= Qnil
;
12155 DEFVAR_KBOARD ("overriding-terminal-local-map",
12156 Voverriding_terminal_local_map
,
12157 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12158 If this variable is non-nil, it is used as a keymap instead of the
12159 buffer's local map, and the minor mode keymaps and text property keymaps.
12160 It also replaces `overriding-local-map'.
12162 This variable is intended to let commands such as `universal-argument'
12163 set up a different keymap for reading the next command.
12165 `overriding-terminal-local-map' has a separate binding for each
12167 See Info node `(elisp)Multiple displays'. */);
12169 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12170 doc
: /* Keymap that overrides all other local keymaps.
12171 If this variable is non-nil, it is used as a keymap--replacing the
12172 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12173 Voverriding_local_map
= Qnil
;
12175 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12176 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12177 Otherwise, the menu bar continues to reflect the buffer's local map
12178 and the minor mode maps regardless of `overriding-local-map'. */);
12179 Voverriding_local_map_menu_flag
= Qnil
;
12181 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12182 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12183 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12185 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12186 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12188 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12189 doc
: /* Alist of system-specific X windows key symbols.
12190 Each element should have the form (N . SYMBOL) where N is the
12191 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12192 and SYMBOL is its name.
12194 `system-key-alist' has a separate binding for each terminal device.
12195 See Info node `(elisp)Multiple displays'. */);
12197 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12198 doc
: /* Keymap that translates key sequences to key sequences during input.
12199 This is used mainly for mapping ASCII function key sequences into
12200 real Emacs function key events (symbols).
12202 The `read-key-sequence' function replaces any subsequence bound by
12203 `local-function-key-map' with its binding. More precisely, when the
12204 active keymaps have no binding for the current key sequence but
12205 `local-function-key-map' binds a suffix of the sequence to a vector or
12206 string, `read-key-sequence' replaces the matching suffix with its
12207 binding, and continues with the new sequence.
12209 If the binding is a function, it is called with one argument (the prompt)
12210 and its return value (a key sequence) is used.
12212 The events that come from bindings in `local-function-key-map' are not
12213 themselves looked up in `local-function-key-map'.
12215 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12216 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12217 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12218 typing `ESC O P x' would return [f1 x].
12220 `local-function-key-map' has a separate binding for each terminal
12221 device. See Info node `(elisp)Multiple displays'. If you need to
12222 define a binding on all terminals, change `function-key-map'
12223 instead. Initially, `local-function-key-map' is an empty keymap that
12224 has `function-key-map' as its parent on all terminal devices. */);
12226 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12227 doc
: /* The parent keymap of all `local-function-key-map' instances.
12228 Function key definitions that apply to all terminal devices should go
12229 here. If a mapping is defined in both the current
12230 `local-function-key-map' binding and this variable, then the local
12231 definition will take precendence. */);
12232 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12234 DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map
,
12235 doc
: /* Keymap of key translations that can override keymaps.
12236 This keymap works like `function-key-map', but comes after that,
12237 and its non-prefix bindings override ordinary bindings.
12239 `key-translation-map' has a separate binding for each terminal device.
12240 (See Info node `(elisp)Multiple displays'.) If you need to set a key
12241 translation on all terminals, change `global-key-translation-map' instead. */);
12243 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12244 doc
: /* The parent keymap of all `local-key-translation-map' instances.
12245 Key translations that apply to all terminal devices should go here. */);
12246 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12248 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12249 doc
: /* List of deferred actions to be performed at a later time.
12250 The precise format isn't relevant here; we just check whether it is nil. */);
12251 Vdeferred_action_list
= Qnil
;
12253 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12254 doc
: /* Function to call to handle deferred actions, after each command.
12255 This function is called with no arguments after each command
12256 whenever `deferred-action-list' is non-nil. */);
12257 Vdeferred_action_function
= Qnil
;
12259 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12260 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12261 The value can be a length of time to show the message for.
12262 If the value is non-nil and not a number, we wait 2 seconds. */);
12263 Vsuggest_key_bindings
= Qt
;
12265 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12266 doc
: /* List of active absolute time timers in order of increasing time. */);
12267 Vtimer_list
= Qnil
;
12269 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12270 doc
: /* List of active idle-time timers in order of increasing time. */);
12271 Vtimer_idle_list
= Qnil
;
12273 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12274 doc
: /* If non-nil, the function that implements the current input method.
12275 It's called with one argument, a printing character that was just read.
12276 \(That means a character with code 040...0176.)
12277 Typically this function uses `read-event' to read additional events.
12278 When it does so, it should first bind `input-method-function' to nil
12279 so it will not be called recursively.
12281 The function should return a list of zero or more events
12282 to be used as input. If it wants to put back some events
12283 to be reconsidered, separately, by the input method,
12284 it can add them to the beginning of `unread-command-events'.
12286 The input method function can find in `input-method-previous-method'
12287 the previous echo area message.
12289 The input method function should refer to the variables
12290 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12291 for guidance on what to do. */);
12292 Vinput_method_function
= Qnil
;
12294 DEFVAR_LISP ("input-method-previous-message",
12295 &Vinput_method_previous_message
,
12296 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12297 This variable exists because `read-event' clears the echo area
12298 before running the input method. It is nil if there was no message. */);
12299 Vinput_method_previous_message
= Qnil
;
12301 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12302 doc
: /* If non-nil, the function that implements the display of help.
12303 It's called with one argument, the help string to display. */);
12304 Vshow_help_function
= Qnil
;
12306 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12307 doc
: /* If non-nil, suppress point adjustment after executing a command.
12309 After a command is executed, if point is moved into a region that has
12310 special properties (e.g. composition, display), we adjust point to
12311 the boundary of the region. But, when a command sets this variable to
12312 non-nil, we suppress the point adjustment.
12314 This variable is set to nil before reading a command, and is checked
12315 just after executing the command. */);
12316 Vdisable_point_adjustment
= Qnil
;
12318 DEFVAR_LISP ("global-disable-point-adjustment",
12319 &Vglobal_disable_point_adjustment
,
12320 doc
: /* *If non-nil, always suppress point adjustment.
12322 The default value is nil, in which case, point adjustment are
12323 suppressed only after special commands that set
12324 `disable-point-adjustment' (which see) to non-nil. */);
12325 Vglobal_disable_point_adjustment
= Qnil
;
12327 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12328 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12329 If the value is not a number, such messages don't time out. */);
12330 Vminibuffer_message_timeout
= make_number (2);
12332 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12333 doc
: /* If non-nil, any keyboard input throws to this symbol.
12334 The value of that variable is passed to `quit-flag' and later causes a
12335 peculiar kind of quitting. */);
12336 Vthrow_on_input
= Qnil
;
12338 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12339 doc
: /* If non-nil, function to output error messages.
12340 The arguments are the error data, a list of the form
12341 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12342 such as just as `condition-case' would bind its variable to,
12343 the context (a string which normally goes at the start of the message),
12344 and the Lisp function within which the error was signaled. */);
12345 Vcommand_error_function
= Qnil
;
12347 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12348 &Venable_disabled_menus_and_buttons
,
12349 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12351 Help functions bind this to allow help on disabled menu items
12352 and tool-bar buttons. */);
12353 Venable_disabled_menus_and_buttons
= Qnil
;
12357 keys_of_keyboard ()
12359 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12360 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12361 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12362 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12363 initial_define_key (meta_map
, 'x', "execute-extended-command");
12365 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12366 "handle-delete-frame");
12367 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12368 current-prefix-arg, as is done in `handle-switch-frame'.
12369 But `handle-switch-frame is not run from the special-map.
12370 Commands from that map are run in a special way that automatically
12371 preserves the prefix-arg. Restoring the prefix arg here is not just
12372 redundant but harmful:
12374 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12375 - after the first prompt, the exit-minibuffer-hook is run which may
12376 iconify a frame and thus push a `iconify-frame' event.
12377 - after running exit-minibuffer-hook, current-prefix-arg is
12378 restored to the non-nil value it had before the prompt.
12379 - we enter the second prompt.
12380 current-prefix-arg is non-nil, prefix-arg is nil.
12381 - before running the first real event, we run the special iconify-frame
12382 event, but we pass the `special' arg to execute-command so
12383 current-prefix-arg and prefix-arg are left untouched.
12384 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12385 - the next key event will have a spuriously non-nil current-prefix-arg. */
12386 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12388 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12390 /* Handling it at such a low-level causes read_key_sequence to get
12391 * confused because it doesn't realize that the current_buffer was
12392 * changed by read_char.
12394 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12395 * "handle-select-window"); */
12396 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12397 "handle-save-session");
12400 /* Mark the pointers in the kboard objects.
12401 Called by the Fgarbage_collector. */
12407 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12409 if (kb
->kbd_macro_buffer
)
12410 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12412 mark_object (kb
->Voverriding_terminal_local_map
);
12413 mark_object (kb
->Vlast_command
);
12414 mark_object (kb
->Vreal_last_command
);
12415 mark_object (kb
->Vkeyboard_translate_table
);
12416 mark_object (kb
->Vprefix_arg
);
12417 mark_object (kb
->Vlast_prefix_arg
);
12418 mark_object (kb
->kbd_queue
);
12419 mark_object (kb
->defining_kbd_macro
);
12420 mark_object (kb
->Vlast_kbd_macro
);
12421 mark_object (kb
->Vsystem_key_alist
);
12422 mark_object (kb
->system_key_syms
);
12423 mark_object (kb
->Vlocal_function_key_map
);
12424 mark_object (kb
->Vlocal_key_translation_map
);
12425 mark_object (kb
->Vdefault_minibuffer_frame
);
12426 mark_object (kb
->echo_string
);
12429 struct input_event
*event
;
12430 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12432 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12433 event
= kbd_buffer
;
12434 if (event
->kind
!= SELECTION_REQUEST_EVENT
12435 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12437 mark_object (event
->x
);
12438 mark_object (event
->y
);
12440 mark_object (event
->frame_or_window
);
12441 mark_object (event
->arg
);
12446 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12447 (do not change this comment) */