1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
47 #ifdef HAVE_GTK_AND_PTHREAD
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #include "syssignal.h"
59 #include <sys/types.h>
68 /* This is to get the definitions of the XK_ symbols. */
75 #endif /* HAVE_NTGUI */
85 /* Variables for blockinput.h: */
87 /* Non-zero if interrupt input is blocked right now. */
88 volatile int interrupt_input_blocked
;
90 /* Nonzero means an input interrupt has arrived
91 during the current critical section. */
92 int interrupt_input_pending
;
94 /* This var should be (interrupt_input_pending || pending_atimers).
95 The QUIT macro checks this instead of interrupt_input_pending and
96 pending_atimers separately, to reduce code size. So, any code that
97 changes interrupt_input_pending or pending_atimers should update
103 #define KBD_BUFFER_SIZE 4096
105 KBOARD
*initial_kboard
;
106 KBOARD
*current_kboard
;
110 /* Non-nil disable property on a command means
111 do not execute it; call disabled-command-function's value instead. */
112 Lisp_Object Qdisabled
, Qdisabled_command_function
;
114 #define NUM_RECENT_KEYS (300)
115 int recent_keys_index
; /* Index for storing next element into recent_keys */
116 int total_keys
; /* Total number of elements stored into recent_keys */
117 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
119 /* Vector holding the key sequence that invoked the current command.
120 It is reused for each command, and it may be longer than the current
121 sequence; this_command_key_count indicates how many elements
122 actually mean something.
123 It's easier to staticpro a single Lisp_Object than an array. */
124 Lisp_Object this_command_keys
;
125 int this_command_key_count
;
127 /* 1 after calling Freset_this_command_lengths.
129 int this_command_key_count_reset
;
131 /* This vector is used as a buffer to record the events that were actually read
132 by read_key_sequence. */
133 Lisp_Object raw_keybuf
;
134 int raw_keybuf_count
;
136 /* Non-nil if the present key sequence was obtained by shift translation. */
137 Lisp_Object Vthis_command_keys_shift_translated
;
139 #define GROW_RAW_KEYBUF \
140 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
141 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
143 /* Number of elements of this_command_keys
144 that precede this key sequence. */
145 int this_single_command_key_start
;
147 /* Record values of this_command_key_count and echo_length ()
148 before this command was read. */
149 static int before_command_key_count
;
150 static int before_command_echo_length
;
152 extern int minbuf_level
;
154 extern int message_enable_multibyte
;
156 /* If non-nil, the function that implements the display of help.
157 It's called with one argument, the help string to display. */
159 Lisp_Object Vshow_help_function
;
161 /* Nonzero means do menu prompting. */
163 static int menu_prompting
;
165 /* Character to see next line of menu prompt. */
167 static Lisp_Object menu_prompt_more_char
;
169 /* For longjmp to where kbd input is being done. */
171 static jmp_buf getcjmp
;
173 /* True while doing kbd input. */
174 int waiting_for_input
;
176 /* True while displaying for echoing. Delays C-g throwing. */
180 /* Non-null means we can start echoing at the next input pause even
181 though there is something in the echo area. */
183 static struct kboard
*ok_to_echo_at_next_pause
;
185 /* The kboard last echoing, or null for none. Reset to 0 in
186 cancel_echoing. If non-null, and a current echo area message
187 exists, and echo_message_buffer is eq to the current message
188 buffer, we know that the message comes from echo_kboard. */
190 struct kboard
*echo_kboard
;
192 /* The buffer used for echoing. Set in echo_now, reset in
195 Lisp_Object echo_message_buffer
;
197 /* Nonzero means disregard local maps for the menu bar. */
198 static int inhibit_local_menu_bar_menus
;
200 /* Nonzero means C-g should cause immediate error-signal. */
203 /* The user's hook function for outputting an error message. */
204 Lisp_Object Vcommand_error_function
;
206 /* The user's ERASE setting. */
207 Lisp_Object Vtty_erase_char
;
209 /* Character to recognize as the help char. */
210 Lisp_Object Vhelp_char
;
212 /* List of other event types to recognize as meaning "help". */
213 Lisp_Object Vhelp_event_list
;
215 /* Form to execute when help char is typed. */
216 Lisp_Object Vhelp_form
;
218 /* Command to run when the help character follows a prefix key. */
219 Lisp_Object Vprefix_help_command
;
221 /* List of items that should move to the end of the menu bar. */
222 Lisp_Object Vmenu_bar_final_items
;
224 /* Non-nil means show the equivalent key-binding for
225 any M-x command that has one.
226 The value can be a length of time to show the message for.
227 If the value is non-nil and not a number, we wait 2 seconds. */
228 Lisp_Object Vsuggest_key_bindings
;
230 /* How long to display an echo-area message when the minibuffer is active.
231 If the value is not a number, such messages don't time out. */
232 Lisp_Object Vminibuffer_message_timeout
;
234 /* Character that causes a quit. Normally C-g.
236 If we are running on an ordinary terminal, this must be an ordinary
237 ASCII char, since we want to make it our interrupt character.
239 If we are not running on an ordinary terminal, it still needs to be
240 an ordinary ASCII char. This character needs to be recognized in
241 the input interrupt handler. At this point, the keystroke is
242 represented as a struct input_event, while the desired quit
243 character is specified as a lispy event. The mapping from struct
244 input_events to lispy events cannot run in an interrupt handler,
245 and the reverse mapping is difficult for anything but ASCII
248 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
252 extern Lisp_Object current_global_map
;
253 extern int minibuf_level
;
255 /* If non-nil, this is a map that overrides all other local maps. */
256 Lisp_Object Voverriding_local_map
;
258 /* If non-nil, Voverriding_local_map applies to the menu bar. */
259 Lisp_Object Voverriding_local_map_menu_flag
;
261 /* Keymap that defines special misc events that should
262 be processed immediately at a low level. */
263 Lisp_Object Vspecial_event_map
;
265 /* Current depth in recursive edits. */
266 int command_loop_level
;
268 /* Total number of times command_loop has read a key sequence. */
269 EMACS_INT num_input_keys
;
271 /* Last input event read as a command. */
272 Lisp_Object last_command_event
;
274 /* Last input character read as a command, not counting menus
275 reached by the mouse. */
276 Lisp_Object last_nonmenu_event
;
278 /* Last input event read for any purpose. */
279 Lisp_Object last_input_event
;
281 /* If not Qnil, a list of objects to be read as subsequent command input. */
282 Lisp_Object Vunread_command_events
;
284 /* If not Qnil, a list of objects to be read as subsequent command input
285 including input method processing. */
286 Lisp_Object Vunread_input_method_events
;
288 /* If not Qnil, a list of objects to be read as subsequent command input
289 but NOT including input method processing. */
290 Lisp_Object Vunread_post_input_method_events
;
292 /* If not -1, an event to be read as subsequent command input. */
293 EMACS_INT unread_command_char
;
295 /* If not Qnil, this is a switch-frame event which we decided to put
296 off until the end of a key sequence. This should be read as the
297 next command input, after any unread_command_events.
299 read_key_sequence uses this to delay switch-frame events until the
300 end of the key sequence; Fread_char uses it to put off switch-frame
301 events until a non-ASCII event is acceptable as input. */
302 Lisp_Object unread_switch_frame
;
304 /* A mask of extra modifier bits to put into every keyboard char. */
305 EMACS_INT extra_keyboard_modifiers
;
307 /* Char to use as prefix when a meta character is typed in.
308 This is bound on entry to minibuffer in case ESC is changed there. */
310 Lisp_Object meta_prefix_char
;
312 /* Last size recorded for a current buffer which is not a minibuffer. */
313 static int last_non_minibuf_size
;
315 /* Number of idle seconds before an auto-save and garbage collection. */
316 static Lisp_Object Vauto_save_timeout
;
318 /* Total number of times read_char has returned. */
319 int num_input_events
;
321 /* Total number of times read_char has returned, outside of macros. */
322 EMACS_INT num_nonmacro_input_events
;
324 /* Auto-save automatically when this many characters have been typed
325 since the last time. */
327 static EMACS_INT auto_save_interval
;
329 /* Value of num_nonmacro_input_events as of last auto save. */
333 /* The command being executed by the command loop.
334 Commands may set this, and the value set will be copied into
335 current_kboard->Vlast_command instead of the actual command. */
336 Lisp_Object Vthis_command
;
338 /* This is like Vthis_command, except that commands never set it. */
339 Lisp_Object real_this_command
;
341 /* If the lookup of the command returns a binding, the original
342 command is stored in this-original-command. It is nil otherwise. */
343 Lisp_Object Vthis_original_command
;
345 /* The value of point when the last command was started. */
346 int last_point_position
;
348 /* The buffer that was current when the last command was started. */
349 Lisp_Object last_point_position_buffer
;
351 /* The window that was selected when the last command was started. */
352 Lisp_Object last_point_position_window
;
354 /* The frame in which the last input event occurred, or Qmacro if the
355 last event came from a macro. We use this to determine when to
356 generate switch-frame events. This may be cleared by functions
357 like Fselect_frame, to make sure that a switch-frame event is
358 generated by the next character. */
359 Lisp_Object internal_last_event_frame
;
361 /* A user-visible version of the above, intended to allow users to
362 figure out where the last event came from, if the event doesn't
363 carry that information itself (i.e. if it was a character). */
364 Lisp_Object Vlast_event_frame
;
366 /* The timestamp of the last input event we received from the X server.
367 X Windows wants this for selection ownership. */
368 unsigned long last_event_timestamp
;
370 Lisp_Object Qself_insert_command
;
371 Lisp_Object Qforward_char
;
372 Lisp_Object Qbackward_char
;
373 Lisp_Object Qundefined
;
374 Lisp_Object Qtimer_event_handler
;
376 /* read_key_sequence stores here the command definition of the
377 key sequence that it reads. */
378 Lisp_Object read_key_sequence_cmd
;
380 /* Echo unfinished commands after this many seconds of pause. */
381 Lisp_Object Vecho_keystrokes
;
383 /* Form to evaluate (if non-nil) when Emacs is started. */
384 Lisp_Object Vtop_level
;
386 /* If non-nil, this implements the current input method. */
387 Lisp_Object Vinput_method_function
;
388 Lisp_Object Qinput_method_function
;
390 /* When we call Vinput_method_function,
391 this holds the echo area message that was just erased. */
392 Lisp_Object Vinput_method_previous_message
;
394 /* Non-nil means deactivate the mark at end of this command. */
395 Lisp_Object Vdeactivate_mark
;
396 Lisp_Object Qdeactivate_mark
;
398 /* Menu bar specified in Lucid Emacs fashion. */
400 Lisp_Object Vlucid_menu_bar_dirty_flag
;
401 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
403 Lisp_Object Qecho_area_clear_hook
;
405 /* Hooks to run before and after each command. */
406 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
407 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
408 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
410 /* Parent keymap of terminal-local function-key-map instances. */
411 Lisp_Object Vfunction_key_map
;
413 /* Keymap of key translations that can override keymaps. */
414 Lisp_Object Vkey_translation_map
;
416 /* List of deferred actions to be performed at a later time.
417 The precise format isn't relevant here; we just check whether it is nil. */
418 Lisp_Object Vdeferred_action_list
;
420 /* Function to call to handle deferred actions, when there are any. */
421 Lisp_Object Vdeferred_action_function
;
422 Lisp_Object Qdeferred_action_function
;
424 Lisp_Object Qinput_method_exit_on_first_char
;
425 Lisp_Object Qinput_method_use_echo_area
;
427 /* File in which we write all commands we read. */
430 /* Nonzero if input is available. */
433 extern char *pending_malloc_warning
;
435 /* Circular buffer for pre-read keyboard input. */
437 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
439 /* Pointer to next available character in kbd_buffer.
440 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
441 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
442 next available char is in kbd_buffer[0]. */
443 static struct input_event
*kbd_fetch_ptr
;
445 /* Pointer to next place to store character in kbd_buffer. This
446 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
447 character should go in kbd_buffer[0]. */
448 static struct input_event
* volatile kbd_store_ptr
;
450 /* The above pair of variables forms a "queue empty" flag. When we
451 enqueue a non-hook event, we increment kbd_store_ptr. When we
452 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
453 there is input available if the two pointers are not equal.
455 Why not just have a flag set and cleared by the enqueuing and
456 dequeuing functions? Such a flag could be screwed up by interrupts
457 at inopportune times. */
459 /* If this flag is non-nil, we check mouse_moved to see when the
460 mouse moves, and motion events will appear in the input stream.
461 Otherwise, mouse motion is ignored. */
462 Lisp_Object do_mouse_tracking
;
464 /* Symbols to head events. */
465 Lisp_Object Qmouse_movement
;
466 Lisp_Object Qscroll_bar_movement
;
467 Lisp_Object Qswitch_frame
;
468 Lisp_Object Qdelete_frame
;
469 Lisp_Object Qiconify_frame
;
470 Lisp_Object Qmake_frame_visible
;
471 Lisp_Object Qselect_window
;
472 Lisp_Object Qhelp_echo
;
474 extern Lisp_Object Qremap
;
476 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
477 Lisp_Object Qmouse_fixup_help_message
;
480 /* Symbols to denote kinds of events. */
481 Lisp_Object Qfunction_key
;
482 Lisp_Object Qmouse_click
;
483 #if defined (WINDOWSNT)
484 Lisp_Object Qlanguage_change
;
486 Lisp_Object Qdrag_n_drop
;
487 Lisp_Object Qsave_session
;
489 Lisp_Object Qdbus_event
;
491 /* Lisp_Object Qmouse_movement; - also an event header */
493 /* Properties of event headers. */
494 Lisp_Object Qevent_kind
;
495 Lisp_Object Qevent_symbol_elements
;
497 /* menu item parts */
498 Lisp_Object Qmenu_alias
;
499 Lisp_Object Qmenu_enable
;
500 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
501 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
502 extern Lisp_Object Vdefine_key_rebound_commands
;
503 extern Lisp_Object Qmenu_item
;
505 /* An event header symbol HEAD may have a property named
506 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
507 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
508 mask of modifiers applied to it. If present, this is used to help
509 speed up parse_modifiers. */
510 Lisp_Object Qevent_symbol_element_mask
;
512 /* An unmodified event header BASE may have a property named
513 Qmodifier_cache, which is an alist mapping modifier masks onto
514 modified versions of BASE. If present, this helps speed up
516 Lisp_Object Qmodifier_cache
;
518 /* Symbols to use for parts of windows. */
519 Lisp_Object Qmode_line
;
520 Lisp_Object Qvertical_line
;
521 Lisp_Object Qvertical_scroll_bar
;
522 Lisp_Object Qmenu_bar
;
523 extern Lisp_Object Qleft_margin
, Qright_margin
;
524 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
525 extern Lisp_Object QCmap
;
527 Lisp_Object
recursive_edit_unwind (), command_loop ();
528 Lisp_Object
Fthis_command_keys ();
529 Lisp_Object Qextended_command_history
;
530 EMACS_TIME
timer_check ();
532 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
534 extern char *x_get_keysym_name ();
536 static void record_menu_key ();
537 static int echo_length ();
539 Lisp_Object Qpolling_period
;
541 /* List of absolute timers. Appears in order of next scheduled event. */
542 Lisp_Object Vtimer_list
;
544 /* List of idle time timers. Appears in order of next scheduled event. */
545 Lisp_Object Vtimer_idle_list
;
547 /* Incremented whenever a timer is run. */
550 extern Lisp_Object Vprint_level
, Vprint_length
;
552 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
554 EMACS_TIME
*input_available_clear_time
;
556 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
557 Default is 1 if INTERRUPT_INPUT is defined. */
560 /* Nonzero while interrupts are temporarily deferred during redisplay. */
561 int interrupts_deferred
;
563 /* Allow m- file to inhibit use of FIONREAD. */
564 #ifdef BROKEN_FIONREAD
568 /* We are unable to use interrupts if FIONREAD is not available,
569 so flush SIGIO so we won't try. */
570 #if !defined (FIONREAD)
576 /* If we support a window system, turn on the code to poll periodically
577 to detect C-g. It isn't actually used when doing interrupt input. */
578 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
579 #define POLL_FOR_INPUT
582 /* After a command is executed, if point is moved into a region that
583 has specific properties (e.g. composition, display), we adjust
584 point to the boundary of the region. But, if a command sets this
585 variable to non-nil, we suppress this point adjustment. This
586 variable is set to nil before reading a command. */
588 Lisp_Object Vdisable_point_adjustment
;
590 /* If non-nil, always disable point adjustment. */
592 Lisp_Object Vglobal_disable_point_adjustment
;
594 /* The time when Emacs started being idle. */
596 static EMACS_TIME timer_idleness_start_time
;
598 /* After Emacs stops being idle, this saves the last value
599 of timer_idleness_start_time from when it was idle. */
601 static EMACS_TIME timer_last_idleness_start_time
;
603 /* If non-nil, events produced by disabled menu items and tool-bar
604 buttons are not ignored. Help functions bind this to allow help on
605 those items and buttons. */
606 Lisp_Object Venable_disabled_menus_and_buttons
;
609 /* Global variable declarations. */
611 /* Flags for readable_events. */
612 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
613 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
614 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
616 /* Function for init_keyboard to call with no args (if nonzero). */
617 void (*keyboard_init_hook
) ();
619 static int read_avail_input
P_ ((int));
620 static void get_input_pending
P_ ((int *, int));
621 static int readable_events
P_ ((int));
622 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
623 Lisp_Object
, int *));
624 static Lisp_Object
read_char_x_menu_prompt ();
625 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
627 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
628 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
629 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
630 enum scroll_bar_part
,
631 Lisp_Object
, Lisp_Object
,
634 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
635 Lisp_Object
, char **,
636 Lisp_Object
*, unsigned));
637 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
638 static void save_getcjmp
P_ ((jmp_buf));
639 static void save_getcjmp ();
640 static void restore_getcjmp
P_ ((jmp_buf));
641 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
642 static void clear_event
P_ ((struct input_event
*));
643 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
644 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
645 static void handle_interrupt
P_ ((void));
646 static void timer_start_idle
P_ ((void));
647 static void timer_stop_idle
P_ ((void));
648 static void timer_resume_idle
P_ ((void));
649 static SIGTYPE handle_user_signal
P_ ((int));
650 static char *find_user_signal_name
P_ ((int));
651 static int store_user_signal_events
P_ ((void));
653 /* Nonzero means don't try to suspend even if the operating system seems
655 static int cannot_suspend
;
657 extern Lisp_Object Qidentity
, Qonly
;
659 /* Install the string STR as the beginning of the string of echoing,
660 so that it serves as a prompt for the next character.
661 Also start echoing. */
667 current_kboard
->echo_string
= str
;
668 current_kboard
->echo_after_prompt
= SCHARS (str
);
672 /* Add C to the echo string, if echoing is going on.
673 C can be a character, which is printed prettily ("M-C-x" and all that
674 jazz), or a symbol, whose name is printed. */
680 if (current_kboard
->immediate_echo
)
682 int size
= KEY_DESCRIPTION_SIZE
+ 100;
683 char *buffer
= (char *) alloca (size
);
685 Lisp_Object echo_string
;
687 echo_string
= current_kboard
->echo_string
;
689 /* If someone has passed us a composite event, use its head symbol. */
694 ptr
= push_key_description (XINT (c
), ptr
, 1);
696 else if (SYMBOLP (c
))
698 Lisp_Object name
= SYMBOL_NAME (c
);
699 int nbytes
= SBYTES (name
);
701 if (size
- (ptr
- buffer
) < nbytes
)
703 int offset
= ptr
- buffer
;
704 size
= max (2 * size
, size
+ nbytes
);
705 buffer
= (char *) alloca (size
);
706 ptr
= buffer
+ offset
;
709 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
710 STRING_MULTIBYTE (name
), 1);
713 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
716 const char *text
= " (Type ? for further options)";
717 int len
= strlen (text
);
719 if (size
- (ptr
- buffer
) < len
)
721 int offset
= ptr
- buffer
;
723 buffer
= (char *) alloca (size
);
724 ptr
= buffer
+ offset
;
727 bcopy (text
, ptr
, len
);
731 /* Replace a dash from echo_dash with a space, otherwise
732 add a space at the end as a separator between keys. */
733 if (STRINGP (echo_string
)
734 && SCHARS (echo_string
) > 1)
736 Lisp_Object last_char
, prev_char
, idx
;
738 idx
= make_number (SCHARS (echo_string
) - 2);
739 prev_char
= Faref (echo_string
, idx
);
741 idx
= make_number (SCHARS (echo_string
) - 1);
742 last_char
= Faref (echo_string
, idx
);
744 /* We test PREV_CHAR to make sure this isn't the echoing
746 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
747 Faset (echo_string
, idx
, make_number (' '));
749 echo_string
= concat2 (echo_string
, build_string (" "));
751 else if (STRINGP (echo_string
))
752 echo_string
= concat2 (echo_string
, build_string (" "));
754 current_kboard
->echo_string
755 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
761 /* Temporarily add a dash to the end of the echo string if it's not
762 empty, so that it serves as a mini-prompt for the very next character. */
767 /* Do nothing if not echoing at all. */
768 if (NILP (current_kboard
->echo_string
))
771 if (!current_kboard
->immediate_echo
772 && SCHARS (current_kboard
->echo_string
) == 0)
775 /* Do nothing if we just printed a prompt. */
776 if (current_kboard
->echo_after_prompt
777 == SCHARS (current_kboard
->echo_string
))
780 /* Do nothing if we have already put a dash at the end. */
781 if (SCHARS (current_kboard
->echo_string
) > 1)
783 Lisp_Object last_char
, prev_char
, idx
;
785 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
786 prev_char
= Faref (current_kboard
->echo_string
, idx
);
788 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
789 last_char
= Faref (current_kboard
->echo_string
, idx
);
791 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
795 /* Put a dash at the end of the buffer temporarily,
796 but make it go away when the next character is added. */
797 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
802 /* Display the current echo string, and begin echoing if not already
808 if (!current_kboard
->immediate_echo
)
811 current_kboard
->immediate_echo
= 1;
813 for (i
= 0; i
< this_command_key_count
; i
++)
817 /* Set before_command_echo_length to the value that would
818 have been saved before the start of this subcommand in
819 command_loop_1, if we had already been echoing then. */
820 if (i
== this_single_command_key_start
)
821 before_command_echo_length
= echo_length ();
823 c
= XVECTOR (this_command_keys
)->contents
[i
];
824 if (! (EVENT_HAS_PARAMETERS (c
)
825 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
829 /* Set before_command_echo_length to the value that would
830 have been saved before the start of this subcommand in
831 command_loop_1, if we had already been echoing then. */
832 if (this_command_key_count
== this_single_command_key_start
)
833 before_command_echo_length
= echo_length ();
835 /* Put a dash at the end to invite the user to type more. */
840 message3_nolog (current_kboard
->echo_string
,
841 SBYTES (current_kboard
->echo_string
),
842 STRING_MULTIBYTE (current_kboard
->echo_string
));
845 /* Record in what buffer we echoed, and from which kboard. */
846 echo_message_buffer
= echo_area_buffer
[0];
847 echo_kboard
= current_kboard
;
849 if (waiting_for_input
&& !NILP (Vquit_flag
))
850 quit_throw_to_read_char ();
853 /* Turn off echoing, for the start of a new command. */
858 current_kboard
->immediate_echo
= 0;
859 current_kboard
->echo_after_prompt
= -1;
860 current_kboard
->echo_string
= Qnil
;
861 ok_to_echo_at_next_pause
= NULL
;
863 echo_message_buffer
= Qnil
;
866 /* Return the length of the current echo string. */
871 return (STRINGP (current_kboard
->echo_string
)
872 ? SCHARS (current_kboard
->echo_string
)
876 /* Truncate the current echo message to its first LEN chars.
877 This and echo_char get used by read_key_sequence when the user
878 switches frames while entering a key sequence. */
881 echo_truncate (nchars
)
884 if (STRINGP (current_kboard
->echo_string
))
885 current_kboard
->echo_string
886 = Fsubstring (current_kboard
->echo_string
,
887 make_number (0), make_number (nchars
));
888 truncate_echo_area (nchars
);
892 /* Functions for manipulating this_command_keys. */
894 add_command_key (key
)
897 #if 0 /* Not needed after we made Freset_this_command_lengths
898 do the job immediately. */
899 /* If reset-this-command-length was called recently, obey it now.
900 See the doc string of that function for an explanation of why. */
901 if (before_command_restore_flag
)
903 this_command_key_count
= before_command_key_count_1
;
904 if (this_command_key_count
< this_single_command_key_start
)
905 this_single_command_key_start
= this_command_key_count
;
906 echo_truncate (before_command_echo_length_1
);
907 before_command_restore_flag
= 0;
911 if (this_command_key_count
>= ASIZE (this_command_keys
))
912 this_command_keys
= larger_vector (this_command_keys
,
913 2 * ASIZE (this_command_keys
),
916 ASET (this_command_keys
, this_command_key_count
, key
);
917 ++this_command_key_count
;
924 int count
= SPECPDL_INDEX ();
927 if (command_loop_level
> 0)
929 specbind (Qstandard_output
, Qt
);
930 specbind (Qstandard_input
, Qt
);
933 #ifdef HAVE_WINDOW_SYSTEM
934 /* The command loop has started an hourglass timer, so we have to
935 cancel it here, otherwise it will fire because the recursive edit
936 can take some time. Do not check for display_hourglass_p here,
937 because it could already be nil. */
941 /* This function may have been called from a debugger called from
942 within redisplay, for instance by Edebugging a function called
943 from fontification-functions. We want to allow redisplay in
944 the debugging session.
946 The recursive edit is left with a `(throw exit ...)'. The `exit'
947 tag is not caught anywhere in redisplay, i.e. when we leave the
948 recursive edit, the original redisplay leading to the recursive
949 edit will be unwound. The outcome should therefore be safe. */
950 specbind (Qinhibit_redisplay
, Qnil
);
953 val
= command_loop ();
955 Fsignal (Qquit
, Qnil
);
956 /* Handle throw from read_minibuf when using minibuffer
957 while it's active but we're in another window. */
959 xsignal1 (Qerror
, val
);
961 return unbind_to (count
, Qnil
);
964 /* When an auto-save happens, record the "time", and don't do again soon. */
969 last_auto_save
= num_nonmacro_input_events
;
972 /* Make an auto save happen as soon as possible at command level. */
975 force_auto_save_soon ()
977 last_auto_save
= - auto_save_interval
- 1;
979 record_asynch_buffer_change ();
982 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
983 doc
: /* Invoke the editor command loop recursively.
984 To get out of the recursive edit, a command can do `(throw 'exit nil)';
985 that tells this function to return.
986 Alternatively, `(throw 'exit t)' makes this function signal an error.
987 This function is called by the editor initialization to begin editing. */)
990 int count
= SPECPDL_INDEX ();
993 /* If we enter while input is blocked, don't lock up here.
994 This may happen through the debugger during redisplay. */
998 command_loop_level
++;
999 update_mode_lines
= 1;
1001 if (command_loop_level
1002 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1003 buffer
= Fcurrent_buffer ();
1007 /* If we leave recursive_edit_1 below with a `throw' for instance,
1008 like it is done in the splash screen display, we have to
1009 make sure that we restore single_kboard as command_loop_1
1010 would have done if it were left normally. */
1011 if (command_loop_level
> 0)
1012 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1013 record_unwind_protect (recursive_edit_unwind
, buffer
);
1015 recursive_edit_1 ();
1016 return unbind_to (count
, Qnil
);
1020 recursive_edit_unwind (buffer
)
1023 if (BUFFERP (buffer
))
1024 Fset_buffer (buffer
);
1026 command_loop_level
--;
1027 update_mode_lines
= 1;
1032 #if 0 /* These two functions are now replaced with
1033 temporarily_switch_to_single_kboard. */
1037 #if 0 /* Theory: if there's anything in Vunread_command_events,
1038 it will right away be read by read_key_sequence,
1039 and then if we do switch KBOARDS, it will go into the side
1040 queue then. So we don't need to do anything special here -- rms. */
1041 if (CONSP (Vunread_command_events
))
1043 current_kboard
->kbd_queue
1044 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1045 current_kboard
->kbd_queue_has_data
= 1;
1047 Vunread_command_events
= Qnil
;
1052 /* Switch to the single-kboard state, making current_kboard
1053 the only KBOARD from which further input is accepted. */
1056 single_kboard_state ()
1062 /* If we're in single_kboard state for kboard KBOARD,
1066 not_single_kboard_state (kboard
)
1069 if (kboard
== current_kboard
)
1073 /* Maintain a stack of kboards, so other parts of Emacs
1074 can switch temporarily to the kboard of a given frame
1075 and then revert to the previous status. */
1080 struct kboard_stack
*next
;
1083 static struct kboard_stack
*kboard_stack
;
1089 struct kboard_stack
*p
1090 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1092 p
->next
= kboard_stack
;
1093 p
->kboard
= current_kboard
;
1103 struct kboard_stack
*p
= kboard_stack
;
1105 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1107 if (t
->kboard
== p
->kboard
)
1109 current_kboard
= p
->kboard
;
1116 /* The terminal we remembered has been deleted. */
1117 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1120 kboard_stack
= p
->next
;
1124 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1125 from which further input is accepted. If F is non-nil, set its
1126 KBOARD as the current keyboard.
1128 This function uses record_unwind_protect to return to the previous
1131 If Emacs is already in single_kboard mode, and F's keyboard is
1132 locked, then this function will throw an errow. */
1135 temporarily_switch_to_single_kboard (f
)
1138 int was_locked
= single_kboard
;
1141 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1142 /* We can not switch keyboards while in single_kboard mode.
1143 In rare cases, Lisp code may call `recursive-edit' (or
1144 `read-minibuffer' or `y-or-n-p') after it switched to a
1145 locked frame. For example, this is likely to happen
1146 when server.el connects to a new terminal while Emacs is in
1147 single_kboard mode. It is best to throw an error instead
1148 of presenting the user with a frozen screen. */
1149 error ("Terminal %d is locked, cannot read from it",
1150 FRAME_TERMINAL (f
)->id
);
1152 /* This call is unnecessary, but helps
1153 `restore_kboard_configuration' discover if somebody changed
1154 `current_kboard' behind our back. */
1155 push_kboard (current_kboard
);
1158 current_kboard
= FRAME_KBOARD (f
);
1160 record_unwind_protect (restore_kboard_configuration
,
1161 (was_locked
? Qt
: Qnil
));
1164 #if 0 /* This function is not needed anymore. */
1166 record_single_kboard_state ()
1169 push_kboard (current_kboard
);
1170 record_unwind_protect (restore_kboard_configuration
,
1171 (single_kboard
? Qt
: Qnil
));
1176 restore_kboard_configuration (was_locked
)
1177 Lisp_Object was_locked
;
1179 if (NILP (was_locked
))
1183 struct kboard
*prev
= current_kboard
;
1186 /* The pop should not change the kboard. */
1187 if (single_kboard
&& current_kboard
!= prev
)
1194 /* Handle errors that are not handled at inner levels
1195 by printing an error message and returning to the editor command loop. */
1201 Lisp_Object old_level
, old_length
;
1202 char macroerror
[50];
1204 #ifdef HAVE_WINDOW_SYSTEM
1205 if (display_hourglass_p
)
1206 cancel_hourglass ();
1209 if (!NILP (executing_kbd_macro
))
1211 if (executing_kbd_macro_iterations
== 1)
1212 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1214 sprintf (macroerror
, "After %d kbd macro iterations: ",
1215 executing_kbd_macro_iterations
);
1220 Vstandard_output
= Qt
;
1221 Vstandard_input
= Qt
;
1222 Vexecuting_kbd_macro
= Qnil
;
1223 executing_kbd_macro
= Qnil
;
1224 current_kboard
->Vprefix_arg
= Qnil
;
1225 current_kboard
->Vlast_prefix_arg
= Qnil
;
1228 /* Avoid unquittable loop if data contains a circular list. */
1229 old_level
= Vprint_level
;
1230 old_length
= Vprint_length
;
1231 XSETFASTINT (Vprint_level
, 10);
1232 XSETFASTINT (Vprint_length
, 10);
1233 cmd_error_internal (data
, macroerror
);
1234 Vprint_level
= old_level
;
1235 Vprint_length
= old_length
;
1239 Vinhibit_quit
= Qnil
;
1240 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1241 if (command_loop_level
== 0 && minibuf_level
== 0)
1242 any_kboard_state ();
1245 return make_number (0);
1248 /* Take actions on handling an error. DATA is the data that describes
1251 CONTEXT is a C-string containing ASCII characters only which
1252 describes the context in which the error happened. If we need to
1253 generalize CONTEXT to allow multibyte characters, make it a Lisp
1257 cmd_error_internal (data
, context
)
1261 struct frame
*sf
= SELECTED_FRAME ();
1263 /* The immediate context is not interesting for Quits,
1264 since they are asyncronous. */
1265 if (EQ (XCAR (data
), Qquit
))
1266 Vsignaling_function
= Qnil
;
1271 /* Use user's specified output function if any. */
1272 if (!NILP (Vcommand_error_function
))
1273 call3 (Vcommand_error_function
, data
,
1274 context
? build_string (context
) : empty_unibyte_string
,
1275 Vsignaling_function
);
1276 /* If the window system or terminal frame hasn't been initialized
1277 yet, or we're not interactive, write the message to stderr and exit. */
1278 else if (!sf
->glyphs_initialized_p
1279 /* The initial frame is a special non-displaying frame. It
1280 will be current in daemon mode when there are no frames
1281 to display, and in non-daemon mode before the real frame
1282 has finished initializing. If an error is thrown in the
1283 latter case while creating the frame, then the frame
1284 will never be displayed, so the safest thing to do is
1285 write to stderr and quit. In daemon mode, there are
1286 many other potential errors that do not prevent frames
1287 from being created, so continuing as normal is better in
1289 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1292 print_error_message (data
, Qexternal_debugging_output
,
1293 context
, Vsignaling_function
);
1294 Fterpri (Qexternal_debugging_output
);
1295 Fkill_emacs (make_number (-1));
1299 clear_message (1, 0);
1301 message_log_maybe_newline ();
1304 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1307 Vsignaling_function
= Qnil
;
1310 Lisp_Object
command_loop_1 ();
1311 Lisp_Object
command_loop_2 ();
1312 Lisp_Object
top_level_1 ();
1314 /* Entry to editor-command-loop.
1315 This level has the catches for exiting/returning to editor command loop.
1316 It returns nil to exit recursive edit, t to abort it. */
1321 if (command_loop_level
> 0 || minibuf_level
> 0)
1324 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1325 executing_kbd_macro
= Qnil
;
1331 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1332 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1333 /* Reset single_kboard in case top-level set it while
1334 evaluating an -f option, or we are stuck there for some
1336 any_kboard_state ();
1338 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1339 executing_kbd_macro
= Qnil
;
1341 /* End of file in -batch run causes exit here. */
1347 /* Here we catch errors in execution of commands within the
1348 editing loop, and reenter the editing loop.
1349 When there is an error, cmd_error runs and returns a non-nil
1350 value to us. A value of nil means that command_loop_1 itself
1351 returned due to end of file (or end of kbd macro). */
1356 register Lisp_Object val
;
1359 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1360 while (!NILP (val
));
1368 return Feval (Vtop_level
);
1374 /* On entry to the outer level, run the startup file */
1375 if (!NILP (Vtop_level
))
1376 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1377 else if (!NILP (Vpurify_flag
))
1378 message ("Bare impure Emacs (standard Lisp code not loaded)");
1380 message ("Bare Emacs (standard Lisp code not loaded)");
1384 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1385 doc
: /* Exit all recursive editing levels.
1386 This also exits all active minibuffers. */)
1389 #ifdef HAVE_WINDOW_SYSTEM
1390 if (display_hourglass_p
)
1391 cancel_hourglass ();
1394 /* Unblock input if we enter with input blocked. This may happen if
1395 redisplay traps e.g. during tool-bar update with input blocked. */
1396 while (INPUT_BLOCKED_P
)
1399 return Fthrow (Qtop_level
, Qnil
);
1402 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1403 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1406 if (command_loop_level
> 0 || minibuf_level
> 0)
1407 Fthrow (Qexit
, Qnil
);
1409 error ("No recursive edit is in progress");
1413 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1414 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1417 if (command_loop_level
> 0 || minibuf_level
> 0)
1420 error ("No recursive edit is in progress");
1424 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1426 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1427 of this function. */
1430 tracking_off (old_value
)
1431 Lisp_Object old_value
;
1433 do_mouse_tracking
= old_value
;
1434 if (NILP (old_value
))
1436 /* Redisplay may have been preempted because there was input
1437 available, and it assumes it will be called again after the
1438 input has been processed. If the only input available was
1439 the sort that we have just disabled, then we need to call
1441 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1443 redisplay_preserve_echo_area (6);
1444 get_input_pending (&input_pending
,
1445 READABLE_EVENTS_DO_TIMERS_NOW
);
1451 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1452 doc
: /* Evaluate BODY with mouse movement events enabled.
1453 Within a `track-mouse' form, mouse motion generates input events that
1454 you can read with `read-event'.
1455 Normally, mouse motion is ignored.
1456 usage: (track-mouse BODY...) */)
1460 int count
= SPECPDL_INDEX ();
1463 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1465 do_mouse_tracking
= Qt
;
1467 val
= Fprogn (args
);
1468 return unbind_to (count
, val
);
1471 /* If mouse has moved on some frame, return one of those frames.
1475 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1476 after resizing the tool-bar window. */
1478 int ignore_mouse_drag_p
;
1483 Lisp_Object tail
, frame
;
1485 if (ignore_mouse_drag_p
)
1487 /* ignore_mouse_drag_p = 0; */
1491 FOR_EACH_FRAME (tail
, frame
)
1493 if (XFRAME (frame
)->mouse_moved
)
1494 return XFRAME (frame
);
1500 #endif /* HAVE_MOUSE || HAVE_GPM */
1502 /* This is the actual command reading loop,
1503 sans error-handling encapsulation. */
1505 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1507 void safe_run_hooks
P_ ((Lisp_Object
));
1508 static void adjust_point_for_property
P_ ((int, int));
1510 /* Cancel hourglass from protect_unwind.
1512 #ifdef HAVE_WINDOW_SYSTEM
1514 cancel_hourglass_unwind (arg
)
1517 cancel_hourglass ();
1528 Lisp_Object keybuf
[30];
1530 int prev_modiff
= 0;
1531 struct buffer
*prev_buffer
= NULL
;
1532 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1533 int was_locked
= single_kboard
;
1535 int already_adjusted
= 0;
1537 current_kboard
->Vprefix_arg
= Qnil
;
1538 current_kboard
->Vlast_prefix_arg
= Qnil
;
1539 Vdeactivate_mark
= Qnil
;
1540 waiting_for_input
= 0;
1544 this_command_key_count
= 0;
1545 this_command_key_count_reset
= 0;
1546 this_single_command_key_start
= 0;
1548 if (NILP (Vmemory_full
))
1550 /* Make sure this hook runs after commands that get errors and
1551 throw to top level. */
1552 /* Note that the value cell will never directly contain nil
1553 if the symbol is a local variable. */
1554 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1555 safe_run_hooks (Qpost_command_hook
);
1557 /* If displaying a message, resize the echo area window to fit
1558 that message's size exactly. */
1559 if (!NILP (echo_area_buffer
[0]))
1560 resize_echo_area_exactly ();
1562 if (!NILP (Vdeferred_action_list
))
1563 safe_run_hooks (Qdeferred_action_function
);
1566 /* Do this after running Vpost_command_hook, for consistency. */
1567 current_kboard
->Vlast_command
= Vthis_command
;
1568 current_kboard
->Vreal_last_command
= real_this_command
;
1569 if (!CONSP (last_command_event
))
1570 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1574 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1577 /* Make sure the current window's buffer is selected. */
1578 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1579 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1581 /* Display any malloc warning that just came out. Use while because
1582 displaying one warning can cause another. */
1584 while (pending_malloc_warning
)
1585 display_malloc_warning ();
1587 Vdeactivate_mark
= Qnil
;
1589 /* If minibuffer on and echo area in use,
1590 wait a short time and redraw minibuffer. */
1593 && !NILP (echo_area_buffer
[0])
1594 && EQ (minibuf_window
, echo_area_window
)
1595 && NUMBERP (Vminibuffer_message_timeout
))
1597 /* Bind inhibit-quit to t so that C-g gets read in
1598 rather than quitting back to the minibuffer. */
1599 int count
= SPECPDL_INDEX ();
1600 specbind (Qinhibit_quit
, Qt
);
1602 sit_for (Vminibuffer_message_timeout
, 0, 2);
1604 /* Clear the echo area. */
1606 safe_run_hooks (Qecho_area_clear_hook
);
1608 unbind_to (count
, Qnil
);
1610 /* If a C-g came in before, treat it as input now. */
1611 if (!NILP (Vquit_flag
))
1614 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1619 /* Select the frame that the last event came from. Usually,
1620 switch-frame events will take care of this, but if some lisp
1621 code swallows a switch-frame event, we'll fix things up here.
1622 Is this a good idea? */
1623 if (FRAMEP (internal_last_event_frame
)
1624 && !EQ (internal_last_event_frame
, selected_frame
))
1625 Fselect_frame (internal_last_event_frame
, Qnil
);
1627 /* If it has changed current-menubar from previous value,
1628 really recompute the menubar from the value. */
1629 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1630 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1631 call0 (Qrecompute_lucid_menubar
);
1633 before_command_key_count
= this_command_key_count
;
1634 before_command_echo_length
= echo_length ();
1636 Vthis_command
= Qnil
;
1637 real_this_command
= Qnil
;
1638 Vthis_original_command
= Qnil
;
1639 Vthis_command_keys_shift_translated
= Qnil
;
1641 /* Read next key sequence; i gets its length. */
1642 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1645 /* A filter may have run while we were reading the input. */
1646 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1648 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1649 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1653 /* Now we have read a key sequence of length I,
1654 or else I is 0 and we found end of file. */
1656 if (i
== 0) /* End of file -- happens only in */
1657 return Qnil
; /* a kbd macro, at the end. */
1658 /* -1 means read_key_sequence got a menu that was rejected.
1659 Just loop around and read another command. */
1663 this_command_key_count
= 0;
1664 this_command_key_count_reset
= 0;
1665 this_single_command_key_start
= 0;
1669 last_command_event
= keybuf
[i
- 1];
1671 /* If the previous command tried to force a specific window-start,
1672 forget about that, in case this command moves point far away
1673 from that position. But also throw away beg_unchanged and
1674 end_unchanged information in that case, so that redisplay will
1675 update the whole window properly. */
1676 if (!NILP (XWINDOW (selected_window
)->force_start
))
1679 XWINDOW (selected_window
)->force_start
= Qnil
;
1680 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1681 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1684 cmd
= read_key_sequence_cmd
;
1685 if (!NILP (Vexecuting_kbd_macro
))
1687 if (!NILP (Vquit_flag
))
1689 Vexecuting_kbd_macro
= Qt
;
1690 QUIT
; /* Make some noise. */
1691 /* Will return since macro now empty. */
1695 /* Do redisplay processing after this command except in special
1696 cases identified below. */
1697 prev_buffer
= current_buffer
;
1698 prev_modiff
= MODIFF
;
1699 last_point_position
= PT
;
1700 last_point_position_window
= selected_window
;
1701 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1703 /* By default, we adjust point to a boundary of a region that
1704 has such a property that should be treated intangible
1705 (e.g. composition, display). But, some commands will set
1706 this variable differently. */
1707 Vdisable_point_adjustment
= Qnil
;
1709 /* Process filters and timers may have messed with deactivate-mark.
1710 reset it before we execute the command. */
1711 Vdeactivate_mark
= Qnil
;
1713 /* Remap command through active keymaps */
1714 Vthis_original_command
= cmd
;
1718 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1722 /* Execute the command. */
1724 Vthis_command
= cmd
;
1725 real_this_command
= cmd
;
1726 /* Note that the value cell will never directly contain nil
1727 if the symbol is a local variable. */
1728 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1729 safe_run_hooks (Qpre_command_hook
);
1731 already_adjusted
= 0;
1733 if (NILP (Vthis_command
))
1735 /* nil means key is undefined. */
1736 Lisp_Object keys
= Fvector (i
, keybuf
);
1737 keys
= Fkey_description (keys
, Qnil
);
1739 message_with_string ("%s is undefined", keys
, 0);
1740 current_kboard
->defining_kbd_macro
= Qnil
;
1741 update_mode_lines
= 1;
1742 current_kboard
->Vprefix_arg
= Qnil
;
1746 if (NILP (current_kboard
->Vprefix_arg
))
1748 /* In case we jump to directly_done. */
1749 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1751 /* Recognize some common commands in common situations and
1752 do them directly. */
1753 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1754 && NILP (Vthis_command_keys_shift_translated
)
1755 && !CONSP (Vtransient_mark_mode
))
1757 struct Lisp_Char_Table
*dp
1758 = window_display_table (XWINDOW (selected_window
));
1759 lose
= FETCH_CHAR (PT_BYTE
);
1761 if (! NILP (Vpost_command_hook
))
1762 /* Put this before calling adjust_point_for_property
1763 so it will only get called once in any case. */
1765 if (current_buffer
== prev_buffer
1766 && last_point_position
!= PT
1767 && NILP (Vdisable_point_adjustment
)
1768 && NILP (Vglobal_disable_point_adjustment
))
1769 adjust_point_for_property (last_point_position
, 0);
1770 already_adjusted
= 1;
1771 if (PT
== last_point_position
+ 1
1773 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1774 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1775 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1776 && (lose
>= 0x20 && lose
< 0x7f)))
1777 : (lose
>= 0x20 && lose
< 0x7f))
1778 /* To extract the case of continuation on
1779 wide-column characters. */
1780 && ASCII_BYTE_P (lose
)
1781 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1783 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1785 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1787 && !windows_or_buffers_changed
1788 && EQ (current_buffer
->selective_display
, Qnil
)
1789 && !detect_input_pending ()
1790 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1791 && NILP (Vexecuting_kbd_macro
))
1792 direct_output_forward_char (1);
1795 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1796 && NILP (Vthis_command_keys_shift_translated
)
1797 && !CONSP (Vtransient_mark_mode
))
1799 struct Lisp_Char_Table
*dp
1800 = window_display_table (XWINDOW (selected_window
));
1802 lose
= FETCH_CHAR (PT_BYTE
);
1803 if (! NILP (Vpost_command_hook
))
1805 if (current_buffer
== prev_buffer
1806 && last_point_position
!= PT
1807 && NILP (Vdisable_point_adjustment
)
1808 && NILP (Vglobal_disable_point_adjustment
))
1809 adjust_point_for_property (last_point_position
, 0);
1810 already_adjusted
= 1;
1811 if (PT
== last_point_position
- 1
1813 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1814 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1815 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1816 && (lose
>= 0x20 && lose
< 0x7f)))
1817 : (lose
>= 0x20 && lose
< 0x7f))
1818 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1820 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1822 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1824 && !windows_or_buffers_changed
1825 && EQ (current_buffer
->selective_display
, Qnil
)
1826 && !detect_input_pending ()
1827 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1828 && NILP (Vexecuting_kbd_macro
))
1829 direct_output_forward_char (-1);
1832 else if (EQ (Vthis_command
, Qself_insert_command
)
1833 /* Try this optimization only on char keystrokes. */
1834 && NATNUMP (last_command_event
)
1835 && CHAR_VALID_P (XFASTINT (last_command_event
), 0))
1838 = translate_char (Vtranslation_table_for_input
,
1839 XFASTINT (last_command_event
));
1841 if (NILP (Vexecuting_kbd_macro
)
1842 && !EQ (minibuf_window
, selected_window
))
1844 if (!nonundocount
|| nonundocount
>= 20)
1852 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1854 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1856 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1858 || MODIFF
<= SAVE_MODIFF
1859 || windows_or_buffers_changed
1860 || !EQ (current_buffer
->selective_display
, Qnil
)
1861 || detect_input_pending ()
1862 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1863 || !NILP (Vexecuting_kbd_macro
));
1865 value
= internal_self_insert (c
, 0);
1870 if (! NILP (Vpost_command_hook
))
1871 /* Put this before calling adjust_point_for_property
1872 so it will only get called once in any case. */
1875 /* VALUE == 1 when AFTER-CHANGE functions are
1876 installed which is the case most of the time
1877 because FONT-LOCK installs one. */
1878 if (!lose
&& !value
)
1879 direct_output_for_insert (c
);
1884 /* Here for a command that isn't executed directly */
1887 #ifdef HAVE_WINDOW_SYSTEM
1888 int scount
= SPECPDL_INDEX ();
1890 if (display_hourglass_p
1891 && NILP (Vexecuting_kbd_macro
))
1893 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1899 if (NILP (current_kboard
->Vprefix_arg
))
1901 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1903 #ifdef HAVE_WINDOW_SYSTEM
1904 /* Do not check display_hourglass_p here, because
1905 Fcommand_execute could change it, but we should cancel
1906 hourglass cursor anyway.
1907 But don't cancel the hourglass within a macro
1908 just because a command in the macro finishes. */
1909 if (NILP (Vexecuting_kbd_macro
))
1910 unbind_to (scount
, Qnil
);
1915 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1917 /* Note that the value cell will never directly contain nil
1918 if the symbol is a local variable. */
1919 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1920 safe_run_hooks (Qpost_command_hook
);
1922 /* If displaying a message, resize the echo area window to fit
1923 that message's size exactly. */
1924 if (!NILP (echo_area_buffer
[0]))
1925 resize_echo_area_exactly ();
1927 if (!NILP (Vdeferred_action_list
))
1928 safe_run_hooks (Qdeferred_action_function
);
1930 /* If there is a prefix argument,
1931 1) We don't want Vlast_command to be ``universal-argument''
1932 (that would be dumb), so don't set Vlast_command,
1933 2) we want to leave echoing on so that the prefix will be
1934 echoed as part of this key sequence, so don't call
1936 3) we want to leave this_command_key_count non-zero, so that
1937 read_char will realize that it is re-reading a character, and
1938 not echo it a second time.
1940 If the command didn't actually create a prefix arg,
1941 but is merely a frame event that is transparent to prefix args,
1942 then the above doesn't apply. */
1943 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1945 current_kboard
->Vlast_command
= Vthis_command
;
1946 current_kboard
->Vreal_last_command
= real_this_command
;
1947 if (!CONSP (last_command_event
))
1948 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1950 this_command_key_count
= 0;
1951 this_command_key_count_reset
= 0;
1952 this_single_command_key_start
= 0;
1955 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1957 /* In Emacs 22, setting transient-mark-mode to `only' was a
1958 way of turning it on for just one command. This usage is
1959 obsolete, but support it anyway. */
1960 if (EQ (Vtransient_mark_mode
, Qidentity
))
1961 Vtransient_mark_mode
= Qnil
;
1962 else if (EQ (Vtransient_mark_mode
, Qonly
))
1963 Vtransient_mark_mode
= Qidentity
;
1965 if (!NILP (Vdeactivate_mark
))
1966 call0 (Qdeactivate_mark
);
1967 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1968 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1973 if (current_buffer
== prev_buffer
1974 && last_point_position
!= PT
1975 && NILP (Vdisable_point_adjustment
)
1976 && NILP (Vglobal_disable_point_adjustment
)
1977 && !already_adjusted
)
1978 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1980 /* Install chars successfully executed in kbd macro. */
1982 if (!NILP (current_kboard
->defining_kbd_macro
)
1983 && NILP (current_kboard
->Vprefix_arg
))
1984 finalize_kbd_macro_chars ();
1985 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1987 any_kboard_state ();
1992 extern Lisp_Object Qcomposition
, Qdisplay
;
1994 /* Adjust point to a boundary of a region that has such a property
1995 that should be treated intangible. For the moment, we check
1996 `composition', `display' and `invisible' properties.
1997 LAST_PT is the last position of point. */
1999 extern Lisp_Object Qafter_string
, Qbefore_string
;
2000 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2003 adjust_point_for_property (last_pt
, modified
)
2008 Lisp_Object val
, overlay
, tmp
;
2009 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2012 /* FIXME: cycling is probably not necessary because these properties
2013 can't be usefully combined anyway. */
2014 while (check_composition
|| check_display
|| check_invisible
)
2016 /* FIXME: check `intangible'. */
2017 if (check_composition
2018 && PT
> BEGV
&& PT
< ZV
2019 && (beg
= composition_adjust_point (last_pt
)) != PT
)
2022 check_display
= check_invisible
= 1;
2024 check_composition
= 0;
2026 && PT
> BEGV
&& PT
< ZV
2027 && !NILP (val
= get_char_property_and_overlay
2028 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2029 && display_prop_intangible_p (val
)
2030 && (!OVERLAYP (overlay
)
2031 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2032 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2033 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2034 && (beg
< PT
/* && end > PT <- It's always the case. */
2035 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2038 SET_PT (PT
< last_pt
2039 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2041 check_composition
= check_invisible
= 1;
2044 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2046 int inv
, ellipsis
= 0;
2049 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2052 /* FIXME: We should stop if we find a spot between
2053 two runs of `invisible' where inserted text would
2054 be visible. This is important when we have two
2055 invisible boundaries that enclose an area: if the
2056 area is empty, we need this test in order to make
2057 it possible to place point in the middle rather
2058 than skip both boundaries. However, this code
2059 also stops anywhere in a non-sticky text-property,
2060 which breaks (e.g.) Org mode. */
2061 && (val
= get_pos_property (make_number (end
),
2063 TEXT_PROP_MEANS_INVISIBLE (val
))
2065 && !NILP (val
= get_char_property_and_overlay
2066 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2067 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2069 ellipsis
= ellipsis
|| inv
> 1
2070 || (OVERLAYP (overlay
)
2071 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2072 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2073 tmp
= Fnext_single_char_property_change
2074 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2075 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2079 && (val
= get_pos_property (make_number (beg
),
2081 TEXT_PROP_MEANS_INVISIBLE (val
))
2083 && !NILP (val
= get_char_property_and_overlay
2084 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2085 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2087 ellipsis
= ellipsis
|| inv
> 1
2088 || (OVERLAYP (overlay
)
2089 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2090 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2091 tmp
= Fprevious_single_char_property_change
2092 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2093 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2096 /* Move away from the inside area. */
2097 if (beg
< PT
&& end
> PT
)
2099 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2100 /* We haven't moved yet (so we don't need to fear
2101 infinite-looping) and we were outside the range
2102 before (so either end of the range still corresponds
2103 to a move in the right direction): pretend we moved
2104 less than we actually did, so that we still have
2105 more freedom below in choosing which end of the range
2107 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2108 /* We either have moved already or the last point
2109 was already in the range: we don't get to choose
2110 which end of the range we have to go to. */
2111 : (PT
< last_pt
? beg
: end
));
2112 check_composition
= check_display
= 1;
2114 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2115 the point to something other than its argument, due to
2116 point-motion hooks, intangibility, etc. */
2117 xassert (PT
== beg
|| PT
== end
);
2120 /* Pretend the area doesn't exist if the buffer is not
2122 if (!modified
&& !ellipsis
&& beg
< end
)
2124 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2125 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2126 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2127 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2128 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2129 /* We've already moved as far as we can. Trying to go
2130 to the other end would mean moving backwards and thus
2131 could lead to an infinite loop. */
2133 else if (val
= get_pos_property (make_number (PT
),
2135 TEXT_PROP_MEANS_INVISIBLE (val
)
2136 && (val
= get_pos_property
2137 (make_number (PT
== beg
? end
: beg
),
2139 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2140 (check_composition
= check_display
= 1,
2141 SET_PT (PT
== beg
? end
: beg
));
2144 check_invisible
= 0;
2148 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2151 safe_run_hooks_1 (hook
)
2154 if (NILP (Vrun_hooks
))
2156 return call1 (Vrun_hooks
, Vinhibit_quit
);
2159 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2162 safe_run_hooks_error (data
)
2165 Lisp_Object args
[3];
2166 args
[0] = build_string ("Error in %s: %s");
2167 args
[1] = Vinhibit_quit
;
2170 return Fset (Vinhibit_quit
, Qnil
);
2173 /* If we get an error while running the hook, cause the hook variable
2174 to be nil. Also inhibit quits, so that C-g won't cause the hook
2175 to mysteriously evaporate. */
2178 safe_run_hooks (hook
)
2181 int count
= SPECPDL_INDEX ();
2182 specbind (Qinhibit_quit
, hook
);
2184 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2186 unbind_to (count
, Qnil
);
2190 /* Number of seconds between polling for input. This is a Lisp
2191 variable that can be bound. */
2193 EMACS_INT polling_period
;
2195 /* Nonzero means polling for input is temporarily suppressed. */
2197 int poll_suppress_count
;
2199 /* Asynchronous timer for polling. */
2201 struct atimer
*poll_timer
;
2204 #ifdef POLL_FOR_INPUT
2206 /* Poll for input, so that we catch a C-g if it comes in. This
2207 function is called from x_make_frame_visible, see comment
2213 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2214 doing anything dangerous. */
2218 if (interrupt_input_blocked
== 0
2219 && !waiting_for_input
)
2220 read_avail_input (0);
2226 /* Timer callback function for poll_timer. TIMER is equal to
2230 poll_for_input (timer
)
2231 struct atimer
*timer
;
2233 if (poll_suppress_count
== 0)
2236 interrupt_input_pending
= 1;
2237 pending_signals
= 1;
2239 poll_for_input_1 ();
2244 #endif /* POLL_FOR_INPUT */
2246 /* Begin signals to poll for input, if they are appropriate.
2247 This function is called unconditionally from various places. */
2252 #ifdef POLL_FOR_INPUT
2253 /* XXX This condition was (read_socket_hook && !interrupt_input),
2254 but read_socket_hook is not global anymore. Let's pretend that
2256 if (!interrupt_input
)
2258 /* Turn alarm handling on unconditionally. It might have
2259 been turned off in process.c. */
2260 turn_on_atimers (1);
2262 /* If poll timer doesn't exist, are we need one with
2263 a different interval, start a new one. */
2264 if (poll_timer
== NULL
2265 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2267 EMACS_TIME interval
;
2270 cancel_atimer (poll_timer
);
2272 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2273 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2274 poll_for_input
, NULL
);
2277 /* Let the timer's callback function poll for input
2278 if this becomes zero. */
2279 --poll_suppress_count
;
2284 /* Nonzero if we are using polling to handle input asynchronously. */
2287 input_polling_used ()
2289 #ifdef POLL_FOR_INPUT
2290 /* XXX This condition was (read_socket_hook && !interrupt_input),
2291 but read_socket_hook is not global anymore. Let's pretend that
2293 return !interrupt_input
;
2299 /* Turn off polling. */
2304 #ifdef POLL_FOR_INPUT
2305 /* XXX This condition was (read_socket_hook && !interrupt_input),
2306 but read_socket_hook is not global anymore. Let's pretend that
2308 if (!interrupt_input
)
2309 ++poll_suppress_count
;
2313 /* Set the value of poll_suppress_count to COUNT
2314 and start or stop polling accordingly. */
2317 set_poll_suppress_count (count
)
2320 #ifdef POLL_FOR_INPUT
2321 if (count
== 0 && poll_suppress_count
!= 0)
2323 poll_suppress_count
= 1;
2326 else if (count
!= 0 && poll_suppress_count
== 0)
2330 poll_suppress_count
= count
;
2334 /* Bind polling_period to a value at least N.
2335 But don't decrease it. */
2338 bind_polling_period (n
)
2341 #ifdef POLL_FOR_INPUT
2342 int new = polling_period
;
2347 stop_other_atimers (poll_timer
);
2349 specbind (Qpolling_period
, make_number (new));
2350 /* Start a new alarm with the new period. */
2355 /* Apply the control modifier to CHARACTER. */
2361 /* Save the upper bits here. */
2362 int upper
= c
& ~0177;
2364 if (! ASCII_BYTE_P (c
))
2365 return c
|= ctrl_modifier
;
2369 /* Everything in the columns containing the upper-case letters
2370 denotes a control character. */
2371 if (c
>= 0100 && c
< 0140)
2375 /* Set the shift modifier for a control char
2376 made from a shifted letter. But only for letters! */
2377 if (oc
>= 'A' && oc
<= 'Z')
2378 c
|= shift_modifier
;
2381 /* The lower-case letters denote control characters too. */
2382 else if (c
>= 'a' && c
<= 'z')
2385 /* Include the bits for control and shift
2386 only if the basic ASCII code can't indicate them. */
2390 /* Replace the high bits. */
2391 c
|= (upper
& ~ctrl_modifier
);
2396 /* Display the help-echo property of the character after the mouse pointer.
2397 Either show it in the echo area, or call show-help-function to display
2398 it by other means (maybe in a tooltip).
2400 If HELP is nil, that means clear the previous help echo.
2402 If HELP is a string, display that string. If HELP is a function,
2403 call it with OBJECT and POS as arguments; the function should
2404 return a help string or nil for none. For all other types of HELP,
2405 evaluate it to obtain a string.
2407 WINDOW is the window in which the help was generated, if any.
2408 It is nil if not in a window.
2410 If OBJECT is a buffer, POS is the position in the buffer where the
2411 `help-echo' text property was found.
2413 If OBJECT is an overlay, that overlay has a `help-echo' property,
2414 and POS is the position in the overlay's buffer under the mouse.
2416 If OBJECT is a string (an overlay string or a string displayed with
2417 the `display' property). POS is the position in that string under
2420 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2421 echo overwrites a keystroke echo currently displayed in the echo
2424 Note: this function may only be called with HELP nil or a string
2425 from X code running asynchronously. */
2428 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2429 Lisp_Object help
, window
, object
, pos
;
2430 int ok_to_overwrite_keystroke_echo
;
2432 if (!NILP (help
) && !STRINGP (help
))
2434 if (FUNCTIONP (help
))
2436 Lisp_Object args
[4];
2441 help
= safe_call (4, args
);
2444 help
= safe_eval (help
);
2446 if (!STRINGP (help
))
2450 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2451 if (!noninteractive
&& STRINGP (help
))
2453 /* The mouse-fixup-help-message Lisp function can call
2454 mouse_position_hook, which resets the mouse_moved flags.
2455 This causes trouble if we are trying to read a mouse motion
2456 event (i.e., if we are inside a `track-mouse' form), so we
2457 restore the mouse_moved flag. */
2458 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2459 help
= call1 (Qmouse_fixup_help_message
, help
);
2465 if (STRINGP (help
) || NILP (help
))
2467 if (!NILP (Vshow_help_function
))
2468 call1 (Vshow_help_function
, help
);
2469 help_echo_showing_p
= STRINGP (help
);
2475 /* Input of single characters from keyboard */
2477 Lisp_Object
print_help ();
2478 static Lisp_Object
kbd_buffer_get_event ();
2479 static void record_char ();
2481 static Lisp_Object help_form_saved_window_configs
;
2483 read_char_help_form_unwind (Lisp_Object arg
)
2485 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2486 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2487 if (!NILP (window_config
))
2488 Fset_window_configuration (window_config
);
2492 #define STOP_POLLING \
2493 do { if (! polling_stopped_here) stop_polling (); \
2494 polling_stopped_here = 1; } while (0)
2496 #define RESUME_POLLING \
2497 do { if (polling_stopped_here) start_polling (); \
2498 polling_stopped_here = 0; } while (0)
2500 /* read a character from the keyboard; call the redisplay if needed */
2501 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2502 -1 means do not do redisplay, but do do autosaving.
2505 /* The arguments MAPS and NMAPS are for menu prompting.
2506 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2508 PREV_EVENT is the previous input event, or nil if we are reading
2509 the first event of a key sequence (or not reading a key sequence).
2510 If PREV_EVENT is t, that is a "magic" value that says
2511 not to run input methods, but in other respects to act as if
2512 not reading a key sequence.
2514 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2515 if we used a mouse menu to read the input, or zero otherwise. If
2516 USED_MOUSE_MENU is null, we don't dereference it.
2518 Value is -2 when we find input on another keyboard. A second call
2519 to read_char will read it.
2521 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2522 specifying the maximum time to wait until. If no input arrives by
2523 that time, stop waiting and return nil.
2525 Value is t if we showed a menu and the user rejected it. */
2528 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2532 Lisp_Object prev_event
;
2533 int *used_mouse_menu
;
2534 EMACS_TIME
*end_time
;
2536 volatile Lisp_Object c
;
2537 int count
, jmpcount
;
2538 jmp_buf local_getcjmp
;
2540 volatile int key_already_recorded
= 0;
2541 Lisp_Object tem
, save
;
2542 volatile Lisp_Object previous_echo_area_message
;
2543 volatile Lisp_Object also_record
;
2544 volatile int reread
;
2545 struct gcpro gcpro1
, gcpro2
;
2546 int polling_stopped_here
= 0;
2547 struct kboard
*orig_kboard
= current_kboard
;
2551 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2552 before_command_key_count
= this_command_key_count
;
2553 before_command_echo_length
= echo_length ();
2556 previous_echo_area_message
= Qnil
;
2558 GCPRO2 (c
, previous_echo_area_message
);
2563 if (CONSP (Vunread_post_input_method_events
))
2565 c
= XCAR (Vunread_post_input_method_events
);
2566 Vunread_post_input_method_events
2567 = XCDR (Vunread_post_input_method_events
);
2569 /* Undo what read_char_x_menu_prompt did when it unread
2570 additional keys returned by Fx_popup_menu. */
2572 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2580 if (unread_command_char
!= -1)
2582 XSETINT (c
, unread_command_char
);
2583 unread_command_char
= -1;
2589 if (CONSP (Vunread_command_events
))
2591 int was_disabled
= 0;
2593 c
= XCAR (Vunread_command_events
);
2594 Vunread_command_events
= XCDR (Vunread_command_events
);
2598 /* Undo what sit-for did when it unread additional keys
2599 inside universal-argument. */
2602 && EQ (XCAR (c
), Qt
))
2608 /* Undo what read_char_x_menu_prompt did when it unread
2609 additional keys returned by Fx_popup_menu. */
2611 && EQ (XCDR (c
), Qdisabled
)
2612 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2618 /* If the queued event is something that used the mouse,
2619 set used_mouse_menu accordingly. */
2621 /* Also check was_disabled so last-nonmenu-event won't return
2622 a bad value when submenus are involved. (Bug#447) */
2623 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2624 *used_mouse_menu
= 1;
2626 goto reread_for_input_method
;
2629 if (CONSP (Vunread_input_method_events
))
2631 c
= XCAR (Vunread_input_method_events
);
2632 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2634 /* Undo what read_char_x_menu_prompt did when it unread
2635 additional keys returned by Fx_popup_menu. */
2637 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2641 goto reread_for_input_method
;
2644 this_command_key_count_reset
= 0;
2646 if (!NILP (Vexecuting_kbd_macro
))
2648 /* We set this to Qmacro; since that's not a frame, nobody will
2649 try to switch frames on us, and the selected window will
2652 Since this event came from a macro, it would be misleading to
2653 leave internal_last_event_frame set to wherever the last
2654 real event came from. Normally, a switch-frame event selects
2655 internal_last_event_frame after each command is read, but
2656 events read from a macro should never cause a new frame to be
2658 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2660 /* Exit the macro if we are at the end.
2661 Also, some things replace the macro with t
2662 to force an early exit. */
2663 if (EQ (Vexecuting_kbd_macro
, Qt
)
2664 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2670 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2671 if (STRINGP (Vexecuting_kbd_macro
)
2672 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2673 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2675 executing_kbd_macro_index
++;
2680 if (!NILP (unread_switch_frame
))
2682 c
= unread_switch_frame
;
2683 unread_switch_frame
= Qnil
;
2685 /* This event should make it into this_command_keys, and get echoed
2686 again, so we do not set `reread'. */
2690 /* if redisplay was requested */
2691 if (commandflag
>= 0)
2693 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2695 /* If there is pending input, process any events which are not
2696 user-visible, such as X selection_request events. */
2698 || detect_input_pending_run_timers (0))
2699 swallow_events (0); /* may clear input_pending */
2701 /* Redisplay if no pending input. */
2702 while (!input_pending
)
2704 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2705 redisplay_preserve_echo_area (5);
2710 /* Normal case: no input arrived during redisplay. */
2713 /* Input arrived and pre-empted redisplay.
2714 Process any events which are not user-visible. */
2716 /* If that cleared input_pending, try again to redisplay. */
2719 /* Prevent the redisplay we just did
2720 from messing up echoing of the input after the prompt. */
2721 if (commandflag
== 0 && echo_current
)
2722 echo_message_buffer
= echo_area_buffer
[0];
2726 /* Message turns off echoing unless more keystrokes turn it on again.
2728 The code in 20.x for the condition was
2730 1. echo_area_glyphs && *echo_area_glyphs
2731 2. && echo_area_glyphs != current_kboard->echobuf
2732 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2734 (1) means there's a current message displayed
2736 (2) means it's not the message from echoing from the current
2739 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2740 is set to a non-null value. This is done in read_char and it is
2741 set to echo_area_glyphs after a call to echo_char. That means
2742 ok_to_echo_at_next_pause is either null or
2743 current_kboard->echobuf with the appropriate current_kboard at
2746 So, condition (3) means in clear text ok_to_echo_at_next_pause
2747 must be either null, or the current message isn't from echoing at
2748 all, or it's from echoing from a different kboard than the
2751 if (/* There currently is something in the echo area. */
2752 !NILP (echo_area_buffer
[0])
2753 && (/* And it's either not from echoing. */
2754 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2755 /* Or it's an echo from a different kboard. */
2756 || echo_kboard
!= current_kboard
2757 /* Or we explicitly allow overwriting whatever there is. */
2758 || ok_to_echo_at_next_pause
== NULL
))
2763 /* Try reading a character via menu prompting in the minibuf.
2764 Try this before the sit-for, because the sit-for
2765 would do the wrong thing if we are supposed to do
2766 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2767 after a mouse event so don't try a minibuf menu. */
2769 if (nmaps
> 0 && INTERACTIVE
2770 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2771 /* Don't bring up a menu if we already have another event. */
2772 && NILP (Vunread_command_events
)
2773 && unread_command_char
< 0
2774 && !detect_input_pending_run_timers (0))
2776 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2778 if (INTEGERP (c
) && XINT (c
) == -2)
2779 return c
; /* wrong_kboard_jmpbuf */
2783 key_already_recorded
= 1;
2788 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2789 We will do that below, temporarily for short sections of code,
2790 when appropriate. local_getcjmp must be in effect
2791 around any call to sit_for or kbd_buffer_get_event;
2792 it *must not* be in effect when we call redisplay. */
2794 jmpcount
= SPECPDL_INDEX ();
2795 if (_setjmp (local_getcjmp
))
2797 /* Handle quits while reading the keyboard. */
2798 /* We must have saved the outer value of getcjmp here,
2799 so restore it now. */
2800 restore_getcjmp (save_jump
);
2801 unbind_to (jmpcount
, Qnil
);
2802 XSETINT (c
, quit_char
);
2803 internal_last_event_frame
= selected_frame
;
2804 Vlast_event_frame
= internal_last_event_frame
;
2805 /* If we report the quit char as an event,
2806 don't do so more than once. */
2807 if (!NILP (Vinhibit_quit
))
2811 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2812 if (kb
!= current_kboard
)
2814 Lisp_Object link
= kb
->kbd_queue
;
2815 /* We shouldn't get here if we were in single-kboard mode! */
2820 while (CONSP (XCDR (link
)))
2822 if (!NILP (XCDR (link
)))
2826 kb
->kbd_queue
= Fcons (c
, Qnil
);
2828 XSETCDR (link
, Fcons (c
, Qnil
));
2829 kb
->kbd_queue_has_data
= 1;
2830 current_kboard
= kb
;
2831 /* This is going to exit from read_char
2832 so we had better get rid of this frame's stuff. */
2834 return make_number (-2); /* wrong_kboard_jmpbuf */
2840 /* Start idle timers if no time limit is supplied. We don't do it
2841 if a time limit is supplied to avoid an infinite recursion in the
2842 situation where an idle timer calls `sit-for'. */
2845 timer_start_idle ();
2847 /* If in middle of key sequence and minibuffer not active,
2848 start echoing if enough time elapses. */
2850 if (minibuf_level
== 0
2852 && !current_kboard
->immediate_echo
2853 && this_command_key_count
> 0
2855 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2856 && NILP (Fzerop (Vecho_keystrokes
))
2857 && (/* No message. */
2858 NILP (echo_area_buffer
[0])
2859 /* Or empty message. */
2860 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2861 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2862 /* Or already echoing from same kboard. */
2863 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2864 /* Or not echoing before and echoing allowed. */
2865 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2867 /* After a mouse event, start echoing right away.
2868 This is because we are probably about to display a menu,
2869 and we don't want to delay before doing so. */
2870 if (EVENT_HAS_PARAMETERS (prev_event
))
2876 save_getcjmp (save_jump
);
2877 restore_getcjmp (local_getcjmp
);
2878 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2879 restore_getcjmp (save_jump
);
2881 && ! CONSP (Vunread_command_events
))
2886 /* Maybe auto save due to number of keystrokes. */
2888 if (commandflag
!= 0
2889 && auto_save_interval
> 0
2890 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2891 && !detect_input_pending_run_timers (0))
2893 Fdo_auto_save (Qnil
, Qnil
);
2894 /* Hooks can actually change some buffers in auto save. */
2898 /* Try reading using an X menu.
2899 This is never confused with reading using the minibuf
2900 because the recursive call of read_char in read_char_minibuf_menu_prompt
2901 does not pass on any keymaps. */
2903 if (nmaps
> 0 && INTERACTIVE
2904 && !NILP (prev_event
)
2905 && EVENT_HAS_PARAMETERS (prev_event
)
2906 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2907 && !EQ (XCAR (prev_event
), Qtool_bar
)
2908 /* Don't bring up a menu if we already have another event. */
2909 && NILP (Vunread_command_events
)
2910 && unread_command_char
< 0)
2912 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2914 /* Now that we have read an event, Emacs is not idle. */
2921 /* Maybe autosave and/or garbage collect due to idleness. */
2923 if (INTERACTIVE
&& NILP (c
))
2925 int delay_level
, buffer_size
;
2927 /* Slow down auto saves logarithmically in size of current buffer,
2928 and garbage collect while we're at it. */
2929 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2930 last_non_minibuf_size
= Z
- BEG
;
2931 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2933 while (buffer_size
> 64)
2934 delay_level
++, buffer_size
-= buffer_size
>> 2;
2935 if (delay_level
< 4) delay_level
= 4;
2936 /* delay_level is 4 for files under around 50k, 7 at 100k,
2937 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2939 /* Auto save if enough time goes by without input. */
2940 if (commandflag
!= 0
2941 && num_nonmacro_input_events
> last_auto_save
2942 && INTEGERP (Vauto_save_timeout
)
2943 && XINT (Vauto_save_timeout
) > 0)
2946 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2948 save_getcjmp (save_jump
);
2949 restore_getcjmp (local_getcjmp
);
2950 tem0
= sit_for (make_number (timeout
), 1, 1);
2951 restore_getcjmp (save_jump
);
2954 && ! CONSP (Vunread_command_events
))
2956 Fdo_auto_save (Qnil
, Qnil
);
2958 /* If we have auto-saved and there is still no input
2959 available, garbage collect if there has been enough
2960 consing going on to make it worthwhile. */
2961 if (!detect_input_pending_run_timers (0)
2962 && consing_since_gc
> gc_cons_threshold
/ 2)
2963 Fgarbage_collect ();
2970 /* Notify the caller if an autosave hook, or a timer, sentinel or
2971 filter in the sit_for calls above have changed the current
2972 kboard. This could happen if they use the minibuffer or start a
2973 recursive edit, like the fancy splash screen in server.el's
2974 filter. If this longjmp wasn't here, read_key_sequence would
2975 interpret the next key sequence using the wrong translation
2976 tables and function keymaps. */
2977 if (NILP (c
) && current_kboard
!= orig_kboard
)
2980 return make_number (-2); /* wrong_kboard_jmpbuf */
2983 /* If this has become non-nil here, it has been set by a timer
2984 or sentinel or filter. */
2985 if (CONSP (Vunread_command_events
))
2987 c
= XCAR (Vunread_command_events
);
2988 Vunread_command_events
= XCDR (Vunread_command_events
);
2991 /* Read something from current KBOARD's side queue, if possible. */
2995 if (current_kboard
->kbd_queue_has_data
)
2997 if (!CONSP (current_kboard
->kbd_queue
))
2999 c
= XCAR (current_kboard
->kbd_queue
);
3000 current_kboard
->kbd_queue
3001 = XCDR (current_kboard
->kbd_queue
);
3002 if (NILP (current_kboard
->kbd_queue
))
3003 current_kboard
->kbd_queue_has_data
= 0;
3004 input_pending
= readable_events (0);
3005 if (EVENT_HAS_PARAMETERS (c
)
3006 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
3007 internal_last_event_frame
= XCAR (XCDR (c
));
3008 Vlast_event_frame
= internal_last_event_frame
;
3012 /* If current_kboard's side queue is empty check the other kboards.
3013 If one of them has data that we have not yet seen here,
3014 switch to it and process the data waiting for it.
3016 Note: if the events queued up for another kboard
3017 have already been seen here, and therefore are not a complete command,
3018 the kbd_queue_has_data field is 0, so we skip that kboard here.
3019 That's to avoid an infinite loop switching between kboards here. */
3020 if (NILP (c
) && !single_kboard
)
3023 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3024 if (kb
->kbd_queue_has_data
)
3026 current_kboard
= kb
;
3027 /* This is going to exit from read_char
3028 so we had better get rid of this frame's stuff. */
3030 return make_number (-2); /* wrong_kboard_jmpbuf */
3038 /* Finally, we read from the main queue,
3039 and if that gives us something we can't use yet, we put it on the
3040 appropriate side queue and try again. */
3049 EMACS_GET_TIME (now
);
3050 if (EMACS_TIME_GE (now
, *end_time
))
3054 /* Actually read a character, waiting if necessary. */
3055 save_getcjmp (save_jump
);
3056 restore_getcjmp (local_getcjmp
);
3058 timer_start_idle ();
3059 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3060 restore_getcjmp (save_jump
);
3062 if (! NILP (c
) && (kb
!= current_kboard
))
3064 Lisp_Object link
= kb
->kbd_queue
;
3067 while (CONSP (XCDR (link
)))
3069 if (!NILP (XCDR (link
)))
3073 kb
->kbd_queue
= Fcons (c
, Qnil
);
3075 XSETCDR (link
, Fcons (c
, Qnil
));
3076 kb
->kbd_queue_has_data
= 1;
3080 current_kboard
= kb
;
3081 /* This is going to exit from read_char
3082 so we had better get rid of this frame's stuff. */
3084 return make_number (-2);
3088 /* Terminate Emacs in batch mode if at eof. */
3089 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3090 Fkill_emacs (make_number (1));
3094 /* Add in any extra modifiers, where appropriate. */
3095 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3096 || ((extra_keyboard_modifiers
& 0177) < ' '
3097 && (extra_keyboard_modifiers
& 0177) != 0))
3098 XSETINT (c
, make_ctrl_char (XINT (c
)));
3100 /* Transfer any other modifier bits directly from
3101 extra_keyboard_modifiers to c. Ignore the actual character code
3102 in the low 16 bits of extra_keyboard_modifiers. */
3103 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3114 if (commandflag
>= 0
3115 && !input_pending
&& !detect_input_pending_run_timers (0))
3123 /* Buffer switch events are only for internal wakeups
3124 so don't show them to the user.
3125 Also, don't record a key if we already did. */
3126 if (BUFFERP (c
) || key_already_recorded
)
3129 /* Process special events within read_char
3130 and loop around to read another event. */
3133 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3138 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3139 int was_locked
= single_kboard
;
3140 int count
= SPECPDL_INDEX ();
3141 record_single_kboard_state ();
3144 last_input_event
= c
;
3145 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
3147 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3148 /* We stopped being idle for this event; undo that. This
3149 prevents automatic window selection (under
3150 mouse_autoselect_window from acting as a real input event, for
3151 example banishing the mouse under mouse-avoidance-mode. */
3152 timer_resume_idle ();
3154 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3155 /* Resume allowing input from any kboard, if that was true before. */
3157 any_kboard_state ();
3158 unbind_to (count
, Qnil
);
3164 /* Handle things that only apply to characters. */
3167 /* If kbd_buffer_get_event gave us an EOF, return that. */
3171 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3172 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3173 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3174 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3175 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3179 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3180 /* nil in keyboard-translate-table means no translation. */
3186 /* If this event is a mouse click in the menu bar,
3187 return just menu-bar for now. Modify the mouse click event
3188 so we won't do this twice, then queue it up. */
3189 if (EVENT_HAS_PARAMETERS (c
)
3191 && CONSP (EVENT_START (c
))
3192 && CONSP (XCDR (EVENT_START (c
))))
3196 posn
= POSN_POSN (EVENT_START (c
));
3197 /* Handle menu-bar events:
3198 insert the dummy prefix event `menu-bar'. */
3199 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3201 /* Change menu-bar to (menu-bar) as the event "position". */
3202 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3205 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3210 /* Store these characters into recent_keys, the dribble file if any,
3211 and the keyboard macro being defined, if any. */
3213 if (! NILP (also_record
))
3214 record_char (also_record
);
3216 /* Wipe the echo area.
3217 But first, if we are about to use an input method,
3218 save the echo area contents for it to refer to. */
3220 && ! NILP (Vinput_method_function
)
3221 && (unsigned) XINT (c
) >= ' '
3222 && (unsigned) XINT (c
) != 127
3223 && (unsigned) XINT (c
) < 256)
3225 previous_echo_area_message
= Fcurrent_message ();
3226 Vinput_method_previous_message
= previous_echo_area_message
;
3229 /* Now wipe the echo area, except for help events which do their
3230 own stuff with the echo area. */
3232 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3233 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3235 if (!NILP (echo_area_buffer
[0]))
3236 safe_run_hooks (Qecho_area_clear_hook
);
3237 clear_message (1, 0);
3240 reread_for_input_method
:
3242 /* Pass this to the input method, if appropriate. */
3244 && ! NILP (Vinput_method_function
)
3245 /* Don't run the input method within a key sequence,
3246 after the first event of the key sequence. */
3247 && NILP (prev_event
)
3248 && (unsigned) XINT (c
) >= ' '
3249 && (unsigned) XINT (c
) != 127
3250 && (unsigned) XINT (c
) < 256)
3253 int key_count
, key_count_reset
;
3254 struct gcpro gcpro1
;
3255 int count
= SPECPDL_INDEX ();
3257 /* Save the echo status. */
3258 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3259 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3260 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3261 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3264 if (before_command_restore_flag
)
3266 this_command_key_count
= before_command_key_count_1
;
3267 if (this_command_key_count
< this_single_command_key_start
)
3268 this_single_command_key_start
= this_command_key_count
;
3269 echo_truncate (before_command_echo_length_1
);
3270 before_command_restore_flag
= 0;
3274 /* Save the this_command_keys status. */
3275 key_count
= this_command_key_count
;
3276 key_count_reset
= this_command_key_count_reset
;
3279 keys
= Fcopy_sequence (this_command_keys
);
3284 /* Clear out this_command_keys. */
3285 this_command_key_count
= 0;
3286 this_command_key_count_reset
= 0;
3288 /* Now wipe the echo area. */
3289 if (!NILP (echo_area_buffer
[0]))
3290 safe_run_hooks (Qecho_area_clear_hook
);
3291 clear_message (1, 0);
3294 /* If we are not reading a key sequence,
3295 never use the echo area. */
3298 specbind (Qinput_method_use_echo_area
, Qt
);
3301 /* Call the input method. */
3302 tem
= call1 (Vinput_method_function
, c
);
3304 tem
= unbind_to (count
, tem
);
3306 /* Restore the saved echoing state
3307 and this_command_keys state. */
3308 this_command_key_count
= key_count
;
3309 this_command_key_count_reset
= key_count_reset
;
3311 this_command_keys
= keys
;
3314 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3315 current_kboard
->echo_string
= saved_echo_string
;
3316 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3317 if (saved_immediate_echo
)
3322 /* The input method can return no events. */
3325 /* Bring back the previous message, if any. */
3326 if (! NILP (previous_echo_area_message
))
3327 message_with_string ("%s", previous_echo_area_message
, 0);
3330 /* It returned one event or more. */
3332 Vunread_post_input_method_events
3333 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3338 /* Display help if not echoing. */
3339 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3341 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3342 Lisp_Object help
, object
, position
, window
, tem
;
3344 tem
= Fcdr (XCDR (c
));
3347 window
= Fcar (tem
);
3349 object
= Fcar (tem
);
3351 position
= Fcar (tem
);
3353 show_help_echo (help
, window
, object
, position
, 0);
3355 /* We stopped being idle for this event; undo that. */
3357 timer_resume_idle ();
3361 if ((! reread
|| this_command_key_count
== 0
3362 || this_command_key_count_reset
)
3366 /* Don't echo mouse motion events. */
3367 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3368 && NILP (Fzerop (Vecho_keystrokes
))
3369 && ! (EVENT_HAS_PARAMETERS (c
)
3370 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3373 if (! NILP (also_record
))
3374 echo_char (also_record
);
3375 /* Once we reread a character, echoing can happen
3376 the next time we pause to read a new one. */
3377 ok_to_echo_at_next_pause
= current_kboard
;
3380 /* Record this character as part of the current key. */
3381 add_command_key (c
);
3382 if (! NILP (also_record
))
3383 add_command_key (also_record
);
3386 last_input_event
= c
;
3389 /* Process the help character specially if enabled */
3390 if (!NILP (Vhelp_form
) && help_char_p (c
))
3393 count
= SPECPDL_INDEX ();
3395 help_form_saved_window_configs
3396 = Fcons (Fcurrent_window_configuration (Qnil
),
3397 help_form_saved_window_configs
);
3398 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3400 tem0
= Feval (Vhelp_form
);
3402 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3407 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3408 if (EVENT_HAS_PARAMETERS (c
)
3409 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3410 XSETCAR (help_form_saved_window_configs
, Qnil
);
3412 while (BUFFERP (c
));
3413 /* Remove the help from the frame */
3414 unbind_to (count
, Qnil
);
3417 if (EQ (c
, make_number (040)))
3421 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3422 while (BUFFERP (c
));
3431 /* Record a key that came from a mouse menu.
3432 Record it for echoing, for this-command-keys, and so on. */
3438 /* Wipe the echo area. */
3439 clear_message (1, 0);
3444 before_command_key_count
= this_command_key_count
;
3445 before_command_echo_length
= echo_length ();
3448 /* Don't echo mouse motion events. */
3449 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3450 && NILP (Fzerop (Vecho_keystrokes
)))
3454 /* Once we reread a character, echoing can happen
3455 the next time we pause to read a new one. */
3456 ok_to_echo_at_next_pause
= 0;
3459 /* Record this character as part of the current key. */
3460 add_command_key (c
);
3462 /* Re-reading in the middle of a command */
3463 last_input_event
= c
;
3467 /* Return 1 if should recognize C as "the help character". */
3475 if (EQ (c
, Vhelp_char
))
3477 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3478 if (EQ (c
, XCAR (tail
)))
3483 /* Record the input event C in various ways. */
3491 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3493 /* To avoid filling recent_keys with help-echo and mouse-movement
3494 events, we filter out repeated help-echo events, only store the
3495 first and last in a series of mouse-movement events, and don't
3496 store repeated help-echo events which are only separated by
3497 mouse-movement events. */
3499 Lisp_Object ev1
, ev2
, ev3
;
3502 if ((ix1
= recent_keys_index
- 1) < 0)
3503 ix1
= NUM_RECENT_KEYS
- 1;
3504 ev1
= AREF (recent_keys
, ix1
);
3506 if ((ix2
= ix1
- 1) < 0)
3507 ix2
= NUM_RECENT_KEYS
- 1;
3508 ev2
= AREF (recent_keys
, ix2
);
3510 if ((ix3
= ix2
- 1) < 0)
3511 ix3
= NUM_RECENT_KEYS
- 1;
3512 ev3
= AREF (recent_keys
, ix3
);
3514 if (EQ (XCAR (c
), Qhelp_echo
))
3516 /* Don't record `help-echo' in recent_keys unless it shows some help
3517 message, and a different help than the previously recorded
3519 Lisp_Object help
, last_help
;
3521 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3522 if (!STRINGP (help
))
3524 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3525 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3527 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3528 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3529 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3531 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3532 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3533 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3534 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3537 else if (EQ (XCAR (c
), Qmouse_movement
))
3539 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3540 So additional mouse movement events replace the last element. */
3541 Lisp_Object last_window
, window
;
3543 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3544 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3545 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3546 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3547 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3549 ASET (recent_keys
, ix1
, c
);
3555 store_kbd_macro_char (c
);
3560 ASET (recent_keys
, recent_keys_index
, c
);
3561 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3562 recent_keys_index
= 0;
3564 else if (recorded
< 0)
3566 /* We need to remove one or two events from recent_keys.
3567 To do this, we simply put nil at those events and move the
3568 recent_keys_index backwards over those events. Usually,
3569 users will never see those nil events, as they will be
3570 overwritten by the command keys entered to see recent_keys
3573 while (recorded
++ < 0 && total_keys
> 0)
3575 if (total_keys
< NUM_RECENT_KEYS
)
3577 if (--recent_keys_index
< 0)
3578 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3579 ASET (recent_keys
, recent_keys_index
, Qnil
);
3583 num_nonmacro_input_events
++;
3585 /* Write c to the dribble file. If c is a lispy event, write
3586 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3587 If you, dear reader, have a better idea, you've got the source. :-) */
3593 if (XUINT (c
) < 0x100)
3594 putc (XINT (c
), dribble
);
3596 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3600 Lisp_Object dribblee
;
3602 /* If it's a structured event, take the event header. */
3603 dribblee
= EVENT_HEAD (c
);
3605 if (SYMBOLP (dribblee
))
3607 putc ('<', dribble
);
3608 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3609 SBYTES (SYMBOL_NAME (dribblee
)),
3611 putc ('>', dribble
);
3624 struct buffer
*old
= current_buffer
;
3625 Fprinc (object
, Qnil
);
3626 set_buffer_internal (XBUFFER (Vstandard_output
));
3627 call0 (intern ("help-mode"));
3628 set_buffer_internal (old
);
3632 /* Copy out or in the info on where C-g should throw to.
3633 This is used when running Lisp code from within get_char,
3634 in case get_char is called recursively.
3635 See read_process_output. */
3641 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3645 restore_getcjmp (temp
)
3648 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3651 /* Low level keyboard/mouse input.
3652 kbd_buffer_store_event places events in kbd_buffer, and
3653 kbd_buffer_get_event retrieves them. */
3655 /* Return true if there are any events in the queue that read-char
3656 would return. If this returns false, a read-char would block. */
3658 readable_events (flags
)
3661 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3664 /* If the buffer contains only FOCUS_IN_EVENT events, and
3665 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3666 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3668 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3669 #ifdef USE_TOOLKIT_SCROLL_BARS
3670 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3674 struct input_event
*event
;
3676 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3683 #ifdef USE_TOOLKIT_SCROLL_BARS
3684 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3686 event
->kind
== FOCUS_IN_EVENT
)
3687 #ifdef USE_TOOLKIT_SCROLL_BARS
3688 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3689 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3690 && event
->part
== scroll_bar_handle
3691 && event
->modifiers
== 0)
3696 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3699 while (event
!= kbd_store_ptr
);
3705 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3706 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3707 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3712 if (current_kboard
->kbd_queue_has_data
)
3718 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3719 if (kb
->kbd_queue_has_data
)
3725 /* Set this for debugging, to have a way to get out */
3729 event_to_kboard (event
)
3730 struct input_event
*event
;
3733 frame
= event
->frame_or_window
;
3735 frame
= XCAR (frame
);
3736 else if (WINDOWP (frame
))
3737 frame
= WINDOW_FRAME (XWINDOW (frame
));
3739 /* There are still some events that don't set this field.
3740 For now, just ignore the problem.
3741 Also ignore dead frames here. */
3742 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3745 return FRAME_KBOARD (XFRAME (frame
));
3749 Lisp_Object Vthrow_on_input
;
3751 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3754 kbd_buffer_store_event (event
)
3755 register struct input_event
*event
;
3757 kbd_buffer_store_event_hold (event
, 0);
3760 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3762 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3763 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3764 Else, if EVENT is a quit event, store the quit event
3765 in HOLD_QUIT, and return (thus ignoring further events).
3767 This is used in read_avail_input to postpone the processing
3768 of the quit event until all subsequent input events have been
3769 parsed (and discarded).
3773 kbd_buffer_store_event_hold (event
, hold_quit
)
3774 register struct input_event
*event
;
3775 struct input_event
*hold_quit
;
3777 if (event
->kind
== NO_EVENT
)
3780 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3783 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3785 register int c
= event
->code
& 0377;
3787 if (event
->modifiers
& ctrl_modifier
)
3788 c
= make_ctrl_char (c
);
3790 c
|= (event
->modifiers
3791 & (meta_modifier
| alt_modifier
3792 | hyper_modifier
| super_modifier
));
3796 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3797 struct input_event
*sp
;
3799 if (single_kboard
&& kb
!= current_kboard
)
3802 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3803 Fcons (make_number (c
), Qnil
));
3804 kb
->kbd_queue_has_data
= 1;
3805 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3807 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3810 if (event_to_kboard (sp
) == kb
)
3812 sp
->kind
= NO_EVENT
;
3813 sp
->frame_or_window
= Qnil
;
3822 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3826 /* If this results in a quit_char being returned to Emacs as
3827 input, set Vlast_event_frame properly. If this doesn't
3828 get returned to Emacs as an event, the next event read
3829 will set Vlast_event_frame again, so this is safe to do. */
3833 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3835 focus
= event
->frame_or_window
;
3836 internal_last_event_frame
= focus
;
3837 Vlast_event_frame
= focus
;
3840 last_event_timestamp
= event
->timestamp
;
3841 handle_interrupt ();
3845 if (c
&& c
== stop_character
)
3851 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3852 Just ignore the second one. */
3853 else if (event
->kind
== BUFFER_SWITCH_EVENT
3854 && kbd_fetch_ptr
!= kbd_store_ptr
3855 && ((kbd_store_ptr
== kbd_buffer
3856 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3857 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3860 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3861 kbd_store_ptr
= kbd_buffer
;
3863 /* Don't let the very last slot in the buffer become full,
3864 since that would make the two pointers equal,
3865 and that is indistinguishable from an empty buffer.
3866 Discard the event if it would fill the last slot. */
3867 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3869 *kbd_store_ptr
= *event
;
3873 /* If we're inside while-no-input, and this event qualifies
3874 as input, set quit-flag to cause an interrupt. */
3875 if (!NILP (Vthrow_on_input
)
3876 && event
->kind
!= FOCUS_IN_EVENT
3877 && event
->kind
!= HELP_EVENT
3878 && event
->kind
!= DEICONIFY_EVENT
)
3880 Vquit_flag
= Vthrow_on_input
;
3881 /* If we're inside a function that wants immediate quits,
3883 if (immediate_quit
&& NILP (Vinhibit_quit
))
3893 /* Put an input event back in the head of the event queue. */
3896 kbd_buffer_unget_event (event
)
3897 register struct input_event
*event
;
3899 if (kbd_fetch_ptr
== kbd_buffer
)
3900 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3902 /* Don't let the very last slot in the buffer become full, */
3903 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3906 *kbd_fetch_ptr
= *event
;
3911 /* Generate HELP_EVENT input_events in BUFP which has room for
3912 SIZE events. If there's not enough room in BUFP, ignore this
3915 HELP is the help form.
3917 FRAME is the frame on which the help is generated. OBJECT is the
3918 Lisp object where the help was found (a buffer, a string, an
3919 overlay, or nil if neither from a string nor from a buffer. POS is
3920 the position within OBJECT where the help was found.
3922 Value is the number of input_events generated. */
3925 gen_help_event (help
, frame
, window
, object
, pos
)
3926 Lisp_Object help
, frame
, object
, window
;
3929 struct input_event event
;
3933 event
.kind
= HELP_EVENT
;
3934 event
.frame_or_window
= frame
;
3936 event
.x
= WINDOWP (window
) ? window
: frame
;
3939 kbd_buffer_store_event (&event
);
3943 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3946 kbd_buffer_store_help_event (frame
, help
)
3947 Lisp_Object frame
, help
;
3949 struct input_event event
;
3951 event
.kind
= HELP_EVENT
;
3952 event
.frame_or_window
= frame
;
3957 kbd_buffer_store_event (&event
);
3961 /* Discard any mouse events in the event buffer by setting them to
3964 discard_mouse_events ()
3966 struct input_event
*sp
;
3967 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3969 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3972 if (sp
->kind
== MOUSE_CLICK_EVENT
3973 || sp
->kind
== WHEEL_EVENT
3974 || sp
->kind
== HORIZ_WHEEL_EVENT
3976 || sp
->kind
== GPM_CLICK_EVENT
3978 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3980 sp
->kind
= NO_EVENT
;
3986 /* Return non-zero if there are any real events waiting in the event
3987 buffer, not counting `NO_EVENT's.
3989 If DISCARD is non-zero, discard NO_EVENT events at the front of
3990 the input queue, possibly leaving the input queue empty if there
3991 are no real input events. */
3994 kbd_buffer_events_waiting (discard
)
3997 struct input_event
*sp
;
3999 for (sp
= kbd_fetch_ptr
;
4000 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4003 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4010 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4014 /* Clear input event EVENT. */
4018 struct input_event
*event
;
4020 event
->kind
= NO_EVENT
;
4024 /* Read one event from the event buffer, waiting if necessary.
4025 The value is a Lisp object representing the event.
4026 The value is nil for an event that should be ignored,
4027 or that was handled here.
4028 We always read and discard one event. */
4031 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4033 int *used_mouse_menu
;
4034 EMACS_TIME
*end_time
;
4040 /* In case we are running as a daemon, only do this before
4041 detaching from the terminal. */
4042 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
4046 *kbp
= current_kboard
;
4050 /* Wait until there is input available. */
4053 /* Break loop if there's an unread command event. Needed in
4054 moused window autoselection which uses a timer to insert such
4056 if (CONSP (Vunread_command_events
))
4059 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4061 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4062 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4066 /* If the quit flag is set, then read_char will return
4067 quit_char, so that counts as "available input." */
4068 if (!NILP (Vquit_flag
))
4069 quit_throw_to_read_char ();
4071 /* One way or another, wait until input is available; then, if
4072 interrupt handlers have not read it, read it now. */
4074 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4078 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4080 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4081 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4086 EMACS_TIME duration
;
4087 EMACS_GET_TIME (duration
);
4088 if (EMACS_TIME_GE (duration
, *end_time
))
4089 return Qnil
; /* finished waiting */
4092 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4093 wait_reading_process_output (EMACS_SECS (duration
),
4094 EMACS_USECS (duration
),
4095 -1, 1, Qnil
, NULL
, 0);
4099 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4101 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4102 /* Pass 1 for EXPECT since we just waited to have input. */
4103 read_avail_input (1);
4106 if (CONSP (Vunread_command_events
))
4109 first
= XCAR (Vunread_command_events
);
4110 Vunread_command_events
= XCDR (Vunread_command_events
);
4111 *kbp
= current_kboard
;
4115 /* At this point, we know that there is a readable event available
4116 somewhere. If the event queue is empty, then there must be a
4117 mouse movement enabled and available. */
4118 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4120 struct input_event
*event
;
4122 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4126 last_event_timestamp
= event
->timestamp
;
4128 *kbp
= event_to_kboard (event
);
4130 *kbp
= current_kboard
; /* Better than returning null ptr? */
4134 /* These two kinds of events get special handling
4135 and don't actually appear to the command loop.
4136 We return nil for them. */
4137 if (event
->kind
== SELECTION_REQUEST_EVENT
4138 || event
->kind
== SELECTION_CLEAR_EVENT
)
4141 struct input_event copy
;
4143 /* Remove it from the buffer before processing it,
4144 since otherwise swallow_events will see it
4145 and process it again. */
4147 kbd_fetch_ptr
= event
+ 1;
4148 input_pending
= readable_events (0);
4149 x_handle_selection_event (©
);
4151 /* We're getting selection request events, but we don't have
4157 #if defined (HAVE_NS)
4158 else if (event
->kind
== NS_TEXT_EVENT
)
4160 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4161 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4163 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4164 kbd_fetch_ptr
= event
+ 1;
4165 if (used_mouse_menu
)
4166 *used_mouse_menu
= 1;
4170 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4171 || defined (HAVE_NS)
4172 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4174 /* Make an event (delete-frame (FRAME)). */
4175 obj
= Fcons (event
->frame_or_window
, Qnil
);
4176 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4177 kbd_fetch_ptr
= event
+ 1;
4180 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4181 || defined (HAVE_NS)
4182 else if (event
->kind
== ICONIFY_EVENT
)
4184 /* Make an event (iconify-frame (FRAME)). */
4185 obj
= Fcons (event
->frame_or_window
, Qnil
);
4186 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4187 kbd_fetch_ptr
= event
+ 1;
4189 else if (event
->kind
== DEICONIFY_EVENT
)
4191 /* Make an event (make-frame-visible (FRAME)). */
4192 obj
= Fcons (event
->frame_or_window
, Qnil
);
4193 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4194 kbd_fetch_ptr
= event
+ 1;
4197 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4199 /* The value doesn't matter here; only the type is tested. */
4200 XSETBUFFER (obj
, current_buffer
);
4201 kbd_fetch_ptr
= event
+ 1;
4203 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4204 || defined(HAVE_NS) || defined (USE_GTK)
4205 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4207 kbd_fetch_ptr
= event
+ 1;
4208 input_pending
= readable_events (0);
4209 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4210 x_activate_menubar (XFRAME (event
->frame_or_window
));
4213 #if defined (WINDOWSNT)
4214 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4216 /* Make an event (language-change (FRAME CHARSET LCID)). */
4217 obj
= Fcons (event
->frame_or_window
, Qnil
);
4218 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4219 kbd_fetch_ptr
= event
+ 1;
4222 else if (event
->kind
== SAVE_SESSION_EVENT
)
4224 obj
= Fcons (Qsave_session
, Qnil
);
4225 kbd_fetch_ptr
= event
+ 1;
4227 /* Just discard these, by returning nil.
4228 With MULTI_KBOARD, these events are used as placeholders
4229 when we need to randomly delete events from the queue.
4230 (They shouldn't otherwise be found in the buffer,
4231 but on some machines it appears they do show up
4232 even without MULTI_KBOARD.) */
4233 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4234 mouse events during a popup-menu call. */
4235 else if (event
->kind
== NO_EVENT
)
4236 kbd_fetch_ptr
= event
+ 1;
4237 else if (event
->kind
== HELP_EVENT
)
4239 Lisp_Object object
, position
, help
, frame
, window
;
4241 frame
= event
->frame_or_window
;
4242 object
= event
->arg
;
4243 position
= make_number (event
->code
);
4246 clear_event (event
);
4248 kbd_fetch_ptr
= event
+ 1;
4249 if (!WINDOWP (window
))
4251 obj
= Fcons (Qhelp_echo
,
4252 list5 (frame
, help
, window
, object
, position
));
4254 else if (event
->kind
== FOCUS_IN_EVENT
)
4256 /* Notification of a FocusIn event. The frame receiving the
4257 focus is in event->frame_or_window. Generate a
4258 switch-frame event if necessary. */
4259 Lisp_Object frame
, focus
;
4261 frame
= event
->frame_or_window
;
4262 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4266 if (!EQ (frame
, internal_last_event_frame
)
4267 && !EQ (frame
, selected_frame
))
4268 obj
= make_lispy_switch_frame (frame
);
4269 internal_last_event_frame
= frame
;
4270 kbd_fetch_ptr
= event
+ 1;
4273 else if (event
->kind
== DBUS_EVENT
)
4275 obj
= make_lispy_event (event
);
4276 kbd_fetch_ptr
= event
+ 1;
4281 /* If this event is on a different frame, return a switch-frame this
4282 time, and leave the event in the queue for next time. */
4286 frame
= event
->frame_or_window
;
4288 frame
= XCAR (frame
);
4289 else if (WINDOWP (frame
))
4290 frame
= WINDOW_FRAME (XWINDOW (frame
));
4292 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4296 if (! EQ (frame
, internal_last_event_frame
)
4297 && !EQ (frame
, selected_frame
))
4298 obj
= make_lispy_switch_frame (frame
);
4299 internal_last_event_frame
= frame
;
4301 /* If we didn't decide to make a switch-frame event, go ahead
4302 and build a real event from the queue entry. */
4306 obj
= make_lispy_event (event
);
4308 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4309 || defined(HAVE_NS) || defined (USE_GTK)
4310 /* If this was a menu selection, then set the flag to inhibit
4311 writing to last_nonmenu_event. Don't do this if the event
4312 we're returning is (menu-bar), though; that indicates the
4313 beginning of the menu sequence, and we might as well leave
4314 that as the `event with parameters' for this selection. */
4316 && !EQ (event
->frame_or_window
, event
->arg
)
4317 && (event
->kind
== MENU_BAR_EVENT
4318 || event
->kind
== TOOL_BAR_EVENT
))
4319 *used_mouse_menu
= 1;
4322 /* certain system events are non-key events */
4324 && event
->kind
== NS_NONKEY_EVENT
)
4325 *used_mouse_menu
= 1;
4328 /* Wipe out this event, to catch bugs. */
4329 clear_event (event
);
4330 kbd_fetch_ptr
= event
+ 1;
4334 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4335 /* Try generating a mouse motion event. */
4336 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4338 FRAME_PTR f
= some_mouse_moved ();
4339 Lisp_Object bar_window
;
4340 enum scroll_bar_part part
;
4344 *kbp
= current_kboard
;
4345 /* Note that this uses F to determine which terminal to look at.
4346 If there is no valid info, it does not store anything
4347 so x remains nil. */
4350 /* XXX Can f or mouse_position_hook be NULL here? */
4351 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4352 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4353 &part
, &x
, &y
, &time
);
4357 /* Decide if we should generate a switch-frame event. Don't
4358 generate switch-frame events for motion outside of all Emacs
4364 frame
= FRAME_FOCUS_FRAME (f
);
4366 XSETFRAME (frame
, f
);
4368 if (! EQ (frame
, internal_last_event_frame
)
4369 && !EQ (frame
, selected_frame
))
4370 obj
= make_lispy_switch_frame (frame
);
4371 internal_last_event_frame
= frame
;
4374 /* If we didn't decide to make a switch-frame event, go ahead and
4375 return a mouse-motion event. */
4376 if (!NILP (x
) && NILP (obj
))
4377 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4379 #endif /* HAVE_MOUSE || HAVE GPM */
4381 /* We were promised by the above while loop that there was
4382 something for us to read! */
4385 input_pending
= readable_events (0);
4387 Vlast_event_frame
= internal_last_event_frame
;
4392 /* Process any events that are not user-visible,
4393 then return, without reading any user-visible events. */
4396 swallow_events (do_display
)
4401 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4403 struct input_event
*event
;
4405 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4409 last_event_timestamp
= event
->timestamp
;
4411 /* These two kinds of events get special handling
4412 and don't actually appear to the command loop. */
4413 if (event
->kind
== SELECTION_REQUEST_EVENT
4414 || event
->kind
== SELECTION_CLEAR_EVENT
)
4417 struct input_event copy
;
4419 /* Remove it from the buffer before processing it,
4420 since otherwise swallow_events called recursively could see it
4421 and process it again. */
4423 kbd_fetch_ptr
= event
+ 1;
4424 input_pending
= readable_events (0);
4425 x_handle_selection_event (©
);
4427 /* We're getting selection request events, but we don't have
4436 old_timers_run
= timers_run
;
4437 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4439 if (timers_run
!= old_timers_run
&& do_display
)
4440 redisplay_preserve_echo_area (7);
4443 /* Record the start of when Emacs is idle,
4444 for the sake of running idle-time timers. */
4451 /* If we are already in the idle state, do nothing. */
4452 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4455 EMACS_GET_TIME (timer_idleness_start_time
);
4457 timer_last_idleness_start_time
= timer_idleness_start_time
;
4459 /* Mark all idle-time timers as once again candidates for running. */
4460 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4464 timer
= XCAR (timers
);
4466 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4468 XVECTOR (timer
)->contents
[0] = Qnil
;
4472 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4477 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4480 /* Resume idle timer from last idle start time. */
4483 timer_resume_idle ()
4485 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4488 timer_idleness_start_time
= timer_last_idleness_start_time
;
4491 /* This is only for debugging. */
4492 struct input_event last_timer_event
;
4494 /* List of elisp functions to call, delayed because they were generated in
4495 a context where Elisp could not be safely run (e.g. redisplay, signal,
4496 ...). Each element has the form (FUN . ARGS). */
4497 Lisp_Object pending_funcalls
;
4499 extern Lisp_Object Qapply
;
4501 /* Check whether a timer has fired. To prevent larger problems we simply
4502 disregard elements that are not proper timers. Do not make a circular
4503 timer list for the time being.
4505 Returns the number of seconds to wait until the next timer fires. If a
4506 timer is triggering now, return zero seconds.
4507 If no timer is active, return -1 seconds.
4509 If a timer is ripe, we run it, with quitting turned off.
4511 DO_IT_NOW is now ignored. It used to mean that we should
4512 run the timer directly instead of queueing a timer-event.
4513 Now we always run timers directly. */
4516 timer_check (do_it_now
)
4519 EMACS_TIME nexttime
;
4520 EMACS_TIME now
, idleness_now
;
4521 Lisp_Object timers
, idle_timers
, chosen_timer
;
4522 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4524 EMACS_SET_SECS (nexttime
, -1);
4525 EMACS_SET_USECS (nexttime
, -1);
4527 /* Always consider the ordinary timers. */
4528 timers
= Vtimer_list
;
4529 /* Consider the idle timers only if Emacs is idle. */
4530 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4531 idle_timers
= Vtimer_idle_list
;
4534 chosen_timer
= Qnil
;
4535 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4537 /* First run the code that was delayed. */
4538 while (CONSP (pending_funcalls
))
4540 Lisp_Object funcall
= XCAR (pending_funcalls
);
4541 pending_funcalls
= XCDR (pending_funcalls
);
4542 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4545 if (CONSP (timers
) || CONSP (idle_timers
))
4547 EMACS_GET_TIME (now
);
4548 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4549 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4552 while (CONSP (timers
) || CONSP (idle_timers
))
4554 Lisp_Object
*vector
;
4555 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4556 EMACS_TIME timer_time
, idle_timer_time
;
4557 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4559 /* Skip past invalid timers and timers already handled. */
4562 timer
= XCAR (timers
);
4563 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4565 timers
= XCDR (timers
);
4568 vector
= XVECTOR (timer
)->contents
;
4570 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4571 || !INTEGERP (vector
[3])
4572 || ! NILP (vector
[0]))
4574 timers
= XCDR (timers
);
4578 if (!NILP (idle_timers
))
4580 timer
= XCAR (idle_timers
);
4581 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4583 idle_timers
= XCDR (idle_timers
);
4586 vector
= XVECTOR (timer
)->contents
;
4588 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4589 || !INTEGERP (vector
[3])
4590 || ! NILP (vector
[0]))
4592 idle_timers
= XCDR (idle_timers
);
4597 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4598 based on the next ordinary timer.
4599 TIMER_DIFFERENCE is the distance in time from NOW to when
4600 this timer becomes ripe (negative if it's already ripe). */
4603 timer
= XCAR (timers
);
4604 vector
= XVECTOR (timer
)->contents
;
4605 EMACS_SET_SECS (timer_time
,
4606 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4607 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4608 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4611 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4612 based on the next idle timer. */
4613 if (!NILP (idle_timers
))
4615 idle_timer
= XCAR (idle_timers
);
4616 vector
= XVECTOR (idle_timer
)->contents
;
4617 EMACS_SET_SECS (idle_timer_time
,
4618 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4619 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4620 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4623 /* Decide which timer is the next timer,
4624 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4625 Also step down the list where we found that timer. */
4627 if (! NILP (timers
) && ! NILP (idle_timers
))
4630 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4631 if (EMACS_TIME_NEG_P (temp
))
4633 chosen_timer
= timer
;
4634 timers
= XCDR (timers
);
4635 difference
= timer_difference
;
4639 chosen_timer
= idle_timer
;
4640 idle_timers
= XCDR (idle_timers
);
4641 difference
= idle_timer_difference
;
4644 else if (! NILP (timers
))
4646 chosen_timer
= timer
;
4647 timers
= XCDR (timers
);
4648 difference
= timer_difference
;
4652 chosen_timer
= idle_timer
;
4653 idle_timers
= XCDR (idle_timers
);
4654 difference
= idle_timer_difference
;
4656 vector
= XVECTOR (chosen_timer
)->contents
;
4658 /* If timer is ripe, run it if it hasn't been run. */
4659 if (EMACS_TIME_NEG_P (difference
)
4660 || (EMACS_SECS (difference
) == 0
4661 && EMACS_USECS (difference
) == 0))
4663 if (NILP (vector
[0]))
4665 int count
= SPECPDL_INDEX ();
4666 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4668 /* Mark the timer as triggered to prevent problems if the lisp
4669 code fails to reschedule it right. */
4672 specbind (Qinhibit_quit
, Qt
);
4674 call1 (Qtimer_event_handler
, chosen_timer
);
4675 Vdeactivate_mark
= old_deactivate_mark
;
4677 unbind_to (count
, Qnil
);
4679 /* Since we have handled the event,
4680 we don't need to tell the caller to wake up and do it. */
4684 /* When we encounter a timer that is still waiting,
4685 return the amount of time to wait before it is ripe. */
4692 /* No timers are pending in the future. */
4693 /* Return 0 if we generated an event, and -1 if not. */
4698 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4699 doc
: /* Return the current length of Emacs idleness, or nil.
4700 The value when Emacs is idle is a list of three integers. The first has
4701 the most significant 16 bits of the seconds, while the second has the least
4702 significant 16 bits. The third integer gives the microsecond count.
4704 The value when Emacs is not idle is nil.
4706 The microsecond count is zero on systems that do not provide
4707 resolution finer than a second. */)
4710 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4712 EMACS_TIME now
, idleness_now
;
4714 EMACS_GET_TIME (now
);
4715 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4717 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4718 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4719 make_number (EMACS_USECS (idleness_now
)));
4725 /* Caches for modify_event_symbol. */
4726 static Lisp_Object accent_key_syms
;
4727 static Lisp_Object func_key_syms
;
4728 static Lisp_Object mouse_syms
;
4729 static Lisp_Object wheel_syms
;
4730 static Lisp_Object drag_n_drop_syms
;
4732 /* This is a list of keysym codes for special "accent" characters.
4733 It parallels lispy_accent_keys. */
4735 static int lispy_accent_codes
[] =
4737 #ifdef XK_dead_circumflex
4742 #ifdef XK_dead_grave
4747 #ifdef XK_dead_tilde
4752 #ifdef XK_dead_diaeresis
4757 #ifdef XK_dead_macron
4762 #ifdef XK_dead_degree
4767 #ifdef XK_dead_acute
4772 #ifdef XK_dead_cedilla
4777 #ifdef XK_dead_breve
4782 #ifdef XK_dead_ogonek
4787 #ifdef XK_dead_caron
4792 #ifdef XK_dead_doubleacute
4793 XK_dead_doubleacute
,
4797 #ifdef XK_dead_abovedot
4802 #ifdef XK_dead_abovering
4812 #ifdef XK_dead_belowdot
4817 #ifdef XK_dead_voiced_sound
4818 XK_dead_voiced_sound
,
4822 #ifdef XK_dead_semivoiced_sound
4823 XK_dead_semivoiced_sound
,
4839 /* This is a list of Lisp names for special "accent" characters.
4840 It parallels lispy_accent_codes. */
4842 static char *lispy_accent_keys
[] =
4860 "dead-voiced-sound",
4861 "dead-semivoiced-sound",
4867 #define FUNCTION_KEY_OFFSET 0x0
4869 char *lispy_function_keys
[] =
4873 0, /* VK_LBUTTON 0x01 */
4874 0, /* VK_RBUTTON 0x02 */
4875 "cancel", /* VK_CANCEL 0x03 */
4876 0, /* VK_MBUTTON 0x04 */
4878 0, 0, 0, /* 0x05 .. 0x07 */
4880 "backspace", /* VK_BACK 0x08 */
4881 "tab", /* VK_TAB 0x09 */
4883 0, 0, /* 0x0A .. 0x0B */
4885 "clear", /* VK_CLEAR 0x0C */
4886 "return", /* VK_RETURN 0x0D */
4888 0, 0, /* 0x0E .. 0x0F */
4890 0, /* VK_SHIFT 0x10 */
4891 0, /* VK_CONTROL 0x11 */
4892 0, /* VK_MENU 0x12 */
4893 "pause", /* VK_PAUSE 0x13 */
4894 "capslock", /* VK_CAPITAL 0x14 */
4895 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4897 "junja", /* VK_JUNJA 0x17 */
4898 "final", /* VK_FINAL 0x18 */
4899 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4901 "escape", /* VK_ESCAPE 0x1B */
4902 "convert", /* VK_CONVERT 0x1C */
4903 "non-convert", /* VK_NONCONVERT 0x1D */
4904 "accept", /* VK_ACCEPT 0x1E */
4905 "mode-change", /* VK_MODECHANGE 0x1F */
4906 0, /* VK_SPACE 0x20 */
4907 "prior", /* VK_PRIOR 0x21 */
4908 "next", /* VK_NEXT 0x22 */
4909 "end", /* VK_END 0x23 */
4910 "home", /* VK_HOME 0x24 */
4911 "left", /* VK_LEFT 0x25 */
4912 "up", /* VK_UP 0x26 */
4913 "right", /* VK_RIGHT 0x27 */
4914 "down", /* VK_DOWN 0x28 */
4915 "select", /* VK_SELECT 0x29 */
4916 "print", /* VK_PRINT 0x2A */
4917 "execute", /* VK_EXECUTE 0x2B */
4918 "snapshot", /* VK_SNAPSHOT 0x2C */
4919 "insert", /* VK_INSERT 0x2D */
4920 "delete", /* VK_DELETE 0x2E */
4921 "help", /* VK_HELP 0x2F */
4923 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4925 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4927 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4929 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4931 0, 0, 0, 0, 0, 0, 0, 0, 0,
4932 0, 0, 0, 0, 0, 0, 0, 0, 0,
4933 0, 0, 0, 0, 0, 0, 0, 0,
4935 "lwindow", /* VK_LWIN 0x5B */
4936 "rwindow", /* VK_RWIN 0x5C */
4937 "apps", /* VK_APPS 0x5D */
4940 "kp-0", /* VK_NUMPAD0 0x60 */
4941 "kp-1", /* VK_NUMPAD1 0x61 */
4942 "kp-2", /* VK_NUMPAD2 0x62 */
4943 "kp-3", /* VK_NUMPAD3 0x63 */
4944 "kp-4", /* VK_NUMPAD4 0x64 */
4945 "kp-5", /* VK_NUMPAD5 0x65 */
4946 "kp-6", /* VK_NUMPAD6 0x66 */
4947 "kp-7", /* VK_NUMPAD7 0x67 */
4948 "kp-8", /* VK_NUMPAD8 0x68 */
4949 "kp-9", /* VK_NUMPAD9 0x69 */
4950 "kp-multiply", /* VK_MULTIPLY 0x6A */
4951 "kp-add", /* VK_ADD 0x6B */
4952 "kp-separator", /* VK_SEPARATOR 0x6C */
4953 "kp-subtract", /* VK_SUBTRACT 0x6D */
4954 "kp-decimal", /* VK_DECIMAL 0x6E */
4955 "kp-divide", /* VK_DIVIDE 0x6F */
4956 "f1", /* VK_F1 0x70 */
4957 "f2", /* VK_F2 0x71 */
4958 "f3", /* VK_F3 0x72 */
4959 "f4", /* VK_F4 0x73 */
4960 "f5", /* VK_F5 0x74 */
4961 "f6", /* VK_F6 0x75 */
4962 "f7", /* VK_F7 0x76 */
4963 "f8", /* VK_F8 0x77 */
4964 "f9", /* VK_F9 0x78 */
4965 "f10", /* VK_F10 0x79 */
4966 "f11", /* VK_F11 0x7A */
4967 "f12", /* VK_F12 0x7B */
4968 "f13", /* VK_F13 0x7C */
4969 "f14", /* VK_F14 0x7D */
4970 "f15", /* VK_F15 0x7E */
4971 "f16", /* VK_F16 0x7F */
4972 "f17", /* VK_F17 0x80 */
4973 "f18", /* VK_F18 0x81 */
4974 "f19", /* VK_F19 0x82 */
4975 "f20", /* VK_F20 0x83 */
4976 "f21", /* VK_F21 0x84 */
4977 "f22", /* VK_F22 0x85 */
4978 "f23", /* VK_F23 0x86 */
4979 "f24", /* VK_F24 0x87 */
4981 0, 0, 0, 0, /* 0x88 .. 0x8B */
4982 0, 0, 0, 0, /* 0x8C .. 0x8F */
4984 "kp-numlock", /* VK_NUMLOCK 0x90 */
4985 "scroll", /* VK_SCROLL 0x91 */
4986 /* Not sure where the following block comes from.
4987 Windows headers have NEC and Fujitsu specific keys in
4988 this block, but nothing generic. */
4989 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4990 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4991 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4992 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4993 "kp-end", /* VK_NUMPAD_END 0x96 */
4994 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4995 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4996 "kp-up", /* VK_NUMPAD_UP 0x99 */
4997 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4998 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4999 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
5000 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
5002 0, 0, /* 0x9E .. 0x9F */
5005 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5006 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5007 * No other API or message will distinguish left and right keys this way.
5012 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5013 to enable them selectively, and gives access to a few more functions.
5014 See lispy_multimedia_keys below. */
5015 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5016 0, 0, 0, /* 0xAD .. 0xAF Volume */
5017 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5018 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5020 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5021 0, 0, 0, 0, 0, 0, 0, 0, 0,
5023 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5024 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5025 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5028 "ax", /* VK_OEM_AX 0xE1 */
5029 0, /* VK_OEM_102 0xE2 */
5030 "ico-help", /* VK_ICO_HELP 0xE3 */
5031 "ico-00", /* VK_ICO_00 0xE4 */
5032 0, /* VK_PROCESSKEY 0xE5 */
5033 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5034 "packet", /* VK_PACKET 0xE7 */
5036 "reset", /* VK_OEM_RESET 0xE9 */
5037 "jump", /* VK_OEM_JUMP 0xEA */
5038 "oem-pa1", /* VK_OEM_PA1 0xEB */
5039 "oem-pa2", /* VK_OEM_PA2 0xEC */
5040 "oem-pa3", /* VK_OEM_PA3 0xED */
5041 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5042 "cusel", /* VK_OEM_CUSEL 0xEF */
5043 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5044 "finish", /* VK_OEM_FINISH 0xF1 */
5045 "copy", /* VK_OEM_COPY 0xF2 */
5046 "auto", /* VK_OEM_AUTO 0xF3 */
5047 "enlw", /* VK_OEM_ENLW 0xF4 */
5048 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5049 "attn", /* VK_ATTN 0xF6 */
5050 "crsel", /* VK_CRSEL 0xF7 */
5051 "exsel", /* VK_EXSEL 0xF8 */
5052 "ereof", /* VK_EREOF 0xF9 */
5053 "play", /* VK_PLAY 0xFA */
5054 "zoom", /* VK_ZOOM 0xFB */
5055 "noname", /* VK_NONAME 0xFC */
5056 "pa1", /* VK_PA1 0xFD */
5057 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5061 /* Some of these duplicate the "Media keys" on newer keyboards,
5062 but they are delivered to the application in a different way. */
5063 static char *lispy_multimedia_keys
[] =
5071 "browser-favorites",
5108 "toggle-dictate-command",
5114 "media-fast-forward",
5117 "media-channel-down"
5120 #else /* not HAVE_NTGUI */
5122 /* This should be dealt with in XTread_socket now, and that doesn't
5123 depend on the client system having the Kana syms defined. See also
5124 the XK_kana_A case below. */
5127 static char *lispy_kana_keys
[] =
5129 /* X Keysym value */
5130 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5131 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5132 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5133 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5134 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5135 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5136 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5137 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5138 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5139 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5140 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5141 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5142 "kana-i", "kana-u", "kana-e", "kana-o",
5143 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5144 "prolongedsound", "kana-A", "kana-I", "kana-U",
5145 "kana-E", "kana-O", "kana-KA", "kana-KI",
5146 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5147 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5148 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5149 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5150 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5151 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5152 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5153 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5154 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5155 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5156 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5157 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5159 #endif /* XK_kana_A */
5162 #define FUNCTION_KEY_OFFSET 0xff00
5164 /* You'll notice that this table is arranged to be conveniently
5165 indexed by X Windows keysym values. */
5166 static char *lispy_function_keys
[] =
5168 /* X Keysym value */
5170 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5171 "backspace", "tab", "linefeed", "clear",
5173 0, 0, 0, "pause", /* 0xff10...1f */
5174 0, 0, 0, 0, 0, 0, 0, "escape",
5176 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5177 "romaji", "hiragana", "katakana", "hiragana-katakana",
5178 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5179 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5180 "eisu-toggle", /* 0xff30...3f */
5181 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5182 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5184 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5185 "down", "prior", "next", "end",
5186 "begin", 0, 0, 0, 0, 0, 0, 0,
5187 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5198 "break", /* 0xff6b */
5201 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5202 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5203 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5204 0, 0, 0, 0, 0, 0, 0, 0,
5205 "kp-tab", /* 0xff89 */
5207 "kp-enter", /* 0xff8d */
5209 "kp-f1", /* 0xff91 */
5213 "kp-home", /* 0xff95 */
5218 "kp-prior", /* kp-page-up */
5219 "kp-next", /* kp-page-down */
5225 0, 0, 0, 0, 0, 0, 0, 0, 0,
5226 "kp-multiply", /* 0xffaa */
5231 "kp-divide", /* 0xffaf */
5232 "kp-0", /* 0xffb0 */
5233 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5236 "kp-equal", /* 0xffbd */
5237 "f1", /* 0xffbe */ /* IsFunctionKey */
5239 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5240 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5241 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5242 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5243 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5244 0, 0, 0, 0, 0, 0, 0, 0,
5245 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5246 0, 0, 0, 0, 0, 0, 0, "delete"
5249 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5250 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5252 static char *iso_lispy_function_keys
[] =
5254 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5255 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5256 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5257 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5258 "iso-lefttab", /* 0xfe20 */
5259 "iso-move-line-up", "iso-move-line-down",
5260 "iso-partial-line-up", "iso-partial-line-down",
5261 "iso-partial-space-left", "iso-partial-space-right",
5262 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5263 "iso-release-margin-left", "iso-release-margin-right",
5264 "iso-release-both-margins",
5265 "iso-fast-cursor-left", "iso-fast-cursor-right",
5266 "iso-fast-cursor-up", "iso-fast-cursor-down",
5267 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5268 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5271 #endif /* not HAVE_NTGUI */
5273 Lisp_Object Vlispy_mouse_stem
;
5275 static char *lispy_wheel_names
[] =
5277 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5280 /* drag-n-drop events are generated when a set of selected files are
5281 dragged from another application and dropped onto an Emacs window. */
5282 static char *lispy_drag_n_drop_names
[] =
5287 /* Scroll bar parts. */
5288 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5289 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5290 Lisp_Object Qtop
, Qratio
;
5292 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5293 Lisp_Object
*scroll_bar_parts
[] = {
5294 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5295 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5298 /* A vector, indexed by button number, giving the down-going location
5299 of currently depressed buttons, both scroll bar and non-scroll bar.
5301 The elements have the form
5302 (BUTTON-NUMBER MODIFIER-MASK . REST)
5303 where REST is the cdr of a position as it would be reported in the event.
5305 The make_lispy_event function stores positions here to tell the
5306 difference between click and drag events, and to store the starting
5307 location to be included in drag events. */
5309 static Lisp_Object button_down_location
;
5311 /* Information about the most recent up-going button event: Which
5312 button, what location, and what time. */
5314 static int last_mouse_button
;
5315 static int last_mouse_x
;
5316 static int last_mouse_y
;
5317 static unsigned long button_down_time
;
5319 /* The maximum time between clicks to make a double-click, or Qnil to
5320 disable double-click detection, or Qt for no time limit. */
5322 Lisp_Object Vdouble_click_time
;
5324 /* Maximum number of pixels the mouse may be moved between clicks
5325 to make a double-click. */
5327 EMACS_INT double_click_fuzz
;
5329 /* The number of clicks in this multiple-click. */
5331 int double_click_count
;
5333 /* Return position of a mouse click or wheel event */
5336 make_lispy_position (f
, x
, y
, time
)
5342 enum window_part part
;
5343 Lisp_Object posn
= Qnil
;
5344 Lisp_Object extra_info
= Qnil
;
5347 /* Set `window' to the window under frame pixel coordinates (x,y) */
5349 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5350 &part
, &wx
, &wy
, 0);
5354 if (WINDOWP (window
))
5356 /* It's a click in window window at frame coordinates (x,y) */
5357 struct window
*w
= XWINDOW (window
);
5358 Lisp_Object string_info
= Qnil
;
5359 int textpos
= -1, rx
= -1, ry
= -1;
5360 int dx
= -1, dy
= -1;
5361 int width
= -1, height
= -1;
5362 Lisp_Object object
= Qnil
;
5364 /* Set event coordinates to window-relative coordinates
5365 for constructing the Lisp event below. */
5369 if (part
== ON_TEXT
)
5371 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5373 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5375 /* Mode line or header line. Look for a string under
5376 the mouse that may have a `local-map' property. */
5380 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5382 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5383 &object
, &dx
, &dy
, &width
, &height
);
5384 if (STRINGP (string
))
5385 string_info
= Fcons (string
, make_number (charpos
));
5386 if (w
== XWINDOW (selected_window
)
5387 && current_buffer
== XBUFFER (w
->buffer
))
5390 textpos
= XMARKER (w
->pointm
)->charpos
;
5392 else if (part
== ON_VERTICAL_BORDER
)
5394 posn
= Qvertical_line
;
5399 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5404 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5406 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5407 &object
, &dx
, &dy
, &width
, &height
);
5408 if (STRINGP (string
))
5409 string_info
= Fcons (string
, make_number (charpos
));
5410 if (part
== ON_LEFT_MARGIN
)
5413 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5415 else if (part
== ON_LEFT_FRINGE
)
5417 posn
= Qleft_fringe
;
5420 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5422 : window_box_width (w
, LEFT_MARGIN_AREA
));
5425 else if (part
== ON_RIGHT_FRINGE
)
5427 posn
= Qright_fringe
;
5430 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5431 + window_box_width (w
, TEXT_AREA
)
5432 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5433 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5439 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5440 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5445 Lisp_Object string2
, object2
= Qnil
;
5446 struct display_pos p
;
5448 int width2
, height2
;
5449 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5450 &object2
, &dx2
, &dy2
,
5452 textpos
= CHARPOS (p
.pos
);
5453 if (rx
< 0) rx
= wx
;
5454 if (ry
< 0) ry
= wy
;
5455 if (dx
< 0) dx
= dx2
;
5456 if (dy
< 0) dy
= dy2
;
5457 if (width
< 0) width
= width2
;
5458 if (height
< 0) height
= height2
;
5462 posn
= make_number (textpos
);
5463 if (STRINGP (string2
))
5464 string_info
= Fcons (string2
,
5465 make_number (CHARPOS (p
.string_pos
)));
5471 #ifdef HAVE_WINDOW_SYSTEM
5472 if (IMAGEP (object
))
5474 Lisp_Object image_map
, hotspot
;
5475 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5477 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5479 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5480 posn
= XCAR (hotspot
);
5485 extra_info
= Fcons (object
,
5486 Fcons (Fcons (make_number (dx
),
5488 Fcons (Fcons (make_number (width
),
5489 make_number (height
)),
5493 extra_info
= Fcons (string_info
,
5494 Fcons (make_number (textpos
),
5495 Fcons (Fcons (make_number (rx
),
5501 XSETFRAME (window
, f
);
5506 XSETFASTINT (*x
, 0);
5507 XSETFASTINT (*y
, 0);
5510 return Fcons (window
,
5512 Fcons (Fcons (*x
, *y
),
5513 Fcons (make_number (time
),
5517 /* Given a struct input_event, build the lisp event which represents
5518 it. If EVENT is 0, build a mouse movement event from the mouse
5519 movement buffer, which should have a movement event in it.
5521 Note that events must be passed to this function in the order they
5522 are received; this function stores the location of button presses
5523 in order to build drag events when the button is released. */
5526 make_lispy_event (event
)
5527 struct input_event
*event
;
5531 switch (SWITCH_ENUM_CAST (event
->kind
))
5533 /* A simple keystroke. */
5534 case ASCII_KEYSTROKE_EVENT
:
5535 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5537 Lisp_Object lispy_c
;
5538 int c
= event
->code
;
5539 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5542 eassert (c
== event
->code
);
5543 /* Turn ASCII characters into control characters
5545 if (event
->modifiers
& ctrl_modifier
)
5547 c
= make_ctrl_char (c
);
5548 event
->modifiers
&= ~ctrl_modifier
;
5552 /* Add in the other modifier bits. The shift key was taken care
5553 of by the X code. */
5554 c
|= (event
->modifiers
5555 & (meta_modifier
| alt_modifier
5556 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5557 /* Distinguish Shift-SPC from SPC. */
5558 if ((event
->code
) == 040
5559 && event
->modifiers
& shift_modifier
)
5560 c
|= shift_modifier
;
5561 button_down_time
= 0;
5562 XSETFASTINT (lispy_c
, c
);
5567 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5568 except that they are non-key events (last-nonmenu-event is nil). */
5569 case NS_NONKEY_EVENT
:
5572 /* A function key. The symbol may need to have modifier prefixes
5574 case NON_ASCII_KEYSTROKE_EVENT
:
5575 button_down_time
= 0;
5577 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5578 if (event
->code
== lispy_accent_codes
[i
])
5579 return modify_event_symbol (i
,
5581 Qfunction_key
, Qnil
,
5582 lispy_accent_keys
, &accent_key_syms
,
5583 (sizeof (lispy_accent_keys
)
5584 / sizeof (lispy_accent_keys
[0])));
5588 if (event
->code
>= 0x400 && event
->code
< 0x500)
5589 return modify_event_symbol (event
->code
- 0x400,
5590 event
->modifiers
& ~shift_modifier
,
5591 Qfunction_key
, Qnil
,
5592 lispy_kana_keys
, &func_key_syms
,
5593 (sizeof (lispy_kana_keys
)
5594 / sizeof (lispy_kana_keys
[0])));
5595 #endif /* XK_kana_A */
5598 #ifdef ISO_FUNCTION_KEY_OFFSET
5599 if (event
->code
< FUNCTION_KEY_OFFSET
5600 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5601 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5603 Qfunction_key
, Qnil
,
5604 iso_lispy_function_keys
, &func_key_syms
,
5605 (sizeof (iso_lispy_function_keys
)
5606 / sizeof (iso_lispy_function_keys
[0])));
5609 /* Handle system-specific or unknown keysyms. */
5610 if (event
->code
& (1 << 28)
5611 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5612 || (event
->code
- FUNCTION_KEY_OFFSET
5613 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5614 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5616 /* We need to use an alist rather than a vector as the cache
5617 since we can't make a vector long enuf. */
5618 if (NILP (current_kboard
->system_key_syms
))
5619 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5620 return modify_event_symbol (event
->code
,
5623 current_kboard
->Vsystem_key_alist
,
5624 0, ¤t_kboard
->system_key_syms
,
5628 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5630 Qfunction_key
, Qnil
,
5631 lispy_function_keys
, &func_key_syms
,
5632 (sizeof (lispy_function_keys
)
5633 / sizeof (lispy_function_keys
[0])));
5636 case MULTIMEDIA_KEY_EVENT
:
5637 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5638 / sizeof (lispy_multimedia_keys
[0]))
5639 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5641 return modify_event_symbol (event
->code
, event
->modifiers
,
5642 Qfunction_key
, Qnil
,
5643 lispy_multimedia_keys
, &func_key_syms
,
5644 (sizeof (lispy_multimedia_keys
)
5645 / sizeof (lispy_multimedia_keys
[0])));
5651 /* A mouse click. Figure out where it is, decide whether it's
5652 a press, click or drag, and build the appropriate structure. */
5653 case MOUSE_CLICK_EVENT
:
5654 #ifndef USE_TOOLKIT_SCROLL_BARS
5655 case SCROLL_BAR_CLICK_EVENT
:
5658 int button
= event
->code
;
5660 Lisp_Object position
;
5661 Lisp_Object
*start_pos_ptr
;
5662 Lisp_Object start_pos
;
5666 /* Build the position as appropriate for this mouse click. */
5667 if (event
->kind
== MOUSE_CLICK_EVENT
)
5669 struct frame
*f
= XFRAME (event
->frame_or_window
);
5670 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5674 /* Ignore mouse events that were made on frame that
5675 have been deleted. */
5676 if (! FRAME_LIVE_P (f
))
5679 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5680 /* EVENT->x and EVENT->y are frame-relative pixel
5681 coordinates at this place. Under old redisplay, COLUMN
5682 and ROW are set to frame relative glyph coordinates
5683 which are then used to determine whether this click is
5684 in a menu (non-toolkit version). */
5685 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5686 &column
, &row
, NULL
, 1);
5688 /* In the non-toolkit version, clicks on the menu bar
5689 are ordinary button events in the event buffer.
5690 Distinguish them, and invoke the menu.
5692 (In the toolkit version, the toolkit handles the menu bar
5693 and Emacs doesn't know about it until after the user
5694 makes a selection.) */
5695 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5696 && (event
->modifiers
& down_modifier
))
5698 Lisp_Object items
, item
;
5703 /* Activate the menu bar on the down event. If the
5704 up event comes in before the menu code can deal with it,
5706 if (! (event
->modifiers
& down_modifier
))
5710 /* Find the menu bar item under `column'. */
5712 items
= FRAME_MENU_BAR_ITEMS (f
);
5713 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5715 Lisp_Object pos
, string
;
5716 string
= AREF (items
, i
+ 1);
5717 pos
= AREF (items
, i
+ 3);
5720 if (column
>= XINT (pos
)
5721 && column
< XINT (pos
) + SCHARS (string
))
5723 item
= AREF (items
, i
);
5728 /* ELisp manual 2.4b says (x y) are window relative but
5729 code says they are frame-relative. */
5731 = Fcons (event
->frame_or_window
,
5733 Fcons (Fcons (event
->x
, event
->y
),
5734 Fcons (make_number (event
->timestamp
),
5737 return Fcons (item
, Fcons (position
, Qnil
));
5739 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5741 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5744 #ifndef USE_TOOLKIT_SCROLL_BARS
5747 /* It's a scrollbar click. */
5749 Lisp_Object portion_whole
;
5752 window
= event
->frame_or_window
;
5753 portion_whole
= Fcons (event
->x
, event
->y
);
5754 part
= *scroll_bar_parts
[(int) event
->part
];
5758 Fcons (Qvertical_scroll_bar
,
5759 Fcons (portion_whole
,
5760 Fcons (make_number (event
->timestamp
),
5761 Fcons (part
, Qnil
)))));
5763 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5765 if (button
>= ASIZE (button_down_location
))
5767 button_down_location
= larger_vector (button_down_location
,
5769 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5772 start_pos_ptr
= &AREF (button_down_location
, button
);
5773 start_pos
= *start_pos_ptr
;
5774 *start_pos_ptr
= Qnil
;
5777 /* On window-system frames, use the value of
5778 double-click-fuzz as is. On other frames, interpret it
5779 as a multiple of 1/8 characters. */
5783 if (WINDOWP (event
->frame_or_window
))
5784 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5785 else if (FRAMEP (event
->frame_or_window
))
5786 f
= XFRAME (event
->frame_or_window
);
5790 if (FRAME_WINDOW_P (f
))
5791 fuzz
= double_click_fuzz
;
5793 fuzz
= double_click_fuzz
/ 8;
5795 is_double
= (button
== last_mouse_button
5796 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5797 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5798 && button_down_time
!= 0
5799 && (EQ (Vdouble_click_time
, Qt
)
5800 || (INTEGERP (Vdouble_click_time
)
5801 && ((int)(event
->timestamp
- button_down_time
)
5802 < XINT (Vdouble_click_time
)))));
5805 last_mouse_button
= button
;
5806 last_mouse_x
= XINT (event
->x
);
5807 last_mouse_y
= XINT (event
->y
);
5809 /* If this is a button press, squirrel away the location, so
5810 we can decide later whether it was a click or a drag. */
5811 if (event
->modifiers
& down_modifier
)
5815 double_click_count
++;
5816 event
->modifiers
|= ((double_click_count
> 2)
5821 double_click_count
= 1;
5822 button_down_time
= event
->timestamp
;
5823 *start_pos_ptr
= Fcopy_alist (position
);
5824 ignore_mouse_drag_p
= 0;
5827 /* Now we're releasing a button - check the co-ordinates to
5828 see if this was a click or a drag. */
5829 else if (event
->modifiers
& up_modifier
)
5831 /* If we did not see a down before this up, ignore the up.
5832 Probably this happened because the down event chose a
5833 menu item. It would be an annoyance to treat the
5834 release of the button that chose the menu item as a
5837 if (!CONSP (start_pos
))
5840 event
->modifiers
&= ~up_modifier
;
5841 #if 0 /* Formerly we treated an up with no down as a click event. */
5842 if (!CONSP (start_pos
))
5843 event
->modifiers
|= click_modifier
;
5848 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5850 /* The third element of every position
5851 should be the (x,y) pair. */
5852 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5854 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5856 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5857 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5860 if (ignore_mouse_drag_p
)
5862 event
->modifiers
|= click_modifier
;
5863 ignore_mouse_drag_p
= 0;
5865 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5866 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5867 /* Maybe the mouse has moved a lot, caused scrolling, and
5868 eventually ended up at the same screen position (but
5869 not buffer position) in which case it is a drag, not
5871 /* FIXME: OTOH if the buffer position has changed
5872 because of a timer or process filter rather than
5873 because of mouse movement, it should be considered as
5874 a click. But mouse-drag-region completely ignores
5875 this case and it hasn't caused any real problem, so
5876 it's probably OK to ignore it as well. */
5877 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5878 /* Mouse hasn't moved (much). */
5879 event
->modifiers
|= click_modifier
;
5882 button_down_time
= 0;
5883 event
->modifiers
|= drag_modifier
;
5886 /* Don't check is_double; treat this as multiple
5887 if the down-event was multiple. */
5888 if (double_click_count
> 1)
5889 event
->modifiers
|= ((double_click_count
> 2)
5895 /* Every mouse event should either have the down_modifier or
5896 the up_modifier set. */
5900 /* Get the symbol we should use for the mouse click. */
5903 head
= modify_event_symbol (button
,
5905 Qmouse_click
, Vlispy_mouse_stem
,
5908 XVECTOR (mouse_syms
)->size
);
5909 if (event
->modifiers
& drag_modifier
)
5914 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5917 Fcons (make_number (double_click_count
),
5927 case HORIZ_WHEEL_EVENT
:
5929 Lisp_Object position
;
5932 /* Build the position as appropriate for this mouse click. */
5933 struct frame
*f
= XFRAME (event
->frame_or_window
);
5935 /* Ignore wheel events that were made on frame that have been
5937 if (! FRAME_LIVE_P (f
))
5940 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5943 /* Set double or triple modifiers to indicate the wheel speed. */
5945 /* On window-system frames, use the value of
5946 double-click-fuzz as is. On other frames, interpret it
5947 as a multiple of 1/8 characters. */
5952 if (WINDOWP (event
->frame_or_window
))
5953 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5954 else if (FRAMEP (event
->frame_or_window
))
5955 f
= XFRAME (event
->frame_or_window
);
5959 if (FRAME_WINDOW_P (f
))
5960 fuzz
= double_click_fuzz
;
5962 fuzz
= double_click_fuzz
/ 8;
5964 is_double
= (last_mouse_button
< 0
5965 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5966 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5967 && button_down_time
!= 0
5968 && (EQ (Vdouble_click_time
, Qt
)
5969 || (INTEGERP (Vdouble_click_time
)
5970 && ((int)(event
->timestamp
- button_down_time
)
5971 < XINT (Vdouble_click_time
)))));
5974 double_click_count
++;
5975 event
->modifiers
|= ((double_click_count
> 2)
5981 double_click_count
= 1;
5982 event
->modifiers
|= click_modifier
;
5985 button_down_time
= event
->timestamp
;
5986 /* Use a negative value to distinguish wheel from mouse button. */
5987 last_mouse_button
= -1;
5988 last_mouse_x
= XINT (event
->x
);
5989 last_mouse_y
= XINT (event
->y
);
5995 if (event
->modifiers
& up_modifier
)
5997 /* Emit a wheel-up event. */
5998 event
->modifiers
&= ~up_modifier
;
6001 else if (event
->modifiers
& down_modifier
)
6003 /* Emit a wheel-down event. */
6004 event
->modifiers
&= ~down_modifier
;
6008 /* Every wheel event should either have the down_modifier or
6009 the up_modifier set. */
6012 if (event
->kind
== HORIZ_WHEEL_EVENT
)
6015 /* Get the symbol we should use for the wheel event. */
6016 head
= modify_event_symbol (symbol_num
,
6022 ASIZE (wheel_syms
));
6025 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6028 Fcons (make_number (double_click_count
),
6037 #ifdef USE_TOOLKIT_SCROLL_BARS
6039 /* We don't have down and up events if using toolkit scroll bars,
6040 so make this always a click event. Store in the `part' of
6041 the Lisp event a symbol which maps to the following actions:
6043 `above_handle' page up
6044 `below_handle' page down
6048 `bottom' bottom of buffer
6049 `handle' thumb has been dragged.
6050 `end-scroll' end of interaction with scroll bar
6052 The incoming input_event contains in its `part' member an
6053 index of type `enum scroll_bar_part' which we can use as an
6054 index in scroll_bar_parts to get the appropriate symbol. */
6056 case SCROLL_BAR_CLICK_EVENT
:
6058 Lisp_Object position
, head
, window
, portion_whole
, part
;
6060 window
= event
->frame_or_window
;
6061 portion_whole
= Fcons (event
->x
, event
->y
);
6062 part
= *scroll_bar_parts
[(int) event
->part
];
6066 Fcons (Qvertical_scroll_bar
,
6067 Fcons (portion_whole
,
6068 Fcons (make_number (event
->timestamp
),
6069 Fcons (part
, Qnil
)))));
6071 /* Always treat scroll bar events as clicks. */
6072 event
->modifiers
|= click_modifier
;
6073 event
->modifiers
&= ~up_modifier
;
6075 if (event
->code
>= ASIZE (mouse_syms
))
6076 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6078 /* Get the symbol we should use for the mouse click. */
6079 head
= modify_event_symbol (event
->code
,
6084 XVECTOR (mouse_syms
)->size
);
6085 return Fcons (head
, Fcons (position
, Qnil
));
6088 #endif /* USE_TOOLKIT_SCROLL_BARS */
6090 case DRAG_N_DROP_EVENT
:
6093 Lisp_Object head
, position
;
6096 f
= XFRAME (event
->frame_or_window
);
6099 /* Ignore mouse events that were made on frames that
6100 have been deleted. */
6101 if (! FRAME_LIVE_P (f
))
6104 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6107 head
= modify_event_symbol (0, event
->modifiers
,
6109 lispy_drag_n_drop_names
,
6110 &drag_n_drop_syms
, 1);
6116 #endif /* HAVE_MOUSE */
6118 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6119 || defined(HAVE_NS) || defined (USE_GTK)
6120 case MENU_BAR_EVENT
:
6121 if (EQ (event
->arg
, event
->frame_or_window
))
6122 /* This is the prefix key. We translate this to
6123 `(menu_bar)' because the code in keyboard.c for menu
6124 events, which we use, relies on this. */
6125 return Fcons (Qmenu_bar
, Qnil
);
6129 case SELECT_WINDOW_EVENT
:
6130 /* Make an event (select-window (WINDOW)). */
6131 return Fcons (Qselect_window
,
6132 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6135 case TOOL_BAR_EVENT
:
6136 if (EQ (event
->arg
, event
->frame_or_window
))
6137 /* This is the prefix key. We translate this to
6138 `(tool_bar)' because the code in keyboard.c for tool bar
6139 events, which we use, relies on this. */
6140 return Fcons (Qtool_bar
, Qnil
);
6141 else if (SYMBOLP (event
->arg
))
6142 return apply_modifiers (event
->modifiers
, event
->arg
);
6145 case USER_SIGNAL_EVENT
:
6146 /* A user signal. */
6148 char *name
= find_user_signal_name (event
->code
);
6151 return intern (name
);
6154 case SAVE_SESSION_EVENT
:
6155 return Qsave_session
;
6160 return Fcons (Qdbus_event
, event
->arg
);
6162 #endif /* HAVE_DBUS */
6165 case GPM_CLICK_EVENT
:
6167 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6168 Lisp_Object head
, position
;
6169 Lisp_Object
*start_pos_ptr
;
6170 Lisp_Object start_pos
;
6171 int button
= event
->code
;
6173 if (button
>= ASIZE (button_down_location
))
6175 button_down_location
= larger_vector (button_down_location
,
6177 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6180 start_pos_ptr
= &AREF (button_down_location
, button
);
6181 start_pos
= *start_pos_ptr
;
6183 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6186 if (event
->modifiers
& down_modifier
)
6187 *start_pos_ptr
= Fcopy_alist (position
);
6188 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6190 if (!CONSP (start_pos
))
6192 event
->modifiers
&= ~up_modifier
;
6195 head
= modify_event_symbol (button
,
6197 Qmouse_click
, Vlispy_mouse_stem
,
6200 XVECTOR (mouse_syms
)->size
);
6202 if (event
->modifiers
& drag_modifier
)
6207 else if (event
->modifiers
& double_modifier
)
6210 Fcons (make_number (2),
6212 else if (event
->modifiers
& triple_modifier
)
6215 Fcons (make_number (3),
6222 #endif /* HAVE_GPM */
6224 /* The 'kind' field of the event is something we don't recognize. */
6230 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6233 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6235 Lisp_Object bar_window
;
6236 enum scroll_bar_part part
;
6240 /* Is it a scroll bar movement? */
6241 if (frame
&& ! NILP (bar_window
))
6243 Lisp_Object part_sym
;
6245 part_sym
= *scroll_bar_parts
[(int) part
];
6246 return Fcons (Qscroll_bar_movement
,
6247 (Fcons (Fcons (bar_window
,
6248 Fcons (Qvertical_scroll_bar
,
6249 Fcons (Fcons (x
, y
),
6250 Fcons (make_number (time
),
6256 /* Or is it an ordinary mouse movement? */
6259 Lisp_Object position
;
6261 position
= make_lispy_position (frame
, &x
, &y
, time
);
6263 return Fcons (Qmouse_movement
,
6269 #endif /* HAVE_MOUSE || HAVE GPM */
6271 /* Construct a switch frame event. */
6273 make_lispy_switch_frame (frame
)
6276 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6279 /* Manipulating modifiers. */
6281 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6283 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6284 SYMBOL's name of the end of the modifiers; the string from this
6285 position is the unmodified symbol name.
6287 This doesn't use any caches. */
6290 parse_modifiers_uncached (symbol
, modifier_end
)
6298 CHECK_SYMBOL (symbol
);
6301 name
= SYMBOL_NAME (symbol
);
6303 for (i
= 0; i
+2 <= SBYTES (name
); )
6305 int this_mod_end
= 0;
6308 /* See if the name continues with a modifier word.
6309 Check that the word appears, but don't check what follows it.
6310 Set this_mod and this_mod_end to record what we find. */
6312 switch (SREF (name
, i
))
6314 #define SINGLE_LETTER_MOD(BIT) \
6315 (this_mod_end = i + 1, this_mod = BIT)
6318 SINGLE_LETTER_MOD (alt_modifier
);
6322 SINGLE_LETTER_MOD (ctrl_modifier
);
6326 SINGLE_LETTER_MOD (hyper_modifier
);
6330 SINGLE_LETTER_MOD (meta_modifier
);
6334 SINGLE_LETTER_MOD (shift_modifier
);
6338 SINGLE_LETTER_MOD (super_modifier
);
6341 #undef SINGLE_LETTER_MOD
6343 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6344 if (i + LEN + 1 <= SBYTES (name) \
6345 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6347 this_mod_end = i + LEN; \
6352 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6353 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6354 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6358 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6360 #undef MULTI_LETTER_MOD
6364 /* If we found no modifier, stop looking for them. */
6365 if (this_mod_end
== 0)
6368 /* Check there is a dash after the modifier, so that it
6369 really is a modifier. */
6370 if (this_mod_end
>= SBYTES (name
)
6371 || SREF (name
, this_mod_end
) != '-')
6374 /* This modifier is real; look for another. */
6375 modifiers
|= this_mod
;
6376 i
= this_mod_end
+ 1;
6379 /* Should we include the `click' modifier? */
6380 if (! (modifiers
& (down_modifier
| drag_modifier
6381 | double_modifier
| triple_modifier
))
6382 && i
+ 7 == SBYTES (name
)
6383 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6384 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6385 modifiers
|= click_modifier
;
6387 if (! (modifiers
& (double_modifier
| triple_modifier
))
6388 && i
+ 6 < SBYTES (name
)
6389 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6390 modifiers
|= click_modifier
;
6398 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6399 prepended to the string BASE[0..BASE_LEN-1].
6400 This doesn't use any caches. */
6402 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6405 int base_len
, base_len_byte
;
6407 /* Since BASE could contain nulls, we can't use intern here; we have
6408 to use Fintern, which expects a genuine Lisp_String, and keeps a
6411 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6417 /* Only the event queue may use the `up' modifier; it should always
6418 be turned into a click or drag event before presented to lisp code. */
6419 if (modifiers
& up_modifier
)
6422 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6423 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6424 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6425 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6426 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6427 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6428 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6429 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6430 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6431 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6432 /* The click modifier is denoted by the absence of other modifiers. */
6436 mod_len
= p
- new_mods
;
6440 Lisp_Object new_name
;
6442 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6443 mod_len
+ base_len_byte
);
6444 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6445 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6447 return Fintern (new_name
, Qnil
);
6452 static char *modifier_names
[] =
6454 "up", "down", "drag", "click", "double", "triple", 0, 0,
6455 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6456 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6458 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6460 static Lisp_Object modifier_symbols
;
6462 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6464 lispy_modifier_list (modifiers
)
6467 Lisp_Object modifier_list
;
6470 modifier_list
= Qnil
;
6471 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6472 if (modifiers
& (1<<i
))
6473 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6476 return modifier_list
;
6480 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6481 where UNMODIFIED is the unmodified form of SYMBOL,
6482 MASK is the set of modifiers present in SYMBOL's name.
6483 This is similar to parse_modifiers_uncached, but uses the cache in
6484 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6485 Qevent_symbol_elements property. */
6487 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6490 parse_modifiers (symbol
)
6493 Lisp_Object elements
;
6495 if (INTEGERP (symbol
))
6496 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6497 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6499 else if (!SYMBOLP (symbol
))
6502 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6503 if (CONSP (elements
))
6508 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6509 Lisp_Object unmodified
;
6512 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6513 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6516 if (modifiers
& ~INTMASK
)
6518 XSETFASTINT (mask
, modifiers
);
6519 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6521 /* Cache the parsing results on SYMBOL. */
6522 Fput (symbol
, Qevent_symbol_element_mask
,
6524 Fput (symbol
, Qevent_symbol_elements
,
6525 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6527 /* Since we know that SYMBOL is modifiers applied to unmodified,
6528 it would be nice to put that in unmodified's cache.
6529 But we can't, since we're not sure that parse_modifiers is
6536 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6537 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6538 doc
: /* Parse the event symbol. For internal use. */)
6542 /* Fill the cache if needed. */
6543 parse_modifiers (symbol
);
6544 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6545 and use the Lispier representation stored on Qevent_symbol_elements
6547 return Fget (symbol
, Qevent_symbol_elements
);
6550 /* Apply the modifiers MODIFIERS to the symbol BASE.
6551 BASE must be unmodified.
6553 This is like apply_modifiers_uncached, but uses BASE's
6554 Qmodifier_cache property, if present. It also builds
6555 Qevent_symbol_elements properties, since it has that info anyway.
6557 apply_modifiers copies the value of BASE's Qevent_kind property to
6558 the modified symbol. */
6560 apply_modifiers (modifiers
, base
)
6564 Lisp_Object cache
, index
, entry
, new_symbol
;
6566 /* Mask out upper bits. We don't know where this value's been. */
6567 modifiers
&= INTMASK
;
6569 if (INTEGERP (base
))
6570 return make_number (XINT (base
) | modifiers
);
6572 /* The click modifier never figures into cache indices. */
6573 cache
= Fget (base
, Qmodifier_cache
);
6574 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6575 entry
= assq_no_quit (index
, cache
);
6578 new_symbol
= XCDR (entry
);
6581 /* We have to create the symbol ourselves. */
6582 new_symbol
= apply_modifiers_uncached (modifiers
,
6583 SDATA (SYMBOL_NAME (base
)),
6584 SCHARS (SYMBOL_NAME (base
)),
6585 SBYTES (SYMBOL_NAME (base
)));
6587 /* Add the new symbol to the base's cache. */
6588 entry
= Fcons (index
, new_symbol
);
6589 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6591 /* We have the parsing info now for free, so we could add it to
6593 XSETFASTINT (index, modifiers);
6594 Fput (new_symbol, Qevent_symbol_element_mask,
6595 Fcons (base, Fcons (index, Qnil)));
6596 Fput (new_symbol, Qevent_symbol_elements,
6597 Fcons (base, lispy_modifier_list (modifiers)));
6598 Sadly, this is only correct if `base' is indeed a base event,
6599 which is not necessarily the case. -stef */
6602 /* Make sure this symbol is of the same kind as BASE.
6604 You'd think we could just set this once and for all when we
6605 intern the symbol above, but reorder_modifiers may call us when
6606 BASE's property isn't set right; we can't assume that just
6607 because it has a Qmodifier_cache property it must have its
6608 Qevent_kind set right as well. */
6609 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6613 kind
= Fget (base
, Qevent_kind
);
6615 Fput (new_symbol
, Qevent_kind
, kind
);
6622 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6623 return a symbol with the modifiers placed in the canonical order.
6624 Canonical order is alphabetical, except for down and drag, which
6625 always come last. The 'click' modifier is never written out.
6627 Fdefine_key calls this to make sure that (for example) C-M-foo
6628 and M-C-foo end up being equivalent in the keymap. */
6631 reorder_modifiers (symbol
)
6634 /* It's hopefully okay to write the code this way, since everything
6635 will soon be in caches, and no consing will be done at all. */
6638 parsed
= parse_modifiers (symbol
);
6639 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6644 /* For handling events, we often want to produce a symbol whose name
6645 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6646 to some base, like the name of a function key or mouse button.
6647 modify_event_symbol produces symbols of this sort.
6649 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6650 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6653 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6654 into symbol names, or a string specifying a name stem used to
6655 construct a symbol name or the form `STEM-N', where N is the decimal
6656 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6657 non-nil; otherwise NAME_TABLE is used.
6659 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6660 persist between calls to modify_event_symbol that it can use to
6661 store a cache of the symbols it's generated for this NAME_TABLE
6662 before. The object stored there may be a vector or an alist.
6664 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6666 MODIFIERS is a set of modifier bits (as given in struct input_events)
6667 whose prefixes should be applied to the symbol name.
6669 SYMBOL_KIND is the value to be placed in the event_kind property of
6670 the returned symbol.
6672 The symbols we create are supposed to have an
6673 `event-symbol-elements' property, which lists the modifiers present
6674 in the symbol's name. */
6677 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6678 name_table
, symbol_table
, table_size
)
6681 Lisp_Object symbol_kind
;
6682 Lisp_Object name_alist_or_stem
;
6684 Lisp_Object
*symbol_table
;
6685 unsigned int table_size
;
6688 Lisp_Object symbol_int
;
6690 /* Get rid of the "vendor-specific" bit here. */
6691 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6693 /* Is this a request for a valid symbol? */
6694 if (symbol_num
< 0 || symbol_num
>= table_size
)
6697 if (CONSP (*symbol_table
))
6698 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6700 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6701 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6702 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6703 we've never used that symbol before. */
6706 if (! VECTORP (*symbol_table
)
6707 || XVECTOR (*symbol_table
)->size
!= table_size
)
6711 XSETFASTINT (size
, table_size
);
6712 *symbol_table
= Fmake_vector (size
, Qnil
);
6715 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6718 /* Have we already used this symbol before? */
6721 /* No; let's create it. */
6722 if (CONSP (name_alist_or_stem
))
6723 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6724 else if (STRINGP (name_alist_or_stem
))
6726 int len
= SBYTES (name_alist_or_stem
);
6727 char *buf
= (char *) alloca (len
+ 50);
6728 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6729 (long) XINT (symbol_int
) + 1);
6730 value
= intern (buf
);
6732 else if (name_table
!= 0 && name_table
[symbol_num
])
6733 value
= intern (name_table
[symbol_num
]);
6735 #ifdef HAVE_WINDOW_SYSTEM
6738 char *name
= x_get_keysym_name (symbol_num
);
6740 value
= intern (name
);
6747 sprintf (buf
, "key-%d", symbol_num
);
6748 value
= intern (buf
);
6751 if (CONSP (*symbol_table
))
6752 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6754 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6756 /* Fill in the cache entries for this symbol; this also
6757 builds the Qevent_symbol_elements property, which the user
6759 apply_modifiers (modifiers
& click_modifier
, value
);
6760 Fput (value
, Qevent_kind
, symbol_kind
);
6763 /* Apply modifiers to that symbol. */
6764 return apply_modifiers (modifiers
, value
);
6767 /* Convert a list that represents an event type,
6768 such as (ctrl meta backspace), into the usual representation of that
6769 event type as a number or a symbol. */
6771 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6772 doc
: /* Convert the event description list EVENT-DESC to an event type.
6773 EVENT-DESC should contain one base event type (a character or symbol)
6774 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6775 drag, down, double or triple). The base must be last.
6776 The return value is an event type (a character or symbol) which
6777 has the same base event type and all the specified modifiers. */)
6779 Lisp_Object event_desc
;
6787 while (CONSP (rest
))
6795 /* Given a symbol, see if it is a modifier name. */
6796 if (SYMBOLP (elt
) && CONSP (rest
))
6797 this = parse_solitary_modifier (elt
);
6801 else if (!NILP (base
))
6802 error ("Two bases given in one event");
6808 /* Let the symbol A refer to the character A. */
6809 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6810 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6812 if (INTEGERP (base
))
6814 /* Turn (shift a) into A. */
6815 if ((modifiers
& shift_modifier
) != 0
6816 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6818 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6819 modifiers
&= ~shift_modifier
;
6822 /* Turn (control a) into C-a. */
6823 if (modifiers
& ctrl_modifier
)
6824 return make_number ((modifiers
& ~ctrl_modifier
)
6825 | make_ctrl_char (XINT (base
)));
6827 return make_number (modifiers
| XINT (base
));
6829 else if (SYMBOLP (base
))
6830 return apply_modifiers (modifiers
, base
);
6833 error ("Invalid base event");
6838 /* Try to recognize SYMBOL as a modifier name.
6839 Return the modifier flag bit, or 0 if not recognized. */
6842 parse_solitary_modifier (Lisp_Object symbol
)
6844 Lisp_Object name
= SYMBOL_NAME (symbol
);
6846 switch (SREF (name
, 0))
6848 #define SINGLE_LETTER_MOD(BIT) \
6849 if (SBYTES (name) == 1) \
6852 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6853 if (LEN == SBYTES (name) \
6854 && ! strncmp (SDATA (name), NAME, LEN)) \
6858 SINGLE_LETTER_MOD (alt_modifier
);
6862 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6866 SINGLE_LETTER_MOD (ctrl_modifier
);
6870 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6871 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6875 SINGLE_LETTER_MOD (hyper_modifier
);
6879 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6883 SINGLE_LETTER_MOD (meta_modifier
);
6887 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6891 SINGLE_LETTER_MOD (shift_modifier
);
6895 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6896 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6897 SINGLE_LETTER_MOD (super_modifier
);
6901 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6902 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6903 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6907 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6910 #undef SINGLE_LETTER_MOD
6911 #undef MULTI_LETTER_MOD
6917 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6918 Such a list is not valid as an event,
6919 but it can be a Lucid-style event type list. */
6922 lucid_event_type_list_p (object
)
6927 if (! CONSP (object
))
6930 if (EQ (XCAR (object
), Qhelp_echo
)
6931 || EQ (XCAR (object
), Qvertical_line
)
6932 || EQ (XCAR (object
), Qmode_line
)
6933 || EQ (XCAR (object
), Qheader_line
))
6936 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6940 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6947 /* Store into *addr a value nonzero if terminal input chars are available.
6948 Serves the purpose of ioctl (0, FIONREAD, addr)
6949 but works even if FIONREAD does not exist.
6950 (In fact, this may actually read some input.)
6952 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6953 timer events that are ripe.
6954 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6955 events (FOCUS_IN_EVENT).
6956 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6957 movements and toolkit scroll bar thumb drags. */
6960 get_input_pending (addr
, flags
)
6964 /* First of all, have we already counted some input? */
6965 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6967 /* If input is being read as it arrives, and we have none, there is none. */
6968 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6971 /* Try to read some input and see how much we get. */
6973 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6976 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6979 gobble_input (expected
)
6983 /* Check whether a D-Bus message has arrived. */
6984 xd_read_queued_messages ();
6985 #endif /* HAVE_DBUS */
6988 if (interrupt_input
)
6991 mask
= sigblock (sigmask (SIGIO
));
6992 read_avail_input (expected
);
6996 #ifdef POLL_FOR_INPUT
6997 /* XXX This condition was (read_socket_hook && !interrupt_input),
6998 but read_socket_hook is not global anymore. Let's pretend that
7000 if (!interrupt_input
&& poll_suppress_count
== 0)
7003 mask
= sigblock (sigmask (SIGALRM
));
7004 read_avail_input (expected
);
7010 read_avail_input (expected
);
7013 /* Put a BUFFER_SWITCH_EVENT in the buffer
7014 so that read_key_sequence will notice the new current buffer. */
7017 record_asynch_buffer_change ()
7019 struct input_event event
;
7023 event
.kind
= BUFFER_SWITCH_EVENT
;
7024 event
.frame_or_window
= Qnil
;
7028 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7029 The purpose of the event is to make read_key_sequence look up the
7030 keymaps again. If we aren't in read_key_sequence, we don't need one,
7031 and the event could cause trouble by messing up (input-pending-p). */
7032 tem
= Fwaiting_for_user_input_p ();
7036 /* We never need these events if we have no asynchronous subprocesses. */
7040 /* Make sure no interrupt happens while storing the event. */
7042 if (interrupt_input
)
7045 mask
= sigblock (sigmask (SIGIO
));
7046 kbd_buffer_store_event (&event
);
7053 kbd_buffer_store_event (&event
);
7058 /* Read any terminal input already buffered up by the system
7059 into the kbd_buffer, but do not wait.
7061 EXPECTED should be nonzero if the caller knows there is some input.
7063 Returns the number of keyboard chars read, or -1 meaning
7064 this is a bad time to try to read input. */
7067 read_avail_input (expected
)
7074 /* Store pending user signal events, if any. */
7075 if (store_user_signal_events ())
7078 /* Loop through the available terminals, and call their input hooks. */
7082 struct terminal
*next
= t
->next_terminal
;
7084 if (t
->read_socket_hook
)
7087 struct input_event hold_quit
;
7089 EVENT_INIT (hold_quit
);
7090 hold_quit
.kind
= NO_EVENT
;
7092 /* No need for FIONREAD or fcntl; just say don't wait. */
7093 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7099 if (nr
== -1) /* Not OK to read input now. */
7103 else if (nr
== -2) /* Non-transient error. */
7105 /* The terminal device terminated; it should be closed. */
7107 /* Kill Emacs if this was our last terminal. */
7108 if (!terminal_list
->next_terminal
)
7109 /* Formerly simply reported no input, but that
7110 sometimes led to a failure of Emacs to terminate.
7111 SIGHUP seems appropriate if we can't reach the
7113 /* ??? Is it really right to send the signal just to
7114 this process rather than to the whole process
7115 group? Perhaps on systems with FIONREAD Emacs is
7116 alone in its group. */
7117 kill (getpid (), SIGHUP
);
7119 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7122 XSETTERMINAL (tmp
, t
);
7123 Fdelete_terminal (tmp
, Qnoelisp
);
7127 if (hold_quit
.kind
!= NO_EVENT
)
7128 kbd_buffer_store_event (&hold_quit
);
7140 /* This is the tty way of reading available input.
7142 Note that each terminal device has its own `struct terminal' object,
7143 and so this function is called once for each individual termcap
7144 terminal. The first parameter indicates which terminal to read from. */
7147 tty_read_avail_input (struct terminal
*terminal
,
7149 struct input_event
*hold_quit
)
7151 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7152 the kbd_buffer can really hold. That may prevent loss
7153 of characters on some systems when input is stuffed at us. */
7154 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7156 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7159 if (!terminal
->name
) /* Don't read from a dead terminal. */
7162 if (terminal
->type
!= output_termcap
7163 && terminal
->type
!= output_msdos_raw
)
7166 /* XXX I think the following code should be moved to separate hook
7167 functions in system-dependent files. */
7170 #else /* not WINDOWSNT */
7171 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7175 return 0; /* The terminal is suspended. */
7178 n_to_read
= dos_keysns ();
7182 cbuf
[0] = dos_keyread ();
7185 #else /* not MSDOS */
7190 struct input_event hold_quit
;
7191 int gpm
, fd
= gpm_fd
;
7193 EVENT_INIT (hold_quit
);
7194 hold_quit
.kind
= NO_EVENT
;
7196 /* gpm==1 if event received.
7197 gpm==0 if the GPM daemon has closed the connection, in which case
7198 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7199 we save it in `fd' so close_gpm can remove it from the
7201 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7202 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7203 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7206 /* Presumably the GPM daemon has closed the connection. */
7208 if (hold_quit
.kind
!= NO_EVENT
)
7209 kbd_buffer_store_event (&hold_quit
);
7213 #endif /* HAVE_GPM */
7215 /* Determine how many characters we should *try* to read. */
7217 /* Find out how much input is available. */
7218 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7220 if (! noninteractive
)
7221 return -2; /* Close this terminal. */
7227 if (n_to_read
> sizeof cbuf
)
7228 n_to_read
= sizeof cbuf
;
7229 #else /* no FIONREAD */
7230 #if defined (USG) || defined(CYGWIN)
7231 /* Read some input if available, but don't wait. */
7232 n_to_read
= sizeof cbuf
;
7233 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7239 /* Now read; for one reason or another, this will not block.
7240 NREAD is set to the number of chars read. */
7243 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7244 /* POSIX infers that processes which are not in the session leader's
7245 process group won't get SIGHUP's at logout time. BSDI adheres to
7246 this part standard and returns -1 from read (0) with errno==EIO
7247 when the control tty is taken away.
7248 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7249 if (nread
== -1 && errno
== EIO
)
7250 return -2; /* Close this terminal. */
7251 #if defined (AIX) && defined (_BSD)
7252 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7253 This looks incorrect, but it isn't, because _BSD causes
7254 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7255 and that causes a value other than 0 when there is no input. */
7257 return -2; /* Close this terminal. */
7261 /* We used to retry the read if it was interrupted.
7262 But this does the wrong thing when O_NDELAY causes
7263 an EAGAIN error. Does anybody know of a situation
7264 where a retry is actually needed? */
7266 nread
< 0 && (errno
== EAGAIN
7280 #if defined (USG) || defined (CYGWIN)
7281 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7282 #endif /* USG or CYGWIN */
7283 #endif /* no FIONREAD */
7288 #endif /* not MSDOS */
7289 #endif /* not WINDOWSNT */
7291 for (i
= 0; i
< nread
; i
++)
7293 struct input_event buf
;
7295 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7297 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7298 buf
.modifiers
= meta_modifier
;
7299 if (tty
->meta_key
!= 2)
7303 /* Set the frame corresponding to the active tty. Note that the
7304 value of selected_frame is not reliable here, redisplay tends
7305 to temporarily change it. */
7306 buf
.frame_or_window
= tty
->top_frame
;
7309 kbd_buffer_store_event (&buf
);
7310 /* Don't look at input that follows a C-g too closely.
7311 This reduces lossage due to autorepeat on C-g. */
7312 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7313 && buf
.code
== quit_char
)
7321 handle_async_input ()
7323 interrupt_input_pending
= 0;
7325 pending_signals
= pending_atimers
;
7327 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7328 doing anything dangerous. */
7335 nread
= read_avail_input (1);
7336 /* -1 means it's not ok to read the input now.
7337 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7338 0 means there was no keyboard input available. */
7348 process_pending_signals ()
7350 if (interrupt_input_pending
)
7351 handle_async_input ();
7352 do_pending_atimers ();
7355 #ifdef SIGIO /* for entire page */
7356 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7359 input_available_signal (signo
)
7362 /* Must preserve main program's value of errno. */
7363 int old_errno
= errno
;
7364 #if defined (USG) && !defined (POSIX_SIGNALS)
7365 /* USG systems forget handlers when they are used;
7366 must reestablish each time */
7367 signal (signo
, input_available_signal
);
7371 interrupt_input_pending
= 1;
7372 pending_signals
= 1;
7374 SIGNAL_THREAD_CHECK (signo
);
7377 if (input_available_clear_time
)
7378 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7381 handle_async_input ();
7388 /* Send ourselves a SIGIO.
7390 This function exists so that the UNBLOCK_INPUT macro in
7391 blockinput.h can have some way to take care of input we put off
7392 dealing with, without assuming that every file which uses
7393 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7395 reinvoke_input_signal ()
7398 handle_async_input ();
7404 /* User signal events. */
7406 struct user_signal_info
7408 /* Signal number. */
7411 /* Name of the signal. */
7414 /* Number of pending signals. */
7417 struct user_signal_info
*next
;
7420 /* List of user signals. */
7421 static struct user_signal_info
*user_signals
= NULL
;
7424 add_user_signal (sig
, name
)
7428 struct user_signal_info
*p
;
7430 for (p
= user_signals
; p
; p
= p
->next
)
7432 /* Already added. */
7435 p
= xmalloc (sizeof (struct user_signal_info
));
7437 p
->name
= xstrdup (name
);
7439 p
->next
= user_signals
;
7442 signal (sig
, handle_user_signal
);
7446 handle_user_signal (sig
)
7449 int old_errno
= errno
;
7450 struct user_signal_info
*p
;
7452 #if defined (USG) && !defined (POSIX_SIGNALS)
7453 /* USG systems forget handlers when they are used;
7454 must reestablish each time */
7455 signal (sig
, handle_user_signal
);
7458 SIGNAL_THREAD_CHECK (sig
);
7460 for (p
= user_signals
; p
; p
= p
->next
)
7465 if (interrupt_input
)
7466 kill (getpid (), SIGIO
);
7470 /* Tell wait_reading_process_output that it needs to wake
7471 up and look around. */
7472 if (input_available_clear_time
)
7473 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7482 find_user_signal_name (sig
)
7485 struct user_signal_info
*p
;
7487 for (p
= user_signals
; p
; p
= p
->next
)
7495 store_user_signal_events ()
7497 struct user_signal_info
*p
;
7498 struct input_event buf
;
7501 for (p
= user_signals
; p
; p
= p
->next
)
7502 if (p
->npending
> 0)
7508 bzero (&buf
, sizeof buf
);
7509 buf
.kind
= USER_SIGNAL_EVENT
;
7510 buf
.frame_or_window
= selected_frame
;
7512 nstored
+= p
->npending
;
7514 mask
= sigblock (sigmask (p
->sig
));
7518 kbd_buffer_store_event (&buf
);
7521 while (p
->npending
> 0);
7529 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7530 static Lisp_Object menu_bar_one_keymap_changed_items
;
7532 /* These variables hold the vector under construction within
7533 menu_bar_items and its subroutines, and the current index
7534 for storing into that vector. */
7535 static Lisp_Object menu_bar_items_vector
;
7536 static int menu_bar_items_index
;
7538 /* Return a vector of menu items for a menu bar, appropriate
7539 to the current buffer. Each item has three elements in the vector:
7542 OLD is an old vector we can optionally reuse, or nil. */
7545 menu_bar_items (old
)
7548 /* The number of keymaps we're scanning right now, and the number of
7549 keymaps we have allocated space for. */
7552 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7553 in the current keymaps, or nil where it is not a prefix. */
7556 Lisp_Object def
, tail
;
7565 /* In order to build the menus, we need to call the keymap
7566 accessors. They all call QUIT. But this function is called
7567 during redisplay, during which a quit is fatal. So inhibit
7568 quitting while building the menus.
7569 We do this instead of specbind because (1) errors will clear it anyway
7570 and (2) this avoids risk of specpdl overflow. */
7571 oquit
= Vinhibit_quit
;
7575 menu_bar_items_vector
= old
;
7577 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7578 menu_bar_items_index
= 0;
7580 /* Build our list of keymaps.
7581 If we recognize a function key and replace its escape sequence in
7582 keybuf with its symbol, or if the sequence starts with a mouse
7583 click and we need to switch buffers, we jump back here to rebuild
7584 the initial keymaps from the current buffer. */
7588 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7589 if (!NILP (Voverriding_local_map_menu_flag
))
7591 /* Yes, use them (if non-nil) as well as the global map. */
7592 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7594 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7595 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7596 if (!NILP (Voverriding_local_map
))
7597 maps
[nmaps
++] = Voverriding_local_map
;
7601 /* No, so use major and minor mode keymaps and keymap property.
7602 Note that menu-bar bindings in the local-map and keymap
7603 properties may not work reliable, as they are only
7604 recognized when the menu-bar (or mode-line) is updated,
7605 which does not normally happen after every command. */
7608 nminor
= current_minor_maps (NULL
, &tmaps
);
7609 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7611 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7612 maps
[nmaps
++] = tem
;
7613 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7615 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7617 maps
[nmaps
++] = current_global_map
;
7620 /* Look up in each map the dummy prefix key `menu-bar'. */
7624 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7625 if (!NILP (maps
[mapno
]))
7627 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7631 menu_bar_one_keymap_changed_items
= Qnil
;
7632 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7636 /* Move to the end those items that should be at the end. */
7638 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7641 int end
= menu_bar_items_index
;
7643 for (i
= 0; i
< end
; i
+= 4)
7644 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7646 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7647 /* Move the item at index I to the end,
7648 shifting all the others forward. */
7649 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7650 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7651 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7652 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7654 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7655 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7656 (end
- i
- 4) * sizeof (Lisp_Object
));
7657 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7658 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7659 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7660 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7665 /* Add nil, nil, nil, nil at the end. */
7666 i
= menu_bar_items_index
;
7667 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7668 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7669 /* Add this item. */
7670 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7671 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7672 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7673 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7674 menu_bar_items_index
= i
;
7676 Vinhibit_quit
= oquit
;
7677 return menu_bar_items_vector
;
7680 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7681 If there's already an item for KEY, add this DEF to it. */
7683 Lisp_Object item_properties
;
7686 menu_bar_item (key
, item
, dummy1
, dummy2
)
7687 Lisp_Object key
, item
, dummy1
;
7690 struct gcpro gcpro1
;
7694 if (EQ (item
, Qundefined
))
7696 /* If a map has an explicit `undefined' as definition,
7697 discard any previously made menu bar item. */
7699 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7700 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7702 if (menu_bar_items_index
> i
+ 4)
7703 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7704 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7705 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7706 menu_bar_items_index
-= 4;
7710 /* If this keymap has already contributed to this KEY,
7711 don't contribute to it a second time. */
7712 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7713 if (!NILP (tem
) || NILP (item
))
7716 menu_bar_one_keymap_changed_items
7717 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7719 /* We add to menu_bar_one_keymap_changed_items before doing the
7720 parse_menu_item, so that if it turns out it wasn't a menu item,
7721 it still correctly hides any further menu item. */
7723 i
= parse_menu_item (item
, 0, 1);
7728 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7730 /* Find any existing item for this KEY. */
7731 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7732 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7735 /* If we did not find this KEY, add it at the end. */
7736 if (i
== menu_bar_items_index
)
7738 /* If vector is too small, get a bigger one. */
7739 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7740 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7741 /* Add this item. */
7742 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7743 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7744 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7745 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7746 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7747 menu_bar_items_index
= i
;
7749 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7753 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7754 /* If the new and the old items are not both keymaps,
7755 the lookup will only find `item'. */
7756 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7757 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7761 /* This is used as the handler when calling menu_item_eval_property. */
7763 menu_item_eval_property_1 (arg
)
7766 /* If we got a quit from within the menu computation,
7767 quit all the way out of it. This takes care of C-] in the debugger. */
7768 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7769 Fsignal (Qquit
, Qnil
);
7774 /* Evaluate an expression and return the result (or nil if something
7775 went wrong). Used to evaluate dynamic parts of menu items. */
7777 menu_item_eval_property (sexpr
)
7780 int count
= SPECPDL_INDEX ();
7782 specbind (Qinhibit_redisplay
, Qt
);
7783 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7784 menu_item_eval_property_1
);
7785 return unbind_to (count
, val
);
7788 /* This function parses a menu item and leaves the result in the
7789 vector item_properties.
7790 ITEM is a key binding, a possible menu item.
7791 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7792 evaluate dynamic expressions in the menu item.
7793 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7795 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7796 parse_menu_item returns true if the item is a menu item and false
7800 parse_menu_item (item
, notreal
, inmenubar
)
7802 int notreal
, inmenubar
;
7804 Lisp_Object def
, tem
, item_string
, start
;
7805 Lisp_Object cachelist
;
7807 Lisp_Object keyhint
;
7818 /* Create item_properties vector if necessary. */
7819 if (NILP (item_properties
))
7821 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7823 /* Initialize optional entries. */
7824 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7825 ASET (item_properties
, i
, Qnil
);
7826 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7828 /* Save the item here to protect it from GC. */
7829 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7831 item_string
= XCAR (item
);
7835 if (STRINGP (item_string
))
7837 /* Old format menu item. */
7838 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7840 /* Maybe help string. */
7841 if (CONSP (item
) && STRINGP (XCAR (item
)))
7843 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7848 /* Maybe key binding cache. */
7849 if (CONSP (item
) && CONSP (XCAR (item
))
7850 && (NILP (XCAR (XCAR (item
)))
7851 || VECTORP (XCAR (XCAR (item
)))))
7853 cachelist
= XCAR (item
);
7857 /* This is the real definition--the function to run. */
7858 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7860 /* Get enable property, if any. */
7863 tem
= Fget (item
, Qmenu_enable
);
7864 if (!NILP (Venable_disabled_menus_and_buttons
))
7865 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7866 else if (!NILP (tem
))
7867 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7870 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7872 /* New format menu item. */
7873 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7874 start
= XCDR (item
);
7877 /* We have a real binding. */
7878 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7880 item
= XCDR (start
);
7881 /* Is there a cache list with key equivalences. */
7882 if (CONSP (item
) && CONSP (XCAR (item
)))
7884 cachelist
= XCAR (item
);
7888 /* Parse properties. */
7889 while (CONSP (item
) && CONSP (XCDR (item
)))
7894 if (EQ (tem
, QCenable
))
7896 if (!NILP (Venable_disabled_menus_and_buttons
))
7897 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7899 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7901 else if (EQ (tem
, QCvisible
) && !notreal
)
7903 /* If got a visible property and that evaluates to nil
7904 then ignore this item. */
7905 tem
= menu_item_eval_property (XCAR (item
));
7909 else if (EQ (tem
, QChelp
))
7910 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7911 else if (EQ (tem
, QCfilter
))
7913 else if (EQ (tem
, QCkey_sequence
))
7916 if (NILP (cachelist
)
7917 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7918 /* Be GC protected. Set keyhint to item instead of tem. */
7921 else if (EQ (tem
, QCkeys
))
7924 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7925 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7927 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7932 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7934 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7936 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7942 else if (inmenubar
|| !NILP (start
))
7946 return 0; /* not a menu item */
7948 /* If item string is not a string, evaluate it to get string.
7949 If we don't get a string, skip this item. */
7950 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7951 if (!(STRINGP (item_string
) || notreal
))
7953 item_string
= menu_item_eval_property (item_string
);
7954 if (!STRINGP (item_string
))
7956 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7959 /* If got a filter apply it on definition. */
7960 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7963 def
= menu_item_eval_property (list2 (XCAR (filter
),
7964 list2 (Qquote
, def
)));
7966 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7969 /* Enable or disable selection of item. */
7970 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7976 tem
= menu_item_eval_property (tem
);
7977 if (inmenubar
&& NILP (tem
))
7978 return 0; /* Ignore disabled items in menu bar. */
7979 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7982 /* If we got no definition, this item is just unselectable text which
7983 is OK in a submenu but not in the menubar. */
7985 return (inmenubar
? 0 : 1);
7987 /* See if this is a separate pane or a submenu. */
7988 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7989 tem
= get_keymap (def
, 0, 1);
7990 /* For a subkeymap, just record its details and exit. */
7993 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7994 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7998 /* At the top level in the menu bar, do likewise for commands also.
7999 The menu bar does not display equivalent key bindings anyway.
8000 ITEM_PROPERTY_DEF is already set up properly. */
8004 /* This is a command. See if there is an equivalent key binding. */
8005 if (NILP (cachelist
))
8007 /* We have to create a cachelist. */
8008 /* With the introduction of where_is_cache, the computation
8009 of equivalent key bindings is sufficiently fast that we
8010 do not need to cache it here any more. */
8011 /* CHECK_IMPURE (start);
8012 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
8013 cachelist = XCAR (XCDR (start)); */
8014 cachelist
= Fcons (Qnil
, Qnil
);
8016 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8017 if (!NILP (keyhint
))
8019 XSETCAR (cachelist
, XCAR (keyhint
));
8022 else if (STRINGP (tem
))
8024 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
8025 XSETCAR (cachelist
, Qt
);
8029 tem
= XCAR (cachelist
);
8036 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
8038 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8041 def
= XCAR (prefix
);
8042 prefix
= XCDR (prefix
);
8045 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8047 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
8049 if (newcache
/* Always check first time. */
8050 /* Should we check everything when precomputing key
8052 /* If something had no key binding before, don't recheck it
8053 because that is too slow--except if we have a list of
8054 rebound commands in Vdefine_key_rebound_commands, do
8055 recheck any command that appears in that list. */
8056 || (CONSP (Vdefine_key_rebound_commands
)
8057 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
8060 /* We had a saved key. Is it still bound to the command? */
8063 /* If the command is an alias for another
8064 (such as lmenu.el set it up), check if the
8065 original command matches the cached command. */
8066 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8067 chkcache
= 1; /* Need to recompute key binding. */
8071 /* Recompute equivalent key binding. If the command is an alias
8072 for another (such as lmenu.el set it up), see if the original
8073 command name has equivalent keys. Otherwise look up the
8074 specified command itself. We don't try both, because that
8075 makes lmenu menus slow. */
8077 && SYMBOLP (XSYMBOL (def
)->function
)
8078 && ! NILP (Fget (def
, Qmenu_alias
)))
8079 def
= XSYMBOL (def
)->function
;
8080 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8082 /* Don't display remap bindings.*/
8083 if (VECTORP (tem
) && ASIZE (tem
) > 0 && EQ (AREF (tem
, 0), Qremap
))
8086 XSETCAR (cachelist
, tem
);
8089 XSETCDR (cachelist
, Qnil
);
8093 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8095 tem
= XCAR (cachelist
);
8099 newcache
= chkcache
;
8102 tem
= Fkey_description (tem
, Qnil
);
8105 if (STRINGP (XCAR (prefix
)))
8106 tem
= concat2 (XCAR (prefix
), tem
);
8107 if (STRINGP (XCDR (prefix
)))
8108 tem
= concat2 (tem
, XCDR (prefix
));
8110 XSETCDR (cachelist
, tem
);
8114 tem
= XCDR (cachelist
);
8115 if (newcache
&& !NILP (tem
))
8117 tem
= concat2 (build_string (" "), tem
);
8118 /* tem = concat3 (build_string (" ("), tem, build_string (")")); */
8119 XSETCDR (cachelist
, tem
);
8122 /* If we only want to precompute equivalent key bindings, stop here. */
8126 /* If we have an equivalent key binding, use that. */
8127 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8129 /* Include this when menu help is implemented.
8130 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8131 if (!(NILP (tem) || STRINGP (tem)))
8133 tem = menu_item_eval_property (tem);
8136 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8140 /* Handle radio buttons or toggle boxes. */
8141 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8143 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8144 menu_item_eval_property (tem
));
8151 /***********************************************************************
8153 ***********************************************************************/
8155 /* A vector holding tool bar items while they are parsed in function
8156 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8159 static Lisp_Object tool_bar_items_vector
;
8161 /* A vector holding the result of parse_tool_bar_item. Layout is like
8162 the one for a single item in tool_bar_items_vector. */
8164 static Lisp_Object tool_bar_item_properties
;
8166 /* Next free index in tool_bar_items_vector. */
8168 static int ntool_bar_items
;
8170 /* The symbols `tool-bar', `:image' and `:rtl'. */
8172 extern Lisp_Object Qtool_bar
;
8173 Lisp_Object QCimage
;
8176 /* Function prototypes. */
8178 static void init_tool_bar_items
P_ ((Lisp_Object
));
8179 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8180 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8181 static void append_tool_bar_item
P_ ((void));
8184 /* Return a vector of tool bar items for keymaps currently in effect.
8185 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8186 tool bar items found. */
8189 tool_bar_items (reuse
, nitems
)
8200 /* In order to build the menus, we need to call the keymap
8201 accessors. They all call QUIT. But this function is called
8202 during redisplay, during which a quit is fatal. So inhibit
8203 quitting while building the menus. We do this instead of
8204 specbind because (1) errors will clear it anyway and (2) this
8205 avoids risk of specpdl overflow. */
8206 oquit
= Vinhibit_quit
;
8209 /* Initialize tool_bar_items_vector and protect it from GC. */
8210 init_tool_bar_items (reuse
);
8212 /* Build list of keymaps in maps. Set nmaps to the number of maps
8215 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8216 if (!NILP (Voverriding_local_map_menu_flag
))
8218 /* Yes, use them (if non-nil) as well as the global map. */
8219 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8221 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8222 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8223 if (!NILP (Voverriding_local_map
))
8224 maps
[nmaps
++] = Voverriding_local_map
;
8228 /* No, so use major and minor mode keymaps and keymap property.
8229 Note that tool-bar bindings in the local-map and keymap
8230 properties may not work reliable, as they are only
8231 recognized when the tool-bar (or mode-line) is updated,
8232 which does not normally happen after every command. */
8235 nminor
= current_minor_maps (NULL
, &tmaps
);
8236 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8238 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8239 maps
[nmaps
++] = tem
;
8240 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8242 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8245 /* Add global keymap at the end. */
8246 maps
[nmaps
++] = current_global_map
;
8248 /* Process maps in reverse order and look up in each map the prefix
8250 for (i
= nmaps
- 1; i
>= 0; --i
)
8251 if (!NILP (maps
[i
]))
8255 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8257 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8260 Vinhibit_quit
= oquit
;
8261 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8262 return tool_bar_items_vector
;
8266 /* Process the definition of KEY which is DEF. */
8269 process_tool_bar_item (key
, def
, data
, args
)
8270 Lisp_Object key
, def
, data
;
8274 extern Lisp_Object Qundefined
;
8275 struct gcpro gcpro1
, gcpro2
;
8277 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8281 if (EQ (def
, Qundefined
))
8283 /* If a map has an explicit `undefined' as definition,
8284 discard any previously made item. */
8285 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8287 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8289 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8291 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8292 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8293 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8294 * sizeof (Lisp_Object
)));
8295 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8300 else if (parse_tool_bar_item (key
, def
))
8301 /* Append a new tool bar item to tool_bar_items_vector. Accept
8302 more than one definition for the same key. */
8303 append_tool_bar_item ();
8309 /* Parse a tool bar item specification ITEM for key KEY and return the
8310 result in tool_bar_item_properties. Value is zero if ITEM is
8313 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8315 CAPTION is the caption of the item, If it's not a string, it is
8316 evaluated to get a string.
8318 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8319 as binding are currently ignored.
8321 The following properties are recognized:
8325 FORM is evaluated and specifies whether the tool bar item is
8326 enabled or disabled.
8330 FORM is evaluated and specifies whether the tool bar item is visible.
8332 - `:filter FUNCTION'
8334 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8335 result is stored as the new binding.
8337 - `:button (TYPE SELECTED)'
8339 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8340 and specifies whether the button is selected (pressed) or not.
8344 IMAGES is either a single image specification or a vector of four
8345 image specifications. See enum tool_bar_item_images.
8347 - `:help HELP-STRING'.
8349 Gives a help string to display for the tool bar item. */
8352 parse_tool_bar_item (key
, item
)
8353 Lisp_Object key
, item
;
8355 /* Access slot with index IDX of vector tool_bar_item_properties. */
8356 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8358 Lisp_Object filter
= Qnil
;
8359 Lisp_Object caption
;
8362 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8363 Rule out items that aren't lists, don't start with
8364 `menu-item' or whose rest following `tool-bar-item' is not a
8367 || !EQ (XCAR (item
), Qmenu_item
)
8368 || (item
= XCDR (item
),
8372 /* Create tool_bar_item_properties vector if necessary. Reset it to
8374 if (VECTORP (tool_bar_item_properties
))
8376 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8380 tool_bar_item_properties
8381 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8384 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8385 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8387 /* Get the caption of the item. If the caption is not a string,
8388 evaluate it to get a string. If we don't get a string, skip this
8390 caption
= XCAR (item
);
8391 if (!STRINGP (caption
))
8393 caption
= menu_item_eval_property (caption
);
8394 if (!STRINGP (caption
))
8397 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8399 /* Give up if rest following the caption is not a list. */
8404 /* Store the binding. */
8405 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8408 /* Ignore cached key binding, if any. */
8409 if (CONSP (item
) && CONSP (XCAR (item
)))
8412 /* Process the rest of the properties. */
8413 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8415 Lisp_Object key
, value
;
8418 value
= XCAR (XCDR (item
));
8420 if (EQ (key
, QCenable
))
8422 /* `:enable FORM'. */
8423 if (!NILP (Venable_disabled_menus_and_buttons
))
8424 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8426 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8428 else if (EQ (key
, QCvisible
))
8430 /* `:visible FORM'. If got a visible property and that
8431 evaluates to nil then ignore this item. */
8432 if (NILP (menu_item_eval_property (value
)))
8435 else if (EQ (key
, QChelp
))
8436 /* `:help HELP-STRING'. */
8437 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8438 else if (EQ (key
, QCfilter
))
8439 /* ':filter FORM'. */
8441 else if (EQ (key
, QCbutton
) && CONSP (value
))
8443 /* `:button (TYPE . SELECTED)'. */
8444 Lisp_Object type
, selected
;
8446 type
= XCAR (value
);
8447 selected
= XCDR (value
);
8448 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8450 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8451 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8454 else if (EQ (key
, QCimage
)
8456 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8457 /* Value is either a single image specification or a vector
8458 of 4 such specifications for the different button states. */
8459 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8460 else if (EQ (key
, Qrtl
))
8462 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8465 /* If got a filter apply it on binding. */
8467 PROP (TOOL_BAR_ITEM_BINDING
)
8468 = menu_item_eval_property (list2 (filter
,
8470 PROP (TOOL_BAR_ITEM_BINDING
))));
8472 /* See if the binding is a keymap. Give up if it is. */
8473 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8476 /* Enable or disable selection of item. */
8477 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8478 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8479 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8481 /* Handle radio buttons or toggle boxes. */
8482 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8483 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8484 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8492 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8493 that can be reused. */
8496 init_tool_bar_items (reuse
)
8499 if (VECTORP (reuse
))
8500 tool_bar_items_vector
= reuse
;
8502 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8503 ntool_bar_items
= 0;
8507 /* Append parsed tool bar item properties from
8508 tool_bar_item_properties */
8511 append_tool_bar_item ()
8513 Lisp_Object
*to
, *from
;
8515 /* Enlarge tool_bar_items_vector if necessary. */
8516 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8517 >= XVECTOR (tool_bar_items_vector
)->size
)
8518 tool_bar_items_vector
8519 = larger_vector (tool_bar_items_vector
,
8520 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8522 /* Append entries from tool_bar_item_properties to the end of
8523 tool_bar_items_vector. */
8524 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8525 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8526 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8527 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8534 /* Read a character using menus based on maps in the array MAPS.
8535 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8536 Return t if we displayed a menu but the user rejected it.
8538 PREV_EVENT is the previous input event, or nil if we are reading
8539 the first event of a key sequence.
8541 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8542 if we used a mouse menu to read the input, or zero otherwise. If
8543 USED_MOUSE_MENU is null, we don't dereference it.
8545 The prompting is done based on the prompt-string of the map
8546 and the strings associated with various map elements.
8548 This can be done with X menus or with menus put in the minibuf.
8549 These are done in different ways, depending on how the input will be read.
8550 Menus using X are done after auto-saving in read-char, getting the input
8551 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8552 and do auto-saving in the inner call of read_char. */
8555 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8558 Lisp_Object prev_event
;
8559 int *used_mouse_menu
;
8562 register Lisp_Object name
= Qnil
;
8564 if (used_mouse_menu
)
8565 *used_mouse_menu
= 0;
8567 /* Use local over global Menu maps */
8569 if (! menu_prompting
)
8572 /* Optionally disregard all but the global map. */
8573 if (inhibit_local_menu_bar_menus
)
8575 maps
+= (nmaps
- 1);
8579 /* Get the menu name from the first map that has one (a prompt string). */
8580 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8582 name
= Fkeymap_prompt (maps
[mapno
]);
8587 /* If we don't have any menus, just read a character normally. */
8588 if (!STRINGP (name
))
8592 /* If we got to this point via a mouse click,
8593 use a real menu for mouse selection. */
8594 if (EVENT_HAS_PARAMETERS (prev_event
)
8595 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8596 && !EQ (XCAR (prev_event
), Qtool_bar
))
8598 /* Display the menu and get the selection. */
8599 Lisp_Object
*realmaps
8600 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8604 /* Use the maps that are not nil. */
8605 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8606 if (!NILP (maps
[mapno
]))
8607 realmaps
[nmaps1
++] = maps
[mapno
];
8609 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8614 record_menu_key (XCAR (value
));
8616 /* If we got multiple events, unread all but
8618 There is no way to prevent those unread events
8619 from showing up later in last_nonmenu_event.
8620 So turn symbol and integer events into lists,
8621 to indicate that they came from a mouse menu,
8622 so that when present in last_nonmenu_event
8623 they won't confuse things. */
8624 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8626 record_menu_key (XCAR (tem
));
8627 if (SYMBOLP (XCAR (tem
))
8628 || INTEGERP (XCAR (tem
)))
8629 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8632 /* If we got more than one event, put all but the first
8633 onto this list to be read later.
8634 Return just the first event now. */
8635 Vunread_command_events
8636 = nconc2 (XCDR (value
), Vunread_command_events
);
8637 value
= XCAR (value
);
8639 else if (NILP (value
))
8641 if (used_mouse_menu
)
8642 *used_mouse_menu
= 1;
8645 #endif /* HAVE_MENUS */
8649 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8650 We make this bigger when necessary, and never free it. */
8651 static char *read_char_minibuf_menu_text
;
8652 /* Size of that buffer. */
8653 static int read_char_minibuf_menu_width
;
8656 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8662 register Lisp_Object name
;
8664 /* FIXME: Use the minibuffer's frame width. */
8665 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8668 Lisp_Object rest
, vector
;
8674 if (! menu_prompting
)
8677 /* Get the menu name from the first map that has one (a prompt string). */
8678 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8680 name
= Fkeymap_prompt (maps
[mapno
]);
8685 /* If we don't have any menus, just read a character normally. */
8686 if (!STRINGP (name
))
8689 /* Make sure we have a big enough buffer for the menu text. */
8690 width
= max (width
, SBYTES (name
));
8691 if (read_char_minibuf_menu_text
== 0)
8693 read_char_minibuf_menu_width
= width
+ 4;
8694 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8696 else if (width
+ 4 > read_char_minibuf_menu_width
)
8698 read_char_minibuf_menu_width
= width
+ 4;
8699 read_char_minibuf_menu_text
8700 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8702 menu
= read_char_minibuf_menu_text
;
8704 /* Prompt string always starts with map's prompt, and a space. */
8705 strcpy (menu
, SDATA (name
));
8706 nlength
= SBYTES (name
);
8707 menu
[nlength
++] = ':';
8708 menu
[nlength
++] = ' ';
8711 /* Start prompting at start of first map. */
8715 /* Present the documented bindings, a line at a time. */
8722 Lisp_Object orig_defn_macro
;
8724 /* Loop over elements of map. */
8729 /* If reached end of map, start at beginning of next map. */
8733 /* At end of last map, wrap around to first map if just starting,
8734 or end this line if already have something on it. */
8738 if (notfirst
|| nobindings
) break;
8743 /* Look at the next element of the map. */
8745 elt
= XVECTOR (vector
)->contents
[idx
];
8747 elt
= Fcar_safe (rest
);
8749 if (idx
< 0 && VECTORP (elt
))
8751 /* If we found a dense table in the keymap,
8752 advanced past it, but start scanning its contents. */
8753 rest
= Fcdr_safe (rest
);
8759 /* An ordinary element. */
8760 Lisp_Object event
, tem
;
8764 event
= Fcar_safe (elt
); /* alist */
8765 elt
= Fcdr_safe (elt
);
8769 XSETINT (event
, idx
); /* vector */
8772 /* Ignore the element if it has no prompt string. */
8773 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8775 /* 1 if the char to type matches the string. */
8777 Lisp_Object upcased_event
, downcased_event
;
8778 Lisp_Object desc
= Qnil
;
8780 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8782 upcased_event
= Fupcase (event
);
8783 downcased_event
= Fdowncase (event
);
8784 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8785 || XINT (downcased_event
) == SREF (s
, 0));
8787 desc
= Fsingle_key_description (event
, Qnil
);
8789 #if 0 /* It is redundant to list the equivalent key bindings because
8790 the prefix is what the user has already typed. */
8792 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8794 /* Insert equivalent keybinding. */
8795 s
= concat2 (s
, tem
);
8798 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8799 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8801 /* Insert button prefix. */
8802 Lisp_Object selected
8803 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8804 if (EQ (tem
, QCradio
))
8805 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8807 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8808 s
= concat2 (tem
, s
);
8812 /* If we have room for the prompt string, add it to this line.
8813 If this is the first on the line, always add it. */
8814 if ((SCHARS (s
) + i
+ 2
8815 + (char_matches
? 0 : SCHARS (desc
) + 3))
8821 /* Punctuate between strings. */
8824 strcpy (menu
+ i
, ", ");
8830 /* If the char to type doesn't match the string's
8831 first char, explicitly show what char to type. */
8834 /* Add as much of string as fits. */
8835 thiswidth
= SCHARS (desc
);
8836 if (thiswidth
+ i
> width
)
8837 thiswidth
= width
- i
;
8838 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8840 strcpy (menu
+ i
, " = ");
8844 /* Add as much of string as fits. */
8845 thiswidth
= SCHARS (s
);
8846 if (thiswidth
+ i
> width
)
8847 thiswidth
= width
- i
;
8848 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8854 /* If this element does not fit, end the line now,
8855 and save the element for the next line. */
8856 strcpy (menu
+ i
, "...");
8861 /* Move past this element. */
8862 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8863 /* Handle reaching end of dense table. */
8868 rest
= Fcdr_safe (rest
);
8872 /* Prompt with that and read response. */
8873 message2_nolog (menu
, strlen (menu
),
8874 ! NILP (current_buffer
->enable_multibyte_characters
));
8876 /* Make believe its not a keyboard macro in case the help char
8877 is pressed. Help characters are not recorded because menu prompting
8878 is not used on replay.
8880 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8881 current_kboard
->defining_kbd_macro
= Qnil
;
8883 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8884 while (BUFFERP (obj
));
8885 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8887 if (!INTEGERP (obj
))
8889 else if (XINT (obj
) == -2)
8894 if (! EQ (obj
, menu_prompt_more_char
)
8895 && (!INTEGERP (menu_prompt_more_char
)
8896 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8898 if (!NILP (current_kboard
->defining_kbd_macro
))
8899 store_kbd_macro_char (obj
);
8902 /* Help char - go round again */
8906 /* Reading key sequences. */
8908 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8909 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8910 keymap, or nil otherwise. Return the index of the first keymap in
8911 which KEY has any binding, or NMAPS if no map has a binding.
8913 If KEY is a meta ASCII character, treat it like meta-prefix-char
8914 followed by the corresponding non-meta character. Keymaps in
8915 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8918 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8921 NEXT may be the same array as CURRENT. */
8924 follow_key (key
, nmaps
, current
, defs
, next
)
8926 Lisp_Object
*current
, *defs
, *next
;
8929 int i
, first_binding
;
8931 first_binding
= nmaps
;
8932 for (i
= nmaps
- 1; i
>= 0; i
--)
8934 if (! NILP (current
[i
]))
8936 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8937 if (! NILP (defs
[i
]))
8944 /* Given the set of bindings we've found, produce the next set of maps. */
8945 if (first_binding
< nmaps
)
8946 for (i
= 0; i
< nmaps
; i
++)
8947 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8949 return first_binding
;
8952 /* Structure used to keep track of partial application of key remapping
8953 such as Vfunction_key_map and Vkey_translation_map. */
8954 typedef struct keyremap
8956 /* This is the map originally specified for this use. */
8958 /* This is a submap reached by looking up, in PARENT,
8959 the events from START to END. */
8961 /* Positions [START, END) in the key sequence buffer
8962 are the key that we have scanned so far.
8963 Those events are the ones that we will replace
8964 if PAREHT maps them into a key sequence. */
8968 /* Lookup KEY in MAP.
8969 MAP is a keymap mapping keys to key vectors or functions.
8970 If the mapping is a function and DO_FUNCTION is non-zero, then
8971 the function is called with PROMPT as parameter and its return
8972 value is used as the return value of this function (after checking
8973 that it is indeed a vector). */
8976 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8977 Lisp_Object map
, key
, prompt
;
8982 next
= access_keymap (map
, key
, 1, 0, 1);
8984 /* Handle symbol with autoload definition. */
8985 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8986 && CONSP (XSYMBOL (next
)->function
)
8987 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8988 do_autoload (XSYMBOL (next
)->function
, next
);
8990 /* Handle a symbol whose function definition is a keymap
8992 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8993 && (ARRAYP (XSYMBOL (next
)->function
)
8994 || KEYMAPP (XSYMBOL (next
)->function
)))
8995 next
= XSYMBOL (next
)->function
;
8997 /* If the keymap gives a function, not an
8998 array, then call the function with one arg and use
8999 its value instead. */
9000 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
9005 next
= call1 (next
, prompt
);
9006 /* If the function returned something invalid,
9007 barf--don't ignore it.
9008 (To ignore it safely, we would need to gcpro a bunch of
9009 other variables.) */
9010 if (! (VECTORP (next
) || STRINGP (next
)))
9011 error ("Function %s returns invalid key sequence", tem
);
9016 /* Do one step of the key remapping used for function-key-map and
9017 key-translation-map:
9018 KEYBUF is the buffer holding the input events.
9019 BUFSIZE is its maximum size.
9020 FKEY is a pointer to the keyremap structure to use.
9021 INPUT is the index of the last element in KEYBUF.
9022 DOIT if non-zero says that the remapping can actually take place.
9023 DIFF is used to return the number of keys added/removed by the remapping.
9024 PARENT is the root of the keymap.
9025 PROMPT is the prompt to use if the remapping happens through a function.
9026 The return value is non-zero if the remapping actually took place. */
9029 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
9030 Lisp_Object
*keybuf
, prompt
;
9032 int input
, doit
, *diff
, bufsize
;
9034 Lisp_Object next
, key
;
9036 key
= keybuf
[fkey
->end
++];
9038 if (KEYMAPP (fkey
->parent
))
9039 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9043 /* If keybuf[fkey->start..fkey->end] is bound in the
9044 map and we're in a position to do the key remapping, replace it with
9045 the binding and restart with fkey->start at the end. */
9046 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9048 int len
= XFASTINT (Flength (next
));
9051 *diff
= len
- (fkey
->end
- fkey
->start
);
9053 if (input
+ *diff
>= bufsize
)
9054 error ("Key sequence too long");
9056 /* Shift the keys that follow fkey->end. */
9058 for (i
= fkey
->end
; i
< input
; i
++)
9059 keybuf
[i
+ *diff
] = keybuf
[i
];
9061 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9062 keybuf
[i
+ *diff
] = keybuf
[i
];
9063 /* Overwrite the old keys with the new ones. */
9064 for (i
= 0; i
< len
; i
++)
9065 keybuf
[fkey
->start
+ i
]
9066 = Faref (next
, make_number (i
));
9068 fkey
->start
= fkey
->end
+= *diff
;
9069 fkey
->map
= fkey
->parent
;
9074 fkey
->map
= get_keymap (next
, 0, 1);
9076 /* If we no longer have a bound suffix, try a new position for
9078 if (!CONSP (fkey
->map
))
9080 fkey
->end
= ++fkey
->start
;
9081 fkey
->map
= fkey
->parent
;
9086 /* Read a sequence of keys that ends with a non prefix character,
9087 storing it in KEYBUF, a buffer of size BUFSIZE.
9089 Return the length of the key sequence stored.
9090 Return -1 if the user rejected a command menu.
9092 Echo starting immediately unless `prompt' is 0.
9094 Where a key sequence ends depends on the currently active keymaps.
9095 These include any minor mode keymaps active in the current buffer,
9096 the current buffer's local map, and the global map.
9098 If a key sequence has no other bindings, we check Vfunction_key_map
9099 to see if some trailing subsequence might be the beginning of a
9100 function key's sequence. If so, we try to read the whole function
9101 key, and substitute its symbolic name into the key sequence.
9103 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9104 `double-' events into similar click events, if that would make them
9105 bound. We try to turn `triple-' events first into `double-' events,
9108 If we get a mouse click in a mode line, vertical divider, or other
9109 non-text area, we treat the click as if it were prefixed by the
9110 symbol denoting that area - `mode-line', `vertical-line', or
9113 If the sequence starts with a mouse click, we read the key sequence
9114 with respect to the buffer clicked on, not the current buffer.
9116 If the user switches frames in the midst of a key sequence, we put
9117 off the switch-frame event until later; the next call to
9118 read_char will return it.
9120 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9121 from the selected window's buffer. */
9124 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9125 can_return_switch_frame
, fix_current_buffer
)
9126 Lisp_Object
*keybuf
;
9129 int dont_downcase_last
;
9130 int can_return_switch_frame
;
9131 int fix_current_buffer
;
9133 volatile Lisp_Object from_string
;
9134 volatile int count
= SPECPDL_INDEX ();
9136 /* How many keys there are in the current key sequence. */
9139 /* The length of the echo buffer when we started reading, and
9140 the length of this_command_keys when we started reading. */
9141 volatile int echo_start
;
9142 volatile int keys_start
;
9144 /* The number of keymaps we're scanning right now, and the number of
9145 keymaps we have allocated space for. */
9147 volatile int nmaps_allocated
= 0;
9149 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9150 the current keymaps. */
9151 Lisp_Object
*volatile defs
= NULL
;
9153 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9154 in the current keymaps, or nil where it is not a prefix. */
9155 Lisp_Object
*volatile submaps
= NULL
;
9157 /* The local map to start out with at start of key sequence. */
9158 volatile Lisp_Object orig_local_map
;
9160 /* The map from the `keymap' property to start out with at start of
9162 volatile Lisp_Object orig_keymap
;
9164 /* 1 if we have already considered switching to the local-map property
9165 of the place where a mouse click occurred. */
9166 volatile int localized_local_map
= 0;
9168 /* The index in submaps[] of the first keymap that has a binding for
9169 this key sequence. In other words, the lowest i such that
9170 submaps[i] is non-nil. */
9171 volatile int first_binding
;
9172 /* Index of the first key that has no binding.
9173 It is useless to try fkey.start larger than that. */
9174 volatile int first_unbound
;
9176 /* If t < mock_input, then KEYBUF[t] should be read as the next
9179 We use this to recover after recognizing a function key. Once we
9180 realize that a suffix of the current key sequence is actually a
9181 function key's escape sequence, we replace the suffix with the
9182 function key's binding from Vfunction_key_map. Now keybuf
9183 contains a new and different key sequence, so the echo area,
9184 this_command_keys, and the submaps and defs arrays are wrong. In
9185 this situation, we set mock_input to t, set t to 0, and jump to
9186 restart_sequence; the loop will read keys from keybuf up until
9187 mock_input, thus rebuilding the state; and then it will resume
9188 reading characters from the keyboard. */
9189 volatile int mock_input
= 0;
9191 /* If the sequence is unbound in submaps[], then
9192 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9193 and fkey.map is its binding.
9195 These might be > t, indicating that all function key scanning
9196 should hold off until t reaches them. We do this when we've just
9197 recognized a function key, to avoid searching for the function
9198 key's again in Vfunction_key_map. */
9199 volatile keyremap fkey
;
9201 /* Likewise, for key_translation_map and input-decode-map. */
9202 volatile keyremap keytran
, indec
;
9204 /* Non-zero if we are trying to map a key by changing an upper-case
9205 letter to lower case, or a shifted function key to an unshifted
9207 volatile int shift_translated
= 0;
9209 /* If we receive a `switch-frame' or `select-window' event in the middle of
9210 a key sequence, we put it off for later.
9211 While we're reading, we keep the event here. */
9212 volatile Lisp_Object delayed_switch_frame
;
9214 /* See the comment below... */
9215 #if defined (GOBBLE_FIRST_EVENT)
9216 Lisp_Object first_event
;
9219 volatile Lisp_Object original_uppercase
;
9220 volatile int original_uppercase_position
= -1;
9222 /* Gets around Microsoft compiler limitations. */
9225 struct buffer
*starting_buffer
;
9227 /* List of events for which a fake prefix key has been generated. */
9228 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9230 #if defined (GOBBLE_FIRST_EVENT)
9234 struct gcpro gcpro1
;
9236 GCPRO1 (fake_prefixed_keys
);
9237 raw_keybuf_count
= 0;
9239 last_nonmenu_event
= Qnil
;
9241 delayed_switch_frame
= Qnil
;
9246 echo_prompt (prompt
);
9247 else if (cursor_in_echo_area
9248 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9249 && NILP (Fzerop (Vecho_keystrokes
)))
9250 /* This doesn't put in a dash if the echo buffer is empty, so
9251 you don't always see a dash hanging out in the minibuffer. */
9255 /* Record the initial state of the echo area and this_command_keys;
9256 we will need to restore them if we replay a key sequence. */
9258 echo_start
= echo_length ();
9259 keys_start
= this_command_key_count
;
9260 this_single_command_key_start
= keys_start
;
9262 #if defined (GOBBLE_FIRST_EVENT)
9263 /* This doesn't quite work, because some of the things that read_char
9264 does cannot safely be bypassed. It seems too risky to try to make
9267 /* Read the first char of the sequence specially, before setting
9268 up any keymaps, in case a filter runs and switches buffers on us. */
9269 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9271 #endif /* GOBBLE_FIRST_EVENT */
9273 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9274 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9277 /* We jump here when we need to reinitialize fkey and keytran; this
9278 happens if we switch keyboards between rescans. */
9279 replay_entire_sequence
:
9281 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9282 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9283 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9284 indec
.start
= indec
.end
= 0;
9285 fkey
.start
= fkey
.end
= 0;
9286 keytran
.start
= keytran
.end
= 0;
9288 /* We jump here when the key sequence has been thoroughly changed, and
9289 we need to rescan it starting from the beginning. When we jump here,
9290 keybuf[0..mock_input] holds the sequence we should reread. */
9293 starting_buffer
= current_buffer
;
9294 first_unbound
= bufsize
+ 1;
9296 /* Build our list of keymaps.
9297 If we recognize a function key and replace its escape sequence in
9298 keybuf with its symbol, or if the sequence starts with a mouse
9299 click and we need to switch buffers, we jump back here to rebuild
9300 the initial keymaps from the current buffer. */
9303 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9305 if (2 > nmaps_allocated
)
9307 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9308 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9309 nmaps_allocated
= 2;
9311 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9313 else if (!NILP (Voverriding_local_map
))
9315 if (2 > nmaps_allocated
)
9317 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9318 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9319 nmaps_allocated
= 2;
9321 submaps
[nmaps
++] = Voverriding_local_map
;
9329 nminor
= current_minor_maps (0, &maps
);
9330 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9332 if (total
> nmaps_allocated
)
9334 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9335 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9336 nmaps_allocated
= total
;
9339 if (!NILP (orig_keymap
))
9340 submaps
[nmaps
++] = orig_keymap
;
9342 bcopy (maps
, (void *) (submaps
+ nmaps
),
9343 nminor
* sizeof (submaps
[0]));
9347 submaps
[nmaps
++] = orig_local_map
;
9349 submaps
[nmaps
++] = current_global_map
;
9351 /* Find an accurate initial value for first_binding. */
9352 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9353 if (! NILP (submaps
[first_binding
]))
9356 /* Start from the beginning in keybuf. */
9359 /* These are no-ops the first time through, but if we restart, they
9360 revert the echo area and this_command_keys to their original state. */
9361 this_command_key_count
= keys_start
;
9362 if (INTERACTIVE
&& t
< mock_input
)
9363 echo_truncate (echo_start
);
9365 /* If the best binding for the current key sequence is a keymap, or
9366 we may be looking at a function key's escape sequence, keep on
9368 while (first_binding
< nmaps
9369 /* Keep reading as long as there's a prefix binding. */
9370 ? !NILP (submaps
[first_binding
])
9371 /* Don't return in the middle of a possible function key sequence,
9372 if the only bindings we found were via case conversion.
9373 Thus, if ESC O a has a function-key-map translation
9374 and ESC o has a binding, don't return after ESC O,
9375 so that we can translate ESC O plus the next character. */
9376 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9379 int used_mouse_menu
= 0;
9381 /* Where the last real key started. If we need to throw away a
9382 key that has expanded into more than one element of keybuf
9383 (say, a mouse click on the mode line which is being treated
9384 as [mode-line (mouse-...)], then we backtrack to this point
9386 volatile int last_real_key_start
;
9388 /* These variables are analogous to echo_start and keys_start;
9389 while those allow us to restart the entire key sequence,
9390 echo_local_start and keys_local_start allow us to throw away
9392 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9394 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9395 eassert (indec
.start
<= indec
.end
);
9396 eassert (fkey
.start
<= fkey
.end
);
9397 eassert (keytran
.start
<= keytran
.end
);
9398 /* key-translation-map is applied *after* function-key-map
9399 which is itself applied *after* input-decode-map. */
9400 eassert (fkey
.end
<= indec
.start
);
9401 eassert (keytran
.end
<= fkey
.start
);
9403 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9404 first_unbound
< keytran
.start
)
9405 { /* The prefix upto first_unbound has no binding and has
9406 no translation left to do either, so we know it's unbound.
9407 If we don't stop now, we risk staying here indefinitely
9408 (if the user keeps entering fkey or keytran prefixes
9409 like C-c ESC ESC ESC ESC ...) */
9411 for (i
= first_unbound
+ 1; i
< t
; i
++)
9412 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9413 mock_input
= t
- first_unbound
- 1;
9414 indec
.end
= indec
.start
-= first_unbound
+ 1;
9415 indec
.map
= indec
.parent
;
9416 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9417 fkey
.map
= fkey
.parent
;
9418 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9419 keytran
.map
= keytran
.parent
;
9420 goto replay_sequence
;
9424 error ("Key sequence too long");
9427 echo_local_start
= echo_length ();
9428 keys_local_start
= this_command_key_count
;
9429 local_first_binding
= first_binding
;
9432 /* These are no-ops, unless we throw away a keystroke below and
9433 jumped back up to replay_key; in that case, these restore the
9434 variables to their original state, allowing us to replay the
9436 if (INTERACTIVE
&& t
< mock_input
)
9437 echo_truncate (echo_local_start
);
9438 this_command_key_count
= keys_local_start
;
9439 first_binding
= local_first_binding
;
9441 /* By default, assume each event is "real". */
9442 last_real_key_start
= t
;
9444 /* Does mock_input indicate that we are re-reading a key sequence? */
9448 add_command_key (key
);
9449 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9450 && NILP (Fzerop (Vecho_keystrokes
)))
9454 /* If not, we should actually read a character. */
9458 KBOARD
*interrupted_kboard
= current_kboard
;
9459 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9460 key
= read_char (NILP (prompt
), nmaps
,
9461 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9462 &used_mouse_menu
, NULL
);
9463 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9468 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9469 if (k
== interrupted_kboard
)
9474 /* Don't touch interrupted_kboard when it's been
9476 delayed_switch_frame
= Qnil
;
9477 goto replay_entire_sequence
;
9480 if (!NILP (delayed_switch_frame
))
9482 interrupted_kboard
->kbd_queue
9483 = Fcons (delayed_switch_frame
,
9484 interrupted_kboard
->kbd_queue
);
9485 delayed_switch_frame
= Qnil
;
9489 interrupted_kboard
->kbd_queue
9490 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9492 /* If the side queue is non-empty, ensure it begins with a
9493 switch-frame, so we'll replay it in the right context. */
9494 if (CONSP (interrupted_kboard
->kbd_queue
)
9495 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9496 !(EVENT_HAS_PARAMETERS (key
)
9497 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9501 XSETFRAME (frame
, interrupted_frame
);
9502 interrupted_kboard
->kbd_queue
9503 = Fcons (make_lispy_switch_frame (frame
),
9504 interrupted_kboard
->kbd_queue
);
9507 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9508 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9509 goto replay_entire_sequence
;
9513 /* read_char returns t when it shows a menu and the user rejects it.
9517 unbind_to (count
, Qnil
);
9522 /* read_char returns -1 at the end of a macro.
9523 Emacs 18 handles this by returning immediately with a
9524 zero, so that's what we'll do. */
9525 if (INTEGERP (key
) && XINT (key
) == -1)
9528 /* The Microsoft C compiler can't handle the goto that
9534 /* If the current buffer has been changed from under us, the
9535 keymap may have changed, so replay the sequence. */
9538 timer_resume_idle ();
9541 /* Reset the current buffer from the selected window
9542 in case something changed the former and not the latter.
9543 This is to be more consistent with the behavior
9544 of the command_loop_1. */
9545 if (fix_current_buffer
)
9547 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9549 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9550 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9553 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9554 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9555 goto replay_sequence
;
9558 /* If we have a quit that was typed in another frame, and
9559 quit_throw_to_read_char switched buffers,
9560 replay to get the right keymap. */
9562 && XINT (key
) == quit_char
9563 && current_buffer
!= starting_buffer
)
9566 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9570 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9571 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9572 goto replay_sequence
;
9577 if (EVENT_HAS_PARAMETERS (key
)
9578 /* Either a `switch-frame' or a `select-window' event. */
9579 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9581 /* If we're at the beginning of a key sequence, and the caller
9582 says it's okay, go ahead and return this event. If we're
9583 in the midst of a key sequence, delay it until the end. */
9584 if (t
> 0 || !can_return_switch_frame
)
9586 delayed_switch_frame
= key
;
9592 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9596 /* Clicks in non-text areas get prefixed by the symbol
9597 in their CHAR-ADDRESS field. For example, a click on
9598 the mode line is prefixed by the symbol `mode-line'.
9600 Furthermore, key sequences beginning with mouse clicks
9601 are read using the keymaps of the buffer clicked on, not
9602 the current buffer. So we may have to switch the buffer
9605 When we turn one event into two events, we must make sure
9606 that neither of the two looks like the original--so that,
9607 if we replay the events, they won't be expanded again.
9608 If not for this, such reexpansion could happen either here
9609 or when user programs play with this-command-keys. */
9610 if (EVENT_HAS_PARAMETERS (key
))
9615 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9616 if (EQ (kind
, Qmouse_click
))
9618 Lisp_Object window
, posn
;
9620 window
= POSN_WINDOW (EVENT_START (key
));
9621 posn
= POSN_POSN (EVENT_START (key
));
9624 || (!NILP (fake_prefixed_keys
)
9625 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9627 /* We're looking a second time at an event for which
9628 we generated a fake prefix key. Set
9629 last_real_key_start appropriately. */
9631 last_real_key_start
= t
- 1;
9634 /* Key sequences beginning with mouse clicks are
9635 read using the keymaps in the buffer clicked on,
9636 not the current buffer. If we're at the
9637 beginning of a key sequence, switch buffers. */
9638 if (last_real_key_start
== 0
9640 && BUFFERP (XWINDOW (window
)->buffer
)
9641 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9643 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9647 /* Arrange to go back to the original buffer once we're
9648 done reading the key sequence. Note that we can't
9649 use save_excursion_{save,restore} here, because they
9650 save point as well as the current buffer; we don't
9651 want to save point, because redisplay may change it,
9652 to accommodate a Fset_window_start or something. We
9653 don't want to do this at the top of the function,
9654 because we may get input from a subprocess which
9655 wants to change the selected window and stuff (say,
9657 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9659 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9661 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9662 orig_local_map
= get_local_map (PT
, current_buffer
,
9664 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9665 goto replay_sequence
;
9668 /* For a mouse click, get the local text-property keymap
9669 of the place clicked on, rather than point. */
9670 if (last_real_key_start
== 0
9671 && CONSP (XCDR (key
))
9672 && ! localized_local_map
)
9674 Lisp_Object map_here
, start
, pos
;
9676 localized_local_map
= 1;
9677 start
= EVENT_START (key
);
9679 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9681 pos
= POSN_BUFFER_POSN (start
);
9683 && XINT (pos
) >= BEGV
9684 && XINT (pos
) <= ZV
)
9686 map_here
= get_local_map (XINT (pos
),
9687 current_buffer
, Qlocal_map
);
9688 if (!EQ (map_here
, orig_local_map
))
9690 orig_local_map
= map_here
;
9691 ++localized_local_map
;
9694 map_here
= get_local_map (XINT (pos
),
9695 current_buffer
, Qkeymap
);
9696 if (!EQ (map_here
, orig_keymap
))
9698 orig_keymap
= map_here
;
9699 ++localized_local_map
;
9702 if (localized_local_map
> 1)
9707 goto replay_sequence
;
9713 /* Expand mode-line and scroll-bar events into two events:
9714 use posn as a fake prefix key. */
9716 && (NILP (fake_prefixed_keys
)
9717 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9719 if (t
+ 1 >= bufsize
)
9720 error ("Key sequence too long");
9723 keybuf
[t
+ 1] = key
;
9726 /* Record that a fake prefix key has been generated
9727 for KEY. Don't modify the event; this would
9728 prevent proper action when the event is pushed
9729 back into unread-command-events. */
9730 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9732 /* If on a mode line string with a local keymap,
9733 reconsider the key sequence with that keymap. */
9734 if (string
= POSN_STRING (EVENT_START (key
)),
9735 (CONSP (string
) && STRINGP (XCAR (string
))))
9737 Lisp_Object pos
, map
, map2
;
9739 pos
= XCDR (string
);
9740 string
= XCAR (string
);
9742 && XINT (pos
) < SCHARS (string
))
9744 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9746 orig_local_map
= map
;
9747 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9750 if (!NILP (map
) || !NILP (map2
))
9751 goto replay_sequence
;
9757 else if (NILP (from_string
)
9758 && (string
= POSN_STRING (EVENT_START (key
)),
9759 (CONSP (string
) && STRINGP (XCAR (string
)))))
9761 /* For a click on a string, i.e. overlay string or a
9762 string displayed via the `display' property,
9763 consider `local-map' and `keymap' properties of
9765 Lisp_Object pos
, map
, map2
;
9767 pos
= XCDR (string
);
9768 string
= XCAR (string
);
9770 && XINT (pos
) < SCHARS (string
))
9772 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9774 orig_local_map
= map
;
9775 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9779 if (!NILP (map
) || !NILP (map2
))
9781 from_string
= string
;
9784 goto replay_sequence
;
9789 else if (CONSP (XCDR (key
))
9790 && CONSP (EVENT_START (key
))
9791 && CONSP (XCDR (EVENT_START (key
))))
9795 posn
= POSN_POSN (EVENT_START (key
));
9796 /* Handle menu-bar events:
9797 insert the dummy prefix event `menu-bar'. */
9798 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9800 if (t
+ 1 >= bufsize
)
9801 error ("Key sequence too long");
9805 /* Zap the position in key, so we know that we've
9806 expanded it, and don't try to do so again. */
9807 POSN_SET_POSN (EVENT_START (key
),
9808 Fcons (posn
, Qnil
));
9811 goto replay_sequence
;
9813 else if (CONSP (posn
))
9815 /* We're looking at the second event of a
9816 sequence which we expanded before. Set
9817 last_real_key_start appropriately. */
9818 if (last_real_key_start
== t
&& t
> 0)
9819 last_real_key_start
= t
- 1;
9824 /* We have finally decided that KEY is something we might want
9826 first_binding
= (follow_key (key
,
9827 nmaps
- first_binding
,
9828 submaps
+ first_binding
,
9829 defs
+ first_binding
,
9830 submaps
+ first_binding
)
9833 /* If KEY wasn't bound, we'll try some fallbacks. */
9834 if (first_binding
< nmaps
)
9835 /* This is needed for the following scenario:
9836 event 0: a down-event that gets dropped by calling replay_key.
9837 event 1: some normal prefix like C-h.
9838 After event 0, first_unbound is 0, after event 1 indec.start,
9839 fkey.start, and keytran.start are all 1, so when we see that
9840 C-h is bound, we need to update first_unbound. */
9841 first_unbound
= max (t
+ 1, first_unbound
);
9846 /* Remember the position to put an upper bound on indec.start. */
9847 first_unbound
= min (t
, first_unbound
);
9849 head
= EVENT_HEAD (key
);
9850 if (help_char_p (head
) && t
> 0)
9852 read_key_sequence_cmd
= Vprefix_help_command
;
9854 last_nonmenu_event
= key
;
9855 /* The Microsoft C compiler can't handle the goto that
9863 Lisp_Object breakdown
;
9866 breakdown
= parse_modifiers (head
);
9867 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9868 /* Attempt to reduce an unbound mouse event to a simpler
9869 event that is bound:
9870 Drags reduce to clicks.
9871 Double-clicks reduce to clicks.
9872 Triple-clicks reduce to double-clicks, then to clicks.
9873 Down-clicks are eliminated.
9874 Double-downs reduce to downs, then are eliminated.
9875 Triple-downs reduce to double-downs, then to downs,
9876 then are eliminated. */
9877 if (modifiers
& (down_modifier
| drag_modifier
9878 | double_modifier
| triple_modifier
))
9880 while (modifiers
& (down_modifier
| drag_modifier
9881 | double_modifier
| triple_modifier
))
9883 Lisp_Object new_head
, new_click
;
9884 if (modifiers
& triple_modifier
)
9885 modifiers
^= (double_modifier
| triple_modifier
);
9886 else if (modifiers
& double_modifier
)
9887 modifiers
&= ~double_modifier
;
9888 else if (modifiers
& drag_modifier
)
9889 modifiers
&= ~drag_modifier
;
9892 /* Dispose of this `down' event by simply jumping
9893 back to replay_key, to get another event.
9895 Note that if this event came from mock input,
9896 then just jumping back to replay_key will just
9897 hand it to us again. So we have to wipe out any
9900 We could delete keybuf[t] and shift everything
9901 after that to the left by one spot, but we'd also
9902 have to fix up any variable that points into
9903 keybuf, and shifting isn't really necessary
9906 Adding prefixes for non-textual mouse clicks
9907 creates two characters of mock input, and both
9908 must be thrown away. If we're only looking at
9909 the prefix now, we can just jump back to
9910 replay_key. On the other hand, if we've already
9911 processed the prefix, and now the actual click
9912 itself is giving us trouble, then we've lost the
9913 state of the keymaps we want to backtrack to, and
9914 we need to replay the whole sequence to rebuild
9917 Beyond that, only function key expansion could
9918 create more than two keys, but that should never
9919 generate mouse events, so it's okay to zero
9920 mock_input in that case too.
9922 FIXME: The above paragraph seems just plain
9923 wrong, if you consider things like
9924 xterm-mouse-mode. -stef
9926 Isn't this just the most wonderful code ever? */
9928 /* If mock_input > t + 1, the above simplification
9929 will actually end up dropping keys on the floor.
9930 This is probably OK for now, but even
9931 if mock_input <= t + 1, we need to adjust indec,
9933 Typical case [header-line down-mouse-N]:
9934 mock_input = 2, t = 1, fkey.end = 1,
9935 last_real_key_start = 0. */
9936 if (indec
.end
> last_real_key_start
)
9938 indec
.end
= indec
.start
9939 = min (last_real_key_start
, indec
.start
);
9940 indec
.map
= indec
.parent
;
9941 if (fkey
.end
> last_real_key_start
)
9943 fkey
.end
= fkey
.start
9944 = min (last_real_key_start
, fkey
.start
);
9945 fkey
.map
= fkey
.parent
;
9946 if (keytran
.end
> last_real_key_start
)
9948 keytran
.end
= keytran
.start
9949 = min (last_real_key_start
, keytran
.start
);
9950 keytran
.map
= keytran
.parent
;
9954 if (t
== last_real_key_start
)
9961 mock_input
= last_real_key_start
;
9962 goto replay_sequence
;
9967 = apply_modifiers (modifiers
, XCAR (breakdown
));
9969 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9971 /* Look for a binding for this new key. follow_key
9972 promises that it didn't munge submaps the
9973 last time we called it, since key was unbound. */
9975 = (follow_key (new_click
,
9976 nmaps
- local_first_binding
,
9977 submaps
+ local_first_binding
,
9978 defs
+ local_first_binding
,
9979 submaps
+ local_first_binding
)
9980 + local_first_binding
);
9982 /* If that click is bound, go for it. */
9983 if (first_binding
< nmaps
)
9988 /* Otherwise, we'll leave key set to the drag event. */
9995 /* Normally, last_nonmenu_event gets the previous key we read.
9996 But when a mouse popup menu is being used,
9997 we don't update last_nonmenu_event; it continues to hold the mouse
9998 event that preceded the first level of menu. */
9999 if (!used_mouse_menu
)
10000 last_nonmenu_event
= key
;
10002 /* Record what part of this_command_keys is the current key sequence. */
10003 this_single_command_key_start
= this_command_key_count
- t
;
10005 /* Look for this sequence in input-decode-map.
10006 Scan from indec.end until we find a bound suffix. */
10007 while (indec
.end
< t
)
10009 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10012 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10013 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
10018 mock_input
= diff
+ max (t
, mock_input
);
10019 goto replay_sequence
;
10023 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
10024 && indec
.start
>= t
)
10025 /* There is a binding and it's not a prefix.
10026 (and it doesn't have any input-decode-map translation pending).
10027 There is thus no function-key in this sequence.
10028 Moving fkey.start is important in this case to allow keytran.start
10029 to go over the sequence before we return (since we keep the
10030 invariant that keytran.end <= fkey.start). */
10032 if (fkey
.start
< t
)
10033 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10036 /* If the sequence is unbound, see if we can hang a function key
10037 off the end of it. */
10038 /* Continue scan from fkey.end until we find a bound suffix. */
10039 while (fkey
.end
< indec
.start
)
10041 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10044 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10045 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10046 max (t
, mock_input
),
10047 /* If there's a binding (i.e.
10048 first_binding >= nmaps) we don't want
10049 to apply this function-key-mapping. */
10050 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10055 mock_input
= diff
+ max (t
, mock_input
);
10056 /* Adjust the input-decode-map counters. */
10058 indec
.start
+= diff
;
10060 goto replay_sequence
;
10064 /* Look for this sequence in key-translation-map.
10065 Scan from keytran.end until we find a bound suffix. */
10066 while (keytran
.end
< fkey
.start
)
10068 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10071 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10072 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10077 mock_input
= diff
+ max (t
, mock_input
);
10078 /* Adjust the function-key-map and input-decode-map counters. */
10080 indec
.start
+= diff
;
10082 fkey
.start
+= diff
;
10084 goto replay_sequence
;
10088 /* If KEY is not defined in any of the keymaps,
10089 and cannot be part of a function key or translation,
10090 and is an upper case letter
10091 use the corresponding lower-case letter instead. */
10092 if (first_binding
>= nmaps
10093 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10095 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10096 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10097 || (XINT (key
) & shift_modifier
)))
10099 Lisp_Object new_key
;
10101 original_uppercase
= key
;
10102 original_uppercase_position
= t
- 1;
10104 if (XINT (key
) & shift_modifier
)
10105 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10107 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10108 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10110 /* We have to do this unconditionally, regardless of whether
10111 the lower-case char is defined in the keymaps, because they
10112 might get translated through function-key-map. */
10113 keybuf
[t
- 1] = new_key
;
10114 mock_input
= max (t
, mock_input
);
10115 shift_translated
= 1;
10117 goto replay_sequence
;
10119 /* If KEY is not defined in any of the keymaps,
10120 and cannot be part of a function key or translation,
10121 and is a shifted function key,
10122 use the corresponding unshifted function key instead. */
10123 if (first_binding
>= nmaps
10124 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10126 Lisp_Object breakdown
= parse_modifiers (key
);
10128 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10130 if (modifiers
& shift_modifier
10131 /* Treat uppercase keys as shifted. */
10133 && (KEY_TO_CHAR (key
)
10134 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10135 && UPPERCASEP (KEY_TO_CHAR (key
))))
10137 Lisp_Object new_key
10138 = (modifiers
& shift_modifier
10139 ? apply_modifiers (modifiers
& ~shift_modifier
,
10141 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10143 original_uppercase
= key
;
10144 original_uppercase_position
= t
- 1;
10146 /* We have to do this unconditionally, regardless of whether
10147 the lower-case char is defined in the keymaps, because they
10148 might get translated through function-key-map. */
10149 keybuf
[t
- 1] = new_key
;
10150 mock_input
= max (t
, mock_input
);
10151 /* Reset fkey (and consequently keytran) to apply
10152 function-key-map on the result, so that S-backspace is
10153 correctly mapped to DEL (via backspace). OTOH,
10154 input-decode-map doesn't need to go through it again. */
10155 fkey
.start
= fkey
.end
= 0;
10156 keytran
.start
= keytran
.end
= 0;
10157 shift_translated
= 1;
10159 goto replay_sequence
;
10164 read_key_sequence_cmd
= (first_binding
< nmaps
10165 ? defs
[first_binding
]
10168 unread_switch_frame
= delayed_switch_frame
;
10169 unbind_to (count
, Qnil
);
10171 /* Don't downcase the last character if the caller says don't.
10172 Don't downcase it if the result is undefined, either. */
10173 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10175 && t
- 1 == original_uppercase_position
)
10177 keybuf
[t
- 1] = original_uppercase
;
10178 shift_translated
= 0;
10181 if (shift_translated
)
10182 Vthis_command_keys_shift_translated
= Qt
;
10184 /* Occasionally we fabricate events, perhaps by expanding something
10185 according to function-key-map, or by adding a prefix symbol to a
10186 mouse click in the scroll bar or modeline. In this cases, return
10187 the entire generated key sequence, even if we hit an unbound
10188 prefix or a definition before the end. This means that you will
10189 be able to push back the event properly, and also means that
10190 read-key-sequence will always return a logical unit.
10193 for (; t
< mock_input
; t
++)
10195 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10196 && NILP (Fzerop (Vecho_keystrokes
)))
10197 echo_char (keybuf
[t
]);
10198 add_command_key (keybuf
[t
]);
10205 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10206 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10207 The sequence is sufficient to specify a non-prefix command in the
10208 current local and global maps.
10210 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10211 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10212 as a continuation of the previous key.
10214 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10215 convert the last event to lower case. (Normally any upper case event
10216 is converted to lower case if the original event is undefined and the lower
10217 case equivalent is defined.) A non-nil value is appropriate for reading
10218 a key sequence to be defined.
10220 A C-g typed while in this function is treated like any other character,
10221 and `quit-flag' is not set.
10223 If the key sequence starts with a mouse click, then the sequence is read
10224 using the keymaps of the buffer of the window clicked in, not the buffer
10225 of the selected window as normal.
10227 `read-key-sequence' drops unbound button-down events, since you normally
10228 only care about the click or drag events which follow them. If a drag
10229 or multi-click event is unbound, but the corresponding click event would
10230 be bound, `read-key-sequence' turns the event into a click event at the
10231 drag's starting position. This means that you don't have to distinguish
10232 between click and drag, double, or triple events unless you want to.
10234 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10235 lines separating windows, and scroll bars with imaginary keys
10236 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10238 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10239 function will process a switch-frame event if the user switches frames
10240 before typing anything. If the user switches frames in the middle of a
10241 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10242 is nil, then the event will be put off until after the current key sequence.
10244 `read-key-sequence' checks `function-key-map' for function key
10245 sequences, where they wouldn't conflict with ordinary bindings. See
10246 `function-key-map' for more details.
10248 The optional fifth argument COMMAND-LOOP, if non-nil, means
10249 that this key sequence is being read by something that will
10250 read commands one after another. It should be nil if the caller
10251 will read just one key sequence. */)
10252 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10254 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10255 Lisp_Object can_return_switch_frame
, command_loop
;
10257 Lisp_Object keybuf
[30];
10259 struct gcpro gcpro1
;
10260 int count
= SPECPDL_INDEX ();
10262 if (!NILP (prompt
))
10263 CHECK_STRING (prompt
);
10266 specbind (Qinput_method_exit_on_first_char
,
10267 (NILP (command_loop
) ? Qt
: Qnil
));
10268 specbind (Qinput_method_use_echo_area
,
10269 (NILP (command_loop
) ? Qt
: Qnil
));
10271 bzero (keybuf
, sizeof keybuf
);
10272 GCPRO1 (keybuf
[0]);
10273 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10275 if (NILP (continue_echo
))
10277 this_command_key_count
= 0;
10278 this_command_key_count_reset
= 0;
10279 this_single_command_key_start
= 0;
10282 #ifdef HAVE_WINDOW_SYSTEM
10283 if (display_hourglass_p
)
10284 cancel_hourglass ();
10287 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10288 prompt
, ! NILP (dont_downcase_last
),
10289 ! NILP (can_return_switch_frame
), 0);
10291 #if 0 /* The following is fine for code reading a key sequence and
10292 then proceeding with a lenghty computation, but it's not good
10293 for code reading keys in a loop, like an input method. */
10294 #ifdef HAVE_WINDOW_SYSTEM
10295 if (display_hourglass_p
)
10296 start_hourglass ();
10306 return unbind_to (count
, make_event_array (i
, keybuf
));
10309 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10310 Sread_key_sequence_vector
, 1, 5, 0,
10311 doc
: /* Like `read-key-sequence' but always return a vector. */)
10312 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10314 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10315 Lisp_Object can_return_switch_frame
, command_loop
;
10317 Lisp_Object keybuf
[30];
10319 struct gcpro gcpro1
;
10320 int count
= SPECPDL_INDEX ();
10322 if (!NILP (prompt
))
10323 CHECK_STRING (prompt
);
10326 specbind (Qinput_method_exit_on_first_char
,
10327 (NILP (command_loop
) ? Qt
: Qnil
));
10328 specbind (Qinput_method_use_echo_area
,
10329 (NILP (command_loop
) ? Qt
: Qnil
));
10331 bzero (keybuf
, sizeof keybuf
);
10332 GCPRO1 (keybuf
[0]);
10333 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10335 if (NILP (continue_echo
))
10337 this_command_key_count
= 0;
10338 this_command_key_count_reset
= 0;
10339 this_single_command_key_start
= 0;
10342 #ifdef HAVE_WINDOW_SYSTEM
10343 if (display_hourglass_p
)
10344 cancel_hourglass ();
10347 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10348 prompt
, ! NILP (dont_downcase_last
),
10349 ! NILP (can_return_switch_frame
), 0);
10351 #ifdef HAVE_WINDOW_SYSTEM
10352 if (display_hourglass_p
)
10353 start_hourglass ();
10362 return unbind_to (count
, Fvector (i
, keybuf
));
10365 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10366 doc
: /* Execute CMD as an editor command.
10367 CMD must be a symbol that satisfies the `commandp' predicate.
10368 Optional second arg RECORD-FLAG non-nil
10369 means unconditionally put this command in `command-history'.
10370 Otherwise, that is done only if an arg is read using the minibuffer.
10371 The argument KEYS specifies the value to use instead of (this-command-keys)
10372 when reading the arguments; if it is nil, (this-command-keys) is used.
10373 The argument SPECIAL, if non-nil, means that this command is executing
10374 a special event, so ignore the prefix argument and don't clear it. */)
10375 (cmd
, record_flag
, keys
, special
)
10376 Lisp_Object cmd
, record_flag
, keys
, special
;
10378 register Lisp_Object final
;
10379 register Lisp_Object tem
;
10380 Lisp_Object prefixarg
;
10381 extern int debug_on_next_call
;
10383 debug_on_next_call
= 0;
10385 if (NILP (special
))
10387 prefixarg
= current_kboard
->Vprefix_arg
;
10388 Vcurrent_prefix_arg
= prefixarg
;
10389 current_kboard
->Vprefix_arg
= Qnil
;
10396 tem
= Fget (cmd
, Qdisabled
);
10397 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10399 tem
= Fsymbol_value (Qdisabled_command_function
);
10401 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10407 final
= Findirect_function (cmd
, Qnil
);
10409 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10411 struct gcpro gcpro1
, gcpro2
;
10413 GCPRO2 (cmd
, prefixarg
);
10414 do_autoload (final
, cmd
);
10421 if (STRINGP (final
) || VECTORP (final
))
10423 /* If requested, place the macro in the command history. For
10424 other sorts of commands, call-interactively takes care of
10426 if (!NILP (record_flag
))
10429 = Fcons (Fcons (Qexecute_kbd_macro
,
10430 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10433 /* Don't keep command history around forever. */
10434 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10436 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10438 XSETCDR (tem
, Qnil
);
10442 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10445 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10446 /* Don't call Fcall_interactively directly because we want to make
10447 sure the backtrace has an entry for `call-interactively'.
10448 For the same reason, pass `cmd' rather than `final'. */
10449 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10456 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10458 doc
: /* Read function name, then read its arguments and call it.
10460 To pass a numeric argument to the command you are invoking with, specify
10461 the numeric argument to this command.
10463 Noninteractively, the argument PREFIXARG is the prefix argument to
10464 give to the command you invoke, if it asks for an argument. */)
10466 Lisp_Object prefixarg
;
10468 Lisp_Object function
;
10470 int saved_last_point_position
;
10471 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10472 Lisp_Object bindings
, value
;
10473 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10474 #ifdef HAVE_WINDOW_SYSTEM
10475 /* The call to Fcompleting_read wil start and cancel the hourglass,
10476 but if the hourglass was already scheduled, this means that no
10477 hourglass will be shown for the actual M-x command itself.
10478 So we restart it if it is already scheduled. Note that checking
10479 hourglass_shown_p is not enough, normally the hourglass is not shown,
10480 just scheduled to be shown. */
10481 int hstarted
= hourglass_started ();
10484 saved_keys
= Fvector (this_command_key_count
,
10485 XVECTOR (this_command_keys
)->contents
);
10486 saved_last_point_position_buffer
= last_point_position_buffer
;
10487 saved_last_point_position
= last_point_position
;
10489 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10491 if (EQ (prefixarg
, Qminus
))
10492 strcpy (buf
, "- ");
10493 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10494 strcpy (buf
, "C-u ");
10495 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10496 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10497 else if (INTEGERP (prefixarg
))
10498 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10500 /* This isn't strictly correct if execute-extended-command
10501 is bound to anything else. Perhaps it should use
10502 this_command_keys? */
10503 strcat (buf
, "M-x ");
10505 /* Prompt with buf, and then read a string, completing from and
10506 restricting to the set of all defined commands. Don't provide
10507 any initial input. Save the command read on the extended-command
10509 function
= Fcompleting_read (build_string (buf
),
10510 Vobarray
, Qcommandp
,
10511 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10514 #ifdef HAVE_WINDOW_SYSTEM
10515 if (hstarted
) start_hourglass ();
10518 if (STRINGP (function
) && SCHARS (function
) == 0)
10519 error ("No command name given");
10521 /* Set this_command_keys to the concatenation of saved_keys and
10522 function, followed by a RET. */
10527 this_command_key_count
= 0;
10528 this_command_key_count_reset
= 0;
10529 this_single_command_key_start
= 0;
10531 keys
= XVECTOR (saved_keys
)->contents
;
10532 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10533 add_command_key (keys
[i
]);
10535 for (i
= 0; i
< SCHARS (function
); i
++)
10536 add_command_key (Faref (function
, make_number (i
)));
10538 add_command_key (make_number ('\015'));
10541 last_point_position
= saved_last_point_position
;
10542 last_point_position_buffer
= saved_last_point_position_buffer
;
10546 function
= Fintern (function
, Qnil
);
10547 current_kboard
->Vprefix_arg
= prefixarg
;
10548 Vthis_command
= function
;
10549 real_this_command
= function
;
10551 /* If enabled, show which key runs this command. */
10552 if (!NILP (Vsuggest_key_bindings
)
10553 && NILP (Vexecuting_kbd_macro
)
10554 && SYMBOLP (function
))
10555 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10561 GCPRO3 (bindings
, value
, function
);
10562 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10564 /* If the command has a key binding, print it now. */
10565 if (!NILP (bindings
)
10566 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10569 /* But first wait, and skip the message if there is input. */
10570 Lisp_Object waited
;
10572 /* If this command displayed something in the echo area;
10573 wait a few seconds, then display our suggestion message. */
10574 if (NILP (echo_area_buffer
[0]))
10575 waited
= sit_for (make_number (0), 0, 2);
10576 else if (NUMBERP (Vsuggest_key_bindings
))
10577 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10579 waited
= sit_for (make_number (2), 0, 2);
10581 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10583 Lisp_Object binding
;
10585 int message_p
= push_message ();
10586 int count
= SPECPDL_INDEX ();
10588 record_unwind_protect (pop_message_unwind
, Qnil
);
10589 binding
= Fkey_description (bindings
, Qnil
);
10592 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10595 sprintf (newmessage
, "You can run the command `%s' with %s",
10596 SDATA (SYMBOL_NAME (function
)),
10598 message2_nolog (newmessage
,
10599 strlen (newmessage
),
10600 STRING_MULTIBYTE (binding
));
10601 if (NUMBERP (Vsuggest_key_bindings
))
10602 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10604 waited
= sit_for (make_number (2), 0, 2);
10606 if (!NILP (waited
) && message_p
)
10607 restore_message ();
10609 unbind_to (count
, Qnil
);
10613 RETURN_UNGCPRO (value
);
10617 /* Return nonzero if input events are pending. */
10620 detect_input_pending ()
10622 if (!input_pending
)
10623 get_input_pending (&input_pending
, 0);
10625 return input_pending
;
10628 /* Return nonzero if input events other than mouse movements are
10632 detect_input_pending_ignore_squeezables ()
10634 if (!input_pending
)
10635 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10637 return input_pending
;
10640 /* Return nonzero if input events are pending, and run any pending timers. */
10643 detect_input_pending_run_timers (do_display
)
10646 int old_timers_run
= timers_run
;
10648 if (!input_pending
)
10649 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10651 if (old_timers_run
!= timers_run
&& do_display
)
10653 redisplay_preserve_echo_area (8);
10654 /* The following fixes a bug when using lazy-lock with
10655 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10656 from an idle timer function. The symptom of the bug is that
10657 the cursor sometimes doesn't become visible until the next X
10658 event is processed. --gerd. */
10660 Lisp_Object tail
, frame
;
10661 FOR_EACH_FRAME (tail
, frame
)
10662 if (FRAME_RIF (XFRAME (frame
)))
10663 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10667 return input_pending
;
10670 /* This is called in some cases before a possible quit.
10671 It cases the next call to detect_input_pending to recompute input_pending.
10672 So calling this function unnecessarily can't do any harm. */
10675 clear_input_pending ()
10680 /* Return nonzero if there are pending requeued events.
10681 This isn't used yet. The hope is to make wait_reading_process_output
10682 call it, and return if it runs Lisp code that unreads something.
10683 The problem is, kbd_buffer_get_event needs to be fixed to know what
10684 to do in that case. It isn't trivial. */
10687 requeued_events_pending_p ()
10689 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10693 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10694 doc
: /* Return t if command input is currently available with no wait.
10695 Actually, the value is nil only if we can be sure that no input is available;
10696 if there is a doubt, the value is t. */)
10699 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10700 || !NILP (Vunread_post_input_method_events
)
10701 || !NILP (Vunread_input_method_events
))
10704 get_input_pending (&input_pending
,
10705 READABLE_EVENTS_DO_TIMERS_NOW
10706 | READABLE_EVENTS_FILTER_EVENTS
);
10707 return input_pending
> 0 ? Qt
: Qnil
;
10710 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10711 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10714 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10717 if (total_keys
< NUM_RECENT_KEYS
)
10718 return Fvector (total_keys
, keys
);
10721 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10722 bcopy (keys
+ recent_keys_index
,
10723 XVECTOR (val
)->contents
,
10724 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10726 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10727 recent_keys_index
* sizeof (Lisp_Object
));
10732 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10733 doc
: /* Return the key sequence that invoked this command.
10734 However, if the command has called `read-key-sequence', it returns
10735 the last key sequence that has been read.
10736 The value is a string or a vector.
10738 See also `this-command-keys-vector'. */)
10741 return make_event_array (this_command_key_count
,
10742 XVECTOR (this_command_keys
)->contents
);
10745 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10746 doc
: /* Return the key sequence that invoked this command, as a vector.
10747 However, if the command has called `read-key-sequence', it returns
10748 the last key sequence that has been read.
10750 See also `this-command-keys'. */)
10753 return Fvector (this_command_key_count
,
10754 XVECTOR (this_command_keys
)->contents
);
10757 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10758 Sthis_single_command_keys
, 0, 0, 0,
10759 doc
: /* Return the key sequence that invoked this command.
10760 More generally, it returns the last key sequence read, either by
10761 the command loop or by `read-key-sequence'.
10762 Unlike `this-command-keys', this function's value
10763 does not include prefix arguments.
10764 The value is always a vector. */)
10767 return Fvector (this_command_key_count
10768 - this_single_command_key_start
,
10769 (XVECTOR (this_command_keys
)->contents
10770 + this_single_command_key_start
));
10773 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10774 Sthis_single_command_raw_keys
, 0, 0, 0,
10775 doc
: /* Return the raw events that were read for this command.
10776 More generally, it returns the last key sequence read, either by
10777 the command loop or by `read-key-sequence'.
10778 Unlike `this-single-command-keys', this function's value
10779 shows the events before all translations (except for input methods).
10780 The value is always a vector. */)
10783 return Fvector (raw_keybuf_count
,
10784 (XVECTOR (raw_keybuf
)->contents
));
10787 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10788 Sreset_this_command_lengths
, 0, 0, 0,
10789 doc
: /* Make the unread events replace the last command and echo.
10790 Used in `universal-argument-other-key'.
10792 `universal-argument-other-key' rereads the event just typed.
10793 It then gets translated through `function-key-map'.
10794 The translated event has to replace the real events,
10795 both in the value of (this-command-keys) and in echoing.
10796 To achieve this, `universal-argument-other-key' calls
10797 `reset-this-command-lengths', which discards the record of reading
10798 these events the first time. */)
10801 this_command_key_count
= before_command_key_count
;
10802 if (this_command_key_count
< this_single_command_key_start
)
10803 this_single_command_key_start
= this_command_key_count
;
10805 echo_truncate (before_command_echo_length
);
10807 /* Cause whatever we put into unread-command-events
10808 to echo as if it were being freshly read from the keyboard. */
10809 this_command_key_count_reset
= 1;
10814 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10815 Sclear_this_command_keys
, 0, 1, 0,
10816 doc
: /* Clear out the vector that `this-command-keys' returns.
10817 Also clear the record of the last 100 events, unless optional arg
10818 KEEP-RECORD is non-nil. */)
10820 Lisp_Object keep_record
;
10824 this_command_key_count
= 0;
10825 this_command_key_count_reset
= 0;
10827 if (NILP (keep_record
))
10829 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10830 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10832 recent_keys_index
= 0;
10837 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10838 doc
: /* Return the current depth in recursive edits. */)
10842 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10846 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10847 "FOpen dribble file: ",
10848 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10849 If FILE is nil, close any open dribble file. */)
10862 file
= Fexpand_file_name (file
, Qnil
);
10863 dribble
= fopen (SDATA (file
), "w");
10865 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10870 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10871 doc
: /* Discard the contents of the terminal input buffer.
10872 Also end any kbd macro being defined. */)
10875 if (!NILP (current_kboard
->defining_kbd_macro
))
10877 /* Discard the last command from the macro. */
10878 Fcancel_kbd_macro_events ();
10882 update_mode_lines
++;
10884 Vunread_command_events
= Qnil
;
10885 unread_command_char
= -1;
10887 discard_tty_input ();
10889 kbd_fetch_ptr
= kbd_store_ptr
;
10895 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10896 doc
: /* Stop Emacs and return to superior process. You can resume later.
10897 If `cannot-suspend' is non-nil, or if the system doesn't support job
10898 control, run a subshell instead.
10900 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10901 to be read as terminal input by Emacs's parent, after suspension.
10903 Before suspending, run the normal hook `suspend-hook'.
10904 After resumption run the normal hook `suspend-resume-hook'.
10906 Some operating systems cannot stop the Emacs process and resume it later.
10907 On such systems, Emacs starts a subshell instead of suspending. */)
10909 Lisp_Object stuffstring
;
10911 int count
= SPECPDL_INDEX ();
10912 int old_height
, old_width
;
10914 struct gcpro gcpro1
;
10916 if (tty_list
&& tty_list
->next
)
10917 error ("There are other tty frames open; close them before suspending Emacs");
10919 if (!NILP (stuffstring
))
10920 CHECK_STRING (stuffstring
);
10922 /* Run the functions in suspend-hook. */
10923 if (!NILP (Vrun_hooks
))
10924 call1 (Vrun_hooks
, intern ("suspend-hook"));
10926 GCPRO1 (stuffstring
);
10927 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10928 reset_all_sys_modes ();
10929 /* sys_suspend can get an error if it tries to fork a subshell
10930 and the system resources aren't available for that. */
10931 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10933 stuff_buffered_input (stuffstring
);
10934 if (cannot_suspend
)
10938 unbind_to (count
, Qnil
);
10940 /* Check if terminal/window size has changed.
10941 Note that this is not useful when we are running directly
10942 with a window system; but suspend should be disabled in that case. */
10943 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10944 if (width
!= old_width
|| height
!= old_height
)
10945 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10947 /* Run suspend-resume-hook. */
10948 if (!NILP (Vrun_hooks
))
10949 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10955 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10956 Then in any case stuff anything Emacs has read ahead and not used. */
10959 stuff_buffered_input (stuffstring
)
10960 Lisp_Object stuffstring
;
10962 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10963 register unsigned char *p
;
10965 if (STRINGP (stuffstring
))
10967 register int count
;
10969 p
= SDATA (stuffstring
);
10970 count
= SBYTES (stuffstring
);
10971 while (count
-- > 0)
10976 /* Anything we have read ahead, put back for the shell to read. */
10977 /* ?? What should this do when we have multiple keyboards??
10978 Should we ignore anything that was typed in at the "wrong" kboard?
10980 rms: we should stuff everything back into the kboard
10982 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10985 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10986 kbd_fetch_ptr
= kbd_buffer
;
10987 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10988 stuff_char (kbd_fetch_ptr
->code
);
10990 clear_event (kbd_fetch_ptr
);
10994 #endif /* SIGTSTP */
10998 set_waiting_for_input (time_to_clear
)
10999 EMACS_TIME
*time_to_clear
;
11001 input_available_clear_time
= time_to_clear
;
11003 /* Tell handle_interrupt to throw back to read_char, */
11004 waiting_for_input
= 1;
11006 /* If handle_interrupt was called before and buffered a C-g,
11007 make it run again now, to avoid timing error. */
11008 if (!NILP (Vquit_flag
))
11009 quit_throw_to_read_char ();
11013 clear_waiting_for_input ()
11015 /* Tell handle_interrupt not to throw back to read_char, */
11016 waiting_for_input
= 0;
11017 input_available_clear_time
= 0;
11020 /* The SIGINT handler.
11022 If we have a frame on the controlling tty, we assume that the
11023 SIGINT was generated by C-g, so we call handle_interrupt.
11024 Otherwise, the handler kills Emacs. */
11027 interrupt_signal (signalnum
) /* If we don't have an argument, */
11028 int signalnum
; /* some compilers complain in signal calls. */
11030 /* Must preserve main program's value of errno. */
11031 int old_errno
= errno
;
11032 struct terminal
*terminal
;
11034 #if defined (USG) && !defined (POSIX_SIGNALS)
11035 /* USG systems forget handlers when they are used;
11036 must reestablish each time */
11037 signal (SIGINT
, interrupt_signal
);
11038 signal (SIGQUIT
, interrupt_signal
);
11041 SIGNAL_THREAD_CHECK (signalnum
);
11043 /* See if we have an active terminal on our controlling tty. */
11044 terminal
= get_named_tty ("/dev/tty");
11047 /* If there are no frames there, let's pretend that we are a
11048 well-behaving UN*X program and quit. */
11049 Fkill_emacs (Qnil
);
11053 /* Otherwise, the SIGINT was probably generated by C-g. */
11055 /* Set internal_last_event_frame to the top frame of the
11056 controlling tty, if we have a frame there. We disable the
11057 interrupt key on secondary ttys, so the SIGINT must have come
11058 from the controlling tty. */
11059 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11061 handle_interrupt ();
11067 /* This routine is called at interrupt level in response to C-g.
11069 It is called from the SIGINT handler or kbd_buffer_store_event.
11071 If `waiting_for_input' is non zero, then unless `echoing' is
11072 nonzero, immediately throw back to read_char.
11074 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11075 eval to throw, when it gets a chance. If quit-flag is already
11076 non-nil, it stops the job right away. */
11079 handle_interrupt ()
11085 /* XXX This code needs to be revised for multi-tty support. */
11086 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
11088 /* If SIGINT isn't blocked, don't let us be interrupted by
11089 another SIGINT, it might be harmful due to non-reentrancy
11090 in I/O functions. */
11091 sigblock (sigmask (SIGINT
));
11094 reset_all_sys_modes ();
11096 #ifdef SIGTSTP /* Support possible in later USG versions */
11098 * On systems which can suspend the current process and return to the original
11099 * shell, this command causes the user to end up back at the shell.
11100 * The "Auto-save" and "Abort" questions are not asked until
11101 * the user elects to return to emacs, at which point he can save the current
11102 * job and either dump core or continue.
11106 /* Perhaps should really fork an inferior shell?
11107 But that would not provide any way to get back
11108 to the original shell, ever. */
11109 printf ("No support for stopping a process on this operating system;\n");
11110 printf ("you can continue or abort.\n");
11111 #endif /* not SIGTSTP */
11113 /* We must remain inside the screen area when the internal terminal
11114 is used. Note that [Enter] is not echoed by dos. */
11115 cursor_to (SELECTED_FRAME (), 0, 0);
11117 /* It doesn't work to autosave while GC is in progress;
11118 the code used for auto-saving doesn't cope with the mark bit. */
11119 if (!gc_in_progress
)
11121 printf ("Auto-save? (y or n) ");
11123 if (((c
= getchar ()) & ~040) == 'Y')
11125 Fdo_auto_save (Qt
, Qnil
);
11127 printf ("\r\nAuto-save done");
11128 #else /* not MSDOS */
11129 printf ("Auto-save done\n");
11130 #endif /* not MSDOS */
11132 while (c
!= '\n') c
= getchar ();
11136 /* During GC, it must be safe to reenable quitting again. */
11137 Vinhibit_quit
= Qnil
;
11140 #endif /* not MSDOS */
11141 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11142 printf ("but will instead do a real quit after garbage collection ends\r\n");
11147 printf ("\r\nAbort? (y or n) ");
11148 #else /* not MSDOS */
11149 printf ("Abort (and dump core)? (y or n) ");
11150 #endif /* not MSDOS */
11152 if (((c
= getchar ()) & ~040) == 'Y')
11154 while (c
!= '\n') c
= getchar ();
11156 printf ("\r\nContinuing...\r\n");
11157 #else /* not MSDOS */
11158 printf ("Continuing...\n");
11159 #endif /* not MSDOS */
11161 init_all_sys_modes ();
11166 /* If executing a function that wants to be interrupted out of
11167 and the user has not deferred quitting by binding `inhibit-quit'
11168 then quit right away. */
11169 if (immediate_quit
&& NILP (Vinhibit_quit
))
11171 struct gl_state_s saved
;
11172 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11174 immediate_quit
= 0;
11177 GCPRO4 (saved
.object
, saved
.global_code
,
11178 saved
.current_syntax_table
, saved
.old_prop
);
11179 Fsignal (Qquit
, Qnil
);
11184 /* Else request quit when it's safe */
11188 /* TODO: The longjmp in this call throws the NS event loop integration off,
11189 and it seems to do fine without this. Probably some attention
11190 needs to be paid to the setting of waiting_for_input in
11191 wait_reading_process_output() under HAVE_NS because of the call
11192 to ns_select there (needed because otherwise events aren't picked up
11193 outside of polling since we don't get SIGIO like X and we don't have a
11194 separate event loop thread like W32. */
11196 if (waiting_for_input
&& !echoing
)
11197 quit_throw_to_read_char ();
11201 /* Handle a C-g by making read_char return C-g. */
11204 quit_throw_to_read_char ()
11207 /* Prevent another signal from doing this before we finish. */
11208 clear_waiting_for_input ();
11211 Vunread_command_events
= Qnil
;
11212 unread_command_char
= -1;
11214 #if 0 /* Currently, sit_for is called from read_char without turning
11215 off polling. And that can call set_waiting_for_input.
11216 It seems to be harmless. */
11217 #ifdef POLL_FOR_INPUT
11218 /* May be > 1 if in recursive minibuffer. */
11219 if (poll_suppress_count
== 0)
11223 if (FRAMEP (internal_last_event_frame
)
11224 && !EQ (internal_last_event_frame
, selected_frame
))
11225 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11228 _longjmp (getcjmp
, 1);
11231 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11232 doc
: /* Set interrupt mode of reading keyboard input.
11233 If INTERRUPT is non-nil, Emacs will use input interrupts;
11234 otherwise Emacs uses CBREAK mode.
11236 See also `current-input-mode'. */)
11238 Lisp_Object interrupt
;
11240 int new_interrupt_input
;
11242 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11243 #ifdef HAVE_X_WINDOWS
11244 if (x_display_list
!= NULL
)
11246 /* When using X, don't give the user a real choice,
11247 because we haven't implemented the mechanisms to support it. */
11248 #ifdef NO_SOCK_SIGIO
11249 new_interrupt_input
= 0;
11250 #else /* not NO_SOCK_SIGIO */
11251 new_interrupt_input
= 1;
11252 #endif /* NO_SOCK_SIGIO */
11255 #endif /* HAVE_X_WINDOWS */
11256 new_interrupt_input
= !NILP (interrupt
);
11257 #else /* not SIGIO */
11258 new_interrupt_input
= 0;
11259 #endif /* not SIGIO */
11261 if (new_interrupt_input
!= interrupt_input
)
11263 #ifdef POLL_FOR_INPUT
11267 /* this causes startup screen to be restored and messes with the mouse */
11268 reset_all_sys_modes ();
11270 interrupt_input
= new_interrupt_input
;
11272 init_all_sys_modes ();
11275 #ifdef POLL_FOR_INPUT
11276 poll_suppress_count
= 1;
11283 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11284 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11285 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11286 C-q in key sequences.
11288 This setting only has an effect on tty terminals and only when
11289 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11291 See also `current-input-mode'. */)
11293 Lisp_Object flow
, terminal
;
11295 struct terminal
*t
= get_terminal (terminal
, 1);
11296 struct tty_display_info
*tty
;
11297 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11299 tty
= t
->display_info
.tty
;
11301 if (tty
->flow_control
!= !NILP (flow
))
11304 /* this causes startup screen to be restored and messes with the mouse */
11305 reset_sys_modes (tty
);
11308 tty
->flow_control
= !NILP (flow
);
11311 init_sys_modes (tty
);
11317 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11318 doc
: /* Enable or disable 8-bit input on TERMINAL.
11319 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11320 bit as the Meta modifier.
11322 If META is nil, Emacs will ignore the top bit, on the assumption it is
11325 Otherwise, Emacs will accept and pass through 8-bit input without
11326 specially interpreting the top bit.
11328 This setting only has an effect on tty terminal devices.
11330 Optional parameter TERMINAL specifies the tty terminal device to use.
11331 It may be a terminal object, a frame, or nil for the terminal used by
11332 the currently selected frame.
11334 See also `current-input-mode'. */)
11336 Lisp_Object meta
, terminal
;
11338 struct terminal
*t
= get_terminal (terminal
, 1);
11339 struct tty_display_info
*tty
;
11342 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11344 tty
= t
->display_info
.tty
;
11348 else if (EQ (meta
, Qt
))
11353 if (tty
->meta_key
!= new_meta
)
11356 /* this causes startup screen to be restored and messes with the mouse */
11357 reset_sys_modes (tty
);
11360 tty
->meta_key
= new_meta
;
11363 init_sys_modes (tty
);
11369 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11370 doc
: /* Specify character used for quitting.
11371 QUIT must be an ASCII character.
11373 This function only has an effect on the controlling tty of the Emacs
11376 See also `current-input-mode'. */)
11380 struct terminal
*t
= get_named_tty ("/dev/tty");
11381 struct tty_display_info
*tty
;
11382 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11384 tty
= t
->display_info
.tty
;
11386 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11387 error ("QUIT must be an ASCII character");
11390 /* this causes startup screen to be restored and messes with the mouse */
11391 reset_sys_modes (tty
);
11394 /* Don't let this value be out of range. */
11395 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11398 init_sys_modes (tty
);
11404 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11405 doc
: /* Set mode of reading keyboard input.
11406 First arg INTERRUPT non-nil means use input interrupts;
11407 nil means use CBREAK mode.
11408 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11409 (no effect except in CBREAK mode).
11410 Third arg META t means accept 8-bit input (for a Meta key).
11411 META nil means ignore the top bit, on the assumption it is parity.
11412 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11413 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11414 See also `current-input-mode'. */)
11415 (interrupt
, flow
, meta
, quit
)
11416 Lisp_Object interrupt
, flow
, meta
, quit
;
11418 Fset_input_interrupt_mode (interrupt
);
11419 Fset_output_flow_control (flow
, Qnil
);
11420 Fset_input_meta_mode (meta
, Qnil
);
11422 Fset_quit_char (quit
);
11426 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11427 doc
: /* Return information about the way Emacs currently reads keyboard input.
11428 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11429 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11430 nil, Emacs is using CBREAK mode.
11431 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11432 terminal; this does not apply if Emacs uses interrupt-driven input.
11433 META is t if accepting 8-bit input with 8th bit as Meta flag.
11434 META nil means ignoring the top bit, on the assumption it is parity.
11435 META is neither t nor nil if accepting 8-bit input and using
11436 all 8 bits as the character code.
11437 QUIT is the character Emacs currently uses to quit.
11438 The elements of this list correspond to the arguments of
11439 `set-input-mode'. */)
11442 Lisp_Object val
[4];
11443 struct frame
*sf
= XFRAME (selected_frame
);
11445 val
[0] = interrupt_input
? Qt
: Qnil
;
11446 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11448 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11449 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11451 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11458 XSETFASTINT (val
[3], quit_char
);
11460 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11463 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11464 doc
: /* Return position information for pixel coordinates X and Y.
11465 By default, X and Y are relative to text area of the selected window.
11466 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11467 If optional fourth arg WHOLE is non-nil, X is relative to the left
11468 edge of the window.
11470 The return value is similar to a mouse click position:
11471 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11472 IMAGE (DX . DY) (WIDTH . HEIGHT))
11473 The `posn-' functions access elements of such lists. */)
11474 (x
, y
, frame_or_window
, whole
)
11475 Lisp_Object x
, y
, frame_or_window
, whole
;
11480 if (NILP (frame_or_window
))
11481 frame_or_window
= selected_window
;
11483 if (WINDOWP (frame_or_window
))
11487 CHECK_LIVE_WINDOW (frame_or_window
);
11489 w
= XWINDOW (frame_or_window
);
11490 XSETINT (x
, (XINT (x
)
11491 + WINDOW_LEFT_EDGE_X (w
)
11493 ? window_box_left_offset (w
, TEXT_AREA
)
11495 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11496 frame_or_window
= w
->frame
;
11499 CHECK_LIVE_FRAME (frame_or_window
);
11501 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11504 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11505 doc
: /* Return position information for buffer POS in WINDOW.
11506 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11508 Return nil if position is not visible in window. Otherwise,
11509 the return value is similar to that returned by `event-start' for
11510 a mouse click at the upper left corner of the glyph corresponding
11511 to the given buffer position:
11512 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11513 IMAGE (DX . DY) (WIDTH . HEIGHT))
11514 The `posn-' functions access elements of such lists. */)
11516 Lisp_Object pos
, window
;
11521 window
= selected_window
;
11523 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11526 Lisp_Object x
= XCAR (tem
);
11527 Lisp_Object y
= XCAR (XCDR (tem
));
11529 /* Point invisible due to hscrolling? */
11532 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11540 * Set up a new kboard object with reasonable initial values.
11546 kb
->Voverriding_terminal_local_map
= Qnil
;
11547 kb
->Vlast_command
= Qnil
;
11548 kb
->Vreal_last_command
= Qnil
;
11549 kb
->Vkeyboard_translate_table
= Qnil
;
11550 kb
->Vlast_repeatable_command
= Qnil
;
11551 kb
->Vprefix_arg
= Qnil
;
11552 kb
->Vlast_prefix_arg
= Qnil
;
11553 kb
->kbd_queue
= Qnil
;
11554 kb
->kbd_queue_has_data
= 0;
11555 kb
->immediate_echo
= 0;
11556 kb
->echo_string
= Qnil
;
11557 kb
->echo_after_prompt
= -1;
11558 kb
->kbd_macro_buffer
= 0;
11559 kb
->kbd_macro_bufsize
= 0;
11560 kb
->defining_kbd_macro
= Qnil
;
11561 kb
->Vlast_kbd_macro
= Qnil
;
11562 kb
->reference_count
= 0;
11563 kb
->Vsystem_key_alist
= Qnil
;
11564 kb
->system_key_syms
= Qnil
;
11565 kb
->Vwindow_system
= Qt
; /* Unset. */
11566 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11567 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11568 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11569 kb
->Vdefault_minibuffer_frame
= Qnil
;
11573 * Destroy the contents of a kboard object, but not the object itself.
11574 * We use this just before deleting it, or if we're going to initialize
11575 * it a second time.
11581 xfree (kb
->kbd_macro_buffer
);
11584 /* Free KB and memory referenced from it. */
11592 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11595 *kbp
= kb
->next_kboard
;
11597 /* Prevent a dangling reference to KB. */
11598 if (kb
== current_kboard
11599 && FRAMEP (selected_frame
)
11600 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11602 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11604 if (current_kboard
== kb
)
11615 /* This is correct before outermost invocation of the editor loop */
11616 command_loop_level
= -1;
11617 immediate_quit
= 0;
11618 quit_char
= Ctl ('g');
11619 Vunread_command_events
= Qnil
;
11620 unread_command_char
= -1;
11621 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11623 recent_keys_index
= 0;
11624 kbd_fetch_ptr
= kbd_buffer
;
11625 kbd_store_ptr
= kbd_buffer
;
11626 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11627 do_mouse_tracking
= Qnil
;
11630 interrupt_input_blocked
= 0;
11631 interrupt_input_pending
= 0;
11633 pending_signals
= 0;
11636 /* This means that command_loop_1 won't try to select anything the first
11638 internal_last_event_frame
= Qnil
;
11639 Vlast_event_frame
= internal_last_event_frame
;
11641 current_kboard
= initial_kboard
;
11642 /* Re-initialize the keyboard again. */
11643 wipe_kboard (current_kboard
);
11644 init_kboard (current_kboard
);
11645 /* A value of nil for Vwindow_system normally means a tty, but we also use
11646 it for the initial terminal since there is no window system there. */
11647 current_kboard
->Vwindow_system
= Qnil
;
11649 if (!noninteractive
)
11651 /* Before multi-tty support, these handlers used to be installed
11652 only if the current session was a tty session. Now an Emacs
11653 session may have multiple display types, so we always handle
11654 SIGINT. There is special code in interrupt_signal to exit
11655 Emacs on SIGINT when there are no termcap frames on the
11656 controlling terminal. */
11657 signal (SIGINT
, interrupt_signal
);
11658 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11659 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11660 SIGQUIT and we can't tell which one it will give us. */
11661 signal (SIGQUIT
, interrupt_signal
);
11662 #endif /* HAVE_TERMIO */
11664 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11666 if (!noninteractive
)
11667 signal (SIGIO
, input_available_signal
);
11670 /* Use interrupt input by default, if it works and noninterrupt input
11671 has deficiencies. */
11673 #ifdef INTERRUPT_INPUT
11674 interrupt_input
= 1;
11676 interrupt_input
= 0;
11682 if (keyboard_init_hook
)
11683 (*keyboard_init_hook
) ();
11685 #ifdef POLL_FOR_INPUT
11687 poll_suppress_count
= 1;
11692 /* This type's only use is in syms_of_keyboard, to initialize the
11693 event header symbols and put properties on them. */
11694 struct event_head
{
11700 struct event_head head_table
[] = {
11701 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11702 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11703 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11704 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11705 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11706 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11707 /* `select-window' should be handled just like `switch-frame'
11708 in read_key_sequence. */
11709 {&Qselect_window
, "select-window", &Qswitch_frame
}
11713 syms_of_keyboard ()
11715 pending_funcalls
= Qnil
;
11716 staticpro (&pending_funcalls
);
11718 Vlispy_mouse_stem
= build_string ("mouse");
11719 staticpro (&Vlispy_mouse_stem
);
11722 QCimage
= intern (":image");
11723 staticpro (&QCimage
);
11725 staticpro (&Qhelp_echo
);
11726 Qhelp_echo
= intern ("help-echo");
11729 Qrtl
= intern (":rtl");
11731 staticpro (&item_properties
);
11732 item_properties
= Qnil
;
11734 staticpro (&tool_bar_item_properties
);
11735 tool_bar_item_properties
= Qnil
;
11736 staticpro (&tool_bar_items_vector
);
11737 tool_bar_items_vector
= Qnil
;
11739 staticpro (&real_this_command
);
11740 real_this_command
= Qnil
;
11742 Qtimer_event_handler
= intern ("timer-event-handler");
11743 staticpro (&Qtimer_event_handler
);
11745 Qdisabled_command_function
= intern ("disabled-command-function");
11746 staticpro (&Qdisabled_command_function
);
11748 Qself_insert_command
= intern ("self-insert-command");
11749 staticpro (&Qself_insert_command
);
11751 Qforward_char
= intern ("forward-char");
11752 staticpro (&Qforward_char
);
11754 Qbackward_char
= intern ("backward-char");
11755 staticpro (&Qbackward_char
);
11757 Qdisabled
= intern ("disabled");
11758 staticpro (&Qdisabled
);
11760 Qundefined
= intern ("undefined");
11761 staticpro (&Qundefined
);
11763 Qpre_command_hook
= intern ("pre-command-hook");
11764 staticpro (&Qpre_command_hook
);
11766 Qpost_command_hook
= intern ("post-command-hook");
11767 staticpro (&Qpost_command_hook
);
11769 Qdeferred_action_function
= intern ("deferred-action-function");
11770 staticpro (&Qdeferred_action_function
);
11772 Qcommand_hook_internal
= intern ("command-hook-internal");
11773 staticpro (&Qcommand_hook_internal
);
11775 Qfunction_key
= intern ("function-key");
11776 staticpro (&Qfunction_key
);
11777 Qmouse_click
= intern ("mouse-click");
11778 staticpro (&Qmouse_click
);
11779 #if defined (WINDOWSNT)
11780 Qlanguage_change
= intern ("language-change");
11781 staticpro (&Qlanguage_change
);
11783 Qdrag_n_drop
= intern ("drag-n-drop");
11784 staticpro (&Qdrag_n_drop
);
11786 Qsave_session
= intern ("save-session");
11787 staticpro (&Qsave_session
);
11790 Qdbus_event
= intern ("dbus-event");
11791 staticpro (&Qdbus_event
);
11794 Qmenu_enable
= intern ("menu-enable");
11795 staticpro (&Qmenu_enable
);
11796 Qmenu_alias
= intern ("menu-alias");
11797 staticpro (&Qmenu_alias
);
11798 QCenable
= intern (":enable");
11799 staticpro (&QCenable
);
11800 QCvisible
= intern (":visible");
11801 staticpro (&QCvisible
);
11802 QChelp
= intern (":help");
11803 staticpro (&QChelp
);
11804 QCfilter
= intern (":filter");
11805 staticpro (&QCfilter
);
11806 QCbutton
= intern (":button");
11807 staticpro (&QCbutton
);
11808 QCkeys
= intern (":keys");
11809 staticpro (&QCkeys
);
11810 QCkey_sequence
= intern (":key-sequence");
11811 staticpro (&QCkey_sequence
);
11812 QCtoggle
= intern (":toggle");
11813 staticpro (&QCtoggle
);
11814 QCradio
= intern (":radio");
11815 staticpro (&QCradio
);
11817 Qmode_line
= intern ("mode-line");
11818 staticpro (&Qmode_line
);
11819 Qvertical_line
= intern ("vertical-line");
11820 staticpro (&Qvertical_line
);
11821 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11822 staticpro (&Qvertical_scroll_bar
);
11823 Qmenu_bar
= intern ("menu-bar");
11824 staticpro (&Qmenu_bar
);
11826 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11827 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11828 staticpro (&Qmouse_fixup_help_message
);
11831 Qabove_handle
= intern ("above-handle");
11832 staticpro (&Qabove_handle
);
11833 Qhandle
= intern ("handle");
11834 staticpro (&Qhandle
);
11835 Qbelow_handle
= intern ("below-handle");
11836 staticpro (&Qbelow_handle
);
11837 Qup
= intern ("up");
11839 Qdown
= intern ("down");
11840 staticpro (&Qdown
);
11841 Qtop
= intern ("top");
11843 Qbottom
= intern ("bottom");
11844 staticpro (&Qbottom
);
11845 Qend_scroll
= intern ("end-scroll");
11846 staticpro (&Qend_scroll
);
11847 Qratio
= intern ("ratio");
11848 staticpro (&Qratio
);
11850 Qevent_kind
= intern ("event-kind");
11851 staticpro (&Qevent_kind
);
11852 Qevent_symbol_elements
= intern ("event-symbol-elements");
11853 staticpro (&Qevent_symbol_elements
);
11854 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11855 staticpro (&Qevent_symbol_element_mask
);
11856 Qmodifier_cache
= intern ("modifier-cache");
11857 staticpro (&Qmodifier_cache
);
11859 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11860 staticpro (&Qrecompute_lucid_menubar
);
11861 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11862 staticpro (&Qactivate_menubar_hook
);
11864 Qpolling_period
= intern ("polling-period");
11865 staticpro (&Qpolling_period
);
11867 Qinput_method_function
= intern ("input-method-function");
11868 staticpro (&Qinput_method_function
);
11870 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11871 staticpro (&Qinput_method_exit_on_first_char
);
11872 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11873 staticpro (&Qinput_method_use_echo_area
);
11875 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11876 Fset (Qinput_method_use_echo_area
, Qnil
);
11878 last_point_position_buffer
= Qnil
;
11879 last_point_position_window
= Qnil
;
11882 struct event_head
*p
;
11884 for (p
= head_table
;
11885 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11888 *p
->var
= intern (p
->name
);
11889 staticpro (p
->var
);
11890 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11891 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11895 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11896 staticpro (&button_down_location
);
11897 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11898 staticpro (&mouse_syms
);
11899 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11900 staticpro (&wheel_syms
);
11904 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11906 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11907 for (i
= 0; i
< len
; i
++)
11908 if (modifier_names
[i
])
11909 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11910 staticpro (&modifier_symbols
);
11913 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11914 staticpro (&recent_keys
);
11916 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11917 staticpro (&this_command_keys
);
11919 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11920 staticpro (&raw_keybuf
);
11922 Qextended_command_history
= intern ("extended-command-history");
11923 Fset (Qextended_command_history
, Qnil
);
11924 staticpro (&Qextended_command_history
);
11926 accent_key_syms
= Qnil
;
11927 staticpro (&accent_key_syms
);
11929 func_key_syms
= Qnil
;
11930 staticpro (&func_key_syms
);
11932 drag_n_drop_syms
= Qnil
;
11933 staticpro (&drag_n_drop_syms
);
11935 unread_switch_frame
= Qnil
;
11936 staticpro (&unread_switch_frame
);
11938 internal_last_event_frame
= Qnil
;
11939 staticpro (&internal_last_event_frame
);
11941 read_key_sequence_cmd
= Qnil
;
11942 staticpro (&read_key_sequence_cmd
);
11944 menu_bar_one_keymap_changed_items
= Qnil
;
11945 staticpro (&menu_bar_one_keymap_changed_items
);
11947 menu_bar_items_vector
= Qnil
;
11948 staticpro (&menu_bar_items_vector
);
11950 help_form_saved_window_configs
= Qnil
;
11951 staticpro (&help_form_saved_window_configs
);
11953 defsubr (&Scurrent_idle_time
);
11954 defsubr (&Sevent_symbol_parse_modifiers
);
11955 defsubr (&Sevent_convert_list
);
11956 defsubr (&Sread_key_sequence
);
11957 defsubr (&Sread_key_sequence_vector
);
11958 defsubr (&Srecursive_edit
);
11959 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11960 defsubr (&Strack_mouse
);
11962 defsubr (&Sinput_pending_p
);
11963 defsubr (&Scommand_execute
);
11964 defsubr (&Srecent_keys
);
11965 defsubr (&Sthis_command_keys
);
11966 defsubr (&Sthis_command_keys_vector
);
11967 defsubr (&Sthis_single_command_keys
);
11968 defsubr (&Sthis_single_command_raw_keys
);
11969 defsubr (&Sreset_this_command_lengths
);
11970 defsubr (&Sclear_this_command_keys
);
11971 defsubr (&Ssuspend_emacs
);
11972 defsubr (&Sabort_recursive_edit
);
11973 defsubr (&Sexit_recursive_edit
);
11974 defsubr (&Srecursion_depth
);
11975 defsubr (&Stop_level
);
11976 defsubr (&Sdiscard_input
);
11977 defsubr (&Sopen_dribble_file
);
11978 defsubr (&Sset_input_interrupt_mode
);
11979 defsubr (&Sset_output_flow_control
);
11980 defsubr (&Sset_input_meta_mode
);
11981 defsubr (&Sset_quit_char
);
11982 defsubr (&Sset_input_mode
);
11983 defsubr (&Scurrent_input_mode
);
11984 defsubr (&Sexecute_extended_command
);
11985 defsubr (&Sposn_at_point
);
11986 defsubr (&Sposn_at_x_y
);
11988 DEFVAR_LISP ("last-command-event", &last_command_event
,
11989 doc
: /* Last input event that was part of a command. */);
11991 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11992 doc
: /* Last input event in a command, except for mouse menu events.
11993 Mouse menus give back keys that don't look like mouse events;
11994 this variable holds the actual mouse event that led to the menu,
11995 so that you can determine whether the command was run by mouse or not. */);
11997 DEFVAR_LISP ("last-input-event", &last_input_event
,
11998 doc
: /* Last input event. */);
12000 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
12001 doc
: /* List of events to be read as the command input.
12002 These events are processed first, before actual keyboard input.
12003 Events read from this list are not normally added to `this-command-keys',
12004 as they will already have been added once as they were read for the first time.
12005 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12006 Vunread_command_events
= Qnil
;
12008 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12009 doc
: /* If not -1, an object to be read as next command input event. */);
12011 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12012 doc
: /* List of events to be processed as input by input methods.
12013 These events are processed before `unread-command-events'
12014 and actual keyboard input, but are not given to `input-method-function'. */);
12015 Vunread_post_input_method_events
= Qnil
;
12017 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12018 doc
: /* List of events to be processed as input by input methods.
12019 These events are processed after `unread-command-events', but
12020 before actual keyboard input.
12021 If there's an active input method, the events are given to
12022 `input-method-function'. */);
12023 Vunread_input_method_events
= Qnil
;
12025 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12026 doc
: /* Meta-prefix character code.
12027 Meta-foo as command input turns into this character followed by foo. */);
12028 XSETINT (meta_prefix_char
, 033);
12030 DEFVAR_KBOARD ("last-command", Vlast_command
,
12031 doc
: /* The last command executed.
12032 Normally a symbol with a function definition, but can be whatever was found
12033 in the keymap, or whatever the variable `this-command' was set to by that
12036 The value `mode-exit' is special; it means that the previous command
12037 read an event that told it to exit, and it did so and unread that event.
12038 In other words, the present command is the event that made the previous
12041 The value `kill-region' is special; it means that the previous command
12042 was a kill command.
12044 `last-command' has a separate binding for each terminal device.
12045 See Info node `(elisp)Multiple displays'. */);
12047 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12048 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12050 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12051 doc
: /* Last command that may be repeated.
12052 The last command executed that was not bound to an input event.
12053 This is the command `repeat' will try to repeat. */);
12055 DEFVAR_LISP ("this-command", &Vthis_command
,
12056 doc
: /* The command now being executed.
12057 The command can set this variable; whatever is put here
12058 will be in `last-command' during the following command. */);
12059 Vthis_command
= Qnil
;
12061 DEFVAR_LISP ("this-command-keys-shift-translated",
12062 &Vthis_command_keys_shift_translated
,
12063 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12064 Shift-translation occurs when there is no binding for the key sequence
12065 as entered, but a binding was found by changing an upper-case letter
12066 to lower-case, or a shifted function key to an unshifted one. */);
12067 Vthis_command_keys_shift_translated
= Qnil
;
12069 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12070 doc
: /* The command bound to the current key sequence before remapping.
12071 It equals `this-command' if the original command was not remapped through
12072 any of the active keymaps. Otherwise, the value of `this-command' is the
12073 result of looking up the original command in the active keymaps. */);
12074 Vthis_original_command
= Qnil
;
12076 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12077 doc
: /* *Number of input events between auto-saves.
12078 Zero means disable autosaving due to number of characters typed. */);
12079 auto_save_interval
= 300;
12081 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12082 doc
: /* *Number of seconds idle time before auto-save.
12083 Zero or nil means disable auto-saving due to idleness.
12084 After auto-saving due to this many seconds of idle time,
12085 Emacs also does a garbage collection if that seems to be warranted. */);
12086 XSETFASTINT (Vauto_save_timeout
, 30);
12088 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12089 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12090 The value may be integer or floating point. */);
12091 Vecho_keystrokes
= make_number (1);
12093 DEFVAR_INT ("polling-period", &polling_period
,
12094 doc
: /* *Interval between polling for input during Lisp execution.
12095 The reason for polling is to make C-g work to stop a running program.
12096 Polling is needed only when using X windows and SIGIO does not work.
12097 Polling is automatically disabled in all other cases. */);
12098 polling_period
= 2;
12100 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12101 doc
: /* *Maximum time between mouse clicks to make a double-click.
12102 Measured in milliseconds. The value nil means disable double-click
12103 recognition; t means double-clicks have no time limit and are detected
12104 by position only. */);
12105 Vdouble_click_time
= make_number (500);
12107 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12108 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12109 On window-system frames, value is the number of pixels the mouse may have
12110 moved horizontally or vertically between two clicks to make a double-click.
12111 On non window-system frames, value is interpreted in units of 1/8 characters
12114 This variable is also the threshold for motion of the mouse
12115 to count as a drag. */);
12116 double_click_fuzz
= 3;
12118 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12119 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12120 inhibit_local_menu_bar_menus
= 0;
12122 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12123 doc
: /* Number of complete key sequences read as input so far.
12124 This includes key sequences read from keyboard macros.
12125 The number is effectively the number of interactive command invocations. */);
12126 num_input_keys
= 0;
12128 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12129 doc
: /* Number of input events read from the keyboard so far.
12130 This does not include events generated by keyboard macros. */);
12131 num_nonmacro_input_events
= 0;
12133 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12134 doc
: /* The frame in which the most recently read event occurred.
12135 If the last event came from a keyboard macro, this is set to `macro'. */);
12136 Vlast_event_frame
= Qnil
;
12138 /* This variable is set up in sysdep.c. */
12139 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12140 doc
: /* The ERASE character as set by the user with stty. */);
12142 DEFVAR_LISP ("help-char", &Vhelp_char
,
12143 doc
: /* Character to recognize as meaning Help.
12144 When it is read, do `(eval help-form)', and display result if it's a string.
12145 If the value of `help-form' is nil, this char can be read normally. */);
12146 XSETINT (Vhelp_char
, Ctl ('H'));
12148 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12149 doc
: /* List of input events to recognize as meaning Help.
12150 These work just like the value of `help-char' (see that). */);
12151 Vhelp_event_list
= Qnil
;
12153 DEFVAR_LISP ("help-form", &Vhelp_form
,
12154 doc
: /* Form to execute when character `help-char' is read.
12155 If the form returns a string, that string is displayed.
12156 If `help-form' is nil, the help char is not recognized. */);
12159 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12160 doc
: /* Command to run when `help-char' character follows a prefix key.
12161 This command is used only when there is no actual binding
12162 for that character after that prefix key. */);
12163 Vprefix_help_command
= Qnil
;
12165 DEFVAR_LISP ("top-level", &Vtop_level
,
12166 doc
: /* Form to evaluate when Emacs starts up.
12167 Useful to set before you dump a modified Emacs. */);
12170 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12171 doc
: /* Translate table for local keyboard input, or nil.
12172 If non-nil, the value should be a char-table. Each character read
12173 from the keyboard is looked up in this char-table. If the value found
12174 there is non-nil, then it is used instead of the actual input character.
12176 The value can also be a string or vector, but this is considered obsolete.
12177 If it is a string or vector of length N, character codes N and up are left
12178 untranslated. In a vector, an element which is nil means "no translation".
12180 This is applied to the characters supplied to input methods, not their
12181 output. See also `translation-table-for-input'.
12183 This variable has a separate binding for each terminal. See Info node
12184 `(elisp)Multiple displays'. */);
12186 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12187 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12188 \(Even if the operating system has support for stopping a process.\) */);
12189 cannot_suspend
= 0;
12191 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12192 doc
: /* Non-nil means prompt with menus when appropriate.
12193 This is done when reading from a keymap that has a prompt string,
12194 for elements that have prompt strings.
12195 The menu is displayed on the screen
12196 if X menus were enabled at configuration
12197 time and the previous event was a mouse click prefix key.
12198 Otherwise, menu prompting uses the echo area. */);
12199 menu_prompting
= 1;
12201 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12202 doc
: /* Character to see next line of menu prompt.
12203 Type this character while in a menu prompt to rotate around the lines of it. */);
12204 XSETINT (menu_prompt_more_char
, ' ');
12206 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12207 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12208 Emacs applies the modifiers of the character stored here to each keyboard
12209 character it reads. For example, after evaluating the expression
12210 (setq extra-keyboard-modifiers ?\\C-x)
12211 all input characters will have the control modifier applied to them.
12213 Note that the character ?\\C-@, equivalent to the integer zero, does
12214 not count as a control character; rather, it counts as a character
12215 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12216 cancels any modification. */);
12217 extra_keyboard_modifiers
= 0;
12219 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12220 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12221 The command loop sets this to nil before each command,
12222 and tests the value when the command returns.
12223 Buffer modification stores t in this variable. */);
12224 Vdeactivate_mark
= Qnil
;
12225 Qdeactivate_mark
= intern ("deactivate-mark");
12226 staticpro (&Qdeactivate_mark
);
12228 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12229 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12230 Vcommand_hook_internal
= Qnil
;
12232 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12233 doc
: /* Normal hook run before each command is executed.
12234 If an unhandled error happens in running this hook,
12235 the hook value is set to nil, since otherwise the error
12236 might happen repeatedly and make Emacs nonfunctional. */);
12237 Vpre_command_hook
= Qnil
;
12239 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12240 doc
: /* Normal hook run after each command is executed.
12241 If an unhandled error happens in running this hook,
12242 the hook value is set to nil, since otherwise the error
12243 might happen repeatedly and make Emacs nonfunctional. */);
12244 Vpost_command_hook
= Qnil
;
12247 DEFVAR_LISP ("echo-area-clear-hook", ...,
12248 doc
: /* Normal hook run when clearing the echo area. */);
12250 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12251 staticpro (&Qecho_area_clear_hook
);
12252 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12254 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12255 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12256 Vlucid_menu_bar_dirty_flag
= Qnil
;
12258 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12259 doc
: /* List of menu bar items to move to the end of the menu bar.
12260 The elements of the list are event types that may have menu bar bindings. */);
12261 Vmenu_bar_final_items
= Qnil
;
12263 DEFVAR_KBOARD ("overriding-terminal-local-map",
12264 Voverriding_terminal_local_map
,
12265 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12266 If this variable is non-nil, it is used as a keymap instead of the
12267 buffer's local map, and the minor mode keymaps and text property keymaps.
12268 It also replaces `overriding-local-map'.
12270 This variable is intended to let commands such as `universal-argument'
12271 set up a different keymap for reading the next command.
12273 `overriding-terminal-local-map' has a separate binding for each
12275 See Info node `(elisp)Multiple displays'. */);
12277 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12278 doc
: /* Keymap that overrides all other local keymaps.
12279 If this variable is non-nil, it is used as a keymap--replacing the
12280 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12281 Voverriding_local_map
= Qnil
;
12283 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12284 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12285 Otherwise, the menu bar continues to reflect the buffer's local map
12286 and the minor mode maps regardless of `overriding-local-map'. */);
12287 Voverriding_local_map_menu_flag
= Qnil
;
12289 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12290 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12291 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12293 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12294 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12296 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12297 doc
: /* Alist of system-specific X windows key symbols.
12298 Each element should have the form (N . SYMBOL) where N is the
12299 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12300 and SYMBOL is its name.
12302 `system-key-alist' has a separate binding for each terminal device.
12303 See Info node `(elisp)Multiple displays'. */);
12305 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12306 doc
: /* Keymap that translates key sequences to key sequences during input.
12307 This is used mainly for mapping key sequences into some preferred
12308 key events (symbols).
12310 The `read-key-sequence' function replaces any subsequence bound by
12311 `local-function-key-map' with its binding. More precisely, when the
12312 active keymaps have no binding for the current key sequence but
12313 `local-function-key-map' binds a suffix of the sequence to a vector or
12314 string, `read-key-sequence' replaces the matching suffix with its
12315 binding, and continues with the new sequence.
12317 If the binding is a function, it is called with one argument (the prompt)
12318 and its return value (a key sequence) is used.
12320 The events that come from bindings in `local-function-key-map' are not
12321 themselves looked up in `local-function-key-map'.
12323 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12324 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12325 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12326 typing `ESC O P x' would return [f1 x].
12328 `local-function-key-map' has a separate binding for each terminal
12329 device. See Info node `(elisp)Multiple displays'. If you need to
12330 define a binding on all terminals, change `function-key-map'
12331 instead. Initially, `local-function-key-map' is an empty keymap that
12332 has `function-key-map' as its parent on all terminal devices. */);
12334 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12335 doc
: /* Keymap that decodes input escape sequences.
12336 This is used mainly for mapping ASCII function key sequences into
12337 real Emacs function key events (symbols).
12339 The `read-key-sequence' function replaces any subsequence bound by
12340 `input-decode-map' with its binding. Contrary to `function-key-map',
12341 this map applies its rebinding regardless of the presence of an ordinary
12342 binding. So it is more like `key-translation-map' except that it applies
12343 before `function-key-map' rather than after.
12345 If the binding is a function, it is called with one argument (the prompt)
12346 and its return value (a key sequence) is used.
12348 The events that come from bindings in `input-decode-map' are not
12349 themselves looked up in `input-decode-map'.
12351 This variable is keyboard-local. */);
12353 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12354 doc
: /* The parent keymap of all `local-function-key-map' instances.
12355 Function key definitions that apply to all terminal devices should go
12356 here. If a mapping is defined in both the current
12357 `local-function-key-map' binding and this variable, then the local
12358 definition will take precendence. */);
12359 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12361 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12362 doc
: /* Keymap of key translations that can override keymaps.
12363 This keymap works like `function-key-map', but comes after that,
12364 and its non-prefix bindings override ordinary bindings.
12365 Another difference is that it is global rather than keyboard-local. */);
12366 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12368 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12369 doc
: /* List of deferred actions to be performed at a later time.
12370 The precise format isn't relevant here; we just check whether it is nil. */);
12371 Vdeferred_action_list
= Qnil
;
12373 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12374 doc
: /* Function to call to handle deferred actions, after each command.
12375 This function is called with no arguments after each command
12376 whenever `deferred-action-list' is non-nil. */);
12377 Vdeferred_action_function
= Qnil
;
12379 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12380 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12381 The value can be a length of time to show the message for.
12382 If the value is non-nil and not a number, we wait 2 seconds. */);
12383 Vsuggest_key_bindings
= Qt
;
12385 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12386 doc
: /* List of active absolute time timers in order of increasing time. */);
12387 Vtimer_list
= Qnil
;
12389 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12390 doc
: /* List of active idle-time timers in order of increasing time. */);
12391 Vtimer_idle_list
= Qnil
;
12393 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12394 doc
: /* If non-nil, the function that implements the current input method.
12395 It's called with one argument, a printing character that was just read.
12396 \(That means a character with code 040...0176.)
12397 Typically this function uses `read-event' to read additional events.
12398 When it does so, it should first bind `input-method-function' to nil
12399 so it will not be called recursively.
12401 The function should return a list of zero or more events
12402 to be used as input. If it wants to put back some events
12403 to be reconsidered, separately, by the input method,
12404 it can add them to the beginning of `unread-command-events'.
12406 The input method function can find in `input-method-previous-message'
12407 the previous echo area message.
12409 The input method function should refer to the variables
12410 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12411 for guidance on what to do. */);
12412 Vinput_method_function
= Qnil
;
12414 DEFVAR_LISP ("input-method-previous-message",
12415 &Vinput_method_previous_message
,
12416 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12417 This variable exists because `read-event' clears the echo area
12418 before running the input method. It is nil if there was no message. */);
12419 Vinput_method_previous_message
= Qnil
;
12421 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12422 doc
: /* If non-nil, the function that implements the display of help.
12423 It's called with one argument, the help string to display. */);
12424 Vshow_help_function
= Qnil
;
12426 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12427 doc
: /* If non-nil, suppress point adjustment after executing a command.
12429 After a command is executed, if point is moved into a region that has
12430 special properties (e.g. composition, display), we adjust point to
12431 the boundary of the region. But, when a command sets this variable to
12432 non-nil, we suppress the point adjustment.
12434 This variable is set to nil before reading a command, and is checked
12435 just after executing the command. */);
12436 Vdisable_point_adjustment
= Qnil
;
12438 DEFVAR_LISP ("global-disable-point-adjustment",
12439 &Vglobal_disable_point_adjustment
,
12440 doc
: /* *If non-nil, always suppress point adjustment.
12442 The default value is nil, in which case, point adjustment are
12443 suppressed only after special commands that set
12444 `disable-point-adjustment' (which see) to non-nil. */);
12445 Vglobal_disable_point_adjustment
= Qnil
;
12447 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12448 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12449 If the value is not a number, such messages don't time out. */);
12450 Vminibuffer_message_timeout
= make_number (2);
12452 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12453 doc
: /* If non-nil, any keyboard input throws to this symbol.
12454 The value of that variable is passed to `quit-flag' and later causes a
12455 peculiar kind of quitting. */);
12456 Vthrow_on_input
= Qnil
;
12458 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12459 doc
: /* If non-nil, function to output error messages.
12460 The arguments are the error data, a list of the form
12461 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12462 such as just as `condition-case' would bind its variable to,
12463 the context (a string which normally goes at the start of the message),
12464 and the Lisp function within which the error was signaled. */);
12465 Vcommand_error_function
= Qnil
;
12467 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12468 &Venable_disabled_menus_and_buttons
,
12469 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12471 Help functions bind this to allow help on disabled menu items
12472 and tool-bar buttons. */);
12473 Venable_disabled_menus_and_buttons
= Qnil
;
12475 /* Create the initial keyboard. */
12476 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12477 init_kboard (initial_kboard
);
12478 /* Vwindow_system is left at t for now. */
12479 initial_kboard
->next_kboard
= all_kboards
;
12480 all_kboards
= initial_kboard
;
12484 keys_of_keyboard ()
12486 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12487 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12488 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12489 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12490 initial_define_key (meta_map
, 'x', "execute-extended-command");
12492 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12493 "handle-delete-frame");
12494 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12495 "ns-put-working-text");
12496 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12497 "ns-unput-working-text");
12498 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12499 current-prefix-arg, as is done in `handle-switch-frame'.
12500 But `handle-switch-frame is not run from the special-map.
12501 Commands from that map are run in a special way that automatically
12502 preserves the prefix-arg. Restoring the prefix arg here is not just
12503 redundant but harmful:
12505 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12506 - after the first prompt, the exit-minibuffer-hook is run which may
12507 iconify a frame and thus push a `iconify-frame' event.
12508 - after running exit-minibuffer-hook, current-prefix-arg is
12509 restored to the non-nil value it had before the prompt.
12510 - we enter the second prompt.
12511 current-prefix-arg is non-nil, prefix-arg is nil.
12512 - before running the first real event, we run the special iconify-frame
12513 event, but we pass the `special' arg to execute-command so
12514 current-prefix-arg and prefix-arg are left untouched.
12515 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12516 - the next key event will have a spuriously non-nil current-prefix-arg. */
12517 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12519 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12521 /* Handling it at such a low-level causes read_key_sequence to get
12522 * confused because it doesn't realize that the current_buffer was
12523 * changed by read_char.
12525 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12526 * "handle-select-window"); */
12527 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12528 "handle-save-session");
12531 /* Define a special event which is raised for dbus callback
12533 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12534 "dbus-handle-event");
12538 /* Mark the pointers in the kboard objects.
12539 Called by the Fgarbage_collector. */
12545 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12547 if (kb
->kbd_macro_buffer
)
12548 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12550 mark_object (kb
->Voverriding_terminal_local_map
);
12551 mark_object (kb
->Vlast_command
);
12552 mark_object (kb
->Vreal_last_command
);
12553 mark_object (kb
->Vkeyboard_translate_table
);
12554 mark_object (kb
->Vlast_repeatable_command
);
12555 mark_object (kb
->Vprefix_arg
);
12556 mark_object (kb
->Vlast_prefix_arg
);
12557 mark_object (kb
->kbd_queue
);
12558 mark_object (kb
->defining_kbd_macro
);
12559 mark_object (kb
->Vlast_kbd_macro
);
12560 mark_object (kb
->Vsystem_key_alist
);
12561 mark_object (kb
->system_key_syms
);
12562 mark_object (kb
->Vwindow_system
);
12563 mark_object (kb
->Vinput_decode_map
);
12564 mark_object (kb
->Vlocal_function_key_map
);
12565 mark_object (kb
->Vdefault_minibuffer_frame
);
12566 mark_object (kb
->echo_string
);
12569 struct input_event
*event
;
12570 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12572 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12573 event
= kbd_buffer
;
12574 if (event
->kind
!= SELECTION_REQUEST_EVENT
12575 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12577 mark_object (event
->x
);
12578 mark_object (event
->y
);
12580 mark_object (event
->frame_or_window
);
12581 mark_object (event
->arg
);
12586 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12587 (do not change this comment) */