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 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
30 #include "termhooks.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
63 #include <sys/types.h>
72 /* This is to get the definitions of the XK_ symbols. */
79 #endif /* HAVE_NTGUI */
89 /* Variables for blockinput.h: */
91 /* Non-zero if interrupt input is blocked right now. */
92 int interrupt_input_blocked
;
94 /* Nonzero means an input interrupt has arrived
95 during the current critical section. */
96 int interrupt_input_pending
;
99 #ifdef HAVE_WINDOW_SYSTEM
100 /* Make all keyboard buffers much bigger when using X windows. */
102 /* But not too big (local data > 32K error) if on Mac OS Classic. */
103 #define KBD_BUFFER_SIZE 512
105 #define KBD_BUFFER_SIZE 4096
107 #else /* No X-windows, character input */
108 #define KBD_BUFFER_SIZE 4096
109 #endif /* No X-windows */
111 #define abs(x) ((x) >= 0 ? (x) : -(x))
113 /* Following definition copied from eval.c */
117 struct backtrace
*next
;
118 Lisp_Object
*function
;
119 Lisp_Object
*args
; /* Points to vector of args. */
120 int nargs
; /* length of vector. If nargs is UNEVALLED,
121 args points to slot holding list of
124 /* Nonzero means call value of debugger when done with this operation. */
129 KBOARD
*initial_kboard
;
130 KBOARD
*current_kboard
;
134 KBOARD the_only_kboard
;
137 /* Non-nil disable property on a command means
138 do not execute it; call disabled-command-function's value instead. */
139 Lisp_Object Qdisabled
, Qdisabled_command_function
;
141 #define NUM_RECENT_KEYS (100)
142 int recent_keys_index
; /* Index for storing next element into recent_keys */
143 int total_keys
; /* Total number of elements stored into recent_keys */
144 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
146 /* Vector holding the key sequence that invoked the current command.
147 It is reused for each command, and it may be longer than the current
148 sequence; this_command_key_count indicates how many elements
149 actually mean something.
150 It's easier to staticpro a single Lisp_Object than an array. */
151 Lisp_Object this_command_keys
;
152 int this_command_key_count
;
154 /* 1 after calling Freset_this_command_lengths.
156 int this_command_key_count_reset
;
158 /* This vector is used as a buffer to record the events that were actually read
159 by read_key_sequence. */
160 Lisp_Object raw_keybuf
;
161 int raw_keybuf_count
;
163 #define GROW_RAW_KEYBUF \
164 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
166 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
168 new = Fmake_vector (make_number (newsize), Qnil); \
169 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
170 raw_keybuf_count * sizeof (Lisp_Object)); \
174 /* Number of elements of this_command_keys
175 that precede this key sequence. */
176 int this_single_command_key_start
;
178 /* Record values of this_command_key_count and echo_length ()
179 before this command was read. */
180 static int before_command_key_count
;
181 static int before_command_echo_length
;
183 extern int minbuf_level
;
185 extern int message_enable_multibyte
;
187 extern struct backtrace
*backtrace_list
;
189 /* If non-nil, the function that implements the display of help.
190 It's called with one argument, the help string to display. */
192 Lisp_Object Vshow_help_function
;
194 /* If a string, the message displayed before displaying a help-echo
197 Lisp_Object Vpre_help_message
;
199 /* Nonzero means do menu prompting. */
201 static int menu_prompting
;
203 /* Character to see next line of menu prompt. */
205 static Lisp_Object menu_prompt_more_char
;
207 /* For longjmp to where kbd input is being done. */
209 static jmp_buf getcjmp
;
211 /* True while doing kbd input. */
212 int waiting_for_input
;
214 /* True while displaying for echoing. Delays C-g throwing. */
218 /* Non-null means we can start echoing at the next input pause even
219 though there is something in the echo area. */
221 static struct kboard
*ok_to_echo_at_next_pause
;
223 /* The kboard last echoing, or null for none. Reset to 0 in
224 cancel_echoing. If non-null, and a current echo area message
225 exists, and echo_message_buffer is eq to the current message
226 buffer, we know that the message comes from echo_kboard. */
228 struct kboard
*echo_kboard
;
230 /* The buffer used for echoing. Set in echo_now, reset in
233 Lisp_Object echo_message_buffer
;
235 /* Nonzero means disregard local maps for the menu bar. */
236 static int inhibit_local_menu_bar_menus
;
238 /* Nonzero means C-g should cause immediate error-signal. */
241 /* The user's hook function for outputting an error message. */
242 Lisp_Object Vcommand_error_function
;
244 /* The user's ERASE setting. */
245 Lisp_Object Vtty_erase_char
;
247 /* Character to recognize as the help char. */
248 Lisp_Object Vhelp_char
;
250 /* List of other event types to recognize as meaning "help". */
251 Lisp_Object Vhelp_event_list
;
253 /* Form to execute when help char is typed. */
254 Lisp_Object Vhelp_form
;
256 /* Command to run when the help character follows a prefix key. */
257 Lisp_Object Vprefix_help_command
;
259 /* List of items that should move to the end of the menu bar. */
260 Lisp_Object Vmenu_bar_final_items
;
262 /* Non-nil means show the equivalent key-binding for
263 any M-x command that has one.
264 The value can be a length of time to show the message for.
265 If the value is non-nil and not a number, we wait 2 seconds. */
266 Lisp_Object Vsuggest_key_bindings
;
268 /* How long to display an echo-area message when the minibuffer is active.
269 If the value is not a number, such messages don't time out. */
270 Lisp_Object Vminibuffer_message_timeout
;
272 /* Character that causes a quit. Normally C-g.
274 If we are running on an ordinary terminal, this must be an ordinary
275 ASCII char, since we want to make it our interrupt character.
277 If we are not running on an ordinary terminal, it still needs to be
278 an ordinary ASCII char. This character needs to be recognized in
279 the input interrupt handler. At this point, the keystroke is
280 represented as a struct input_event, while the desired quit
281 character is specified as a lispy event. The mapping from struct
282 input_events to lispy events cannot run in an interrupt handler,
283 and the reverse mapping is difficult for anything but ASCII
286 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
290 extern Lisp_Object current_global_map
;
291 extern int minibuf_level
;
293 /* If non-nil, this is a map that overrides all other local maps. */
294 Lisp_Object Voverriding_local_map
;
296 /* If non-nil, Voverriding_local_map applies to the menu bar. */
297 Lisp_Object Voverriding_local_map_menu_flag
;
299 /* Keymap that defines special misc events that should
300 be processed immediately at a low level. */
301 Lisp_Object Vspecial_event_map
;
303 /* Current depth in recursive edits. */
304 int command_loop_level
;
306 /* Total number of times command_loop has read a key sequence. */
307 EMACS_INT num_input_keys
;
309 /* Last input character read as a command. */
310 Lisp_Object last_command_char
;
312 /* Last input character read as a command, not counting menus
313 reached by the mouse. */
314 Lisp_Object last_nonmenu_event
;
316 /* Last input character read for any purpose. */
317 Lisp_Object last_input_char
;
319 /* If not Qnil, a list of objects to be read as subsequent command input. */
320 Lisp_Object Vunread_command_events
;
322 /* If not Qnil, a list of objects to be read as subsequent command input
323 including input method processing. */
324 Lisp_Object Vunread_input_method_events
;
326 /* If not Qnil, a list of objects to be read as subsequent command input
327 but NOT including input method processing. */
328 Lisp_Object Vunread_post_input_method_events
;
330 /* If not -1, an event to be read as subsequent command input. */
331 EMACS_INT unread_command_char
;
333 /* If not Qnil, this is a switch-frame event which we decided to put
334 off until the end of a key sequence. This should be read as the
335 next command input, after any unread_command_events.
337 read_key_sequence uses this to delay switch-frame events until the
338 end of the key sequence; Fread_char uses it to put off switch-frame
339 events until a non-ASCII event is acceptable as input. */
340 Lisp_Object unread_switch_frame
;
342 /* A mask of extra modifier bits to put into every keyboard char. */
343 EMACS_INT extra_keyboard_modifiers
;
345 /* Char to use as prefix when a meta character is typed in.
346 This is bound on entry to minibuffer in case ESC is changed there. */
348 Lisp_Object meta_prefix_char
;
350 /* Last size recorded for a current buffer which is not a minibuffer. */
351 static int last_non_minibuf_size
;
353 /* Number of idle seconds before an auto-save and garbage collection. */
354 static Lisp_Object Vauto_save_timeout
;
356 /* Total number of times read_char has returned. */
357 int num_input_events
;
359 /* Total number of times read_char has returned, outside of macros. */
360 EMACS_INT num_nonmacro_input_events
;
362 /* Auto-save automatically when this many characters have been typed
363 since the last time. */
365 static EMACS_INT auto_save_interval
;
367 /* Value of num_nonmacro_input_events as of last auto save. */
371 /* The command being executed by the command loop.
372 Commands may set this, and the value set will be copied into
373 current_kboard->Vlast_command instead of the actual command. */
374 Lisp_Object Vthis_command
;
376 /* This is like Vthis_command, except that commands never set it. */
377 Lisp_Object real_this_command
;
379 /* If the lookup of the command returns a binding, the original
380 command is stored in this-original-command. It is nil otherwise. */
381 Lisp_Object Vthis_original_command
;
383 /* The value of point when the last command was started. */
384 int last_point_position
;
386 /* The buffer that was current when the last command was started. */
387 Lisp_Object last_point_position_buffer
;
389 /* The window that was selected when the last command was started. */
390 Lisp_Object last_point_position_window
;
392 /* The frame in which the last input event occurred, or Qmacro if the
393 last event came from a macro. We use this to determine when to
394 generate switch-frame events. This may be cleared by functions
395 like Fselect_frame, to make sure that a switch-frame event is
396 generated by the next character. */
397 Lisp_Object internal_last_event_frame
;
399 /* A user-visible version of the above, intended to allow users to
400 figure out where the last event came from, if the event doesn't
401 carry that information itself (i.e. if it was a character). */
402 Lisp_Object Vlast_event_frame
;
404 /* The timestamp of the last input event we received from the X server.
405 X Windows wants this for selection ownership. */
406 unsigned long last_event_timestamp
;
408 Lisp_Object Qself_insert_command
;
409 Lisp_Object Qforward_char
;
410 Lisp_Object Qbackward_char
;
411 Lisp_Object Qundefined
;
412 Lisp_Object Qtimer_event_handler
;
414 /* read_key_sequence stores here the command definition of the
415 key sequence that it reads. */
416 Lisp_Object read_key_sequence_cmd
;
418 /* Echo unfinished commands after this many seconds of pause. */
419 Lisp_Object Vecho_keystrokes
;
421 /* Form to evaluate (if non-nil) when Emacs is started. */
422 Lisp_Object Vtop_level
;
424 /* If non-nil, this implements the current input method. */
425 Lisp_Object Vinput_method_function
;
426 Lisp_Object Qinput_method_function
;
428 /* When we call Vinput_method_function,
429 this holds the echo area message that was just erased. */
430 Lisp_Object Vinput_method_previous_message
;
432 /* Non-nil means deactivate the mark at end of this command. */
433 Lisp_Object Vdeactivate_mark
;
435 /* Menu bar specified in Lucid Emacs fashion. */
437 Lisp_Object Vlucid_menu_bar_dirty_flag
;
438 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
440 Lisp_Object Qecho_area_clear_hook
;
442 /* Hooks to run before and after each command. */
443 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
444 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
445 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
447 /* Parent keymap of terminal-local function-key-map instances. */
448 Lisp_Object Vfunction_key_map
;
450 /* Parent keymap of terminal-local key-translation-map instances. */
451 Lisp_Object Vkey_translation_map
;
453 /* List of deferred actions to be performed at a later time.
454 The precise format isn't relevant here; we just check whether it is nil. */
455 Lisp_Object Vdeferred_action_list
;
457 /* Function to call to handle deferred actions, when there are any. */
458 Lisp_Object Vdeferred_action_function
;
459 Lisp_Object Qdeferred_action_function
;
461 Lisp_Object Qinput_method_exit_on_first_char
;
462 Lisp_Object Qinput_method_use_echo_area
;
464 /* File in which we write all commands we read. */
467 /* Nonzero if input is available. */
470 extern char *pending_malloc_warning
;
472 /* Circular buffer for pre-read keyboard input. */
474 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
476 /* Pointer to next available character in kbd_buffer.
477 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
478 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
479 next available char is in kbd_buffer[0]. */
480 static struct input_event
*kbd_fetch_ptr
;
482 /* Pointer to next place to store character in kbd_buffer. This
483 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
484 character should go in kbd_buffer[0]. */
485 static struct input_event
* volatile kbd_store_ptr
;
487 /* The above pair of variables forms a "queue empty" flag. When we
488 enqueue a non-hook event, we increment kbd_store_ptr. When we
489 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
490 there is input available iff the two pointers are not equal.
492 Why not just have a flag set and cleared by the enqueuing and
493 dequeuing functions? Such a flag could be screwed up by interrupts
494 at inopportune times. */
496 /* If this flag is non-nil, we check mouse_moved to see when the
497 mouse moves, and motion events will appear in the input stream.
498 Otherwise, mouse motion is ignored. */
499 Lisp_Object do_mouse_tracking
;
501 /* Symbols to head events. */
502 Lisp_Object Qmouse_movement
;
503 Lisp_Object Qscroll_bar_movement
;
504 Lisp_Object Qswitch_frame
;
505 Lisp_Object Qdelete_frame
;
506 Lisp_Object Qiconify_frame
;
507 Lisp_Object Qmake_frame_visible
;
508 Lisp_Object Qselect_window
;
509 Lisp_Object Qhelp_echo
;
512 Lisp_Object Qmouse_fixup_help_message
;
515 /* Symbols to denote kinds of events. */
516 Lisp_Object Qfunction_key
;
517 Lisp_Object Qmouse_click
;
518 #if defined (WINDOWSNT) || defined (MAC_OS)
519 Lisp_Object Qlanguage_change
;
521 Lisp_Object Qdrag_n_drop
;
522 Lisp_Object Qsave_session
;
524 Lisp_Object Qmac_apple_event
;
527 /* Lisp_Object Qmouse_movement; - also an event header */
529 /* Properties of event headers. */
530 Lisp_Object Qevent_kind
;
531 Lisp_Object Qevent_symbol_elements
;
533 /* menu item parts */
534 Lisp_Object Qmenu_alias
;
535 Lisp_Object Qmenu_enable
;
536 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
537 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
538 extern Lisp_Object Vdefine_key_rebound_commands
;
539 extern Lisp_Object Qmenu_item
;
541 /* An event header symbol HEAD may have a property named
542 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
543 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
544 mask of modifiers applied to it. If present, this is used to help
545 speed up parse_modifiers. */
546 Lisp_Object Qevent_symbol_element_mask
;
548 /* An unmodified event header BASE may have a property named
549 Qmodifier_cache, which is an alist mapping modifier masks onto
550 modified versions of BASE. If present, this helps speed up
552 Lisp_Object Qmodifier_cache
;
554 /* Symbols to use for parts of windows. */
555 Lisp_Object Qmode_line
;
556 Lisp_Object Qvertical_line
;
557 Lisp_Object Qvertical_scroll_bar
;
558 Lisp_Object Qmenu_bar
;
559 extern Lisp_Object Qleft_margin
, Qright_margin
;
560 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
561 extern Lisp_Object QCmap
;
563 Lisp_Object
recursive_edit_unwind (), command_loop ();
564 Lisp_Object
Fthis_command_keys ();
565 Lisp_Object Qextended_command_history
;
566 EMACS_TIME
timer_check ();
568 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
570 extern char *x_get_keysym_name ();
572 static void record_menu_key ();
573 static int echo_length ();
575 Lisp_Object Qpolling_period
;
577 /* List of absolute timers. Appears in order of next scheduled event. */
578 Lisp_Object Vtimer_list
;
580 /* List of idle time timers. Appears in order of next scheduled event. */
581 Lisp_Object Vtimer_idle_list
;
583 /* Incremented whenever a timer is run. */
586 extern Lisp_Object Vprint_level
, Vprint_length
;
588 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
590 EMACS_TIME
*input_available_clear_time
;
592 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
593 Default is 1 if INTERRUPT_INPUT is defined. */
596 /* Nonzero while interrupts are temporarily deferred during redisplay. */
597 int interrupts_deferred
;
599 /* Allow m- file to inhibit use of FIONREAD. */
600 #ifdef BROKEN_FIONREAD
604 /* We are unable to use interrupts if FIONREAD is not available,
605 so flush SIGIO so we won't try. */
606 #if !defined (FIONREAD)
612 /* If we support a window system, turn on the code to poll periodically
613 to detect C-g. It isn't actually used when doing interrupt input. */
614 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
615 #define POLL_FOR_INPUT
618 /* After a command is executed, if point is moved into a region that
619 has specific properties (e.g. composition, display), we adjust
620 point to the boundary of the region. But, if a command sets this
621 variable to non-nil, we suppress this point adjustment. This
622 variable is set to nil before reading a command. */
624 Lisp_Object Vdisable_point_adjustment
;
626 /* If non-nil, always disable point adjustment. */
628 Lisp_Object Vglobal_disable_point_adjustment
;
630 /* The time when Emacs started being idle. */
632 static EMACS_TIME timer_idleness_start_time
;
634 /* After Emacs stops being idle, this saves the last value
635 of timer_idleness_start_time from when it was idle. */
637 static EMACS_TIME timer_last_idleness_start_time
;
639 /* If non-nil, events produced by disabled menu items and tool-bar
640 buttons are not ignored. Help functions bind this to allow help on
641 those items and buttons. */
642 Lisp_Object Venable_disabled_menus_and_buttons
;
645 /* Global variable declarations. */
647 /* Flags for readable_events. */
648 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
649 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
650 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
652 /* Function for init_keyboard to call with no args (if nonzero). */
653 void (*keyboard_init_hook
) ();
655 static int read_avail_input
P_ ((int));
656 static void get_input_pending
P_ ((int *, int));
657 static int readable_events
P_ ((int));
658 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
659 Lisp_Object
, int *));
660 static Lisp_Object
read_char_x_menu_prompt ();
661 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
663 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
665 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
666 enum scroll_bar_part
,
667 Lisp_Object
, Lisp_Object
,
670 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
671 Lisp_Object
, char **,
672 Lisp_Object
*, unsigned));
673 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
674 static int parse_solitary_modifier
P_ ((Lisp_Object
));
675 static int parse_solitary_modifier ();
676 static void save_getcjmp
P_ ((jmp_buf));
677 static void save_getcjmp ();
678 static void restore_getcjmp
P_ ((jmp_buf));
679 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
680 static void clear_event
P_ ((struct input_event
*));
681 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
));
1226 restore_kboard_configuration (was_locked
)
1227 Lisp_Object was_locked
;
1229 if (NILP (was_locked
))
1233 struct kboard
*prev
= current_kboard
;
1236 /* The pop should not change the kboard. */
1237 if (single_kboard
&& current_kboard
!= prev
)
1243 /* Handle errors that are not handled at inner levels
1244 by printing an error message and returning to the editor command loop. */
1250 Lisp_Object old_level
, old_length
;
1251 char macroerror
[50];
1253 #ifdef HAVE_X_WINDOWS
1254 if (display_hourglass_p
)
1255 cancel_hourglass ();
1258 if (!NILP (executing_kbd_macro
))
1260 if (executing_kbd_macro_iterations
== 1)
1261 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1263 sprintf (macroerror
, "After %d kbd macro iterations: ",
1264 executing_kbd_macro_iterations
);
1269 Vstandard_output
= Qt
;
1270 Vstandard_input
= Qt
;
1271 Vexecuting_kbd_macro
= Qnil
;
1272 executing_kbd_macro
= Qnil
;
1273 current_kboard
->Vprefix_arg
= Qnil
;
1274 current_kboard
->Vlast_prefix_arg
= Qnil
;
1277 /* Avoid unquittable loop if data contains a circular list. */
1278 old_level
= Vprint_level
;
1279 old_length
= Vprint_length
;
1280 XSETFASTINT (Vprint_level
, 10);
1281 XSETFASTINT (Vprint_length
, 10);
1282 cmd_error_internal (data
, macroerror
);
1283 Vprint_level
= old_level
;
1284 Vprint_length
= old_length
;
1288 Vinhibit_quit
= Qnil
;
1289 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1291 if (command_loop_level
== 0 && minibuf_level
== 0)
1292 any_kboard_state ();
1296 return make_number (0);
1299 /* Take actions on handling an error. DATA is the data that describes
1302 CONTEXT is a C-string containing ASCII characters only which
1303 describes the context in which the error happened. If we need to
1304 generalize CONTEXT to allow multibyte characters, make it a Lisp
1308 cmd_error_internal (data
, context
)
1312 struct frame
*sf
= SELECTED_FRAME ();
1314 /* The immediate context is not interesting for Quits,
1315 since they are asyncronous. */
1316 if (EQ (XCAR (data
), Qquit
))
1317 Vsignaling_function
= Qnil
;
1322 /* Use user's specified output function if any. */
1323 if (!NILP (Vcommand_error_function
))
1324 call3 (Vcommand_error_function
, data
,
1325 build_string (context
? context
: ""),
1326 Vsignaling_function
);
1327 /* If the window system or terminal frame hasn't been initialized
1328 yet, or we're not interactive, write the message to stderr and exit. */
1329 else if (!sf
->glyphs_initialized_p
1330 || FRAME_INITIAL_P (sf
)
1333 print_error_message (data
, Qexternal_debugging_output
,
1334 context
, Vsignaling_function
);
1335 Fterpri (Qexternal_debugging_output
);
1336 Fkill_emacs (make_number (-1));
1340 clear_message (1, 0);
1342 message_log_maybe_newline ();
1345 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1348 Vsignaling_function
= Qnil
;
1351 Lisp_Object
command_loop_1 ();
1352 Lisp_Object
command_loop_2 ();
1353 Lisp_Object
top_level_1 ();
1355 /* Entry to editor-command-loop.
1356 This level has the catches for exiting/returning to editor command loop.
1357 It returns nil to exit recursive edit, t to abort it. */
1362 if (command_loop_level
> 0 || minibuf_level
> 0)
1365 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1366 executing_kbd_macro
= Qnil
;
1372 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1373 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1374 /* Reset single_kboard in case top-level set it while
1375 evaluating an -f option, or we are stuck there for some
1377 any_kboard_state ();
1379 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1380 executing_kbd_macro
= Qnil
;
1382 /* End of file in -batch run causes exit here. */
1388 /* Here we catch errors in execution of commands within the
1389 editing loop, and reenter the editing loop.
1390 When there is an error, cmd_error runs and returns a non-nil
1391 value to us. A value of nil means that command_loop_1 itself
1392 returned due to end of file (or end of kbd macro). */
1397 register Lisp_Object val
;
1400 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1401 while (!NILP (val
));
1409 return Feval (Vtop_level
);
1415 /* On entry to the outer level, run the startup file */
1416 if (!NILP (Vtop_level
))
1417 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1418 else if (!NILP (Vpurify_flag
))
1419 message ("Bare impure Emacs (standard Lisp code not loaded)");
1421 message ("Bare Emacs (standard Lisp code not loaded)");
1425 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1426 doc
: /* Exit all recursive editing levels. */)
1429 #ifdef HAVE_X_WINDOWS
1430 if (display_hourglass_p
)
1431 cancel_hourglass ();
1434 /* Unblock input if we enter with input blocked. This may happen if
1435 redisplay traps e.g. during tool-bar update with input blocked. */
1436 while (INPUT_BLOCKED_P
)
1439 return Fthrow (Qtop_level
, Qnil
);
1442 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1443 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1446 if (command_loop_level
> 0 || minibuf_level
> 0)
1447 Fthrow (Qexit
, Qnil
);
1449 error ("No recursive edit is in progress");
1453 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1454 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1457 if (command_loop_level
> 0 || minibuf_level
> 0)
1460 error ("No recursive edit is in progress");
1466 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1467 of this function. */
1470 tracking_off (old_value
)
1471 Lisp_Object old_value
;
1473 do_mouse_tracking
= old_value
;
1474 if (NILP (old_value
))
1476 /* Redisplay may have been preempted because there was input
1477 available, and it assumes it will be called again after the
1478 input has been processed. If the only input available was
1479 the sort that we have just disabled, then we need to call
1481 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1483 redisplay_preserve_echo_area (6);
1484 get_input_pending (&input_pending
,
1485 READABLE_EVENTS_DO_TIMERS_NOW
);
1491 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1492 doc
: /* Evaluate BODY with mouse movement events enabled.
1493 Within a `track-mouse' form, mouse motion generates input events that
1494 you can read with `read-event'.
1495 Normally, mouse motion is ignored.
1496 usage: (track-mouse BODY ...) */)
1500 int count
= SPECPDL_INDEX ();
1503 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1505 do_mouse_tracking
= Qt
;
1507 val
= Fprogn (args
);
1508 return unbind_to (count
, val
);
1511 /* If mouse has moved on some frame, return one of those frames.
1515 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1516 after resizing the tool-bar window. */
1518 int ignore_mouse_drag_p
;
1523 Lisp_Object tail
, frame
;
1525 if (ignore_mouse_drag_p
)
1527 /* ignore_mouse_drag_p = 0; */
1531 FOR_EACH_FRAME (tail
, frame
)
1533 if (XFRAME (frame
)->mouse_moved
)
1534 return XFRAME (frame
);
1540 #endif /* HAVE_MOUSE */
1542 /* This is the actual command reading loop,
1543 sans error-handling encapsulation. */
1545 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1547 void safe_run_hooks
P_ ((Lisp_Object
));
1548 static void adjust_point_for_property
P_ ((int, int));
1550 /* Cancel hourglass from protect_unwind.
1552 #ifdef HAVE_X_WINDOWS
1554 cancel_hourglass_unwind (arg
)
1557 cancel_hourglass ();
1568 Lisp_Object keybuf
[30];
1571 int prev_modiff
= 0;
1572 struct buffer
*prev_buffer
= NULL
;
1573 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1575 int was_locked
= single_kboard
;
1578 int already_adjusted
= 0;
1580 current_kboard
->Vprefix_arg
= Qnil
;
1581 current_kboard
->Vlast_prefix_arg
= Qnil
;
1582 Vdeactivate_mark
= Qnil
;
1583 waiting_for_input
= 0;
1587 this_command_key_count
= 0;
1588 this_command_key_count_reset
= 0;
1589 this_single_command_key_start
= 0;
1591 if (NILP (Vmemory_full
))
1593 /* Make sure this hook runs after commands that get errors and
1594 throw to top level. */
1595 /* Note that the value cell will never directly contain nil
1596 if the symbol is a local variable. */
1597 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1598 safe_run_hooks (Qpost_command_hook
);
1600 /* If displaying a message, resize the echo area window to fit
1601 that message's size exactly. */
1602 if (!NILP (echo_area_buffer
[0]))
1603 resize_echo_area_exactly ();
1605 if (!NILP (Vdeferred_action_list
))
1606 safe_run_hooks (Qdeferred_action_function
);
1609 /* Do this after running Vpost_command_hook, for consistency. */
1610 current_kboard
->Vlast_command
= Vthis_command
;
1611 current_kboard
->Vreal_last_command
= real_this_command
;
1615 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1618 /* Make sure the current window's buffer is selected. */
1619 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1620 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1622 /* Display any malloc warning that just came out. Use while because
1623 displaying one warning can cause another. */
1625 while (pending_malloc_warning
)
1626 display_malloc_warning ();
1630 Vdeactivate_mark
= Qnil
;
1632 /* If minibuffer on and echo area in use,
1633 wait a short time and redraw minibuffer. */
1636 && !NILP (echo_area_buffer
[0])
1637 && EQ (minibuf_window
, echo_area_window
))
1639 /* Bind inhibit-quit to t so that C-g gets read in
1640 rather than quitting back to the minibuffer. */
1641 int count
= SPECPDL_INDEX ();
1642 specbind (Qinhibit_quit
, Qt
);
1644 if (NUMBERP (Vminibuffer_message_timeout
))
1645 sit_for (Vminibuffer_message_timeout
, 0, 2);
1649 /* Clear the echo area. */
1651 safe_run_hooks (Qecho_area_clear_hook
);
1653 unbind_to (count
, Qnil
);
1655 /* If a C-g came in before, treat it as input now. */
1656 if (!NILP (Vquit_flag
))
1659 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1664 alloca (0); /* Cause a garbage collection now */
1665 /* Since we can free the most stuff here. */
1666 #endif /* C_ALLOCA */
1669 /* Select the frame that the last event came from. Usually,
1670 switch-frame events will take care of this, but if some lisp
1671 code swallows a switch-frame event, we'll fix things up here.
1672 Is this a good idea? */
1673 if (FRAMEP (internal_last_event_frame
)
1674 && !EQ (internal_last_event_frame
, selected_frame
))
1675 Fselect_frame (internal_last_event_frame
);
1677 /* If it has changed current-menubar from previous value,
1678 really recompute the menubar from the value. */
1679 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1680 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1681 call0 (Qrecompute_lucid_menubar
);
1683 before_command_key_count
= this_command_key_count
;
1684 before_command_echo_length
= echo_length ();
1686 Vthis_command
= Qnil
;
1687 real_this_command
= Qnil
;
1688 Vthis_original_command
= Qnil
;
1690 /* Read next key sequence; i gets its length. */
1691 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1694 /* A filter may have run while we were reading the input. */
1695 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1697 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1698 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1702 /* Now we have read a key sequence of length I,
1703 or else I is 0 and we found end of file. */
1705 if (i
== 0) /* End of file -- happens only in */
1706 return Qnil
; /* a kbd macro, at the end. */
1707 /* -1 means read_key_sequence got a menu that was rejected.
1708 Just loop around and read another command. */
1712 this_command_key_count
= 0;
1713 this_command_key_count_reset
= 0;
1714 this_single_command_key_start
= 0;
1718 last_command_char
= keybuf
[i
- 1];
1720 /* If the previous command tried to force a specific window-start,
1721 forget about that, in case this command moves point far away
1722 from that position. But also throw away beg_unchanged and
1723 end_unchanged information in that case, so that redisplay will
1724 update the whole window properly. */
1725 if (!NILP (XWINDOW (selected_window
)->force_start
))
1728 XWINDOW (selected_window
)->force_start
= Qnil
;
1729 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1730 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1733 cmd
= read_key_sequence_cmd
;
1734 if (!NILP (Vexecuting_kbd_macro
))
1736 if (!NILP (Vquit_flag
))
1738 Vexecuting_kbd_macro
= Qt
;
1739 QUIT
; /* Make some noise. */
1740 /* Will return since macro now empty. */
1744 /* Do redisplay processing after this command except in special
1745 cases identified below. */
1746 prev_buffer
= current_buffer
;
1747 prev_modiff
= MODIFF
;
1748 last_point_position
= PT
;
1749 last_point_position_window
= selected_window
;
1750 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1752 /* By default, we adjust point to a boundary of a region that
1753 has such a property that should be treated intangible
1754 (e.g. composition, display). But, some commands will set
1755 this variable differently. */
1756 Vdisable_point_adjustment
= Qnil
;
1758 /* Process filters and timers may have messed with deactivate-mark.
1759 reset it before we execute the command. */
1760 Vdeactivate_mark
= Qnil
;
1762 /* Remap command through active keymaps */
1763 Vthis_original_command
= cmd
;
1767 if (cmd1
= Fcommand_remapping (cmd
, Qnil
), !NILP (cmd1
))
1771 /* Execute the command. */
1773 Vthis_command
= cmd
;
1774 real_this_command
= cmd
;
1775 /* Note that the value cell will never directly contain nil
1776 if the symbol is a local variable. */
1777 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1778 safe_run_hooks (Qpre_command_hook
);
1780 already_adjusted
= 0;
1782 if (NILP (Vthis_command
))
1784 /* nil means key is undefined. */
1785 Lisp_Object keys
= Fvector (i
, keybuf
);
1786 keys
= Fkey_description (keys
, Qnil
);
1788 message_with_string ("%s is undefined", keys
, 0);
1789 current_kboard
->defining_kbd_macro
= Qnil
;
1790 update_mode_lines
= 1;
1791 current_kboard
->Vprefix_arg
= Qnil
;
1795 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1797 /* In case we jump to directly_done. */
1798 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1800 /* Recognize some common commands in common situations and
1801 do them directly. */
1802 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1804 struct Lisp_Char_Table
*dp
1805 = window_display_table (XWINDOW (selected_window
));
1806 lose
= FETCH_CHAR (PT_BYTE
);
1808 if (! NILP (Vpost_command_hook
))
1809 /* Put this before calling adjust_point_for_property
1810 so it will only get called once in any case. */
1812 if (current_buffer
== prev_buffer
1813 && last_point_position
!= PT
1814 && NILP (Vdisable_point_adjustment
)
1815 && NILP (Vglobal_disable_point_adjustment
))
1816 adjust_point_for_property (last_point_position
, 0);
1817 already_adjusted
= 1;
1818 if (PT
== last_point_position
+ 1
1820 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1821 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1822 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1823 && (lose
>= 0x20 && lose
< 0x7f)))
1824 : (lose
>= 0x20 && lose
< 0x7f))
1825 /* To extract the case of continuation on
1826 wide-column characters. */
1827 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1828 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1830 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1832 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1834 && !windows_or_buffers_changed
1835 && EQ (current_buffer
->selective_display
, Qnil
)
1836 && !detect_input_pending ()
1837 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1838 && NILP (Vexecuting_kbd_macro
))
1839 direct_output_forward_char (1);
1842 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1844 struct Lisp_Char_Table
*dp
1845 = window_display_table (XWINDOW (selected_window
));
1847 lose
= FETCH_CHAR (PT_BYTE
);
1848 if (! NILP (Vpost_command_hook
))
1850 if (current_buffer
== prev_buffer
1851 && last_point_position
!= PT
1852 && NILP (Vdisable_point_adjustment
)
1853 && NILP (Vglobal_disable_point_adjustment
))
1854 adjust_point_for_property (last_point_position
, 0);
1855 already_adjusted
= 1;
1856 if (PT
== last_point_position
- 1
1858 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1859 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1860 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1861 && (lose
>= 0x20 && lose
< 0x7f)))
1862 : (lose
>= 0x20 && lose
< 0x7f))
1863 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1865 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1867 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1869 && !windows_or_buffers_changed
1870 && EQ (current_buffer
->selective_display
, Qnil
)
1871 && !detect_input_pending ()
1872 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1873 && NILP (Vexecuting_kbd_macro
))
1874 direct_output_forward_char (-1);
1877 else if (EQ (Vthis_command
, Qself_insert_command
)
1878 /* Try this optimization only on char keystrokes. */
1879 && NATNUMP (last_command_char
)
1880 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1883 = translate_char (Vtranslation_table_for_input
,
1884 XFASTINT (last_command_char
), 0, 0, 0);
1886 if (NILP (Vexecuting_kbd_macro
)
1887 && !EQ (minibuf_window
, selected_window
))
1889 if (!nonundocount
|| nonundocount
>= 20)
1897 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1899 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1901 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1903 || MODIFF
<= SAVE_MODIFF
1904 || windows_or_buffers_changed
1905 || !EQ (current_buffer
->selective_display
, Qnil
)
1906 || detect_input_pending ()
1907 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1908 || !NILP (Vexecuting_kbd_macro
));
1910 value
= internal_self_insert (c
, 0);
1915 if (! NILP (Vpost_command_hook
))
1916 /* Put this before calling adjust_point_for_property
1917 so it will only get called once in any case. */
1920 /* VALUE == 1 when AFTER-CHANGE functions are
1921 installed which is the case most of the time
1922 because FONT-LOCK installs one. */
1923 if (!lose
&& !value
)
1924 direct_output_for_insert (c
);
1929 /* Here for a command that isn't executed directly */
1932 #ifdef HAVE_X_WINDOWS
1933 int scount
= SPECPDL_INDEX ();
1935 if (display_hourglass_p
1936 && NILP (Vexecuting_kbd_macro
))
1938 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1944 if (NILP (current_kboard
->Vprefix_arg
))
1946 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1948 #ifdef HAVE_X_WINDOWS
1949 /* Do not check display_hourglass_p here, because
1950 Fcommand_execute could change it, but we should cancel
1951 hourglass cursor anyway.
1952 But don't cancel the hourglass within a macro
1953 just because a command in the macro finishes. */
1954 if (NILP (Vexecuting_kbd_macro
))
1955 unbind_to (scount
, Qnil
);
1960 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1962 /* Note that the value cell will never directly contain nil
1963 if the symbol is a local variable. */
1964 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1965 safe_run_hooks (Qpost_command_hook
);
1967 /* If displaying a message, resize the echo area window to fit
1968 that message's size exactly. */
1969 if (!NILP (echo_area_buffer
[0]))
1970 resize_echo_area_exactly ();
1972 if (!NILP (Vdeferred_action_list
))
1973 safe_run_hooks (Qdeferred_action_function
);
1975 /* If there is a prefix argument,
1976 1) We don't want Vlast_command to be ``universal-argument''
1977 (that would be dumb), so don't set Vlast_command,
1978 2) we want to leave echoing on so that the prefix will be
1979 echoed as part of this key sequence, so don't call
1981 3) we want to leave this_command_key_count non-zero, so that
1982 read_char will realize that it is re-reading a character, and
1983 not echo it a second time.
1985 If the command didn't actually create a prefix arg,
1986 but is merely a frame event that is transparent to prefix args,
1987 then the above doesn't apply. */
1988 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1990 current_kboard
->Vlast_command
= Vthis_command
;
1991 current_kboard
->Vreal_last_command
= real_this_command
;
1993 this_command_key_count
= 0;
1994 this_command_key_count_reset
= 0;
1995 this_single_command_key_start
= 0;
1998 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
2000 /* Setting transient-mark-mode to `only' is a way of
2001 turning it on for just one command. */
2003 if (EQ (Vtransient_mark_mode
, Qidentity
))
2004 Vtransient_mark_mode
= Qnil
;
2005 if (EQ (Vtransient_mark_mode
, Qonly
))
2006 Vtransient_mark_mode
= Qidentity
;
2008 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
2010 /* We could also call `deactivate'mark'. */
2011 if (EQ (Vtransient_mark_mode
, Qlambda
))
2012 Vtransient_mark_mode
= Qnil
;
2015 current_buffer
->mark_active
= Qnil
;
2016 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
2019 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
2020 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
2025 if (current_buffer
== prev_buffer
2026 && last_point_position
!= PT
2027 && NILP (Vdisable_point_adjustment
)
2028 && NILP (Vglobal_disable_point_adjustment
)
2029 && !already_adjusted
)
2030 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
2032 /* Install chars successfully executed in kbd macro. */
2034 if (!NILP (current_kboard
->defining_kbd_macro
)
2035 && NILP (current_kboard
->Vprefix_arg
))
2036 finalize_kbd_macro_chars ();
2037 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2040 any_kboard_state ();
2046 extern Lisp_Object Qcomposition
, Qdisplay
;
2048 /* Adjust point to a boundary of a region that has such a property
2049 that should be treated intangible. For the moment, we check
2050 `composition', `display' and `invisible' properties.
2051 LAST_PT is the last position of point. */
2053 extern Lisp_Object Qafter_string
, Qbefore_string
;
2054 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2057 adjust_point_for_property (last_pt
, modified
)
2062 Lisp_Object val
, overlay
, tmp
;
2063 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2066 /* FIXME: cycling is probably not necessary because these properties
2067 can't be usefully combined anyway. */
2068 while (check_composition
|| check_display
|| check_invisible
)
2070 if (check_composition
2071 && PT
> BEGV
&& PT
< ZV
2072 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2073 && COMPOSITION_VALID_P (beg
, end
, val
)
2074 && beg
< PT
/* && end > PT <- It's always the case. */
2075 && (last_pt
<= beg
|| last_pt
>= end
))
2078 SET_PT (PT
< last_pt
? beg
: end
);
2079 check_display
= check_invisible
= 1;
2081 check_composition
= 0;
2083 && PT
> BEGV
&& PT
< ZV
2084 && !NILP (val
= get_char_property_and_overlay
2085 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2086 && display_prop_intangible_p (val
)
2087 && (!OVERLAYP (overlay
)
2088 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2089 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2090 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2091 && (beg
< PT
/* && end > PT <- It's always the case. */
2092 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2095 SET_PT (PT
< last_pt
2096 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2098 check_composition
= check_invisible
= 1;
2101 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2103 int inv
, ellipsis
= 0;
2106 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2108 && !NILP (val
= get_char_property_and_overlay
2109 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2110 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2112 ellipsis
= ellipsis
|| inv
> 1
2113 || (OVERLAYP (overlay
)
2114 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2115 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2116 tmp
= Fnext_single_char_property_change
2117 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2118 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2121 && !NILP (val
= get_char_property_and_overlay
2122 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2123 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2125 ellipsis
= ellipsis
|| inv
> 1
2126 || (OVERLAYP (overlay
)
2127 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2128 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2129 tmp
= Fprevious_single_char_property_change
2130 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2131 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2134 /* Move away from the inside area. */
2135 if (beg
< PT
&& end
> PT
)
2137 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2138 /* We haven't moved yet (so we don't need to fear
2139 infinite-looping) and we were outside the range
2140 before (so either end of the range still corresponds
2141 to a move in the right direction): pretend we moved
2142 less than we actually did, so that we still have
2143 more freedom below in choosing which end of the range
2145 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2146 /* We either have moved already or the last point
2147 was already in the range: we don't get to choose
2148 which end of the range we have to go to. */
2149 : (PT
< last_pt
? beg
: end
));
2150 check_composition
= check_display
= 1;
2152 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2153 the point to something other than its argument, due to
2154 point-motion hooks, intangibility, etc. */
2155 xassert (PT
== beg
|| PT
== end
);
2158 /* Pretend the area doesn't exist if the buffer is not
2160 if (!modified
&& !ellipsis
&& beg
< end
)
2162 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2163 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2164 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2165 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2166 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2167 /* We've already moved as far as we can. Trying to go
2168 to the other end would mean moving backwards and thus
2169 could lead to an infinite loop. */
2171 else if (val
= get_pos_property (make_number (PT
),
2173 TEXT_PROP_MEANS_INVISIBLE (val
)
2174 && (val
= get_pos_property
2175 (make_number (PT
== beg
? end
: beg
),
2177 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2178 (check_composition
= check_display
= 1,
2179 SET_PT (PT
== beg
? end
: beg
));
2182 check_invisible
= 0;
2186 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2189 safe_run_hooks_1 (hook
)
2192 if (NILP (Vrun_hooks
))
2194 return call1 (Vrun_hooks
, Vinhibit_quit
);
2197 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2200 safe_run_hooks_error (data
)
2203 Lisp_Object args
[3];
2204 args
[0] = build_string ("Error in %s: %s");
2205 args
[1] = Vinhibit_quit
;
2208 return Fset (Vinhibit_quit
, Qnil
);
2211 /* If we get an error while running the hook, cause the hook variable
2212 to be nil. Also inhibit quits, so that C-g won't cause the hook
2213 to mysteriously evaporate. */
2216 safe_run_hooks (hook
)
2219 int count
= SPECPDL_INDEX ();
2220 specbind (Qinhibit_quit
, hook
);
2222 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2224 unbind_to (count
, Qnil
);
2228 /* Number of seconds between polling for input. This is a Lisp
2229 variable that can be bound. */
2231 EMACS_INT polling_period
;
2233 /* Nonzero means polling for input is temporarily suppressed. */
2235 int poll_suppress_count
;
2237 /* Asynchronous timer for polling. */
2239 struct atimer
*poll_timer
;
2242 #ifdef POLL_FOR_INPUT
2244 /* Poll for input, so what we catch a C-g if it comes in. This
2245 function is called from x_make_frame_visible, see comment
2251 if (interrupt_input_blocked
== 0
2252 && !waiting_for_input
)
2253 read_avail_input (0);
2256 /* Timer callback function for poll_timer. TIMER is equal to
2260 poll_for_input (timer
)
2261 struct atimer
*timer
;
2263 if (poll_suppress_count
== 0)
2265 interrupt_input_pending
= 1;
2267 poll_for_input_1 ();
2271 #endif /* POLL_FOR_INPUT */
2273 /* Begin signals to poll for input, if they are appropriate.
2274 This function is called unconditionally from various places. */
2279 #ifdef POLL_FOR_INPUT
2280 /* XXX This condition was (read_socket_hook && !interrupt_input),
2281 but read_socket_hook is not global anymore. Let's pretend that
2283 if (!interrupt_input
)
2285 /* Turn alarm handling on unconditionally. It might have
2286 been turned off in process.c. */
2287 turn_on_atimers (1);
2289 /* If poll timer doesn't exist, are we need one with
2290 a different interval, start a new one. */
2291 if (poll_timer
== NULL
2292 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2294 EMACS_TIME interval
;
2297 cancel_atimer (poll_timer
);
2299 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2300 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2301 poll_for_input
, NULL
);
2304 /* Let the timer's callback function poll for input
2305 if this becomes zero. */
2306 --poll_suppress_count
;
2311 /* Nonzero if we are using polling to handle input asynchronously. */
2314 input_polling_used ()
2316 #ifdef POLL_FOR_INPUT
2317 /* XXX This condition was (read_socket_hook && !interrupt_input),
2318 but read_socket_hook is not global anymore. Let's pretend that
2320 return !interrupt_input
;
2326 /* Turn off polling. */
2331 #ifdef POLL_FOR_INPUT
2332 /* XXX This condition was (read_socket_hook && !interrupt_input),
2333 but read_socket_hook is not global anymore. Let's pretend that
2335 if (!interrupt_input
)
2336 ++poll_suppress_count
;
2340 /* Set the value of poll_suppress_count to COUNT
2341 and start or stop polling accordingly. */
2344 set_poll_suppress_count (count
)
2347 #ifdef POLL_FOR_INPUT
2348 if (count
== 0 && poll_suppress_count
!= 0)
2350 poll_suppress_count
= 1;
2353 else if (count
!= 0 && poll_suppress_count
== 0)
2357 poll_suppress_count
= count
;
2361 /* Bind polling_period to a value at least N.
2362 But don't decrease it. */
2365 bind_polling_period (n
)
2368 #ifdef POLL_FOR_INPUT
2369 int new = polling_period
;
2374 stop_other_atimers (poll_timer
);
2376 specbind (Qpolling_period
, make_number (new));
2377 /* Start a new alarm with the new period. */
2382 /* Apply the control modifier to CHARACTER. */
2388 /* Save the upper bits here. */
2389 int upper
= c
& ~0177;
2393 /* Everything in the columns containing the upper-case letters
2394 denotes a control character. */
2395 if (c
>= 0100 && c
< 0140)
2399 /* Set the shift modifier for a control char
2400 made from a shifted letter. But only for letters! */
2401 if (oc
>= 'A' && oc
<= 'Z')
2402 c
|= shift_modifier
;
2405 /* The lower-case letters denote control characters too. */
2406 else if (c
>= 'a' && c
<= 'z')
2409 /* Include the bits for control and shift
2410 only if the basic ASCII code can't indicate them. */
2414 /* Replace the high bits. */
2415 c
|= (upper
& ~ctrl_modifier
);
2420 /* Display the help-echo property of the character after the mouse pointer.
2421 Either show it in the echo area, or call show-help-function to display
2422 it by other means (maybe in a tooltip).
2424 If HELP is nil, that means clear the previous help echo.
2426 If HELP is a string, display that string. If HELP is a function,
2427 call it with OBJECT and POS as arguments; the function should
2428 return a help string or nil for none. For all other types of HELP,
2429 evaluate it to obtain a string.
2431 WINDOW is the window in which the help was generated, if any.
2432 It is nil if not in a window.
2434 If OBJECT is a buffer, POS is the position in the buffer where the
2435 `help-echo' text property was found.
2437 If OBJECT is an overlay, that overlay has a `help-echo' property,
2438 and POS is the position in the overlay's buffer under the mouse.
2440 If OBJECT is a string (an overlay string or a string displayed with
2441 the `display' property). POS is the position in that string under
2444 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2445 echo overwrites a keystroke echo currently displayed in the echo
2448 Note: this function may only be called with HELP nil or a string
2449 from X code running asynchronously. */
2452 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2453 Lisp_Object help
, window
, object
, pos
;
2454 int ok_to_overwrite_keystroke_echo
;
2456 if (!NILP (help
) && !STRINGP (help
))
2458 if (FUNCTIONP (help
))
2460 Lisp_Object args
[4];
2465 help
= safe_call (4, args
);
2468 help
= safe_eval (help
);
2470 if (!STRINGP (help
))
2475 if (!noninteractive
&& STRINGP (help
))
2477 /* The mouse-fixup-help-message Lisp function can call
2478 mouse_position_hook, which resets the mouse_moved flags.
2479 This causes trouble if we are trying to read a mouse motion
2480 event (i.e., if we are inside a `track-mouse' form), so we
2481 restore the mouse_moved flag. */
2482 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2483 help
= call1 (Qmouse_fixup_help_message
, help
);
2489 if (STRINGP (help
) || NILP (help
))
2491 if (!NILP (Vshow_help_function
))
2492 call1 (Vshow_help_function
, help
);
2493 else if (/* Don't overwrite minibuffer contents. */
2494 !MINI_WINDOW_P (XWINDOW (selected_window
))
2495 /* Don't overwrite a keystroke echo. */
2496 && (NILP (echo_message_buffer
)
2497 || ok_to_overwrite_keystroke_echo
)
2498 /* Don't overwrite a prompt. */
2499 && !cursor_in_echo_area
)
2503 int count
= SPECPDL_INDEX ();
2505 if (!help_echo_showing_p
)
2506 Vpre_help_message
= current_message ();
2508 specbind (Qmessage_truncate_lines
, Qt
);
2509 message3_nolog (help
, SBYTES (help
),
2510 STRING_MULTIBYTE (help
));
2511 unbind_to (count
, Qnil
);
2513 else if (STRINGP (Vpre_help_message
))
2515 message3_nolog (Vpre_help_message
,
2516 SBYTES (Vpre_help_message
),
2517 STRING_MULTIBYTE (Vpre_help_message
));
2518 Vpre_help_message
= Qnil
;
2524 help_echo_showing_p
= STRINGP (help
);
2530 /* Input of single characters from keyboard */
2532 Lisp_Object
print_help ();
2533 static Lisp_Object
kbd_buffer_get_event ();
2534 static void record_char ();
2536 #define STOP_POLLING \
2537 do { if (! polling_stopped_here) stop_polling (); \
2538 polling_stopped_here = 1; } while (0)
2540 #define RESUME_POLLING \
2541 do { if (polling_stopped_here) start_polling (); \
2542 polling_stopped_here = 0; } while (0)
2544 /* read a character from the keyboard; call the redisplay if needed */
2545 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2546 -1 means do not do redisplay, but do do autosaving.
2549 /* The arguments MAPS and NMAPS are for menu prompting.
2550 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2552 PREV_EVENT is the previous input event, or nil if we are reading
2553 the first event of a key sequence (or not reading a key sequence).
2554 If PREV_EVENT is t, that is a "magic" value that says
2555 not to run input methods, but in other respects to act as if
2556 not reading a key sequence.
2558 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2559 if we used a mouse menu to read the input, or zero otherwise. If
2560 USED_MOUSE_MENU is null, we don't dereference it.
2562 Value is -2 when we find input on another keyboard. A second call
2563 to read_char will read it.
2565 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2566 specifying the maximum time to wait until. If no input arrives by
2567 that time, stop waiting and return nil.
2569 Value is t if we showed a menu and the user rejected it. */
2572 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2576 Lisp_Object prev_event
;
2577 int *used_mouse_menu
;
2578 EMACS_TIME
*end_time
;
2580 volatile Lisp_Object c
;
2581 int count
, jmpcount
;
2582 jmp_buf local_getcjmp
;
2584 volatile int key_already_recorded
= 0;
2585 Lisp_Object tem
, save
;
2586 volatile Lisp_Object previous_echo_area_message
;
2587 volatile Lisp_Object also_record
;
2588 volatile int reread
;
2589 struct gcpro gcpro1
, gcpro2
;
2590 int polling_stopped_here
= 0;
2591 struct kboard
*orig_kboard
= current_kboard
;
2595 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2596 before_command_key_count
= this_command_key_count
;
2597 before_command_echo_length
= echo_length ();
2600 previous_echo_area_message
= Qnil
;
2602 GCPRO2 (c
, previous_echo_area_message
);
2607 if (CONSP (Vunread_post_input_method_events
))
2609 c
= XCAR (Vunread_post_input_method_events
);
2610 Vunread_post_input_method_events
2611 = XCDR (Vunread_post_input_method_events
);
2613 /* Undo what read_char_x_menu_prompt did when it unread
2614 additional keys returned by Fx_popup_menu. */
2616 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2624 if (unread_command_char
!= -1)
2626 XSETINT (c
, unread_command_char
);
2627 unread_command_char
= -1;
2633 if (CONSP (Vunread_command_events
))
2635 c
= XCAR (Vunread_command_events
);
2636 Vunread_command_events
= XCDR (Vunread_command_events
);
2640 /* Undo what sit-for did when it unread additional keys
2641 inside universal-argument. */
2644 && EQ (XCAR (c
), Qt
))
2650 /* Undo what read_char_x_menu_prompt did when it unread
2651 additional keys returned by Fx_popup_menu. */
2653 && EQ (XCDR (c
), Qdisabled
)
2654 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2657 /* If the queued event is something that used the mouse,
2658 set used_mouse_menu accordingly. */
2660 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2661 *used_mouse_menu
= 1;
2663 goto reread_for_input_method
;
2666 if (CONSP (Vunread_input_method_events
))
2668 c
= XCAR (Vunread_input_method_events
);
2669 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2671 /* Undo what read_char_x_menu_prompt did when it unread
2672 additional keys returned by Fx_popup_menu. */
2674 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2678 goto reread_for_input_method
;
2681 this_command_key_count_reset
= 0;
2683 if (!NILP (Vexecuting_kbd_macro
))
2685 /* We set this to Qmacro; since that's not a frame, nobody will
2686 try to switch frames on us, and the selected window will
2689 Since this event came from a macro, it would be misleading to
2690 leave internal_last_event_frame set to wherever the last
2691 real event came from. Normally, a switch-frame event selects
2692 internal_last_event_frame after each command is read, but
2693 events read from a macro should never cause a new frame to be
2695 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2697 /* Exit the macro if we are at the end.
2698 Also, some things replace the macro with t
2699 to force an early exit. */
2700 if (EQ (Vexecuting_kbd_macro
, Qt
)
2701 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2707 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2708 if (STRINGP (Vexecuting_kbd_macro
)
2709 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2710 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2712 executing_kbd_macro_index
++;
2717 if (!NILP (unread_switch_frame
))
2719 c
= unread_switch_frame
;
2720 unread_switch_frame
= Qnil
;
2722 /* This event should make it into this_command_keys, and get echoed
2723 again, so we do not set `reread'. */
2727 /* if redisplay was requested */
2728 if (commandflag
>= 0)
2730 /* If there is pending input, process any events which are not
2731 user-visible, such as X selection_request events. */
2733 || detect_input_pending_run_timers (0))
2734 swallow_events (0); /* may clear input_pending */
2736 /* Redisplay if no pending input. */
2737 while (!input_pending
)
2739 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2740 redisplay_preserve_echo_area (5);
2745 /* Normal case: no input arrived during redisplay. */
2748 /* Input arrived and pre-empted redisplay.
2749 Process any events which are not user-visible. */
2751 /* If that cleared input_pending, try again to redisplay. */
2755 /* Message turns off echoing unless more keystrokes turn it on again.
2757 The code in 20.x for the condition was
2759 1. echo_area_glyphs && *echo_area_glyphs
2760 2. && echo_area_glyphs != current_kboard->echobuf
2761 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2763 (1) means there's a current message displayed
2765 (2) means it's not the message from echoing from the current
2768 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2769 is set to a non-null value. This is done in read_char and it is
2770 set to echo_area_glyphs after a call to echo_char. That means
2771 ok_to_echo_at_next_pause is either null or
2772 current_kboard->echobuf with the appropriate current_kboard at
2775 So, condition (3) means in clear text ok_to_echo_at_next_pause
2776 must be either null, or the current message isn't from echoing at
2777 all, or it's from echoing from a different kboard than the
2780 if (/* There currently is something in the echo area. */
2781 !NILP (echo_area_buffer
[0])
2782 && (/* And it's either not from echoing. */
2783 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2784 /* Or it's an echo from a different kboard. */
2785 || echo_kboard
!= current_kboard
2786 /* Or we explicitly allow overwriting whatever there is. */
2787 || ok_to_echo_at_next_pause
== NULL
))
2792 /* Try reading a character via menu prompting in the minibuf.
2793 Try this before the sit-for, because the sit-for
2794 would do the wrong thing if we are supposed to do
2795 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2796 after a mouse event so don't try a minibuf menu. */
2798 if (nmaps
> 0 && INTERACTIVE
2799 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2800 /* Don't bring up a menu if we already have another event. */
2801 && NILP (Vunread_command_events
)
2802 && unread_command_char
< 0
2803 && !detect_input_pending_run_timers (0))
2805 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2807 if (INTEGERP (c
) && XINT (c
) == -2)
2808 return c
; /* wrong_kboard_jmpbuf */
2812 key_already_recorded
= 1;
2817 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2818 We will do that below, temporarily for short sections of code,
2819 when appropriate. local_getcjmp must be in effect
2820 around any call to sit_for or kbd_buffer_get_event;
2821 it *must not* be in effect when we call redisplay. */
2823 jmpcount
= SPECPDL_INDEX ();
2824 if (_setjmp (local_getcjmp
))
2826 /* Handle quits while reading the keyboard. */
2827 /* We must have saved the outer value of getcjmp here,
2828 so restore it now. */
2829 restore_getcjmp (save_jump
);
2830 unbind_to (jmpcount
, Qnil
);
2831 XSETINT (c
, quit_char
);
2832 internal_last_event_frame
= selected_frame
;
2833 Vlast_event_frame
= internal_last_event_frame
;
2834 /* If we report the quit char as an event,
2835 don't do so more than once. */
2836 if (!NILP (Vinhibit_quit
))
2841 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2842 if (kb
!= current_kboard
)
2844 Lisp_Object link
= kb
->kbd_queue
;
2845 /* We shouldn't get here if we were in single-kboard mode! */
2850 while (CONSP (XCDR (link
)))
2852 if (!NILP (XCDR (link
)))
2856 kb
->kbd_queue
= Fcons (c
, Qnil
);
2858 XSETCDR (link
, Fcons (c
, Qnil
));
2859 kb
->kbd_queue_has_data
= 1;
2860 current_kboard
= kb
;
2861 /* This is going to exit from read_char
2862 so we had better get rid of this frame's stuff. */
2864 return make_number (-2); /* wrong_kboard_jmpbuf */
2871 /* Start idle timers if no time limit is supplied. We don't do it
2872 if a time limit is supplied to avoid an infinite recursion in the
2873 situation where an idle timer calls `sit-for'. */
2876 timer_start_idle ();
2878 /* If in middle of key sequence and minibuffer not active,
2879 start echoing if enough time elapses. */
2881 if (minibuf_level
== 0
2883 && !current_kboard
->immediate_echo
2884 && this_command_key_count
> 0
2886 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2887 && NILP (Fzerop (Vecho_keystrokes
))
2888 && (/* No message. */
2889 NILP (echo_area_buffer
[0])
2890 /* Or empty message. */
2891 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2892 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2893 /* Or already echoing from same kboard. */
2894 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2895 /* Or not echoing before and echoing allowed. */
2896 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2898 /* After a mouse event, start echoing right away.
2899 This is because we are probably about to display a menu,
2900 and we don't want to delay before doing so. */
2901 if (EVENT_HAS_PARAMETERS (prev_event
))
2907 save_getcjmp (save_jump
);
2908 restore_getcjmp (local_getcjmp
);
2909 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2910 restore_getcjmp (save_jump
);
2912 && ! CONSP (Vunread_command_events
))
2917 /* Maybe auto save due to number of keystrokes. */
2919 if (commandflag
!= 0
2920 && auto_save_interval
> 0
2921 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2922 && !detect_input_pending_run_timers (0))
2924 Fdo_auto_save (Qnil
, Qnil
);
2925 /* Hooks can actually change some buffers in auto save. */
2929 /* Try reading using an X menu.
2930 This is never confused with reading using the minibuf
2931 because the recursive call of read_char in read_char_minibuf_menu_prompt
2932 does not pass on any keymaps. */
2934 if (nmaps
> 0 && INTERACTIVE
2935 && !NILP (prev_event
)
2936 && EVENT_HAS_PARAMETERS (prev_event
)
2937 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2938 && !EQ (XCAR (prev_event
), Qtool_bar
)
2939 /* Don't bring up a menu if we already have another event. */
2940 && NILP (Vunread_command_events
)
2941 && unread_command_char
< 0)
2943 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2945 /* Now that we have read an event, Emacs is not idle. */
2952 /* Maybe autosave and/or garbage collect due to idleness. */
2954 if (INTERACTIVE
&& NILP (c
))
2956 int delay_level
, buffer_size
;
2958 /* Slow down auto saves logarithmically in size of current buffer,
2959 and garbage collect while we're at it. */
2960 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2961 last_non_minibuf_size
= Z
- BEG
;
2962 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2964 while (buffer_size
> 64)
2965 delay_level
++, buffer_size
-= buffer_size
>> 2;
2966 if (delay_level
< 4) delay_level
= 4;
2967 /* delay_level is 4 for files under around 50k, 7 at 100k,
2968 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2970 /* Auto save if enough time goes by without input. */
2971 if (commandflag
!= 0
2972 && num_nonmacro_input_events
> last_auto_save
2973 && INTEGERP (Vauto_save_timeout
)
2974 && XINT (Vauto_save_timeout
) > 0)
2977 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2979 save_getcjmp (save_jump
);
2980 restore_getcjmp (local_getcjmp
);
2981 tem0
= sit_for (make_number (timeout
), 1, 1);
2982 restore_getcjmp (save_jump
);
2985 && ! CONSP (Vunread_command_events
))
2987 Fdo_auto_save (Qnil
, Qnil
);
2989 /* If we have auto-saved and there is still no input
2990 available, garbage collect if there has been enough
2991 consing going on to make it worthwhile. */
2992 if (!detect_input_pending_run_timers (0)
2993 && consing_since_gc
> gc_cons_threshold
/ 2)
2994 Fgarbage_collect ();
3001 /* Notify the caller if an autosave hook, or a timer, sentinel or
3002 filter in the sit_for calls above have changed the current
3003 kboard. This could happen if they use the minibuffer or start a
3004 recursive edit, like the fancy splash screen in server.el's
3005 filter. If this longjmp wasn't here, read_key_sequence would
3006 interpret the next key sequence using the wrong translation
3007 tables and function keymaps. */
3008 if (NILP (c
) && current_kboard
!= orig_kboard
)
3011 return make_number (-2); /* wrong_kboard_jmpbuf */
3014 /* If this has become non-nil here, it has been set by a timer
3015 or sentinel or filter. */
3016 if (CONSP (Vunread_command_events
))
3018 c
= XCAR (Vunread_command_events
);
3019 Vunread_command_events
= XCDR (Vunread_command_events
);
3022 /* Read something from current KBOARD's side queue, if possible. */
3026 if (current_kboard
->kbd_queue_has_data
)
3028 if (!CONSP (current_kboard
->kbd_queue
))
3030 c
= XCAR (current_kboard
->kbd_queue
);
3031 current_kboard
->kbd_queue
3032 = XCDR (current_kboard
->kbd_queue
);
3033 if (NILP (current_kboard
->kbd_queue
))
3034 current_kboard
->kbd_queue_has_data
= 0;
3035 input_pending
= readable_events (0);
3036 if (EVENT_HAS_PARAMETERS (c
)
3037 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
3038 internal_last_event_frame
= XCAR (XCDR (c
));
3039 Vlast_event_frame
= internal_last_event_frame
;
3044 /* If current_kboard's side queue is empty check the other kboards.
3045 If one of them has data that we have not yet seen here,
3046 switch to it and process the data waiting for it.
3048 Note: if the events queued up for another kboard
3049 have already been seen here, and therefore are not a complete command,
3050 the kbd_queue_has_data field is 0, so we skip that kboard here.
3051 That's to avoid an infinite loop switching between kboards here. */
3052 if (NILP (c
) && !single_kboard
)
3055 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3056 if (kb
->kbd_queue_has_data
)
3058 current_kboard
= kb
;
3059 /* This is going to exit from read_char
3060 so we had better get rid of this frame's stuff. */
3062 return make_number (-2); /* wrong_kboard_jmpbuf */
3071 /* Finally, we read from the main queue,
3072 and if that gives us something we can't use yet, we put it on the
3073 appropriate side queue and try again. */
3082 EMACS_GET_TIME (now
);
3083 if (EMACS_TIME_GE (now
, *end_time
))
3087 /* Actually read a character, waiting if necessary. */
3088 save_getcjmp (save_jump
);
3089 restore_getcjmp (local_getcjmp
);
3091 timer_start_idle ();
3092 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3093 restore_getcjmp (save_jump
);
3096 if (! NILP (c
) && (kb
!= current_kboard
))
3098 Lisp_Object link
= kb
->kbd_queue
;
3101 while (CONSP (XCDR (link
)))
3103 if (!NILP (XCDR (link
)))
3107 kb
->kbd_queue
= Fcons (c
, Qnil
);
3109 XSETCDR (link
, Fcons (c
, Qnil
));
3110 kb
->kbd_queue_has_data
= 1;
3114 current_kboard
= kb
;
3115 /* This is going to exit from read_char
3116 so we had better get rid of this frame's stuff. */
3118 return make_number (-2);
3123 /* Terminate Emacs in batch mode if at eof. */
3124 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3125 Fkill_emacs (make_number (1));
3129 /* Add in any extra modifiers, where appropriate. */
3130 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3131 || ((extra_keyboard_modifiers
& 0177) < ' '
3132 && (extra_keyboard_modifiers
& 0177) != 0))
3133 XSETINT (c
, make_ctrl_char (XINT (c
)));
3135 /* Transfer any other modifier bits directly from
3136 extra_keyboard_modifiers to c. Ignore the actual character code
3137 in the low 16 bits of extra_keyboard_modifiers. */
3138 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3149 if (commandflag
>= 0
3150 && !input_pending
&& !detect_input_pending_run_timers (0))
3158 /* Buffer switch events are only for internal wakeups
3159 so don't show them to the user.
3160 Also, don't record a key if we already did. */
3161 if (BUFFERP (c
) || key_already_recorded
)
3164 /* Process special events within read_char
3165 and loop around to read another event. */
3168 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3173 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3174 int was_locked
= single_kboard
;
3175 int count
= SPECPDL_INDEX ();
3176 record_single_kboard_state ();
3179 last_input_char
= c
;
3180 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3182 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3183 /* We stopped being idle for this event; undo that. This
3184 prevents automatic window selection (under
3185 mouse_autoselect_window from acting as a real input event, for
3186 example banishing the mouse under mouse-avoidance-mode. */
3187 timer_resume_idle ();
3189 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3190 /* Resume allowing input from any kboard, if that was true before. */
3192 any_kboard_state ();
3193 unbind_to (count
, Qnil
);
3199 /* Handle things that only apply to characters. */
3202 /* If kbd_buffer_get_event gave us an EOF, return that. */
3206 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3207 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3208 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3209 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3210 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3211 && CHAR_VALID_P (XINT (c
), 0)))
3214 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3215 /* nil in keyboard-translate-table means no translation. */
3221 /* If this event is a mouse click in the menu bar,
3222 return just menu-bar for now. Modify the mouse click event
3223 so we won't do this twice, then queue it up. */
3224 if (EVENT_HAS_PARAMETERS (c
)
3226 && CONSP (EVENT_START (c
))
3227 && CONSP (XCDR (EVENT_START (c
))))
3231 posn
= POSN_POSN (EVENT_START (c
));
3232 /* Handle menu-bar events:
3233 insert the dummy prefix event `menu-bar'. */
3234 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3236 /* Change menu-bar to (menu-bar) as the event "position". */
3237 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3240 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3245 /* Store these characters into recent_keys, the dribble file if any,
3246 and the keyboard macro being defined, if any. */
3248 if (! NILP (also_record
))
3249 record_char (also_record
);
3251 /* Wipe the echo area.
3252 But first, if we are about to use an input method,
3253 save the echo area contents for it to refer to. */
3255 && ! NILP (Vinput_method_function
)
3256 && (unsigned) XINT (c
) >= ' '
3257 && (unsigned) XINT (c
) != 127
3258 && (unsigned) XINT (c
) < 256)
3260 previous_echo_area_message
= Fcurrent_message ();
3261 Vinput_method_previous_message
= previous_echo_area_message
;
3264 /* Now wipe the echo area, except for help events which do their
3265 own stuff with the echo area. */
3267 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3268 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3270 if (!NILP (echo_area_buffer
[0]))
3271 safe_run_hooks (Qecho_area_clear_hook
);
3272 clear_message (1, 0);
3275 reread_for_input_method
:
3277 /* Pass this to the input method, if appropriate. */
3279 && ! NILP (Vinput_method_function
)
3280 /* Don't run the input method within a key sequence,
3281 after the first event of the key sequence. */
3282 && NILP (prev_event
)
3283 && (unsigned) XINT (c
) >= ' '
3284 && (unsigned) XINT (c
) != 127
3285 && (unsigned) XINT (c
) < 256)
3288 int key_count
, key_count_reset
;
3289 struct gcpro gcpro1
;
3290 int count
= SPECPDL_INDEX ();
3292 /* Save the echo status. */
3293 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3294 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3295 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3296 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3299 if (before_command_restore_flag
)
3301 this_command_key_count
= before_command_key_count_1
;
3302 if (this_command_key_count
< this_single_command_key_start
)
3303 this_single_command_key_start
= this_command_key_count
;
3304 echo_truncate (before_command_echo_length_1
);
3305 before_command_restore_flag
= 0;
3309 /* Save the this_command_keys status. */
3310 key_count
= this_command_key_count
;
3311 key_count_reset
= this_command_key_count_reset
;
3314 keys
= Fcopy_sequence (this_command_keys
);
3319 /* Clear out this_command_keys. */
3320 this_command_key_count
= 0;
3321 this_command_key_count_reset
= 0;
3323 /* Now wipe the echo area. */
3324 if (!NILP (echo_area_buffer
[0]))
3325 safe_run_hooks (Qecho_area_clear_hook
);
3326 clear_message (1, 0);
3329 /* If we are not reading a key sequence,
3330 never use the echo area. */
3333 specbind (Qinput_method_use_echo_area
, Qt
);
3336 /* Call the input method. */
3337 tem
= call1 (Vinput_method_function
, c
);
3339 tem
= unbind_to (count
, tem
);
3341 /* Restore the saved echoing state
3342 and this_command_keys state. */
3343 this_command_key_count
= key_count
;
3344 this_command_key_count_reset
= key_count_reset
;
3346 this_command_keys
= keys
;
3349 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3350 current_kboard
->echo_string
= saved_echo_string
;
3351 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3352 if (saved_immediate_echo
)
3357 /* The input method can return no events. */
3360 /* Bring back the previous message, if any. */
3361 if (! NILP (previous_echo_area_message
))
3362 message_with_string ("%s", previous_echo_area_message
, 0);
3365 /* It returned one event or more. */
3367 Vunread_post_input_method_events
3368 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3373 /* Display help if not echoing. */
3374 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3376 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3377 Lisp_Object help
, object
, position
, window
, tem
;
3379 tem
= Fcdr (XCDR (c
));
3382 window
= Fcar (tem
);
3384 object
= Fcar (tem
);
3386 position
= Fcar (tem
);
3388 show_help_echo (help
, window
, object
, position
, 0);
3390 /* We stopped being idle for this event; undo that. */
3392 timer_resume_idle ();
3396 if ((! reread
|| this_command_key_count
== 0
3397 || this_command_key_count_reset
)
3401 /* Don't echo mouse motion events. */
3402 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3403 && NILP (Fzerop (Vecho_keystrokes
))
3404 && ! (EVENT_HAS_PARAMETERS (c
)
3405 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3408 if (! NILP (also_record
))
3409 echo_char (also_record
);
3410 /* Once we reread a character, echoing can happen
3411 the next time we pause to read a new one. */
3412 ok_to_echo_at_next_pause
= current_kboard
;
3415 /* Record this character as part of the current key. */
3416 add_command_key (c
);
3417 if (! NILP (also_record
))
3418 add_command_key (also_record
);
3421 last_input_char
= c
;
3424 /* Process the help character specially if enabled */
3425 if (!NILP (Vhelp_form
) && help_char_p (c
))
3428 count
= SPECPDL_INDEX ();
3430 record_unwind_protect (Fset_window_configuration
,
3431 Fcurrent_window_configuration (Qnil
));
3433 tem0
= Feval (Vhelp_form
);
3435 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3439 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3440 while (BUFFERP (c
));
3441 /* Remove the help from the frame */
3442 unbind_to (count
, Qnil
);
3445 if (EQ (c
, make_number (040)))
3449 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3450 while (BUFFERP (c
));
3459 /* Record a key that came from a mouse menu.
3460 Record it for echoing, for this-command-keys, and so on. */
3466 /* Wipe the echo area. */
3467 clear_message (1, 0);
3472 before_command_key_count
= this_command_key_count
;
3473 before_command_echo_length
= echo_length ();
3476 /* Don't echo mouse motion events. */
3477 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3478 && NILP (Fzerop (Vecho_keystrokes
)))
3482 /* Once we reread a character, echoing can happen
3483 the next time we pause to read a new one. */
3484 ok_to_echo_at_next_pause
= 0;
3487 /* Record this character as part of the current key. */
3488 add_command_key (c
);
3490 /* Re-reading in the middle of a command */
3491 last_input_char
= c
;
3495 /* Return 1 if should recognize C as "the help character". */
3503 if (EQ (c
, Vhelp_char
))
3505 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3506 if (EQ (c
, XCAR (tail
)))
3511 /* Record the input event C in various ways. */
3519 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3521 /* To avoid filling recent_keys with help-echo and mouse-movement
3522 events, we filter out repeated help-echo events, only store the
3523 first and last in a series of mouse-movement events, and don't
3524 store repeated help-echo events which are only separated by
3525 mouse-movement events. */
3527 Lisp_Object ev1
, ev2
, ev3
;
3530 if ((ix1
= recent_keys_index
- 1) < 0)
3531 ix1
= NUM_RECENT_KEYS
- 1;
3532 ev1
= AREF (recent_keys
, ix1
);
3534 if ((ix2
= ix1
- 1) < 0)
3535 ix2
= NUM_RECENT_KEYS
- 1;
3536 ev2
= AREF (recent_keys
, ix2
);
3538 if ((ix3
= ix2
- 1) < 0)
3539 ix3
= NUM_RECENT_KEYS
- 1;
3540 ev3
= AREF (recent_keys
, ix3
);
3542 if (EQ (XCAR (c
), Qhelp_echo
))
3544 /* Don't record `help-echo' in recent_keys unless it shows some help
3545 message, and a different help than the previously recorded
3547 Lisp_Object help
, last_help
;
3549 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3550 if (!STRINGP (help
))
3552 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3553 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3555 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3556 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3557 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3559 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3560 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3561 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3562 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3565 else if (EQ (XCAR (c
), Qmouse_movement
))
3567 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3568 So additional mouse movement events replace the last element. */
3569 Lisp_Object last_window
, window
;
3571 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3572 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3573 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3574 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3575 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3577 ASET (recent_keys
, ix1
, c
);
3583 store_kbd_macro_char (c
);
3588 ASET (recent_keys
, recent_keys_index
, c
);
3589 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3590 recent_keys_index
= 0;
3592 else if (recorded
< 0)
3594 /* We need to remove one or two events from recent_keys.
3595 To do this, we simply put nil at those events and move the
3596 recent_keys_index backwards over those events. Usually,
3597 users will never see those nil events, as they will be
3598 overwritten by the command keys entered to see recent_keys
3601 while (recorded
++ < 0 && total_keys
> 0)
3603 if (total_keys
< NUM_RECENT_KEYS
)
3605 if (--recent_keys_index
< 0)
3606 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3607 ASET (recent_keys
, recent_keys_index
, Qnil
);
3611 num_nonmacro_input_events
++;
3613 /* Write c to the dribble file. If c is a lispy event, write
3614 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3615 If you, dear reader, have a better idea, you've got the source. :-) */
3620 if (XUINT (c
) < 0x100)
3621 putc (XINT (c
), dribble
);
3623 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3627 Lisp_Object dribblee
;
3629 /* If it's a structured event, take the event header. */
3630 dribblee
= EVENT_HEAD (c
);
3632 if (SYMBOLP (dribblee
))
3634 putc ('<', dribble
);
3635 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3636 SBYTES (SYMBOL_NAME (dribblee
)),
3638 putc ('>', dribble
);
3650 struct buffer
*old
= current_buffer
;
3651 Fprinc (object
, Qnil
);
3652 set_buffer_internal (XBUFFER (Vstandard_output
));
3653 call0 (intern ("help-mode"));
3654 set_buffer_internal (old
);
3658 /* Copy out or in the info on where C-g should throw to.
3659 This is used when running Lisp code from within get_char,
3660 in case get_char is called recursively.
3661 See read_process_output. */
3667 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3671 restore_getcjmp (temp
)
3674 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3677 /* Low level keyboard/mouse input.
3678 kbd_buffer_store_event places events in kbd_buffer, and
3679 kbd_buffer_get_event retrieves them. */
3681 /* Return true iff there are any events in the queue that read-char
3682 would return. If this returns false, a read-char would block. */
3684 readable_events (flags
)
3687 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3690 /* If the buffer contains only FOCUS_IN_EVENT events, and
3691 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3692 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3694 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3695 #ifdef USE_TOOLKIT_SCROLL_BARS
3696 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3700 struct input_event
*event
;
3702 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3709 #ifdef USE_TOOLKIT_SCROLL_BARS
3710 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3712 event
->kind
== FOCUS_IN_EVENT
)
3713 #ifdef USE_TOOLKIT_SCROLL_BARS
3714 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3715 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3716 && event
->part
== scroll_bar_handle
3717 && event
->modifiers
== 0)
3722 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3725 while (event
!= kbd_store_ptr
);
3732 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3733 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3738 if (current_kboard
->kbd_queue_has_data
)
3744 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3745 if (kb
->kbd_queue_has_data
)
3751 /* Set this for debugging, to have a way to get out */
3756 event_to_kboard (event
)
3757 struct input_event
*event
;
3760 frame
= event
->frame_or_window
;
3762 frame
= XCAR (frame
);
3763 else if (WINDOWP (frame
))
3764 frame
= WINDOW_FRAME (XWINDOW (frame
));
3766 /* There are still some events that don't set this field.
3767 For now, just ignore the problem.
3768 Also ignore dead frames here. */
3769 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3772 return FRAME_KBOARD (XFRAME (frame
));
3777 Lisp_Object Vthrow_on_input
;
3779 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3782 kbd_buffer_store_event (event
)
3783 register struct input_event
*event
;
3785 kbd_buffer_store_event_hold (event
, 0);
3788 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3790 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3791 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3792 Else, if EVENT is a quit event, store the quit event
3793 in HOLD_QUIT, and return (thus ignoring further events).
3795 This is used in read_avail_input to postpone the processing
3796 of the quit event until all subsequent input events have been
3797 parsed (and discarded).
3801 kbd_buffer_store_event_hold (event
, hold_quit
)
3802 register struct input_event
*event
;
3803 struct input_event
*hold_quit
;
3805 if (event
->kind
== NO_EVENT
)
3808 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3811 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3813 register int c
= event
->code
& 0377;
3815 if (event
->modifiers
& ctrl_modifier
)
3816 c
= make_ctrl_char (c
);
3818 c
|= (event
->modifiers
3819 & (meta_modifier
| alt_modifier
3820 | hyper_modifier
| super_modifier
));
3825 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3826 struct input_event
*sp
;
3828 if (single_kboard
&& kb
!= current_kboard
)
3831 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3832 Fcons (make_number (c
), Qnil
));
3833 kb
->kbd_queue_has_data
= 1;
3834 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3836 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3839 if (event_to_kboard (sp
) == kb
)
3841 sp
->kind
= NO_EVENT
;
3842 sp
->frame_or_window
= Qnil
;
3852 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3856 /* If this results in a quit_char being returned to Emacs as
3857 input, set Vlast_event_frame properly. If this doesn't
3858 get returned to Emacs as an event, the next event read
3859 will set Vlast_event_frame again, so this is safe to do. */
3863 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3865 focus
= event
->frame_or_window
;
3866 internal_last_event_frame
= focus
;
3867 Vlast_event_frame
= focus
;
3870 last_event_timestamp
= event
->timestamp
;
3871 handle_interrupt ();
3875 if (c
&& c
== stop_character
)
3881 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3882 Just ignore the second one. */
3883 else if (event
->kind
== BUFFER_SWITCH_EVENT
3884 && kbd_fetch_ptr
!= kbd_store_ptr
3885 && ((kbd_store_ptr
== kbd_buffer
3886 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3887 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3890 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3891 kbd_store_ptr
= kbd_buffer
;
3893 /* Don't let the very last slot in the buffer become full,
3894 since that would make the two pointers equal,
3895 and that is indistinguishable from an empty buffer.
3896 Discard the event if it would fill the last slot. */
3897 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3899 *kbd_store_ptr
= *event
;
3903 /* If we're inside while-no-input, and this event qualifies
3904 as input, set quit-flag to cause an interrupt. */
3905 if (!NILP (Vthrow_on_input
)
3906 && event
->kind
!= FOCUS_IN_EVENT
3907 && event
->kind
!= HELP_EVENT
3908 && event
->kind
!= DEICONIFY_EVENT
)
3910 Vquit_flag
= Vthrow_on_input
;
3911 /* If we're inside a function that wants immediate quits,
3913 if (immediate_quit
&& NILP (Vinhibit_quit
))
3923 /* Put an input event back in the head of the event queue. */
3926 kbd_buffer_unget_event (event
)
3927 register struct input_event
*event
;
3929 if (kbd_fetch_ptr
== kbd_buffer
)
3930 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3932 /* Don't let the very last slot in the buffer become full, */
3933 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3936 *kbd_fetch_ptr
= *event
;
3941 /* Generate HELP_EVENT input_events in BUFP which has room for
3942 SIZE events. If there's not enough room in BUFP, ignore this
3945 HELP is the help form.
3947 FRAME is the frame on which the help is generated. OBJECT is the
3948 Lisp object where the help was found (a buffer, a string, an
3949 overlay, or nil if neither from a string nor from a buffer. POS is
3950 the position within OBJECT where the help was found.
3952 Value is the number of input_events generated. */
3955 gen_help_event (help
, frame
, window
, object
, pos
)
3956 Lisp_Object help
, frame
, object
, window
;
3959 struct input_event event
;
3963 event
.kind
= HELP_EVENT
;
3964 event
.frame_or_window
= frame
;
3966 event
.x
= WINDOWP (window
) ? window
: frame
;
3969 kbd_buffer_store_event (&event
);
3973 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3976 kbd_buffer_store_help_event (frame
, help
)
3977 Lisp_Object frame
, help
;
3979 struct input_event event
;
3981 event
.kind
= HELP_EVENT
;
3982 event
.frame_or_window
= frame
;
3987 kbd_buffer_store_event (&event
);
3991 /* Discard any mouse events in the event buffer by setting them to
3994 discard_mouse_events ()
3996 struct input_event
*sp
;
3997 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3999 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4002 if (sp
->kind
== MOUSE_CLICK_EVENT
4003 || sp
->kind
== WHEEL_EVENT
4005 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
4007 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
4009 sp
->kind
= NO_EVENT
;
4015 /* Return non-zero if there are any real events waiting in the event
4016 buffer, not counting `NO_EVENT's.
4018 If DISCARD is non-zero, discard NO_EVENT events at the front of
4019 the input queue, possibly leaving the input queue empty if there
4020 are no real input events. */
4023 kbd_buffer_events_waiting (discard
)
4026 struct input_event
*sp
;
4028 for (sp
= kbd_fetch_ptr
;
4029 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4032 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4039 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4043 /* Clear input event EVENT. */
4047 struct input_event
*event
;
4049 event
->kind
= NO_EVENT
;
4053 /* Read one event from the event buffer, waiting if necessary.
4054 The value is a Lisp object representing the event.
4055 The value is nil for an event that should be ignored,
4056 or that was handled here.
4057 We always read and discard one event. */
4060 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4062 int *used_mouse_menu
;
4063 EMACS_TIME
*end_time
;
4072 *kbp
= current_kboard
;
4076 /* Wait until there is input available. */
4079 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4082 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4086 /* If the quit flag is set, then read_char will return
4087 quit_char, so that counts as "available input." */
4088 if (!NILP (Vquit_flag
))
4089 quit_throw_to_read_char ();
4091 /* One way or another, wait until input is available; then, if
4092 interrupt handlers have not read it, read it now. */
4095 wait_for_kbd_input ();
4097 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4101 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4104 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4109 EMACS_TIME duration
;
4110 EMACS_GET_TIME (duration
);
4111 if (EMACS_TIME_GE (duration
, *end_time
))
4112 return Qnil
; /* finished waiting */
4115 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4116 wait_reading_process_output (EMACS_SECS (duration
),
4117 EMACS_USECS (duration
),
4118 -1, 1, Qnil
, NULL
, 0);
4122 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4124 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4125 /* Pass 1 for EXPECT since we just waited to have input. */
4126 read_avail_input (1);
4127 #endif /* not VMS */
4130 if (CONSP (Vunread_command_events
))
4133 first
= XCAR (Vunread_command_events
);
4134 Vunread_command_events
= XCDR (Vunread_command_events
);
4135 *kbp
= current_kboard
;
4139 /* At this point, we know that there is a readable event available
4140 somewhere. If the event queue is empty, then there must be a
4141 mouse movement enabled and available. */
4142 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4144 struct input_event
*event
;
4146 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4150 last_event_timestamp
= event
->timestamp
;
4153 *kbp
= event_to_kboard (event
);
4155 *kbp
= current_kboard
; /* Better than returning null ptr? */
4157 *kbp
= &the_only_kboard
;
4162 /* These two kinds of events get special handling
4163 and don't actually appear to the command loop.
4164 We return nil for them. */
4165 if (event
->kind
== SELECTION_REQUEST_EVENT
4166 || event
->kind
== SELECTION_CLEAR_EVENT
)
4169 struct input_event copy
;
4171 /* Remove it from the buffer before processing it,
4172 since otherwise swallow_events will see it
4173 and process it again. */
4175 kbd_fetch_ptr
= event
+ 1;
4176 input_pending
= readable_events (0);
4177 x_handle_selection_event (©
);
4179 /* We're getting selection request events, but we don't have
4185 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4186 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4188 /* Make an event (delete-frame (FRAME)). */
4189 obj
= Fcons (event
->frame_or_window
, Qnil
);
4190 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4191 kbd_fetch_ptr
= event
+ 1;
4194 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4195 else if (event
->kind
== ICONIFY_EVENT
)
4197 /* Make an event (iconify-frame (FRAME)). */
4198 obj
= Fcons (event
->frame_or_window
, Qnil
);
4199 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4200 kbd_fetch_ptr
= event
+ 1;
4202 else if (event
->kind
== DEICONIFY_EVENT
)
4204 /* Make an event (make-frame-visible (FRAME)). */
4205 obj
= Fcons (event
->frame_or_window
, Qnil
);
4206 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4207 kbd_fetch_ptr
= event
+ 1;
4210 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4212 /* The value doesn't matter here; only the type is tested. */
4213 XSETBUFFER (obj
, current_buffer
);
4214 kbd_fetch_ptr
= event
+ 1;
4216 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4217 || defined (USE_GTK)
4218 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4220 kbd_fetch_ptr
= event
+ 1;
4221 input_pending
= readable_events (0);
4222 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4223 x_activate_menubar (XFRAME (event
->frame_or_window
));
4226 #if defined (WINDOWSNT) || defined (MAC_OS)
4227 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4230 /* Make an event (language-change (KEY_SCRIPT)). */
4231 obj
= Fcons (make_number (event
->code
), Qnil
);
4233 /* Make an event (language-change (FRAME CHARSET LCID)). */
4234 obj
= Fcons (event
->frame_or_window
, Qnil
);
4236 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4237 kbd_fetch_ptr
= event
+ 1;
4240 else if (event
->kind
== SAVE_SESSION_EVENT
)
4242 obj
= Fcons (Qsave_session
, Qnil
);
4243 kbd_fetch_ptr
= event
+ 1;
4245 /* Just discard these, by returning nil.
4246 With MULTI_KBOARD, these events are used as placeholders
4247 when we need to randomly delete events from the queue.
4248 (They shouldn't otherwise be found in the buffer,
4249 but on some machines it appears they do show up
4250 even without MULTI_KBOARD.) */
4251 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4252 mouse events during a popup-menu call. */
4253 else if (event
->kind
== NO_EVENT
)
4254 kbd_fetch_ptr
= event
+ 1;
4255 else if (event
->kind
== HELP_EVENT
)
4257 Lisp_Object object
, position
, help
, frame
, window
;
4259 frame
= event
->frame_or_window
;
4260 object
= event
->arg
;
4261 position
= make_number (event
->code
);
4264 clear_event (event
);
4266 kbd_fetch_ptr
= event
+ 1;
4267 if (!WINDOWP (window
))
4269 obj
= Fcons (Qhelp_echo
,
4270 list5 (frame
, help
, window
, object
, position
));
4272 else if (event
->kind
== FOCUS_IN_EVENT
)
4274 /* Notification of a FocusIn event. The frame receiving the
4275 focus is in event->frame_or_window. Generate a
4276 switch-frame event if necessary. */
4277 Lisp_Object frame
, focus
;
4279 frame
= event
->frame_or_window
;
4280 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4284 if (!EQ (frame
, internal_last_event_frame
)
4285 && !EQ (frame
, selected_frame
))
4286 obj
= make_lispy_switch_frame (frame
);
4287 internal_last_event_frame
= frame
;
4288 kbd_fetch_ptr
= event
+ 1;
4292 /* If this event is on a different frame, return a switch-frame this
4293 time, and leave the event in the queue for next time. */
4297 frame
= event
->frame_or_window
;
4299 frame
= XCAR (frame
);
4300 else if (WINDOWP (frame
))
4301 frame
= WINDOW_FRAME (XWINDOW (frame
));
4303 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4307 if (! EQ (frame
, internal_last_event_frame
)
4308 && !EQ (frame
, selected_frame
))
4309 obj
= make_lispy_switch_frame (frame
);
4310 internal_last_event_frame
= frame
;
4312 /* If we didn't decide to make a switch-frame event, go ahead
4313 and build a real event from the queue entry. */
4317 obj
= make_lispy_event (event
);
4319 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4320 || defined (USE_GTK)
4321 /* If this was a menu selection, then set the flag to inhibit
4322 writing to last_nonmenu_event. Don't do this if the event
4323 we're returning is (menu-bar), though; that indicates the
4324 beginning of the menu sequence, and we might as well leave
4325 that as the `event with parameters' for this selection. */
4327 && !EQ (event
->frame_or_window
, event
->arg
)
4328 && (event
->kind
== MENU_BAR_EVENT
4329 || event
->kind
== TOOL_BAR_EVENT
))
4330 *used_mouse_menu
= 1;
4333 /* Wipe out this event, to catch bugs. */
4334 clear_event (event
);
4335 kbd_fetch_ptr
= event
+ 1;
4340 /* Try generating a mouse motion event. */
4341 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4343 FRAME_PTR f
= some_mouse_moved ();
4344 Lisp_Object bar_window
;
4345 enum scroll_bar_part part
;
4349 *kbp
= current_kboard
;
4350 /* Note that this uses F to determine which terminal to look at.
4351 If there is no valid info, it does not store anything
4352 so x remains nil. */
4355 /* XXX Can f or mouse_position_hook be NULL here? */
4356 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4357 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4358 &part
, &x
, &y
, &time
);
4362 /* Decide if we should generate a switch-frame event. Don't
4363 generate switch-frame events for motion outside of all Emacs
4369 frame
= FRAME_FOCUS_FRAME (f
);
4371 XSETFRAME (frame
, f
);
4373 if (! EQ (frame
, internal_last_event_frame
)
4374 && !EQ (frame
, selected_frame
))
4375 obj
= make_lispy_switch_frame (frame
);
4376 internal_last_event_frame
= frame
;
4379 /* If we didn't decide to make a switch-frame event, go ahead and
4380 return a mouse-motion event. */
4381 if (!NILP (x
) && NILP (obj
))
4382 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4384 #endif /* HAVE_MOUSE */
4386 /* We were promised by the above while loop that there was
4387 something for us to read! */
4390 input_pending
= readable_events (0);
4392 Vlast_event_frame
= internal_last_event_frame
;
4397 /* Process any events that are not user-visible,
4398 then return, without reading any user-visible events. */
4401 swallow_events (do_display
)
4406 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4408 struct input_event
*event
;
4410 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4414 last_event_timestamp
= event
->timestamp
;
4416 /* These two kinds of events get special handling
4417 and don't actually appear to the command loop. */
4418 if (event
->kind
== SELECTION_REQUEST_EVENT
4419 || event
->kind
== SELECTION_CLEAR_EVENT
)
4422 struct input_event copy
;
4424 /* Remove it from the buffer before processing it,
4425 since otherwise swallow_events called recursively could see it
4426 and process it again. */
4428 kbd_fetch_ptr
= event
+ 1;
4429 input_pending
= readable_events (0);
4430 x_handle_selection_event (©
);
4432 /* We're getting selection request events, but we don't have
4441 old_timers_run
= timers_run
;
4442 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4444 if (timers_run
!= old_timers_run
&& do_display
)
4445 redisplay_preserve_echo_area (7);
4448 /* Record the start of when Emacs is idle,
4449 for the sake of running idle-time timers. */
4456 /* If we are already in the idle state, do nothing. */
4457 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4460 EMACS_GET_TIME (timer_idleness_start_time
);
4462 timer_last_idleness_start_time
= timer_idleness_start_time
;
4464 /* Mark all idle-time timers as once again candidates for running. */
4465 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4469 timer
= XCAR (timers
);
4471 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4473 XVECTOR (timer
)->contents
[0] = Qnil
;
4477 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4482 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4485 /* Resume idle timer from last idle start time. */
4488 timer_resume_idle ()
4490 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4493 timer_idleness_start_time
= timer_last_idleness_start_time
;
4496 /* This is only for debugging. */
4497 struct input_event last_timer_event
;
4499 /* Check whether a timer has fired. To prevent larger problems we simply
4500 disregard elements that are not proper timers. Do not make a circular
4501 timer list for the time being.
4503 Returns the number of seconds to wait until the next timer fires. If a
4504 timer is triggering now, return zero seconds.
4505 If no timer is active, return -1 seconds.
4507 If a timer is ripe, we run it, with quitting turned off.
4509 DO_IT_NOW is now ignored. It used to mean that we should
4510 run the timer directly instead of queueing a timer-event.
4511 Now we always run timers directly. */
4514 timer_check (do_it_now
)
4517 EMACS_TIME nexttime
;
4518 EMACS_TIME now
, idleness_now
;
4519 Lisp_Object timers
, idle_timers
, chosen_timer
;
4520 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4522 EMACS_SET_SECS (nexttime
, -1);
4523 EMACS_SET_USECS (nexttime
, -1);
4525 /* Always consider the ordinary timers. */
4526 timers
= Vtimer_list
;
4527 /* Consider the idle timers only if Emacs is idle. */
4528 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4529 idle_timers
= Vtimer_idle_list
;
4532 chosen_timer
= Qnil
;
4533 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4535 if (CONSP (timers
) || CONSP (idle_timers
))
4537 EMACS_GET_TIME (now
);
4538 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4539 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4542 while (CONSP (timers
) || CONSP (idle_timers
))
4544 Lisp_Object
*vector
;
4545 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4546 EMACS_TIME timer_time
, idle_timer_time
;
4547 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4549 /* Skip past invalid timers and timers already handled. */
4552 timer
= XCAR (timers
);
4553 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4555 timers
= XCDR (timers
);
4558 vector
= XVECTOR (timer
)->contents
;
4560 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4561 || !INTEGERP (vector
[3])
4562 || ! NILP (vector
[0]))
4564 timers
= XCDR (timers
);
4568 if (!NILP (idle_timers
))
4570 timer
= XCAR (idle_timers
);
4571 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4573 idle_timers
= XCDR (idle_timers
);
4576 vector
= XVECTOR (timer
)->contents
;
4578 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4579 || !INTEGERP (vector
[3])
4580 || ! NILP (vector
[0]))
4582 idle_timers
= XCDR (idle_timers
);
4587 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4588 based on the next ordinary timer.
4589 TIMER_DIFFERENCE is the distance in time from NOW to when
4590 this timer becomes ripe (negative if it's already ripe). */
4593 timer
= XCAR (timers
);
4594 vector
= XVECTOR (timer
)->contents
;
4595 EMACS_SET_SECS (timer_time
,
4596 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4597 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4598 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4601 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4602 based on the next idle timer. */
4603 if (!NILP (idle_timers
))
4605 idle_timer
= XCAR (idle_timers
);
4606 vector
= XVECTOR (idle_timer
)->contents
;
4607 EMACS_SET_SECS (idle_timer_time
,
4608 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4609 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4610 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4613 /* Decide which timer is the next timer,
4614 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4615 Also step down the list where we found that timer. */
4617 if (! NILP (timers
) && ! NILP (idle_timers
))
4620 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4621 if (EMACS_TIME_NEG_P (temp
))
4623 chosen_timer
= timer
;
4624 timers
= XCDR (timers
);
4625 difference
= timer_difference
;
4629 chosen_timer
= idle_timer
;
4630 idle_timers
= XCDR (idle_timers
);
4631 difference
= idle_timer_difference
;
4634 else if (! NILP (timers
))
4636 chosen_timer
= timer
;
4637 timers
= XCDR (timers
);
4638 difference
= timer_difference
;
4642 chosen_timer
= idle_timer
;
4643 idle_timers
= XCDR (idle_timers
);
4644 difference
= idle_timer_difference
;
4646 vector
= XVECTOR (chosen_timer
)->contents
;
4648 /* If timer is ripe, run it if it hasn't been run. */
4649 if (EMACS_TIME_NEG_P (difference
)
4650 || (EMACS_SECS (difference
) == 0
4651 && EMACS_USECS (difference
) == 0))
4653 if (NILP (vector
[0]))
4655 int count
= SPECPDL_INDEX ();
4656 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4658 #if 0 /* This shouldn't be necessary anymore. --lorentey */
4659 /* On unbind_to, resume allowing input from any kboard, if that
4661 record_single_kboard_state ();
4663 /* Mark the timer as triggered to prevent problems if the lisp
4664 code fails to reschedule it right. */
4667 specbind (Qinhibit_quit
, Qt
);
4669 call1 (Qtimer_event_handler
, chosen_timer
);
4670 Vdeactivate_mark
= old_deactivate_mark
;
4672 unbind_to (count
, Qnil
);
4674 /* Since we have handled the event,
4675 we don't need to tell the caller to wake up and do it. */
4679 /* When we encounter a timer that is still waiting,
4680 return the amount of time to wait before it is ripe. */
4687 /* No timers are pending in the future. */
4688 /* Return 0 if we generated an event, and -1 if not. */
4693 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4694 doc
: /* Return the current length of Emacs idleness.
4695 The value is returned as a list of three integers. The first has the
4696 most significant 16 bits of the seconds, while the second has the
4697 least significant 16 bits. The third integer gives the microsecond
4700 The microsecond count is zero on systems that do not provide
4701 resolution finer than a second. */)
4704 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4706 EMACS_TIME now
, idleness_now
;
4708 EMACS_GET_TIME (now
);
4709 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4711 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4712 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4713 make_number (EMACS_USECS (idleness_now
)));
4719 /* Caches for modify_event_symbol. */
4720 static Lisp_Object accent_key_syms
;
4721 static Lisp_Object func_key_syms
;
4722 static Lisp_Object mouse_syms
;
4723 static Lisp_Object wheel_syms
;
4724 static Lisp_Object drag_n_drop_syms
;
4726 /* This is a list of keysym codes for special "accent" characters.
4727 It parallels lispy_accent_keys. */
4729 static int lispy_accent_codes
[] =
4731 #ifdef XK_dead_circumflex
4736 #ifdef XK_dead_grave
4741 #ifdef XK_dead_tilde
4746 #ifdef XK_dead_diaeresis
4751 #ifdef XK_dead_macron
4756 #ifdef XK_dead_degree
4761 #ifdef XK_dead_acute
4766 #ifdef XK_dead_cedilla
4771 #ifdef XK_dead_breve
4776 #ifdef XK_dead_ogonek
4781 #ifdef XK_dead_caron
4786 #ifdef XK_dead_doubleacute
4787 XK_dead_doubleacute
,
4791 #ifdef XK_dead_abovedot
4796 #ifdef XK_dead_abovering
4806 #ifdef XK_dead_belowdot
4811 #ifdef XK_dead_voiced_sound
4812 XK_dead_voiced_sound
,
4816 #ifdef XK_dead_semivoiced_sound
4817 XK_dead_semivoiced_sound
,
4833 /* This is a list of Lisp names for special "accent" characters.
4834 It parallels lispy_accent_codes. */
4836 static char *lispy_accent_keys
[] =
4854 "dead-voiced-sound",
4855 "dead-semivoiced-sound",
4861 #define FUNCTION_KEY_OFFSET 0x0
4863 char *lispy_function_keys
[] =
4867 0, /* VK_LBUTTON 0x01 */
4868 0, /* VK_RBUTTON 0x02 */
4869 "cancel", /* VK_CANCEL 0x03 */
4870 0, /* VK_MBUTTON 0x04 */
4872 0, 0, 0, /* 0x05 .. 0x07 */
4874 "backspace", /* VK_BACK 0x08 */
4875 "tab", /* VK_TAB 0x09 */
4877 0, 0, /* 0x0A .. 0x0B */
4879 "clear", /* VK_CLEAR 0x0C */
4880 "return", /* VK_RETURN 0x0D */
4882 0, 0, /* 0x0E .. 0x0F */
4884 0, /* VK_SHIFT 0x10 */
4885 0, /* VK_CONTROL 0x11 */
4886 0, /* VK_MENU 0x12 */
4887 "pause", /* VK_PAUSE 0x13 */
4888 "capslock", /* VK_CAPITAL 0x14 */
4890 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4892 "escape", /* VK_ESCAPE 0x1B */
4894 0, 0, 0, 0, /* 0x1C .. 0x1F */
4896 0, /* VK_SPACE 0x20 */
4897 "prior", /* VK_PRIOR 0x21 */
4898 "next", /* VK_NEXT 0x22 */
4899 "end", /* VK_END 0x23 */
4900 "home", /* VK_HOME 0x24 */
4901 "left", /* VK_LEFT 0x25 */
4902 "up", /* VK_UP 0x26 */
4903 "right", /* VK_RIGHT 0x27 */
4904 "down", /* VK_DOWN 0x28 */
4905 "select", /* VK_SELECT 0x29 */
4906 "print", /* VK_PRINT 0x2A */
4907 "execute", /* VK_EXECUTE 0x2B */
4908 "snapshot", /* VK_SNAPSHOT 0x2C */
4909 "insert", /* VK_INSERT 0x2D */
4910 "delete", /* VK_DELETE 0x2E */
4911 "help", /* VK_HELP 0x2F */
4913 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4915 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4917 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4919 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4921 0, 0, 0, 0, 0, 0, 0, 0, 0,
4922 0, 0, 0, 0, 0, 0, 0, 0, 0,
4923 0, 0, 0, 0, 0, 0, 0, 0,
4925 "lwindow", /* VK_LWIN 0x5B */
4926 "rwindow", /* VK_RWIN 0x5C */
4927 "apps", /* VK_APPS 0x5D */
4929 0, 0, /* 0x5E .. 0x5F */
4931 "kp-0", /* VK_NUMPAD0 0x60 */
4932 "kp-1", /* VK_NUMPAD1 0x61 */
4933 "kp-2", /* VK_NUMPAD2 0x62 */
4934 "kp-3", /* VK_NUMPAD3 0x63 */
4935 "kp-4", /* VK_NUMPAD4 0x64 */
4936 "kp-5", /* VK_NUMPAD5 0x65 */
4937 "kp-6", /* VK_NUMPAD6 0x66 */
4938 "kp-7", /* VK_NUMPAD7 0x67 */
4939 "kp-8", /* VK_NUMPAD8 0x68 */
4940 "kp-9", /* VK_NUMPAD9 0x69 */
4941 "kp-multiply", /* VK_MULTIPLY 0x6A */
4942 "kp-add", /* VK_ADD 0x6B */
4943 "kp-separator", /* VK_SEPARATOR 0x6C */
4944 "kp-subtract", /* VK_SUBTRACT 0x6D */
4945 "kp-decimal", /* VK_DECIMAL 0x6E */
4946 "kp-divide", /* VK_DIVIDE 0x6F */
4947 "f1", /* VK_F1 0x70 */
4948 "f2", /* VK_F2 0x71 */
4949 "f3", /* VK_F3 0x72 */
4950 "f4", /* VK_F4 0x73 */
4951 "f5", /* VK_F5 0x74 */
4952 "f6", /* VK_F6 0x75 */
4953 "f7", /* VK_F7 0x76 */
4954 "f8", /* VK_F8 0x77 */
4955 "f9", /* VK_F9 0x78 */
4956 "f10", /* VK_F10 0x79 */
4957 "f11", /* VK_F11 0x7A */
4958 "f12", /* VK_F12 0x7B */
4959 "f13", /* VK_F13 0x7C */
4960 "f14", /* VK_F14 0x7D */
4961 "f15", /* VK_F15 0x7E */
4962 "f16", /* VK_F16 0x7F */
4963 "f17", /* VK_F17 0x80 */
4964 "f18", /* VK_F18 0x81 */
4965 "f19", /* VK_F19 0x82 */
4966 "f20", /* VK_F20 0x83 */
4967 "f21", /* VK_F21 0x84 */
4968 "f22", /* VK_F22 0x85 */
4969 "f23", /* VK_F23 0x86 */
4970 "f24", /* VK_F24 0x87 */
4972 0, 0, 0, 0, /* 0x88 .. 0x8B */
4973 0, 0, 0, 0, /* 0x8C .. 0x8F */
4975 "kp-numlock", /* VK_NUMLOCK 0x90 */
4976 "scroll", /* VK_SCROLL 0x91 */
4978 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4979 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4980 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4981 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4982 "kp-end", /* VK_NUMPAD_END 0x96 */
4983 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4984 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4985 "kp-up", /* VK_NUMPAD_UP 0x99 */
4986 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4987 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4988 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4989 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4991 0, 0, /* 0x9E .. 0x9F */
4994 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4995 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4996 * No other API or message will distinguish left and right keys this way.
5000 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5001 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5002 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5003 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5004 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5010 "attn", /* VK_ATTN 0xF6 */
5011 "crsel", /* VK_CRSEL 0xF7 */
5012 "exsel", /* VK_EXSEL 0xF8 */
5013 "ereof", /* VK_EREOF 0xF9 */
5014 "play", /* VK_PLAY 0xFA */
5015 "zoom", /* VK_ZOOM 0xFB */
5016 "noname", /* VK_NONAME 0xFC */
5017 "pa1", /* VK_PA1 0xFD */
5018 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5022 #else /* not HAVE_NTGUI */
5024 /* This should be dealt with in XTread_socket now, and that doesn't
5025 depend on the client system having the Kana syms defined. See also
5026 the XK_kana_A case below. */
5029 static char *lispy_kana_keys
[] =
5031 /* X Keysym value */
5032 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5033 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5034 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5035 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5036 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5037 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5038 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5039 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5040 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5041 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5042 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5043 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5044 "kana-i", "kana-u", "kana-e", "kana-o",
5045 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5046 "prolongedsound", "kana-A", "kana-I", "kana-U",
5047 "kana-E", "kana-O", "kana-KA", "kana-KI",
5048 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5049 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5050 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5051 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5052 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5053 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5054 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5055 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5056 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5057 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5058 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5059 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5061 #endif /* XK_kana_A */
5064 #define FUNCTION_KEY_OFFSET 0xff00
5066 /* You'll notice that this table is arranged to be conveniently
5067 indexed by X Windows keysym values. */
5068 static char *lispy_function_keys
[] =
5070 /* X Keysym value */
5072 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5073 "backspace", "tab", "linefeed", "clear",
5075 0, 0, 0, "pause", /* 0xff10...1f */
5076 0, 0, 0, 0, 0, 0, 0, "escape",
5078 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5079 "romaji", "hiragana", "katakana", "hiragana-katakana",
5080 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5081 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5082 "eisu-toggle", /* 0xff30...3f */
5083 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5084 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5086 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5087 "down", "prior", "next", "end",
5088 "begin", 0, 0, 0, 0, 0, 0, 0,
5089 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5100 "break", /* 0xff6b */
5103 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5104 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5105 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5106 0, 0, 0, 0, 0, 0, 0, 0,
5107 "kp-tab", /* 0xff89 */
5109 "kp-enter", /* 0xff8d */
5111 "kp-f1", /* 0xff91 */
5115 "kp-home", /* 0xff95 */
5120 "kp-prior", /* kp-page-up */
5121 "kp-next", /* kp-page-down */
5127 0, 0, 0, 0, 0, 0, 0, 0, 0,
5128 "kp-multiply", /* 0xffaa */
5133 "kp-divide", /* 0xffaf */
5134 "kp-0", /* 0xffb0 */
5135 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5138 "kp-equal", /* 0xffbd */
5139 "f1", /* 0xffbe */ /* IsFunctionKey */
5141 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5142 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5143 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5144 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5145 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5146 0, 0, 0, 0, 0, 0, 0, 0,
5147 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5148 0, 0, 0, 0, 0, 0, 0, "delete"
5151 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5152 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5154 static char *iso_lispy_function_keys
[] =
5156 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5157 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5158 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5159 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5160 "iso-lefttab", /* 0xfe20 */
5161 "iso-move-line-up", "iso-move-line-down",
5162 "iso-partial-line-up", "iso-partial-line-down",
5163 "iso-partial-space-left", "iso-partial-space-right",
5164 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5165 "iso-release-margin-left", "iso-release-margin-right",
5166 "iso-release-both-margins",
5167 "iso-fast-cursor-left", "iso-fast-cursor-right",
5168 "iso-fast-cursor-up", "iso-fast-cursor-down",
5169 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5170 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5173 #endif /* not HAVE_NTGUI */
5175 Lisp_Object Vlispy_mouse_stem
;
5177 static char *lispy_wheel_names
[] =
5179 "wheel-up", "wheel-down"
5182 /* drag-n-drop events are generated when a set of selected files are
5183 dragged from another application and dropped onto an Emacs window. */
5184 static char *lispy_drag_n_drop_names
[] =
5189 /* Scroll bar parts. */
5190 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5191 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5192 Lisp_Object Qtop
, Qratio
;
5194 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5195 Lisp_Object
*scroll_bar_parts
[] = {
5196 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5197 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5200 /* A vector, indexed by button number, giving the down-going location
5201 of currently depressed buttons, both scroll bar and non-scroll bar.
5203 The elements have the form
5204 (BUTTON-NUMBER MODIFIER-MASK . REST)
5205 where REST is the cdr of a position as it would be reported in the event.
5207 The make_lispy_event function stores positions here to tell the
5208 difference between click and drag events, and to store the starting
5209 location to be included in drag events. */
5211 static Lisp_Object button_down_location
;
5213 /* Information about the most recent up-going button event: Which
5214 button, what location, and what time. */
5216 static int last_mouse_button
;
5217 static int last_mouse_x
;
5218 static int last_mouse_y
;
5219 static unsigned long button_down_time
;
5221 /* The maximum time between clicks to make a double-click, or Qnil to
5222 disable double-click detection, or Qt for no time limit. */
5224 Lisp_Object Vdouble_click_time
;
5226 /* Maximum number of pixels the mouse may be moved between clicks
5227 to make a double-click. */
5229 EMACS_INT double_click_fuzz
;
5231 /* The number of clicks in this multiple-click. */
5233 int double_click_count
;
5235 /* Return position of a mouse click or wheel event */
5238 make_lispy_position (f
, x
, y
, time
)
5244 enum window_part part
;
5245 Lisp_Object posn
= Qnil
;
5246 Lisp_Object extra_info
= Qnil
;
5249 /* Set `window' to the window under frame pixel coordinates (x,y) */
5251 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5252 &part
, &wx
, &wy
, 0);
5256 if (WINDOWP (window
))
5258 /* It's a click in window window at frame coordinates (x,y) */
5259 struct window
*w
= XWINDOW (window
);
5260 Lisp_Object string_info
= Qnil
;
5261 int textpos
= -1, rx
= -1, ry
= -1;
5262 int dx
= -1, dy
= -1;
5263 int width
= -1, height
= -1;
5264 Lisp_Object object
= Qnil
;
5266 /* Set event coordinates to window-relative coordinates
5267 for constructing the Lisp event below. */
5271 if (part
== ON_TEXT
)
5273 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5275 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5277 /* Mode line or header line. Look for a string under
5278 the mouse that may have a `local-map' property. */
5282 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5284 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5285 &object
, &dx
, &dy
, &width
, &height
);
5286 if (STRINGP (string
))
5287 string_info
= Fcons (string
, make_number (charpos
));
5288 if (w
== XWINDOW (selected_window
))
5291 textpos
= XMARKER (w
->pointm
)->charpos
;
5293 else if (part
== ON_VERTICAL_BORDER
)
5295 posn
= Qvertical_line
;
5300 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5305 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5307 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5308 &object
, &dx
, &dy
, &width
, &height
);
5309 if (STRINGP (string
))
5310 string_info
= Fcons (string
, make_number (charpos
));
5311 if (part
== ON_LEFT_MARGIN
)
5314 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5316 else if (part
== ON_LEFT_FRINGE
)
5318 posn
= Qleft_fringe
;
5321 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5323 : window_box_width (w
, LEFT_MARGIN_AREA
));
5326 else if (part
== ON_RIGHT_FRINGE
)
5328 posn
= Qright_fringe
;
5331 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5332 + window_box_width (w
, TEXT_AREA
)
5333 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5334 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5340 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5341 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5346 Lisp_Object string2
, object2
= Qnil
;
5347 struct display_pos p
;
5349 int width2
, height2
;
5350 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5351 &object2
, &dx2
, &dy2
,
5353 textpos
= CHARPOS (p
.pos
);
5354 if (rx
< 0) rx
= wx
;
5355 if (ry
< 0) ry
= wy
;
5356 if (dx
< 0) dx
= dx2
;
5357 if (dy
< 0) dy
= dy2
;
5358 if (width
< 0) width
= width2
;
5359 if (height
< 0) height
= height2
;
5363 posn
= make_number (textpos
);
5364 if (STRINGP (string2
))
5365 string_info
= Fcons (string2
,
5366 make_number (CHARPOS (p
.string_pos
)));
5372 #ifdef HAVE_WINDOW_SYSTEM
5373 if (IMAGEP (object
))
5375 Lisp_Object image_map
, hotspot
;
5376 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5378 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5380 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5381 posn
= XCAR (hotspot
);
5386 extra_info
= Fcons (object
,
5387 Fcons (Fcons (make_number (dx
),
5389 Fcons (Fcons (make_number (width
),
5390 make_number (height
)),
5394 extra_info
= Fcons (string_info
,
5395 Fcons (make_number (textpos
),
5396 Fcons (Fcons (make_number (rx
),
5402 XSETFRAME (window
, f
);
5407 XSETFASTINT (*x
, 0);
5408 XSETFASTINT (*y
, 0);
5411 return Fcons (window
,
5413 Fcons (Fcons (*x
, *y
),
5414 Fcons (make_number (time
),
5418 /* Given a struct input_event, build the lisp event which represents
5419 it. If EVENT is 0, build a mouse movement event from the mouse
5420 movement buffer, which should have a movement event in it.
5422 Note that events must be passed to this function in the order they
5423 are received; this function stores the location of button presses
5424 in order to build drag events when the button is released. */
5427 make_lispy_event (event
)
5428 struct input_event
*event
;
5432 switch (SWITCH_ENUM_CAST (event
->kind
))
5434 /* A simple keystroke. */
5435 case ASCII_KEYSTROKE_EVENT
:
5437 Lisp_Object lispy_c
;
5438 int c
= event
->code
& 0377;
5439 /* Turn ASCII characters into control characters
5441 if (event
->modifiers
& ctrl_modifier
)
5442 c
= make_ctrl_char (c
);
5444 /* Add in the other modifier bits. We took care of ctrl_modifier
5445 just above, and the shift key was taken care of by the X code,
5446 and applied to control characters by make_ctrl_char. */
5447 c
|= (event
->modifiers
5448 & (meta_modifier
| alt_modifier
5449 | hyper_modifier
| super_modifier
));
5450 /* Distinguish Shift-SPC from SPC. */
5451 if ((event
->code
& 0377) == 040
5452 && event
->modifiers
& shift_modifier
)
5453 c
|= shift_modifier
;
5454 button_down_time
= 0;
5455 XSETFASTINT (lispy_c
, c
);
5459 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5461 Lisp_Object lispy_c
;
5462 int c
= event
->code
;
5464 /* Add in the other modifier bits. We took care of ctrl_modifier
5465 just above, and the shift key was taken care of by the X code,
5466 and applied to control characters by make_ctrl_char. */
5467 c
|= (event
->modifiers
5468 & (meta_modifier
| alt_modifier
5469 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5470 /* What about the `shift' modifier ? */
5471 button_down_time
= 0;
5472 XSETFASTINT (lispy_c
, c
);
5476 /* A function key. The symbol may need to have modifier prefixes
5478 case NON_ASCII_KEYSTROKE_EVENT
:
5479 button_down_time
= 0;
5481 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5482 if (event
->code
== lispy_accent_codes
[i
])
5483 return modify_event_symbol (i
,
5485 Qfunction_key
, Qnil
,
5486 lispy_accent_keys
, &accent_key_syms
,
5487 (sizeof (lispy_accent_keys
)
5488 / sizeof (lispy_accent_keys
[0])));
5492 if (event
->code
>= 0x400 && event
->code
< 0x500)
5493 return modify_event_symbol (event
->code
- 0x400,
5494 event
->modifiers
& ~shift_modifier
,
5495 Qfunction_key
, Qnil
,
5496 lispy_kana_keys
, &func_key_syms
,
5497 (sizeof (lispy_kana_keys
)
5498 / sizeof (lispy_kana_keys
[0])));
5499 #endif /* XK_kana_A */
5502 #ifdef ISO_FUNCTION_KEY_OFFSET
5503 if (event
->code
< FUNCTION_KEY_OFFSET
5504 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5505 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5507 Qfunction_key
, Qnil
,
5508 iso_lispy_function_keys
, &func_key_syms
,
5509 (sizeof (iso_lispy_function_keys
)
5510 / sizeof (iso_lispy_function_keys
[0])));
5513 /* Handle system-specific or unknown keysyms. */
5514 if (event
->code
& (1 << 28)
5515 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5516 || (event
->code
- FUNCTION_KEY_OFFSET
5517 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5518 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5520 /* We need to use an alist rather than a vector as the cache
5521 since we can't make a vector long enuf. */
5522 if (NILP (current_kboard
->system_key_syms
))
5523 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5524 return modify_event_symbol (event
->code
,
5527 current_kboard
->Vsystem_key_alist
,
5528 0, ¤t_kboard
->system_key_syms
,
5532 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5534 Qfunction_key
, Qnil
,
5535 lispy_function_keys
, &func_key_syms
,
5536 (sizeof (lispy_function_keys
)
5537 / sizeof (lispy_function_keys
[0])));
5540 /* A mouse click. Figure out where it is, decide whether it's
5541 a press, click or drag, and build the appropriate structure. */
5542 case MOUSE_CLICK_EVENT
:
5543 #ifndef USE_TOOLKIT_SCROLL_BARS
5544 case SCROLL_BAR_CLICK_EVENT
:
5547 int button
= event
->code
;
5549 Lisp_Object position
;
5550 Lisp_Object
*start_pos_ptr
;
5551 Lisp_Object start_pos
;
5555 /* Build the position as appropriate for this mouse click. */
5556 if (event
->kind
== MOUSE_CLICK_EVENT
)
5558 struct frame
*f
= XFRAME (event
->frame_or_window
);
5559 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5563 /* Ignore mouse events that were made on frame that
5564 have been deleted. */
5565 if (! FRAME_LIVE_P (f
))
5568 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5569 /* EVENT->x and EVENT->y are frame-relative pixel
5570 coordinates at this place. Under old redisplay, COLUMN
5571 and ROW are set to frame relative glyph coordinates
5572 which are then used to determine whether this click is
5573 in a menu (non-toolkit version). */
5574 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5575 &column
, &row
, NULL
, 1);
5577 /* In the non-toolkit version, clicks on the menu bar
5578 are ordinary button events in the event buffer.
5579 Distinguish them, and invoke the menu.
5581 (In the toolkit version, the toolkit handles the menu bar
5582 and Emacs doesn't know about it until after the user
5583 makes a selection.) */
5584 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5585 && (event
->modifiers
& down_modifier
))
5587 Lisp_Object items
, item
;
5592 /* Activate the menu bar on the down event. If the
5593 up event comes in before the menu code can deal with it,
5595 if (! (event
->modifiers
& down_modifier
))
5599 /* Find the menu bar item under `column'. */
5601 items
= FRAME_MENU_BAR_ITEMS (f
);
5602 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5604 Lisp_Object pos
, string
;
5605 string
= AREF (items
, i
+ 1);
5606 pos
= AREF (items
, i
+ 3);
5609 if (column
>= XINT (pos
)
5610 && column
< XINT (pos
) + SCHARS (string
))
5612 item
= AREF (items
, i
);
5617 /* ELisp manual 2.4b says (x y) are window relative but
5618 code says they are frame-relative. */
5620 = Fcons (event
->frame_or_window
,
5622 Fcons (Fcons (event
->x
, event
->y
),
5623 Fcons (make_number (event
->timestamp
),
5626 return Fcons (item
, Fcons (position
, Qnil
));
5628 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5630 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5633 #ifndef USE_TOOLKIT_SCROLL_BARS
5636 /* It's a scrollbar click. */
5638 Lisp_Object portion_whole
;
5641 window
= event
->frame_or_window
;
5642 portion_whole
= Fcons (event
->x
, event
->y
);
5643 part
= *scroll_bar_parts
[(int) event
->part
];
5647 Fcons (Qvertical_scroll_bar
,
5648 Fcons (portion_whole
,
5649 Fcons (make_number (event
->timestamp
),
5650 Fcons (part
, Qnil
)))));
5652 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5654 if (button
>= ASIZE (button_down_location
))
5656 button_down_location
= larger_vector (button_down_location
,
5658 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5661 start_pos_ptr
= &AREF (button_down_location
, button
);
5662 start_pos
= *start_pos_ptr
;
5663 *start_pos_ptr
= Qnil
;
5666 /* On window-system frames, use the value of
5667 double-click-fuzz as is. On other frames, interpret it
5668 as a multiple of 1/8 characters. */
5672 if (WINDOWP (event
->frame_or_window
))
5673 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5674 else if (FRAMEP (event
->frame_or_window
))
5675 f
= XFRAME (event
->frame_or_window
);
5679 if (FRAME_WINDOW_P (f
))
5680 fuzz
= double_click_fuzz
;
5682 fuzz
= double_click_fuzz
/ 8;
5684 is_double
= (button
== last_mouse_button
5685 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5686 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5687 && button_down_time
!= 0
5688 && (EQ (Vdouble_click_time
, Qt
)
5689 || (INTEGERP (Vdouble_click_time
)
5690 && ((int)(event
->timestamp
- button_down_time
)
5691 < XINT (Vdouble_click_time
)))));
5694 last_mouse_button
= button
;
5695 last_mouse_x
= XINT (event
->x
);
5696 last_mouse_y
= XINT (event
->y
);
5698 /* If this is a button press, squirrel away the location, so
5699 we can decide later whether it was a click or a drag. */
5700 if (event
->modifiers
& down_modifier
)
5704 double_click_count
++;
5705 event
->modifiers
|= ((double_click_count
> 2)
5710 double_click_count
= 1;
5711 button_down_time
= event
->timestamp
;
5712 *start_pos_ptr
= Fcopy_alist (position
);
5713 ignore_mouse_drag_p
= 0;
5716 /* Now we're releasing a button - check the co-ordinates to
5717 see if this was a click or a drag. */
5718 else if (event
->modifiers
& up_modifier
)
5720 /* If we did not see a down before this up, ignore the up.
5721 Probably this happened because the down event chose a
5722 menu item. It would be an annoyance to treat the
5723 release of the button that chose the menu item as a
5726 if (!CONSP (start_pos
))
5729 event
->modifiers
&= ~up_modifier
;
5730 #if 0 /* Formerly we treated an up with no down as a click event. */
5731 if (!CONSP (start_pos
))
5732 event
->modifiers
|= click_modifier
;
5737 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5739 /* The third element of every position
5740 should be the (x,y) pair. */
5741 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5743 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5745 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5746 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5749 if (ignore_mouse_drag_p
)
5751 event
->modifiers
|= click_modifier
;
5752 ignore_mouse_drag_p
= 0;
5754 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5755 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5756 /* Maybe the mouse has moved a lot, caused scrolling, and
5757 eventually ended up at the same screen position (but
5758 not buffer position) in which case it is a drag, not
5760 /* FIXME: OTOH if the buffer position has changed
5761 because of a timer or process filter rather than
5762 because of mouse movement, it should be considered as
5763 a click. But mouse-drag-region completely ignores
5764 this case and it hasn't caused any real problem, so
5765 it's probably OK to ignore it as well. */
5766 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5767 /* Mouse hasn't moved (much). */
5768 event
->modifiers
|= click_modifier
;
5771 button_down_time
= 0;
5772 event
->modifiers
|= drag_modifier
;
5775 /* Don't check is_double; treat this as multiple
5776 if the down-event was multiple. */
5777 if (double_click_count
> 1)
5778 event
->modifiers
|= ((double_click_count
> 2)
5784 /* Every mouse event should either have the down_modifier or
5785 the up_modifier set. */
5789 /* Get the symbol we should use for the mouse click. */
5792 head
= modify_event_symbol (button
,
5794 Qmouse_click
, Vlispy_mouse_stem
,
5797 XVECTOR (mouse_syms
)->size
);
5798 if (event
->modifiers
& drag_modifier
)
5803 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5806 Fcons (make_number (double_click_count
),
5817 Lisp_Object position
;
5820 /* Build the position as appropriate for this mouse click. */
5821 struct frame
*f
= XFRAME (event
->frame_or_window
);
5823 /* Ignore wheel events that were made on frame that have been
5825 if (! FRAME_LIVE_P (f
))
5828 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5831 /* Set double or triple modifiers to indicate the wheel speed. */
5833 /* On window-system frames, use the value of
5834 double-click-fuzz as is. On other frames, interpret it
5835 as a multiple of 1/8 characters. */
5840 if (WINDOWP (event
->frame_or_window
))
5841 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5842 else if (FRAMEP (event
->frame_or_window
))
5843 f
= XFRAME (event
->frame_or_window
);
5847 if (FRAME_WINDOW_P (f
))
5848 fuzz
= double_click_fuzz
;
5850 fuzz
= double_click_fuzz
/ 8;
5852 is_double
= (last_mouse_button
< 0
5853 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5854 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5855 && button_down_time
!= 0
5856 && (EQ (Vdouble_click_time
, Qt
)
5857 || (INTEGERP (Vdouble_click_time
)
5858 && ((int)(event
->timestamp
- button_down_time
)
5859 < XINT (Vdouble_click_time
)))));
5862 double_click_count
++;
5863 event
->modifiers
|= ((double_click_count
> 2)
5869 double_click_count
= 1;
5870 event
->modifiers
|= click_modifier
;
5873 button_down_time
= event
->timestamp
;
5874 /* Use a negative value to distinguish wheel from mouse button. */
5875 last_mouse_button
= -1;
5876 last_mouse_x
= XINT (event
->x
);
5877 last_mouse_y
= XINT (event
->y
);
5883 if (event
->modifiers
& up_modifier
)
5885 /* Emit a wheel-up event. */
5886 event
->modifiers
&= ~up_modifier
;
5889 else if (event
->modifiers
& down_modifier
)
5891 /* Emit a wheel-down event. */
5892 event
->modifiers
&= ~down_modifier
;
5896 /* Every wheel event should either have the down_modifier or
5897 the up_modifier set. */
5900 /* Get the symbol we should use for the wheel event. */
5901 head
= modify_event_symbol (symbol_num
,
5907 ASIZE (wheel_syms
));
5910 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5913 Fcons (make_number (double_click_count
),
5922 #ifdef USE_TOOLKIT_SCROLL_BARS
5924 /* We don't have down and up events if using toolkit scroll bars,
5925 so make this always a click event. Store in the `part' of
5926 the Lisp event a symbol which maps to the following actions:
5928 `above_handle' page up
5929 `below_handle' page down
5933 `bottom' bottom of buffer
5934 `handle' thumb has been dragged.
5935 `end-scroll' end of interaction with scroll bar
5937 The incoming input_event contains in its `part' member an
5938 index of type `enum scroll_bar_part' which we can use as an
5939 index in scroll_bar_parts to get the appropriate symbol. */
5941 case SCROLL_BAR_CLICK_EVENT
:
5943 Lisp_Object position
, head
, window
, portion_whole
, part
;
5945 window
= event
->frame_or_window
;
5946 portion_whole
= Fcons (event
->x
, event
->y
);
5947 part
= *scroll_bar_parts
[(int) event
->part
];
5951 Fcons (Qvertical_scroll_bar
,
5952 Fcons (portion_whole
,
5953 Fcons (make_number (event
->timestamp
),
5954 Fcons (part
, Qnil
)))));
5956 /* Always treat scroll bar events as clicks. */
5957 event
->modifiers
|= click_modifier
;
5958 event
->modifiers
&= ~up_modifier
;
5960 if (event
->code
>= ASIZE (mouse_syms
))
5961 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5963 /* Get the symbol we should use for the mouse click. */
5964 head
= modify_event_symbol (event
->code
,
5969 XVECTOR (mouse_syms
)->size
);
5970 return Fcons (head
, Fcons (position
, Qnil
));
5973 #endif /* USE_TOOLKIT_SCROLL_BARS */
5976 case W32_SCROLL_BAR_CLICK_EVENT
:
5978 int button
= event
->code
;
5980 Lisp_Object position
;
5981 Lisp_Object
*start_pos_ptr
;
5982 Lisp_Object start_pos
;
5986 Lisp_Object portion_whole
;
5989 window
= event
->frame_or_window
;
5990 portion_whole
= Fcons (event
->x
, event
->y
);
5991 part
= *scroll_bar_parts
[(int) event
->part
];
5995 Fcons (Qvertical_scroll_bar
,
5996 Fcons (portion_whole
,
5997 Fcons (make_number (event
->timestamp
),
5998 Fcons (part
, Qnil
)))));
6001 /* Always treat W32 scroll bar events as clicks. */
6002 event
->modifiers
|= click_modifier
;
6005 /* Get the symbol we should use for the mouse click. */
6008 head
= modify_event_symbol (button
,
6013 XVECTOR (mouse_syms
)->size
);
6019 #endif /* WINDOWSNT */
6021 case DRAG_N_DROP_EVENT
:
6024 Lisp_Object head
, position
;
6027 f
= XFRAME (event
->frame_or_window
);
6030 /* Ignore mouse events that were made on frames that
6031 have been deleted. */
6032 if (! FRAME_LIVE_P (f
))
6035 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6038 head
= modify_event_symbol (0, event
->modifiers
,
6040 lispy_drag_n_drop_names
,
6041 &drag_n_drop_syms
, 1);
6047 #endif /* HAVE_MOUSE */
6049 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
6050 || defined (USE_GTK)
6051 case MENU_BAR_EVENT
:
6052 if (EQ (event
->arg
, event
->frame_or_window
))
6053 /* This is the prefix key. We translate this to
6054 `(menu_bar)' because the code in keyboard.c for menu
6055 events, which we use, relies on this. */
6056 return Fcons (Qmenu_bar
, Qnil
);
6060 case SELECT_WINDOW_EVENT
:
6061 /* Make an event (select-window (WINDOW)). */
6062 return Fcons (Qselect_window
,
6063 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6066 case TOOL_BAR_EVENT
:
6067 if (EQ (event
->arg
, event
->frame_or_window
))
6068 /* This is the prefix key. We translate this to
6069 `(tool_bar)' because the code in keyboard.c for tool bar
6070 events, which we use, relies on this. */
6071 return Fcons (Qtool_bar
, Qnil
);
6072 else if (SYMBOLP (event
->arg
))
6073 return apply_modifiers (event
->modifiers
, event
->arg
);
6076 case USER_SIGNAL_EVENT
:
6077 /* A user signal. */
6079 char *name
= find_user_signal_name (event
->code
);
6082 return intern (name
);
6085 case SAVE_SESSION_EVENT
:
6086 return Qsave_session
;
6089 case MAC_APPLE_EVENT
:
6091 Lisp_Object spec
[2];
6095 return Fcons (Qmac_apple_event
,
6096 Fcons (Fvector (2, spec
),
6097 Fcons (event
->arg
, Qnil
)));
6101 /* The 'kind' field of the event is something we don't recognize. */
6110 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6112 Lisp_Object bar_window
;
6113 enum scroll_bar_part part
;
6117 /* Is it a scroll bar movement? */
6118 if (frame
&& ! NILP (bar_window
))
6120 Lisp_Object part_sym
;
6122 part_sym
= *scroll_bar_parts
[(int) part
];
6123 return Fcons (Qscroll_bar_movement
,
6124 (Fcons (Fcons (bar_window
,
6125 Fcons (Qvertical_scroll_bar
,
6126 Fcons (Fcons (x
, y
),
6127 Fcons (make_number (time
),
6133 /* Or is it an ordinary mouse movement? */
6136 Lisp_Object position
;
6138 position
= make_lispy_position (frame
, &x
, &y
, time
);
6140 return Fcons (Qmouse_movement
,
6146 #endif /* HAVE_MOUSE */
6148 /* Construct a switch frame event. */
6150 make_lispy_switch_frame (frame
)
6153 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6156 /* Manipulating modifiers. */
6158 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6160 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6161 SYMBOL's name of the end of the modifiers; the string from this
6162 position is the unmodified symbol name.
6164 This doesn't use any caches. */
6167 parse_modifiers_uncached (symbol
, modifier_end
)
6175 CHECK_SYMBOL (symbol
);
6178 name
= SYMBOL_NAME (symbol
);
6180 for (i
= 0; i
+2 <= SBYTES (name
); )
6182 int this_mod_end
= 0;
6185 /* See if the name continues with a modifier word.
6186 Check that the word appears, but don't check what follows it.
6187 Set this_mod and this_mod_end to record what we find. */
6189 switch (SREF (name
, i
))
6191 #define SINGLE_LETTER_MOD(BIT) \
6192 (this_mod_end = i + 1, this_mod = BIT)
6195 SINGLE_LETTER_MOD (alt_modifier
);
6199 SINGLE_LETTER_MOD (ctrl_modifier
);
6203 SINGLE_LETTER_MOD (hyper_modifier
);
6207 SINGLE_LETTER_MOD (meta_modifier
);
6211 SINGLE_LETTER_MOD (shift_modifier
);
6215 SINGLE_LETTER_MOD (super_modifier
);
6218 #undef SINGLE_LETTER_MOD
6220 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6221 if (i + LEN + 1 <= SBYTES (name) \
6222 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6224 this_mod_end = i + LEN; \
6229 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6230 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6231 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6235 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6237 #undef MULTI_LETTER_MOD
6241 /* If we found no modifier, stop looking for them. */
6242 if (this_mod_end
== 0)
6245 /* Check there is a dash after the modifier, so that it
6246 really is a modifier. */
6247 if (this_mod_end
>= SBYTES (name
)
6248 || SREF (name
, this_mod_end
) != '-')
6251 /* This modifier is real; look for another. */
6252 modifiers
|= this_mod
;
6253 i
= this_mod_end
+ 1;
6256 /* Should we include the `click' modifier? */
6257 if (! (modifiers
& (down_modifier
| drag_modifier
6258 | double_modifier
| triple_modifier
))
6259 && i
+ 7 == SBYTES (name
)
6260 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6261 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6262 modifiers
|= click_modifier
;
6270 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6271 prepended to the string BASE[0..BASE_LEN-1].
6272 This doesn't use any caches. */
6274 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6277 int base_len
, base_len_byte
;
6279 /* Since BASE could contain nulls, we can't use intern here; we have
6280 to use Fintern, which expects a genuine Lisp_String, and keeps a
6283 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6289 /* Only the event queue may use the `up' modifier; it should always
6290 be turned into a click or drag event before presented to lisp code. */
6291 if (modifiers
& up_modifier
)
6294 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6295 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6296 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6297 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6298 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6299 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6300 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6301 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6302 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6303 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6304 /* The click modifier is denoted by the absence of other modifiers. */
6308 mod_len
= p
- new_mods
;
6312 Lisp_Object new_name
;
6314 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6315 mod_len
+ base_len_byte
);
6316 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6317 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6319 return Fintern (new_name
, Qnil
);
6324 static char *modifier_names
[] =
6326 "up", "down", "drag", "click", "double", "triple", 0, 0,
6327 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6328 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6330 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6332 static Lisp_Object modifier_symbols
;
6334 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6336 lispy_modifier_list (modifiers
)
6339 Lisp_Object modifier_list
;
6342 modifier_list
= Qnil
;
6343 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6344 if (modifiers
& (1<<i
))
6345 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6348 return modifier_list
;
6352 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6353 where UNMODIFIED is the unmodified form of SYMBOL,
6354 MASK is the set of modifiers present in SYMBOL's name.
6355 This is similar to parse_modifiers_uncached, but uses the cache in
6356 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6357 Qevent_symbol_elements property. */
6360 parse_modifiers (symbol
)
6363 Lisp_Object elements
;
6365 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6366 if (CONSP (elements
))
6371 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6372 Lisp_Object unmodified
;
6375 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6376 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6379 if (modifiers
& ~INTMASK
)
6381 XSETFASTINT (mask
, modifiers
);
6382 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6384 /* Cache the parsing results on SYMBOL. */
6385 Fput (symbol
, Qevent_symbol_element_mask
,
6387 Fput (symbol
, Qevent_symbol_elements
,
6388 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6390 /* Since we know that SYMBOL is modifiers applied to unmodified,
6391 it would be nice to put that in unmodified's cache.
6392 But we can't, since we're not sure that parse_modifiers is
6399 /* Apply the modifiers MODIFIERS to the symbol BASE.
6400 BASE must be unmodified.
6402 This is like apply_modifiers_uncached, but uses BASE's
6403 Qmodifier_cache property, if present. It also builds
6404 Qevent_symbol_elements properties, since it has that info anyway.
6406 apply_modifiers copies the value of BASE's Qevent_kind property to
6407 the modified symbol. */
6409 apply_modifiers (modifiers
, base
)
6413 Lisp_Object cache
, index
, entry
, new_symbol
;
6415 /* Mask out upper bits. We don't know where this value's been. */
6416 modifiers
&= INTMASK
;
6418 /* The click modifier never figures into cache indices. */
6419 cache
= Fget (base
, Qmodifier_cache
);
6420 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6421 entry
= assq_no_quit (index
, cache
);
6424 new_symbol
= XCDR (entry
);
6427 /* We have to create the symbol ourselves. */
6428 new_symbol
= apply_modifiers_uncached (modifiers
,
6429 SDATA (SYMBOL_NAME (base
)),
6430 SCHARS (SYMBOL_NAME (base
)),
6431 SBYTES (SYMBOL_NAME (base
)));
6433 /* Add the new symbol to the base's cache. */
6434 entry
= Fcons (index
, new_symbol
);
6435 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6437 /* We have the parsing info now for free, so we could add it to
6439 XSETFASTINT (index, modifiers);
6440 Fput (new_symbol, Qevent_symbol_element_mask,
6441 Fcons (base, Fcons (index, Qnil)));
6442 Fput (new_symbol, Qevent_symbol_elements,
6443 Fcons (base, lispy_modifier_list (modifiers)));
6444 Sadly, this is only correct if `base' is indeed a base event,
6445 which is not necessarily the case. -stef */
6448 /* Make sure this symbol is of the same kind as BASE.
6450 You'd think we could just set this once and for all when we
6451 intern the symbol above, but reorder_modifiers may call us when
6452 BASE's property isn't set right; we can't assume that just
6453 because it has a Qmodifier_cache property it must have its
6454 Qevent_kind set right as well. */
6455 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6459 kind
= Fget (base
, Qevent_kind
);
6461 Fput (new_symbol
, Qevent_kind
, kind
);
6468 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6469 return a symbol with the modifiers placed in the canonical order.
6470 Canonical order is alphabetical, except for down and drag, which
6471 always come last. The 'click' modifier is never written out.
6473 Fdefine_key calls this to make sure that (for example) C-M-foo
6474 and M-C-foo end up being equivalent in the keymap. */
6477 reorder_modifiers (symbol
)
6480 /* It's hopefully okay to write the code this way, since everything
6481 will soon be in caches, and no consing will be done at all. */
6484 parsed
= parse_modifiers (symbol
);
6485 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6490 /* For handling events, we often want to produce a symbol whose name
6491 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6492 to some base, like the name of a function key or mouse button.
6493 modify_event_symbol produces symbols of this sort.
6495 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6496 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6499 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6500 into symbol names, or a string specifying a name stem used to
6501 construct a symbol name or the form `STEM-N', where N is the decimal
6502 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6503 non-nil; otherwise NAME_TABLE is used.
6505 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6506 persist between calls to modify_event_symbol that it can use to
6507 store a cache of the symbols it's generated for this NAME_TABLE
6508 before. The object stored there may be a vector or an alist.
6510 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6512 MODIFIERS is a set of modifier bits (as given in struct input_events)
6513 whose prefixes should be applied to the symbol name.
6515 SYMBOL_KIND is the value to be placed in the event_kind property of
6516 the returned symbol.
6518 The symbols we create are supposed to have an
6519 `event-symbol-elements' property, which lists the modifiers present
6520 in the symbol's name. */
6523 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6524 name_table
, symbol_table
, table_size
)
6527 Lisp_Object symbol_kind
;
6528 Lisp_Object name_alist_or_stem
;
6530 Lisp_Object
*symbol_table
;
6531 unsigned int table_size
;
6534 Lisp_Object symbol_int
;
6536 /* Get rid of the "vendor-specific" bit here. */
6537 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6539 /* Is this a request for a valid symbol? */
6540 if (symbol_num
< 0 || symbol_num
>= table_size
)
6543 if (CONSP (*symbol_table
))
6544 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6546 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6547 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6548 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6549 we've never used that symbol before. */
6552 if (! VECTORP (*symbol_table
)
6553 || XVECTOR (*symbol_table
)->size
!= table_size
)
6557 XSETFASTINT (size
, table_size
);
6558 *symbol_table
= Fmake_vector (size
, Qnil
);
6561 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6564 /* Have we already used this symbol before? */
6567 /* No; let's create it. */
6568 if (CONSP (name_alist_or_stem
))
6569 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6570 else if (STRINGP (name_alist_or_stem
))
6572 int len
= SBYTES (name_alist_or_stem
);
6573 char *buf
= (char *) alloca (len
+ 50);
6574 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6575 (long) XINT (symbol_int
) + 1);
6576 value
= intern (buf
);
6578 else if (name_table
!= 0 && name_table
[symbol_num
])
6579 value
= intern (name_table
[symbol_num
]);
6581 #ifdef HAVE_WINDOW_SYSTEM
6584 char *name
= x_get_keysym_name (symbol_num
);
6586 value
= intern (name
);
6593 sprintf (buf
, "key-%d", symbol_num
);
6594 value
= intern (buf
);
6597 if (CONSP (*symbol_table
))
6598 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6600 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6602 /* Fill in the cache entries for this symbol; this also
6603 builds the Qevent_symbol_elements property, which the user
6605 apply_modifiers (modifiers
& click_modifier
, value
);
6606 Fput (value
, Qevent_kind
, symbol_kind
);
6609 /* Apply modifiers to that symbol. */
6610 return apply_modifiers (modifiers
, value
);
6613 /* Convert a list that represents an event type,
6614 such as (ctrl meta backspace), into the usual representation of that
6615 event type as a number or a symbol. */
6617 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6618 doc
: /* Convert the event description list EVENT-DESC to an event type.
6619 EVENT-DESC should contain one base event type (a character or symbol)
6620 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6621 drag, down, double or triple). The base must be last.
6622 The return value is an event type (a character or symbol) which
6623 has the same base event type and all the specified modifiers. */)
6625 Lisp_Object event_desc
;
6633 while (CONSP (rest
))
6641 /* Given a symbol, see if it is a modifier name. */
6642 if (SYMBOLP (elt
) && CONSP (rest
))
6643 this = parse_solitary_modifier (elt
);
6647 else if (!NILP (base
))
6648 error ("Two bases given in one event");
6654 /* Let the symbol A refer to the character A. */
6655 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6656 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6658 if (INTEGERP (base
))
6660 /* Turn (shift a) into A. */
6661 if ((modifiers
& shift_modifier
) != 0
6662 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6664 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6665 modifiers
&= ~shift_modifier
;
6668 /* Turn (control a) into C-a. */
6669 if (modifiers
& ctrl_modifier
)
6670 return make_number ((modifiers
& ~ctrl_modifier
)
6671 | make_ctrl_char (XINT (base
)));
6673 return make_number (modifiers
| XINT (base
));
6675 else if (SYMBOLP (base
))
6676 return apply_modifiers (modifiers
, base
);
6679 error ("Invalid base event");
6684 /* Try to recognize SYMBOL as a modifier name.
6685 Return the modifier flag bit, or 0 if not recognized. */
6688 parse_solitary_modifier (symbol
)
6691 Lisp_Object name
= SYMBOL_NAME (symbol
);
6693 switch (SREF (name
, 0))
6695 #define SINGLE_LETTER_MOD(BIT) \
6696 if (SBYTES (name) == 1) \
6699 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6700 if (LEN == SBYTES (name) \
6701 && ! strncmp (SDATA (name), NAME, LEN)) \
6705 SINGLE_LETTER_MOD (alt_modifier
);
6709 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6713 SINGLE_LETTER_MOD (ctrl_modifier
);
6717 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6718 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6722 SINGLE_LETTER_MOD (hyper_modifier
);
6726 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6730 SINGLE_LETTER_MOD (meta_modifier
);
6734 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6738 SINGLE_LETTER_MOD (shift_modifier
);
6742 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6743 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6744 SINGLE_LETTER_MOD (super_modifier
);
6748 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6749 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6750 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6754 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6757 #undef SINGLE_LETTER_MOD
6758 #undef MULTI_LETTER_MOD
6764 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6765 Such a list is not valid as an event,
6766 but it can be a Lucid-style event type list. */
6769 lucid_event_type_list_p (object
)
6774 if (! CONSP (object
))
6777 if (EQ (XCAR (object
), Qhelp_echo
)
6778 || EQ (XCAR (object
), Qvertical_line
)
6779 || EQ (XCAR (object
), Qmode_line
)
6780 || EQ (XCAR (object
), Qheader_line
))
6783 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6787 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6794 /* Store into *addr a value nonzero if terminal input chars are available.
6795 Serves the purpose of ioctl (0, FIONREAD, addr)
6796 but works even if FIONREAD does not exist.
6797 (In fact, this may actually read some input.)
6799 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6800 timer events that are ripe.
6801 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6802 events (FOCUS_IN_EVENT).
6803 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6804 movements and toolkit scroll bar thumb drags. */
6807 get_input_pending (addr
, flags
)
6811 /* First of all, have we already counted some input? */
6812 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6814 /* If input is being read as it arrives, and we have none, there is none. */
6815 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6818 /* Try to read some input and see how much we get. */
6820 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6823 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6826 gobble_input (expected
)
6831 if (interrupt_input
)
6834 mask
= sigblock (sigmask (SIGIO
));
6835 read_avail_input (expected
);
6839 #ifdef POLL_FOR_INPUT
6840 /* XXX This condition was (read_socket_hook && !interrupt_input),
6841 but read_socket_hook is not global anymore. Let's pretend that
6843 if (!interrupt_input
&& poll_suppress_count
== 0)
6846 mask
= sigblock (sigmask (SIGALRM
));
6847 read_avail_input (expected
);
6853 read_avail_input (expected
);
6857 /* Put a BUFFER_SWITCH_EVENT in the buffer
6858 so that read_key_sequence will notice the new current buffer. */
6861 record_asynch_buffer_change ()
6863 struct input_event event
;
6867 event
.kind
= BUFFER_SWITCH_EVENT
;
6868 event
.frame_or_window
= Qnil
;
6872 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6873 The purpose of the event is to make read_key_sequence look up the
6874 keymaps again. If we aren't in read_key_sequence, we don't need one,
6875 and the event could cause trouble by messing up (input-pending-p). */
6876 tem
= Fwaiting_for_user_input_p ();
6880 /* We never need these events if we have no asynchronous subprocesses. */
6884 /* Make sure no interrupt happens while storing the event. */
6886 if (interrupt_input
)
6889 mask
= sigblock (sigmask (SIGIO
));
6890 kbd_buffer_store_event (&event
);
6897 kbd_buffer_store_event (&event
);
6904 /* Read any terminal input already buffered up by the system
6905 into the kbd_buffer, but do not wait.
6907 EXPECTED should be nonzero if the caller knows there is some input.
6909 Except on VMS, all input is read by this function.
6910 If interrupt_input is nonzero, this function MUST be called
6911 only when SIGIO is blocked.
6913 Returns the number of keyboard chars read, or -1 meaning
6914 this is a bad time to try to read input. */
6917 read_avail_input (expected
)
6924 /* Store pending user signal events, if any. */
6925 if (store_user_signal_events ())
6928 /* Loop through the available terminals, and call their input hooks. */
6932 struct terminal
*next
= t
->next_terminal
;
6934 if (t
->read_socket_hook
)
6937 struct input_event hold_quit
;
6939 EVENT_INIT (hold_quit
);
6940 hold_quit
.kind
= NO_EVENT
;
6942 /* No need for FIONREAD or fcntl; just say don't wait. */
6943 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6949 if (nr
== -1) /* Not OK to read input now. */
6953 else if (nr
== -2) /* Non-transient error. */
6955 /* The terminal device terminated; it should be closed. */
6957 /* Kill Emacs if this was our last terminal. */
6958 if (!terminal_list
->next_terminal
)
6959 /* Formerly simply reported no input, but that
6960 sometimes led to a failure of Emacs to terminate.
6961 SIGHUP seems appropriate if we can't reach the
6963 /* ??? Is it really right to send the signal just to
6964 this process rather than to the whole process
6965 group? Perhaps on systems with FIONREAD Emacs is
6966 alone in its group. */
6967 kill (getpid (), SIGHUP
);
6969 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
6970 if (t
->delete_terminal_hook
)
6971 (*t
->delete_terminal_hook
) (t
);
6973 delete_terminal (t
);
6976 if (hold_quit
.kind
!= NO_EVENT
)
6977 kbd_buffer_store_event (&hold_quit
);
6989 /* This is the tty way of reading available input.
6991 Note that each terminal device has its own `struct terminal' object,
6992 and so this function is called once for each individual termcap
6993 terminal. The first parameter indicates which terminal to read from. */
6996 tty_read_avail_input (struct terminal
*terminal
,
6998 struct input_event
*hold_quit
)
7000 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7001 the kbd_buffer can really hold. That may prevent loss
7002 of characters on some systems when input is stuffed at us. */
7003 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7005 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7008 if (terminal
->deleted
) /* Don't read from a deleted terminal. */
7011 if (terminal
->type
!= output_termcap
)
7014 /* XXX I think the following code should be moved to separate hook
7015 functions in system-dependent files. */
7018 #else /* not WINDOWSNT */
7020 n_to_read
= dos_keysns ();
7024 cbuf
[0] = dos_keyread ();
7027 #else /* not MSDOS */
7029 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7033 return 0; /* The terminal is suspended. */
7035 /* Determine how many characters we should *try* to read. */
7037 /* Find out how much input is available. */
7038 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7040 if (! noninteractive
)
7041 return -2; /* Close this terminal. */
7047 if (n_to_read
> sizeof cbuf
)
7048 n_to_read
= sizeof cbuf
;
7049 #else /* no FIONREAD */
7050 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
7051 /* Read some input if available, but don't wait. */
7052 n_to_read
= sizeof cbuf
;
7053 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7059 /* Now read; for one reason or another, this will not block.
7060 NREAD is set to the number of chars read. */
7063 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7064 /* POSIX infers that processes which are not in the session leader's
7065 process group won't get SIGHUP's at logout time. BSDI adheres to
7066 this part standard and returns -1 from read (0) with errno==EIO
7067 when the control tty is taken away.
7068 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7069 if (nread
== -1 && errno
== EIO
)
7070 return -2; /* Close this terminal. */
7071 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
7072 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7073 This looks incorrect, but it isn't, because _BSD causes
7074 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7075 and that causes a value other than 0 when there is no input. */
7077 return -2; /* Close this terminal. */
7081 /* We used to retry the read if it was interrupted.
7082 But this does the wrong thing when O_NDELAY causes
7083 an EAGAIN error. Does anybody know of a situation
7084 where a retry is actually needed? */
7086 nread
< 0 && (errno
== EAGAIN
7100 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
7101 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7102 #endif /* USG or DGUX or CYGWIN */
7103 #endif /* no FIONREAD */
7108 #endif /* not MSDOS */
7109 #endif /* not WINDOWSNT */
7111 for (i
= 0; i
< nread
; i
++)
7113 struct input_event buf
;
7115 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7117 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7118 buf
.modifiers
= meta_modifier
;
7119 if (tty
->meta_key
!= 2)
7123 /* Set the frame corresponding to the active tty. Note that the
7124 value of selected_frame is not reliable here, redisplay tends
7125 to temporarily change it. */
7126 buf
.frame_or_window
= tty
->top_frame
;
7129 kbd_buffer_store_event (&buf
);
7130 /* Don't look at input that follows a C-g too closely.
7131 This reduces lossage due to autorepeat on C-g. */
7132 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7133 && buf
.code
== quit_char
)
7139 #endif /* not VMS */
7142 handle_async_input ()
7145 extern int select_alarmed
;
7148 interrupt_input_pending
= 0;
7153 nread
= read_avail_input (1);
7154 /* -1 means it's not ok to read the input now.
7155 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7156 0 means there was no keyboard input available. */
7161 select_alarmed
= 1; /* Force the select emulator back to life */
7166 #ifdef SIGIO /* for entire page */
7167 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7170 input_available_signal (signo
)
7173 /* Must preserve main program's value of errno. */
7174 int old_errno
= errno
;
7175 #if defined (USG) && !defined (POSIX_SIGNALS)
7176 /* USG systems forget handlers when they are used;
7177 must reestablish each time */
7178 signal (signo
, input_available_signal
);
7186 interrupt_input_pending
= 1;
7188 SIGNAL_THREAD_CHECK (signo
);
7191 if (input_available_clear_time
)
7192 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7195 handle_async_input ();
7205 /* Send ourselves a SIGIO.
7207 This function exists so that the UNBLOCK_INPUT macro in
7208 blockinput.h can have some way to take care of input we put off
7209 dealing with, without assuming that every file which uses
7210 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7212 reinvoke_input_signal ()
7215 handle_async_input ();
7221 /* User signal events. */
7223 struct user_signal_info
7225 /* Signal number. */
7228 /* Name of the signal. */
7231 /* Number of pending signals. */
7234 struct user_signal_info
*next
;
7237 /* List of user signals. */
7238 static struct user_signal_info
*user_signals
= NULL
;
7241 add_user_signal (sig
, name
)
7245 struct user_signal_info
*p
;
7247 for (p
= user_signals
; p
; p
= p
->next
)
7249 /* Already added. */
7252 p
= xmalloc (sizeof (struct user_signal_info
));
7254 p
->name
= xstrdup (name
);
7256 p
->next
= user_signals
;
7259 signal (sig
, handle_user_signal
);
7263 handle_user_signal (sig
)
7266 int old_errno
= errno
;
7267 struct user_signal_info
*p
;
7269 #if defined (USG) && !defined (POSIX_SIGNALS)
7270 /* USG systems forget handlers when they are used;
7271 must reestablish each time */
7272 signal (sig
, handle_user_signal
);
7275 SIGNAL_THREAD_CHECK (sig
);
7277 for (p
= user_signals
; p
; p
= p
->next
)
7282 if (interrupt_input
)
7283 kill (getpid (), SIGIO
);
7287 /* Tell wait_reading_process_output that it needs to wake
7288 up and look around. */
7289 if (input_available_clear_time
)
7290 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7299 find_user_signal_name (sig
)
7302 struct user_signal_info
*p
;
7304 for (p
= user_signals
; p
; p
= p
->next
)
7312 store_user_signal_events ()
7314 struct user_signal_info
*p
;
7315 struct input_event buf
;
7318 for (p
= user_signals
; p
; p
= p
->next
)
7319 if (p
->npending
> 0)
7325 bzero (&buf
, sizeof buf
);
7326 buf
.kind
= USER_SIGNAL_EVENT
;
7327 buf
.frame_or_window
= selected_frame
;
7329 nstored
+= p
->npending
;
7331 mask
= sigblock (sigmask (p
->sig
));
7335 kbd_buffer_store_event (&buf
);
7338 while (p
->npending
> 0);
7346 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7347 static Lisp_Object menu_bar_one_keymap_changed_items
;
7349 /* These variables hold the vector under construction within
7350 menu_bar_items and its subroutines, and the current index
7351 for storing into that vector. */
7352 static Lisp_Object menu_bar_items_vector
;
7353 static int menu_bar_items_index
;
7355 /* Return a vector of menu items for a menu bar, appropriate
7356 to the current buffer. Each item has three elements in the vector:
7359 OLD is an old vector we can optionally reuse, or nil. */
7362 menu_bar_items (old
)
7365 /* The number of keymaps we're scanning right now, and the number of
7366 keymaps we have allocated space for. */
7369 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7370 in the current keymaps, or nil where it is not a prefix. */
7373 Lisp_Object def
, tail
;
7382 /* In order to build the menus, we need to call the keymap
7383 accessors. They all call QUIT. But this function is called
7384 during redisplay, during which a quit is fatal. So inhibit
7385 quitting while building the menus.
7386 We do this instead of specbind because (1) errors will clear it anyway
7387 and (2) this avoids risk of specpdl overflow. */
7388 oquit
= Vinhibit_quit
;
7392 menu_bar_items_vector
= old
;
7394 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7395 menu_bar_items_index
= 0;
7397 /* Build our list of keymaps.
7398 If we recognize a function key and replace its escape sequence in
7399 keybuf with its symbol, or if the sequence starts with a mouse
7400 click and we need to switch buffers, we jump back here to rebuild
7401 the initial keymaps from the current buffer. */
7405 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7406 if (!NILP (Voverriding_local_map_menu_flag
))
7408 /* Yes, use them (if non-nil) as well as the global map. */
7409 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7411 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7412 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7413 if (!NILP (Voverriding_local_map
))
7414 maps
[nmaps
++] = Voverriding_local_map
;
7418 /* No, so use major and minor mode keymaps and keymap property.
7419 Note that menu-bar bindings in the local-map and keymap
7420 properties may not work reliable, as they are only
7421 recognized when the menu-bar (or mode-line) is updated,
7422 which does not normally happen after every command. */
7425 nminor
= current_minor_maps (NULL
, &tmaps
);
7426 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7428 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7429 maps
[nmaps
++] = tem
;
7430 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7432 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7434 maps
[nmaps
++] = current_global_map
;
7437 /* Look up in each map the dummy prefix key `menu-bar'. */
7441 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7442 if (!NILP (maps
[mapno
]))
7444 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7448 menu_bar_one_keymap_changed_items
= Qnil
;
7449 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7453 /* Move to the end those items that should be at the end. */
7455 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7458 int end
= menu_bar_items_index
;
7460 for (i
= 0; i
< end
; i
+= 4)
7461 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7463 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7464 /* Move the item at index I to the end,
7465 shifting all the others forward. */
7466 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7467 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7468 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7469 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7471 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7472 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7473 (end
- i
- 4) * sizeof (Lisp_Object
));
7474 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7475 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7476 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7477 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7482 /* Add nil, nil, nil, nil at the end. */
7483 i
= menu_bar_items_index
;
7484 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7487 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7488 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7489 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7490 menu_bar_items_vector
= tem
;
7492 /* Add this item. */
7493 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7494 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7495 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7496 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7497 menu_bar_items_index
= i
;
7499 Vinhibit_quit
= oquit
;
7500 return menu_bar_items_vector
;
7503 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7504 If there's already an item for KEY, add this DEF to it. */
7506 Lisp_Object item_properties
;
7509 menu_bar_item (key
, item
, dummy1
, dummy2
)
7510 Lisp_Object key
, item
, dummy1
;
7513 struct gcpro gcpro1
;
7517 if (EQ (item
, Qundefined
))
7519 /* If a map has an explicit `undefined' as definition,
7520 discard any previously made menu bar item. */
7522 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7523 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7525 if (menu_bar_items_index
> i
+ 4)
7526 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7527 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7528 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7529 menu_bar_items_index
-= 4;
7533 /* If this keymap has already contributed to this KEY,
7534 don't contribute to it a second time. */
7535 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7536 if (!NILP (tem
) || NILP (item
))
7539 menu_bar_one_keymap_changed_items
7540 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7542 /* We add to menu_bar_one_keymap_changed_items before doing the
7543 parse_menu_item, so that if it turns out it wasn't a menu item,
7544 it still correctly hides any further menu item. */
7546 i
= parse_menu_item (item
, 0, 1);
7551 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7553 /* Find any existing item for this KEY. */
7554 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7555 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7558 /* If we did not find this KEY, add it at the end. */
7559 if (i
== menu_bar_items_index
)
7561 /* If vector is too small, get a bigger one. */
7562 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7565 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7566 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7567 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7568 menu_bar_items_vector
= tem
;
7571 /* Add this item. */
7572 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7573 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7574 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7575 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7576 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7577 menu_bar_items_index
= i
;
7579 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7583 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7584 /* If the new and the old items are not both keymaps,
7585 the lookup will only find `item'. */
7586 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7587 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7591 /* This is used as the handler when calling menu_item_eval_property. */
7593 menu_item_eval_property_1 (arg
)
7596 /* If we got a quit from within the menu computation,
7597 quit all the way out of it. This takes care of C-] in the debugger. */
7598 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7599 Fsignal (Qquit
, Qnil
);
7604 /* Evaluate an expression and return the result (or nil if something
7605 went wrong). Used to evaluate dynamic parts of menu items. */
7607 menu_item_eval_property (sexpr
)
7610 int count
= SPECPDL_INDEX ();
7612 specbind (Qinhibit_redisplay
, Qt
);
7613 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7614 menu_item_eval_property_1
);
7615 return unbind_to (count
, val
);
7618 /* This function parses a menu item and leaves the result in the
7619 vector item_properties.
7620 ITEM is a key binding, a possible menu item.
7621 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7622 evaluate dynamic expressions in the menu item.
7623 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7625 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7626 parse_menu_item returns true if the item is a menu item and false
7630 parse_menu_item (item
, notreal
, inmenubar
)
7632 int notreal
, inmenubar
;
7634 Lisp_Object def
, tem
, item_string
, start
;
7635 Lisp_Object cachelist
;
7637 Lisp_Object keyhint
;
7648 /* Create item_properties vector if necessary. */
7649 if (NILP (item_properties
))
7651 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7653 /* Initialize optional entries. */
7654 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7655 AREF (item_properties
, i
) = Qnil
;
7656 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7658 /* Save the item here to protect it from GC. */
7659 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7661 item_string
= XCAR (item
);
7665 if (STRINGP (item_string
))
7667 /* Old format menu item. */
7668 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7670 /* Maybe help string. */
7671 if (CONSP (item
) && STRINGP (XCAR (item
)))
7673 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7678 /* Maybe key binding cache. */
7679 if (CONSP (item
) && CONSP (XCAR (item
))
7680 && (NILP (XCAR (XCAR (item
)))
7681 || VECTORP (XCAR (XCAR (item
)))))
7683 cachelist
= XCAR (item
);
7687 /* This is the real definition--the function to run. */
7688 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7690 /* Get enable property, if any. */
7693 tem
= Fget (item
, Qmenu_enable
);
7694 if (!NILP (Venable_disabled_menus_and_buttons
))
7695 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7696 else if (!NILP (tem
))
7697 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7700 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7702 /* New format menu item. */
7703 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7704 start
= XCDR (item
);
7707 /* We have a real binding. */
7708 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7710 item
= XCDR (start
);
7711 /* Is there a cache list with key equivalences. */
7712 if (CONSP (item
) && CONSP (XCAR (item
)))
7714 cachelist
= XCAR (item
);
7718 /* Parse properties. */
7719 while (CONSP (item
) && CONSP (XCDR (item
)))
7724 if (EQ (tem
, QCenable
))
7726 if (!NILP (Venable_disabled_menus_and_buttons
))
7727 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7729 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7731 else if (EQ (tem
, QCvisible
) && !notreal
)
7733 /* If got a visible property and that evaluates to nil
7734 then ignore this item. */
7735 tem
= menu_item_eval_property (XCAR (item
));
7739 else if (EQ (tem
, QChelp
))
7740 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7741 else if (EQ (tem
, QCfilter
))
7743 else if (EQ (tem
, QCkey_sequence
))
7746 if (NILP (cachelist
)
7747 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7748 /* Be GC protected. Set keyhint to item instead of tem. */
7751 else if (EQ (tem
, QCkeys
))
7754 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7755 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7757 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7762 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7764 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7766 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7773 else if (inmenubar
|| !NILP (start
))
7777 return 0; /* not a menu item */
7779 /* If item string is not a string, evaluate it to get string.
7780 If we don't get a string, skip this item. */
7781 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7782 if (!(STRINGP (item_string
) || notreal
))
7784 item_string
= menu_item_eval_property (item_string
);
7785 if (!STRINGP (item_string
))
7787 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7790 /* If got a filter apply it on definition. */
7791 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7794 def
= menu_item_eval_property (list2 (XCAR (filter
),
7795 list2 (Qquote
, def
)));
7797 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7800 /* Enable or disable selection of item. */
7801 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7807 tem
= menu_item_eval_property (tem
);
7808 if (inmenubar
&& NILP (tem
))
7809 return 0; /* Ignore disabled items in menu bar. */
7810 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7813 /* If we got no definition, this item is just unselectable text which
7814 is OK in a submenu but not in the menubar. */
7816 return (inmenubar
? 0 : 1);
7818 /* See if this is a separate pane or a submenu. */
7819 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7820 tem
= get_keymap (def
, 0, 1);
7821 /* For a subkeymap, just record its details and exit. */
7824 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7825 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7829 /* At the top level in the menu bar, do likewise for commands also.
7830 The menu bar does not display equivalent key bindings anyway.
7831 ITEM_PROPERTY_DEF is already set up properly. */
7835 /* This is a command. See if there is an equivalent key binding. */
7836 if (NILP (cachelist
))
7838 /* We have to create a cachelist. */
7839 CHECK_IMPURE (start
);
7840 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7841 cachelist
= XCAR (XCDR (start
));
7843 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7844 if (!NILP (keyhint
))
7846 XSETCAR (cachelist
, XCAR (keyhint
));
7849 else if (STRINGP (tem
))
7851 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7852 XSETCAR (cachelist
, Qt
);
7856 tem
= XCAR (cachelist
);
7863 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
7865 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7868 def
= XCAR (prefix
);
7869 prefix
= XCDR (prefix
);
7872 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7874 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7876 if (newcache
/* Always check first time. */
7877 /* Should we check everything when precomputing key
7879 /* If something had no key binding before, don't recheck it
7880 because that is too slow--except if we have a list of
7881 rebound commands in Vdefine_key_rebound_commands, do
7882 recheck any command that appears in that list. */
7883 || (CONSP (Vdefine_key_rebound_commands
)
7884 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7887 /* We had a saved key. Is it still bound to the command? */
7890 /* If the command is an alias for another
7891 (such as lmenu.el set it up), check if the
7892 original command matches the cached command. */
7893 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7894 chkcache
= 1; /* Need to recompute key binding. */
7898 /* Recompute equivalent key binding. If the command is an alias
7899 for another (such as lmenu.el set it up), see if the original
7900 command name has equivalent keys. Otherwise look up the
7901 specified command itself. We don't try both, because that
7902 makes lmenu menus slow. */
7904 && SYMBOLP (XSYMBOL (def
)->function
)
7905 && ! NILP (Fget (def
, Qmenu_alias
)))
7906 def
= XSYMBOL (def
)->function
;
7907 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7908 XSETCAR (cachelist
, tem
);
7911 XSETCDR (cachelist
, Qnil
);
7915 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7917 tem
= XCAR (cachelist
);
7921 newcache
= chkcache
;
7924 tem
= Fkey_description (tem
, Qnil
);
7927 if (STRINGP (XCAR (prefix
)))
7928 tem
= concat2 (XCAR (prefix
), tem
);
7929 if (STRINGP (XCDR (prefix
)))
7930 tem
= concat2 (tem
, XCDR (prefix
));
7932 XSETCDR (cachelist
, tem
);
7936 tem
= XCDR (cachelist
);
7937 if (newcache
&& !NILP (tem
))
7939 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7940 XSETCDR (cachelist
, tem
);
7943 /* If we only want to precompute equivalent key bindings, stop here. */
7947 /* If we have an equivalent key binding, use that. */
7948 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7950 /* Include this when menu help is implemented.
7951 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7952 if (!(NILP (tem) || STRINGP (tem)))
7954 tem = menu_item_eval_property (tem);
7957 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7961 /* Handle radio buttons or toggle boxes. */
7962 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7964 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7965 = menu_item_eval_property (tem
);
7972 /***********************************************************************
7974 ***********************************************************************/
7976 /* A vector holding tool bar items while they are parsed in function
7977 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7980 static Lisp_Object tool_bar_items_vector
;
7982 /* A vector holding the result of parse_tool_bar_item. Layout is like
7983 the one for a single item in tool_bar_items_vector. */
7985 static Lisp_Object tool_bar_item_properties
;
7987 /* Next free index in tool_bar_items_vector. */
7989 static int ntool_bar_items
;
7991 /* The symbols `tool-bar', and `:image'. */
7993 extern Lisp_Object Qtool_bar
;
7994 Lisp_Object QCimage
;
7996 /* Function prototypes. */
7998 static void init_tool_bar_items
P_ ((Lisp_Object
));
7999 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8000 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8001 static void append_tool_bar_item
P_ ((void));
8004 /* Return a vector of tool bar items for keymaps currently in effect.
8005 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8006 tool bar items found. */
8009 tool_bar_items (reuse
, nitems
)
8020 /* In order to build the menus, we need to call the keymap
8021 accessors. They all call QUIT. But this function is called
8022 during redisplay, during which a quit is fatal. So inhibit
8023 quitting while building the menus. We do this instead of
8024 specbind because (1) errors will clear it anyway and (2) this
8025 avoids risk of specpdl overflow. */
8026 oquit
= Vinhibit_quit
;
8029 /* Initialize tool_bar_items_vector and protect it from GC. */
8030 init_tool_bar_items (reuse
);
8032 /* Build list of keymaps in maps. Set nmaps to the number of maps
8035 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8036 if (!NILP (Voverriding_local_map_menu_flag
))
8038 /* Yes, use them (if non-nil) as well as the global map. */
8039 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8041 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8042 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8043 if (!NILP (Voverriding_local_map
))
8044 maps
[nmaps
++] = Voverriding_local_map
;
8048 /* No, so use major and minor mode keymaps and keymap property.
8049 Note that tool-bar bindings in the local-map and keymap
8050 properties may not work reliable, as they are only
8051 recognized when the tool-bar (or mode-line) is updated,
8052 which does not normally happen after every command. */
8055 nminor
= current_minor_maps (NULL
, &tmaps
);
8056 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8058 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8059 maps
[nmaps
++] = tem
;
8060 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8062 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8065 /* Add global keymap at the end. */
8066 maps
[nmaps
++] = current_global_map
;
8068 /* Process maps in reverse order and look up in each map the prefix
8070 for (i
= nmaps
- 1; i
>= 0; --i
)
8071 if (!NILP (maps
[i
]))
8075 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8077 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8080 Vinhibit_quit
= oquit
;
8081 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8082 return tool_bar_items_vector
;
8086 /* Process the definition of KEY which is DEF. */
8089 process_tool_bar_item (key
, def
, data
, args
)
8090 Lisp_Object key
, def
, data
;
8094 extern Lisp_Object Qundefined
;
8095 struct gcpro gcpro1
, gcpro2
;
8097 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8101 if (EQ (def
, Qundefined
))
8103 /* If a map has an explicit `undefined' as definition,
8104 discard any previously made item. */
8105 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8107 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8109 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8111 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8112 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8113 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8114 * sizeof (Lisp_Object
)));
8115 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8120 else if (parse_tool_bar_item (key
, def
))
8121 /* Append a new tool bar item to tool_bar_items_vector. Accept
8122 more than one definition for the same key. */
8123 append_tool_bar_item ();
8129 /* Parse a tool bar item specification ITEM for key KEY and return the
8130 result in tool_bar_item_properties. Value is zero if ITEM is
8133 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8135 CAPTION is the caption of the item, If it's not a string, it is
8136 evaluated to get a string.
8138 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8139 as binding are currently ignored.
8141 The following properties are recognized:
8145 FORM is evaluated and specifies whether the tool bar item is
8146 enabled or disabled.
8150 FORM is evaluated and specifies whether the tool bar item is visible.
8152 - `:filter FUNCTION'
8154 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8155 result is stored as the new binding.
8157 - `:button (TYPE SELECTED)'
8159 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8160 and specifies whether the button is selected (pressed) or not.
8164 IMAGES is either a single image specification or a vector of four
8165 image specifications. See enum tool_bar_item_images.
8167 - `:help HELP-STRING'.
8169 Gives a help string to display for the tool bar item. */
8172 parse_tool_bar_item (key
, item
)
8173 Lisp_Object key
, item
;
8175 /* Access slot with index IDX of vector tool_bar_item_properties. */
8176 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8178 Lisp_Object filter
= Qnil
;
8179 Lisp_Object caption
;
8182 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8183 Rule out items that aren't lists, don't start with
8184 `menu-item' or whose rest following `tool-bar-item' is not a
8187 || !EQ (XCAR (item
), Qmenu_item
)
8188 || (item
= XCDR (item
),
8192 /* Create tool_bar_item_properties vector if necessary. Reset it to
8194 if (VECTORP (tool_bar_item_properties
))
8196 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8200 tool_bar_item_properties
8201 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8204 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8205 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8207 /* Get the caption of the item. If the caption is not a string,
8208 evaluate it to get a string. If we don't get a string, skip this
8210 caption
= XCAR (item
);
8211 if (!STRINGP (caption
))
8213 caption
= menu_item_eval_property (caption
);
8214 if (!STRINGP (caption
))
8217 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8219 /* Give up if rest following the caption is not a list. */
8224 /* Store the binding. */
8225 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8228 /* Ignore cached key binding, if any. */
8229 if (CONSP (item
) && CONSP (XCAR (item
)))
8232 /* Process the rest of the properties. */
8233 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8235 Lisp_Object key
, value
;
8238 value
= XCAR (XCDR (item
));
8240 if (EQ (key
, QCenable
))
8242 /* `:enable FORM'. */
8243 if (!NILP (Venable_disabled_menus_and_buttons
))
8244 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8246 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8248 else if (EQ (key
, QCvisible
))
8250 /* `:visible FORM'. If got a visible property and that
8251 evaluates to nil then ignore this item. */
8252 if (NILP (menu_item_eval_property (value
)))
8255 else if (EQ (key
, QChelp
))
8256 /* `:help HELP-STRING'. */
8257 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8258 else if (EQ (key
, QCfilter
))
8259 /* ':filter FORM'. */
8261 else if (EQ (key
, QCbutton
) && CONSP (value
))
8263 /* `:button (TYPE . SELECTED)'. */
8264 Lisp_Object type
, selected
;
8266 type
= XCAR (value
);
8267 selected
= XCDR (value
);
8268 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8270 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8271 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8274 else if (EQ (key
, QCimage
)
8276 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8277 /* Value is either a single image specification or a vector
8278 of 4 such specifications for the different button states. */
8279 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8282 /* If got a filter apply it on binding. */
8284 PROP (TOOL_BAR_ITEM_BINDING
)
8285 = menu_item_eval_property (list2 (filter
,
8287 PROP (TOOL_BAR_ITEM_BINDING
))));
8289 /* See if the binding is a keymap. Give up if it is. */
8290 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8293 /* Enable or disable selection of item. */
8294 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8295 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8296 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8298 /* Handle radio buttons or toggle boxes. */
8299 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8300 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8301 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8309 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8310 that can be reused. */
8313 init_tool_bar_items (reuse
)
8316 if (VECTORP (reuse
))
8317 tool_bar_items_vector
= reuse
;
8319 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8320 ntool_bar_items
= 0;
8324 /* Append parsed tool bar item properties from
8325 tool_bar_item_properties */
8328 append_tool_bar_item ()
8330 Lisp_Object
*to
, *from
;
8332 /* Enlarge tool_bar_items_vector if necessary. */
8333 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8334 >= XVECTOR (tool_bar_items_vector
)->size
)
8336 Lisp_Object new_vector
;
8337 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
8339 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
8340 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
8341 XVECTOR (new_vector
)->contents
,
8342 old_size
* sizeof (Lisp_Object
));
8343 tool_bar_items_vector
= new_vector
;
8346 /* Append entries from tool_bar_item_properties to the end of
8347 tool_bar_items_vector. */
8348 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8349 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8350 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8351 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8358 /* Read a character using menus based on maps in the array MAPS.
8359 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8360 Return t if we displayed a menu but the user rejected it.
8362 PREV_EVENT is the previous input event, or nil if we are reading
8363 the first event of a key sequence.
8365 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8366 if we used a mouse menu to read the input, or zero otherwise. If
8367 USED_MOUSE_MENU is null, we don't dereference it.
8369 The prompting is done based on the prompt-string of the map
8370 and the strings associated with various map elements.
8372 This can be done with X menus or with menus put in the minibuf.
8373 These are done in different ways, depending on how the input will be read.
8374 Menus using X are done after auto-saving in read-char, getting the input
8375 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8376 and do auto-saving in the inner call of read_char. */
8379 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8382 Lisp_Object prev_event
;
8383 int *used_mouse_menu
;
8386 register Lisp_Object name
= Qnil
;
8388 if (used_mouse_menu
)
8389 *used_mouse_menu
= 0;
8391 /* Use local over global Menu maps */
8393 if (! menu_prompting
)
8396 /* Optionally disregard all but the global map. */
8397 if (inhibit_local_menu_bar_menus
)
8399 maps
+= (nmaps
- 1);
8403 /* Get the menu name from the first map that has one (a prompt string). */
8404 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8406 name
= Fkeymap_prompt (maps
[mapno
]);
8411 /* If we don't have any menus, just read a character normally. */
8412 if (!STRINGP (name
))
8416 /* If we got to this point via a mouse click,
8417 use a real menu for mouse selection. */
8418 if (EVENT_HAS_PARAMETERS (prev_event
)
8419 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8420 && !EQ (XCAR (prev_event
), Qtool_bar
))
8422 /* Display the menu and get the selection. */
8423 Lisp_Object
*realmaps
8424 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8428 /* Use the maps that are not nil. */
8429 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8430 if (!NILP (maps
[mapno
]))
8431 realmaps
[nmaps1
++] = maps
[mapno
];
8433 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8438 record_menu_key (XCAR (value
));
8440 /* If we got multiple events, unread all but
8442 There is no way to prevent those unread events
8443 from showing up later in last_nonmenu_event.
8444 So turn symbol and integer events into lists,
8445 to indicate that they came from a mouse menu,
8446 so that when present in last_nonmenu_event
8447 they won't confuse things. */
8448 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8450 record_menu_key (XCAR (tem
));
8451 if (SYMBOLP (XCAR (tem
))
8452 || INTEGERP (XCAR (tem
)))
8453 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8456 /* If we got more than one event, put all but the first
8457 onto this list to be read later.
8458 Return just the first event now. */
8459 Vunread_command_events
8460 = nconc2 (XCDR (value
), Vunread_command_events
);
8461 value
= XCAR (value
);
8463 else if (NILP (value
))
8465 if (used_mouse_menu
)
8466 *used_mouse_menu
= 1;
8469 #endif /* HAVE_MENUS */
8473 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8474 We make this bigger when necessary, and never free it. */
8475 static char *read_char_minibuf_menu_text
;
8476 /* Size of that buffer. */
8477 static int read_char_minibuf_menu_width
;
8480 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8486 register Lisp_Object name
;
8488 /* FIXME: Use the minibuffer's frame width. */
8489 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8492 Lisp_Object rest
, vector
;
8498 if (! menu_prompting
)
8501 /* Make sure we have a big enough buffer for the menu text. */
8502 if (read_char_minibuf_menu_text
== 0)
8504 read_char_minibuf_menu_width
= width
+ 4;
8505 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8507 else if (width
+ 4 > read_char_minibuf_menu_width
)
8509 read_char_minibuf_menu_width
= width
+ 4;
8510 read_char_minibuf_menu_text
8511 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8513 menu
= read_char_minibuf_menu_text
;
8515 /* Get the menu name from the first map that has one (a prompt string). */
8516 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8518 name
= Fkeymap_prompt (maps
[mapno
]);
8523 /* If we don't have any menus, just read a character normally. */
8524 if (!STRINGP (name
))
8527 /* Prompt string always starts with map's prompt, and a space. */
8528 strcpy (menu
, SDATA (name
));
8529 nlength
= SBYTES (name
);
8530 menu
[nlength
++] = ':';
8531 menu
[nlength
++] = ' ';
8534 /* Start prompting at start of first map. */
8538 /* Present the documented bindings, a line at a time. */
8545 Lisp_Object orig_defn_macro
;
8547 /* Loop over elements of map. */
8552 /* If reached end of map, start at beginning of next map. */
8556 /* At end of last map, wrap around to first map if just starting,
8557 or end this line if already have something on it. */
8561 if (notfirst
|| nobindings
) break;
8566 /* Look at the next element of the map. */
8568 elt
= XVECTOR (vector
)->contents
[idx
];
8570 elt
= Fcar_safe (rest
);
8572 if (idx
< 0 && VECTORP (elt
))
8574 /* If we found a dense table in the keymap,
8575 advanced past it, but start scanning its contents. */
8576 rest
= Fcdr_safe (rest
);
8582 /* An ordinary element. */
8583 Lisp_Object event
, tem
;
8587 event
= Fcar_safe (elt
); /* alist */
8588 elt
= Fcdr_safe (elt
);
8592 XSETINT (event
, idx
); /* vector */
8595 /* Ignore the element if it has no prompt string. */
8596 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8598 /* 1 if the char to type matches the string. */
8600 Lisp_Object upcased_event
, downcased_event
;
8601 Lisp_Object desc
= Qnil
;
8603 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8605 upcased_event
= Fupcase (event
);
8606 downcased_event
= Fdowncase (event
);
8607 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8608 || XINT (downcased_event
) == SREF (s
, 0));
8610 desc
= Fsingle_key_description (event
, Qnil
);
8612 #if 0 /* It is redundant to list the equivalent key bindings because
8613 the prefix is what the user has already typed. */
8615 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8617 /* Insert equivalent keybinding. */
8618 s
= concat2 (s
, tem
);
8621 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8622 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8624 /* Insert button prefix. */
8625 Lisp_Object selected
8626 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8627 if (EQ (tem
, QCradio
))
8628 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8630 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8631 s
= concat2 (tem
, s
);
8635 /* If we have room for the prompt string, add it to this line.
8636 If this is the first on the line, always add it. */
8637 if ((SCHARS (s
) + i
+ 2
8638 + (char_matches
? 0 : SCHARS (desc
) + 3))
8644 /* Punctuate between strings. */
8647 strcpy (menu
+ i
, ", ");
8653 /* If the char to type doesn't match the string's
8654 first char, explicitly show what char to type. */
8657 /* Add as much of string as fits. */
8658 thiswidth
= SCHARS (desc
);
8659 if (thiswidth
+ i
> width
)
8660 thiswidth
= width
- i
;
8661 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8663 strcpy (menu
+ i
, " = ");
8667 /* Add as much of string as fits. */
8668 thiswidth
= SCHARS (s
);
8669 if (thiswidth
+ i
> width
)
8670 thiswidth
= width
- i
;
8671 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8677 /* If this element does not fit, end the line now,
8678 and save the element for the next line. */
8679 strcpy (menu
+ i
, "...");
8684 /* Move past this element. */
8685 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8686 /* Handle reaching end of dense table. */
8691 rest
= Fcdr_safe (rest
);
8695 /* Prompt with that and read response. */
8696 message2_nolog (menu
, strlen (menu
),
8697 ! NILP (current_buffer
->enable_multibyte_characters
));
8699 /* Make believe its not a keyboard macro in case the help char
8700 is pressed. Help characters are not recorded because menu prompting
8701 is not used on replay.
8703 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8704 current_kboard
->defining_kbd_macro
= Qnil
;
8706 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8707 while (BUFFERP (obj
));
8708 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8710 if (!INTEGERP (obj
))
8712 else if (XINT (obj
) == -2)
8717 if (! EQ (obj
, menu_prompt_more_char
)
8718 && (!INTEGERP (menu_prompt_more_char
)
8719 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8721 if (!NILP (current_kboard
->defining_kbd_macro
))
8722 store_kbd_macro_char (obj
);
8725 /* Help char - go round again */
8729 /* Reading key sequences. */
8731 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8732 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8733 keymap, or nil otherwise. Return the index of the first keymap in
8734 which KEY has any binding, or NMAPS if no map has a binding.
8736 If KEY is a meta ASCII character, treat it like meta-prefix-char
8737 followed by the corresponding non-meta character. Keymaps in
8738 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8741 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8744 NEXT may be the same array as CURRENT. */
8747 follow_key (key
, nmaps
, current
, defs
, next
)
8749 Lisp_Object
*current
, *defs
, *next
;
8752 int i
, first_binding
;
8754 first_binding
= nmaps
;
8755 for (i
= nmaps
- 1; i
>= 0; i
--)
8757 if (! NILP (current
[i
]))
8759 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8760 if (! NILP (defs
[i
]))
8767 /* Given the set of bindings we've found, produce the next set of maps. */
8768 if (first_binding
< nmaps
)
8769 for (i
= 0; i
< nmaps
; i
++)
8770 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8772 return first_binding
;
8775 /* Structure used to keep track of partial application of key remapping
8776 such as Vfunction_key_map and Vkey_translation_map. */
8777 typedef struct keyremap
8779 /* This is the map originally specified for this use. */
8781 /* This is a submap reached by looking up, in PARENT,
8782 the events from START to END. */
8784 /* Positions [START, END) in the key sequence buffer
8785 are the key that we have scanned so far.
8786 Those events are the ones that we will replace
8787 if PAREHT maps them into a key sequence. */
8791 /* Lookup KEY in MAP.
8792 MAP is a keymap mapping keys to key vectors or functions.
8793 If the mapping is a function and DO_FUNCTION is non-zero, then
8794 the function is called with PROMPT as parameter and its return
8795 value is used as the return value of this function (after checking
8796 that it is indeed a vector). */
8799 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8800 Lisp_Object map
, key
, prompt
;
8805 next
= access_keymap (map
, key
, 1, 0, 1);
8807 /* Handle symbol with autoload definition. */
8808 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8809 && CONSP (XSYMBOL (next
)->function
)
8810 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8811 do_autoload (XSYMBOL (next
)->function
, next
);
8813 /* Handle a symbol whose function definition is a keymap
8815 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8816 && (ARRAYP (XSYMBOL (next
)->function
)
8817 || KEYMAPP (XSYMBOL (next
)->function
)))
8818 next
= XSYMBOL (next
)->function
;
8820 /* If the keymap gives a function, not an
8821 array, then call the function with one arg and use
8822 its value instead. */
8823 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8828 next
= call1 (next
, prompt
);
8829 /* If the function returned something invalid,
8830 barf--don't ignore it.
8831 (To ignore it safely, we would need to gcpro a bunch of
8832 other variables.) */
8833 if (! (VECTORP (next
) || STRINGP (next
)))
8834 error ("Function %s returns invalid key sequence", tem
);
8839 /* Do one step of the key remapping used for function-key-map and
8840 key-translation-map:
8841 KEYBUF is the buffer holding the input events.
8842 BUFSIZE is its maximum size.
8843 FKEY is a pointer to the keyremap structure to use.
8844 INPUT is the index of the last element in KEYBUF.
8845 DOIT if non-zero says that the remapping can actually take place.
8846 DIFF is used to return the number of keys added/removed by the remapping.
8847 PARENT is the root of the keymap.
8848 PROMPT is the prompt to use if the remapping happens through a function.
8849 The return value is non-zero if the remapping actually took place. */
8852 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8853 Lisp_Object
*keybuf
, prompt
;
8855 int input
, doit
, *diff
, bufsize
;
8857 Lisp_Object next
, key
;
8859 key
= keybuf
[fkey
->end
++];
8861 if (KEYMAPP (fkey
->parent
))
8862 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8866 /* If keybuf[fkey->start..fkey->end] is bound in the
8867 map and we're in a position to do the key remapping, replace it with
8868 the binding and restart with fkey->start at the end. */
8869 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8871 int len
= XFASTINT (Flength (next
));
8874 *diff
= len
- (fkey
->end
- fkey
->start
);
8876 if (input
+ *diff
>= bufsize
)
8877 error ("Key sequence too long");
8879 /* Shift the keys that follow fkey->end. */
8881 for (i
= fkey
->end
; i
< input
; i
++)
8882 keybuf
[i
+ *diff
] = keybuf
[i
];
8884 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8885 keybuf
[i
+ *diff
] = keybuf
[i
];
8886 /* Overwrite the old keys with the new ones. */
8887 for (i
= 0; i
< len
; i
++)
8888 keybuf
[fkey
->start
+ i
]
8889 = Faref (next
, make_number (i
));
8891 fkey
->start
= fkey
->end
+= *diff
;
8892 fkey
->map
= fkey
->parent
;
8897 fkey
->map
= get_keymap (next
, 0, 1);
8899 /* If we no longer have a bound suffix, try a new position for
8901 if (!CONSP (fkey
->map
))
8903 fkey
->end
= ++fkey
->start
;
8904 fkey
->map
= fkey
->parent
;
8909 /* Read a sequence of keys that ends with a non prefix character,
8910 storing it in KEYBUF, a buffer of size BUFSIZE.
8912 Return the length of the key sequence stored.
8913 Return -1 if the user rejected a command menu.
8915 Echo starting immediately unless `prompt' is 0.
8917 Where a key sequence ends depends on the currently active keymaps.
8918 These include any minor mode keymaps active in the current buffer,
8919 the current buffer's local map, and the global map.
8921 If a key sequence has no other bindings, we check Vfunction_key_map
8922 to see if some trailing subsequence might be the beginning of a
8923 function key's sequence. If so, we try to read the whole function
8924 key, and substitute its symbolic name into the key sequence.
8926 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8927 `double-' events into similar click events, if that would make them
8928 bound. We try to turn `triple-' events first into `double-' events,
8931 If we get a mouse click in a mode line, vertical divider, or other
8932 non-text area, we treat the click as if it were prefixed by the
8933 symbol denoting that area - `mode-line', `vertical-line', or
8936 If the sequence starts with a mouse click, we read the key sequence
8937 with respect to the buffer clicked on, not the current buffer.
8939 If the user switches frames in the midst of a key sequence, we put
8940 off the switch-frame event until later; the next call to
8941 read_char will return it.
8943 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8944 from the selected window's buffer. */
8947 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8948 can_return_switch_frame
, fix_current_buffer
)
8949 Lisp_Object
*keybuf
;
8952 int dont_downcase_last
;
8953 int can_return_switch_frame
;
8954 int fix_current_buffer
;
8956 volatile Lisp_Object from_string
;
8957 volatile int count
= SPECPDL_INDEX ();
8959 /* How many keys there are in the current key sequence. */
8962 /* The length of the echo buffer when we started reading, and
8963 the length of this_command_keys when we started reading. */
8964 volatile int echo_start
;
8965 volatile int keys_start
;
8967 /* The number of keymaps we're scanning right now, and the number of
8968 keymaps we have allocated space for. */
8970 volatile int nmaps_allocated
= 0;
8972 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8973 the current keymaps. */
8974 Lisp_Object
*volatile defs
= NULL
;
8976 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8977 in the current keymaps, or nil where it is not a prefix. */
8978 Lisp_Object
*volatile submaps
= NULL
;
8980 /* The local map to start out with at start of key sequence. */
8981 volatile Lisp_Object orig_local_map
;
8983 /* The map from the `keymap' property to start out with at start of
8985 volatile Lisp_Object orig_keymap
;
8987 /* 1 if we have already considered switching to the local-map property
8988 of the place where a mouse click occurred. */
8989 volatile int localized_local_map
= 0;
8991 /* The index in defs[] of the first keymap that has a binding for
8992 this key sequence. In other words, the lowest i such that
8993 defs[i] is non-nil. */
8994 volatile int first_binding
;
8995 /* Index of the first key that has no binding.
8996 It is useless to try fkey.start larger than that. */
8997 volatile int first_unbound
;
8999 /* If t < mock_input, then KEYBUF[t] should be read as the next
9002 We use this to recover after recognizing a function key. Once we
9003 realize that a suffix of the current key sequence is actually a
9004 function key's escape sequence, we replace the suffix with the
9005 function key's binding from Vfunction_key_map. Now keybuf
9006 contains a new and different key sequence, so the echo area,
9007 this_command_keys, and the submaps and defs arrays are wrong. In
9008 this situation, we set mock_input to t, set t to 0, and jump to
9009 restart_sequence; the loop will read keys from keybuf up until
9010 mock_input, thus rebuilding the state; and then it will resume
9011 reading characters from the keyboard. */
9012 volatile int mock_input
= 0;
9014 /* If the sequence is unbound in submaps[], then
9015 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9016 and fkey.map is its binding.
9018 These might be > t, indicating that all function key scanning
9019 should hold off until t reaches them. We do this when we've just
9020 recognized a function key, to avoid searching for the function
9021 key's again in Vfunction_key_map. */
9022 volatile keyremap fkey
;
9024 /* Likewise, for key_translation_map. */
9025 volatile keyremap keytran
;
9027 /* If we receive a `switch-frame' or `select-window' event in the middle of
9028 a key sequence, we put it off for later.
9029 While we're reading, we keep the event here. */
9030 volatile Lisp_Object delayed_switch_frame
;
9032 /* See the comment below... */
9033 #if defined (GOBBLE_FIRST_EVENT)
9034 Lisp_Object first_event
;
9037 volatile Lisp_Object original_uppercase
;
9038 volatile int original_uppercase_position
= -1;
9040 /* Gets around Microsoft compiler limitations. */
9043 struct buffer
*starting_buffer
;
9045 /* List of events for which a fake prefix key has been generated. */
9046 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9048 #if defined (GOBBLE_FIRST_EVENT)
9052 struct gcpro gcpro1
;
9054 GCPRO1 (fake_prefixed_keys
);
9055 raw_keybuf_count
= 0;
9057 last_nonmenu_event
= Qnil
;
9059 delayed_switch_frame
= Qnil
;
9064 echo_prompt (prompt
);
9065 else if (cursor_in_echo_area
9066 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9067 && NILP (Fzerop (Vecho_keystrokes
)))
9068 /* This doesn't put in a dash if the echo buffer is empty, so
9069 you don't always see a dash hanging out in the minibuffer. */
9073 /* Record the initial state of the echo area and this_command_keys;
9074 we will need to restore them if we replay a key sequence. */
9076 echo_start
= echo_length ();
9077 keys_start
= this_command_key_count
;
9078 this_single_command_key_start
= keys_start
;
9080 #if defined (GOBBLE_FIRST_EVENT)
9081 /* This doesn't quite work, because some of the things that read_char
9082 does cannot safely be bypassed. It seems too risky to try to make
9085 /* Read the first char of the sequence specially, before setting
9086 up any keymaps, in case a filter runs and switches buffers on us. */
9087 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9089 #endif /* GOBBLE_FIRST_EVENT */
9091 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9092 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9095 /* We jump here when the key sequence has been thoroughly changed, and
9096 we need to rescan it starting from the beginning. When we jump here,
9097 keybuf[0..mock_input] holds the sequence we should reread. */
9100 /* We may switch keyboards between rescans, so we need to
9101 reinitialize fkey and keytran before each replay. */
9102 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9103 keytran
.map
= keytran
.parent
= current_kboard
->Vlocal_key_translation_map
;
9104 fkey
.start
= fkey
.end
= 0;
9105 keytran
.start
= keytran
.end
= 0;
9107 starting_buffer
= current_buffer
;
9108 first_unbound
= bufsize
+ 1;
9110 /* Build our list of keymaps.
9111 If we recognize a function key and replace its escape sequence in
9112 keybuf with its symbol, or if the sequence starts with a mouse
9113 click and we need to switch buffers, we jump back here to rebuild
9114 the initial keymaps from the current buffer. */
9117 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9119 if (2 > nmaps_allocated
)
9121 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9122 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9123 nmaps_allocated
= 2;
9125 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9126 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9128 else if (!NILP (Voverriding_local_map
))
9130 if (2 > nmaps_allocated
)
9132 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9133 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9134 nmaps_allocated
= 2;
9136 if (!NILP (Voverriding_local_map
))
9137 submaps
[nmaps
++] = Voverriding_local_map
;
9145 nminor
= current_minor_maps (0, &maps
);
9146 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9148 if (total
> nmaps_allocated
)
9150 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9151 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9152 nmaps_allocated
= total
;
9155 if (!NILP (orig_keymap
))
9156 submaps
[nmaps
++] = orig_keymap
;
9158 bcopy (maps
, (void *) (submaps
+ nmaps
),
9159 nminor
* sizeof (submaps
[0]));
9163 submaps
[nmaps
++] = orig_local_map
;
9165 submaps
[nmaps
++] = current_global_map
;
9167 /* Find an accurate initial value for first_binding. */
9168 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9169 if (! NILP (submaps
[first_binding
]))
9172 /* Start from the beginning in keybuf. */
9175 /* These are no-ops the first time through, but if we restart, they
9176 revert the echo area and this_command_keys to their original state. */
9177 this_command_key_count
= keys_start
;
9178 if (INTERACTIVE
&& t
< mock_input
)
9179 echo_truncate (echo_start
);
9181 /* If the best binding for the current key sequence is a keymap, or
9182 we may be looking at a function key's escape sequence, keep on
9184 while (first_binding
< nmaps
9185 /* Keep reading as long as there's a prefix binding. */
9186 ? !NILP (submaps
[first_binding
])
9187 /* Don't return in the middle of a possible function key sequence,
9188 if the only bindings we found were via case conversion.
9189 Thus, if ESC O a has a function-key-map translation
9190 and ESC o has a binding, don't return after ESC O,
9191 so that we can translate ESC O plus the next character. */
9192 : (fkey
.start
< t
|| keytran
.start
< t
))
9195 int used_mouse_menu
= 0;
9197 /* Where the last real key started. If we need to throw away a
9198 key that has expanded into more than one element of keybuf
9199 (say, a mouse click on the mode line which is being treated
9200 as [mode-line (mouse-...)], then we backtrack to this point
9202 volatile int last_real_key_start
;
9204 /* These variables are analogous to echo_start and keys_start;
9205 while those allow us to restart the entire key sequence,
9206 echo_local_start and keys_local_start allow us to throw away
9208 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9210 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
9211 eassert (fkey
.start
<= fkey
.end
);
9212 eassert (keytran
.start
<= keytran
.end
);
9213 /* key-translation-map is applied *after* function-key-map. */
9214 eassert (keytran
.end
<= fkey
.start
);
9216 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
9217 { /* The prefix upto first_unbound has no binding and has
9218 no translation left to do either, so we know it's unbound.
9219 If we don't stop now, we risk staying here indefinitely
9220 (if the user keeps entering fkey or keytran prefixes
9221 like C-c ESC ESC ESC ESC ...) */
9223 for (i
= first_unbound
+ 1; i
< t
; i
++)
9224 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9225 mock_input
= t
- first_unbound
- 1;
9226 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9227 fkey
.map
= fkey
.parent
;
9228 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9229 keytran
.map
= keytran
.parent
;
9230 goto replay_sequence
;
9234 error ("Key sequence too long");
9237 echo_local_start
= echo_length ();
9238 keys_local_start
= this_command_key_count
;
9239 local_first_binding
= first_binding
;
9242 /* These are no-ops, unless we throw away a keystroke below and
9243 jumped back up to replay_key; in that case, these restore the
9244 variables to their original state, allowing us to replay the
9246 if (INTERACTIVE
&& t
< mock_input
)
9247 echo_truncate (echo_local_start
);
9248 this_command_key_count
= keys_local_start
;
9249 first_binding
= local_first_binding
;
9251 /* By default, assume each event is "real". */
9252 last_real_key_start
= t
;
9254 /* Does mock_input indicate that we are re-reading a key sequence? */
9258 add_command_key (key
);
9259 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9260 && NILP (Fzerop (Vecho_keystrokes
)))
9264 /* If not, we should actually read a character. */
9269 KBOARD
*interrupted_kboard
= current_kboard
;
9270 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9272 key
= read_char (NILP (prompt
), nmaps
,
9273 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9274 &used_mouse_menu
, NULL
);
9276 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9281 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9282 if (k
== interrupted_kboard
)
9287 /* Don't touch interrupted_kboard when it's been
9289 delayed_switch_frame
= Qnil
;
9290 goto replay_sequence
;
9293 if (!NILP (delayed_switch_frame
))
9295 interrupted_kboard
->kbd_queue
9296 = Fcons (delayed_switch_frame
,
9297 interrupted_kboard
->kbd_queue
);
9298 delayed_switch_frame
= Qnil
;
9302 interrupted_kboard
->kbd_queue
9303 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9305 /* If the side queue is non-empty, ensure it begins with a
9306 switch-frame, so we'll replay it in the right context. */
9307 if (CONSP (interrupted_kboard
->kbd_queue
)
9308 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9309 !(EVENT_HAS_PARAMETERS (key
)
9310 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9314 XSETFRAME (frame
, interrupted_frame
);
9315 interrupted_kboard
->kbd_queue
9316 = Fcons (make_lispy_switch_frame (frame
),
9317 interrupted_kboard
->kbd_queue
);
9320 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9321 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9322 goto replay_sequence
;
9327 /* read_char returns t when it shows a menu and the user rejects it.
9331 unbind_to (count
, Qnil
);
9336 /* read_char returns -1 at the end of a macro.
9337 Emacs 18 handles this by returning immediately with a
9338 zero, so that's what we'll do. */
9339 if (INTEGERP (key
) && XINT (key
) == -1)
9342 /* The Microsoft C compiler can't handle the goto that
9348 /* If the current buffer has been changed from under us, the
9349 keymap may have changed, so replay the sequence. */
9352 timer_resume_idle ();
9355 /* Reset the current buffer from the selected window
9356 in case something changed the former and not the latter.
9357 This is to be more consistent with the behavior
9358 of the command_loop_1. */
9359 if (fix_current_buffer
)
9361 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9363 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9364 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9367 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9368 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9369 goto replay_sequence
;
9372 /* If we have a quit that was typed in another frame, and
9373 quit_throw_to_read_char switched buffers,
9374 replay to get the right keymap. */
9376 && XINT (key
) == quit_char
9377 && current_buffer
!= starting_buffer
)
9380 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9384 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9385 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9386 goto replay_sequence
;
9391 if (EVENT_HAS_PARAMETERS (key
)
9392 /* Either a `switch-frame' or a `select-window' event. */
9393 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9395 /* If we're at the beginning of a key sequence, and the caller
9396 says it's okay, go ahead and return this event. If we're
9397 in the midst of a key sequence, delay it until the end. */
9398 if (t
> 0 || !can_return_switch_frame
)
9400 delayed_switch_frame
= key
;
9406 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9409 /* Clicks in non-text areas get prefixed by the symbol
9410 in their CHAR-ADDRESS field. For example, a click on
9411 the mode line is prefixed by the symbol `mode-line'.
9413 Furthermore, key sequences beginning with mouse clicks
9414 are read using the keymaps of the buffer clicked on, not
9415 the current buffer. So we may have to switch the buffer
9418 When we turn one event into two events, we must make sure
9419 that neither of the two looks like the original--so that,
9420 if we replay the events, they won't be expanded again.
9421 If not for this, such reexpansion could happen either here
9422 or when user programs play with this-command-keys. */
9423 if (EVENT_HAS_PARAMETERS (key
))
9428 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9429 if (EQ (kind
, Qmouse_click
))
9431 Lisp_Object window
, posn
;
9433 window
= POSN_WINDOW (EVENT_START (key
));
9434 posn
= POSN_POSN (EVENT_START (key
));
9437 || (!NILP (fake_prefixed_keys
)
9438 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9440 /* We're looking a second time at an event for which
9441 we generated a fake prefix key. Set
9442 last_real_key_start appropriately. */
9444 last_real_key_start
= t
- 1;
9447 /* Key sequences beginning with mouse clicks are
9448 read using the keymaps in the buffer clicked on,
9449 not the current buffer. If we're at the
9450 beginning of a key sequence, switch buffers. */
9451 if (last_real_key_start
== 0
9453 && BUFFERP (XWINDOW (window
)->buffer
)
9454 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9456 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9460 /* Arrange to go back to the original buffer once we're
9461 done reading the key sequence. Note that we can't
9462 use save_excursion_{save,restore} here, because they
9463 save point as well as the current buffer; we don't
9464 want to save point, because redisplay may change it,
9465 to accommodate a Fset_window_start or something. We
9466 don't want to do this at the top of the function,
9467 because we may get input from a subprocess which
9468 wants to change the selected window and stuff (say,
9470 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9472 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9474 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9475 orig_local_map
= get_local_map (PT
, current_buffer
,
9477 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9478 goto replay_sequence
;
9481 /* For a mouse click, get the local text-property keymap
9482 of the place clicked on, rather than point. */
9483 if (last_real_key_start
== 0
9484 && CONSP (XCDR (key
))
9485 && ! localized_local_map
)
9487 Lisp_Object map_here
, start
, pos
;
9489 localized_local_map
= 1;
9490 start
= EVENT_START (key
);
9492 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9494 pos
= POSN_BUFFER_POSN (start
);
9496 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9498 map_here
= get_local_map (XINT (pos
),
9499 current_buffer
, Qlocal_map
);
9500 if (!EQ (map_here
, orig_local_map
))
9502 orig_local_map
= map_here
;
9503 ++localized_local_map
;
9506 map_here
= get_local_map (XINT (pos
),
9507 current_buffer
, Qkeymap
);
9508 if (!EQ (map_here
, orig_keymap
))
9510 orig_keymap
= map_here
;
9511 ++localized_local_map
;
9514 if (localized_local_map
> 1)
9519 goto replay_sequence
;
9525 /* Expand mode-line and scroll-bar events into two events:
9526 use posn as a fake prefix key. */
9528 && (NILP (fake_prefixed_keys
)
9529 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9531 if (t
+ 1 >= bufsize
)
9532 error ("Key sequence too long");
9535 keybuf
[t
+ 1] = key
;
9538 /* Record that a fake prefix key has been generated
9539 for KEY. Don't modify the event; this would
9540 prevent proper action when the event is pushed
9541 back into unread-command-events. */
9542 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9544 /* If on a mode line string with a local keymap,
9545 reconsider the key sequence with that keymap. */
9546 if (string
= POSN_STRING (EVENT_START (key
)),
9547 (CONSP (string
) && STRINGP (XCAR (string
))))
9549 Lisp_Object pos
, map
, map2
;
9551 pos
= XCDR (string
);
9552 string
= XCAR (string
);
9554 && XINT (pos
) < SCHARS (string
))
9556 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9558 orig_local_map
= map
;
9559 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9562 if (!NILP (map
) || !NILP (map2
))
9563 goto replay_sequence
;
9569 else if (NILP (from_string
)
9570 && (string
= POSN_STRING (EVENT_START (key
)),
9571 (CONSP (string
) && STRINGP (XCAR (string
)))))
9573 /* For a click on a string, i.e. overlay string or a
9574 string displayed via the `display' property,
9575 consider `local-map' and `keymap' properties of
9577 Lisp_Object pos
, map
, map2
;
9579 pos
= XCDR (string
);
9580 string
= XCAR (string
);
9582 && XINT (pos
) < SCHARS (string
))
9584 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9586 orig_local_map
= map
;
9587 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9591 if (!NILP (map
) || !NILP (map2
))
9593 from_string
= string
;
9594 goto replay_sequence
;
9599 else if (CONSP (XCDR (key
))
9600 && CONSP (EVENT_START (key
))
9601 && CONSP (XCDR (EVENT_START (key
))))
9605 posn
= POSN_POSN (EVENT_START (key
));
9606 /* Handle menu-bar events:
9607 insert the dummy prefix event `menu-bar'. */
9608 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9610 if (t
+ 1 >= bufsize
)
9611 error ("Key sequence too long");
9615 /* Zap the position in key, so we know that we've
9616 expanded it, and don't try to do so again. */
9617 POSN_SET_POSN (EVENT_START (key
),
9618 Fcons (posn
, Qnil
));
9621 goto replay_sequence
;
9623 else if (CONSP (posn
))
9625 /* We're looking at the second event of a
9626 sequence which we expanded before. Set
9627 last_real_key_start appropriately. */
9628 if (last_real_key_start
== t
&& t
> 0)
9629 last_real_key_start
= t
- 1;
9634 /* We have finally decided that KEY is something we might want
9636 first_binding
= (follow_key (key
,
9637 nmaps
- first_binding
,
9638 submaps
+ first_binding
,
9639 defs
+ first_binding
,
9640 submaps
+ first_binding
)
9643 /* If KEY wasn't bound, we'll try some fallbacks. */
9644 if (first_binding
< nmaps
)
9645 /* This is needed for the following scenario:
9646 event 0: a down-event that gets dropped by calling replay_key.
9647 event 1: some normal prefix like C-h.
9648 After event 0, first_unbound is 0, after event 1 fkey.start
9649 and keytran.start are both 1, so when we see that C-h is bound,
9650 we need to update first_unbound. */
9651 first_unbound
= max (t
+ 1, first_unbound
);
9656 /* Remember the position to put an upper bound on fkey.start. */
9657 first_unbound
= min (t
, first_unbound
);
9659 head
= EVENT_HEAD (key
);
9660 if (help_char_p (head
) && t
> 0)
9662 read_key_sequence_cmd
= Vprefix_help_command
;
9664 last_nonmenu_event
= key
;
9665 /* The Microsoft C compiler can't handle the goto that
9673 Lisp_Object breakdown
;
9676 breakdown
= parse_modifiers (head
);
9677 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9678 /* Attempt to reduce an unbound mouse event to a simpler
9679 event that is bound:
9680 Drags reduce to clicks.
9681 Double-clicks reduce to clicks.
9682 Triple-clicks reduce to double-clicks, then to clicks.
9683 Down-clicks are eliminated.
9684 Double-downs reduce to downs, then are eliminated.
9685 Triple-downs reduce to double-downs, then to downs,
9686 then are eliminated. */
9687 if (modifiers
& (down_modifier
| drag_modifier
9688 | double_modifier
| triple_modifier
))
9690 while (modifiers
& (down_modifier
| drag_modifier
9691 | double_modifier
| triple_modifier
))
9693 Lisp_Object new_head
, new_click
;
9694 if (modifiers
& triple_modifier
)
9695 modifiers
^= (double_modifier
| triple_modifier
);
9696 else if (modifiers
& double_modifier
)
9697 modifiers
&= ~double_modifier
;
9698 else if (modifiers
& drag_modifier
)
9699 modifiers
&= ~drag_modifier
;
9702 /* Dispose of this `down' event by simply jumping
9703 back to replay_key, to get another event.
9705 Note that if this event came from mock input,
9706 then just jumping back to replay_key will just
9707 hand it to us again. So we have to wipe out any
9710 We could delete keybuf[t] and shift everything
9711 after that to the left by one spot, but we'd also
9712 have to fix up any variable that points into
9713 keybuf, and shifting isn't really necessary
9716 Adding prefixes for non-textual mouse clicks
9717 creates two characters of mock input, and both
9718 must be thrown away. If we're only looking at
9719 the prefix now, we can just jump back to
9720 replay_key. On the other hand, if we've already
9721 processed the prefix, and now the actual click
9722 itself is giving us trouble, then we've lost the
9723 state of the keymaps we want to backtrack to, and
9724 we need to replay the whole sequence to rebuild
9727 Beyond that, only function key expansion could
9728 create more than two keys, but that should never
9729 generate mouse events, so it's okay to zero
9730 mock_input in that case too.
9732 FIXME: The above paragraph seems just plain
9733 wrong, if you consider things like
9734 xterm-mouse-mode. -stef
9736 Isn't this just the most wonderful code ever? */
9738 /* If mock_input > t + 1, the above simplification
9739 will actually end up dropping keys on the floor.
9740 This is probably OK for now, but even
9741 if mock_input <= t + 1, we need to adjust fkey
9743 Typical case [header-line down-mouse-N]:
9744 mock_input = 2, t = 1, fkey.end = 1,
9745 last_real_key_start = 0. */
9746 if (fkey
.end
> last_real_key_start
)
9748 fkey
.end
= fkey
.start
9749 = min (last_real_key_start
, fkey
.start
);
9750 fkey
.map
= fkey
.parent
;
9751 if (keytran
.end
> last_real_key_start
)
9753 keytran
.end
= keytran
.start
9754 = min (last_real_key_start
, keytran
.start
);
9755 keytran
.map
= keytran
.parent
;
9758 if (t
== last_real_key_start
)
9765 mock_input
= last_real_key_start
;
9766 goto replay_sequence
;
9771 = apply_modifiers (modifiers
, XCAR (breakdown
));
9773 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9775 /* Look for a binding for this new key. follow_key
9776 promises that it didn't munge submaps the
9777 last time we called it, since key was unbound. */
9779 = (follow_key (new_click
,
9780 nmaps
- local_first_binding
,
9781 submaps
+ local_first_binding
,
9782 defs
+ local_first_binding
,
9783 submaps
+ local_first_binding
)
9784 + local_first_binding
);
9786 /* If that click is bound, go for it. */
9787 if (first_binding
< nmaps
)
9792 /* Otherwise, we'll leave key set to the drag event. */
9799 /* Normally, last_nonmenu_event gets the previous key we read.
9800 But when a mouse popup menu is being used,
9801 we don't update last_nonmenu_event; it continues to hold the mouse
9802 event that preceded the first level of menu. */
9803 if (!used_mouse_menu
)
9804 last_nonmenu_event
= key
;
9806 /* Record what part of this_command_keys is the current key sequence. */
9807 this_single_command_key_start
= this_command_key_count
- t
;
9809 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9810 /* There is a binding and it's not a prefix.
9811 There is thus no function-key in this sequence.
9812 Moving fkey.start is important in this case to allow keytran.start
9813 to go over the sequence before we return (since we keep the
9814 invariant that keytran.end <= fkey.start). */
9817 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9820 /* If the sequence is unbound, see if we can hang a function key
9821 off the end of it. */
9822 /* Continue scan from fkey.end until we find a bound suffix. */
9823 while (fkey
.end
< t
)
9825 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9828 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9829 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9830 max (t
, mock_input
),
9831 /* If there's a binding (i.e.
9832 first_binding >= nmaps) we don't want
9833 to apply this function-key-mapping. */
9834 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9839 mock_input
= diff
+ max (t
, mock_input
);
9840 goto replay_sequence
;
9844 /* Look for this sequence in key-translation-map.
9845 Scan from keytran.end until we find a bound suffix. */
9846 while (keytran
.end
< fkey
.start
)
9848 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9851 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9852 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9857 mock_input
= diff
+ max (t
, mock_input
);
9858 /* Adjust the function-key-map counters. */
9862 goto replay_sequence
;
9866 /* If KEY is not defined in any of the keymaps,
9867 and cannot be part of a function key or translation,
9868 and is an upper case letter
9869 use the corresponding lower-case letter instead. */
9870 if (first_binding
>= nmaps
9871 && fkey
.start
>= t
&& keytran
.start
>= t
9873 && ((((XINT (key
) & 0x3ffff)
9874 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9875 && UPPERCASEP (XINT (key
) & 0x3ffff))
9876 || (XINT (key
) & shift_modifier
)))
9878 Lisp_Object new_key
;
9880 original_uppercase
= key
;
9881 original_uppercase_position
= t
- 1;
9883 if (XINT (key
) & shift_modifier
)
9884 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9886 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9887 | (XINT (key
) & ~0x3ffff)));
9889 /* We have to do this unconditionally, regardless of whether
9890 the lower-case char is defined in the keymaps, because they
9891 might get translated through function-key-map. */
9892 keybuf
[t
- 1] = new_key
;
9893 mock_input
= max (t
, mock_input
);
9895 goto replay_sequence
;
9897 /* If KEY is not defined in any of the keymaps,
9898 and cannot be part of a function key or translation,
9899 and is a shifted function key,
9900 use the corresponding unshifted function key instead. */
9901 if (first_binding
>= nmaps
9902 && fkey
.start
>= t
&& keytran
.start
>= t
9905 Lisp_Object breakdown
;
9908 breakdown
= parse_modifiers (key
);
9909 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9910 if (modifiers
& shift_modifier
)
9912 Lisp_Object new_key
;
9914 original_uppercase
= key
;
9915 original_uppercase_position
= t
- 1;
9917 modifiers
&= ~shift_modifier
;
9918 new_key
= apply_modifiers (modifiers
,
9921 keybuf
[t
- 1] = new_key
;
9922 mock_input
= max (t
, mock_input
);
9923 fkey
.start
= fkey
.end
= 0;
9924 keytran
.start
= keytran
.end
= 0;
9926 goto replay_sequence
;
9932 read_key_sequence_cmd
= (first_binding
< nmaps
9933 ? defs
[first_binding
]
9936 unread_switch_frame
= delayed_switch_frame
;
9937 unbind_to (count
, Qnil
);
9939 /* Don't downcase the last character if the caller says don't.
9940 Don't downcase it if the result is undefined, either. */
9941 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9943 && t
- 1 == original_uppercase_position
)
9944 keybuf
[t
- 1] = original_uppercase
;
9946 /* Occasionally we fabricate events, perhaps by expanding something
9947 according to function-key-map, or by adding a prefix symbol to a
9948 mouse click in the scroll bar or modeline. In this cases, return
9949 the entire generated key sequence, even if we hit an unbound
9950 prefix or a definition before the end. This means that you will
9951 be able to push back the event properly, and also means that
9952 read-key-sequence will always return a logical unit.
9955 for (; t
< mock_input
; t
++)
9957 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9958 && NILP (Fzerop (Vecho_keystrokes
)))
9959 echo_char (keybuf
[t
]);
9960 add_command_key (keybuf
[t
]);
9969 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9970 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9971 The sequence is sufficient to specify a non-prefix command in the
9972 current local and global maps.
9974 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9975 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9976 as a continuation of the previous key.
9978 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9979 convert the last event to lower case. (Normally any upper case event
9980 is converted to lower case if the original event is undefined and the lower
9981 case equivalent is defined.) A non-nil value is appropriate for reading
9982 a key sequence to be defined.
9984 A C-g typed while in this function is treated like any other character,
9985 and `quit-flag' is not set.
9987 If the key sequence starts with a mouse click, then the sequence is read
9988 using the keymaps of the buffer of the window clicked in, not the buffer
9989 of the selected window as normal.
9991 `read-key-sequence' drops unbound button-down events, since you normally
9992 only care about the click or drag events which follow them. If a drag
9993 or multi-click event is unbound, but the corresponding click event would
9994 be bound, `read-key-sequence' turns the event into a click event at the
9995 drag's starting position. This means that you don't have to distinguish
9996 between click and drag, double, or triple events unless you want to.
9998 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9999 lines separating windows, and scroll bars with imaginary keys
10000 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10002 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10003 function will process a switch-frame event if the user switches frames
10004 before typing anything. If the user switches frames in the middle of a
10005 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10006 is nil, then the event will be put off until after the current key sequence.
10008 `read-key-sequence' checks `function-key-map' for function key
10009 sequences, where they wouldn't conflict with ordinary bindings. See
10010 `function-key-map' for more details.
10012 The optional fifth argument COMMAND-LOOP, if non-nil, means
10013 that this key sequence is being read by something that will
10014 read commands one after another. It should be nil if the caller
10015 will read just one key sequence. */)
10016 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10018 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10019 Lisp_Object can_return_switch_frame
, command_loop
;
10021 Lisp_Object keybuf
[30];
10023 struct gcpro gcpro1
;
10024 int count
= SPECPDL_INDEX ();
10026 if (!NILP (prompt
))
10027 CHECK_STRING (prompt
);
10030 specbind (Qinput_method_exit_on_first_char
,
10031 (NILP (command_loop
) ? Qt
: Qnil
));
10032 specbind (Qinput_method_use_echo_area
,
10033 (NILP (command_loop
) ? Qt
: Qnil
));
10035 bzero (keybuf
, sizeof keybuf
);
10036 GCPRO1 (keybuf
[0]);
10037 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10039 if (NILP (continue_echo
))
10041 this_command_key_count
= 0;
10042 this_command_key_count_reset
= 0;
10043 this_single_command_key_start
= 0;
10046 #ifdef HAVE_X_WINDOWS
10047 if (display_hourglass_p
)
10048 cancel_hourglass ();
10051 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10052 prompt
, ! NILP (dont_downcase_last
),
10053 ! NILP (can_return_switch_frame
), 0);
10055 #if 0 /* The following is fine for code reading a key sequence and
10056 then proceeding with a lenghty computation, but it's not good
10057 for code reading keys in a loop, like an input method. */
10058 #ifdef HAVE_X_WINDOWS
10059 if (display_hourglass_p
)
10060 start_hourglass ();
10070 return unbind_to (count
, make_event_array (i
, keybuf
));
10073 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10074 Sread_key_sequence_vector
, 1, 5, 0,
10075 doc
: /* Like `read-key-sequence' but always return a vector. */)
10076 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10078 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10079 Lisp_Object can_return_switch_frame
, command_loop
;
10081 Lisp_Object keybuf
[30];
10083 struct gcpro gcpro1
;
10084 int count
= SPECPDL_INDEX ();
10086 if (!NILP (prompt
))
10087 CHECK_STRING (prompt
);
10090 specbind (Qinput_method_exit_on_first_char
,
10091 (NILP (command_loop
) ? Qt
: Qnil
));
10092 specbind (Qinput_method_use_echo_area
,
10093 (NILP (command_loop
) ? Qt
: Qnil
));
10095 bzero (keybuf
, sizeof keybuf
);
10096 GCPRO1 (keybuf
[0]);
10097 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10099 if (NILP (continue_echo
))
10101 this_command_key_count
= 0;
10102 this_command_key_count_reset
= 0;
10103 this_single_command_key_start
= 0;
10106 #ifdef HAVE_X_WINDOWS
10107 if (display_hourglass_p
)
10108 cancel_hourglass ();
10111 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10112 prompt
, ! NILP (dont_downcase_last
),
10113 ! NILP (can_return_switch_frame
), 0);
10115 #ifdef HAVE_X_WINDOWS
10116 if (display_hourglass_p
)
10117 start_hourglass ();
10126 return unbind_to (count
, Fvector (i
, keybuf
));
10129 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10130 doc
: /* Execute CMD as an editor command.
10131 CMD must be a symbol that satisfies the `commandp' predicate.
10132 Optional second arg RECORD-FLAG non-nil
10133 means unconditionally put this command in `command-history'.
10134 Otherwise, that is done only if an arg is read using the minibuffer.
10135 The argument KEYS specifies the value to use instead of (this-command-keys)
10136 when reading the arguments; if it is nil, (this-command-keys) is used.
10137 The argument SPECIAL, if non-nil, means that this command is executing
10138 a special event, so ignore the prefix argument and don't clear it. */)
10139 (cmd
, record_flag
, keys
, special
)
10140 Lisp_Object cmd
, record_flag
, keys
, special
;
10142 register Lisp_Object final
;
10143 register Lisp_Object tem
;
10144 Lisp_Object prefixarg
;
10145 struct backtrace backtrace
;
10146 extern int debug_on_next_call
;
10148 debug_on_next_call
= 0;
10150 if (NILP (special
))
10152 prefixarg
= current_kboard
->Vprefix_arg
;
10153 Vcurrent_prefix_arg
= prefixarg
;
10154 current_kboard
->Vprefix_arg
= Qnil
;
10161 tem
= Fget (cmd
, Qdisabled
);
10162 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10164 tem
= Fsymbol_value (Qdisabled_command_function
);
10166 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10172 final
= Findirect_function (cmd
, Qnil
);
10174 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10176 struct gcpro gcpro1
, gcpro2
;
10178 GCPRO2 (cmd
, prefixarg
);
10179 do_autoload (final
, cmd
);
10186 if (STRINGP (final
) || VECTORP (final
))
10188 /* If requested, place the macro in the command history. For
10189 other sorts of commands, call-interactively takes care of
10191 if (!NILP (record_flag
))
10194 = Fcons (Fcons (Qexecute_kbd_macro
,
10195 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10198 /* Don't keep command history around forever. */
10199 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10201 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10203 XSETCDR (tem
, Qnil
);
10207 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10210 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10212 backtrace
.next
= backtrace_list
;
10213 backtrace_list
= &backtrace
;
10214 backtrace
.function
= &Qcall_interactively
;
10215 backtrace
.args
= &cmd
;
10216 backtrace
.nargs
= 1;
10217 backtrace
.evalargs
= 0;
10218 backtrace
.debug_on_exit
= 0;
10220 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
10222 backtrace_list
= backtrace
.next
;
10230 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10232 doc
: /* Read function name, then read its arguments and call it.
10234 To pass a numeric argument to the command you are invoking with, specify
10235 the numeric argument to this command.
10237 Noninteractively, the argument PREFIXARG is the prefix argument to
10238 give to the command you invoke, if it asks for an argument. */)
10240 Lisp_Object prefixarg
;
10242 Lisp_Object function
;
10244 int saved_last_point_position
;
10245 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10246 Lisp_Object bindings
, value
;
10247 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10248 #ifdef HAVE_X_WINDOWS
10249 /* The call to Fcompleting_read wil start and cancel the hourglass,
10250 but if the hourglass was already scheduled, this means that no
10251 hourglass will be shown for the actual M-x command itself.
10252 So we restart it if it is already scheduled. Note that checking
10253 hourglass_shown_p is not enough, normally the hourglass is not shown,
10254 just scheduled to be shown. */
10255 int hstarted
= hourglass_started ();
10258 saved_keys
= Fvector (this_command_key_count
,
10259 XVECTOR (this_command_keys
)->contents
);
10260 saved_last_point_position_buffer
= last_point_position_buffer
;
10261 saved_last_point_position
= last_point_position
;
10263 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10265 if (EQ (prefixarg
, Qminus
))
10266 strcpy (buf
, "- ");
10267 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10268 strcpy (buf
, "C-u ");
10269 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10270 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10271 else if (INTEGERP (prefixarg
))
10272 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10274 /* This isn't strictly correct if execute-extended-command
10275 is bound to anything else. Perhaps it should use
10276 this_command_keys? */
10277 strcat (buf
, "M-x ");
10279 /* Prompt with buf, and then read a string, completing from and
10280 restricting to the set of all defined commands. Don't provide
10281 any initial input. Save the command read on the extended-command
10283 function
= Fcompleting_read (build_string (buf
),
10284 Vobarray
, Qcommandp
,
10285 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10288 #ifdef HAVE_X_WINDOWS
10289 if (hstarted
) start_hourglass ();
10292 if (STRINGP (function
) && SCHARS (function
) == 0)
10293 error ("No command name given");
10295 /* Set this_command_keys to the concatenation of saved_keys and
10296 function, followed by a RET. */
10301 this_command_key_count
= 0;
10302 this_command_key_count_reset
= 0;
10303 this_single_command_key_start
= 0;
10305 keys
= XVECTOR (saved_keys
)->contents
;
10306 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10307 add_command_key (keys
[i
]);
10309 for (i
= 0; i
< SCHARS (function
); i
++)
10310 add_command_key (Faref (function
, make_number (i
)));
10312 add_command_key (make_number ('\015'));
10315 last_point_position
= saved_last_point_position
;
10316 last_point_position_buffer
= saved_last_point_position_buffer
;
10320 function
= Fintern (function
, Qnil
);
10321 current_kboard
->Vprefix_arg
= prefixarg
;
10322 Vthis_command
= function
;
10323 real_this_command
= function
;
10325 /* If enabled, show which key runs this command. */
10326 if (!NILP (Vsuggest_key_bindings
)
10327 && NILP (Vexecuting_kbd_macro
)
10328 && SYMBOLP (function
))
10329 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10335 GCPRO2 (bindings
, value
);
10336 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10338 /* If the command has a key binding, print it now. */
10339 if (!NILP (bindings
)
10340 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10343 /* But first wait, and skip the message if there is input. */
10344 Lisp_Object waited
;
10346 /* If this command displayed something in the echo area;
10347 wait a few seconds, then display our suggestion message. */
10348 if (NILP (echo_area_buffer
[0]))
10349 waited
= sit_for (make_number (0), 0, 2);
10350 else if (NUMBERP (Vsuggest_key_bindings
))
10351 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10353 waited
= sit_for (make_number (2), 0, 2);
10355 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10357 Lisp_Object binding
;
10359 int message_p
= push_message ();
10360 int count
= SPECPDL_INDEX ();
10362 record_unwind_protect (pop_message_unwind
, Qnil
);
10363 binding
= Fkey_description (bindings
, Qnil
);
10366 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10369 sprintf (newmessage
, "You can run the command `%s' with %s",
10370 SDATA (SYMBOL_NAME (function
)),
10372 message2_nolog (newmessage
,
10373 strlen (newmessage
),
10374 STRING_MULTIBYTE (binding
));
10375 if (NUMBERP (Vsuggest_key_bindings
))
10376 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10378 waited
= sit_for (make_number (2), 0, 2);
10380 if (!NILP (waited
) && message_p
)
10381 restore_message ();
10383 unbind_to (count
, Qnil
);
10387 RETURN_UNGCPRO (value
);
10391 /* Return nonzero if input events are pending. */
10394 detect_input_pending ()
10396 if (!input_pending
)
10397 get_input_pending (&input_pending
, 0);
10399 return input_pending
;
10402 /* Return nonzero if input events other than mouse movements are
10406 detect_input_pending_ignore_squeezables ()
10408 if (!input_pending
)
10409 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10411 return input_pending
;
10414 /* Return nonzero if input events are pending, and run any pending timers. */
10417 detect_input_pending_run_timers (do_display
)
10420 int old_timers_run
= timers_run
;
10422 if (!input_pending
)
10423 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10425 if (old_timers_run
!= timers_run
&& do_display
)
10427 redisplay_preserve_echo_area (8);
10428 /* The following fixes a bug when using lazy-lock with
10429 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10430 from an idle timer function. The symptom of the bug is that
10431 the cursor sometimes doesn't become visible until the next X
10432 event is processed. --gerd. */
10434 Lisp_Object tail
, frame
;
10435 FOR_EACH_FRAME (tail
, frame
)
10436 if (FRAME_RIF (XFRAME (frame
)))
10437 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10441 return input_pending
;
10444 /* This is called in some cases before a possible quit.
10445 It cases the next call to detect_input_pending to recompute input_pending.
10446 So calling this function unnecessarily can't do any harm. */
10449 clear_input_pending ()
10454 /* Return nonzero if there are pending requeued events.
10455 This isn't used yet. The hope is to make wait_reading_process_output
10456 call it, and return if it runs Lisp code that unreads something.
10457 The problem is, kbd_buffer_get_event needs to be fixed to know what
10458 to do in that case. It isn't trivial. */
10461 requeued_events_pending_p ()
10463 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10467 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10468 doc
: /* Return t if command input is currently available with no wait.
10469 Actually, the value is nil only if we can be sure that no input is available;
10470 if there is a doubt, the value is t. */)
10473 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10474 || !NILP (Vunread_post_input_method_events
)
10475 || !NILP (Vunread_input_method_events
))
10478 get_input_pending (&input_pending
,
10479 READABLE_EVENTS_DO_TIMERS_NOW
10480 | READABLE_EVENTS_FILTER_EVENTS
);
10481 return input_pending
> 0 ? Qt
: Qnil
;
10484 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10485 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10488 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10491 if (total_keys
< NUM_RECENT_KEYS
)
10492 return Fvector (total_keys
, keys
);
10495 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10496 bcopy (keys
+ recent_keys_index
,
10497 XVECTOR (val
)->contents
,
10498 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10500 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10501 recent_keys_index
* sizeof (Lisp_Object
));
10506 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10507 doc
: /* Return the key sequence that invoked this command.
10508 However, if the command has called `read-key-sequence', it returns
10509 the last key sequence that has been read.
10510 The value is a string or a vector. */)
10513 return make_event_array (this_command_key_count
,
10514 XVECTOR (this_command_keys
)->contents
);
10517 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10518 doc
: /* Return the key sequence that invoked this command, as a vector.
10519 However, if the command has called `read-key-sequence', it returns
10520 the last key sequence that has been read. */)
10523 return Fvector (this_command_key_count
,
10524 XVECTOR (this_command_keys
)->contents
);
10527 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10528 Sthis_single_command_keys
, 0, 0, 0,
10529 doc
: /* Return the key sequence that invoked this command.
10530 More generally, it returns the last key sequence read, either by
10531 the command loop or by `read-key-sequence'.
10532 Unlike `this-command-keys', this function's value
10533 does not include prefix arguments.
10534 The value is always a vector. */)
10537 return Fvector (this_command_key_count
10538 - this_single_command_key_start
,
10539 (XVECTOR (this_command_keys
)->contents
10540 + this_single_command_key_start
));
10543 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10544 Sthis_single_command_raw_keys
, 0, 0, 0,
10545 doc
: /* Return the raw events that were read for this command.
10546 More generally, it returns the last key sequence read, either by
10547 the command loop or by `read-key-sequence'.
10548 Unlike `this-single-command-keys', this function's value
10549 shows the events before all translations (except for input methods).
10550 The value is always a vector. */)
10553 return Fvector (raw_keybuf_count
,
10554 (XVECTOR (raw_keybuf
)->contents
));
10557 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10558 Sreset_this_command_lengths
, 0, 0, 0,
10559 doc
: /* Make the unread events replace the last command and echo.
10560 Used in `universal-argument-other-key'.
10562 `universal-argument-other-key' rereads the event just typed.
10563 It then gets translated through `function-key-map'.
10564 The translated event has to replace the real events,
10565 both in the value of (this-command-keys) and in echoing.
10566 To achieve this, `universal-argument-other-key' calls
10567 `reset-this-command-lengths', which discards the record of reading
10568 these events the first time. */)
10571 this_command_key_count
= before_command_key_count
;
10572 if (this_command_key_count
< this_single_command_key_start
)
10573 this_single_command_key_start
= this_command_key_count
;
10575 echo_truncate (before_command_echo_length
);
10577 /* Cause whatever we put into unread-command-events
10578 to echo as if it were being freshly read from the keyboard. */
10579 this_command_key_count_reset
= 1;
10584 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10585 Sclear_this_command_keys
, 0, 1, 0,
10586 doc
: /* Clear out the vector that `this-command-keys' returns.
10587 Also clear the record of the last 100 events, unless optional arg
10588 KEEP-RECORD is non-nil. */)
10590 Lisp_Object keep_record
;
10594 this_command_key_count
= 0;
10595 this_command_key_count_reset
= 0;
10597 if (NILP (keep_record
))
10599 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10600 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10602 recent_keys_index
= 0;
10607 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10608 doc
: /* Return the current depth in recursive edits. */)
10612 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10616 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10617 "FOpen dribble file: ",
10618 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10619 If FILE is nil, close any open dribble file. */)
10630 file
= Fexpand_file_name (file
, Qnil
);
10631 dribble
= fopen (SDATA (file
), "w");
10633 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10638 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10639 doc
: /* Discard the contents of the terminal input buffer.
10640 Also end any kbd macro being defined. */)
10643 if (!NILP (current_kboard
->defining_kbd_macro
))
10645 /* Discard the last command from the macro. */
10646 Fcancel_kbd_macro_events ();
10650 update_mode_lines
++;
10652 Vunread_command_events
= Qnil
;
10653 unread_command_char
= -1;
10655 discard_tty_input ();
10657 kbd_fetch_ptr
= kbd_store_ptr
;
10663 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10664 doc
: /* Stop Emacs and return to superior process. You can resume later.
10665 If `cannot-suspend' is non-nil, or if the system doesn't support job
10666 control, run a subshell instead.
10668 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10669 to be read as terminal input by Emacs's parent, after suspension.
10671 Before suspending, run the normal hook `suspend-hook'.
10672 After resumption run the normal hook `suspend-resume-hook'.
10674 Some operating systems cannot stop the Emacs process and resume it later.
10675 On such systems, Emacs starts a subshell instead of suspending. */)
10677 Lisp_Object stuffstring
;
10679 int count
= SPECPDL_INDEX ();
10680 int old_height
, old_width
;
10682 struct gcpro gcpro1
;
10684 if (tty_list
&& tty_list
->next
)
10685 error ("There are other tty frames open; close them before suspending Emacs");
10687 if (!NILP (stuffstring
))
10688 CHECK_STRING (stuffstring
);
10690 /* Run the functions in suspend-hook. */
10691 if (!NILP (Vrun_hooks
))
10692 call1 (Vrun_hooks
, intern ("suspend-hook"));
10694 GCPRO1 (stuffstring
);
10695 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10696 reset_all_sys_modes ();
10697 /* sys_suspend can get an error if it tries to fork a subshell
10698 and the system resources aren't available for that. */
10699 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10701 stuff_buffered_input (stuffstring
);
10702 if (cannot_suspend
)
10706 unbind_to (count
, Qnil
);
10708 /* Check if terminal/window size has changed.
10709 Note that this is not useful when we are running directly
10710 with a window system; but suspend should be disabled in that case. */
10711 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10712 if (width
!= old_width
|| height
!= old_height
)
10713 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10715 /* Run suspend-resume-hook. */
10716 if (!NILP (Vrun_hooks
))
10717 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10723 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10724 Then in any case stuff anything Emacs has read ahead and not used. */
10727 stuff_buffered_input (stuffstring
)
10728 Lisp_Object stuffstring
;
10730 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10731 register unsigned char *p
;
10733 if (STRINGP (stuffstring
))
10735 register int count
;
10737 p
= SDATA (stuffstring
);
10738 count
= SBYTES (stuffstring
);
10739 while (count
-- > 0)
10744 /* Anything we have read ahead, put back for the shell to read. */
10745 /* ?? What should this do when we have multiple keyboards??
10746 Should we ignore anything that was typed in at the "wrong" kboard?
10748 rms: we should stuff everything back into the kboard
10750 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10753 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10754 kbd_fetch_ptr
= kbd_buffer
;
10755 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10756 stuff_char (kbd_fetch_ptr
->code
);
10758 clear_event (kbd_fetch_ptr
);
10762 #endif /* SIGTSTP */
10766 set_waiting_for_input (time_to_clear
)
10767 EMACS_TIME
*time_to_clear
;
10769 input_available_clear_time
= time_to_clear
;
10771 /* Tell handle_interrupt to throw back to read_char, */
10772 waiting_for_input
= 1;
10774 /* If handle_interrupt was called before and buffered a C-g,
10775 make it run again now, to avoid timing error. */
10776 if (!NILP (Vquit_flag
))
10777 quit_throw_to_read_char ();
10781 clear_waiting_for_input ()
10783 /* Tell handle_interrupt not to throw back to read_char, */
10784 waiting_for_input
= 0;
10785 input_available_clear_time
= 0;
10788 /* The SIGINT handler.
10790 If we have a frame on the controlling tty, we assume that the
10791 SIGINT was generated by C-g, so we call handle_interrupt.
10792 Otherwise, the handler kills Emacs. */
10795 interrupt_signal (signalnum
) /* If we don't have an argument, */
10796 int signalnum
; /* some compilers complain in signal calls. */
10798 /* Must preserve main program's value of errno. */
10799 int old_errno
= errno
;
10800 struct terminal
*terminal
;
10802 #if defined (USG) && !defined (POSIX_SIGNALS)
10803 /* USG systems forget handlers when they are used;
10804 must reestablish each time */
10805 signal (SIGINT
, interrupt_signal
);
10806 signal (SIGQUIT
, interrupt_signal
);
10809 SIGNAL_THREAD_CHECK (signalnum
);
10811 /* See if we have an active terminal on our controlling tty. */
10812 terminal
= get_named_tty ("/dev/tty");
10815 /* If there are no frames there, let's pretend that we are a
10816 well-behaving UN*X program and quit. */
10817 Fkill_emacs (Qnil
);
10821 /* Otherwise, the SIGINT was probably generated by C-g. */
10823 /* Set internal_last_event_frame to the top frame of the
10824 controlling tty, if we have a frame there. We disable the
10825 interrupt key on secondary ttys, so the SIGINT must have come
10826 from the controlling tty. */
10827 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10829 handle_interrupt ();
10835 /* This routine is called at interrupt level in response to C-g.
10837 It is called from the SIGINT handler or kbd_buffer_store_event.
10839 If `waiting_for_input' is non zero, then unless `echoing' is
10840 nonzero, immediately throw back to read_char.
10842 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10843 eval to throw, when it gets a chance. If quit-flag is already
10844 non-nil, it stops the job right away. */
10847 handle_interrupt ()
10853 /* XXX This code needs to be revised for multi-tty support. */
10854 if (!NILP (Vquit_flag
)
10856 && get_named_tty ("/dev/tty")
10860 /* If SIGINT isn't blocked, don't let us be interrupted by
10861 another SIGINT, it might be harmful due to non-reentrancy
10862 in I/O functions. */
10863 sigblock (sigmask (SIGINT
));
10866 reset_all_sys_modes ();
10868 #ifdef SIGTSTP /* Support possible in later USG versions */
10870 * On systems which can suspend the current process and return to the original
10871 * shell, this command causes the user to end up back at the shell.
10872 * The "Auto-save" and "Abort" questions are not asked until
10873 * the user elects to return to emacs, at which point he can save the current
10874 * job and either dump core or continue.
10879 if (sys_suspend () == -1)
10881 printf ("Not running as a subprocess;\n");
10882 printf ("you can continue or abort.\n");
10884 #else /* not VMS */
10885 /* Perhaps should really fork an inferior shell?
10886 But that would not provide any way to get back
10887 to the original shell, ever. */
10888 printf ("No support for stopping a process on this operating system;\n");
10889 printf ("you can continue or abort.\n");
10890 #endif /* not VMS */
10891 #endif /* not SIGTSTP */
10893 /* We must remain inside the screen area when the internal terminal
10894 is used. Note that [Enter] is not echoed by dos. */
10897 /* It doesn't work to autosave while GC is in progress;
10898 the code used for auto-saving doesn't cope with the mark bit. */
10899 if (!gc_in_progress
)
10901 printf ("Auto-save? (y or n) ");
10903 if (((c
= getchar ()) & ~040) == 'Y')
10905 Fdo_auto_save (Qt
, Qnil
);
10907 printf ("\r\nAuto-save done");
10908 #else /* not MSDOS */
10909 printf ("Auto-save done\n");
10910 #endif /* not MSDOS */
10912 while (c
!= '\n') c
= getchar ();
10916 /* During GC, it must be safe to reenable quitting again. */
10917 Vinhibit_quit
= Qnil
;
10920 #endif /* not MSDOS */
10921 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10922 printf ("but will instead do a real quit after garbage collection ends\r\n");
10927 printf ("\r\nAbort? (y or n) ");
10928 #else /* not MSDOS */
10930 printf ("Abort (and enter debugger)? (y or n) ");
10931 #else /* not VMS */
10932 printf ("Abort (and dump core)? (y or n) ");
10933 #endif /* not VMS */
10934 #endif /* not MSDOS */
10936 if (((c
= getchar ()) & ~040) == 'Y')
10938 while (c
!= '\n') c
= getchar ();
10940 printf ("\r\nContinuing...\r\n");
10941 #else /* not MSDOS */
10942 printf ("Continuing...\n");
10943 #endif /* not MSDOS */
10945 init_all_sys_modes ();
10950 /* If executing a function that wants to be interrupted out of
10951 and the user has not deferred quitting by binding `inhibit-quit'
10952 then quit right away. */
10953 if (immediate_quit
&& NILP (Vinhibit_quit
))
10955 struct gl_state_s saved
;
10956 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10958 immediate_quit
= 0;
10961 GCPRO4 (saved
.object
, saved
.global_code
,
10962 saved
.current_syntax_table
, saved
.old_prop
);
10963 Fsignal (Qquit
, Qnil
);
10968 /* Else request quit when it's safe */
10972 if (waiting_for_input
&& !echoing
)
10973 quit_throw_to_read_char ();
10976 /* Handle a C-g by making read_char return C-g. */
10979 quit_throw_to_read_char ()
10982 /* Prevent another signal from doing this before we finish. */
10983 clear_waiting_for_input ();
10986 Vunread_command_events
= Qnil
;
10987 unread_command_char
= -1;
10989 #if 0 /* Currently, sit_for is called from read_char without turning
10990 off polling. And that can call set_waiting_for_input.
10991 It seems to be harmless. */
10992 #ifdef POLL_FOR_INPUT
10993 /* May be > 1 if in recursive minibuffer. */
10994 if (poll_suppress_count
== 0)
10998 if (FRAMEP (internal_last_event_frame
)
10999 && !EQ (internal_last_event_frame
, selected_frame
))
11000 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11003 _longjmp (getcjmp
, 1);
11006 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11007 doc
: /* Set interrupt mode of reading keyboard input.
11008 If INTERRUPT is non-nil, Emacs will use input interrupts;
11009 otherwise Emacs uses CBREAK mode.
11011 See also `current-input-mode'. */)
11013 Lisp_Object interrupt
;
11015 int new_interrupt_input
;
11017 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11018 #ifdef HAVE_X_WINDOWS
11019 if (x_display_list
!= NULL
)
11021 /* When using X, don't give the user a real choice,
11022 because we haven't implemented the mechanisms to support it. */
11023 #ifdef NO_SOCK_SIGIO
11024 new_interrupt_input
= 0;
11025 #else /* not NO_SOCK_SIGIO */
11026 new_interrupt_input
= 1;
11027 #endif /* NO_SOCK_SIGIO */
11031 new_interrupt_input
= !NILP (interrupt
);
11032 #else /* not SIGIO */
11033 new_interrupt_input
= 0;
11034 #endif /* not SIGIO */
11036 /* Our VMS input only works by interrupts, as of now. */
11038 new_interrupt_input
= 1;
11041 if (new_interrupt_input
!= interrupt_input
)
11043 #ifdef POLL_FOR_INPUT
11047 /* this causes startup screen to be restored and messes with the mouse */
11048 reset_all_sys_modes ();
11050 interrupt_input
= new_interrupt_input
;
11052 init_all_sys_modes ();
11055 #ifdef POLL_FOR_INPUT
11056 poll_suppress_count
= 1;
11063 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11064 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11065 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11066 C-q in key sequences.
11068 This setting only has an effect on tty terminals and only when
11069 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11071 See also `current-input-mode'. */)
11073 Lisp_Object flow
, terminal
;
11075 struct terminal
*t
= get_terminal (terminal
, 1);
11076 struct tty_display_info
*tty
;
11077 if (t
== NULL
|| t
->type
!= output_termcap
)
11079 tty
= t
->display_info
.tty
;
11081 if (tty
->flow_control
!= !NILP (flow
))
11084 /* this causes startup screen to be restored and messes with the mouse */
11085 reset_sys_modes (tty
);
11088 tty
->flow_control
= !NILP (flow
);
11091 init_sys_modes (tty
);
11097 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11098 doc
: /* Enable or disable 8-bit input on TERMINAL.
11099 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11100 bit as the Meta modifier.
11102 If META is nil, Emacs will ignore the top bit, on the assumption it is
11105 Otherwise, Emacs will accept and pass through 8-bit input without
11106 specially interpreting the top bit.
11108 This setting only has an effect on tty terminal devices.
11110 Optional parameter TERMINAL specifies the tty terminal device to use.
11111 It may be a terminal id, a frame, or nil for the terminal used by the
11112 currently selected frame.
11114 See also `current-input-mode'. */)
11116 Lisp_Object meta
, terminal
;
11118 struct terminal
*t
= get_terminal (terminal
, 1);
11119 struct tty_display_info
*tty
;
11122 if (t
== NULL
|| t
->type
!= output_termcap
)
11124 tty
= t
->display_info
.tty
;
11128 else if (EQ (meta
, Qt
))
11133 if (tty
->meta_key
!= new_meta
)
11136 /* this causes startup screen to be restored and messes with the mouse */
11137 reset_sys_modes (tty
);
11140 tty
->meta_key
= new_meta
;
11143 init_sys_modes (tty
);
11149 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11150 doc
: /* Specify character used for quitting.
11151 QUIT must be an ASCII character.
11153 This function only has an effect on the controlling tty of the Emacs
11156 See also `current-input-mode'. */)
11160 struct terminal
*t
= get_named_tty ("/dev/tty");
11161 struct tty_display_info
*tty
;
11162 if (t
== NULL
|| t
->type
!= output_termcap
)
11164 tty
= t
->display_info
.tty
;
11166 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11167 error ("QUIT must be an ASCII character");
11170 /* this causes startup screen to be restored and messes with the mouse */
11171 reset_sys_modes (tty
);
11174 /* Don't let this value be out of range. */
11175 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11178 init_sys_modes (tty
);
11184 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11185 doc
: /* Set mode of reading keyboard input.
11186 First arg INTERRUPT non-nil means use input interrupts;
11187 nil means use CBREAK mode.
11188 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11189 (no effect except in CBREAK mode).
11190 Third arg META t means accept 8-bit input (for a Meta key).
11191 META nil means ignore the top bit, on the assumption it is parity.
11192 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11193 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11194 See also `current-input-mode'. */)
11195 (interrupt
, flow
, meta
, quit
)
11196 Lisp_Object interrupt
, flow
, meta
, quit
;
11198 Fset_input_interrupt_mode (interrupt
);
11199 Fset_output_flow_control (flow
, Qnil
);
11200 Fset_input_meta_mode (meta
, Qnil
);
11201 Fset_quit_char (quit
);
11205 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11206 doc
: /* Return information about the way Emacs currently reads keyboard input.
11207 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11208 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11209 nil, Emacs is using CBREAK mode.
11210 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11211 terminal; this does not apply if Emacs uses interrupt-driven input.
11212 META is t if accepting 8-bit input with 8th bit as Meta flag.
11213 META nil means ignoring the top bit, on the assumption it is parity.
11214 META is neither t nor nil if accepting 8-bit input and using
11215 all 8 bits as the character code.
11216 QUIT is the character Emacs currently uses to quit.
11217 The elements of this list correspond to the arguments of
11218 `set-input-mode'. */)
11221 Lisp_Object val
[4];
11222 struct frame
*sf
= XFRAME (selected_frame
);
11224 val
[0] = interrupt_input
? Qt
: Qnil
;
11225 if (FRAME_TERMCAP_P (sf
))
11227 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11228 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11230 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11237 XSETFASTINT (val
[3], quit_char
);
11239 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11242 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11243 doc
: /* Return position information for pixel coordinates X and Y.
11244 By default, X and Y are relative to text area of the selected window.
11245 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11246 If optional fourth arg WHOLE is non-nil, X is relative to the left
11247 edge of the window.
11249 The return value is similar to a mouse click position:
11250 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11251 IMAGE (DX . DY) (WIDTH . HEIGHT))
11252 The `posn-' functions access elements of such lists. */)
11253 (x
, y
, frame_or_window
, whole
)
11254 Lisp_Object x
, y
, frame_or_window
, whole
;
11259 if (NILP (frame_or_window
))
11260 frame_or_window
= selected_window
;
11262 if (WINDOWP (frame_or_window
))
11266 CHECK_LIVE_WINDOW (frame_or_window
);
11268 w
= XWINDOW (frame_or_window
);
11269 XSETINT (x
, (XINT (x
)
11270 + WINDOW_LEFT_EDGE_X (w
)
11272 ? window_box_left_offset (w
, TEXT_AREA
)
11274 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11275 frame_or_window
= w
->frame
;
11278 CHECK_LIVE_FRAME (frame_or_window
);
11280 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11283 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11284 doc
: /* Return position information for buffer POS in WINDOW.
11285 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11287 Return nil if position is not visible in window. Otherwise,
11288 the return value is similar to that returned by `event-start' for
11289 a mouse click at the upper left corner of the glyph corresponding
11290 to the given buffer position:
11291 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11292 IMAGE (DX . DY) (WIDTH . HEIGHT))
11293 The `posn-' functions access elements of such lists. */)
11295 Lisp_Object pos
, window
;
11300 window
= selected_window
;
11302 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11305 Lisp_Object x
= XCAR (tem
);
11306 Lisp_Object y
= XCAR (XCDR (tem
));
11308 /* Point invisible due to hscrolling? */
11311 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11319 * Set up a new kboard object with reasonable initial values.
11325 kb
->Voverriding_terminal_local_map
= Qnil
;
11326 kb
->Vlast_command
= Qnil
;
11327 kb
->Vreal_last_command
= Qnil
;
11328 kb
->Vkeyboard_translate_table
= Qnil
;
11329 kb
->Vprefix_arg
= Qnil
;
11330 kb
->Vlast_prefix_arg
= Qnil
;
11331 kb
->kbd_queue
= Qnil
;
11332 kb
->kbd_queue_has_data
= 0;
11333 kb
->immediate_echo
= 0;
11334 kb
->echo_string
= Qnil
;
11335 kb
->echo_after_prompt
= -1;
11336 kb
->kbd_macro_buffer
= 0;
11337 kb
->kbd_macro_bufsize
= 0;
11338 kb
->defining_kbd_macro
= Qnil
;
11339 kb
->Vlast_kbd_macro
= Qnil
;
11340 kb
->reference_count
= 0;
11341 kb
->Vsystem_key_alist
= Qnil
;
11342 kb
->system_key_syms
= Qnil
;
11343 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11344 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11345 kb
->Vlocal_key_translation_map
= Fmake_sparse_keymap (Qnil
);
11346 Fset_keymap_parent (kb
->Vlocal_key_translation_map
, Vkey_translation_map
);
11347 kb
->Vdefault_minibuffer_frame
= Qnil
;
11351 * Destroy the contents of a kboard object, but not the object itself.
11352 * We use this just before deleting it, or if we're going to initialize
11353 * it a second time.
11359 if (kb
->kbd_macro_buffer
)
11360 xfree (kb
->kbd_macro_buffer
);
11363 #ifdef MULTI_KBOARD
11365 /* Free KB and memory referenced from it. */
11373 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11376 *kbp
= kb
->next_kboard
;
11378 /* Prevent a dangling reference to KB. */
11379 if (kb
== current_kboard
11380 && FRAMEP (selected_frame
)
11381 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11383 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11385 if (current_kboard
== kb
)
11393 #endif /* MULTI_KBOARD */
11398 /* This is correct before outermost invocation of the editor loop */
11399 command_loop_level
= -1;
11400 immediate_quit
= 0;
11401 quit_char
= Ctl ('g');
11402 Vunread_command_events
= Qnil
;
11403 unread_command_char
= -1;
11404 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11406 recent_keys_index
= 0;
11407 kbd_fetch_ptr
= kbd_buffer
;
11408 kbd_store_ptr
= kbd_buffer
;
11410 do_mouse_tracking
= Qnil
;
11413 interrupt_input_blocked
= 0;
11414 interrupt_input_pending
= 0;
11416 /* This means that command_loop_1 won't try to select anything the first
11418 internal_last_event_frame
= Qnil
;
11419 Vlast_event_frame
= internal_last_event_frame
;
11421 #ifdef MULTI_KBOARD
11422 current_kboard
= initial_kboard
;
11424 wipe_kboard (current_kboard
);
11425 init_kboard (current_kboard
);
11427 if (!noninteractive
)
11429 /* Before multi-tty support, these handlers used to be installed
11430 only if the current session was a tty session. Now an Emacs
11431 session may have multiple display types, so we always handle
11432 SIGINT. There is special code in interrupt_signal to exit
11433 Emacs on SIGINT when there are no termcap frames on the
11434 controlling terminal. */
11435 signal (SIGINT
, interrupt_signal
);
11436 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11437 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11438 SIGQUIT and we can't tell which one it will give us. */
11439 signal (SIGQUIT
, interrupt_signal
);
11440 #endif /* HAVE_TERMIO */
11442 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11444 if (!noninteractive
)
11445 signal (SIGIO
, input_available_signal
);
11448 /* Use interrupt input by default, if it works and noninterrupt input
11449 has deficiencies. */
11451 #ifdef INTERRUPT_INPUT
11452 interrupt_input
= 1;
11454 interrupt_input
= 0;
11457 /* Our VMS input only works by interrupts, as of now. */
11459 interrupt_input
= 1;
11465 if (keyboard_init_hook
)
11466 (*keyboard_init_hook
) ();
11468 #ifdef POLL_FOR_INPUT
11469 poll_suppress_count
= 1;
11474 /* This type's only use is in syms_of_keyboard, to initialize the
11475 event header symbols and put properties on them. */
11476 struct event_head
{
11482 struct event_head head_table
[] = {
11483 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11484 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11485 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11486 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11487 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11488 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11489 /* `select-window' should be handled just like `switch-frame'
11490 in read_key_sequence. */
11491 {&Qselect_window
, "select-window", &Qswitch_frame
}
11495 syms_of_keyboard ()
11497 Vpre_help_message
= Qnil
;
11498 staticpro (&Vpre_help_message
);
11500 Vlispy_mouse_stem
= build_string ("mouse");
11501 staticpro (&Vlispy_mouse_stem
);
11504 QCimage
= intern (":image");
11505 staticpro (&QCimage
);
11507 staticpro (&Qhelp_echo
);
11508 Qhelp_echo
= intern ("help-echo");
11510 staticpro (&item_properties
);
11511 item_properties
= Qnil
;
11513 staticpro (&tool_bar_item_properties
);
11514 tool_bar_item_properties
= Qnil
;
11515 staticpro (&tool_bar_items_vector
);
11516 tool_bar_items_vector
= Qnil
;
11518 staticpro (&real_this_command
);
11519 real_this_command
= Qnil
;
11521 Qtimer_event_handler
= intern ("timer-event-handler");
11522 staticpro (&Qtimer_event_handler
);
11524 Qdisabled_command_function
= intern ("disabled-command-function");
11525 staticpro (&Qdisabled_command_function
);
11527 Qself_insert_command
= intern ("self-insert-command");
11528 staticpro (&Qself_insert_command
);
11530 Qforward_char
= intern ("forward-char");
11531 staticpro (&Qforward_char
);
11533 Qbackward_char
= intern ("backward-char");
11534 staticpro (&Qbackward_char
);
11536 Qdisabled
= intern ("disabled");
11537 staticpro (&Qdisabled
);
11539 Qundefined
= intern ("undefined");
11540 staticpro (&Qundefined
);
11542 Qpre_command_hook
= intern ("pre-command-hook");
11543 staticpro (&Qpre_command_hook
);
11545 Qpost_command_hook
= intern ("post-command-hook");
11546 staticpro (&Qpost_command_hook
);
11548 Qdeferred_action_function
= intern ("deferred-action-function");
11549 staticpro (&Qdeferred_action_function
);
11551 Qcommand_hook_internal
= intern ("command-hook-internal");
11552 staticpro (&Qcommand_hook_internal
);
11554 Qfunction_key
= intern ("function-key");
11555 staticpro (&Qfunction_key
);
11556 Qmouse_click
= intern ("mouse-click");
11557 staticpro (&Qmouse_click
);
11558 #if defined (WINDOWSNT) || defined (MAC_OS)
11559 Qlanguage_change
= intern ("language-change");
11560 staticpro (&Qlanguage_change
);
11562 Qdrag_n_drop
= intern ("drag-n-drop");
11563 staticpro (&Qdrag_n_drop
);
11565 Qsave_session
= intern ("save-session");
11566 staticpro (&Qsave_session
);
11569 Qmac_apple_event
= intern ("mac-apple-event");
11570 staticpro (&Qmac_apple_event
);
11573 Qmenu_enable
= intern ("menu-enable");
11574 staticpro (&Qmenu_enable
);
11575 Qmenu_alias
= intern ("menu-alias");
11576 staticpro (&Qmenu_alias
);
11577 QCenable
= intern (":enable");
11578 staticpro (&QCenable
);
11579 QCvisible
= intern (":visible");
11580 staticpro (&QCvisible
);
11581 QChelp
= intern (":help");
11582 staticpro (&QChelp
);
11583 QCfilter
= intern (":filter");
11584 staticpro (&QCfilter
);
11585 QCbutton
= intern (":button");
11586 staticpro (&QCbutton
);
11587 QCkeys
= intern (":keys");
11588 staticpro (&QCkeys
);
11589 QCkey_sequence
= intern (":key-sequence");
11590 staticpro (&QCkey_sequence
);
11591 QCtoggle
= intern (":toggle");
11592 staticpro (&QCtoggle
);
11593 QCradio
= intern (":radio");
11594 staticpro (&QCradio
);
11596 Qmode_line
= intern ("mode-line");
11597 staticpro (&Qmode_line
);
11598 Qvertical_line
= intern ("vertical-line");
11599 staticpro (&Qvertical_line
);
11600 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11601 staticpro (&Qvertical_scroll_bar
);
11602 Qmenu_bar
= intern ("menu-bar");
11603 staticpro (&Qmenu_bar
);
11606 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11607 staticpro (&Qmouse_fixup_help_message
);
11610 Qabove_handle
= intern ("above-handle");
11611 staticpro (&Qabove_handle
);
11612 Qhandle
= intern ("handle");
11613 staticpro (&Qhandle
);
11614 Qbelow_handle
= intern ("below-handle");
11615 staticpro (&Qbelow_handle
);
11616 Qup
= intern ("up");
11618 Qdown
= intern ("down");
11619 staticpro (&Qdown
);
11620 Qtop
= intern ("top");
11622 Qbottom
= intern ("bottom");
11623 staticpro (&Qbottom
);
11624 Qend_scroll
= intern ("end-scroll");
11625 staticpro (&Qend_scroll
);
11626 Qratio
= intern ("ratio");
11627 staticpro (&Qratio
);
11629 Qevent_kind
= intern ("event-kind");
11630 staticpro (&Qevent_kind
);
11631 Qevent_symbol_elements
= intern ("event-symbol-elements");
11632 staticpro (&Qevent_symbol_elements
);
11633 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11634 staticpro (&Qevent_symbol_element_mask
);
11635 Qmodifier_cache
= intern ("modifier-cache");
11636 staticpro (&Qmodifier_cache
);
11638 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11639 staticpro (&Qrecompute_lucid_menubar
);
11640 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11641 staticpro (&Qactivate_menubar_hook
);
11643 Qpolling_period
= intern ("polling-period");
11644 staticpro (&Qpolling_period
);
11646 Qinput_method_function
= intern ("input-method-function");
11647 staticpro (&Qinput_method_function
);
11649 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11650 staticpro (&Qinput_method_exit_on_first_char
);
11651 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11652 staticpro (&Qinput_method_use_echo_area
);
11654 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11655 Fset (Qinput_method_use_echo_area
, Qnil
);
11657 last_point_position_buffer
= Qnil
;
11658 last_point_position_window
= Qnil
;
11661 struct event_head
*p
;
11663 for (p
= head_table
;
11664 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11667 *p
->var
= intern (p
->name
);
11668 staticpro (p
->var
);
11669 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11670 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11674 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11675 staticpro (&button_down_location
);
11676 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11677 staticpro (&mouse_syms
);
11678 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11679 staticpro (&wheel_syms
);
11683 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11685 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11686 for (i
= 0; i
< len
; i
++)
11687 if (modifier_names
[i
])
11688 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11689 staticpro (&modifier_symbols
);
11692 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11693 staticpro (&recent_keys
);
11695 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11696 staticpro (&this_command_keys
);
11698 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11699 staticpro (&raw_keybuf
);
11701 Qextended_command_history
= intern ("extended-command-history");
11702 Fset (Qextended_command_history
, Qnil
);
11703 staticpro (&Qextended_command_history
);
11705 accent_key_syms
= Qnil
;
11706 staticpro (&accent_key_syms
);
11708 func_key_syms
= Qnil
;
11709 staticpro (&func_key_syms
);
11711 drag_n_drop_syms
= Qnil
;
11712 staticpro (&drag_n_drop_syms
);
11714 unread_switch_frame
= Qnil
;
11715 staticpro (&unread_switch_frame
);
11717 internal_last_event_frame
= Qnil
;
11718 staticpro (&internal_last_event_frame
);
11720 read_key_sequence_cmd
= Qnil
;
11721 staticpro (&read_key_sequence_cmd
);
11723 menu_bar_one_keymap_changed_items
= Qnil
;
11724 staticpro (&menu_bar_one_keymap_changed_items
);
11726 menu_bar_items_vector
= Qnil
;
11727 staticpro (&menu_bar_items_vector
);
11729 defsubr (&Scurrent_idle_time
);
11730 defsubr (&Sevent_convert_list
);
11731 defsubr (&Sread_key_sequence
);
11732 defsubr (&Sread_key_sequence_vector
);
11733 defsubr (&Srecursive_edit
);
11735 defsubr (&Strack_mouse
);
11737 defsubr (&Sinput_pending_p
);
11738 defsubr (&Scommand_execute
);
11739 defsubr (&Srecent_keys
);
11740 defsubr (&Sthis_command_keys
);
11741 defsubr (&Sthis_command_keys_vector
);
11742 defsubr (&Sthis_single_command_keys
);
11743 defsubr (&Sthis_single_command_raw_keys
);
11744 defsubr (&Sreset_this_command_lengths
);
11745 defsubr (&Sclear_this_command_keys
);
11746 defsubr (&Ssuspend_emacs
);
11747 defsubr (&Sabort_recursive_edit
);
11748 defsubr (&Sexit_recursive_edit
);
11749 defsubr (&Srecursion_depth
);
11750 defsubr (&Stop_level
);
11751 defsubr (&Sdiscard_input
);
11752 defsubr (&Sopen_dribble_file
);
11753 defsubr (&Sset_input_interrupt_mode
);
11754 defsubr (&Sset_output_flow_control
);
11755 defsubr (&Sset_input_meta_mode
);
11756 defsubr (&Sset_quit_char
);
11757 defsubr (&Sset_input_mode
);
11758 defsubr (&Scurrent_input_mode
);
11759 defsubr (&Sexecute_extended_command
);
11760 defsubr (&Sposn_at_point
);
11761 defsubr (&Sposn_at_x_y
);
11763 DEFVAR_LISP ("last-command-char", &last_command_char
,
11764 doc
: /* Last input event that was part of a command. */);
11766 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11767 doc
: /* Last input event that was part of a command. */);
11769 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11770 doc
: /* Last input event in a command, except for mouse menu events.
11771 Mouse menus give back keys that don't look like mouse events;
11772 this variable holds the actual mouse event that led to the menu,
11773 so that you can determine whether the command was run by mouse or not. */);
11775 DEFVAR_LISP ("last-input-char", &last_input_char
,
11776 doc
: /* Last input event. */);
11778 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11779 doc
: /* Last input event. */);
11781 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11782 doc
: /* List of events to be read as the command input.
11783 These events are processed first, before actual keyboard input.
11784 Events read from this list are not normally added to `this-command-keys',
11785 as they will already have been added once as they were read for the first time.
11786 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11787 Vunread_command_events
= Qnil
;
11789 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11790 doc
: /* If not -1, an object to be read as next command input event. */);
11792 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11793 doc
: /* List of events to be processed as input by input methods.
11794 These events are processed before `unread-command-events'
11795 and actual keyboard input without given to `input-method-function'. */);
11796 Vunread_post_input_method_events
= Qnil
;
11798 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11799 doc
: /* List of events to be processed as input by input methods.
11800 These events are processed after `unread-command-events', but
11801 before actual keyboard input.
11802 If there's an active input method, the events are given to
11803 `input-method-function'. */);
11804 Vunread_input_method_events
= Qnil
;
11806 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11807 doc
: /* Meta-prefix character code.
11808 Meta-foo as command input turns into this character followed by foo. */);
11809 XSETINT (meta_prefix_char
, 033);
11811 DEFVAR_KBOARD ("last-command", Vlast_command
,
11812 doc
: /* The last command executed.
11813 Normally a symbol with a function definition, but can be whatever was found
11814 in the keymap, or whatever the variable `this-command' was set to by that
11817 The value `mode-exit' is special; it means that the previous command
11818 read an event that told it to exit, and it did so and unread that event.
11819 In other words, the present command is the event that made the previous
11822 The value `kill-region' is special; it means that the previous command
11823 was a kill command.
11825 `last-command' has a separate binding for each terminal device.
11826 See Info node `(elisp)Multiple displays'. */);
11828 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11829 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11831 DEFVAR_LISP ("this-command", &Vthis_command
,
11832 doc
: /* The command now being executed.
11833 The command can set this variable; whatever is put here
11834 will be in `last-command' during the following command. */);
11835 Vthis_command
= Qnil
;
11837 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11838 doc
: /* The command bound to the current key sequence before remapping.
11839 It equals `this-command' if the original command was not remapped through
11840 any of the active keymaps. Otherwise, the value of `this-command' is the
11841 result of looking up the original command in the active keymaps. */);
11842 Vthis_original_command
= Qnil
;
11844 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11845 doc
: /* *Number of input events between auto-saves.
11846 Zero means disable autosaving due to number of characters typed. */);
11847 auto_save_interval
= 300;
11849 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11850 doc
: /* *Number of seconds idle time before auto-save.
11851 Zero or nil means disable auto-saving due to idleness.
11852 After auto-saving due to this many seconds of idle time,
11853 Emacs also does a garbage collection if that seems to be warranted. */);
11854 XSETFASTINT (Vauto_save_timeout
, 30);
11856 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11857 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11858 The value may be integer or floating point. */);
11859 Vecho_keystrokes
= make_number (1);
11861 DEFVAR_INT ("polling-period", &polling_period
,
11862 doc
: /* *Interval between polling for input during Lisp execution.
11863 The reason for polling is to make C-g work to stop a running program.
11864 Polling is needed only when using X windows and SIGIO does not work.
11865 Polling is automatically disabled in all other cases. */);
11866 polling_period
= 2;
11868 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11869 doc
: /* *Maximum time between mouse clicks to make a double-click.
11870 Measured in milliseconds. The value nil means disable double-click
11871 recognition; t means double-clicks have no time limit and are detected
11872 by position only. */);
11873 Vdouble_click_time
= make_number (500);
11875 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11876 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11877 On window-system frames, value is the number of pixels the mouse may have
11878 moved horizontally or vertically between two clicks to make a double-click.
11879 On non window-system frames, value is interpreted in units of 1/8 characters
11882 This variable is also the threshold for motion of the mouse
11883 to count as a drag. */);
11884 double_click_fuzz
= 3;
11886 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11887 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11888 inhibit_local_menu_bar_menus
= 0;
11890 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11891 doc
: /* Number of complete key sequences read as input so far.
11892 This includes key sequences read from keyboard macros.
11893 The number is effectively the number of interactive command invocations. */);
11894 num_input_keys
= 0;
11896 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11897 doc
: /* Number of input events read from the keyboard so far.
11898 This does not include events generated by keyboard macros. */);
11899 num_nonmacro_input_events
= 0;
11901 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11902 doc
: /* The frame in which the most recently read event occurred.
11903 If the last event came from a keyboard macro, this is set to `macro'. */);
11904 Vlast_event_frame
= Qnil
;
11906 /* This variable is set up in sysdep.c. */
11907 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11908 doc
: /* The ERASE character as set by the user with stty. */);
11910 DEFVAR_LISP ("help-char", &Vhelp_char
,
11911 doc
: /* Character to recognize as meaning Help.
11912 When it is read, do `(eval help-form)', and display result if it's a string.
11913 If the value of `help-form' is nil, this char can be read normally. */);
11914 XSETINT (Vhelp_char
, Ctl ('H'));
11916 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11917 doc
: /* List of input events to recognize as meaning Help.
11918 These work just like the value of `help-char' (see that). */);
11919 Vhelp_event_list
= Qnil
;
11921 DEFVAR_LISP ("help-form", &Vhelp_form
,
11922 doc
: /* Form to execute when character `help-char' is read.
11923 If the form returns a string, that string is displayed.
11924 If `help-form' is nil, the help char is not recognized. */);
11927 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11928 doc
: /* Command to run when `help-char' character follows a prefix key.
11929 This command is used only when there is no actual binding
11930 for that character after that prefix key. */);
11931 Vprefix_help_command
= Qnil
;
11933 DEFVAR_LISP ("top-level", &Vtop_level
,
11934 doc
: /* Form to evaluate when Emacs starts up.
11935 Useful to set before you dump a modified Emacs. */);
11938 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11939 doc
: /* Translate table for local keyboard input, or nil.
11940 If non-nil, the value should be a char-table. Each character read
11941 from the keyboard is looked up in this char-table. If the value found
11942 there is non-nil, then it is used instead of the actual input character.
11944 The value can also be a string or vector, but this is considered obsolete.
11945 If it is a string or vector of length N, character codes N and up are left
11946 untranslated. In a vector, an element which is nil means "no translation".
11948 This is applied to the characters supplied to input methods, not their
11949 output. See also `translation-table-for-input'.
11951 This variable has a separate binding for each terminal. See Info node
11952 `(elisp)Multiple displays'. */);
11954 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11955 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11956 \(Even if the operating system has support for stopping a process.\) */);
11957 cannot_suspend
= 0;
11959 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11960 doc
: /* Non-nil means prompt with menus when appropriate.
11961 This is done when reading from a keymap that has a prompt string,
11962 for elements that have prompt strings.
11963 The menu is displayed on the screen
11964 if X menus were enabled at configuration
11965 time and the previous event was a mouse click prefix key.
11966 Otherwise, menu prompting uses the echo area. */);
11967 menu_prompting
= 1;
11969 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11970 doc
: /* Character to see next line of menu prompt.
11971 Type this character while in a menu prompt to rotate around the lines of it. */);
11972 XSETINT (menu_prompt_more_char
, ' ');
11974 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11975 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11976 Emacs applies the modifiers of the character stored here to each keyboard
11977 character it reads. For example, after evaluating the expression
11978 (setq extra-keyboard-modifiers ?\\C-x)
11979 all input characters will have the control modifier applied to them.
11981 Note that the character ?\\C-@, equivalent to the integer zero, does
11982 not count as a control character; rather, it counts as a character
11983 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11984 cancels any modification. */);
11985 extra_keyboard_modifiers
= 0;
11987 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11988 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11989 The command loop sets this to nil before each command,
11990 and tests the value when the command returns.
11991 Buffer modification stores t in this variable. */);
11992 Vdeactivate_mark
= Qnil
;
11994 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11995 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11996 Vcommand_hook_internal
= Qnil
;
11998 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11999 doc
: /* Normal hook run before each command is executed.
12000 If an unhandled error happens in running this hook,
12001 the hook value is set to nil, since otherwise the error
12002 might happen repeatedly and make Emacs nonfunctional. */);
12003 Vpre_command_hook
= Qnil
;
12005 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12006 doc
: /* Normal hook run after each command is executed.
12007 If an unhandled error happens in running this hook,
12008 the hook value is set to nil, since otherwise the error
12009 might happen repeatedly and make Emacs nonfunctional. */);
12010 Vpost_command_hook
= Qnil
;
12013 DEFVAR_LISP ("echo-area-clear-hook", ...,
12014 doc
: /* Normal hook run when clearing the echo area. */);
12016 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12017 staticpro (&Qecho_area_clear_hook
);
12018 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12020 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12021 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12022 Vlucid_menu_bar_dirty_flag
= Qnil
;
12024 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12025 doc
: /* List of menu bar items to move to the end of the menu bar.
12026 The elements of the list are event types that may have menu bar bindings. */);
12027 Vmenu_bar_final_items
= Qnil
;
12029 DEFVAR_KBOARD ("overriding-terminal-local-map",
12030 Voverriding_terminal_local_map
,
12031 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12032 If this variable is non-nil, it is used as a keymap instead of the
12033 buffer's local map, and the minor mode keymaps and text property keymaps.
12034 It also replaces `overriding-local-map'.
12036 This variable is intended to let commands such as `universal-argument'
12037 set up a different keymap for reading the next command.
12039 `overriding-terminal-local-map' has a separate binding for each
12041 See Info node `(elisp)Multiple displays'. */);
12043 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12044 doc
: /* Keymap that overrides all other local keymaps.
12045 If this variable is non-nil, it is used as a keymap--replacing the
12046 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12047 Voverriding_local_map
= Qnil
;
12049 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12050 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12051 Otherwise, the menu bar continues to reflect the buffer's local map
12052 and the minor mode maps regardless of `overriding-local-map'. */);
12053 Voverriding_local_map_menu_flag
= Qnil
;
12055 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12056 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12057 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12059 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12060 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12062 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12063 doc
: /* Alist of system-specific X windows key symbols.
12064 Each element should have the form (N . SYMBOL) where N is the
12065 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12066 and SYMBOL is its name.
12068 `system-key-alist' has a separate binding for each terminal device.
12069 See Info node `(elisp)Multiple displays'. */);
12071 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12072 doc
: /* Keymap that translates key sequences to key sequences during input.
12073 This is used mainly for mapping ASCII function key sequences into
12074 real Emacs function key events (symbols).
12076 The `read-key-sequence' function replaces any subsequence bound by
12077 `local-function-key-map' with its binding. More precisely, when the
12078 active keymaps have no binding for the current key sequence but
12079 `local-function-key-map' binds a suffix of the sequence to a vector or
12080 string, `read-key-sequence' replaces the matching suffix with its
12081 binding, and continues with the new sequence.
12083 If the binding is a function, it is called with one argument (the prompt)
12084 and its return value (a key sequence) is used.
12086 The events that come from bindings in `local-function-key-map' are not
12087 themselves looked up in `local-function-key-map'.
12089 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12090 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12091 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12092 typing `ESC O P x' would return [f1 x].
12094 `local-function-key-map' has a separate binding for each terminal
12095 device. See Info node `(elisp)Multiple displays'. If you need to
12096 define a binding on all terminals, change `function-key-map'
12097 instead. Initially, `local-function-key-map' is an empty keymap that
12098 has `function-key-map' as its parent on all terminal devices. */);
12100 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12101 doc
: /* The parent keymap of all `local-function-key-map' instances.
12102 Function key definitions that apply to all terminal devices should go
12103 here. If a mapping is defined in both the current
12104 `local-function-key-map' binding and this variable, then the local
12105 definition will take precendence. */);
12106 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12108 DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map
,
12109 doc
: /* Keymap of key translations that can override keymaps.
12110 This keymap works like `function-key-map', but comes after that,
12111 and its non-prefix bindings override ordinary bindings.
12113 `key-translation-map' has a separate binding for each terminal device.
12114 (See Info node `(elisp)Multiple displays'.) If you need to set a key
12115 translation on all terminals, change `global-key-translation-map' instead. */);
12117 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12118 doc
: /* The parent keymap of all `local-key-translation-map' instances.
12119 Key translations that apply to all terminal devices should go here. */);
12120 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12122 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12123 doc
: /* List of deferred actions to be performed at a later time.
12124 The precise format isn't relevant here; we just check whether it is nil. */);
12125 Vdeferred_action_list
= Qnil
;
12127 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12128 doc
: /* Function to call to handle deferred actions, after each command.
12129 This function is called with no arguments after each command
12130 whenever `deferred-action-list' is non-nil. */);
12131 Vdeferred_action_function
= Qnil
;
12133 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12134 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12135 The value can be a length of time to show the message for.
12136 If the value is non-nil and not a number, we wait 2 seconds. */);
12137 Vsuggest_key_bindings
= Qt
;
12139 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12140 doc
: /* List of active absolute time timers in order of increasing time. */);
12141 Vtimer_list
= Qnil
;
12143 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12144 doc
: /* List of active idle-time timers in order of increasing time. */);
12145 Vtimer_idle_list
= Qnil
;
12147 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12148 doc
: /* If non-nil, the function that implements the current input method.
12149 It's called with one argument, a printing character that was just read.
12150 \(That means a character with code 040...0176.)
12151 Typically this function uses `read-event' to read additional events.
12152 When it does so, it should first bind `input-method-function' to nil
12153 so it will not be called recursively.
12155 The function should return a list of zero or more events
12156 to be used as input. If it wants to put back some events
12157 to be reconsidered, separately, by the input method,
12158 it can add them to the beginning of `unread-command-events'.
12160 The input method function can find in `input-method-previous-method'
12161 the previous echo area message.
12163 The input method function should refer to the variables
12164 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12165 for guidance on what to do. */);
12166 Vinput_method_function
= Qnil
;
12168 DEFVAR_LISP ("input-method-previous-message",
12169 &Vinput_method_previous_message
,
12170 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12171 This variable exists because `read-event' clears the echo area
12172 before running the input method. It is nil if there was no message. */);
12173 Vinput_method_previous_message
= Qnil
;
12175 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12176 doc
: /* If non-nil, the function that implements the display of help.
12177 It's called with one argument, the help string to display. */);
12178 Vshow_help_function
= Qnil
;
12180 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12181 doc
: /* If non-nil, suppress point adjustment after executing a command.
12183 After a command is executed, if point is moved into a region that has
12184 special properties (e.g. composition, display), we adjust point to
12185 the boundary of the region. But, when a command sets this variable to
12186 non-nil, we suppress the point adjustment.
12188 This variable is set to nil before reading a command, and is checked
12189 just after executing the command. */);
12190 Vdisable_point_adjustment
= Qnil
;
12192 DEFVAR_LISP ("global-disable-point-adjustment",
12193 &Vglobal_disable_point_adjustment
,
12194 doc
: /* *If non-nil, always suppress point adjustment.
12196 The default value is nil, in which case, point adjustment are
12197 suppressed only after special commands that set
12198 `disable-point-adjustment' (which see) to non-nil. */);
12199 Vglobal_disable_point_adjustment
= Qnil
;
12201 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12202 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12203 If the value is not a number, such messages don't time out. */);
12204 Vminibuffer_message_timeout
= make_number (2);
12206 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12207 doc
: /* If non-nil, any keyboard input throws to this symbol.
12208 The value of that variable is passed to `quit-flag' and later causes a
12209 peculiar kind of quitting. */);
12210 Vthrow_on_input
= Qnil
;
12212 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12213 doc
: /* If non-nil, function to output error messages.
12214 The arguments are the error data, a list of the form
12215 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12216 such as just as `condition-case' would bind its variable to,
12217 the context (a string which normally goes at the start of the message),
12218 and the Lisp function within which the error was signaled. */);
12219 Vcommand_error_function
= Qnil
;
12221 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12222 &Venable_disabled_menus_and_buttons
,
12223 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12225 Help functions bind this to allow help on disabled menu items
12226 and tool-bar buttons. */);
12227 Venable_disabled_menus_and_buttons
= Qnil
;
12231 keys_of_keyboard ()
12233 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12234 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12235 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12236 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12237 initial_define_key (meta_map
, 'x', "execute-extended-command");
12239 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12240 "handle-delete-frame");
12241 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12242 current-prefix-arg, as is done in `handle-switch-frame'.
12243 But `handle-switch-frame is not run from the special-map.
12244 Commands from that map are run in a special way that automatically
12245 preserves the prefix-arg. Restoring the prefix arg here is not just
12246 redundant but harmful:
12248 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12249 - after the first prompt, the exit-minibuffer-hook is run which may
12250 iconify a frame and thus push a `iconify-frame' event.
12251 - after running exit-minibuffer-hook, current-prefix-arg is
12252 restored to the non-nil value it had before the prompt.
12253 - we enter the second prompt.
12254 current-prefix-arg is non-nil, prefix-arg is nil.
12255 - before running the first real event, we run the special iconify-frame
12256 event, but we pass the `special' arg to execute-command so
12257 current-prefix-arg and prefix-arg are left untouched.
12258 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12259 - the next key event will have a spuriously non-nil current-prefix-arg. */
12260 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12262 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12264 /* Handling it at such a low-level causes read_key_sequence to get
12265 * confused because it doesn't realize that the current_buffer was
12266 * changed by read_char.
12268 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12269 * "handle-select-window"); */
12270 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12271 "handle-save-session");
12274 /* Mark the pointers in the kboard objects.
12275 Called by the Fgarbage_collector. */
12281 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12283 if (kb
->kbd_macro_buffer
)
12284 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12286 mark_object (kb
->Voverriding_terminal_local_map
);
12287 mark_object (kb
->Vlast_command
);
12288 mark_object (kb
->Vreal_last_command
);
12289 mark_object (kb
->Vkeyboard_translate_table
);
12290 mark_object (kb
->Vprefix_arg
);
12291 mark_object (kb
->Vlast_prefix_arg
);
12292 mark_object (kb
->kbd_queue
);
12293 mark_object (kb
->defining_kbd_macro
);
12294 mark_object (kb
->Vlast_kbd_macro
);
12295 mark_object (kb
->Vsystem_key_alist
);
12296 mark_object (kb
->system_key_syms
);
12297 mark_object (kb
->Vlocal_function_key_map
);
12298 mark_object (kb
->Vlocal_key_translation_map
);
12299 mark_object (kb
->Vdefault_minibuffer_frame
);
12300 mark_object (kb
->echo_string
);
12303 struct input_event
*event
;
12304 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12306 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12307 event
= kbd_buffer
;
12308 if (event
->kind
!= SELECTION_REQUEST_EVENT
12309 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12311 mark_object (event
->x
);
12312 mark_object (event
->y
);
12314 mark_object (event
->frame_or_window
);
12315 mark_object (event
->arg
);
12320 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12321 (do not change this comment) */