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_enable
;
499 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
500 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
501 extern Lisp_Object Qmenu_item
;
503 /* An event header symbol HEAD may have a property named
504 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
505 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
506 mask of modifiers applied to it. If present, this is used to help
507 speed up parse_modifiers. */
508 Lisp_Object Qevent_symbol_element_mask
;
510 /* An unmodified event header BASE may have a property named
511 Qmodifier_cache, which is an alist mapping modifier masks onto
512 modified versions of BASE. If present, this helps speed up
514 Lisp_Object Qmodifier_cache
;
516 /* Symbols to use for parts of windows. */
517 Lisp_Object Qmode_line
;
518 Lisp_Object Qvertical_line
;
519 Lisp_Object Qvertical_scroll_bar
;
520 Lisp_Object Qmenu_bar
;
521 extern Lisp_Object Qleft_margin
, Qright_margin
;
522 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
523 extern Lisp_Object QCmap
;
525 Lisp_Object
recursive_edit_unwind (), command_loop ();
526 Lisp_Object
Fthis_command_keys ();
527 Lisp_Object Qextended_command_history
;
528 EMACS_TIME
timer_check ();
530 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
532 extern char *x_get_keysym_name ();
534 static void record_menu_key ();
535 static int echo_length ();
537 Lisp_Object Qpolling_period
;
539 /* List of absolute timers. Appears in order of next scheduled event. */
540 Lisp_Object Vtimer_list
;
542 /* List of idle time timers. Appears in order of next scheduled event. */
543 Lisp_Object Vtimer_idle_list
;
545 /* Incremented whenever a timer is run. */
548 extern Lisp_Object Vprint_level
, Vprint_length
;
550 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
552 EMACS_TIME
*input_available_clear_time
;
554 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
555 Default is 1 if INTERRUPT_INPUT is defined. */
558 /* Nonzero while interrupts are temporarily deferred during redisplay. */
559 int interrupts_deferred
;
561 /* Allow m- file to inhibit use of FIONREAD. */
562 #ifdef BROKEN_FIONREAD
566 /* We are unable to use interrupts if FIONREAD is not available,
567 so flush SIGIO so we won't try. */
568 #if !defined (FIONREAD)
574 /* If we support a window system, turn on the code to poll periodically
575 to detect C-g. It isn't actually used when doing interrupt input. */
576 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
577 #define POLL_FOR_INPUT
580 /* After a command is executed, if point is moved into a region that
581 has specific properties (e.g. composition, display), we adjust
582 point to the boundary of the region. But, if a command sets this
583 variable to non-nil, we suppress this point adjustment. This
584 variable is set to nil before reading a command. */
586 Lisp_Object Vdisable_point_adjustment
;
588 /* If non-nil, always disable point adjustment. */
590 Lisp_Object Vglobal_disable_point_adjustment
;
592 /* The time when Emacs started being idle. */
594 static EMACS_TIME timer_idleness_start_time
;
596 /* After Emacs stops being idle, this saves the last value
597 of timer_idleness_start_time from when it was idle. */
599 static EMACS_TIME timer_last_idleness_start_time
;
601 /* If non-nil, events produced by disabled menu items and tool-bar
602 buttons are not ignored. Help functions bind this to allow help on
603 those items and buttons. */
604 Lisp_Object Venable_disabled_menus_and_buttons
;
607 /* Global variable declarations. */
609 /* Flags for readable_events. */
610 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
611 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
612 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
614 /* Function for init_keyboard to call with no args (if nonzero). */
615 void (*keyboard_init_hook
) ();
617 static int read_avail_input
P_ ((int));
618 static void get_input_pending
P_ ((int *, int));
619 static int readable_events
P_ ((int));
620 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
621 Lisp_Object
, int *));
622 static Lisp_Object
read_char_x_menu_prompt ();
623 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
625 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
626 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
627 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
628 enum scroll_bar_part
,
629 Lisp_Object
, Lisp_Object
,
632 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
633 Lisp_Object
, char **,
634 Lisp_Object
*, unsigned));
635 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
636 static void save_getcjmp
P_ ((jmp_buf));
637 static void save_getcjmp ();
638 static void restore_getcjmp
P_ ((jmp_buf));
639 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
640 static void clear_event
P_ ((struct input_event
*));
641 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
642 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
643 static void handle_interrupt
P_ ((void));
644 static void timer_start_idle
P_ ((void));
645 static void timer_stop_idle
P_ ((void));
646 static void timer_resume_idle
P_ ((void));
647 static SIGTYPE handle_user_signal
P_ ((int));
648 static char *find_user_signal_name
P_ ((int));
649 static int store_user_signal_events
P_ ((void));
651 /* Nonzero means don't try to suspend even if the operating system seems
653 static int cannot_suspend
;
655 extern Lisp_Object Qidentity
, Qonly
;
657 /* Install the string STR as the beginning of the string of echoing,
658 so that it serves as a prompt for the next character.
659 Also start echoing. */
665 current_kboard
->echo_string
= str
;
666 current_kboard
->echo_after_prompt
= SCHARS (str
);
670 /* Add C to the echo string, if echoing is going on.
671 C can be a character, which is printed prettily ("M-C-x" and all that
672 jazz), or a symbol, whose name is printed. */
678 if (current_kboard
->immediate_echo
)
680 int size
= KEY_DESCRIPTION_SIZE
+ 100;
681 char *buffer
= (char *) alloca (size
);
683 Lisp_Object echo_string
;
685 echo_string
= current_kboard
->echo_string
;
687 /* If someone has passed us a composite event, use its head symbol. */
692 ptr
= push_key_description (XINT (c
), ptr
, 1);
694 else if (SYMBOLP (c
))
696 Lisp_Object name
= SYMBOL_NAME (c
);
697 int nbytes
= SBYTES (name
);
699 if (size
- (ptr
- buffer
) < nbytes
)
701 int offset
= ptr
- buffer
;
702 size
= max (2 * size
, size
+ nbytes
);
703 buffer
= (char *) alloca (size
);
704 ptr
= buffer
+ offset
;
707 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
708 STRING_MULTIBYTE (name
), 1);
711 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
714 const char *text
= " (Type ? for further options)";
715 int len
= strlen (text
);
717 if (size
- (ptr
- buffer
) < len
)
719 int offset
= ptr
- buffer
;
721 buffer
= (char *) alloca (size
);
722 ptr
= buffer
+ offset
;
725 bcopy (text
, ptr
, len
);
729 /* Replace a dash from echo_dash with a space, otherwise
730 add a space at the end as a separator between keys. */
731 if (STRINGP (echo_string
)
732 && SCHARS (echo_string
) > 1)
734 Lisp_Object last_char
, prev_char
, idx
;
736 idx
= make_number (SCHARS (echo_string
) - 2);
737 prev_char
= Faref (echo_string
, idx
);
739 idx
= make_number (SCHARS (echo_string
) - 1);
740 last_char
= Faref (echo_string
, idx
);
742 /* We test PREV_CHAR to make sure this isn't the echoing
744 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
745 Faset (echo_string
, idx
, make_number (' '));
747 echo_string
= concat2 (echo_string
, build_string (" "));
749 else if (STRINGP (echo_string
))
750 echo_string
= concat2 (echo_string
, build_string (" "));
752 current_kboard
->echo_string
753 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
759 /* Temporarily add a dash to the end of the echo string if it's not
760 empty, so that it serves as a mini-prompt for the very next character. */
765 /* Do nothing if not echoing at all. */
766 if (NILP (current_kboard
->echo_string
))
769 if (!current_kboard
->immediate_echo
770 && SCHARS (current_kboard
->echo_string
) == 0)
773 /* Do nothing if we just printed a prompt. */
774 if (current_kboard
->echo_after_prompt
775 == SCHARS (current_kboard
->echo_string
))
778 /* Do nothing if we have already put a dash at the end. */
779 if (SCHARS (current_kboard
->echo_string
) > 1)
781 Lisp_Object last_char
, prev_char
, idx
;
783 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
784 prev_char
= Faref (current_kboard
->echo_string
, idx
);
786 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
787 last_char
= Faref (current_kboard
->echo_string
, idx
);
789 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
793 /* Put a dash at the end of the buffer temporarily,
794 but make it go away when the next character is added. */
795 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
800 /* Display the current echo string, and begin echoing if not already
806 if (!current_kboard
->immediate_echo
)
809 current_kboard
->immediate_echo
= 1;
811 for (i
= 0; i
< this_command_key_count
; i
++)
815 /* Set before_command_echo_length to the value that would
816 have been saved before the start of this subcommand in
817 command_loop_1, if we had already been echoing then. */
818 if (i
== this_single_command_key_start
)
819 before_command_echo_length
= echo_length ();
821 c
= XVECTOR (this_command_keys
)->contents
[i
];
822 if (! (EVENT_HAS_PARAMETERS (c
)
823 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
827 /* Set before_command_echo_length to the value that would
828 have been saved before the start of this subcommand in
829 command_loop_1, if we had already been echoing then. */
830 if (this_command_key_count
== this_single_command_key_start
)
831 before_command_echo_length
= echo_length ();
833 /* Put a dash at the end to invite the user to type more. */
838 message3_nolog (current_kboard
->echo_string
,
839 SBYTES (current_kboard
->echo_string
),
840 STRING_MULTIBYTE (current_kboard
->echo_string
));
843 /* Record in what buffer we echoed, and from which kboard. */
844 echo_message_buffer
= echo_area_buffer
[0];
845 echo_kboard
= current_kboard
;
847 if (waiting_for_input
&& !NILP (Vquit_flag
))
848 quit_throw_to_read_char ();
851 /* Turn off echoing, for the start of a new command. */
856 current_kboard
->immediate_echo
= 0;
857 current_kboard
->echo_after_prompt
= -1;
858 current_kboard
->echo_string
= Qnil
;
859 ok_to_echo_at_next_pause
= NULL
;
861 echo_message_buffer
= Qnil
;
864 /* Return the length of the current echo string. */
869 return (STRINGP (current_kboard
->echo_string
)
870 ? SCHARS (current_kboard
->echo_string
)
874 /* Truncate the current echo message to its first LEN chars.
875 This and echo_char get used by read_key_sequence when the user
876 switches frames while entering a key sequence. */
879 echo_truncate (nchars
)
882 if (STRINGP (current_kboard
->echo_string
))
883 current_kboard
->echo_string
884 = Fsubstring (current_kboard
->echo_string
,
885 make_number (0), make_number (nchars
));
886 truncate_echo_area (nchars
);
890 /* Functions for manipulating this_command_keys. */
892 add_command_key (key
)
895 #if 0 /* Not needed after we made Freset_this_command_lengths
896 do the job immediately. */
897 /* If reset-this-command-length was called recently, obey it now.
898 See the doc string of that function for an explanation of why. */
899 if (before_command_restore_flag
)
901 this_command_key_count
= before_command_key_count_1
;
902 if (this_command_key_count
< this_single_command_key_start
)
903 this_single_command_key_start
= this_command_key_count
;
904 echo_truncate (before_command_echo_length_1
);
905 before_command_restore_flag
= 0;
909 if (this_command_key_count
>= ASIZE (this_command_keys
))
910 this_command_keys
= larger_vector (this_command_keys
,
911 2 * ASIZE (this_command_keys
),
914 ASET (this_command_keys
, this_command_key_count
, key
);
915 ++this_command_key_count
;
922 int count
= SPECPDL_INDEX ();
925 if (command_loop_level
> 0)
927 specbind (Qstandard_output
, Qt
);
928 specbind (Qstandard_input
, Qt
);
931 #ifdef HAVE_WINDOW_SYSTEM
932 /* The command loop has started an hourglass timer, so we have to
933 cancel it here, otherwise it will fire because the recursive edit
934 can take some time. Do not check for display_hourglass_p here,
935 because it could already be nil. */
939 /* This function may have been called from a debugger called from
940 within redisplay, for instance by Edebugging a function called
941 from fontification-functions. We want to allow redisplay in
942 the debugging session.
944 The recursive edit is left with a `(throw exit ...)'. The `exit'
945 tag is not caught anywhere in redisplay, i.e. when we leave the
946 recursive edit, the original redisplay leading to the recursive
947 edit will be unwound. The outcome should therefore be safe. */
948 specbind (Qinhibit_redisplay
, Qnil
);
951 val
= command_loop ();
953 Fsignal (Qquit
, Qnil
);
954 /* Handle throw from read_minibuf when using minibuffer
955 while it's active but we're in another window. */
957 xsignal1 (Qerror
, val
);
959 return unbind_to (count
, Qnil
);
962 /* When an auto-save happens, record the "time", and don't do again soon. */
967 last_auto_save
= num_nonmacro_input_events
;
970 /* Make an auto save happen as soon as possible at command level. */
973 force_auto_save_soon ()
975 last_auto_save
= - auto_save_interval
- 1;
977 record_asynch_buffer_change ();
980 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
981 doc
: /* Invoke the editor command loop recursively.
982 To get out of the recursive edit, a command can do `(throw 'exit nil)';
983 that tells this function to return.
984 Alternatively, `(throw 'exit t)' makes this function signal an error.
985 This function is called by the editor initialization to begin editing. */)
988 int count
= SPECPDL_INDEX ();
991 /* If we enter while input is blocked, don't lock up here.
992 This may happen through the debugger during redisplay. */
996 command_loop_level
++;
997 update_mode_lines
= 1;
999 if (command_loop_level
1000 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1001 buffer
= Fcurrent_buffer ();
1005 /* If we leave recursive_edit_1 below with a `throw' for instance,
1006 like it is done in the splash screen display, we have to
1007 make sure that we restore single_kboard as command_loop_1
1008 would have done if it were left normally. */
1009 if (command_loop_level
> 0)
1010 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1011 record_unwind_protect (recursive_edit_unwind
, buffer
);
1013 recursive_edit_1 ();
1014 return unbind_to (count
, Qnil
);
1018 recursive_edit_unwind (buffer
)
1021 if (BUFFERP (buffer
))
1022 Fset_buffer (buffer
);
1024 command_loop_level
--;
1025 update_mode_lines
= 1;
1030 #if 0 /* These two functions are now replaced with
1031 temporarily_switch_to_single_kboard. */
1035 #if 0 /* Theory: if there's anything in Vunread_command_events,
1036 it will right away be read by read_key_sequence,
1037 and then if we do switch KBOARDS, it will go into the side
1038 queue then. So we don't need to do anything special here -- rms. */
1039 if (CONSP (Vunread_command_events
))
1041 current_kboard
->kbd_queue
1042 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1043 current_kboard
->kbd_queue_has_data
= 1;
1045 Vunread_command_events
= Qnil
;
1050 /* Switch to the single-kboard state, making current_kboard
1051 the only KBOARD from which further input is accepted. */
1054 single_kboard_state ()
1060 /* If we're in single_kboard state for kboard KBOARD,
1064 not_single_kboard_state (kboard
)
1067 if (kboard
== current_kboard
)
1071 /* Maintain a stack of kboards, so other parts of Emacs
1072 can switch temporarily to the kboard of a given frame
1073 and then revert to the previous status. */
1078 struct kboard_stack
*next
;
1081 static struct kboard_stack
*kboard_stack
;
1087 struct kboard_stack
*p
1088 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1090 p
->next
= kboard_stack
;
1091 p
->kboard
= current_kboard
;
1101 struct kboard_stack
*p
= kboard_stack
;
1103 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1105 if (t
->kboard
== p
->kboard
)
1107 current_kboard
= p
->kboard
;
1114 /* The terminal we remembered has been deleted. */
1115 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1118 kboard_stack
= p
->next
;
1122 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1123 from which further input is accepted. If F is non-nil, set its
1124 KBOARD as the current keyboard.
1126 This function uses record_unwind_protect to return to the previous
1129 If Emacs is already in single_kboard mode, and F's keyboard is
1130 locked, then this function will throw an errow. */
1133 temporarily_switch_to_single_kboard (f
)
1136 int was_locked
= single_kboard
;
1139 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1140 /* We can not switch keyboards while in single_kboard mode.
1141 In rare cases, Lisp code may call `recursive-edit' (or
1142 `read-minibuffer' or `y-or-n-p') after it switched to a
1143 locked frame. For example, this is likely to happen
1144 when server.el connects to a new terminal while Emacs is in
1145 single_kboard mode. It is best to throw an error instead
1146 of presenting the user with a frozen screen. */
1147 error ("Terminal %d is locked, cannot read from it",
1148 FRAME_TERMINAL (f
)->id
);
1150 /* This call is unnecessary, but helps
1151 `restore_kboard_configuration' discover if somebody changed
1152 `current_kboard' behind our back. */
1153 push_kboard (current_kboard
);
1156 current_kboard
= FRAME_KBOARD (f
);
1158 record_unwind_protect (restore_kboard_configuration
,
1159 (was_locked
? Qt
: Qnil
));
1162 #if 0 /* This function is not needed anymore. */
1164 record_single_kboard_state ()
1167 push_kboard (current_kboard
);
1168 record_unwind_protect (restore_kboard_configuration
,
1169 (single_kboard
? Qt
: Qnil
));
1174 restore_kboard_configuration (was_locked
)
1175 Lisp_Object was_locked
;
1177 if (NILP (was_locked
))
1181 struct kboard
*prev
= current_kboard
;
1184 /* The pop should not change the kboard. */
1185 if (single_kboard
&& current_kboard
!= prev
)
1192 /* Handle errors that are not handled at inner levels
1193 by printing an error message and returning to the editor command loop. */
1199 Lisp_Object old_level
, old_length
;
1200 char macroerror
[50];
1202 #ifdef HAVE_WINDOW_SYSTEM
1203 if (display_hourglass_p
)
1204 cancel_hourglass ();
1207 if (!NILP (executing_kbd_macro
))
1209 if (executing_kbd_macro_iterations
== 1)
1210 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1212 sprintf (macroerror
, "After %d kbd macro iterations: ",
1213 executing_kbd_macro_iterations
);
1218 Vstandard_output
= Qt
;
1219 Vstandard_input
= Qt
;
1220 Vexecuting_kbd_macro
= Qnil
;
1221 executing_kbd_macro
= Qnil
;
1222 current_kboard
->Vprefix_arg
= Qnil
;
1223 current_kboard
->Vlast_prefix_arg
= Qnil
;
1226 /* Avoid unquittable loop if data contains a circular list. */
1227 old_level
= Vprint_level
;
1228 old_length
= Vprint_length
;
1229 XSETFASTINT (Vprint_level
, 10);
1230 XSETFASTINT (Vprint_length
, 10);
1231 cmd_error_internal (data
, macroerror
);
1232 Vprint_level
= old_level
;
1233 Vprint_length
= old_length
;
1237 Vinhibit_quit
= Qnil
;
1238 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1239 if (command_loop_level
== 0 && minibuf_level
== 0)
1240 any_kboard_state ();
1243 return make_number (0);
1246 /* Take actions on handling an error. DATA is the data that describes
1249 CONTEXT is a C-string containing ASCII characters only which
1250 describes the context in which the error happened. If we need to
1251 generalize CONTEXT to allow multibyte characters, make it a Lisp
1255 cmd_error_internal (data
, context
)
1259 struct frame
*sf
= SELECTED_FRAME ();
1261 /* The immediate context is not interesting for Quits,
1262 since they are asyncronous. */
1263 if (EQ (XCAR (data
), Qquit
))
1264 Vsignaling_function
= Qnil
;
1269 /* Use user's specified output function if any. */
1270 if (!NILP (Vcommand_error_function
))
1271 call3 (Vcommand_error_function
, data
,
1272 context
? build_string (context
) : empty_unibyte_string
,
1273 Vsignaling_function
);
1274 /* If the window system or terminal frame hasn't been initialized
1275 yet, or we're not interactive, write the message to stderr and exit. */
1276 else if (!sf
->glyphs_initialized_p
1277 /* The initial frame is a special non-displaying frame. It
1278 will be current in daemon mode when there are no frames
1279 to display, and in non-daemon mode before the real frame
1280 has finished initializing. If an error is thrown in the
1281 latter case while creating the frame, then the frame
1282 will never be displayed, so the safest thing to do is
1283 write to stderr and quit. In daemon mode, there are
1284 many other potential errors that do not prevent frames
1285 from being created, so continuing as normal is better in
1287 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1290 print_error_message (data
, Qexternal_debugging_output
,
1291 context
, Vsignaling_function
);
1292 Fterpri (Qexternal_debugging_output
);
1293 Fkill_emacs (make_number (-1));
1297 clear_message (1, 0);
1299 message_log_maybe_newline ();
1302 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1305 Vsignaling_function
= Qnil
;
1308 Lisp_Object
command_loop_1 ();
1309 Lisp_Object
command_loop_2 ();
1310 Lisp_Object
top_level_1 ();
1312 /* Entry to editor-command-loop.
1313 This level has the catches for exiting/returning to editor command loop.
1314 It returns nil to exit recursive edit, t to abort it. */
1319 if (command_loop_level
> 0 || minibuf_level
> 0)
1322 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1323 executing_kbd_macro
= Qnil
;
1329 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1330 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1331 /* Reset single_kboard in case top-level set it while
1332 evaluating an -f option, or we are stuck there for some
1334 any_kboard_state ();
1336 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1337 executing_kbd_macro
= Qnil
;
1339 /* End of file in -batch run causes exit here. */
1345 /* Here we catch errors in execution of commands within the
1346 editing loop, and reenter the editing loop.
1347 When there is an error, cmd_error runs and returns a non-nil
1348 value to us. A value of nil means that command_loop_1 itself
1349 returned due to end of file (or end of kbd macro). */
1354 register Lisp_Object val
;
1357 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1358 while (!NILP (val
));
1366 return Feval (Vtop_level
);
1372 /* On entry to the outer level, run the startup file */
1373 if (!NILP (Vtop_level
))
1374 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1375 else if (!NILP (Vpurify_flag
))
1376 message ("Bare impure Emacs (standard Lisp code not loaded)");
1378 message ("Bare Emacs (standard Lisp code not loaded)");
1382 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1383 doc
: /* Exit all recursive editing levels.
1384 This also exits all active minibuffers. */)
1387 #ifdef HAVE_WINDOW_SYSTEM
1388 if (display_hourglass_p
)
1389 cancel_hourglass ();
1392 /* Unblock input if we enter with input blocked. This may happen if
1393 redisplay traps e.g. during tool-bar update with input blocked. */
1394 while (INPUT_BLOCKED_P
)
1397 return Fthrow (Qtop_level
, Qnil
);
1400 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1401 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1404 if (command_loop_level
> 0 || minibuf_level
> 0)
1405 Fthrow (Qexit
, Qnil
);
1407 error ("No recursive edit is in progress");
1411 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1412 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1415 if (command_loop_level
> 0 || minibuf_level
> 0)
1418 error ("No recursive edit is in progress");
1422 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1424 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1425 of this function. */
1428 tracking_off (old_value
)
1429 Lisp_Object old_value
;
1431 do_mouse_tracking
= old_value
;
1432 if (NILP (old_value
))
1434 /* Redisplay may have been preempted because there was input
1435 available, and it assumes it will be called again after the
1436 input has been processed. If the only input available was
1437 the sort that we have just disabled, then we need to call
1439 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1441 redisplay_preserve_echo_area (6);
1442 get_input_pending (&input_pending
,
1443 READABLE_EVENTS_DO_TIMERS_NOW
);
1449 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1450 doc
: /* Evaluate BODY with mouse movement events enabled.
1451 Within a `track-mouse' form, mouse motion generates input events that
1452 you can read with `read-event'.
1453 Normally, mouse motion is ignored.
1454 usage: (track-mouse BODY...) */)
1458 int count
= SPECPDL_INDEX ();
1461 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1463 do_mouse_tracking
= Qt
;
1465 val
= Fprogn (args
);
1466 return unbind_to (count
, val
);
1469 /* If mouse has moved on some frame, return one of those frames.
1473 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1474 after resizing the tool-bar window. */
1476 int ignore_mouse_drag_p
;
1481 Lisp_Object tail
, frame
;
1483 if (ignore_mouse_drag_p
)
1485 /* ignore_mouse_drag_p = 0; */
1489 FOR_EACH_FRAME (tail
, frame
)
1491 if (XFRAME (frame
)->mouse_moved
)
1492 return XFRAME (frame
);
1498 #endif /* HAVE_MOUSE || HAVE_GPM */
1500 /* This is the actual command reading loop,
1501 sans error-handling encapsulation. */
1503 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1505 void safe_run_hooks
P_ ((Lisp_Object
));
1506 static void adjust_point_for_property
P_ ((int, int));
1508 /* Cancel hourglass from protect_unwind.
1510 #ifdef HAVE_WINDOW_SYSTEM
1512 cancel_hourglass_unwind (arg
)
1515 cancel_hourglass ();
1520 extern int nonundocount
; /* Declared in cmds.c. */
1527 Lisp_Object keybuf
[30];
1529 int prev_modiff
= 0;
1530 struct buffer
*prev_buffer
= NULL
;
1531 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1532 int was_locked
= single_kboard
;
1534 int already_adjusted
= 0;
1536 current_kboard
->Vprefix_arg
= Qnil
;
1537 current_kboard
->Vlast_prefix_arg
= Qnil
;
1538 Vdeactivate_mark
= Qnil
;
1539 waiting_for_input
= 0;
1542 this_command_key_count
= 0;
1543 this_command_key_count_reset
= 0;
1544 this_single_command_key_start
= 0;
1546 if (NILP (Vmemory_full
))
1548 /* Make sure this hook runs after commands that get errors and
1549 throw to top level. */
1550 /* Note that the value cell will never directly contain nil
1551 if the symbol is a local variable. */
1552 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1553 safe_run_hooks (Qpost_command_hook
);
1555 /* If displaying a message, resize the echo area window to fit
1556 that message's size exactly. */
1557 if (!NILP (echo_area_buffer
[0]))
1558 resize_echo_area_exactly ();
1560 if (!NILP (Vdeferred_action_list
))
1561 safe_run_hooks (Qdeferred_action_function
);
1564 /* Do this after running Vpost_command_hook, for consistency. */
1565 current_kboard
->Vlast_command
= Vthis_command
;
1566 current_kboard
->Vreal_last_command
= real_this_command
;
1567 if (!CONSP (last_command_event
))
1568 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1572 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1575 /* Make sure the current window's buffer is selected. */
1576 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1577 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1579 /* Display any malloc warning that just came out. Use while because
1580 displaying one warning can cause another. */
1582 while (pending_malloc_warning
)
1583 display_malloc_warning ();
1585 Vdeactivate_mark
= Qnil
;
1587 /* If minibuffer on and echo area in use,
1588 wait a short time and redraw minibuffer. */
1591 && !NILP (echo_area_buffer
[0])
1592 && EQ (minibuf_window
, echo_area_window
)
1593 && NUMBERP (Vminibuffer_message_timeout
))
1595 /* Bind inhibit-quit to t so that C-g gets read in
1596 rather than quitting back to the minibuffer. */
1597 int count
= SPECPDL_INDEX ();
1598 specbind (Qinhibit_quit
, Qt
);
1600 sit_for (Vminibuffer_message_timeout
, 0, 2);
1602 /* Clear the echo area. */
1604 safe_run_hooks (Qecho_area_clear_hook
);
1606 unbind_to (count
, Qnil
);
1608 /* If a C-g came in before, treat it as input now. */
1609 if (!NILP (Vquit_flag
))
1612 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1617 /* Select the frame that the last event came from. Usually,
1618 switch-frame events will take care of this, but if some lisp
1619 code swallows a switch-frame event, we'll fix things up here.
1620 Is this a good idea? */
1621 if (FRAMEP (internal_last_event_frame
)
1622 && !EQ (internal_last_event_frame
, selected_frame
))
1623 Fselect_frame (internal_last_event_frame
, Qnil
);
1625 /* If it has changed current-menubar from previous value,
1626 really recompute the menubar from the value. */
1627 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1628 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1629 call0 (Qrecompute_lucid_menubar
);
1631 before_command_key_count
= this_command_key_count
;
1632 before_command_echo_length
= echo_length ();
1634 Vthis_command
= Qnil
;
1635 real_this_command
= Qnil
;
1636 Vthis_original_command
= Qnil
;
1637 Vthis_command_keys_shift_translated
= Qnil
;
1639 /* Read next key sequence; i gets its length. */
1640 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1643 /* A filter may have run while we were reading the input. */
1644 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1646 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1647 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1651 /* Now we have read a key sequence of length I,
1652 or else I is 0 and we found end of file. */
1654 if (i
== 0) /* End of file -- happens only in */
1655 return Qnil
; /* a kbd macro, at the end. */
1656 /* -1 means read_key_sequence got a menu that was rejected.
1657 Just loop around and read another command. */
1661 this_command_key_count
= 0;
1662 this_command_key_count_reset
= 0;
1663 this_single_command_key_start
= 0;
1667 last_command_event
= keybuf
[i
- 1];
1669 /* If the previous command tried to force a specific window-start,
1670 forget about that, in case this command moves point far away
1671 from that position. But also throw away beg_unchanged and
1672 end_unchanged information in that case, so that redisplay will
1673 update the whole window properly. */
1674 if (!NILP (XWINDOW (selected_window
)->force_start
))
1677 XWINDOW (selected_window
)->force_start
= Qnil
;
1678 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1679 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1682 cmd
= read_key_sequence_cmd
;
1683 if (!NILP (Vexecuting_kbd_macro
))
1685 if (!NILP (Vquit_flag
))
1687 Vexecuting_kbd_macro
= Qt
;
1688 QUIT
; /* Make some noise. */
1689 /* Will return since macro now empty. */
1693 /* Do redisplay processing after this command except in special
1694 cases identified below. */
1695 prev_buffer
= current_buffer
;
1696 prev_modiff
= MODIFF
;
1697 last_point_position
= PT
;
1698 last_point_position_window
= selected_window
;
1699 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1701 /* By default, we adjust point to a boundary of a region that
1702 has such a property that should be treated intangible
1703 (e.g. composition, display). But, some commands will set
1704 this variable differently. */
1705 Vdisable_point_adjustment
= Qnil
;
1707 /* Process filters and timers may have messed with deactivate-mark.
1708 reset it before we execute the command. */
1709 Vdeactivate_mark
= Qnil
;
1711 /* Remap command through active keymaps */
1712 Vthis_original_command
= cmd
;
1716 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1720 /* Execute the command. */
1722 Vthis_command
= cmd
;
1723 real_this_command
= cmd
;
1724 /* Note that the value cell will never directly contain nil
1725 if the symbol is a local variable. */
1726 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1727 safe_run_hooks (Qpre_command_hook
);
1729 already_adjusted
= 0;
1731 if (NILP (Vthis_command
))
1733 /* nil means key is undefined. */
1734 Lisp_Object keys
= Fvector (i
, keybuf
);
1735 keys
= Fkey_description (keys
, Qnil
);
1737 message_with_string ("%s is undefined", keys
, 0);
1738 current_kboard
->defining_kbd_macro
= Qnil
;
1739 update_mode_lines
= 1;
1740 current_kboard
->Vprefix_arg
= Qnil
;
1744 if (NILP (current_kboard
->Vprefix_arg
))
1746 /* In case we jump to directly_done. */
1747 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1749 /* Recognize some common commands in common situations and
1750 do them directly. */
1751 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1752 && NILP (Vthis_command_keys_shift_translated
)
1753 && !CONSP (Vtransient_mark_mode
))
1755 struct Lisp_Char_Table
*dp
1756 = window_display_table (XWINDOW (selected_window
));
1757 lose
= FETCH_CHAR (PT_BYTE
);
1759 if (! NILP (Vpost_command_hook
))
1760 /* Put this before calling adjust_point_for_property
1761 so it will only get called once in any case. */
1763 if (current_buffer
== prev_buffer
1764 && last_point_position
!= PT
1765 && NILP (Vdisable_point_adjustment
)
1766 && NILP (Vglobal_disable_point_adjustment
))
1767 adjust_point_for_property (last_point_position
, 0);
1768 already_adjusted
= 1;
1769 if (PT
== last_point_position
+ 1
1771 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1772 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1773 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1774 && (lose
>= 0x20 && lose
< 0x7f)))
1775 : (lose
>= 0x20 && lose
< 0x7f))
1776 /* To extract the case of continuation on
1777 wide-column characters. */
1778 && ASCII_BYTE_P (lose
)
1779 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1781 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1783 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1785 && !windows_or_buffers_changed
1786 && EQ (current_buffer
->selective_display
, Qnil
)
1787 && !detect_input_pending ()
1788 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1789 && NILP (Vexecuting_kbd_macro
))
1790 direct_output_forward_char (1);
1793 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1794 && NILP (Vthis_command_keys_shift_translated
)
1795 && !CONSP (Vtransient_mark_mode
))
1797 struct Lisp_Char_Table
*dp
1798 = window_display_table (XWINDOW (selected_window
));
1800 lose
= FETCH_CHAR (PT_BYTE
);
1801 if (! NILP (Vpost_command_hook
))
1803 if (current_buffer
== prev_buffer
1804 && last_point_position
!= PT
1805 && NILP (Vdisable_point_adjustment
)
1806 && NILP (Vglobal_disable_point_adjustment
))
1807 adjust_point_for_property (last_point_position
, 0);
1808 already_adjusted
= 1;
1809 if (PT
== last_point_position
- 1
1811 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1812 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1813 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1814 && (lose
>= 0x20 && lose
< 0x7f)))
1815 : (lose
>= 0x20 && lose
< 0x7f))
1816 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1818 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1820 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1822 && !windows_or_buffers_changed
1823 && EQ (current_buffer
->selective_display
, Qnil
)
1824 && !detect_input_pending ()
1825 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1826 && NILP (Vexecuting_kbd_macro
))
1827 direct_output_forward_char (-1);
1830 else if (EQ (Vthis_command
, Qself_insert_command
)
1831 /* Try this optimization only on char keystrokes. */
1832 && NATNUMP (last_command_event
)
1833 && CHAR_VALID_P (XFASTINT (last_command_event
), 0))
1836 = translate_char (Vtranslation_table_for_input
,
1837 XFASTINT (last_command_event
));
1839 if (NILP (Vexecuting_kbd_macro
)
1840 && !EQ (minibuf_window
, selected_window
))
1842 if (!nonundocount
|| nonundocount
>= 20)
1850 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1852 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1854 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1856 || MODIFF
<= SAVE_MODIFF
1857 || windows_or_buffers_changed
1858 || !EQ (current_buffer
->selective_display
, Qnil
)
1859 || detect_input_pending ()
1860 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1861 || !NILP (Vexecuting_kbd_macro
));
1863 value
= internal_self_insert (c
, 0);
1868 frame_make_pointer_invisible ();
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
)) /* FIXME: Why? --Stef */
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
)
3662 /* Check whether a D-Bus message has arrived. */
3663 if (xd_pending_messages () > 0)
3665 #endif /* HAVE_DBUS */
3667 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3670 /* If the buffer contains only FOCUS_IN_EVENT events, and
3671 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3672 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3674 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3675 #ifdef USE_TOOLKIT_SCROLL_BARS
3676 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3680 struct input_event
*event
;
3682 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3689 #ifdef USE_TOOLKIT_SCROLL_BARS
3690 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3692 event
->kind
== FOCUS_IN_EVENT
)
3693 #ifdef USE_TOOLKIT_SCROLL_BARS
3694 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3695 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3696 && event
->part
== scroll_bar_handle
3697 && event
->modifiers
== 0)
3702 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3705 while (event
!= kbd_store_ptr
);
3711 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3712 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3713 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3718 if (current_kboard
->kbd_queue_has_data
)
3724 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3725 if (kb
->kbd_queue_has_data
)
3731 /* Set this for debugging, to have a way to get out */
3735 event_to_kboard (event
)
3736 struct input_event
*event
;
3739 frame
= event
->frame_or_window
;
3741 frame
= XCAR (frame
);
3742 else if (WINDOWP (frame
))
3743 frame
= WINDOW_FRAME (XWINDOW (frame
));
3745 /* There are still some events that don't set this field.
3746 For now, just ignore the problem.
3747 Also ignore dead frames here. */
3748 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3751 return FRAME_KBOARD (XFRAME (frame
));
3755 Lisp_Object Vthrow_on_input
;
3757 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3760 kbd_buffer_store_event (event
)
3761 register struct input_event
*event
;
3763 kbd_buffer_store_event_hold (event
, 0);
3766 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3768 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3769 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3770 Else, if EVENT is a quit event, store the quit event
3771 in HOLD_QUIT, and return (thus ignoring further events).
3773 This is used in read_avail_input to postpone the processing
3774 of the quit event until all subsequent input events have been
3775 parsed (and discarded).
3779 kbd_buffer_store_event_hold (event
, hold_quit
)
3780 register struct input_event
*event
;
3781 struct input_event
*hold_quit
;
3783 if (event
->kind
== NO_EVENT
)
3786 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3789 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3791 register int c
= event
->code
& 0377;
3793 if (event
->modifiers
& ctrl_modifier
)
3794 c
= make_ctrl_char (c
);
3796 c
|= (event
->modifiers
3797 & (meta_modifier
| alt_modifier
3798 | hyper_modifier
| super_modifier
));
3802 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3803 struct input_event
*sp
;
3805 if (single_kboard
&& kb
!= current_kboard
)
3808 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3809 Fcons (make_number (c
), Qnil
));
3810 kb
->kbd_queue_has_data
= 1;
3811 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3813 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3816 if (event_to_kboard (sp
) == kb
)
3818 sp
->kind
= NO_EVENT
;
3819 sp
->frame_or_window
= Qnil
;
3828 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3832 /* If this results in a quit_char being returned to Emacs as
3833 input, set Vlast_event_frame properly. If this doesn't
3834 get returned to Emacs as an event, the next event read
3835 will set Vlast_event_frame again, so this is safe to do. */
3839 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3841 focus
= event
->frame_or_window
;
3842 internal_last_event_frame
= focus
;
3843 Vlast_event_frame
= focus
;
3846 last_event_timestamp
= event
->timestamp
;
3847 handle_interrupt ();
3851 if (c
&& c
== stop_character
)
3857 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3858 Just ignore the second one. */
3859 else if (event
->kind
== BUFFER_SWITCH_EVENT
3860 && kbd_fetch_ptr
!= kbd_store_ptr
3861 && ((kbd_store_ptr
== kbd_buffer
3862 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3863 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3866 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3867 kbd_store_ptr
= kbd_buffer
;
3869 /* Don't let the very last slot in the buffer become full,
3870 since that would make the two pointers equal,
3871 and that is indistinguishable from an empty buffer.
3872 Discard the event if it would fill the last slot. */
3873 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3875 *kbd_store_ptr
= *event
;
3879 /* If we're inside while-no-input, and this event qualifies
3880 as input, set quit-flag to cause an interrupt. */
3881 if (!NILP (Vthrow_on_input
)
3882 && event
->kind
!= FOCUS_IN_EVENT
3883 && event
->kind
!= HELP_EVENT
3884 && event
->kind
!= DEICONIFY_EVENT
)
3886 Vquit_flag
= Vthrow_on_input
;
3887 /* If we're inside a function that wants immediate quits,
3889 if (immediate_quit
&& NILP (Vinhibit_quit
))
3899 /* Put an input event back in the head of the event queue. */
3902 kbd_buffer_unget_event (event
)
3903 register struct input_event
*event
;
3905 if (kbd_fetch_ptr
== kbd_buffer
)
3906 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3908 /* Don't let the very last slot in the buffer become full, */
3909 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3912 *kbd_fetch_ptr
= *event
;
3917 /* Generate HELP_EVENT input_events in BUFP which has room for
3918 SIZE events. If there's not enough room in BUFP, ignore this
3921 HELP is the help form.
3923 FRAME is the frame on which the help is generated. OBJECT is the
3924 Lisp object where the help was found (a buffer, a string, an
3925 overlay, or nil if neither from a string nor from a buffer. POS is
3926 the position within OBJECT where the help was found.
3928 Value is the number of input_events generated. */
3931 gen_help_event (help
, frame
, window
, object
, pos
)
3932 Lisp_Object help
, frame
, object
, window
;
3935 struct input_event event
;
3939 event
.kind
= HELP_EVENT
;
3940 event
.frame_or_window
= frame
;
3942 event
.x
= WINDOWP (window
) ? window
: frame
;
3945 kbd_buffer_store_event (&event
);
3949 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3952 kbd_buffer_store_help_event (frame
, help
)
3953 Lisp_Object frame
, help
;
3955 struct input_event event
;
3957 event
.kind
= HELP_EVENT
;
3958 event
.frame_or_window
= frame
;
3963 kbd_buffer_store_event (&event
);
3967 /* Discard any mouse events in the event buffer by setting them to
3970 discard_mouse_events ()
3972 struct input_event
*sp
;
3973 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3975 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3978 if (sp
->kind
== MOUSE_CLICK_EVENT
3979 || sp
->kind
== WHEEL_EVENT
3980 || sp
->kind
== HORIZ_WHEEL_EVENT
3982 || sp
->kind
== GPM_CLICK_EVENT
3984 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3986 sp
->kind
= NO_EVENT
;
3992 /* Return non-zero if there are any real events waiting in the event
3993 buffer, not counting `NO_EVENT's.
3995 If DISCARD is non-zero, discard NO_EVENT events at the front of
3996 the input queue, possibly leaving the input queue empty if there
3997 are no real input events. */
4000 kbd_buffer_events_waiting (discard
)
4003 struct input_event
*sp
;
4005 for (sp
= kbd_fetch_ptr
;
4006 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4009 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4016 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4020 /* Clear input event EVENT. */
4024 struct input_event
*event
;
4026 event
->kind
= NO_EVENT
;
4030 /* Read one event from the event buffer, waiting if necessary.
4031 The value is a Lisp object representing the event.
4032 The value is nil for an event that should be ignored,
4033 or that was handled here.
4034 We always read and discard one event. */
4037 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4039 int *used_mouse_menu
;
4040 EMACS_TIME
*end_time
;
4046 /* In case we are running as a daemon, only do this before
4047 detaching from the terminal. */
4048 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
4052 *kbp
= current_kboard
;
4056 /* Wait until there is input available. */
4059 /* Break loop if there's an unread command event. Needed in
4060 moused window autoselection which uses a timer to insert such
4062 if (CONSP (Vunread_command_events
))
4065 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4067 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4068 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4072 /* If the quit flag is set, then read_char will return
4073 quit_char, so that counts as "available input." */
4074 if (!NILP (Vquit_flag
))
4075 quit_throw_to_read_char ();
4077 /* One way or another, wait until input is available; then, if
4078 interrupt handlers have not read it, read it now. */
4080 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4084 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4086 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4087 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4092 EMACS_TIME duration
;
4093 EMACS_GET_TIME (duration
);
4094 if (EMACS_TIME_GE (duration
, *end_time
))
4095 return Qnil
; /* finished waiting */
4098 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4099 wait_reading_process_output (EMACS_SECS (duration
),
4100 EMACS_USECS (duration
),
4101 -1, 1, Qnil
, NULL
, 0);
4105 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4107 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4108 /* Pass 1 for EXPECT since we just waited to have input. */
4109 read_avail_input (1);
4112 if (CONSP (Vunread_command_events
))
4115 first
= XCAR (Vunread_command_events
);
4116 Vunread_command_events
= XCDR (Vunread_command_events
);
4117 *kbp
= current_kboard
;
4121 /* At this point, we know that there is a readable event available
4122 somewhere. If the event queue is empty, then there must be a
4123 mouse movement enabled and available. */
4124 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4126 struct input_event
*event
;
4128 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4132 last_event_timestamp
= event
->timestamp
;
4134 *kbp
= event_to_kboard (event
);
4136 *kbp
= current_kboard
; /* Better than returning null ptr? */
4140 /* These two kinds of events get special handling
4141 and don't actually appear to the command loop.
4142 We return nil for them. */
4143 if (event
->kind
== SELECTION_REQUEST_EVENT
4144 || event
->kind
== SELECTION_CLEAR_EVENT
)
4147 struct input_event copy
;
4149 /* Remove it from the buffer before processing it,
4150 since otherwise swallow_events will see it
4151 and process it again. */
4153 kbd_fetch_ptr
= event
+ 1;
4154 input_pending
= readable_events (0);
4155 x_handle_selection_event (©
);
4157 /* We're getting selection request events, but we don't have
4163 #if defined (HAVE_NS)
4164 else if (event
->kind
== NS_TEXT_EVENT
)
4166 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4167 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4169 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4170 kbd_fetch_ptr
= event
+ 1;
4171 if (used_mouse_menu
)
4172 *used_mouse_menu
= 1;
4176 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4177 || defined (HAVE_NS)
4178 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4180 /* Make an event (delete-frame (FRAME)). */
4181 obj
= Fcons (event
->frame_or_window
, Qnil
);
4182 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4183 kbd_fetch_ptr
= event
+ 1;
4186 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4187 || defined (HAVE_NS)
4188 else if (event
->kind
== ICONIFY_EVENT
)
4190 /* Make an event (iconify-frame (FRAME)). */
4191 obj
= Fcons (event
->frame_or_window
, Qnil
);
4192 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4193 kbd_fetch_ptr
= event
+ 1;
4195 else if (event
->kind
== DEICONIFY_EVENT
)
4197 /* Make an event (make-frame-visible (FRAME)). */
4198 obj
= Fcons (event
->frame_or_window
, Qnil
);
4199 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4200 kbd_fetch_ptr
= event
+ 1;
4203 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4205 /* The value doesn't matter here; only the type is tested. */
4206 XSETBUFFER (obj
, current_buffer
);
4207 kbd_fetch_ptr
= event
+ 1;
4209 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4210 || defined(HAVE_NS) || defined (USE_GTK)
4211 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4213 kbd_fetch_ptr
= event
+ 1;
4214 input_pending
= readable_events (0);
4215 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4216 x_activate_menubar (XFRAME (event
->frame_or_window
));
4219 #if defined (WINDOWSNT)
4220 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4222 /* Make an event (language-change (FRAME CHARSET LCID)). */
4223 obj
= Fcons (event
->frame_or_window
, Qnil
);
4224 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4225 kbd_fetch_ptr
= event
+ 1;
4228 else if (event
->kind
== SAVE_SESSION_EVENT
)
4230 obj
= Fcons (Qsave_session
, Qnil
);
4231 kbd_fetch_ptr
= event
+ 1;
4233 /* Just discard these, by returning nil.
4234 With MULTI_KBOARD, these events are used as placeholders
4235 when we need to randomly delete events from the queue.
4236 (They shouldn't otherwise be found in the buffer,
4237 but on some machines it appears they do show up
4238 even without MULTI_KBOARD.) */
4239 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4240 mouse events during a popup-menu call. */
4241 else if (event
->kind
== NO_EVENT
)
4242 kbd_fetch_ptr
= event
+ 1;
4243 else if (event
->kind
== HELP_EVENT
)
4245 Lisp_Object object
, position
, help
, frame
, window
;
4247 frame
= event
->frame_or_window
;
4248 object
= event
->arg
;
4249 position
= make_number (event
->code
);
4252 clear_event (event
);
4254 kbd_fetch_ptr
= event
+ 1;
4255 if (!WINDOWP (window
))
4257 obj
= Fcons (Qhelp_echo
,
4258 list5 (frame
, help
, window
, object
, position
));
4260 else if (event
->kind
== FOCUS_IN_EVENT
)
4262 /* Notification of a FocusIn event. The frame receiving the
4263 focus is in event->frame_or_window. Generate a
4264 switch-frame event if necessary. */
4265 Lisp_Object frame
, focus
;
4267 frame
= event
->frame_or_window
;
4268 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4272 if (!EQ (frame
, internal_last_event_frame
)
4273 && !EQ (frame
, selected_frame
))
4274 obj
= make_lispy_switch_frame (frame
);
4275 internal_last_event_frame
= frame
;
4276 kbd_fetch_ptr
= event
+ 1;
4279 else if (event
->kind
== DBUS_EVENT
)
4281 obj
= make_lispy_event (event
);
4282 kbd_fetch_ptr
= event
+ 1;
4287 /* If this event is on a different frame, return a switch-frame this
4288 time, and leave the event in the queue for next time. */
4292 frame
= event
->frame_or_window
;
4294 frame
= XCAR (frame
);
4295 else if (WINDOWP (frame
))
4296 frame
= WINDOW_FRAME (XWINDOW (frame
));
4298 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4302 if (! EQ (frame
, internal_last_event_frame
)
4303 && !EQ (frame
, selected_frame
))
4304 obj
= make_lispy_switch_frame (frame
);
4305 internal_last_event_frame
= frame
;
4307 /* If we didn't decide to make a switch-frame event, go ahead
4308 and build a real event from the queue entry. */
4312 obj
= make_lispy_event (event
);
4314 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4315 || defined(HAVE_NS) || defined (USE_GTK)
4316 /* If this was a menu selection, then set the flag to inhibit
4317 writing to last_nonmenu_event. Don't do this if the event
4318 we're returning is (menu-bar), though; that indicates the
4319 beginning of the menu sequence, and we might as well leave
4320 that as the `event with parameters' for this selection. */
4322 && !EQ (event
->frame_or_window
, event
->arg
)
4323 && (event
->kind
== MENU_BAR_EVENT
4324 || event
->kind
== TOOL_BAR_EVENT
))
4325 *used_mouse_menu
= 1;
4328 /* certain system events are non-key events */
4330 && event
->kind
== NS_NONKEY_EVENT
)
4331 *used_mouse_menu
= 1;
4334 /* Wipe out this event, to catch bugs. */
4335 clear_event (event
);
4336 kbd_fetch_ptr
= event
+ 1;
4340 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4341 /* Try generating a mouse motion event. */
4342 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4344 FRAME_PTR f
= some_mouse_moved ();
4345 Lisp_Object bar_window
;
4346 enum scroll_bar_part part
;
4350 *kbp
= current_kboard
;
4351 /* Note that this uses F to determine which terminal to look at.
4352 If there is no valid info, it does not store anything
4353 so x remains nil. */
4356 /* XXX Can f or mouse_position_hook be NULL here? */
4357 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4358 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4359 &part
, &x
, &y
, &time
);
4363 /* Decide if we should generate a switch-frame event. Don't
4364 generate switch-frame events for motion outside of all Emacs
4370 frame
= FRAME_FOCUS_FRAME (f
);
4372 XSETFRAME (frame
, f
);
4374 if (! EQ (frame
, internal_last_event_frame
)
4375 && !EQ (frame
, selected_frame
))
4376 obj
= make_lispy_switch_frame (frame
);
4377 internal_last_event_frame
= frame
;
4380 /* If we didn't decide to make a switch-frame event, go ahead and
4381 return a mouse-motion event. */
4382 if (!NILP (x
) && NILP (obj
))
4383 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4385 #endif /* HAVE_MOUSE || HAVE GPM */
4387 /* We were promised by the above while loop that there was
4388 something for us to read! */
4391 input_pending
= readable_events (0);
4393 Vlast_event_frame
= internal_last_event_frame
;
4398 /* Process any events that are not user-visible,
4399 then return, without reading any user-visible events. */
4402 swallow_events (do_display
)
4407 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4409 struct input_event
*event
;
4411 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4415 last_event_timestamp
= event
->timestamp
;
4417 /* These two kinds of events get special handling
4418 and don't actually appear to the command loop. */
4419 if (event
->kind
== SELECTION_REQUEST_EVENT
4420 || event
->kind
== SELECTION_CLEAR_EVENT
)
4423 struct input_event copy
;
4425 /* Remove it from the buffer before processing it,
4426 since otherwise swallow_events called recursively could see it
4427 and process it again. */
4429 kbd_fetch_ptr
= event
+ 1;
4430 input_pending
= readable_events (0);
4431 x_handle_selection_event (©
);
4433 /* We're getting selection request events, but we don't have
4442 old_timers_run
= timers_run
;
4443 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4445 if (timers_run
!= old_timers_run
&& do_display
)
4446 redisplay_preserve_echo_area (7);
4449 /* Record the start of when Emacs is idle,
4450 for the sake of running idle-time timers. */
4457 /* If we are already in the idle state, do nothing. */
4458 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4461 EMACS_GET_TIME (timer_idleness_start_time
);
4463 timer_last_idleness_start_time
= timer_idleness_start_time
;
4465 /* Mark all idle-time timers as once again candidates for running. */
4466 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4470 timer
= XCAR (timers
);
4472 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4474 XVECTOR (timer
)->contents
[0] = Qnil
;
4478 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4483 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4486 /* Resume idle timer from last idle start time. */
4489 timer_resume_idle ()
4491 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4494 timer_idleness_start_time
= timer_last_idleness_start_time
;
4497 /* This is only for debugging. */
4498 struct input_event last_timer_event
;
4500 /* List of elisp functions to call, delayed because they were generated in
4501 a context where Elisp could not be safely run (e.g. redisplay, signal,
4502 ...). Each element has the form (FUN . ARGS). */
4503 Lisp_Object pending_funcalls
;
4505 extern Lisp_Object Qapply
;
4507 /* Check whether a timer has fired. To prevent larger problems we simply
4508 disregard elements that are not proper timers. Do not make a circular
4509 timer list for the time being.
4511 Returns the number of seconds to wait until the next timer fires. If a
4512 timer is triggering now, return zero seconds.
4513 If no timer is active, return -1 seconds.
4515 If a timer is ripe, we run it, with quitting turned off.
4517 DO_IT_NOW is now ignored. It used to mean that we should
4518 run the timer directly instead of queueing a timer-event.
4519 Now we always run timers directly. */
4522 timer_check (do_it_now
)
4525 EMACS_TIME nexttime
;
4526 EMACS_TIME now
, idleness_now
;
4527 Lisp_Object timers
, idle_timers
, chosen_timer
;
4528 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4530 EMACS_SET_SECS (nexttime
, -1);
4531 EMACS_SET_USECS (nexttime
, -1);
4533 /* Always consider the ordinary timers. */
4534 timers
= Vtimer_list
;
4535 /* Consider the idle timers only if Emacs is idle. */
4536 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4537 idle_timers
= Vtimer_idle_list
;
4540 chosen_timer
= Qnil
;
4541 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4543 /* First run the code that was delayed. */
4544 while (CONSP (pending_funcalls
))
4546 Lisp_Object funcall
= XCAR (pending_funcalls
);
4547 pending_funcalls
= XCDR (pending_funcalls
);
4548 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4551 if (CONSP (timers
) || CONSP (idle_timers
))
4553 EMACS_GET_TIME (now
);
4554 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4555 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4558 while (CONSP (timers
) || CONSP (idle_timers
))
4560 Lisp_Object
*vector
;
4561 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4562 EMACS_TIME timer_time
, idle_timer_time
;
4563 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4565 /* Skip past invalid timers and timers already handled. */
4568 timer
= XCAR (timers
);
4569 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4571 timers
= XCDR (timers
);
4574 vector
= XVECTOR (timer
)->contents
;
4576 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4577 || !INTEGERP (vector
[3])
4578 || ! NILP (vector
[0]))
4580 timers
= XCDR (timers
);
4584 if (!NILP (idle_timers
))
4586 timer
= XCAR (idle_timers
);
4587 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4589 idle_timers
= XCDR (idle_timers
);
4592 vector
= XVECTOR (timer
)->contents
;
4594 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4595 || !INTEGERP (vector
[3])
4596 || ! NILP (vector
[0]))
4598 idle_timers
= XCDR (idle_timers
);
4603 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4604 based on the next ordinary timer.
4605 TIMER_DIFFERENCE is the distance in time from NOW to when
4606 this timer becomes ripe (negative if it's already ripe). */
4609 timer
= XCAR (timers
);
4610 vector
= XVECTOR (timer
)->contents
;
4611 EMACS_SET_SECS (timer_time
,
4612 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4613 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4614 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4617 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4618 based on the next idle timer. */
4619 if (!NILP (idle_timers
))
4621 idle_timer
= XCAR (idle_timers
);
4622 vector
= XVECTOR (idle_timer
)->contents
;
4623 EMACS_SET_SECS (idle_timer_time
,
4624 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4625 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4626 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4629 /* Decide which timer is the next timer,
4630 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4631 Also step down the list where we found that timer. */
4633 if (! NILP (timers
) && ! NILP (idle_timers
))
4636 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4637 if (EMACS_TIME_NEG_P (temp
))
4639 chosen_timer
= timer
;
4640 timers
= XCDR (timers
);
4641 difference
= timer_difference
;
4645 chosen_timer
= idle_timer
;
4646 idle_timers
= XCDR (idle_timers
);
4647 difference
= idle_timer_difference
;
4650 else if (! NILP (timers
))
4652 chosen_timer
= timer
;
4653 timers
= XCDR (timers
);
4654 difference
= timer_difference
;
4658 chosen_timer
= idle_timer
;
4659 idle_timers
= XCDR (idle_timers
);
4660 difference
= idle_timer_difference
;
4662 vector
= XVECTOR (chosen_timer
)->contents
;
4664 /* If timer is ripe, run it if it hasn't been run. */
4665 if (EMACS_TIME_NEG_P (difference
)
4666 || (EMACS_SECS (difference
) == 0
4667 && EMACS_USECS (difference
) == 0))
4669 if (NILP (vector
[0]))
4671 int count
= SPECPDL_INDEX ();
4672 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4674 /* Mark the timer as triggered to prevent problems if the lisp
4675 code fails to reschedule it right. */
4678 specbind (Qinhibit_quit
, Qt
);
4680 call1 (Qtimer_event_handler
, chosen_timer
);
4681 Vdeactivate_mark
= old_deactivate_mark
;
4683 unbind_to (count
, Qnil
);
4685 /* Since we have handled the event,
4686 we don't need to tell the caller to wake up and do it. */
4690 /* When we encounter a timer that is still waiting,
4691 return the amount of time to wait before it is ripe. */
4698 /* No timers are pending in the future. */
4699 /* Return 0 if we generated an event, and -1 if not. */
4704 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4705 doc
: /* Return the current length of Emacs idleness, or nil.
4706 The value when Emacs is idle is a list of three integers. The first has
4707 the most significant 16 bits of the seconds, while the second has the least
4708 significant 16 bits. The third integer gives the microsecond count.
4710 The value when Emacs is not idle is nil.
4712 The microsecond count is zero on systems that do not provide
4713 resolution finer than a second. */)
4716 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4718 EMACS_TIME now
, idleness_now
;
4720 EMACS_GET_TIME (now
);
4721 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4723 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4724 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4725 make_number (EMACS_USECS (idleness_now
)));
4731 /* Caches for modify_event_symbol. */
4732 static Lisp_Object accent_key_syms
;
4733 static Lisp_Object func_key_syms
;
4734 static Lisp_Object mouse_syms
;
4735 static Lisp_Object wheel_syms
;
4736 static Lisp_Object drag_n_drop_syms
;
4738 /* This is a list of keysym codes for special "accent" characters.
4739 It parallels lispy_accent_keys. */
4741 static int lispy_accent_codes
[] =
4743 #ifdef XK_dead_circumflex
4748 #ifdef XK_dead_grave
4753 #ifdef XK_dead_tilde
4758 #ifdef XK_dead_diaeresis
4763 #ifdef XK_dead_macron
4768 #ifdef XK_dead_degree
4773 #ifdef XK_dead_acute
4778 #ifdef XK_dead_cedilla
4783 #ifdef XK_dead_breve
4788 #ifdef XK_dead_ogonek
4793 #ifdef XK_dead_caron
4798 #ifdef XK_dead_doubleacute
4799 XK_dead_doubleacute
,
4803 #ifdef XK_dead_abovedot
4808 #ifdef XK_dead_abovering
4818 #ifdef XK_dead_belowdot
4823 #ifdef XK_dead_voiced_sound
4824 XK_dead_voiced_sound
,
4828 #ifdef XK_dead_semivoiced_sound
4829 XK_dead_semivoiced_sound
,
4845 /* This is a list of Lisp names for special "accent" characters.
4846 It parallels lispy_accent_codes. */
4848 static char *lispy_accent_keys
[] =
4866 "dead-voiced-sound",
4867 "dead-semivoiced-sound",
4873 #define FUNCTION_KEY_OFFSET 0x0
4875 char *lispy_function_keys
[] =
4879 0, /* VK_LBUTTON 0x01 */
4880 0, /* VK_RBUTTON 0x02 */
4881 "cancel", /* VK_CANCEL 0x03 */
4882 0, /* VK_MBUTTON 0x04 */
4884 0, 0, 0, /* 0x05 .. 0x07 */
4886 "backspace", /* VK_BACK 0x08 */
4887 "tab", /* VK_TAB 0x09 */
4889 0, 0, /* 0x0A .. 0x0B */
4891 "clear", /* VK_CLEAR 0x0C */
4892 "return", /* VK_RETURN 0x0D */
4894 0, 0, /* 0x0E .. 0x0F */
4896 0, /* VK_SHIFT 0x10 */
4897 0, /* VK_CONTROL 0x11 */
4898 0, /* VK_MENU 0x12 */
4899 "pause", /* VK_PAUSE 0x13 */
4900 "capslock", /* VK_CAPITAL 0x14 */
4901 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4903 "junja", /* VK_JUNJA 0x17 */
4904 "final", /* VK_FINAL 0x18 */
4905 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4907 "escape", /* VK_ESCAPE 0x1B */
4908 "convert", /* VK_CONVERT 0x1C */
4909 "non-convert", /* VK_NONCONVERT 0x1D */
4910 "accept", /* VK_ACCEPT 0x1E */
4911 "mode-change", /* VK_MODECHANGE 0x1F */
4912 0, /* VK_SPACE 0x20 */
4913 "prior", /* VK_PRIOR 0x21 */
4914 "next", /* VK_NEXT 0x22 */
4915 "end", /* VK_END 0x23 */
4916 "home", /* VK_HOME 0x24 */
4917 "left", /* VK_LEFT 0x25 */
4918 "up", /* VK_UP 0x26 */
4919 "right", /* VK_RIGHT 0x27 */
4920 "down", /* VK_DOWN 0x28 */
4921 "select", /* VK_SELECT 0x29 */
4922 "print", /* VK_PRINT 0x2A */
4923 "execute", /* VK_EXECUTE 0x2B */
4924 "snapshot", /* VK_SNAPSHOT 0x2C */
4925 "insert", /* VK_INSERT 0x2D */
4926 "delete", /* VK_DELETE 0x2E */
4927 "help", /* VK_HELP 0x2F */
4929 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4931 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4933 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4935 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4937 0, 0, 0, 0, 0, 0, 0, 0, 0,
4938 0, 0, 0, 0, 0, 0, 0, 0, 0,
4939 0, 0, 0, 0, 0, 0, 0, 0,
4941 "lwindow", /* VK_LWIN 0x5B */
4942 "rwindow", /* VK_RWIN 0x5C */
4943 "apps", /* VK_APPS 0x5D */
4946 "kp-0", /* VK_NUMPAD0 0x60 */
4947 "kp-1", /* VK_NUMPAD1 0x61 */
4948 "kp-2", /* VK_NUMPAD2 0x62 */
4949 "kp-3", /* VK_NUMPAD3 0x63 */
4950 "kp-4", /* VK_NUMPAD4 0x64 */
4951 "kp-5", /* VK_NUMPAD5 0x65 */
4952 "kp-6", /* VK_NUMPAD6 0x66 */
4953 "kp-7", /* VK_NUMPAD7 0x67 */
4954 "kp-8", /* VK_NUMPAD8 0x68 */
4955 "kp-9", /* VK_NUMPAD9 0x69 */
4956 "kp-multiply", /* VK_MULTIPLY 0x6A */
4957 "kp-add", /* VK_ADD 0x6B */
4958 "kp-separator", /* VK_SEPARATOR 0x6C */
4959 "kp-subtract", /* VK_SUBTRACT 0x6D */
4960 "kp-decimal", /* VK_DECIMAL 0x6E */
4961 "kp-divide", /* VK_DIVIDE 0x6F */
4962 "f1", /* VK_F1 0x70 */
4963 "f2", /* VK_F2 0x71 */
4964 "f3", /* VK_F3 0x72 */
4965 "f4", /* VK_F4 0x73 */
4966 "f5", /* VK_F5 0x74 */
4967 "f6", /* VK_F6 0x75 */
4968 "f7", /* VK_F7 0x76 */
4969 "f8", /* VK_F8 0x77 */
4970 "f9", /* VK_F9 0x78 */
4971 "f10", /* VK_F10 0x79 */
4972 "f11", /* VK_F11 0x7A */
4973 "f12", /* VK_F12 0x7B */
4974 "f13", /* VK_F13 0x7C */
4975 "f14", /* VK_F14 0x7D */
4976 "f15", /* VK_F15 0x7E */
4977 "f16", /* VK_F16 0x7F */
4978 "f17", /* VK_F17 0x80 */
4979 "f18", /* VK_F18 0x81 */
4980 "f19", /* VK_F19 0x82 */
4981 "f20", /* VK_F20 0x83 */
4982 "f21", /* VK_F21 0x84 */
4983 "f22", /* VK_F22 0x85 */
4984 "f23", /* VK_F23 0x86 */
4985 "f24", /* VK_F24 0x87 */
4987 0, 0, 0, 0, /* 0x88 .. 0x8B */
4988 0, 0, 0, 0, /* 0x8C .. 0x8F */
4990 "kp-numlock", /* VK_NUMLOCK 0x90 */
4991 "scroll", /* VK_SCROLL 0x91 */
4992 /* Not sure where the following block comes from.
4993 Windows headers have NEC and Fujitsu specific keys in
4994 this block, but nothing generic. */
4995 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4996 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4997 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4998 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4999 "kp-end", /* VK_NUMPAD_END 0x96 */
5000 "kp-home", /* VK_NUMPAD_HOME 0x97 */
5001 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
5002 "kp-up", /* VK_NUMPAD_UP 0x99 */
5003 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
5004 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
5005 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
5006 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
5008 0, 0, /* 0x9E .. 0x9F */
5011 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5012 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5013 * No other API or message will distinguish left and right keys this way.
5018 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5019 to enable them selectively, and gives access to a few more functions.
5020 See lispy_multimedia_keys below. */
5021 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5022 0, 0, 0, /* 0xAD .. 0xAF Volume */
5023 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5024 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5026 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5027 0, 0, 0, 0, 0, 0, 0, 0, 0,
5029 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5030 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5031 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5034 "ax", /* VK_OEM_AX 0xE1 */
5035 0, /* VK_OEM_102 0xE2 */
5036 "ico-help", /* VK_ICO_HELP 0xE3 */
5037 "ico-00", /* VK_ICO_00 0xE4 */
5038 0, /* VK_PROCESSKEY 0xE5 */
5039 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5040 "packet", /* VK_PACKET 0xE7 */
5042 "reset", /* VK_OEM_RESET 0xE9 */
5043 "jump", /* VK_OEM_JUMP 0xEA */
5044 "oem-pa1", /* VK_OEM_PA1 0xEB */
5045 "oem-pa2", /* VK_OEM_PA2 0xEC */
5046 "oem-pa3", /* VK_OEM_PA3 0xED */
5047 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5048 "cusel", /* VK_OEM_CUSEL 0xEF */
5049 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5050 "finish", /* VK_OEM_FINISH 0xF1 */
5051 "copy", /* VK_OEM_COPY 0xF2 */
5052 "auto", /* VK_OEM_AUTO 0xF3 */
5053 "enlw", /* VK_OEM_ENLW 0xF4 */
5054 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5055 "attn", /* VK_ATTN 0xF6 */
5056 "crsel", /* VK_CRSEL 0xF7 */
5057 "exsel", /* VK_EXSEL 0xF8 */
5058 "ereof", /* VK_EREOF 0xF9 */
5059 "play", /* VK_PLAY 0xFA */
5060 "zoom", /* VK_ZOOM 0xFB */
5061 "noname", /* VK_NONAME 0xFC */
5062 "pa1", /* VK_PA1 0xFD */
5063 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5067 /* Some of these duplicate the "Media keys" on newer keyboards,
5068 but they are delivered to the application in a different way. */
5069 static char *lispy_multimedia_keys
[] =
5077 "browser-favorites",
5114 "toggle-dictate-command",
5120 "media-fast-forward",
5123 "media-channel-down"
5126 #else /* not HAVE_NTGUI */
5128 /* This should be dealt with in XTread_socket now, and that doesn't
5129 depend on the client system having the Kana syms defined. See also
5130 the XK_kana_A case below. */
5133 static char *lispy_kana_keys
[] =
5135 /* X Keysym value */
5136 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5137 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5138 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5139 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5140 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5141 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5142 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5143 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5144 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5145 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5146 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5147 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5148 "kana-i", "kana-u", "kana-e", "kana-o",
5149 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5150 "prolongedsound", "kana-A", "kana-I", "kana-U",
5151 "kana-E", "kana-O", "kana-KA", "kana-KI",
5152 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5153 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5154 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5155 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5156 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5157 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5158 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5159 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5160 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5161 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5162 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5163 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5165 #endif /* XK_kana_A */
5168 #define FUNCTION_KEY_OFFSET 0xff00
5170 /* You'll notice that this table is arranged to be conveniently
5171 indexed by X Windows keysym values. */
5172 static char *lispy_function_keys
[] =
5174 /* X Keysym value */
5176 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5177 "backspace", "tab", "linefeed", "clear",
5179 0, 0, 0, "pause", /* 0xff10...1f */
5180 0, 0, 0, 0, 0, 0, 0, "escape",
5182 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5183 "romaji", "hiragana", "katakana", "hiragana-katakana",
5184 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5185 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5186 "eisu-toggle", /* 0xff30...3f */
5187 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5188 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5190 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5191 "down", "prior", "next", "end",
5192 "begin", 0, 0, 0, 0, 0, 0, 0,
5193 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5204 "break", /* 0xff6b */
5207 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5208 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5209 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5210 0, 0, 0, 0, 0, 0, 0, 0,
5211 "kp-tab", /* 0xff89 */
5213 "kp-enter", /* 0xff8d */
5215 "kp-f1", /* 0xff91 */
5219 "kp-home", /* 0xff95 */
5224 "kp-prior", /* kp-page-up */
5225 "kp-next", /* kp-page-down */
5231 0, 0, 0, 0, 0, 0, 0, 0, 0,
5232 "kp-multiply", /* 0xffaa */
5237 "kp-divide", /* 0xffaf */
5238 "kp-0", /* 0xffb0 */
5239 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5242 "kp-equal", /* 0xffbd */
5243 "f1", /* 0xffbe */ /* IsFunctionKey */
5245 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5246 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5247 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5248 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5249 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5250 0, 0, 0, 0, 0, 0, 0, 0,
5251 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5252 0, 0, 0, 0, 0, 0, 0, "delete"
5255 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5256 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5258 static char *iso_lispy_function_keys
[] =
5260 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5261 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5262 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5263 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5264 "iso-lefttab", /* 0xfe20 */
5265 "iso-move-line-up", "iso-move-line-down",
5266 "iso-partial-line-up", "iso-partial-line-down",
5267 "iso-partial-space-left", "iso-partial-space-right",
5268 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5269 "iso-release-margin-left", "iso-release-margin-right",
5270 "iso-release-both-margins",
5271 "iso-fast-cursor-left", "iso-fast-cursor-right",
5272 "iso-fast-cursor-up", "iso-fast-cursor-down",
5273 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5274 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5277 #endif /* not HAVE_NTGUI */
5279 Lisp_Object Vlispy_mouse_stem
;
5281 static char *lispy_wheel_names
[] =
5283 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5286 /* drag-n-drop events are generated when a set of selected files are
5287 dragged from another application and dropped onto an Emacs window. */
5288 static char *lispy_drag_n_drop_names
[] =
5293 /* Scroll bar parts. */
5294 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5295 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5296 Lisp_Object Qtop
, Qratio
;
5298 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5299 Lisp_Object
*scroll_bar_parts
[] = {
5300 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5301 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5304 /* A vector, indexed by button number, giving the down-going location
5305 of currently depressed buttons, both scroll bar and non-scroll bar.
5307 The elements have the form
5308 (BUTTON-NUMBER MODIFIER-MASK . REST)
5309 where REST is the cdr of a position as it would be reported in the event.
5311 The make_lispy_event function stores positions here to tell the
5312 difference between click and drag events, and to store the starting
5313 location to be included in drag events. */
5315 static Lisp_Object button_down_location
;
5317 /* Information about the most recent up-going button event: Which
5318 button, what location, and what time. */
5320 static int last_mouse_button
;
5321 static int last_mouse_x
;
5322 static int last_mouse_y
;
5323 static unsigned long button_down_time
;
5325 /* The maximum time between clicks to make a double-click, or Qnil to
5326 disable double-click detection, or Qt for no time limit. */
5328 Lisp_Object Vdouble_click_time
;
5330 /* Maximum number of pixels the mouse may be moved between clicks
5331 to make a double-click. */
5333 EMACS_INT double_click_fuzz
;
5335 /* The number of clicks in this multiple-click. */
5337 int double_click_count
;
5339 /* Return position of a mouse click or wheel event */
5342 make_lispy_position (f
, x
, y
, time
)
5348 enum window_part part
;
5349 Lisp_Object posn
= Qnil
;
5350 Lisp_Object extra_info
= Qnil
;
5353 /* Set `window' to the window under frame pixel coordinates (x,y) */
5355 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5356 &part
, &wx
, &wy
, 0);
5360 if (WINDOWP (window
))
5362 /* It's a click in window window at frame coordinates (x,y) */
5363 struct window
*w
= XWINDOW (window
);
5364 Lisp_Object string_info
= Qnil
;
5365 int textpos
= -1, rx
= -1, ry
= -1;
5366 int dx
= -1, dy
= -1;
5367 int width
= -1, height
= -1;
5368 Lisp_Object object
= Qnil
;
5370 /* Set event coordinates to window-relative coordinates
5371 for constructing the Lisp event below. */
5375 if (part
== ON_TEXT
)
5377 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5379 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5381 /* Mode line or header line. Look for a string under
5382 the mouse that may have a `local-map' property. */
5386 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5388 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5389 &object
, &dx
, &dy
, &width
, &height
);
5390 if (STRINGP (string
))
5391 string_info
= Fcons (string
, make_number (charpos
));
5392 if (w
== XWINDOW (selected_window
)
5393 && current_buffer
== XBUFFER (w
->buffer
))
5396 textpos
= XMARKER (w
->pointm
)->charpos
;
5398 else if (part
== ON_VERTICAL_BORDER
)
5400 posn
= Qvertical_line
;
5405 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5410 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5412 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5413 &object
, &dx
, &dy
, &width
, &height
);
5414 if (STRINGP (string
))
5415 string_info
= Fcons (string
, make_number (charpos
));
5416 if (part
== ON_LEFT_MARGIN
)
5419 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5421 else if (part
== ON_LEFT_FRINGE
)
5423 posn
= Qleft_fringe
;
5426 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5428 : window_box_width (w
, LEFT_MARGIN_AREA
));
5431 else if (part
== ON_RIGHT_FRINGE
)
5433 posn
= Qright_fringe
;
5436 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5437 + window_box_width (w
, TEXT_AREA
)
5438 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5439 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5445 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5446 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5451 Lisp_Object string2
, object2
= Qnil
;
5452 struct display_pos p
;
5454 int width2
, height2
;
5455 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5456 &object2
, &dx2
, &dy2
,
5458 textpos
= CHARPOS (p
.pos
);
5459 if (rx
< 0) rx
= wx
;
5460 if (ry
< 0) ry
= wy
;
5461 if (dx
< 0) dx
= dx2
;
5462 if (dy
< 0) dy
= dy2
;
5463 if (width
< 0) width
= width2
;
5464 if (height
< 0) height
= height2
;
5468 posn
= make_number (textpos
);
5469 if (STRINGP (string2
))
5470 string_info
= Fcons (string2
,
5471 make_number (CHARPOS (p
.string_pos
)));
5477 #ifdef HAVE_WINDOW_SYSTEM
5478 if (IMAGEP (object
))
5480 Lisp_Object image_map
, hotspot
;
5481 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5483 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5485 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5486 posn
= XCAR (hotspot
);
5491 extra_info
= Fcons (object
,
5492 Fcons (Fcons (make_number (dx
),
5494 Fcons (Fcons (make_number (width
),
5495 make_number (height
)),
5499 extra_info
= Fcons (string_info
,
5500 Fcons (make_number (textpos
),
5501 Fcons (Fcons (make_number (rx
),
5507 XSETFRAME (window
, f
);
5512 XSETFASTINT (*x
, 0);
5513 XSETFASTINT (*y
, 0);
5516 return Fcons (window
,
5518 Fcons (Fcons (*x
, *y
),
5519 Fcons (make_number (time
),
5523 /* Given a struct input_event, build the lisp event which represents
5524 it. If EVENT is 0, build a mouse movement event from the mouse
5525 movement buffer, which should have a movement event in it.
5527 Note that events must be passed to this function in the order they
5528 are received; this function stores the location of button presses
5529 in order to build drag events when the button is released. */
5532 make_lispy_event (event
)
5533 struct input_event
*event
;
5537 switch (SWITCH_ENUM_CAST (event
->kind
))
5539 /* A simple keystroke. */
5540 case ASCII_KEYSTROKE_EVENT
:
5541 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5543 Lisp_Object lispy_c
;
5544 int c
= event
->code
;
5545 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5548 eassert (c
== event
->code
);
5549 /* Turn ASCII characters into control characters
5551 if (event
->modifiers
& ctrl_modifier
)
5553 c
= make_ctrl_char (c
);
5554 event
->modifiers
&= ~ctrl_modifier
;
5558 /* Add in the other modifier bits. The shift key was taken care
5559 of by the X code. */
5560 c
|= (event
->modifiers
5561 & (meta_modifier
| alt_modifier
5562 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5563 /* Distinguish Shift-SPC from SPC. */
5564 if ((event
->code
) == 040
5565 && event
->modifiers
& shift_modifier
)
5566 c
|= shift_modifier
;
5567 button_down_time
= 0;
5568 XSETFASTINT (lispy_c
, c
);
5573 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5574 except that they are non-key events (last-nonmenu-event is nil). */
5575 case NS_NONKEY_EVENT
:
5578 /* A function key. The symbol may need to have modifier prefixes
5580 case NON_ASCII_KEYSTROKE_EVENT
:
5581 button_down_time
= 0;
5583 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5584 if (event
->code
== lispy_accent_codes
[i
])
5585 return modify_event_symbol (i
,
5587 Qfunction_key
, Qnil
,
5588 lispy_accent_keys
, &accent_key_syms
,
5589 (sizeof (lispy_accent_keys
)
5590 / sizeof (lispy_accent_keys
[0])));
5594 if (event
->code
>= 0x400 && event
->code
< 0x500)
5595 return modify_event_symbol (event
->code
- 0x400,
5596 event
->modifiers
& ~shift_modifier
,
5597 Qfunction_key
, Qnil
,
5598 lispy_kana_keys
, &func_key_syms
,
5599 (sizeof (lispy_kana_keys
)
5600 / sizeof (lispy_kana_keys
[0])));
5601 #endif /* XK_kana_A */
5604 #ifdef ISO_FUNCTION_KEY_OFFSET
5605 if (event
->code
< FUNCTION_KEY_OFFSET
5606 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5607 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5609 Qfunction_key
, Qnil
,
5610 iso_lispy_function_keys
, &func_key_syms
,
5611 (sizeof (iso_lispy_function_keys
)
5612 / sizeof (iso_lispy_function_keys
[0])));
5615 /* Handle system-specific or unknown keysyms. */
5616 if (event
->code
& (1 << 28)
5617 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5618 || (event
->code
- FUNCTION_KEY_OFFSET
5619 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5620 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5622 /* We need to use an alist rather than a vector as the cache
5623 since we can't make a vector long enuf. */
5624 if (NILP (current_kboard
->system_key_syms
))
5625 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5626 return modify_event_symbol (event
->code
,
5629 current_kboard
->Vsystem_key_alist
,
5630 0, ¤t_kboard
->system_key_syms
,
5634 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5636 Qfunction_key
, Qnil
,
5637 lispy_function_keys
, &func_key_syms
,
5638 (sizeof (lispy_function_keys
)
5639 / sizeof (lispy_function_keys
[0])));
5642 case MULTIMEDIA_KEY_EVENT
:
5643 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5644 / sizeof (lispy_multimedia_keys
[0]))
5645 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5647 return modify_event_symbol (event
->code
, event
->modifiers
,
5648 Qfunction_key
, Qnil
,
5649 lispy_multimedia_keys
, &func_key_syms
,
5650 (sizeof (lispy_multimedia_keys
)
5651 / sizeof (lispy_multimedia_keys
[0])));
5657 /* A mouse click. Figure out where it is, decide whether it's
5658 a press, click or drag, and build the appropriate structure. */
5659 case MOUSE_CLICK_EVENT
:
5660 #ifndef USE_TOOLKIT_SCROLL_BARS
5661 case SCROLL_BAR_CLICK_EVENT
:
5664 int button
= event
->code
;
5666 Lisp_Object position
;
5667 Lisp_Object
*start_pos_ptr
;
5668 Lisp_Object start_pos
;
5672 /* Build the position as appropriate for this mouse click. */
5673 if (event
->kind
== MOUSE_CLICK_EVENT
)
5675 struct frame
*f
= XFRAME (event
->frame_or_window
);
5676 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5680 /* Ignore mouse events that were made on frame that
5681 have been deleted. */
5682 if (! FRAME_LIVE_P (f
))
5685 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5686 /* EVENT->x and EVENT->y are frame-relative pixel
5687 coordinates at this place. Under old redisplay, COLUMN
5688 and ROW are set to frame relative glyph coordinates
5689 which are then used to determine whether this click is
5690 in a menu (non-toolkit version). */
5691 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5692 &column
, &row
, NULL
, 1);
5694 /* In the non-toolkit version, clicks on the menu bar
5695 are ordinary button events in the event buffer.
5696 Distinguish them, and invoke the menu.
5698 (In the toolkit version, the toolkit handles the menu bar
5699 and Emacs doesn't know about it until after the user
5700 makes a selection.) */
5701 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5702 && (event
->modifiers
& down_modifier
))
5704 Lisp_Object items
, item
;
5709 /* Activate the menu bar on the down event. If the
5710 up event comes in before the menu code can deal with it,
5712 if (! (event
->modifiers
& down_modifier
))
5716 /* Find the menu bar item under `column'. */
5718 items
= FRAME_MENU_BAR_ITEMS (f
);
5719 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5721 Lisp_Object pos
, string
;
5722 string
= AREF (items
, i
+ 1);
5723 pos
= AREF (items
, i
+ 3);
5726 if (column
>= XINT (pos
)
5727 && column
< XINT (pos
) + SCHARS (string
))
5729 item
= AREF (items
, i
);
5734 /* ELisp manual 2.4b says (x y) are window relative but
5735 code says they are frame-relative. */
5737 = Fcons (event
->frame_or_window
,
5739 Fcons (Fcons (event
->x
, event
->y
),
5740 Fcons (make_number (event
->timestamp
),
5743 return Fcons (item
, Fcons (position
, Qnil
));
5745 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5747 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5750 #ifndef USE_TOOLKIT_SCROLL_BARS
5753 /* It's a scrollbar click. */
5755 Lisp_Object portion_whole
;
5758 window
= event
->frame_or_window
;
5759 portion_whole
= Fcons (event
->x
, event
->y
);
5760 part
= *scroll_bar_parts
[(int) event
->part
];
5764 Fcons (Qvertical_scroll_bar
,
5765 Fcons (portion_whole
,
5766 Fcons (make_number (event
->timestamp
),
5767 Fcons (part
, Qnil
)))));
5769 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5771 if (button
>= ASIZE (button_down_location
))
5773 button_down_location
= larger_vector (button_down_location
,
5775 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5778 start_pos_ptr
= &AREF (button_down_location
, button
);
5779 start_pos
= *start_pos_ptr
;
5780 *start_pos_ptr
= Qnil
;
5783 /* On window-system frames, use the value of
5784 double-click-fuzz as is. On other frames, interpret it
5785 as a multiple of 1/8 characters. */
5789 if (WINDOWP (event
->frame_or_window
))
5790 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5791 else if (FRAMEP (event
->frame_or_window
))
5792 f
= XFRAME (event
->frame_or_window
);
5796 if (FRAME_WINDOW_P (f
))
5797 fuzz
= double_click_fuzz
;
5799 fuzz
= double_click_fuzz
/ 8;
5801 is_double
= (button
== last_mouse_button
5802 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5803 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5804 && button_down_time
!= 0
5805 && (EQ (Vdouble_click_time
, Qt
)
5806 || (INTEGERP (Vdouble_click_time
)
5807 && ((int)(event
->timestamp
- button_down_time
)
5808 < XINT (Vdouble_click_time
)))));
5811 last_mouse_button
= button
;
5812 last_mouse_x
= XINT (event
->x
);
5813 last_mouse_y
= XINT (event
->y
);
5815 /* If this is a button press, squirrel away the location, so
5816 we can decide later whether it was a click or a drag. */
5817 if (event
->modifiers
& down_modifier
)
5821 double_click_count
++;
5822 event
->modifiers
|= ((double_click_count
> 2)
5827 double_click_count
= 1;
5828 button_down_time
= event
->timestamp
;
5829 *start_pos_ptr
= Fcopy_alist (position
);
5830 ignore_mouse_drag_p
= 0;
5833 /* Now we're releasing a button - check the co-ordinates to
5834 see if this was a click or a drag. */
5835 else if (event
->modifiers
& up_modifier
)
5837 /* If we did not see a down before this up, ignore the up.
5838 Probably this happened because the down event chose a
5839 menu item. It would be an annoyance to treat the
5840 release of the button that chose the menu item as a
5843 if (!CONSP (start_pos
))
5846 event
->modifiers
&= ~up_modifier
;
5847 #if 0 /* Formerly we treated an up with no down as a click event. */
5848 if (!CONSP (start_pos
))
5849 event
->modifiers
|= click_modifier
;
5854 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5856 /* The third element of every position
5857 should be the (x,y) pair. */
5858 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5860 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5862 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5863 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5866 if (ignore_mouse_drag_p
)
5868 event
->modifiers
|= click_modifier
;
5869 ignore_mouse_drag_p
= 0;
5871 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5872 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5873 /* Maybe the mouse has moved a lot, caused scrolling, and
5874 eventually ended up at the same screen position (but
5875 not buffer position) in which case it is a drag, not
5877 /* FIXME: OTOH if the buffer position has changed
5878 because of a timer or process filter rather than
5879 because of mouse movement, it should be considered as
5880 a click. But mouse-drag-region completely ignores
5881 this case and it hasn't caused any real problem, so
5882 it's probably OK to ignore it as well. */
5883 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5884 /* Mouse hasn't moved (much). */
5885 event
->modifiers
|= click_modifier
;
5888 button_down_time
= 0;
5889 event
->modifiers
|= drag_modifier
;
5892 /* Don't check is_double; treat this as multiple
5893 if the down-event was multiple. */
5894 if (double_click_count
> 1)
5895 event
->modifiers
|= ((double_click_count
> 2)
5901 /* Every mouse event should either have the down_modifier or
5902 the up_modifier set. */
5906 /* Get the symbol we should use for the mouse click. */
5909 head
= modify_event_symbol (button
,
5911 Qmouse_click
, Vlispy_mouse_stem
,
5914 XVECTOR (mouse_syms
)->size
);
5915 if (event
->modifiers
& drag_modifier
)
5920 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5923 Fcons (make_number (double_click_count
),
5933 case HORIZ_WHEEL_EVENT
:
5935 Lisp_Object position
;
5938 /* Build the position as appropriate for this mouse click. */
5939 struct frame
*f
= XFRAME (event
->frame_or_window
);
5941 /* Ignore wheel events that were made on frame that have been
5943 if (! FRAME_LIVE_P (f
))
5946 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5949 /* Set double or triple modifiers to indicate the wheel speed. */
5951 /* On window-system frames, use the value of
5952 double-click-fuzz as is. On other frames, interpret it
5953 as a multiple of 1/8 characters. */
5958 if (WINDOWP (event
->frame_or_window
))
5959 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5960 else if (FRAMEP (event
->frame_or_window
))
5961 f
= XFRAME (event
->frame_or_window
);
5965 if (FRAME_WINDOW_P (f
))
5966 fuzz
= double_click_fuzz
;
5968 fuzz
= double_click_fuzz
/ 8;
5970 is_double
= (last_mouse_button
< 0
5971 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5972 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5973 && button_down_time
!= 0
5974 && (EQ (Vdouble_click_time
, Qt
)
5975 || (INTEGERP (Vdouble_click_time
)
5976 && ((int)(event
->timestamp
- button_down_time
)
5977 < XINT (Vdouble_click_time
)))));
5980 double_click_count
++;
5981 event
->modifiers
|= ((double_click_count
> 2)
5987 double_click_count
= 1;
5988 event
->modifiers
|= click_modifier
;
5991 button_down_time
= event
->timestamp
;
5992 /* Use a negative value to distinguish wheel from mouse button. */
5993 last_mouse_button
= -1;
5994 last_mouse_x
= XINT (event
->x
);
5995 last_mouse_y
= XINT (event
->y
);
6001 if (event
->modifiers
& up_modifier
)
6003 /* Emit a wheel-up event. */
6004 event
->modifiers
&= ~up_modifier
;
6007 else if (event
->modifiers
& down_modifier
)
6009 /* Emit a wheel-down event. */
6010 event
->modifiers
&= ~down_modifier
;
6014 /* Every wheel event should either have the down_modifier or
6015 the up_modifier set. */
6018 if (event
->kind
== HORIZ_WHEEL_EVENT
)
6021 /* Get the symbol we should use for the wheel event. */
6022 head
= modify_event_symbol (symbol_num
,
6028 ASIZE (wheel_syms
));
6031 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6034 Fcons (make_number (double_click_count
),
6043 #ifdef USE_TOOLKIT_SCROLL_BARS
6045 /* We don't have down and up events if using toolkit scroll bars,
6046 so make this always a click event. Store in the `part' of
6047 the Lisp event a symbol which maps to the following actions:
6049 `above_handle' page up
6050 `below_handle' page down
6054 `bottom' bottom of buffer
6055 `handle' thumb has been dragged.
6056 `end-scroll' end of interaction with scroll bar
6058 The incoming input_event contains in its `part' member an
6059 index of type `enum scroll_bar_part' which we can use as an
6060 index in scroll_bar_parts to get the appropriate symbol. */
6062 case SCROLL_BAR_CLICK_EVENT
:
6064 Lisp_Object position
, head
, window
, portion_whole
, part
;
6066 window
= event
->frame_or_window
;
6067 portion_whole
= Fcons (event
->x
, event
->y
);
6068 part
= *scroll_bar_parts
[(int) event
->part
];
6072 Fcons (Qvertical_scroll_bar
,
6073 Fcons (portion_whole
,
6074 Fcons (make_number (event
->timestamp
),
6075 Fcons (part
, Qnil
)))));
6077 /* Always treat scroll bar events as clicks. */
6078 event
->modifiers
|= click_modifier
;
6079 event
->modifiers
&= ~up_modifier
;
6081 if (event
->code
>= ASIZE (mouse_syms
))
6082 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6084 /* Get the symbol we should use for the mouse click. */
6085 head
= modify_event_symbol (event
->code
,
6090 XVECTOR (mouse_syms
)->size
);
6091 return Fcons (head
, Fcons (position
, Qnil
));
6094 #endif /* USE_TOOLKIT_SCROLL_BARS */
6096 case DRAG_N_DROP_EVENT
:
6099 Lisp_Object head
, position
;
6102 f
= XFRAME (event
->frame_or_window
);
6105 /* Ignore mouse events that were made on frames that
6106 have been deleted. */
6107 if (! FRAME_LIVE_P (f
))
6110 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6113 head
= modify_event_symbol (0, event
->modifiers
,
6115 lispy_drag_n_drop_names
,
6116 &drag_n_drop_syms
, 1);
6122 #endif /* HAVE_MOUSE */
6124 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6125 || defined(HAVE_NS) || defined (USE_GTK)
6126 case MENU_BAR_EVENT
:
6127 if (EQ (event
->arg
, event
->frame_or_window
))
6128 /* This is the prefix key. We translate this to
6129 `(menu_bar)' because the code in keyboard.c for menu
6130 events, which we use, relies on this. */
6131 return Fcons (Qmenu_bar
, Qnil
);
6135 case SELECT_WINDOW_EVENT
:
6136 /* Make an event (select-window (WINDOW)). */
6137 return Fcons (Qselect_window
,
6138 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6141 case TOOL_BAR_EVENT
:
6142 if (EQ (event
->arg
, event
->frame_or_window
))
6143 /* This is the prefix key. We translate this to
6144 `(tool_bar)' because the code in keyboard.c for tool bar
6145 events, which we use, relies on this. */
6146 return Fcons (Qtool_bar
, Qnil
);
6147 else if (SYMBOLP (event
->arg
))
6148 return apply_modifiers (event
->modifiers
, event
->arg
);
6151 case USER_SIGNAL_EVENT
:
6152 /* A user signal. */
6154 char *name
= find_user_signal_name (event
->code
);
6157 return intern (name
);
6160 case SAVE_SESSION_EVENT
:
6161 return Qsave_session
;
6166 return Fcons (Qdbus_event
, event
->arg
);
6168 #endif /* HAVE_DBUS */
6171 case GPM_CLICK_EVENT
:
6173 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6174 Lisp_Object head
, position
;
6175 Lisp_Object
*start_pos_ptr
;
6176 Lisp_Object start_pos
;
6177 int button
= event
->code
;
6179 if (button
>= ASIZE (button_down_location
))
6181 button_down_location
= larger_vector (button_down_location
,
6183 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6186 start_pos_ptr
= &AREF (button_down_location
, button
);
6187 start_pos
= *start_pos_ptr
;
6189 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6192 if (event
->modifiers
& down_modifier
)
6193 *start_pos_ptr
= Fcopy_alist (position
);
6194 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6196 if (!CONSP (start_pos
))
6198 event
->modifiers
&= ~up_modifier
;
6201 head
= modify_event_symbol (button
,
6203 Qmouse_click
, Vlispy_mouse_stem
,
6206 XVECTOR (mouse_syms
)->size
);
6208 if (event
->modifiers
& drag_modifier
)
6213 else if (event
->modifiers
& double_modifier
)
6216 Fcons (make_number (2),
6218 else if (event
->modifiers
& triple_modifier
)
6221 Fcons (make_number (3),
6228 #endif /* HAVE_GPM */
6230 /* The 'kind' field of the event is something we don't recognize. */
6236 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6239 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6241 Lisp_Object bar_window
;
6242 enum scroll_bar_part part
;
6246 /* Is it a scroll bar movement? */
6247 if (frame
&& ! NILP (bar_window
))
6249 Lisp_Object part_sym
;
6251 part_sym
= *scroll_bar_parts
[(int) part
];
6252 return Fcons (Qscroll_bar_movement
,
6253 (Fcons (Fcons (bar_window
,
6254 Fcons (Qvertical_scroll_bar
,
6255 Fcons (Fcons (x
, y
),
6256 Fcons (make_number (time
),
6262 /* Or is it an ordinary mouse movement? */
6265 Lisp_Object position
;
6267 position
= make_lispy_position (frame
, &x
, &y
, time
);
6269 return Fcons (Qmouse_movement
,
6275 #endif /* HAVE_MOUSE || HAVE GPM */
6277 /* Construct a switch frame event. */
6279 make_lispy_switch_frame (frame
)
6282 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6285 /* Manipulating modifiers. */
6287 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6289 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6290 SYMBOL's name of the end of the modifiers; the string from this
6291 position is the unmodified symbol name.
6293 This doesn't use any caches. */
6296 parse_modifiers_uncached (symbol
, modifier_end
)
6304 CHECK_SYMBOL (symbol
);
6307 name
= SYMBOL_NAME (symbol
);
6309 for (i
= 0; i
+2 <= SBYTES (name
); )
6311 int this_mod_end
= 0;
6314 /* See if the name continues with a modifier word.
6315 Check that the word appears, but don't check what follows it.
6316 Set this_mod and this_mod_end to record what we find. */
6318 switch (SREF (name
, i
))
6320 #define SINGLE_LETTER_MOD(BIT) \
6321 (this_mod_end = i + 1, this_mod = BIT)
6324 SINGLE_LETTER_MOD (alt_modifier
);
6328 SINGLE_LETTER_MOD (ctrl_modifier
);
6332 SINGLE_LETTER_MOD (hyper_modifier
);
6336 SINGLE_LETTER_MOD (meta_modifier
);
6340 SINGLE_LETTER_MOD (shift_modifier
);
6344 SINGLE_LETTER_MOD (super_modifier
);
6347 #undef SINGLE_LETTER_MOD
6349 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6350 if (i + LEN + 1 <= SBYTES (name) \
6351 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6353 this_mod_end = i + LEN; \
6358 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6359 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6360 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6364 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6366 #undef MULTI_LETTER_MOD
6370 /* If we found no modifier, stop looking for them. */
6371 if (this_mod_end
== 0)
6374 /* Check there is a dash after the modifier, so that it
6375 really is a modifier. */
6376 if (this_mod_end
>= SBYTES (name
)
6377 || SREF (name
, this_mod_end
) != '-')
6380 /* This modifier is real; look for another. */
6381 modifiers
|= this_mod
;
6382 i
= this_mod_end
+ 1;
6385 /* Should we include the `click' modifier? */
6386 if (! (modifiers
& (down_modifier
| drag_modifier
6387 | double_modifier
| triple_modifier
))
6388 && i
+ 7 == SBYTES (name
)
6389 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6390 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6391 modifiers
|= click_modifier
;
6393 if (! (modifiers
& (double_modifier
| triple_modifier
))
6394 && i
+ 6 < SBYTES (name
)
6395 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6396 modifiers
|= click_modifier
;
6404 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6405 prepended to the string BASE[0..BASE_LEN-1].
6406 This doesn't use any caches. */
6408 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6411 int base_len
, base_len_byte
;
6413 /* Since BASE could contain nulls, we can't use intern here; we have
6414 to use Fintern, which expects a genuine Lisp_String, and keeps a
6417 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6423 /* Only the event queue may use the `up' modifier; it should always
6424 be turned into a click or drag event before presented to lisp code. */
6425 if (modifiers
& up_modifier
)
6428 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6429 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6430 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6431 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6432 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6433 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6434 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6435 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6436 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6437 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6438 /* The click modifier is denoted by the absence of other modifiers. */
6442 mod_len
= p
- new_mods
;
6446 Lisp_Object new_name
;
6448 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6449 mod_len
+ base_len_byte
);
6450 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6451 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6453 return Fintern (new_name
, Qnil
);
6458 static char *modifier_names
[] =
6460 "up", "down", "drag", "click", "double", "triple", 0, 0,
6461 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6462 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6464 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6466 static Lisp_Object modifier_symbols
;
6468 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6470 lispy_modifier_list (modifiers
)
6473 Lisp_Object modifier_list
;
6476 modifier_list
= Qnil
;
6477 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6478 if (modifiers
& (1<<i
))
6479 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6482 return modifier_list
;
6486 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6487 where UNMODIFIED is the unmodified form of SYMBOL,
6488 MASK is the set of modifiers present in SYMBOL's name.
6489 This is similar to parse_modifiers_uncached, but uses the cache in
6490 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6491 Qevent_symbol_elements property. */
6493 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6496 parse_modifiers (symbol
)
6499 Lisp_Object elements
;
6501 if (INTEGERP (symbol
))
6502 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6503 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6505 else if (!SYMBOLP (symbol
))
6508 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6509 if (CONSP (elements
))
6514 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6515 Lisp_Object unmodified
;
6518 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6519 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6522 if (modifiers
& ~INTMASK
)
6524 XSETFASTINT (mask
, modifiers
);
6525 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6527 /* Cache the parsing results on SYMBOL. */
6528 Fput (symbol
, Qevent_symbol_element_mask
,
6530 Fput (symbol
, Qevent_symbol_elements
,
6531 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6533 /* Since we know that SYMBOL is modifiers applied to unmodified,
6534 it would be nice to put that in unmodified's cache.
6535 But we can't, since we're not sure that parse_modifiers is
6542 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6543 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6544 doc
: /* Parse the event symbol. For internal use. */)
6548 /* Fill the cache if needed. */
6549 parse_modifiers (symbol
);
6550 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6551 and use the Lispier representation stored on Qevent_symbol_elements
6553 return Fget (symbol
, Qevent_symbol_elements
);
6556 /* Apply the modifiers MODIFIERS to the symbol BASE.
6557 BASE must be unmodified.
6559 This is like apply_modifiers_uncached, but uses BASE's
6560 Qmodifier_cache property, if present. It also builds
6561 Qevent_symbol_elements properties, since it has that info anyway.
6563 apply_modifiers copies the value of BASE's Qevent_kind property to
6564 the modified symbol. */
6566 apply_modifiers (modifiers
, base
)
6570 Lisp_Object cache
, index
, entry
, new_symbol
;
6572 /* Mask out upper bits. We don't know where this value's been. */
6573 modifiers
&= INTMASK
;
6575 if (INTEGERP (base
))
6576 return make_number (XINT (base
) | modifiers
);
6578 /* The click modifier never figures into cache indices. */
6579 cache
= Fget (base
, Qmodifier_cache
);
6580 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6581 entry
= assq_no_quit (index
, cache
);
6584 new_symbol
= XCDR (entry
);
6587 /* We have to create the symbol ourselves. */
6588 new_symbol
= apply_modifiers_uncached (modifiers
,
6589 SDATA (SYMBOL_NAME (base
)),
6590 SCHARS (SYMBOL_NAME (base
)),
6591 SBYTES (SYMBOL_NAME (base
)));
6593 /* Add the new symbol to the base's cache. */
6594 entry
= Fcons (index
, new_symbol
);
6595 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6597 /* We have the parsing info now for free, so we could add it to
6599 XSETFASTINT (index, modifiers);
6600 Fput (new_symbol, Qevent_symbol_element_mask,
6601 Fcons (base, Fcons (index, Qnil)));
6602 Fput (new_symbol, Qevent_symbol_elements,
6603 Fcons (base, lispy_modifier_list (modifiers)));
6604 Sadly, this is only correct if `base' is indeed a base event,
6605 which is not necessarily the case. -stef */
6608 /* Make sure this symbol is of the same kind as BASE.
6610 You'd think we could just set this once and for all when we
6611 intern the symbol above, but reorder_modifiers may call us when
6612 BASE's property isn't set right; we can't assume that just
6613 because it has a Qmodifier_cache property it must have its
6614 Qevent_kind set right as well. */
6615 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6619 kind
= Fget (base
, Qevent_kind
);
6621 Fput (new_symbol
, Qevent_kind
, kind
);
6628 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6629 return a symbol with the modifiers placed in the canonical order.
6630 Canonical order is alphabetical, except for down and drag, which
6631 always come last. The 'click' modifier is never written out.
6633 Fdefine_key calls this to make sure that (for example) C-M-foo
6634 and M-C-foo end up being equivalent in the keymap. */
6637 reorder_modifiers (symbol
)
6640 /* It's hopefully okay to write the code this way, since everything
6641 will soon be in caches, and no consing will be done at all. */
6644 parsed
= parse_modifiers (symbol
);
6645 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6650 /* For handling events, we often want to produce a symbol whose name
6651 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6652 to some base, like the name of a function key or mouse button.
6653 modify_event_symbol produces symbols of this sort.
6655 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6656 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6659 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6660 into symbol names, or a string specifying a name stem used to
6661 construct a symbol name or the form `STEM-N', where N is the decimal
6662 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6663 non-nil; otherwise NAME_TABLE is used.
6665 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6666 persist between calls to modify_event_symbol that it can use to
6667 store a cache of the symbols it's generated for this NAME_TABLE
6668 before. The object stored there may be a vector or an alist.
6670 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6672 MODIFIERS is a set of modifier bits (as given in struct input_events)
6673 whose prefixes should be applied to the symbol name.
6675 SYMBOL_KIND is the value to be placed in the event_kind property of
6676 the returned symbol.
6678 The symbols we create are supposed to have an
6679 `event-symbol-elements' property, which lists the modifiers present
6680 in the symbol's name. */
6683 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6684 name_table
, symbol_table
, table_size
)
6687 Lisp_Object symbol_kind
;
6688 Lisp_Object name_alist_or_stem
;
6690 Lisp_Object
*symbol_table
;
6691 unsigned int table_size
;
6694 Lisp_Object symbol_int
;
6696 /* Get rid of the "vendor-specific" bit here. */
6697 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6699 /* Is this a request for a valid symbol? */
6700 if (symbol_num
< 0 || symbol_num
>= table_size
)
6703 if (CONSP (*symbol_table
))
6704 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6706 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6707 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6708 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6709 we've never used that symbol before. */
6712 if (! VECTORP (*symbol_table
)
6713 || XVECTOR (*symbol_table
)->size
!= table_size
)
6717 XSETFASTINT (size
, table_size
);
6718 *symbol_table
= Fmake_vector (size
, Qnil
);
6721 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6724 /* Have we already used this symbol before? */
6727 /* No; let's create it. */
6728 if (CONSP (name_alist_or_stem
))
6729 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6730 else if (STRINGP (name_alist_or_stem
))
6732 int len
= SBYTES (name_alist_or_stem
);
6733 char *buf
= (char *) alloca (len
+ 50);
6734 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6735 (long) XINT (symbol_int
) + 1);
6736 value
= intern (buf
);
6738 else if (name_table
!= 0 && name_table
[symbol_num
])
6739 value
= intern (name_table
[symbol_num
]);
6741 #ifdef HAVE_WINDOW_SYSTEM
6744 char *name
= x_get_keysym_name (symbol_num
);
6746 value
= intern (name
);
6753 sprintf (buf
, "key-%d", symbol_num
);
6754 value
= intern (buf
);
6757 if (CONSP (*symbol_table
))
6758 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6760 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6762 /* Fill in the cache entries for this symbol; this also
6763 builds the Qevent_symbol_elements property, which the user
6765 apply_modifiers (modifiers
& click_modifier
, value
);
6766 Fput (value
, Qevent_kind
, symbol_kind
);
6769 /* Apply modifiers to that symbol. */
6770 return apply_modifiers (modifiers
, value
);
6773 /* Convert a list that represents an event type,
6774 such as (ctrl meta backspace), into the usual representation of that
6775 event type as a number or a symbol. */
6777 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6778 doc
: /* Convert the event description list EVENT-DESC to an event type.
6779 EVENT-DESC should contain one base event type (a character or symbol)
6780 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6781 drag, down, double or triple). The base must be last.
6782 The return value is an event type (a character or symbol) which
6783 has the same base event type and all the specified modifiers. */)
6785 Lisp_Object event_desc
;
6793 while (CONSP (rest
))
6801 /* Given a symbol, see if it is a modifier name. */
6802 if (SYMBOLP (elt
) && CONSP (rest
))
6803 this = parse_solitary_modifier (elt
);
6807 else if (!NILP (base
))
6808 error ("Two bases given in one event");
6814 /* Let the symbol A refer to the character A. */
6815 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6816 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6818 if (INTEGERP (base
))
6820 /* Turn (shift a) into A. */
6821 if ((modifiers
& shift_modifier
) != 0
6822 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6824 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6825 modifiers
&= ~shift_modifier
;
6828 /* Turn (control a) into C-a. */
6829 if (modifiers
& ctrl_modifier
)
6830 return make_number ((modifiers
& ~ctrl_modifier
)
6831 | make_ctrl_char (XINT (base
)));
6833 return make_number (modifiers
| XINT (base
));
6835 else if (SYMBOLP (base
))
6836 return apply_modifiers (modifiers
, base
);
6839 error ("Invalid base event");
6844 /* Try to recognize SYMBOL as a modifier name.
6845 Return the modifier flag bit, or 0 if not recognized. */
6848 parse_solitary_modifier (Lisp_Object symbol
)
6850 Lisp_Object name
= SYMBOL_NAME (symbol
);
6852 switch (SREF (name
, 0))
6854 #define SINGLE_LETTER_MOD(BIT) \
6855 if (SBYTES (name) == 1) \
6858 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6859 if (LEN == SBYTES (name) \
6860 && ! strncmp (SDATA (name), NAME, LEN)) \
6864 SINGLE_LETTER_MOD (alt_modifier
);
6868 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6872 SINGLE_LETTER_MOD (ctrl_modifier
);
6876 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6877 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6881 SINGLE_LETTER_MOD (hyper_modifier
);
6885 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6889 SINGLE_LETTER_MOD (meta_modifier
);
6893 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6897 SINGLE_LETTER_MOD (shift_modifier
);
6901 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6902 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6903 SINGLE_LETTER_MOD (super_modifier
);
6907 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6908 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6909 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6913 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6916 #undef SINGLE_LETTER_MOD
6917 #undef MULTI_LETTER_MOD
6923 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6924 Such a list is not valid as an event,
6925 but it can be a Lucid-style event type list. */
6928 lucid_event_type_list_p (object
)
6933 if (! CONSP (object
))
6936 if (EQ (XCAR (object
), Qhelp_echo
)
6937 || EQ (XCAR (object
), Qvertical_line
)
6938 || EQ (XCAR (object
), Qmode_line
)
6939 || EQ (XCAR (object
), Qheader_line
))
6942 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6946 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6953 /* Store into *addr a value nonzero if terminal input chars are available.
6954 Serves the purpose of ioctl (0, FIONREAD, addr)
6955 but works even if FIONREAD does not exist.
6956 (In fact, this may actually read some input.)
6958 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6959 timer events that are ripe.
6960 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6961 events (FOCUS_IN_EVENT).
6962 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6963 movements and toolkit scroll bar thumb drags. */
6966 get_input_pending (addr
, flags
)
6970 /* First of all, have we already counted some input? */
6971 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6973 /* If input is being read as it arrives, and we have none, there is none. */
6974 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6977 /* Try to read some input and see how much we get. */
6979 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6982 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6985 gobble_input (expected
)
6989 /* Read D-Bus messages. */
6990 xd_read_queued_messages ();
6991 #endif /* HAVE_DBUS */
6994 if (interrupt_input
)
6997 mask
= sigblock (sigmask (SIGIO
));
6998 read_avail_input (expected
);
7002 #ifdef POLL_FOR_INPUT
7003 /* XXX This condition was (read_socket_hook && !interrupt_input),
7004 but read_socket_hook is not global anymore. Let's pretend that
7006 if (!interrupt_input
&& poll_suppress_count
== 0)
7009 mask
= sigblock (sigmask (SIGALRM
));
7010 read_avail_input (expected
);
7016 read_avail_input (expected
);
7019 /* Put a BUFFER_SWITCH_EVENT in the buffer
7020 so that read_key_sequence will notice the new current buffer. */
7023 record_asynch_buffer_change ()
7025 struct input_event event
;
7029 event
.kind
= BUFFER_SWITCH_EVENT
;
7030 event
.frame_or_window
= Qnil
;
7034 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7035 The purpose of the event is to make read_key_sequence look up the
7036 keymaps again. If we aren't in read_key_sequence, we don't need one,
7037 and the event could cause trouble by messing up (input-pending-p). */
7038 tem
= Fwaiting_for_user_input_p ();
7042 /* We never need these events if we have no asynchronous subprocesses. */
7046 /* Make sure no interrupt happens while storing the event. */
7048 if (interrupt_input
)
7051 mask
= sigblock (sigmask (SIGIO
));
7052 kbd_buffer_store_event (&event
);
7059 kbd_buffer_store_event (&event
);
7064 /* Read any terminal input already buffered up by the system
7065 into the kbd_buffer, but do not wait.
7067 EXPECTED should be nonzero if the caller knows there is some input.
7069 Returns the number of keyboard chars read, or -1 meaning
7070 this is a bad time to try to read input. */
7073 read_avail_input (expected
)
7080 /* Store pending user signal events, if any. */
7081 if (store_user_signal_events ())
7084 /* Loop through the available terminals, and call their input hooks. */
7088 struct terminal
*next
= t
->next_terminal
;
7090 if (t
->read_socket_hook
)
7093 struct input_event hold_quit
;
7095 EVENT_INIT (hold_quit
);
7096 hold_quit
.kind
= NO_EVENT
;
7098 /* No need for FIONREAD or fcntl; just say don't wait. */
7099 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7105 if (nr
== -1) /* Not OK to read input now. */
7109 else if (nr
== -2) /* Non-transient error. */
7111 /* The terminal device terminated; it should be closed. */
7113 /* Kill Emacs if this was our last terminal. */
7114 if (!terminal_list
->next_terminal
)
7115 /* Formerly simply reported no input, but that
7116 sometimes led to a failure of Emacs to terminate.
7117 SIGHUP seems appropriate if we can't reach the
7119 /* ??? Is it really right to send the signal just to
7120 this process rather than to the whole process
7121 group? Perhaps on systems with FIONREAD Emacs is
7122 alone in its group. */
7123 kill (getpid (), SIGHUP
);
7125 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7128 XSETTERMINAL (tmp
, t
);
7129 Fdelete_terminal (tmp
, Qnoelisp
);
7133 if (hold_quit
.kind
!= NO_EVENT
)
7134 kbd_buffer_store_event (&hold_quit
);
7143 frame_make_pointer_visible ();
7149 decode_keyboard_code (struct tty_display_info
*tty
,
7150 struct coding_system
*coding
,
7151 unsigned char *buf
, int nbytes
)
7153 unsigned char *src
= buf
;
7154 const unsigned char *p
;
7159 if (tty
->meta_key
!= 2)
7160 for (i
= 0; i
< nbytes
; i
++)
7162 if (coding
->carryover_bytes
> 0)
7164 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7165 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7166 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7167 nbytes
+= coding
->carryover_bytes
;
7169 coding
->destination
= alloca (nbytes
* 4);
7170 coding
->dst_bytes
= nbytes
* 4;
7171 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7172 if (coding
->produced_char
== 0)
7174 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7176 struct input_event buf
;
7179 buf
.code
= STRING_CHAR_ADVANCE (p
);
7180 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7181 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7182 /* See the comment in tty_read_avail_input. */
7183 buf
.frame_or_window
= tty
->top_frame
;
7185 kbd_buffer_store_event (&buf
);
7189 /* This is the tty way of reading available input.
7191 Note that each terminal device has its own `struct terminal' object,
7192 and so this function is called once for each individual termcap
7193 terminal. The first parameter indicates which terminal to read from. */
7196 tty_read_avail_input (struct terminal
*terminal
,
7198 struct input_event
*hold_quit
)
7200 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7201 the kbd_buffer can really hold. That may prevent loss
7202 of characters on some systems when input is stuffed at us. */
7203 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7205 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7208 if (!terminal
->name
) /* Don't read from a dead terminal. */
7211 if (terminal
->type
!= output_termcap
7212 && terminal
->type
!= output_msdos_raw
)
7215 /* XXX I think the following code should be moved to separate hook
7216 functions in system-dependent files. */
7219 #else /* not WINDOWSNT */
7220 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7224 return 0; /* The terminal is suspended. */
7227 n_to_read
= dos_keysns ();
7231 cbuf
[0] = dos_keyread ();
7234 #else /* not MSDOS */
7239 struct input_event hold_quit
;
7240 int gpm
, fd
= gpm_fd
;
7242 EVENT_INIT (hold_quit
);
7243 hold_quit
.kind
= NO_EVENT
;
7245 /* gpm==1 if event received.
7246 gpm==0 if the GPM daemon has closed the connection, in which case
7247 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7248 we save it in `fd' so close_gpm can remove it from the
7250 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7251 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7252 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7255 /* Presumably the GPM daemon has closed the connection. */
7257 if (hold_quit
.kind
!= NO_EVENT
)
7258 kbd_buffer_store_event (&hold_quit
);
7262 #endif /* HAVE_GPM */
7264 /* Determine how many characters we should *try* to read. */
7266 /* Find out how much input is available. */
7267 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7269 if (! noninteractive
)
7270 return -2; /* Close this terminal. */
7276 if (n_to_read
> sizeof cbuf
)
7277 n_to_read
= sizeof cbuf
;
7278 #else /* no FIONREAD */
7279 #if defined (USG) || defined(CYGWIN)
7280 /* Read some input if available, but don't wait. */
7281 n_to_read
= sizeof cbuf
;
7282 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7288 /* Now read; for one reason or another, this will not block.
7289 NREAD is set to the number of chars read. */
7292 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7293 /* POSIX infers that processes which are not in the session leader's
7294 process group won't get SIGHUP's at logout time. BSDI adheres to
7295 this part standard and returns -1 from read (0) with errno==EIO
7296 when the control tty is taken away.
7297 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7298 if (nread
== -1 && errno
== EIO
)
7299 return -2; /* Close this terminal. */
7300 #if defined (AIX) && defined (_BSD)
7301 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7302 This looks incorrect, but it isn't, because _BSD causes
7303 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7304 and that causes a value other than 0 when there is no input. */
7306 return -2; /* Close this terminal. */
7310 /* We used to retry the read if it was interrupted.
7311 But this does the wrong thing when O_NDELAY causes
7312 an EAGAIN error. Does anybody know of a situation
7313 where a retry is actually needed? */
7315 nread
< 0 && (errno
== EAGAIN
7329 #if defined (USG) || defined (CYGWIN)
7330 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7331 #endif /* USG or CYGWIN */
7332 #endif /* no FIONREAD */
7337 #endif /* not MSDOS */
7338 #endif /* not WINDOWSNT */
7340 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7341 & CODING_REQUIRE_DECODING_MASK
)
7343 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7346 /* Decode the key sequence except for those with meta
7348 for (i
= from
= 0; ; i
++)
7349 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7351 struct input_event buf
;
7353 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7358 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7359 buf
.modifiers
= meta_modifier
;
7360 buf
.code
= cbuf
[i
] & ~0x80;
7361 /* See the comment below. */
7362 buf
.frame_or_window
= tty
->top_frame
;
7364 kbd_buffer_store_event (&buf
);
7370 for (i
= 0; i
< nread
; i
++)
7372 struct input_event buf
;
7374 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7376 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7377 buf
.modifiers
= meta_modifier
;
7378 if (tty
->meta_key
!= 2)
7382 /* Set the frame corresponding to the active tty. Note that the
7383 value of selected_frame is not reliable here, redisplay tends
7384 to temporarily change it. */
7385 buf
.frame_or_window
= tty
->top_frame
;
7388 kbd_buffer_store_event (&buf
);
7389 /* Don't look at input that follows a C-g too closely.
7390 This reduces lossage due to autorepeat on C-g. */
7391 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7392 && buf
.code
== quit_char
)
7400 handle_async_input ()
7402 interrupt_input_pending
= 0;
7404 pending_signals
= pending_atimers
;
7406 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7407 doing anything dangerous. */
7414 nread
= read_avail_input (1);
7415 /* -1 means it's not ok to read the input now.
7416 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7417 0 means there was no keyboard input available. */
7427 process_pending_signals ()
7429 if (interrupt_input_pending
)
7430 handle_async_input ();
7431 do_pending_atimers ();
7434 #ifdef SIGIO /* for entire page */
7435 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7438 input_available_signal (signo
)
7441 /* Must preserve main program's value of errno. */
7442 int old_errno
= errno
;
7443 #if defined (USG) && !defined (POSIX_SIGNALS)
7444 /* USG systems forget handlers when they are used;
7445 must reestablish each time */
7446 signal (signo
, input_available_signal
);
7450 interrupt_input_pending
= 1;
7451 pending_signals
= 1;
7453 SIGNAL_THREAD_CHECK (signo
);
7456 if (input_available_clear_time
)
7457 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7460 handle_async_input ();
7467 /* Send ourselves a SIGIO.
7469 This function exists so that the UNBLOCK_INPUT macro in
7470 blockinput.h can have some way to take care of input we put off
7471 dealing with, without assuming that every file which uses
7472 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7474 reinvoke_input_signal ()
7477 handle_async_input ();
7483 /* User signal events. */
7485 struct user_signal_info
7487 /* Signal number. */
7490 /* Name of the signal. */
7493 /* Number of pending signals. */
7496 struct user_signal_info
*next
;
7499 /* List of user signals. */
7500 static struct user_signal_info
*user_signals
= NULL
;
7503 add_user_signal (sig
, name
)
7507 struct user_signal_info
*p
;
7509 for (p
= user_signals
; p
; p
= p
->next
)
7511 /* Already added. */
7514 p
= xmalloc (sizeof (struct user_signal_info
));
7516 p
->name
= xstrdup (name
);
7518 p
->next
= user_signals
;
7521 signal (sig
, handle_user_signal
);
7525 handle_user_signal (sig
)
7528 int old_errno
= errno
;
7529 struct user_signal_info
*p
;
7531 #if defined (USG) && !defined (POSIX_SIGNALS)
7532 /* USG systems forget handlers when they are used;
7533 must reestablish each time */
7534 signal (sig
, handle_user_signal
);
7537 SIGNAL_THREAD_CHECK (sig
);
7539 for (p
= user_signals
; p
; p
= p
->next
)
7544 if (interrupt_input
)
7545 kill (getpid (), SIGIO
);
7549 /* Tell wait_reading_process_output that it needs to wake
7550 up and look around. */
7551 if (input_available_clear_time
)
7552 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7561 find_user_signal_name (sig
)
7564 struct user_signal_info
*p
;
7566 for (p
= user_signals
; p
; p
= p
->next
)
7574 store_user_signal_events ()
7576 struct user_signal_info
*p
;
7577 struct input_event buf
;
7580 for (p
= user_signals
; p
; p
= p
->next
)
7581 if (p
->npending
> 0)
7587 bzero (&buf
, sizeof buf
);
7588 buf
.kind
= USER_SIGNAL_EVENT
;
7589 buf
.frame_or_window
= selected_frame
;
7591 nstored
+= p
->npending
;
7593 mask
= sigblock (sigmask (p
->sig
));
7597 kbd_buffer_store_event (&buf
);
7600 while (p
->npending
> 0);
7608 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7609 static Lisp_Object menu_bar_one_keymap_changed_items
;
7611 /* These variables hold the vector under construction within
7612 menu_bar_items and its subroutines, and the current index
7613 for storing into that vector. */
7614 static Lisp_Object menu_bar_items_vector
;
7615 static int menu_bar_items_index
;
7617 /* Return a vector of menu items for a menu bar, appropriate
7618 to the current buffer. Each item has three elements in the vector:
7621 OLD is an old vector we can optionally reuse, or nil. */
7624 menu_bar_items (old
)
7627 /* The number of keymaps we're scanning right now, and the number of
7628 keymaps we have allocated space for. */
7631 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7632 in the current keymaps, or nil where it is not a prefix. */
7635 Lisp_Object def
, tail
;
7644 /* In order to build the menus, we need to call the keymap
7645 accessors. They all call QUIT. But this function is called
7646 during redisplay, during which a quit is fatal. So inhibit
7647 quitting while building the menus.
7648 We do this instead of specbind because (1) errors will clear it anyway
7649 and (2) this avoids risk of specpdl overflow. */
7650 oquit
= Vinhibit_quit
;
7654 menu_bar_items_vector
= old
;
7656 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7657 menu_bar_items_index
= 0;
7659 /* Build our list of keymaps.
7660 If we recognize a function key and replace its escape sequence in
7661 keybuf with its symbol, or if the sequence starts with a mouse
7662 click and we need to switch buffers, we jump back here to rebuild
7663 the initial keymaps from the current buffer. */
7667 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7668 if (!NILP (Voverriding_local_map_menu_flag
))
7670 /* Yes, use them (if non-nil) as well as the global map. */
7671 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7673 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7674 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7675 if (!NILP (Voverriding_local_map
))
7676 maps
[nmaps
++] = Voverriding_local_map
;
7680 /* No, so use major and minor mode keymaps and keymap property.
7681 Note that menu-bar bindings in the local-map and keymap
7682 properties may not work reliable, as they are only
7683 recognized when the menu-bar (or mode-line) is updated,
7684 which does not normally happen after every command. */
7687 nminor
= current_minor_maps (NULL
, &tmaps
);
7688 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7690 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7691 maps
[nmaps
++] = tem
;
7692 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7694 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7696 maps
[nmaps
++] = current_global_map
;
7699 /* Look up in each map the dummy prefix key `menu-bar'. */
7703 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7704 if (!NILP (maps
[mapno
]))
7706 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7710 menu_bar_one_keymap_changed_items
= Qnil
;
7711 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7715 /* Move to the end those items that should be at the end. */
7717 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7720 int end
= menu_bar_items_index
;
7722 for (i
= 0; i
< end
; i
+= 4)
7723 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7725 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7726 /* Move the item at index I to the end,
7727 shifting all the others forward. */
7728 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7729 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7730 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7731 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7733 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7734 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7735 (end
- i
- 4) * sizeof (Lisp_Object
));
7736 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7737 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7738 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7739 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7744 /* Add nil, nil, nil, nil at the end. */
7745 i
= menu_bar_items_index
;
7746 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7747 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7748 /* Add this item. */
7749 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7750 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7751 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7752 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7753 menu_bar_items_index
= i
;
7755 Vinhibit_quit
= oquit
;
7756 return menu_bar_items_vector
;
7759 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7760 If there's already an item for KEY, add this DEF to it. */
7762 Lisp_Object item_properties
;
7765 menu_bar_item (key
, item
, dummy1
, dummy2
)
7766 Lisp_Object key
, item
, dummy1
;
7769 struct gcpro gcpro1
;
7773 if (EQ (item
, Qundefined
))
7775 /* If a map has an explicit `undefined' as definition,
7776 discard any previously made menu bar item. */
7778 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7779 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7781 if (menu_bar_items_index
> i
+ 4)
7782 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7783 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7784 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7785 menu_bar_items_index
-= 4;
7789 /* If this keymap has already contributed to this KEY,
7790 don't contribute to it a second time. */
7791 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7792 if (!NILP (tem
) || NILP (item
))
7795 menu_bar_one_keymap_changed_items
7796 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7798 /* We add to menu_bar_one_keymap_changed_items before doing the
7799 parse_menu_item, so that if it turns out it wasn't a menu item,
7800 it still correctly hides any further menu item. */
7802 i
= parse_menu_item (item
, 0, 1);
7807 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7809 /* Find any existing item for this KEY. */
7810 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7811 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7814 /* If we did not find this KEY, add it at the end. */
7815 if (i
== menu_bar_items_index
)
7817 /* If vector is too small, get a bigger one. */
7818 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7819 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7820 /* Add this item. */
7821 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7822 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7823 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7824 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7825 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7826 menu_bar_items_index
= i
;
7828 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7832 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7833 /* If the new and the old items are not both keymaps,
7834 the lookup will only find `item'. */
7835 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7836 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7840 /* This is used as the handler when calling menu_item_eval_property. */
7842 menu_item_eval_property_1 (arg
)
7845 /* If we got a quit from within the menu computation,
7846 quit all the way out of it. This takes care of C-] in the debugger. */
7847 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7848 Fsignal (Qquit
, Qnil
);
7853 /* Evaluate an expression and return the result (or nil if something
7854 went wrong). Used to evaluate dynamic parts of menu items. */
7856 menu_item_eval_property (sexpr
)
7859 int count
= SPECPDL_INDEX ();
7861 specbind (Qinhibit_redisplay
, Qt
);
7862 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7863 menu_item_eval_property_1
);
7864 return unbind_to (count
, val
);
7867 /* This function parses a menu item and leaves the result in the
7868 vector item_properties.
7869 ITEM is a key binding, a possible menu item.
7870 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7871 evaluate dynamic expressions in the menu item.
7872 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7874 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7875 parse_menu_item returns true if the item is a menu item and false
7879 parse_menu_item (item
, notreal
, inmenubar
)
7881 int notreal
, inmenubar
;
7883 Lisp_Object def
, tem
, item_string
, start
;
7885 Lisp_Object keyhint
;
7894 /* Create item_properties vector if necessary. */
7895 if (NILP (item_properties
))
7897 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7899 /* Initialize optional entries. */
7900 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7901 ASET (item_properties
, i
, Qnil
);
7902 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7904 /* Save the item here to protect it from GC. */
7905 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7907 item_string
= XCAR (item
);
7911 if (STRINGP (item_string
))
7913 /* Old format menu item. */
7914 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7916 /* Maybe help string. */
7917 if (CONSP (item
) && STRINGP (XCAR (item
)))
7919 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7924 /* Maybe an obsolete key binding cache. */
7925 if (CONSP (item
) && CONSP (XCAR (item
))
7926 && (NILP (XCAR (XCAR (item
)))
7927 || VECTORP (XCAR (XCAR (item
)))))
7930 /* This is the real definition--the function to run. */
7931 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7933 /* Get enable property, if any. */
7936 tem
= Fget (item
, Qmenu_enable
);
7937 if (!NILP (Venable_disabled_menus_and_buttons
))
7938 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7939 else if (!NILP (tem
))
7940 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7943 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7945 /* New format menu item. */
7946 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7947 start
= XCDR (item
);
7950 /* We have a real binding. */
7951 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7953 item
= XCDR (start
);
7954 /* Is there an obsolete cache list with key equivalences. */
7955 if (CONSP (item
) && CONSP (XCAR (item
)))
7958 /* Parse properties. */
7959 while (CONSP (item
) && CONSP (XCDR (item
)))
7964 if (EQ (tem
, QCenable
))
7966 if (!NILP (Venable_disabled_menus_and_buttons
))
7967 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7969 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7971 else if (EQ (tem
, QCvisible
) && !notreal
)
7973 /* If got a visible property and that evaluates to nil
7974 then ignore this item. */
7975 tem
= menu_item_eval_property (XCAR (item
));
7979 else if (EQ (tem
, QChelp
))
7980 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7981 else if (EQ (tem
, QCfilter
))
7983 else if (EQ (tem
, QCkey_sequence
))
7986 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7987 /* Be GC protected. Set keyhint to item instead of tem. */
7990 else if (EQ (tem
, QCkeys
))
7993 if (CONSP (tem
) || STRINGP (tem
))
7994 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7996 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
8001 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8003 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8005 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
8011 else if (inmenubar
|| !NILP (start
))
8015 return 0; /* not a menu item */
8017 /* If item string is not a string, evaluate it to get string.
8018 If we don't get a string, skip this item. */
8019 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
8020 if (!(STRINGP (item_string
) || notreal
))
8022 item_string
= menu_item_eval_property (item_string
);
8023 if (!STRINGP (item_string
))
8025 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
8028 /* If got a filter apply it on definition. */
8029 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8032 def
= menu_item_eval_property (list2 (XCAR (filter
),
8033 list2 (Qquote
, def
)));
8035 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
8038 /* Enable or disable selection of item. */
8039 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
8045 tem
= menu_item_eval_property (tem
);
8046 if (inmenubar
&& NILP (tem
))
8047 return 0; /* Ignore disabled items in menu bar. */
8048 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
8051 /* If we got no definition, this item is just unselectable text which
8052 is OK in a submenu but not in the menubar. */
8054 return (inmenubar
? 0 : 1);
8056 /* See if this is a separate pane or a submenu. */
8057 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8058 tem
= get_keymap (def
, 0, 1);
8059 /* For a subkeymap, just record its details and exit. */
8062 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
8063 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
8067 /* At the top level in the menu bar, do likewise for commands also.
8068 The menu bar does not display equivalent key bindings anyway.
8069 ITEM_PROPERTY_DEF is already set up properly. */
8073 /* This is a command. See if there is an equivalent key binding. */
8074 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8075 /* The previous code preferred :key-sequence to :keys, so we
8076 preserve this behavior. */
8077 if (STRINGP (tem
) && !CONSP (keyhint
))
8078 tem
= Fsubstitute_command_keys (tem
);
8081 Lisp_Object prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8082 Lisp_Object keys
= Qnil
;
8086 def
= XCAR (prefix
);
8087 prefix
= XCDR (prefix
);
8090 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8092 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
8094 keys
= XCAR (keyhint
);
8095 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
8097 /* We have a suggested key. Is it bound to the command? */
8100 /* If the command is an alias for another
8101 (such as lmenu.el set it up), check if the
8102 original command matches the cached command. */
8103 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8108 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
8112 tem
= Fkey_description (keys
, Qnil
);
8115 if (STRINGP (XCAR (prefix
)))
8116 tem
= concat2 (XCAR (prefix
), tem
);
8117 if (STRINGP (XCDR (prefix
)))
8118 tem
= concat2 (tem
, XCDR (prefix
));
8120 tem
= concat2 (build_string (" "), tem
);
8121 /* tem = concat3 (build_string (" ("), tem, build_string (")")); */
8126 /* If we only want to precompute equivalent key bindings, stop here. */
8130 /* If we have an equivalent key binding, use that. */
8131 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8133 /* Include this when menu help is implemented.
8134 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8135 if (!(NILP (tem) || STRINGP (tem)))
8137 tem = menu_item_eval_property (tem);
8140 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8144 /* Handle radio buttons or toggle boxes. */
8145 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8147 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8148 menu_item_eval_property (tem
));
8155 /***********************************************************************
8157 ***********************************************************************/
8159 /* A vector holding tool bar items while they are parsed in function
8160 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8163 static Lisp_Object tool_bar_items_vector
;
8165 /* A vector holding the result of parse_tool_bar_item. Layout is like
8166 the one for a single item in tool_bar_items_vector. */
8168 static Lisp_Object tool_bar_item_properties
;
8170 /* Next free index in tool_bar_items_vector. */
8172 static int ntool_bar_items
;
8174 /* The symbols `tool-bar', `:image' and `:rtl'. */
8176 extern Lisp_Object Qtool_bar
;
8177 Lisp_Object QCimage
;
8180 /* Function prototypes. */
8182 static void init_tool_bar_items
P_ ((Lisp_Object
));
8183 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8184 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8185 static void append_tool_bar_item
P_ ((void));
8188 /* Return a vector of tool bar items for keymaps currently in effect.
8189 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8190 tool bar items found. */
8193 tool_bar_items (reuse
, nitems
)
8204 /* In order to build the menus, we need to call the keymap
8205 accessors. They all call QUIT. But this function is called
8206 during redisplay, during which a quit is fatal. So inhibit
8207 quitting while building the menus. We do this instead of
8208 specbind because (1) errors will clear it anyway and (2) this
8209 avoids risk of specpdl overflow. */
8210 oquit
= Vinhibit_quit
;
8213 /* Initialize tool_bar_items_vector and protect it from GC. */
8214 init_tool_bar_items (reuse
);
8216 /* Build list of keymaps in maps. Set nmaps to the number of maps
8219 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8220 if (!NILP (Voverriding_local_map_menu_flag
))
8222 /* Yes, use them (if non-nil) as well as the global map. */
8223 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8225 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8226 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8227 if (!NILP (Voverriding_local_map
))
8228 maps
[nmaps
++] = Voverriding_local_map
;
8232 /* No, so use major and minor mode keymaps and keymap property.
8233 Note that tool-bar bindings in the local-map and keymap
8234 properties may not work reliable, as they are only
8235 recognized when the tool-bar (or mode-line) is updated,
8236 which does not normally happen after every command. */
8239 nminor
= current_minor_maps (NULL
, &tmaps
);
8240 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8242 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8243 maps
[nmaps
++] = tem
;
8244 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8246 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8249 /* Add global keymap at the end. */
8250 maps
[nmaps
++] = current_global_map
;
8252 /* Process maps in reverse order and look up in each map the prefix
8254 for (i
= nmaps
- 1; i
>= 0; --i
)
8255 if (!NILP (maps
[i
]))
8259 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8261 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8264 Vinhibit_quit
= oquit
;
8265 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8266 return tool_bar_items_vector
;
8270 /* Process the definition of KEY which is DEF. */
8273 process_tool_bar_item (key
, def
, data
, args
)
8274 Lisp_Object key
, def
, data
;
8278 extern Lisp_Object Qundefined
;
8279 struct gcpro gcpro1
, gcpro2
;
8281 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8285 if (EQ (def
, Qundefined
))
8287 /* If a map has an explicit `undefined' as definition,
8288 discard any previously made item. */
8289 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8291 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8293 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8295 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8296 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8297 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8298 * sizeof (Lisp_Object
)));
8299 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8304 else if (parse_tool_bar_item (key
, def
))
8305 /* Append a new tool bar item to tool_bar_items_vector. Accept
8306 more than one definition for the same key. */
8307 append_tool_bar_item ();
8313 /* Parse a tool bar item specification ITEM for key KEY and return the
8314 result in tool_bar_item_properties. Value is zero if ITEM is
8317 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8319 CAPTION is the caption of the item, If it's not a string, it is
8320 evaluated to get a string.
8322 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8323 as binding are currently ignored.
8325 The following properties are recognized:
8329 FORM is evaluated and specifies whether the tool bar item is
8330 enabled or disabled.
8334 FORM is evaluated and specifies whether the tool bar item is visible.
8336 - `:filter FUNCTION'
8338 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8339 result is stored as the new binding.
8341 - `:button (TYPE SELECTED)'
8343 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8344 and specifies whether the button is selected (pressed) or not.
8348 IMAGES is either a single image specification or a vector of four
8349 image specifications. See enum tool_bar_item_images.
8351 - `:help HELP-STRING'.
8353 Gives a help string to display for the tool bar item. */
8356 parse_tool_bar_item (key
, item
)
8357 Lisp_Object key
, item
;
8359 /* Access slot with index IDX of vector tool_bar_item_properties. */
8360 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8362 Lisp_Object filter
= Qnil
;
8363 Lisp_Object caption
;
8366 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8367 Rule out items that aren't lists, don't start with
8368 `menu-item' or whose rest following `tool-bar-item' is not a
8371 || !EQ (XCAR (item
), Qmenu_item
)
8372 || (item
= XCDR (item
),
8376 /* Create tool_bar_item_properties vector if necessary. Reset it to
8378 if (VECTORP (tool_bar_item_properties
))
8380 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8384 tool_bar_item_properties
8385 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8388 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8389 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8391 /* Get the caption of the item. If the caption is not a string,
8392 evaluate it to get a string. If we don't get a string, skip this
8394 caption
= XCAR (item
);
8395 if (!STRINGP (caption
))
8397 caption
= menu_item_eval_property (caption
);
8398 if (!STRINGP (caption
))
8401 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8403 /* Give up if rest following the caption is not a list. */
8408 /* Store the binding. */
8409 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8412 /* Ignore cached key binding, if any. */
8413 if (CONSP (item
) && CONSP (XCAR (item
)))
8416 /* Process the rest of the properties. */
8417 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8419 Lisp_Object key
, value
;
8422 value
= XCAR (XCDR (item
));
8424 if (EQ (key
, QCenable
))
8426 /* `:enable FORM'. */
8427 if (!NILP (Venable_disabled_menus_and_buttons
))
8428 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8430 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8432 else if (EQ (key
, QCvisible
))
8434 /* `:visible FORM'. If got a visible property and that
8435 evaluates to nil then ignore this item. */
8436 if (NILP (menu_item_eval_property (value
)))
8439 else if (EQ (key
, QChelp
))
8440 /* `:help HELP-STRING'. */
8441 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8442 else if (EQ (key
, QCfilter
))
8443 /* ':filter FORM'. */
8445 else if (EQ (key
, QCbutton
) && CONSP (value
))
8447 /* `:button (TYPE . SELECTED)'. */
8448 Lisp_Object type
, selected
;
8450 type
= XCAR (value
);
8451 selected
= XCDR (value
);
8452 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8454 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8455 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8458 else if (EQ (key
, QCimage
)
8460 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8461 /* Value is either a single image specification or a vector
8462 of 4 such specifications for the different button states. */
8463 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8464 else if (EQ (key
, Qrtl
))
8466 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8469 /* If got a filter apply it on binding. */
8471 PROP (TOOL_BAR_ITEM_BINDING
)
8472 = menu_item_eval_property (list2 (filter
,
8474 PROP (TOOL_BAR_ITEM_BINDING
))));
8476 /* See if the binding is a keymap. Give up if it is. */
8477 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8480 /* Enable or disable selection of item. */
8481 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8482 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8483 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8485 /* Handle radio buttons or toggle boxes. */
8486 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8487 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8488 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8496 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8497 that can be reused. */
8500 init_tool_bar_items (reuse
)
8503 if (VECTORP (reuse
))
8504 tool_bar_items_vector
= reuse
;
8506 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8507 ntool_bar_items
= 0;
8511 /* Append parsed tool bar item properties from
8512 tool_bar_item_properties */
8515 append_tool_bar_item ()
8517 Lisp_Object
*to
, *from
;
8519 /* Enlarge tool_bar_items_vector if necessary. */
8520 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8521 >= XVECTOR (tool_bar_items_vector
)->size
)
8522 tool_bar_items_vector
8523 = larger_vector (tool_bar_items_vector
,
8524 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8526 /* Append entries from tool_bar_item_properties to the end of
8527 tool_bar_items_vector. */
8528 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8529 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8530 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8531 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8538 /* Read a character using menus based on maps in the array MAPS.
8539 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8540 Return t if we displayed a menu but the user rejected it.
8542 PREV_EVENT is the previous input event, or nil if we are reading
8543 the first event of a key sequence.
8545 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8546 if we used a mouse menu to read the input, or zero otherwise. If
8547 USED_MOUSE_MENU is null, we don't dereference it.
8549 The prompting is done based on the prompt-string of the map
8550 and the strings associated with various map elements.
8552 This can be done with X menus or with menus put in the minibuf.
8553 These are done in different ways, depending on how the input will be read.
8554 Menus using X are done after auto-saving in read-char, getting the input
8555 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8556 and do auto-saving in the inner call of read_char. */
8559 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8562 Lisp_Object prev_event
;
8563 int *used_mouse_menu
;
8566 register Lisp_Object name
= Qnil
;
8568 if (used_mouse_menu
)
8569 *used_mouse_menu
= 0;
8571 /* Use local over global Menu maps */
8573 if (! menu_prompting
)
8576 /* Optionally disregard all but the global map. */
8577 if (inhibit_local_menu_bar_menus
)
8579 maps
+= (nmaps
- 1);
8583 /* Get the menu name from the first map that has one (a prompt string). */
8584 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8586 name
= Fkeymap_prompt (maps
[mapno
]);
8591 /* If we don't have any menus, just read a character normally. */
8592 if (!STRINGP (name
))
8596 /* If we got to this point via a mouse click,
8597 use a real menu for mouse selection. */
8598 if (EVENT_HAS_PARAMETERS (prev_event
)
8599 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8600 && !EQ (XCAR (prev_event
), Qtool_bar
))
8602 /* Display the menu and get the selection. */
8603 Lisp_Object
*realmaps
8604 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8608 /* Use the maps that are not nil. */
8609 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8610 if (!NILP (maps
[mapno
]))
8611 realmaps
[nmaps1
++] = maps
[mapno
];
8613 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8618 record_menu_key (XCAR (value
));
8620 /* If we got multiple events, unread all but
8622 There is no way to prevent those unread events
8623 from showing up later in last_nonmenu_event.
8624 So turn symbol and integer events into lists,
8625 to indicate that they came from a mouse menu,
8626 so that when present in last_nonmenu_event
8627 they won't confuse things. */
8628 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8630 record_menu_key (XCAR (tem
));
8631 if (SYMBOLP (XCAR (tem
))
8632 || INTEGERP (XCAR (tem
)))
8633 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8636 /* If we got more than one event, put all but the first
8637 onto this list to be read later.
8638 Return just the first event now. */
8639 Vunread_command_events
8640 = nconc2 (XCDR (value
), Vunread_command_events
);
8641 value
= XCAR (value
);
8643 else if (NILP (value
))
8645 if (used_mouse_menu
)
8646 *used_mouse_menu
= 1;
8649 #endif /* HAVE_MENUS */
8653 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8654 We make this bigger when necessary, and never free it. */
8655 static char *read_char_minibuf_menu_text
;
8656 /* Size of that buffer. */
8657 static int read_char_minibuf_menu_width
;
8660 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8666 register Lisp_Object name
;
8668 /* FIXME: Use the minibuffer's frame width. */
8669 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8672 Lisp_Object rest
, vector
;
8678 if (! menu_prompting
)
8681 /* Get the menu name from the first map that has one (a prompt string). */
8682 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8684 name
= Fkeymap_prompt (maps
[mapno
]);
8689 /* If we don't have any menus, just read a character normally. */
8690 if (!STRINGP (name
))
8693 /* Make sure we have a big enough buffer for the menu text. */
8694 width
= max (width
, SBYTES (name
));
8695 if (read_char_minibuf_menu_text
== 0)
8697 read_char_minibuf_menu_width
= width
+ 4;
8698 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8700 else if (width
+ 4 > read_char_minibuf_menu_width
)
8702 read_char_minibuf_menu_width
= width
+ 4;
8703 read_char_minibuf_menu_text
8704 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8706 menu
= read_char_minibuf_menu_text
;
8708 /* Prompt string always starts with map's prompt, and a space. */
8709 strcpy (menu
, SDATA (name
));
8710 nlength
= SBYTES (name
);
8711 menu
[nlength
++] = ':';
8712 menu
[nlength
++] = ' ';
8715 /* Start prompting at start of first map. */
8719 /* Present the documented bindings, a line at a time. */
8726 Lisp_Object orig_defn_macro
;
8728 /* Loop over elements of map. */
8733 /* If reached end of map, start at beginning of next map. */
8737 /* At end of last map, wrap around to first map if just starting,
8738 or end this line if already have something on it. */
8742 if (notfirst
|| nobindings
) break;
8747 /* Look at the next element of the map. */
8749 elt
= XVECTOR (vector
)->contents
[idx
];
8751 elt
= Fcar_safe (rest
);
8753 if (idx
< 0 && VECTORP (elt
))
8755 /* If we found a dense table in the keymap,
8756 advanced past it, but start scanning its contents. */
8757 rest
= Fcdr_safe (rest
);
8763 /* An ordinary element. */
8764 Lisp_Object event
, tem
;
8768 event
= Fcar_safe (elt
); /* alist */
8769 elt
= Fcdr_safe (elt
);
8773 XSETINT (event
, idx
); /* vector */
8776 /* Ignore the element if it has no prompt string. */
8777 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8779 /* 1 if the char to type matches the string. */
8781 Lisp_Object upcased_event
, downcased_event
;
8782 Lisp_Object desc
= Qnil
;
8784 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8786 upcased_event
= Fupcase (event
);
8787 downcased_event
= Fdowncase (event
);
8788 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8789 || XINT (downcased_event
) == SREF (s
, 0));
8791 desc
= Fsingle_key_description (event
, Qnil
);
8793 #if 0 /* It is redundant to list the equivalent key bindings because
8794 the prefix is what the user has already typed. */
8796 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8798 /* Insert equivalent keybinding. */
8799 s
= concat2 (s
, tem
);
8802 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8803 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8805 /* Insert button prefix. */
8806 Lisp_Object selected
8807 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8808 if (EQ (tem
, QCradio
))
8809 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8811 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8812 s
= concat2 (tem
, s
);
8816 /* If we have room for the prompt string, add it to this line.
8817 If this is the first on the line, always add it. */
8818 if ((SCHARS (s
) + i
+ 2
8819 + (char_matches
? 0 : SCHARS (desc
) + 3))
8825 /* Punctuate between strings. */
8828 strcpy (menu
+ i
, ", ");
8834 /* If the char to type doesn't match the string's
8835 first char, explicitly show what char to type. */
8838 /* Add as much of string as fits. */
8839 thiswidth
= SCHARS (desc
);
8840 if (thiswidth
+ i
> width
)
8841 thiswidth
= width
- i
;
8842 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8844 strcpy (menu
+ i
, " = ");
8848 /* Add as much of string as fits. */
8849 thiswidth
= SCHARS (s
);
8850 if (thiswidth
+ i
> width
)
8851 thiswidth
= width
- i
;
8852 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8858 /* If this element does not fit, end the line now,
8859 and save the element for the next line. */
8860 strcpy (menu
+ i
, "...");
8865 /* Move past this element. */
8866 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8867 /* Handle reaching end of dense table. */
8872 rest
= Fcdr_safe (rest
);
8876 /* Prompt with that and read response. */
8877 message2_nolog (menu
, strlen (menu
),
8878 ! NILP (current_buffer
->enable_multibyte_characters
));
8880 /* Make believe its not a keyboard macro in case the help char
8881 is pressed. Help characters are not recorded because menu prompting
8882 is not used on replay.
8884 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8885 current_kboard
->defining_kbd_macro
= Qnil
;
8887 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8888 while (BUFFERP (obj
));
8889 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8891 if (!INTEGERP (obj
))
8893 else if (XINT (obj
) == -2)
8898 if (! EQ (obj
, menu_prompt_more_char
)
8899 && (!INTEGERP (menu_prompt_more_char
)
8900 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8902 if (!NILP (current_kboard
->defining_kbd_macro
))
8903 store_kbd_macro_char (obj
);
8906 /* Help char - go round again */
8910 /* Reading key sequences. */
8912 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8913 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8914 keymap, or nil otherwise. Return the index of the first keymap in
8915 which KEY has any binding, or NMAPS if no map has a binding.
8917 If KEY is a meta ASCII character, treat it like meta-prefix-char
8918 followed by the corresponding non-meta character. Keymaps in
8919 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8922 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8925 NEXT may be the same array as CURRENT. */
8928 follow_key (key
, nmaps
, current
, defs
, next
)
8930 Lisp_Object
*current
, *defs
, *next
;
8933 int i
, first_binding
;
8935 first_binding
= nmaps
;
8936 for (i
= nmaps
- 1; i
>= 0; i
--)
8938 if (! NILP (current
[i
]))
8940 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8941 if (! NILP (defs
[i
]))
8948 /* Given the set of bindings we've found, produce the next set of maps. */
8949 if (first_binding
< nmaps
)
8950 for (i
= 0; i
< nmaps
; i
++)
8951 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8953 return first_binding
;
8956 /* Structure used to keep track of partial application of key remapping
8957 such as Vfunction_key_map and Vkey_translation_map. */
8958 typedef struct keyremap
8960 /* This is the map originally specified for this use. */
8962 /* This is a submap reached by looking up, in PARENT,
8963 the events from START to END. */
8965 /* Positions [START, END) in the key sequence buffer
8966 are the key that we have scanned so far.
8967 Those events are the ones that we will replace
8968 if PAREHT maps them into a key sequence. */
8972 /* Lookup KEY in MAP.
8973 MAP is a keymap mapping keys to key vectors or functions.
8974 If the mapping is a function and DO_FUNCTION is non-zero, then
8975 the function is called with PROMPT as parameter and its return
8976 value is used as the return value of this function (after checking
8977 that it is indeed a vector). */
8980 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8981 Lisp_Object map
, key
, prompt
;
8986 next
= access_keymap (map
, key
, 1, 0, 1);
8988 /* Handle symbol with autoload definition. */
8989 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8990 && CONSP (XSYMBOL (next
)->function
)
8991 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8992 do_autoload (XSYMBOL (next
)->function
, next
);
8994 /* Handle a symbol whose function definition is a keymap
8996 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8997 && (ARRAYP (XSYMBOL (next
)->function
)
8998 || KEYMAPP (XSYMBOL (next
)->function
)))
8999 next
= XSYMBOL (next
)->function
;
9001 /* If the keymap gives a function, not an
9002 array, then call the function with one arg and use
9003 its value instead. */
9004 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
9009 next
= call1 (next
, prompt
);
9010 /* If the function returned something invalid,
9011 barf--don't ignore it.
9012 (To ignore it safely, we would need to gcpro a bunch of
9013 other variables.) */
9014 if (! (VECTORP (next
) || STRINGP (next
)))
9015 error ("Function %s returns invalid key sequence", tem
);
9020 /* Do one step of the key remapping used for function-key-map and
9021 key-translation-map:
9022 KEYBUF is the buffer holding the input events.
9023 BUFSIZE is its maximum size.
9024 FKEY is a pointer to the keyremap structure to use.
9025 INPUT is the index of the last element in KEYBUF.
9026 DOIT if non-zero says that the remapping can actually take place.
9027 DIFF is used to return the number of keys added/removed by the remapping.
9028 PARENT is the root of the keymap.
9029 PROMPT is the prompt to use if the remapping happens through a function.
9030 The return value is non-zero if the remapping actually took place. */
9033 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
9034 Lisp_Object
*keybuf
, prompt
;
9036 int input
, doit
, *diff
, bufsize
;
9038 Lisp_Object next
, key
;
9040 key
= keybuf
[fkey
->end
++];
9042 if (KEYMAPP (fkey
->parent
))
9043 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9047 /* If keybuf[fkey->start..fkey->end] is bound in the
9048 map and we're in a position to do the key remapping, replace it with
9049 the binding and restart with fkey->start at the end. */
9050 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9052 int len
= XFASTINT (Flength (next
));
9055 *diff
= len
- (fkey
->end
- fkey
->start
);
9057 if (input
+ *diff
>= bufsize
)
9058 error ("Key sequence too long");
9060 /* Shift the keys that follow fkey->end. */
9062 for (i
= fkey
->end
; i
< input
; i
++)
9063 keybuf
[i
+ *diff
] = keybuf
[i
];
9065 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9066 keybuf
[i
+ *diff
] = keybuf
[i
];
9067 /* Overwrite the old keys with the new ones. */
9068 for (i
= 0; i
< len
; i
++)
9069 keybuf
[fkey
->start
+ i
]
9070 = Faref (next
, make_number (i
));
9072 fkey
->start
= fkey
->end
+= *diff
;
9073 fkey
->map
= fkey
->parent
;
9078 fkey
->map
= get_keymap (next
, 0, 1);
9080 /* If we no longer have a bound suffix, try a new position for
9082 if (!CONSP (fkey
->map
))
9084 fkey
->end
= ++fkey
->start
;
9085 fkey
->map
= fkey
->parent
;
9090 /* Read a sequence of keys that ends with a non prefix character,
9091 storing it in KEYBUF, a buffer of size BUFSIZE.
9093 Return the length of the key sequence stored.
9094 Return -1 if the user rejected a command menu.
9096 Echo starting immediately unless `prompt' is 0.
9098 Where a key sequence ends depends on the currently active keymaps.
9099 These include any minor mode keymaps active in the current buffer,
9100 the current buffer's local map, and the global map.
9102 If a key sequence has no other bindings, we check Vfunction_key_map
9103 to see if some trailing subsequence might be the beginning of a
9104 function key's sequence. If so, we try to read the whole function
9105 key, and substitute its symbolic name into the key sequence.
9107 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9108 `double-' events into similar click events, if that would make them
9109 bound. We try to turn `triple-' events first into `double-' events,
9112 If we get a mouse click in a mode line, vertical divider, or other
9113 non-text area, we treat the click as if it were prefixed by the
9114 symbol denoting that area - `mode-line', `vertical-line', or
9117 If the sequence starts with a mouse click, we read the key sequence
9118 with respect to the buffer clicked on, not the current buffer.
9120 If the user switches frames in the midst of a key sequence, we put
9121 off the switch-frame event until later; the next call to
9122 read_char will return it.
9124 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9125 from the selected window's buffer. */
9128 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9129 can_return_switch_frame
, fix_current_buffer
)
9130 Lisp_Object
*keybuf
;
9133 int dont_downcase_last
;
9134 int can_return_switch_frame
;
9135 int fix_current_buffer
;
9137 volatile Lisp_Object from_string
;
9138 volatile int count
= SPECPDL_INDEX ();
9140 /* How many keys there are in the current key sequence. */
9143 /* The length of the echo buffer when we started reading, and
9144 the length of this_command_keys when we started reading. */
9145 volatile int echo_start
;
9146 volatile int keys_start
;
9148 /* The number of keymaps we're scanning right now, and the number of
9149 keymaps we have allocated space for. */
9151 volatile int nmaps_allocated
= 0;
9153 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9154 the current keymaps. */
9155 Lisp_Object
*volatile defs
= NULL
;
9157 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9158 in the current keymaps, or nil where it is not a prefix. */
9159 Lisp_Object
*volatile submaps
= NULL
;
9161 /* The local map to start out with at start of key sequence. */
9162 volatile Lisp_Object orig_local_map
;
9164 /* The map from the `keymap' property to start out with at start of
9166 volatile Lisp_Object orig_keymap
;
9168 /* 1 if we have already considered switching to the local-map property
9169 of the place where a mouse click occurred. */
9170 volatile int localized_local_map
= 0;
9172 /* The index in submaps[] of the first keymap that has a binding for
9173 this key sequence. In other words, the lowest i such that
9174 submaps[i] is non-nil. */
9175 volatile int first_binding
;
9176 /* Index of the first key that has no binding.
9177 It is useless to try fkey.start larger than that. */
9178 volatile int first_unbound
;
9180 /* If t < mock_input, then KEYBUF[t] should be read as the next
9183 We use this to recover after recognizing a function key. Once we
9184 realize that a suffix of the current key sequence is actually a
9185 function key's escape sequence, we replace the suffix with the
9186 function key's binding from Vfunction_key_map. Now keybuf
9187 contains a new and different key sequence, so the echo area,
9188 this_command_keys, and the submaps and defs arrays are wrong. In
9189 this situation, we set mock_input to t, set t to 0, and jump to
9190 restart_sequence; the loop will read keys from keybuf up until
9191 mock_input, thus rebuilding the state; and then it will resume
9192 reading characters from the keyboard. */
9193 volatile int mock_input
= 0;
9195 /* If the sequence is unbound in submaps[], then
9196 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9197 and fkey.map is its binding.
9199 These might be > t, indicating that all function key scanning
9200 should hold off until t reaches them. We do this when we've just
9201 recognized a function key, to avoid searching for the function
9202 key's again in Vfunction_key_map. */
9203 volatile keyremap fkey
;
9205 /* Likewise, for key_translation_map and input-decode-map. */
9206 volatile keyremap keytran
, indec
;
9208 /* Non-zero if we are trying to map a key by changing an upper-case
9209 letter to lower case, or a shifted function key to an unshifted
9211 volatile int shift_translated
= 0;
9213 /* If we receive a `switch-frame' or `select-window' event in the middle of
9214 a key sequence, we put it off for later.
9215 While we're reading, we keep the event here. */
9216 volatile Lisp_Object delayed_switch_frame
;
9218 /* See the comment below... */
9219 #if defined (GOBBLE_FIRST_EVENT)
9220 Lisp_Object first_event
;
9223 volatile Lisp_Object original_uppercase
;
9224 volatile int original_uppercase_position
= -1;
9226 /* Gets around Microsoft compiler limitations. */
9229 struct buffer
*starting_buffer
;
9231 /* List of events for which a fake prefix key has been generated. */
9232 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9234 #if defined (GOBBLE_FIRST_EVENT)
9238 struct gcpro gcpro1
;
9240 GCPRO1 (fake_prefixed_keys
);
9241 raw_keybuf_count
= 0;
9243 last_nonmenu_event
= Qnil
;
9245 delayed_switch_frame
= Qnil
;
9250 echo_prompt (prompt
);
9251 else if (cursor_in_echo_area
9252 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9253 && NILP (Fzerop (Vecho_keystrokes
)))
9254 /* This doesn't put in a dash if the echo buffer is empty, so
9255 you don't always see a dash hanging out in the minibuffer. */
9259 /* Record the initial state of the echo area and this_command_keys;
9260 we will need to restore them if we replay a key sequence. */
9262 echo_start
= echo_length ();
9263 keys_start
= this_command_key_count
;
9264 this_single_command_key_start
= keys_start
;
9266 #if defined (GOBBLE_FIRST_EVENT)
9267 /* This doesn't quite work, because some of the things that read_char
9268 does cannot safely be bypassed. It seems too risky to try to make
9271 /* Read the first char of the sequence specially, before setting
9272 up any keymaps, in case a filter runs and switches buffers on us. */
9273 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9275 #endif /* GOBBLE_FIRST_EVENT */
9277 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9278 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9281 /* We jump here when we need to reinitialize fkey and keytran; this
9282 happens if we switch keyboards between rescans. */
9283 replay_entire_sequence
:
9285 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9286 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9287 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9288 indec
.start
= indec
.end
= 0;
9289 fkey
.start
= fkey
.end
= 0;
9290 keytran
.start
= keytran
.end
= 0;
9292 /* We jump here when the key sequence has been thoroughly changed, and
9293 we need to rescan it starting from the beginning. When we jump here,
9294 keybuf[0..mock_input] holds the sequence we should reread. */
9297 starting_buffer
= current_buffer
;
9298 first_unbound
= bufsize
+ 1;
9300 /* Build our list of keymaps.
9301 If we recognize a function key and replace its escape sequence in
9302 keybuf with its symbol, or if the sequence starts with a mouse
9303 click and we need to switch buffers, we jump back here to rebuild
9304 the initial keymaps from the current buffer. */
9307 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9309 if (2 > nmaps_allocated
)
9311 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9312 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9313 nmaps_allocated
= 2;
9315 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9317 else if (!NILP (Voverriding_local_map
))
9319 if (2 > nmaps_allocated
)
9321 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9322 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9323 nmaps_allocated
= 2;
9325 submaps
[nmaps
++] = Voverriding_local_map
;
9333 nminor
= current_minor_maps (0, &maps
);
9334 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9336 if (total
> nmaps_allocated
)
9338 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9339 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9340 nmaps_allocated
= total
;
9343 if (!NILP (orig_keymap
))
9344 submaps
[nmaps
++] = orig_keymap
;
9346 bcopy (maps
, (void *) (submaps
+ nmaps
),
9347 nminor
* sizeof (submaps
[0]));
9351 submaps
[nmaps
++] = orig_local_map
;
9353 submaps
[nmaps
++] = current_global_map
;
9355 /* Find an accurate initial value for first_binding. */
9356 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9357 if (! NILP (submaps
[first_binding
]))
9360 /* Start from the beginning in keybuf. */
9363 /* These are no-ops the first time through, but if we restart, they
9364 revert the echo area and this_command_keys to their original state. */
9365 this_command_key_count
= keys_start
;
9366 if (INTERACTIVE
&& t
< mock_input
)
9367 echo_truncate (echo_start
);
9369 /* If the best binding for the current key sequence is a keymap, or
9370 we may be looking at a function key's escape sequence, keep on
9372 while (first_binding
< nmaps
9373 /* Keep reading as long as there's a prefix binding. */
9374 ? !NILP (submaps
[first_binding
])
9375 /* Don't return in the middle of a possible function key sequence,
9376 if the only bindings we found were via case conversion.
9377 Thus, if ESC O a has a function-key-map translation
9378 and ESC o has a binding, don't return after ESC O,
9379 so that we can translate ESC O plus the next character. */
9380 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9383 int used_mouse_menu
= 0;
9385 /* Where the last real key started. If we need to throw away a
9386 key that has expanded into more than one element of keybuf
9387 (say, a mouse click on the mode line which is being treated
9388 as [mode-line (mouse-...)], then we backtrack to this point
9390 volatile int last_real_key_start
;
9392 /* These variables are analogous to echo_start and keys_start;
9393 while those allow us to restart the entire key sequence,
9394 echo_local_start and keys_local_start allow us to throw away
9396 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9398 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9399 eassert (indec
.start
<= indec
.end
);
9400 eassert (fkey
.start
<= fkey
.end
);
9401 eassert (keytran
.start
<= keytran
.end
);
9402 /* key-translation-map is applied *after* function-key-map
9403 which is itself applied *after* input-decode-map. */
9404 eassert (fkey
.end
<= indec
.start
);
9405 eassert (keytran
.end
<= fkey
.start
);
9407 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9408 first_unbound
< keytran
.start
)
9409 { /* The prefix upto first_unbound has no binding and has
9410 no translation left to do either, so we know it's unbound.
9411 If we don't stop now, we risk staying here indefinitely
9412 (if the user keeps entering fkey or keytran prefixes
9413 like C-c ESC ESC ESC ESC ...) */
9415 for (i
= first_unbound
+ 1; i
< t
; i
++)
9416 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9417 mock_input
= t
- first_unbound
- 1;
9418 indec
.end
= indec
.start
-= first_unbound
+ 1;
9419 indec
.map
= indec
.parent
;
9420 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9421 fkey
.map
= fkey
.parent
;
9422 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9423 keytran
.map
= keytran
.parent
;
9424 goto replay_sequence
;
9428 error ("Key sequence too long");
9431 echo_local_start
= echo_length ();
9432 keys_local_start
= this_command_key_count
;
9433 local_first_binding
= first_binding
;
9436 /* These are no-ops, unless we throw away a keystroke below and
9437 jumped back up to replay_key; in that case, these restore the
9438 variables to their original state, allowing us to replay the
9440 if (INTERACTIVE
&& t
< mock_input
)
9441 echo_truncate (echo_local_start
);
9442 this_command_key_count
= keys_local_start
;
9443 first_binding
= local_first_binding
;
9445 /* By default, assume each event is "real". */
9446 last_real_key_start
= t
;
9448 /* Does mock_input indicate that we are re-reading a key sequence? */
9452 add_command_key (key
);
9453 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9454 && NILP (Fzerop (Vecho_keystrokes
)))
9458 /* If not, we should actually read a character. */
9462 KBOARD
*interrupted_kboard
= current_kboard
;
9463 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9464 key
= read_char (NILP (prompt
), nmaps
,
9465 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9466 &used_mouse_menu
, NULL
);
9467 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9472 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9473 if (k
== interrupted_kboard
)
9478 /* Don't touch interrupted_kboard when it's been
9480 delayed_switch_frame
= Qnil
;
9481 goto replay_entire_sequence
;
9484 if (!NILP (delayed_switch_frame
))
9486 interrupted_kboard
->kbd_queue
9487 = Fcons (delayed_switch_frame
,
9488 interrupted_kboard
->kbd_queue
);
9489 delayed_switch_frame
= Qnil
;
9493 interrupted_kboard
->kbd_queue
9494 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9496 /* If the side queue is non-empty, ensure it begins with a
9497 switch-frame, so we'll replay it in the right context. */
9498 if (CONSP (interrupted_kboard
->kbd_queue
)
9499 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9500 !(EVENT_HAS_PARAMETERS (key
)
9501 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9505 XSETFRAME (frame
, interrupted_frame
);
9506 interrupted_kboard
->kbd_queue
9507 = Fcons (make_lispy_switch_frame (frame
),
9508 interrupted_kboard
->kbd_queue
);
9511 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9512 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9513 goto replay_entire_sequence
;
9517 /* read_char returns t when it shows a menu and the user rejects it.
9521 unbind_to (count
, Qnil
);
9526 /* read_char returns -1 at the end of a macro.
9527 Emacs 18 handles this by returning immediately with a
9528 zero, so that's what we'll do. */
9529 if (INTEGERP (key
) && XINT (key
) == -1)
9532 /* The Microsoft C compiler can't handle the goto that
9538 /* If the current buffer has been changed from under us, the
9539 keymap may have changed, so replay the sequence. */
9542 timer_resume_idle ();
9545 /* Reset the current buffer from the selected window
9546 in case something changed the former and not the latter.
9547 This is to be more consistent with the behavior
9548 of the command_loop_1. */
9549 if (fix_current_buffer
)
9551 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9553 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9554 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9557 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9558 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9559 goto replay_sequence
;
9562 /* If we have a quit that was typed in another frame, and
9563 quit_throw_to_read_char switched buffers,
9564 replay to get the right keymap. */
9566 && XINT (key
) == quit_char
9567 && current_buffer
!= starting_buffer
)
9570 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9574 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9575 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9576 goto replay_sequence
;
9581 if (EVENT_HAS_PARAMETERS (key
)
9582 /* Either a `switch-frame' or a `select-window' event. */
9583 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9585 /* If we're at the beginning of a key sequence, and the caller
9586 says it's okay, go ahead and return this event. If we're
9587 in the midst of a key sequence, delay it until the end. */
9588 if (t
> 0 || !can_return_switch_frame
)
9590 delayed_switch_frame
= key
;
9596 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9600 /* Clicks in non-text areas get prefixed by the symbol
9601 in their CHAR-ADDRESS field. For example, a click on
9602 the mode line is prefixed by the symbol `mode-line'.
9604 Furthermore, key sequences beginning with mouse clicks
9605 are read using the keymaps of the buffer clicked on, not
9606 the current buffer. So we may have to switch the buffer
9609 When we turn one event into two events, we must make sure
9610 that neither of the two looks like the original--so that,
9611 if we replay the events, they won't be expanded again.
9612 If not for this, such reexpansion could happen either here
9613 or when user programs play with this-command-keys. */
9614 if (EVENT_HAS_PARAMETERS (key
))
9619 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9620 if (EQ (kind
, Qmouse_click
))
9622 Lisp_Object window
, posn
;
9624 window
= POSN_WINDOW (EVENT_START (key
));
9625 posn
= POSN_POSN (EVENT_START (key
));
9628 || (!NILP (fake_prefixed_keys
)
9629 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9631 /* We're looking a second time at an event for which
9632 we generated a fake prefix key. Set
9633 last_real_key_start appropriately. */
9635 last_real_key_start
= t
- 1;
9638 /* Key sequences beginning with mouse clicks are
9639 read using the keymaps in the buffer clicked on,
9640 not the current buffer. If we're at the
9641 beginning of a key sequence, switch buffers. */
9642 if (last_real_key_start
== 0
9644 && BUFFERP (XWINDOW (window
)->buffer
)
9645 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9647 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9651 /* Arrange to go back to the original buffer once we're
9652 done reading the key sequence. Note that we can't
9653 use save_excursion_{save,restore} here, because they
9654 save point as well as the current buffer; we don't
9655 want to save point, because redisplay may change it,
9656 to accommodate a Fset_window_start or something. We
9657 don't want to do this at the top of the function,
9658 because we may get input from a subprocess which
9659 wants to change the selected window and stuff (say,
9661 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9663 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9665 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9666 orig_local_map
= get_local_map (PT
, current_buffer
,
9668 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9669 goto replay_sequence
;
9672 /* For a mouse click, get the local text-property keymap
9673 of the place clicked on, rather than point. */
9674 if (last_real_key_start
== 0
9675 && CONSP (XCDR (key
))
9676 && ! localized_local_map
)
9678 Lisp_Object map_here
, start
, pos
;
9680 localized_local_map
= 1;
9681 start
= EVENT_START (key
);
9683 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9685 pos
= POSN_BUFFER_POSN (start
);
9687 && XINT (pos
) >= BEGV
9688 && XINT (pos
) <= ZV
)
9690 map_here
= get_local_map (XINT (pos
),
9691 current_buffer
, Qlocal_map
);
9692 if (!EQ (map_here
, orig_local_map
))
9694 orig_local_map
= map_here
;
9695 ++localized_local_map
;
9698 map_here
= get_local_map (XINT (pos
),
9699 current_buffer
, Qkeymap
);
9700 if (!EQ (map_here
, orig_keymap
))
9702 orig_keymap
= map_here
;
9703 ++localized_local_map
;
9706 if (localized_local_map
> 1)
9711 goto replay_sequence
;
9717 /* Expand mode-line and scroll-bar events into two events:
9718 use posn as a fake prefix key. */
9720 && (NILP (fake_prefixed_keys
)
9721 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9723 if (t
+ 1 >= bufsize
)
9724 error ("Key sequence too long");
9727 keybuf
[t
+ 1] = key
;
9730 /* Record that a fake prefix key has been generated
9731 for KEY. Don't modify the event; this would
9732 prevent proper action when the event is pushed
9733 back into unread-command-events. */
9734 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9736 /* If on a mode line string with a local keymap,
9737 reconsider the key sequence with that keymap. */
9738 if (string
= POSN_STRING (EVENT_START (key
)),
9739 (CONSP (string
) && STRINGP (XCAR (string
))))
9741 Lisp_Object pos
, map
, map2
;
9743 pos
= XCDR (string
);
9744 string
= XCAR (string
);
9746 && XINT (pos
) < SCHARS (string
))
9748 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9750 orig_local_map
= map
;
9751 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9754 if (!NILP (map
) || !NILP (map2
))
9755 goto replay_sequence
;
9761 else if (NILP (from_string
)
9762 && (string
= POSN_STRING (EVENT_START (key
)),
9763 (CONSP (string
) && STRINGP (XCAR (string
)))))
9765 /* For a click on a string, i.e. overlay string or a
9766 string displayed via the `display' property,
9767 consider `local-map' and `keymap' properties of
9769 Lisp_Object pos
, map
, map2
;
9771 pos
= XCDR (string
);
9772 string
= XCAR (string
);
9774 && XINT (pos
) < SCHARS (string
))
9776 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9778 orig_local_map
= map
;
9779 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9783 if (!NILP (map
) || !NILP (map2
))
9785 from_string
= string
;
9788 goto replay_sequence
;
9793 else if (CONSP (XCDR (key
))
9794 && CONSP (EVENT_START (key
))
9795 && CONSP (XCDR (EVENT_START (key
))))
9799 posn
= POSN_POSN (EVENT_START (key
));
9800 /* Handle menu-bar events:
9801 insert the dummy prefix event `menu-bar'. */
9802 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9804 if (t
+ 1 >= bufsize
)
9805 error ("Key sequence too long");
9809 /* Zap the position in key, so we know that we've
9810 expanded it, and don't try to do so again. */
9811 POSN_SET_POSN (EVENT_START (key
),
9812 Fcons (posn
, Qnil
));
9815 goto replay_sequence
;
9817 else if (CONSP (posn
))
9819 /* We're looking at the second event of a
9820 sequence which we expanded before. Set
9821 last_real_key_start appropriately. */
9822 if (last_real_key_start
== t
&& t
> 0)
9823 last_real_key_start
= t
- 1;
9828 /* We have finally decided that KEY is something we might want
9830 first_binding
= (follow_key (key
,
9831 nmaps
- first_binding
,
9832 submaps
+ first_binding
,
9833 defs
+ first_binding
,
9834 submaps
+ first_binding
)
9837 /* If KEY wasn't bound, we'll try some fallbacks. */
9838 if (first_binding
< nmaps
)
9839 /* This is needed for the following scenario:
9840 event 0: a down-event that gets dropped by calling replay_key.
9841 event 1: some normal prefix like C-h.
9842 After event 0, first_unbound is 0, after event 1 indec.start,
9843 fkey.start, and keytran.start are all 1, so when we see that
9844 C-h is bound, we need to update first_unbound. */
9845 first_unbound
= max (t
+ 1, first_unbound
);
9850 /* Remember the position to put an upper bound on indec.start. */
9851 first_unbound
= min (t
, first_unbound
);
9853 head
= EVENT_HEAD (key
);
9854 if (help_char_p (head
) && t
> 0)
9856 read_key_sequence_cmd
= Vprefix_help_command
;
9858 last_nonmenu_event
= key
;
9859 /* The Microsoft C compiler can't handle the goto that
9867 Lisp_Object breakdown
;
9870 breakdown
= parse_modifiers (head
);
9871 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9872 /* Attempt to reduce an unbound mouse event to a simpler
9873 event that is bound:
9874 Drags reduce to clicks.
9875 Double-clicks reduce to clicks.
9876 Triple-clicks reduce to double-clicks, then to clicks.
9877 Down-clicks are eliminated.
9878 Double-downs reduce to downs, then are eliminated.
9879 Triple-downs reduce to double-downs, then to downs,
9880 then are eliminated. */
9881 if (modifiers
& (down_modifier
| drag_modifier
9882 | double_modifier
| triple_modifier
))
9884 while (modifiers
& (down_modifier
| drag_modifier
9885 | double_modifier
| triple_modifier
))
9887 Lisp_Object new_head
, new_click
;
9888 if (modifiers
& triple_modifier
)
9889 modifiers
^= (double_modifier
| triple_modifier
);
9890 else if (modifiers
& double_modifier
)
9891 modifiers
&= ~double_modifier
;
9892 else if (modifiers
& drag_modifier
)
9893 modifiers
&= ~drag_modifier
;
9896 /* Dispose of this `down' event by simply jumping
9897 back to replay_key, to get another event.
9899 Note that if this event came from mock input,
9900 then just jumping back to replay_key will just
9901 hand it to us again. So we have to wipe out any
9904 We could delete keybuf[t] and shift everything
9905 after that to the left by one spot, but we'd also
9906 have to fix up any variable that points into
9907 keybuf, and shifting isn't really necessary
9910 Adding prefixes for non-textual mouse clicks
9911 creates two characters of mock input, and both
9912 must be thrown away. If we're only looking at
9913 the prefix now, we can just jump back to
9914 replay_key. On the other hand, if we've already
9915 processed the prefix, and now the actual click
9916 itself is giving us trouble, then we've lost the
9917 state of the keymaps we want to backtrack to, and
9918 we need to replay the whole sequence to rebuild
9921 Beyond that, only function key expansion could
9922 create more than two keys, but that should never
9923 generate mouse events, so it's okay to zero
9924 mock_input in that case too.
9926 FIXME: The above paragraph seems just plain
9927 wrong, if you consider things like
9928 xterm-mouse-mode. -stef
9930 Isn't this just the most wonderful code ever? */
9932 /* If mock_input > t + 1, the above simplification
9933 will actually end up dropping keys on the floor.
9934 This is probably OK for now, but even
9935 if mock_input <= t + 1, we need to adjust indec,
9937 Typical case [header-line down-mouse-N]:
9938 mock_input = 2, t = 1, fkey.end = 1,
9939 last_real_key_start = 0. */
9940 if (indec
.end
> last_real_key_start
)
9942 indec
.end
= indec
.start
9943 = min (last_real_key_start
, indec
.start
);
9944 indec
.map
= indec
.parent
;
9945 if (fkey
.end
> last_real_key_start
)
9947 fkey
.end
= fkey
.start
9948 = min (last_real_key_start
, fkey
.start
);
9949 fkey
.map
= fkey
.parent
;
9950 if (keytran
.end
> last_real_key_start
)
9952 keytran
.end
= keytran
.start
9953 = min (last_real_key_start
, keytran
.start
);
9954 keytran
.map
= keytran
.parent
;
9958 if (t
== last_real_key_start
)
9965 mock_input
= last_real_key_start
;
9966 goto replay_sequence
;
9971 = apply_modifiers (modifiers
, XCAR (breakdown
));
9973 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9975 /* Look for a binding for this new key. follow_key
9976 promises that it didn't munge submaps the
9977 last time we called it, since key was unbound. */
9979 = (follow_key (new_click
,
9980 nmaps
- local_first_binding
,
9981 submaps
+ local_first_binding
,
9982 defs
+ local_first_binding
,
9983 submaps
+ local_first_binding
)
9984 + local_first_binding
);
9986 /* If that click is bound, go for it. */
9987 if (first_binding
< nmaps
)
9992 /* Otherwise, we'll leave key set to the drag event. */
9999 /* Normally, last_nonmenu_event gets the previous key we read.
10000 But when a mouse popup menu is being used,
10001 we don't update last_nonmenu_event; it continues to hold the mouse
10002 event that preceded the first level of menu. */
10003 if (!used_mouse_menu
)
10004 last_nonmenu_event
= key
;
10006 /* Record what part of this_command_keys is the current key sequence. */
10007 this_single_command_key_start
= this_command_key_count
- t
;
10009 /* Look for this sequence in input-decode-map.
10010 Scan from indec.end until we find a bound suffix. */
10011 while (indec
.end
< t
)
10013 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10016 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10017 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
10022 mock_input
= diff
+ max (t
, mock_input
);
10023 goto replay_sequence
;
10027 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
10028 && indec
.start
>= t
)
10029 /* There is a binding and it's not a prefix.
10030 (and it doesn't have any input-decode-map translation pending).
10031 There is thus no function-key in this sequence.
10032 Moving fkey.start is important in this case to allow keytran.start
10033 to go over the sequence before we return (since we keep the
10034 invariant that keytran.end <= fkey.start). */
10036 if (fkey
.start
< t
)
10037 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10040 /* If the sequence is unbound, see if we can hang a function key
10041 off the end of it. */
10042 /* Continue scan from fkey.end until we find a bound suffix. */
10043 while (fkey
.end
< indec
.start
)
10045 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10048 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10049 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10050 max (t
, mock_input
),
10051 /* If there's a binding (i.e.
10052 first_binding >= nmaps) we don't want
10053 to apply this function-key-mapping. */
10054 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10059 mock_input
= diff
+ max (t
, mock_input
);
10060 /* Adjust the input-decode-map counters. */
10062 indec
.start
+= diff
;
10064 goto replay_sequence
;
10068 /* Look for this sequence in key-translation-map.
10069 Scan from keytran.end until we find a bound suffix. */
10070 while (keytran
.end
< fkey
.start
)
10072 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10075 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10076 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10081 mock_input
= diff
+ max (t
, mock_input
);
10082 /* Adjust the function-key-map and input-decode-map counters. */
10084 indec
.start
+= diff
;
10086 fkey
.start
+= diff
;
10088 goto replay_sequence
;
10092 /* If KEY is not defined in any of the keymaps,
10093 and cannot be part of a function key or translation,
10094 and is an upper case letter
10095 use the corresponding lower-case letter instead. */
10096 if (first_binding
>= nmaps
10097 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10099 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10100 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10101 || (XINT (key
) & shift_modifier
)))
10103 Lisp_Object new_key
;
10105 original_uppercase
= key
;
10106 original_uppercase_position
= t
- 1;
10108 if (XINT (key
) & shift_modifier
)
10109 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10111 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10112 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10114 /* We have to do this unconditionally, regardless of whether
10115 the lower-case char is defined in the keymaps, because they
10116 might get translated through function-key-map. */
10117 keybuf
[t
- 1] = new_key
;
10118 mock_input
= max (t
, mock_input
);
10119 shift_translated
= 1;
10121 goto replay_sequence
;
10123 /* If KEY is not defined in any of the keymaps,
10124 and cannot be part of a function key or translation,
10125 and is a shifted function key,
10126 use the corresponding unshifted function key instead. */
10127 if (first_binding
>= nmaps
10128 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10130 Lisp_Object breakdown
= parse_modifiers (key
);
10132 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10134 if (modifiers
& shift_modifier
10135 /* Treat uppercase keys as shifted. */
10137 && (KEY_TO_CHAR (key
)
10138 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10139 && UPPERCASEP (KEY_TO_CHAR (key
))))
10141 Lisp_Object new_key
10142 = (modifiers
& shift_modifier
10143 ? apply_modifiers (modifiers
& ~shift_modifier
,
10145 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10147 original_uppercase
= key
;
10148 original_uppercase_position
= t
- 1;
10150 /* We have to do this unconditionally, regardless of whether
10151 the lower-case char is defined in the keymaps, because they
10152 might get translated through function-key-map. */
10153 keybuf
[t
- 1] = new_key
;
10154 mock_input
= max (t
, mock_input
);
10155 /* Reset fkey (and consequently keytran) to apply
10156 function-key-map on the result, so that S-backspace is
10157 correctly mapped to DEL (via backspace). OTOH,
10158 input-decode-map doesn't need to go through it again. */
10159 fkey
.start
= fkey
.end
= 0;
10160 keytran
.start
= keytran
.end
= 0;
10161 shift_translated
= 1;
10163 goto replay_sequence
;
10168 read_key_sequence_cmd
= (first_binding
< nmaps
10169 ? defs
[first_binding
]
10172 unread_switch_frame
= delayed_switch_frame
;
10173 unbind_to (count
, Qnil
);
10175 /* Don't downcase the last character if the caller says don't.
10176 Don't downcase it if the result is undefined, either. */
10177 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10179 && t
- 1 == original_uppercase_position
)
10181 keybuf
[t
- 1] = original_uppercase
;
10182 shift_translated
= 0;
10185 if (shift_translated
)
10186 Vthis_command_keys_shift_translated
= Qt
;
10188 /* Occasionally we fabricate events, perhaps by expanding something
10189 according to function-key-map, or by adding a prefix symbol to a
10190 mouse click in the scroll bar or modeline. In this cases, return
10191 the entire generated key sequence, even if we hit an unbound
10192 prefix or a definition before the end. This means that you will
10193 be able to push back the event properly, and also means that
10194 read-key-sequence will always return a logical unit.
10197 for (; t
< mock_input
; t
++)
10199 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10200 && NILP (Fzerop (Vecho_keystrokes
)))
10201 echo_char (keybuf
[t
]);
10202 add_command_key (keybuf
[t
]);
10209 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10210 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10211 The sequence is sufficient to specify a non-prefix command in the
10212 current local and global maps.
10214 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10215 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10216 as a continuation of the previous key.
10218 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10219 convert the last event to lower case. (Normally any upper case event
10220 is converted to lower case if the original event is undefined and the lower
10221 case equivalent is defined.) A non-nil value is appropriate for reading
10222 a key sequence to be defined.
10224 A C-g typed while in this function is treated like any other character,
10225 and `quit-flag' is not set.
10227 If the key sequence starts with a mouse click, then the sequence is read
10228 using the keymaps of the buffer of the window clicked in, not the buffer
10229 of the selected window as normal.
10231 `read-key-sequence' drops unbound button-down events, since you normally
10232 only care about the click or drag events which follow them. If a drag
10233 or multi-click event is unbound, but the corresponding click event would
10234 be bound, `read-key-sequence' turns the event into a click event at the
10235 drag's starting position. This means that you don't have to distinguish
10236 between click and drag, double, or triple events unless you want to.
10238 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10239 lines separating windows, and scroll bars with imaginary keys
10240 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10242 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10243 function will process a switch-frame event if the user switches frames
10244 before typing anything. If the user switches frames in the middle of a
10245 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10246 is nil, then the event will be put off until after the current key sequence.
10248 `read-key-sequence' checks `function-key-map' for function key
10249 sequences, where they wouldn't conflict with ordinary bindings. See
10250 `function-key-map' for more details.
10252 The optional fifth argument COMMAND-LOOP, if non-nil, means
10253 that this key sequence is being read by something that will
10254 read commands one after another. It should be nil if the caller
10255 will read just one key sequence. */)
10256 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10258 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10259 Lisp_Object can_return_switch_frame
, command_loop
;
10261 Lisp_Object keybuf
[30];
10263 struct gcpro gcpro1
;
10264 int count
= SPECPDL_INDEX ();
10266 if (!NILP (prompt
))
10267 CHECK_STRING (prompt
);
10270 specbind (Qinput_method_exit_on_first_char
,
10271 (NILP (command_loop
) ? Qt
: Qnil
));
10272 specbind (Qinput_method_use_echo_area
,
10273 (NILP (command_loop
) ? Qt
: Qnil
));
10275 bzero (keybuf
, sizeof keybuf
);
10276 GCPRO1 (keybuf
[0]);
10277 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10279 if (NILP (continue_echo
))
10281 this_command_key_count
= 0;
10282 this_command_key_count_reset
= 0;
10283 this_single_command_key_start
= 0;
10286 #ifdef HAVE_WINDOW_SYSTEM
10287 if (display_hourglass_p
)
10288 cancel_hourglass ();
10291 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10292 prompt
, ! NILP (dont_downcase_last
),
10293 ! NILP (can_return_switch_frame
), 0);
10295 #if 0 /* The following is fine for code reading a key sequence and
10296 then proceeding with a lenghty computation, but it's not good
10297 for code reading keys in a loop, like an input method. */
10298 #ifdef HAVE_WINDOW_SYSTEM
10299 if (display_hourglass_p
)
10300 start_hourglass ();
10310 return unbind_to (count
, make_event_array (i
, keybuf
));
10313 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10314 Sread_key_sequence_vector
, 1, 5, 0,
10315 doc
: /* Like `read-key-sequence' but always return a vector. */)
10316 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10318 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10319 Lisp_Object can_return_switch_frame
, command_loop
;
10321 Lisp_Object keybuf
[30];
10323 struct gcpro gcpro1
;
10324 int count
= SPECPDL_INDEX ();
10326 if (!NILP (prompt
))
10327 CHECK_STRING (prompt
);
10330 specbind (Qinput_method_exit_on_first_char
,
10331 (NILP (command_loop
) ? Qt
: Qnil
));
10332 specbind (Qinput_method_use_echo_area
,
10333 (NILP (command_loop
) ? Qt
: Qnil
));
10335 bzero (keybuf
, sizeof keybuf
);
10336 GCPRO1 (keybuf
[0]);
10337 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10339 if (NILP (continue_echo
))
10341 this_command_key_count
= 0;
10342 this_command_key_count_reset
= 0;
10343 this_single_command_key_start
= 0;
10346 #ifdef HAVE_WINDOW_SYSTEM
10347 if (display_hourglass_p
)
10348 cancel_hourglass ();
10351 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10352 prompt
, ! NILP (dont_downcase_last
),
10353 ! NILP (can_return_switch_frame
), 0);
10355 #ifdef HAVE_WINDOW_SYSTEM
10356 if (display_hourglass_p
)
10357 start_hourglass ();
10366 return unbind_to (count
, Fvector (i
, keybuf
));
10369 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10370 doc
: /* Execute CMD as an editor command.
10371 CMD must be a symbol that satisfies the `commandp' predicate.
10372 Optional second arg RECORD-FLAG non-nil
10373 means unconditionally put this command in `command-history'.
10374 Otherwise, that is done only if an arg is read using the minibuffer.
10375 The argument KEYS specifies the value to use instead of (this-command-keys)
10376 when reading the arguments; if it is nil, (this-command-keys) is used.
10377 The argument SPECIAL, if non-nil, means that this command is executing
10378 a special event, so ignore the prefix argument and don't clear it. */)
10379 (cmd
, record_flag
, keys
, special
)
10380 Lisp_Object cmd
, record_flag
, keys
, special
;
10382 register Lisp_Object final
;
10383 register Lisp_Object tem
;
10384 Lisp_Object prefixarg
;
10385 extern int debug_on_next_call
;
10387 debug_on_next_call
= 0;
10389 if (NILP (special
))
10391 prefixarg
= current_kboard
->Vprefix_arg
;
10392 Vcurrent_prefix_arg
= prefixarg
;
10393 current_kboard
->Vprefix_arg
= Qnil
;
10400 tem
= Fget (cmd
, Qdisabled
);
10401 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10403 tem
= Fsymbol_value (Qdisabled_command_function
);
10405 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10411 final
= Findirect_function (cmd
, Qnil
);
10413 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10415 struct gcpro gcpro1
, gcpro2
;
10417 GCPRO2 (cmd
, prefixarg
);
10418 do_autoload (final
, cmd
);
10425 if (STRINGP (final
) || VECTORP (final
))
10427 /* If requested, place the macro in the command history. For
10428 other sorts of commands, call-interactively takes care of
10430 if (!NILP (record_flag
))
10433 = Fcons (Fcons (Qexecute_kbd_macro
,
10434 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10437 /* Don't keep command history around forever. */
10438 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10440 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10442 XSETCDR (tem
, Qnil
);
10446 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10449 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10450 /* Don't call Fcall_interactively directly because we want to make
10451 sure the backtrace has an entry for `call-interactively'.
10452 For the same reason, pass `cmd' rather than `final'. */
10453 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10460 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10462 doc
: /* Read function name, then read its arguments and call it.
10464 To pass a numeric argument to the command you are invoking with, specify
10465 the numeric argument to this command.
10467 Noninteractively, the argument PREFIXARG is the prefix argument to
10468 give to the command you invoke, if it asks for an argument. */)
10470 Lisp_Object prefixarg
;
10472 Lisp_Object function
;
10474 int saved_last_point_position
;
10475 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10476 Lisp_Object bindings
, value
;
10477 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10478 #ifdef HAVE_WINDOW_SYSTEM
10479 /* The call to Fcompleting_read wil start and cancel the hourglass,
10480 but if the hourglass was already scheduled, this means that no
10481 hourglass will be shown for the actual M-x command itself.
10482 So we restart it if it is already scheduled. Note that checking
10483 hourglass_shown_p is not enough, normally the hourglass is not shown,
10484 just scheduled to be shown. */
10485 int hstarted
= hourglass_started ();
10488 saved_keys
= Fvector (this_command_key_count
,
10489 XVECTOR (this_command_keys
)->contents
);
10490 saved_last_point_position_buffer
= last_point_position_buffer
;
10491 saved_last_point_position
= last_point_position
;
10493 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10495 if (EQ (prefixarg
, Qminus
))
10496 strcpy (buf
, "- ");
10497 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10498 strcpy (buf
, "C-u ");
10499 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10500 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10501 else if (INTEGERP (prefixarg
))
10502 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10504 /* This isn't strictly correct if execute-extended-command
10505 is bound to anything else. Perhaps it should use
10506 this_command_keys? */
10507 strcat (buf
, "M-x ");
10509 /* Prompt with buf, and then read a string, completing from and
10510 restricting to the set of all defined commands. Don't provide
10511 any initial input. Save the command read on the extended-command
10513 function
= Fcompleting_read (build_string (buf
),
10514 Vobarray
, Qcommandp
,
10515 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10518 #ifdef HAVE_WINDOW_SYSTEM
10519 if (hstarted
) start_hourglass ();
10522 if (STRINGP (function
) && SCHARS (function
) == 0)
10523 error ("No command name given");
10525 /* Set this_command_keys to the concatenation of saved_keys and
10526 function, followed by a RET. */
10531 this_command_key_count
= 0;
10532 this_command_key_count_reset
= 0;
10533 this_single_command_key_start
= 0;
10535 keys
= XVECTOR (saved_keys
)->contents
;
10536 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10537 add_command_key (keys
[i
]);
10539 for (i
= 0; i
< SCHARS (function
); i
++)
10540 add_command_key (Faref (function
, make_number (i
)));
10542 add_command_key (make_number ('\015'));
10545 last_point_position
= saved_last_point_position
;
10546 last_point_position_buffer
= saved_last_point_position_buffer
;
10550 function
= Fintern (function
, Qnil
);
10551 current_kboard
->Vprefix_arg
= prefixarg
;
10552 Vthis_command
= function
;
10553 real_this_command
= function
;
10555 /* If enabled, show which key runs this command. */
10556 if (!NILP (Vsuggest_key_bindings
)
10557 && NILP (Vexecuting_kbd_macro
)
10558 && SYMBOLP (function
))
10559 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10565 GCPRO3 (bindings
, value
, function
);
10566 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10568 /* If the command has a key binding, print it now. */
10569 if (!NILP (bindings
)
10570 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10573 /* But first wait, and skip the message if there is input. */
10574 Lisp_Object waited
;
10576 /* If this command displayed something in the echo area;
10577 wait a few seconds, then display our suggestion message. */
10578 if (NILP (echo_area_buffer
[0]))
10579 waited
= sit_for (make_number (0), 0, 2);
10580 else if (NUMBERP (Vsuggest_key_bindings
))
10581 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10583 waited
= sit_for (make_number (2), 0, 2);
10585 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10587 Lisp_Object binding
;
10589 int message_p
= push_message ();
10590 int count
= SPECPDL_INDEX ();
10592 record_unwind_protect (pop_message_unwind
, Qnil
);
10593 binding
= Fkey_description (bindings
, Qnil
);
10596 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10599 sprintf (newmessage
, "You can run the command `%s' with %s",
10600 SDATA (SYMBOL_NAME (function
)),
10602 message2_nolog (newmessage
,
10603 strlen (newmessage
),
10604 STRING_MULTIBYTE (binding
));
10605 if (NUMBERP (Vsuggest_key_bindings
))
10606 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10608 waited
= sit_for (make_number (2), 0, 2);
10610 if (!NILP (waited
) && message_p
)
10611 restore_message ();
10613 unbind_to (count
, Qnil
);
10617 RETURN_UNGCPRO (value
);
10621 /* Return nonzero if input events are pending. */
10624 detect_input_pending ()
10626 if (!input_pending
)
10627 get_input_pending (&input_pending
, 0);
10629 return input_pending
;
10632 /* Return nonzero if input events other than mouse movements are
10636 detect_input_pending_ignore_squeezables ()
10638 if (!input_pending
)
10639 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10641 return input_pending
;
10644 /* Return nonzero if input events are pending, and run any pending timers. */
10647 detect_input_pending_run_timers (do_display
)
10650 int old_timers_run
= timers_run
;
10652 if (!input_pending
)
10653 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10655 if (old_timers_run
!= timers_run
&& do_display
)
10657 redisplay_preserve_echo_area (8);
10658 /* The following fixes a bug when using lazy-lock with
10659 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10660 from an idle timer function. The symptom of the bug is that
10661 the cursor sometimes doesn't become visible until the next X
10662 event is processed. --gerd. */
10664 Lisp_Object tail
, frame
;
10665 FOR_EACH_FRAME (tail
, frame
)
10666 if (FRAME_RIF (XFRAME (frame
)))
10667 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10671 return input_pending
;
10674 /* This is called in some cases before a possible quit.
10675 It cases the next call to detect_input_pending to recompute input_pending.
10676 So calling this function unnecessarily can't do any harm. */
10679 clear_input_pending ()
10684 /* Return nonzero if there are pending requeued events.
10685 This isn't used yet. The hope is to make wait_reading_process_output
10686 call it, and return if it runs Lisp code that unreads something.
10687 The problem is, kbd_buffer_get_event needs to be fixed to know what
10688 to do in that case. It isn't trivial. */
10691 requeued_events_pending_p ()
10693 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10697 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10698 doc
: /* Return t if command input is currently available with no wait.
10699 Actually, the value is nil only if we can be sure that no input is available;
10700 if there is a doubt, the value is t. */)
10703 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10704 || !NILP (Vunread_post_input_method_events
)
10705 || !NILP (Vunread_input_method_events
))
10708 get_input_pending (&input_pending
,
10709 READABLE_EVENTS_DO_TIMERS_NOW
10710 | READABLE_EVENTS_FILTER_EVENTS
);
10711 return input_pending
> 0 ? Qt
: Qnil
;
10714 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10715 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10718 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10721 if (total_keys
< NUM_RECENT_KEYS
)
10722 return Fvector (total_keys
, keys
);
10725 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10726 bcopy (keys
+ recent_keys_index
,
10727 XVECTOR (val
)->contents
,
10728 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10730 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10731 recent_keys_index
* sizeof (Lisp_Object
));
10736 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10737 doc
: /* Return the key sequence that invoked this command.
10738 However, if the command has called `read-key-sequence', it returns
10739 the last key sequence that has been read.
10740 The value is a string or a vector.
10742 See also `this-command-keys-vector'. */)
10745 return make_event_array (this_command_key_count
,
10746 XVECTOR (this_command_keys
)->contents
);
10749 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10750 doc
: /* Return the key sequence that invoked this command, as a vector.
10751 However, if the command has called `read-key-sequence', it returns
10752 the last key sequence that has been read.
10754 See also `this-command-keys'. */)
10757 return Fvector (this_command_key_count
,
10758 XVECTOR (this_command_keys
)->contents
);
10761 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10762 Sthis_single_command_keys
, 0, 0, 0,
10763 doc
: /* Return the key sequence that invoked this command.
10764 More generally, it returns the last key sequence read, either by
10765 the command loop or by `read-key-sequence'.
10766 Unlike `this-command-keys', this function's value
10767 does not include prefix arguments.
10768 The value is always a vector. */)
10771 return Fvector (this_command_key_count
10772 - this_single_command_key_start
,
10773 (XVECTOR (this_command_keys
)->contents
10774 + this_single_command_key_start
));
10777 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10778 Sthis_single_command_raw_keys
, 0, 0, 0,
10779 doc
: /* Return the raw events that were read for this command.
10780 More generally, it returns the last key sequence read, either by
10781 the command loop or by `read-key-sequence'.
10782 Unlike `this-single-command-keys', this function's value
10783 shows the events before all translations (except for input methods).
10784 The value is always a vector. */)
10787 return Fvector (raw_keybuf_count
,
10788 (XVECTOR (raw_keybuf
)->contents
));
10791 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10792 Sreset_this_command_lengths
, 0, 0, 0,
10793 doc
: /* Make the unread events replace the last command and echo.
10794 Used in `universal-argument-other-key'.
10796 `universal-argument-other-key' rereads the event just typed.
10797 It then gets translated through `function-key-map'.
10798 The translated event has to replace the real events,
10799 both in the value of (this-command-keys) and in echoing.
10800 To achieve this, `universal-argument-other-key' calls
10801 `reset-this-command-lengths', which discards the record of reading
10802 these events the first time. */)
10805 this_command_key_count
= before_command_key_count
;
10806 if (this_command_key_count
< this_single_command_key_start
)
10807 this_single_command_key_start
= this_command_key_count
;
10809 echo_truncate (before_command_echo_length
);
10811 /* Cause whatever we put into unread-command-events
10812 to echo as if it were being freshly read from the keyboard. */
10813 this_command_key_count_reset
= 1;
10818 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10819 Sclear_this_command_keys
, 0, 1, 0,
10820 doc
: /* Clear out the vector that `this-command-keys' returns.
10821 Also clear the record of the last 100 events, unless optional arg
10822 KEEP-RECORD is non-nil. */)
10824 Lisp_Object keep_record
;
10828 this_command_key_count
= 0;
10829 this_command_key_count_reset
= 0;
10831 if (NILP (keep_record
))
10833 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10834 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10836 recent_keys_index
= 0;
10841 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10842 doc
: /* Return the current depth in recursive edits. */)
10846 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10850 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10851 "FOpen dribble file: ",
10852 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10853 If FILE is nil, close any open dribble file. */)
10866 file
= Fexpand_file_name (file
, Qnil
);
10867 dribble
= fopen (SDATA (file
), "w");
10869 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10874 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10875 doc
: /* Discard the contents of the terminal input buffer.
10876 Also end any kbd macro being defined. */)
10879 if (!NILP (current_kboard
->defining_kbd_macro
))
10881 /* Discard the last command from the macro. */
10882 Fcancel_kbd_macro_events ();
10886 update_mode_lines
++;
10888 Vunread_command_events
= Qnil
;
10889 unread_command_char
= -1;
10891 discard_tty_input ();
10893 kbd_fetch_ptr
= kbd_store_ptr
;
10899 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10900 doc
: /* Stop Emacs and return to superior process. You can resume later.
10901 If `cannot-suspend' is non-nil, or if the system doesn't support job
10902 control, run a subshell instead.
10904 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10905 to be read as terminal input by Emacs's parent, after suspension.
10907 Before suspending, run the normal hook `suspend-hook'.
10908 After resumption run the normal hook `suspend-resume-hook'.
10910 Some operating systems cannot stop the Emacs process and resume it later.
10911 On such systems, Emacs starts a subshell instead of suspending. */)
10913 Lisp_Object stuffstring
;
10915 int count
= SPECPDL_INDEX ();
10916 int old_height
, old_width
;
10918 struct gcpro gcpro1
;
10920 if (tty_list
&& tty_list
->next
)
10921 error ("There are other tty frames open; close them before suspending Emacs");
10923 if (!NILP (stuffstring
))
10924 CHECK_STRING (stuffstring
);
10926 /* Run the functions in suspend-hook. */
10927 if (!NILP (Vrun_hooks
))
10928 call1 (Vrun_hooks
, intern ("suspend-hook"));
10930 GCPRO1 (stuffstring
);
10931 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10932 reset_all_sys_modes ();
10933 /* sys_suspend can get an error if it tries to fork a subshell
10934 and the system resources aren't available for that. */
10935 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10937 stuff_buffered_input (stuffstring
);
10938 if (cannot_suspend
)
10942 unbind_to (count
, Qnil
);
10944 /* Check if terminal/window size has changed.
10945 Note that this is not useful when we are running directly
10946 with a window system; but suspend should be disabled in that case. */
10947 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10948 if (width
!= old_width
|| height
!= old_height
)
10949 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10951 /* Run suspend-resume-hook. */
10952 if (!NILP (Vrun_hooks
))
10953 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10959 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10960 Then in any case stuff anything Emacs has read ahead and not used. */
10963 stuff_buffered_input (stuffstring
)
10964 Lisp_Object stuffstring
;
10966 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10967 register unsigned char *p
;
10969 if (STRINGP (stuffstring
))
10971 register int count
;
10973 p
= SDATA (stuffstring
);
10974 count
= SBYTES (stuffstring
);
10975 while (count
-- > 0)
10980 /* Anything we have read ahead, put back for the shell to read. */
10981 /* ?? What should this do when we have multiple keyboards??
10982 Should we ignore anything that was typed in at the "wrong" kboard?
10984 rms: we should stuff everything back into the kboard
10986 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10989 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10990 kbd_fetch_ptr
= kbd_buffer
;
10991 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10992 stuff_char (kbd_fetch_ptr
->code
);
10994 clear_event (kbd_fetch_ptr
);
10998 #endif /* SIGTSTP */
11002 set_waiting_for_input (time_to_clear
)
11003 EMACS_TIME
*time_to_clear
;
11005 input_available_clear_time
= time_to_clear
;
11007 /* Tell handle_interrupt to throw back to read_char, */
11008 waiting_for_input
= 1;
11010 /* If handle_interrupt was called before and buffered a C-g,
11011 make it run again now, to avoid timing error. */
11012 if (!NILP (Vquit_flag
))
11013 quit_throw_to_read_char ();
11017 clear_waiting_for_input ()
11019 /* Tell handle_interrupt not to throw back to read_char, */
11020 waiting_for_input
= 0;
11021 input_available_clear_time
= 0;
11024 /* The SIGINT handler.
11026 If we have a frame on the controlling tty, we assume that the
11027 SIGINT was generated by C-g, so we call handle_interrupt.
11028 Otherwise, the handler kills Emacs. */
11031 interrupt_signal (signalnum
) /* If we don't have an argument, */
11032 int signalnum
; /* some compilers complain in signal calls. */
11034 /* Must preserve main program's value of errno. */
11035 int old_errno
= errno
;
11036 struct terminal
*terminal
;
11038 #if defined (USG) && !defined (POSIX_SIGNALS)
11039 /* USG systems forget handlers when they are used;
11040 must reestablish each time */
11041 signal (SIGINT
, interrupt_signal
);
11042 signal (SIGQUIT
, interrupt_signal
);
11045 SIGNAL_THREAD_CHECK (signalnum
);
11047 /* See if we have an active terminal on our controlling tty. */
11048 terminal
= get_named_tty ("/dev/tty");
11051 /* If there are no frames there, let's pretend that we are a
11052 well-behaving UN*X program and quit. */
11053 Fkill_emacs (Qnil
);
11057 /* Otherwise, the SIGINT was probably generated by C-g. */
11059 /* Set internal_last_event_frame to the top frame of the
11060 controlling tty, if we have a frame there. We disable the
11061 interrupt key on secondary ttys, so the SIGINT must have come
11062 from the controlling tty. */
11063 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11065 handle_interrupt ();
11071 /* This routine is called at interrupt level in response to C-g.
11073 It is called from the SIGINT handler or kbd_buffer_store_event.
11075 If `waiting_for_input' is non zero, then unless `echoing' is
11076 nonzero, immediately throw back to read_char.
11078 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11079 eval to throw, when it gets a chance. If quit-flag is already
11080 non-nil, it stops the job right away. */
11083 handle_interrupt ()
11089 /* XXX This code needs to be revised for multi-tty support. */
11090 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
11092 /* If SIGINT isn't blocked, don't let us be interrupted by
11093 another SIGINT, it might be harmful due to non-reentrancy
11094 in I/O functions. */
11095 sigblock (sigmask (SIGINT
));
11098 reset_all_sys_modes ();
11100 #ifdef SIGTSTP /* Support possible in later USG versions */
11102 * On systems which can suspend the current process and return to the original
11103 * shell, this command causes the user to end up back at the shell.
11104 * The "Auto-save" and "Abort" questions are not asked until
11105 * the user elects to return to emacs, at which point he can save the current
11106 * job and either dump core or continue.
11110 /* Perhaps should really fork an inferior shell?
11111 But that would not provide any way to get back
11112 to the original shell, ever. */
11113 printf ("No support for stopping a process on this operating system;\n");
11114 printf ("you can continue or abort.\n");
11115 #endif /* not SIGTSTP */
11117 /* We must remain inside the screen area when the internal terminal
11118 is used. Note that [Enter] is not echoed by dos. */
11119 cursor_to (SELECTED_FRAME (), 0, 0);
11121 /* It doesn't work to autosave while GC is in progress;
11122 the code used for auto-saving doesn't cope with the mark bit. */
11123 if (!gc_in_progress
)
11125 printf ("Auto-save? (y or n) ");
11127 if (((c
= getchar ()) & ~040) == 'Y')
11129 Fdo_auto_save (Qt
, Qnil
);
11131 printf ("\r\nAuto-save done");
11132 #else /* not MSDOS */
11133 printf ("Auto-save done\n");
11134 #endif /* not MSDOS */
11136 while (c
!= '\n') c
= getchar ();
11140 /* During GC, it must be safe to reenable quitting again. */
11141 Vinhibit_quit
= Qnil
;
11144 #endif /* not MSDOS */
11145 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11146 printf ("but will instead do a real quit after garbage collection ends\r\n");
11151 printf ("\r\nAbort? (y or n) ");
11152 #else /* not MSDOS */
11153 printf ("Abort (and dump core)? (y or n) ");
11154 #endif /* not MSDOS */
11156 if (((c
= getchar ()) & ~040) == 'Y')
11158 while (c
!= '\n') c
= getchar ();
11160 printf ("\r\nContinuing...\r\n");
11161 #else /* not MSDOS */
11162 printf ("Continuing...\n");
11163 #endif /* not MSDOS */
11165 init_all_sys_modes ();
11170 /* If executing a function that wants to be interrupted out of
11171 and the user has not deferred quitting by binding `inhibit-quit'
11172 then quit right away. */
11173 if (immediate_quit
&& NILP (Vinhibit_quit
))
11175 struct gl_state_s saved
;
11176 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11178 immediate_quit
= 0;
11181 GCPRO4 (saved
.object
, saved
.global_code
,
11182 saved
.current_syntax_table
, saved
.old_prop
);
11183 Fsignal (Qquit
, Qnil
);
11188 /* Else request quit when it's safe */
11192 /* TODO: The longjmp in this call throws the NS event loop integration off,
11193 and it seems to do fine without this. Probably some attention
11194 needs to be paid to the setting of waiting_for_input in
11195 wait_reading_process_output() under HAVE_NS because of the call
11196 to ns_select there (needed because otherwise events aren't picked up
11197 outside of polling since we don't get SIGIO like X and we don't have a
11198 separate event loop thread like W32. */
11200 if (waiting_for_input
&& !echoing
)
11201 quit_throw_to_read_char ();
11205 /* Handle a C-g by making read_char return C-g. */
11208 quit_throw_to_read_char ()
11211 /* Prevent another signal from doing this before we finish. */
11212 clear_waiting_for_input ();
11215 Vunread_command_events
= Qnil
;
11216 unread_command_char
= -1;
11218 #if 0 /* Currently, sit_for is called from read_char without turning
11219 off polling. And that can call set_waiting_for_input.
11220 It seems to be harmless. */
11221 #ifdef POLL_FOR_INPUT
11222 /* May be > 1 if in recursive minibuffer. */
11223 if (poll_suppress_count
== 0)
11227 if (FRAMEP (internal_last_event_frame
)
11228 && !EQ (internal_last_event_frame
, selected_frame
))
11229 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11232 _longjmp (getcjmp
, 1);
11235 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11236 doc
: /* Set interrupt mode of reading keyboard input.
11237 If INTERRUPT is non-nil, Emacs will use input interrupts;
11238 otherwise Emacs uses CBREAK mode.
11240 See also `current-input-mode'. */)
11242 Lisp_Object interrupt
;
11244 int new_interrupt_input
;
11246 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11247 #ifdef HAVE_X_WINDOWS
11248 if (x_display_list
!= NULL
)
11250 /* When using X, don't give the user a real choice,
11251 because we haven't implemented the mechanisms to support it. */
11252 #ifdef NO_SOCK_SIGIO
11253 new_interrupt_input
= 0;
11254 #else /* not NO_SOCK_SIGIO */
11255 new_interrupt_input
= 1;
11256 #endif /* NO_SOCK_SIGIO */
11259 #endif /* HAVE_X_WINDOWS */
11260 new_interrupt_input
= !NILP (interrupt
);
11261 #else /* not SIGIO */
11262 new_interrupt_input
= 0;
11263 #endif /* not SIGIO */
11265 if (new_interrupt_input
!= interrupt_input
)
11267 #ifdef POLL_FOR_INPUT
11271 /* this causes startup screen to be restored and messes with the mouse */
11272 reset_all_sys_modes ();
11274 interrupt_input
= new_interrupt_input
;
11276 init_all_sys_modes ();
11279 #ifdef POLL_FOR_INPUT
11280 poll_suppress_count
= 1;
11287 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11288 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11289 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11290 C-q in key sequences.
11292 This setting only has an effect on tty terminals and only when
11293 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11295 See also `current-input-mode'. */)
11297 Lisp_Object flow
, terminal
;
11299 struct terminal
*t
= get_terminal (terminal
, 1);
11300 struct tty_display_info
*tty
;
11301 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11303 tty
= t
->display_info
.tty
;
11305 if (tty
->flow_control
!= !NILP (flow
))
11308 /* this causes startup screen to be restored and messes with the mouse */
11309 reset_sys_modes (tty
);
11312 tty
->flow_control
= !NILP (flow
);
11315 init_sys_modes (tty
);
11321 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11322 doc
: /* Enable or disable 8-bit input on TERMINAL.
11323 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11324 bit as the Meta modifier.
11326 If META is nil, Emacs will ignore the top bit, on the assumption it is
11329 Otherwise, Emacs will accept and pass through 8-bit input without
11330 specially interpreting the top bit.
11332 This setting only has an effect on tty terminal devices.
11334 Optional parameter TERMINAL specifies the tty terminal device to use.
11335 It may be a terminal object, a frame, or nil for the terminal used by
11336 the currently selected frame.
11338 See also `current-input-mode'. */)
11340 Lisp_Object meta
, terminal
;
11342 struct terminal
*t
= get_terminal (terminal
, 1);
11343 struct tty_display_info
*tty
;
11346 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11348 tty
= t
->display_info
.tty
;
11352 else if (EQ (meta
, Qt
))
11357 if (tty
->meta_key
!= new_meta
)
11360 /* this causes startup screen to be restored and messes with the mouse */
11361 reset_sys_modes (tty
);
11364 tty
->meta_key
= new_meta
;
11367 init_sys_modes (tty
);
11373 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11374 doc
: /* Specify character used for quitting.
11375 QUIT must be an ASCII character.
11377 This function only has an effect on the controlling tty of the Emacs
11380 See also `current-input-mode'. */)
11384 struct terminal
*t
= get_named_tty ("/dev/tty");
11385 struct tty_display_info
*tty
;
11386 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11388 tty
= t
->display_info
.tty
;
11390 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11391 error ("QUIT must be an ASCII character");
11394 /* this causes startup screen to be restored and messes with the mouse */
11395 reset_sys_modes (tty
);
11398 /* Don't let this value be out of range. */
11399 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11402 init_sys_modes (tty
);
11408 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11409 doc
: /* Set mode of reading keyboard input.
11410 First arg INTERRUPT non-nil means use input interrupts;
11411 nil means use CBREAK mode.
11412 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11413 (no effect except in CBREAK mode).
11414 Third arg META t means accept 8-bit input (for a Meta key).
11415 META nil means ignore the top bit, on the assumption it is parity.
11416 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11417 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11418 See also `current-input-mode'. */)
11419 (interrupt
, flow
, meta
, quit
)
11420 Lisp_Object interrupt
, flow
, meta
, quit
;
11422 Fset_input_interrupt_mode (interrupt
);
11423 Fset_output_flow_control (flow
, Qnil
);
11424 Fset_input_meta_mode (meta
, Qnil
);
11426 Fset_quit_char (quit
);
11430 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11431 doc
: /* Return information about the way Emacs currently reads keyboard input.
11432 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11433 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11434 nil, Emacs is using CBREAK mode.
11435 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11436 terminal; this does not apply if Emacs uses interrupt-driven input.
11437 META is t if accepting 8-bit input with 8th bit as Meta flag.
11438 META nil means ignoring the top bit, on the assumption it is parity.
11439 META is neither t nor nil if accepting 8-bit input and using
11440 all 8 bits as the character code.
11441 QUIT is the character Emacs currently uses to quit.
11442 The elements of this list correspond to the arguments of
11443 `set-input-mode'. */)
11446 Lisp_Object val
[4];
11447 struct frame
*sf
= XFRAME (selected_frame
);
11449 val
[0] = interrupt_input
? Qt
: Qnil
;
11450 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11452 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11453 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11455 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11462 XSETFASTINT (val
[3], quit_char
);
11464 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11467 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11468 doc
: /* Return position information for pixel coordinates X and Y.
11469 By default, X and Y are relative to text area of the selected window.
11470 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11471 If optional fourth arg WHOLE is non-nil, X is relative to the left
11472 edge of the window.
11474 The return value is similar to a mouse click position:
11475 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11476 IMAGE (DX . DY) (WIDTH . HEIGHT))
11477 The `posn-' functions access elements of such lists. */)
11478 (x
, y
, frame_or_window
, whole
)
11479 Lisp_Object x
, y
, frame_or_window
, whole
;
11484 if (NILP (frame_or_window
))
11485 frame_or_window
= selected_window
;
11487 if (WINDOWP (frame_or_window
))
11491 CHECK_LIVE_WINDOW (frame_or_window
);
11493 w
= XWINDOW (frame_or_window
);
11494 XSETINT (x
, (XINT (x
)
11495 + WINDOW_LEFT_EDGE_X (w
)
11497 ? window_box_left_offset (w
, TEXT_AREA
)
11499 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11500 frame_or_window
= w
->frame
;
11503 CHECK_LIVE_FRAME (frame_or_window
);
11505 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11508 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11509 doc
: /* Return position information for buffer POS in WINDOW.
11510 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11512 Return nil if position is not visible in window. Otherwise,
11513 the return value is similar to that returned by `event-start' for
11514 a mouse click at the upper left corner of the glyph corresponding
11515 to the given buffer position:
11516 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11517 IMAGE (DX . DY) (WIDTH . HEIGHT))
11518 The `posn-' functions access elements of such lists. */)
11520 Lisp_Object pos
, window
;
11525 window
= selected_window
;
11527 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11530 Lisp_Object x
= XCAR (tem
);
11531 Lisp_Object y
= XCAR (XCDR (tem
));
11533 /* Point invisible due to hscrolling? */
11536 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11544 * Set up a new kboard object with reasonable initial values.
11550 kb
->Voverriding_terminal_local_map
= Qnil
;
11551 kb
->Vlast_command
= Qnil
;
11552 kb
->Vreal_last_command
= Qnil
;
11553 kb
->Vkeyboard_translate_table
= Qnil
;
11554 kb
->Vlast_repeatable_command
= Qnil
;
11555 kb
->Vprefix_arg
= Qnil
;
11556 kb
->Vlast_prefix_arg
= Qnil
;
11557 kb
->kbd_queue
= Qnil
;
11558 kb
->kbd_queue_has_data
= 0;
11559 kb
->immediate_echo
= 0;
11560 kb
->echo_string
= Qnil
;
11561 kb
->echo_after_prompt
= -1;
11562 kb
->kbd_macro_buffer
= 0;
11563 kb
->kbd_macro_bufsize
= 0;
11564 kb
->defining_kbd_macro
= Qnil
;
11565 kb
->Vlast_kbd_macro
= Qnil
;
11566 kb
->reference_count
= 0;
11567 kb
->Vsystem_key_alist
= Qnil
;
11568 kb
->system_key_syms
= Qnil
;
11569 kb
->Vwindow_system
= Qt
; /* Unset. */
11570 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11571 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11572 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11573 kb
->Vdefault_minibuffer_frame
= Qnil
;
11577 * Destroy the contents of a kboard object, but not the object itself.
11578 * We use this just before deleting it, or if we're going to initialize
11579 * it a second time.
11585 xfree (kb
->kbd_macro_buffer
);
11588 /* Free KB and memory referenced from it. */
11596 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11599 *kbp
= kb
->next_kboard
;
11601 /* Prevent a dangling reference to KB. */
11602 if (kb
== current_kboard
11603 && FRAMEP (selected_frame
)
11604 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11606 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11608 if (current_kboard
== kb
)
11619 /* This is correct before outermost invocation of the editor loop */
11620 command_loop_level
= -1;
11621 immediate_quit
= 0;
11622 quit_char
= Ctl ('g');
11623 Vunread_command_events
= Qnil
;
11624 unread_command_char
= -1;
11625 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11627 recent_keys_index
= 0;
11628 kbd_fetch_ptr
= kbd_buffer
;
11629 kbd_store_ptr
= kbd_buffer
;
11630 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11631 do_mouse_tracking
= Qnil
;
11634 interrupt_input_blocked
= 0;
11635 interrupt_input_pending
= 0;
11637 pending_signals
= 0;
11640 /* This means that command_loop_1 won't try to select anything the first
11642 internal_last_event_frame
= Qnil
;
11643 Vlast_event_frame
= internal_last_event_frame
;
11645 current_kboard
= initial_kboard
;
11646 /* Re-initialize the keyboard again. */
11647 wipe_kboard (current_kboard
);
11648 init_kboard (current_kboard
);
11649 /* A value of nil for Vwindow_system normally means a tty, but we also use
11650 it for the initial terminal since there is no window system there. */
11651 current_kboard
->Vwindow_system
= Qnil
;
11653 if (!noninteractive
)
11655 /* Before multi-tty support, these handlers used to be installed
11656 only if the current session was a tty session. Now an Emacs
11657 session may have multiple display types, so we always handle
11658 SIGINT. There is special code in interrupt_signal to exit
11659 Emacs on SIGINT when there are no termcap frames on the
11660 controlling terminal. */
11661 signal (SIGINT
, interrupt_signal
);
11662 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11663 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11664 SIGQUIT and we can't tell which one it will give us. */
11665 signal (SIGQUIT
, interrupt_signal
);
11666 #endif /* HAVE_TERMIO */
11668 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11670 if (!noninteractive
)
11671 signal (SIGIO
, input_available_signal
);
11674 /* Use interrupt input by default, if it works and noninterrupt input
11675 has deficiencies. */
11677 #ifdef INTERRUPT_INPUT
11678 interrupt_input
= 1;
11680 interrupt_input
= 0;
11686 if (keyboard_init_hook
)
11687 (*keyboard_init_hook
) ();
11689 #ifdef POLL_FOR_INPUT
11691 poll_suppress_count
= 1;
11696 /* This type's only use is in syms_of_keyboard, to initialize the
11697 event header symbols and put properties on them. */
11698 struct event_head
{
11704 struct event_head head_table
[] = {
11705 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11706 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11707 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11708 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11709 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11710 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11711 /* `select-window' should be handled just like `switch-frame'
11712 in read_key_sequence. */
11713 {&Qselect_window
, "select-window", &Qswitch_frame
}
11717 syms_of_keyboard ()
11719 pending_funcalls
= Qnil
;
11720 staticpro (&pending_funcalls
);
11722 Vlispy_mouse_stem
= build_string ("mouse");
11723 staticpro (&Vlispy_mouse_stem
);
11726 QCimage
= intern (":image");
11727 staticpro (&QCimage
);
11729 staticpro (&Qhelp_echo
);
11730 Qhelp_echo
= intern ("help-echo");
11733 Qrtl
= intern (":rtl");
11735 staticpro (&item_properties
);
11736 item_properties
= Qnil
;
11738 staticpro (&tool_bar_item_properties
);
11739 tool_bar_item_properties
= Qnil
;
11740 staticpro (&tool_bar_items_vector
);
11741 tool_bar_items_vector
= Qnil
;
11743 staticpro (&real_this_command
);
11744 real_this_command
= Qnil
;
11746 Qtimer_event_handler
= intern ("timer-event-handler");
11747 staticpro (&Qtimer_event_handler
);
11749 Qdisabled_command_function
= intern ("disabled-command-function");
11750 staticpro (&Qdisabled_command_function
);
11752 Qself_insert_command
= intern ("self-insert-command");
11753 staticpro (&Qself_insert_command
);
11755 Qforward_char
= intern ("forward-char");
11756 staticpro (&Qforward_char
);
11758 Qbackward_char
= intern ("backward-char");
11759 staticpro (&Qbackward_char
);
11761 Qdisabled
= intern ("disabled");
11762 staticpro (&Qdisabled
);
11764 Qundefined
= intern ("undefined");
11765 staticpro (&Qundefined
);
11767 Qpre_command_hook
= intern ("pre-command-hook");
11768 staticpro (&Qpre_command_hook
);
11770 Qpost_command_hook
= intern ("post-command-hook");
11771 staticpro (&Qpost_command_hook
);
11773 Qdeferred_action_function
= intern ("deferred-action-function");
11774 staticpro (&Qdeferred_action_function
);
11776 Qcommand_hook_internal
= intern ("command-hook-internal");
11777 staticpro (&Qcommand_hook_internal
);
11779 Qfunction_key
= intern ("function-key");
11780 staticpro (&Qfunction_key
);
11781 Qmouse_click
= intern ("mouse-click");
11782 staticpro (&Qmouse_click
);
11783 #if defined (WINDOWSNT)
11784 Qlanguage_change
= intern ("language-change");
11785 staticpro (&Qlanguage_change
);
11787 Qdrag_n_drop
= intern ("drag-n-drop");
11788 staticpro (&Qdrag_n_drop
);
11790 Qsave_session
= intern ("save-session");
11791 staticpro (&Qsave_session
);
11794 Qdbus_event
= intern ("dbus-event");
11795 staticpro (&Qdbus_event
);
11798 Qmenu_enable
= intern ("menu-enable");
11799 staticpro (&Qmenu_enable
);
11800 QCenable
= intern (":enable");
11801 staticpro (&QCenable
);
11802 QCvisible
= intern (":visible");
11803 staticpro (&QCvisible
);
11804 QChelp
= intern (":help");
11805 staticpro (&QChelp
);
11806 QCfilter
= intern (":filter");
11807 staticpro (&QCfilter
);
11808 QCbutton
= intern (":button");
11809 staticpro (&QCbutton
);
11810 QCkeys
= intern (":keys");
11811 staticpro (&QCkeys
);
11812 QCkey_sequence
= intern (":key-sequence");
11813 staticpro (&QCkey_sequence
);
11814 QCtoggle
= intern (":toggle");
11815 staticpro (&QCtoggle
);
11816 QCradio
= intern (":radio");
11817 staticpro (&QCradio
);
11819 Qmode_line
= intern ("mode-line");
11820 staticpro (&Qmode_line
);
11821 Qvertical_line
= intern ("vertical-line");
11822 staticpro (&Qvertical_line
);
11823 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11824 staticpro (&Qvertical_scroll_bar
);
11825 Qmenu_bar
= intern ("menu-bar");
11826 staticpro (&Qmenu_bar
);
11828 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11829 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11830 staticpro (&Qmouse_fixup_help_message
);
11833 Qabove_handle
= intern ("above-handle");
11834 staticpro (&Qabove_handle
);
11835 Qhandle
= intern ("handle");
11836 staticpro (&Qhandle
);
11837 Qbelow_handle
= intern ("below-handle");
11838 staticpro (&Qbelow_handle
);
11839 Qup
= intern ("up");
11841 Qdown
= intern ("down");
11842 staticpro (&Qdown
);
11843 Qtop
= intern ("top");
11845 Qbottom
= intern ("bottom");
11846 staticpro (&Qbottom
);
11847 Qend_scroll
= intern ("end-scroll");
11848 staticpro (&Qend_scroll
);
11849 Qratio
= intern ("ratio");
11850 staticpro (&Qratio
);
11852 Qevent_kind
= intern ("event-kind");
11853 staticpro (&Qevent_kind
);
11854 Qevent_symbol_elements
= intern ("event-symbol-elements");
11855 staticpro (&Qevent_symbol_elements
);
11856 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11857 staticpro (&Qevent_symbol_element_mask
);
11858 Qmodifier_cache
= intern ("modifier-cache");
11859 staticpro (&Qmodifier_cache
);
11861 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11862 staticpro (&Qrecompute_lucid_menubar
);
11863 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11864 staticpro (&Qactivate_menubar_hook
);
11866 Qpolling_period
= intern ("polling-period");
11867 staticpro (&Qpolling_period
);
11869 Qinput_method_function
= intern ("input-method-function");
11870 staticpro (&Qinput_method_function
);
11872 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11873 staticpro (&Qinput_method_exit_on_first_char
);
11874 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11875 staticpro (&Qinput_method_use_echo_area
);
11877 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11878 Fset (Qinput_method_use_echo_area
, Qnil
);
11880 last_point_position_buffer
= Qnil
;
11881 last_point_position_window
= Qnil
;
11884 struct event_head
*p
;
11886 for (p
= head_table
;
11887 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11890 *p
->var
= intern (p
->name
);
11891 staticpro (p
->var
);
11892 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11893 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11897 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11898 staticpro (&button_down_location
);
11899 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11900 staticpro (&mouse_syms
);
11901 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11902 staticpro (&wheel_syms
);
11906 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11908 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11909 for (i
= 0; i
< len
; i
++)
11910 if (modifier_names
[i
])
11911 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11912 staticpro (&modifier_symbols
);
11915 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11916 staticpro (&recent_keys
);
11918 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11919 staticpro (&this_command_keys
);
11921 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11922 staticpro (&raw_keybuf
);
11924 Qextended_command_history
= intern ("extended-command-history");
11925 Fset (Qextended_command_history
, Qnil
);
11926 staticpro (&Qextended_command_history
);
11928 accent_key_syms
= Qnil
;
11929 staticpro (&accent_key_syms
);
11931 func_key_syms
= Qnil
;
11932 staticpro (&func_key_syms
);
11934 drag_n_drop_syms
= Qnil
;
11935 staticpro (&drag_n_drop_syms
);
11937 unread_switch_frame
= Qnil
;
11938 staticpro (&unread_switch_frame
);
11940 internal_last_event_frame
= Qnil
;
11941 staticpro (&internal_last_event_frame
);
11943 read_key_sequence_cmd
= Qnil
;
11944 staticpro (&read_key_sequence_cmd
);
11946 menu_bar_one_keymap_changed_items
= Qnil
;
11947 staticpro (&menu_bar_one_keymap_changed_items
);
11949 menu_bar_items_vector
= Qnil
;
11950 staticpro (&menu_bar_items_vector
);
11952 help_form_saved_window_configs
= Qnil
;
11953 staticpro (&help_form_saved_window_configs
);
11955 defsubr (&Scurrent_idle_time
);
11956 defsubr (&Sevent_symbol_parse_modifiers
);
11957 defsubr (&Sevent_convert_list
);
11958 defsubr (&Sread_key_sequence
);
11959 defsubr (&Sread_key_sequence_vector
);
11960 defsubr (&Srecursive_edit
);
11961 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11962 defsubr (&Strack_mouse
);
11964 defsubr (&Sinput_pending_p
);
11965 defsubr (&Scommand_execute
);
11966 defsubr (&Srecent_keys
);
11967 defsubr (&Sthis_command_keys
);
11968 defsubr (&Sthis_command_keys_vector
);
11969 defsubr (&Sthis_single_command_keys
);
11970 defsubr (&Sthis_single_command_raw_keys
);
11971 defsubr (&Sreset_this_command_lengths
);
11972 defsubr (&Sclear_this_command_keys
);
11973 defsubr (&Ssuspend_emacs
);
11974 defsubr (&Sabort_recursive_edit
);
11975 defsubr (&Sexit_recursive_edit
);
11976 defsubr (&Srecursion_depth
);
11977 defsubr (&Stop_level
);
11978 defsubr (&Sdiscard_input
);
11979 defsubr (&Sopen_dribble_file
);
11980 defsubr (&Sset_input_interrupt_mode
);
11981 defsubr (&Sset_output_flow_control
);
11982 defsubr (&Sset_input_meta_mode
);
11983 defsubr (&Sset_quit_char
);
11984 defsubr (&Sset_input_mode
);
11985 defsubr (&Scurrent_input_mode
);
11986 defsubr (&Sexecute_extended_command
);
11987 defsubr (&Sposn_at_point
);
11988 defsubr (&Sposn_at_x_y
);
11990 DEFVAR_LISP ("last-command-event", &last_command_event
,
11991 doc
: /* Last input event that was part of a command. */);
11993 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11994 doc
: /* Last input event in a command, except for mouse menu events.
11995 Mouse menus give back keys that don't look like mouse events;
11996 this variable holds the actual mouse event that led to the menu,
11997 so that you can determine whether the command was run by mouse or not. */);
11999 DEFVAR_LISP ("last-input-event", &last_input_event
,
12000 doc
: /* Last input event. */);
12002 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
12003 doc
: /* List of events to be read as the command input.
12004 These events are processed first, before actual keyboard input.
12005 Events read from this list are not normally added to `this-command-keys',
12006 as they will already have been added once as they were read for the first time.
12007 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12008 Vunread_command_events
= Qnil
;
12010 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12011 doc
: /* If not -1, an object to be read as next command input event. */);
12013 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12014 doc
: /* List of events to be processed as input by input methods.
12015 These events are processed before `unread-command-events'
12016 and actual keyboard input, but are not given to `input-method-function'. */);
12017 Vunread_post_input_method_events
= Qnil
;
12019 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12020 doc
: /* List of events to be processed as input by input methods.
12021 These events are processed after `unread-command-events', but
12022 before actual keyboard input.
12023 If there's an active input method, the events are given to
12024 `input-method-function'. */);
12025 Vunread_input_method_events
= Qnil
;
12027 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12028 doc
: /* Meta-prefix character code.
12029 Meta-foo as command input turns into this character followed by foo. */);
12030 XSETINT (meta_prefix_char
, 033);
12032 DEFVAR_KBOARD ("last-command", Vlast_command
,
12033 doc
: /* The last command executed.
12034 Normally a symbol with a function definition, but can be whatever was found
12035 in the keymap, or whatever the variable `this-command' was set to by that
12038 The value `mode-exit' is special; it means that the previous command
12039 read an event that told it to exit, and it did so and unread that event.
12040 In other words, the present command is the event that made the previous
12043 The value `kill-region' is special; it means that the previous command
12044 was a kill command.
12046 `last-command' has a separate binding for each terminal device.
12047 See Info node `(elisp)Multiple displays'. */);
12049 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12050 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12052 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12053 doc
: /* Last command that may be repeated.
12054 The last command executed that was not bound to an input event.
12055 This is the command `repeat' will try to repeat. */);
12057 DEFVAR_LISP ("this-command", &Vthis_command
,
12058 doc
: /* The command now being executed.
12059 The command can set this variable; whatever is put here
12060 will be in `last-command' during the following command. */);
12061 Vthis_command
= Qnil
;
12063 DEFVAR_LISP ("this-command-keys-shift-translated",
12064 &Vthis_command_keys_shift_translated
,
12065 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12066 Shift-translation occurs when there is no binding for the key sequence
12067 as entered, but a binding was found by changing an upper-case letter
12068 to lower-case, or a shifted function key to an unshifted one. */);
12069 Vthis_command_keys_shift_translated
= Qnil
;
12071 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12072 doc
: /* The command bound to the current key sequence before remapping.
12073 It equals `this-command' if the original command was not remapped through
12074 any of the active keymaps. Otherwise, the value of `this-command' is the
12075 result of looking up the original command in the active keymaps. */);
12076 Vthis_original_command
= Qnil
;
12078 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12079 doc
: /* *Number of input events between auto-saves.
12080 Zero means disable autosaving due to number of characters typed. */);
12081 auto_save_interval
= 300;
12083 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12084 doc
: /* *Number of seconds idle time before auto-save.
12085 Zero or nil means disable auto-saving due to idleness.
12086 After auto-saving due to this many seconds of idle time,
12087 Emacs also does a garbage collection if that seems to be warranted. */);
12088 XSETFASTINT (Vauto_save_timeout
, 30);
12090 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12091 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12092 The value may be integer or floating point. */);
12093 Vecho_keystrokes
= make_number (1);
12095 DEFVAR_INT ("polling-period", &polling_period
,
12096 doc
: /* *Interval between polling for input during Lisp execution.
12097 The reason for polling is to make C-g work to stop a running program.
12098 Polling is needed only when using X windows and SIGIO does not work.
12099 Polling is automatically disabled in all other cases. */);
12100 polling_period
= 2;
12102 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12103 doc
: /* *Maximum time between mouse clicks to make a double-click.
12104 Measured in milliseconds. The value nil means disable double-click
12105 recognition; t means double-clicks have no time limit and are detected
12106 by position only. */);
12107 Vdouble_click_time
= make_number (500);
12109 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12110 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12111 On window-system frames, value is the number of pixels the mouse may have
12112 moved horizontally or vertically between two clicks to make a double-click.
12113 On non window-system frames, value is interpreted in units of 1/8 characters
12116 This variable is also the threshold for motion of the mouse
12117 to count as a drag. */);
12118 double_click_fuzz
= 3;
12120 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12121 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12122 inhibit_local_menu_bar_menus
= 0;
12124 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12125 doc
: /* Number of complete key sequences read as input so far.
12126 This includes key sequences read from keyboard macros.
12127 The number is effectively the number of interactive command invocations. */);
12128 num_input_keys
= 0;
12130 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12131 doc
: /* Number of input events read from the keyboard so far.
12132 This does not include events generated by keyboard macros. */);
12133 num_nonmacro_input_events
= 0;
12135 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12136 doc
: /* The frame in which the most recently read event occurred.
12137 If the last event came from a keyboard macro, this is set to `macro'. */);
12138 Vlast_event_frame
= Qnil
;
12140 /* This variable is set up in sysdep.c. */
12141 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12142 doc
: /* The ERASE character as set by the user with stty. */);
12144 DEFVAR_LISP ("help-char", &Vhelp_char
,
12145 doc
: /* Character to recognize as meaning Help.
12146 When it is read, do `(eval help-form)', and display result if it's a string.
12147 If the value of `help-form' is nil, this char can be read normally. */);
12148 XSETINT (Vhelp_char
, Ctl ('H'));
12150 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12151 doc
: /* List of input events to recognize as meaning Help.
12152 These work just like the value of `help-char' (see that). */);
12153 Vhelp_event_list
= Qnil
;
12155 DEFVAR_LISP ("help-form", &Vhelp_form
,
12156 doc
: /* Form to execute when character `help-char' is read.
12157 If the form returns a string, that string is displayed.
12158 If `help-form' is nil, the help char is not recognized. */);
12161 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12162 doc
: /* Command to run when `help-char' character follows a prefix key.
12163 This command is used only when there is no actual binding
12164 for that character after that prefix key. */);
12165 Vprefix_help_command
= Qnil
;
12167 DEFVAR_LISP ("top-level", &Vtop_level
,
12168 doc
: /* Form to evaluate when Emacs starts up.
12169 Useful to set before you dump a modified Emacs. */);
12172 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12173 doc
: /* Translate table for local keyboard input, or nil.
12174 If non-nil, the value should be a char-table. Each character read
12175 from the keyboard is looked up in this char-table. If the value found
12176 there is non-nil, then it is used instead of the actual input character.
12178 The value can also be a string or vector, but this is considered obsolete.
12179 If it is a string or vector of length N, character codes N and up are left
12180 untranslated. In a vector, an element which is nil means "no translation".
12182 This is applied to the characters supplied to input methods, not their
12183 output. See also `translation-table-for-input'.
12185 This variable has a separate binding for each terminal. See Info node
12186 `(elisp)Multiple displays'. */);
12188 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12189 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12190 \(Even if the operating system has support for stopping a process.\) */);
12191 cannot_suspend
= 0;
12193 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12194 doc
: /* Non-nil means prompt with menus when appropriate.
12195 This is done when reading from a keymap that has a prompt string,
12196 for elements that have prompt strings.
12197 The menu is displayed on the screen
12198 if X menus were enabled at configuration
12199 time and the previous event was a mouse click prefix key.
12200 Otherwise, menu prompting uses the echo area. */);
12201 menu_prompting
= 1;
12203 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12204 doc
: /* Character to see next line of menu prompt.
12205 Type this character while in a menu prompt to rotate around the lines of it. */);
12206 XSETINT (menu_prompt_more_char
, ' ');
12208 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12209 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12210 Emacs applies the modifiers of the character stored here to each keyboard
12211 character it reads. For example, after evaluating the expression
12212 (setq extra-keyboard-modifiers ?\\C-x)
12213 all input characters will have the control modifier applied to them.
12215 Note that the character ?\\C-@, equivalent to the integer zero, does
12216 not count as a control character; rather, it counts as a character
12217 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12218 cancels any modification. */);
12219 extra_keyboard_modifiers
= 0;
12221 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12222 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12223 The command loop sets this to nil before each command,
12224 and tests the value when the command returns.
12225 Buffer modification stores t in this variable. */);
12226 Vdeactivate_mark
= Qnil
;
12227 Qdeactivate_mark
= intern ("deactivate-mark");
12228 staticpro (&Qdeactivate_mark
);
12230 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12231 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12232 Vcommand_hook_internal
= Qnil
;
12234 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12235 doc
: /* Normal hook run before each command is executed.
12236 If an unhandled error happens in running this hook,
12237 the hook value is set to nil, since otherwise the error
12238 might happen repeatedly and make Emacs nonfunctional. */);
12239 Vpre_command_hook
= Qnil
;
12241 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12242 doc
: /* Normal hook run after each command is executed.
12243 If an unhandled error happens in running this hook,
12244 the hook value is set to nil, since otherwise the error
12245 might happen repeatedly and make Emacs nonfunctional. */);
12246 Vpost_command_hook
= Qnil
;
12249 DEFVAR_LISP ("echo-area-clear-hook", ...,
12250 doc
: /* Normal hook run when clearing the echo area. */);
12252 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12253 staticpro (&Qecho_area_clear_hook
);
12254 Fset (Qecho_area_clear_hook
, Qnil
);
12256 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12257 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12258 Vlucid_menu_bar_dirty_flag
= Qnil
;
12260 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12261 doc
: /* List of menu bar items to move to the end of the menu bar.
12262 The elements of the list are event types that may have menu bar bindings. */);
12263 Vmenu_bar_final_items
= Qnil
;
12265 DEFVAR_KBOARD ("overriding-terminal-local-map",
12266 Voverriding_terminal_local_map
,
12267 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12268 If this variable is non-nil, it is used as a keymap instead of the
12269 buffer's local map, and the minor mode keymaps and text property keymaps.
12270 It also replaces `overriding-local-map'.
12272 This variable is intended to let commands such as `universal-argument'
12273 set up a different keymap for reading the next command.
12275 `overriding-terminal-local-map' has a separate binding for each
12277 See Info node `(elisp)Multiple displays'. */);
12279 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12280 doc
: /* Keymap that overrides all other local keymaps.
12281 If this variable is non-nil, it is used as a keymap--replacing the
12282 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12283 Voverriding_local_map
= Qnil
;
12285 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12286 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12287 Otherwise, the menu bar continues to reflect the buffer's local map
12288 and the minor mode maps regardless of `overriding-local-map'. */);
12289 Voverriding_local_map_menu_flag
= Qnil
;
12291 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12292 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12293 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12295 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12296 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12298 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12299 doc
: /* Alist of system-specific X windows key symbols.
12300 Each element should have the form (N . SYMBOL) where N is the
12301 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12302 and SYMBOL is its name.
12304 `system-key-alist' has a separate binding for each terminal device.
12305 See Info node `(elisp)Multiple displays'. */);
12307 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12308 doc
: /* Keymap that translates key sequences to key sequences during input.
12309 This is used mainly for mapping key sequences into some preferred
12310 key events (symbols).
12312 The `read-key-sequence' function replaces any subsequence bound by
12313 `local-function-key-map' with its binding. More precisely, when the
12314 active keymaps have no binding for the current key sequence but
12315 `local-function-key-map' binds a suffix of the sequence to a vector or
12316 string, `read-key-sequence' replaces the matching suffix with its
12317 binding, and continues with the new sequence.
12319 If the binding is a function, it is called with one argument (the prompt)
12320 and its return value (a key sequence) is used.
12322 The events that come from bindings in `local-function-key-map' are not
12323 themselves looked up in `local-function-key-map'.
12325 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12326 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12327 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12328 typing `ESC O P x' would return [f1 x].
12330 `local-function-key-map' has a separate binding for each terminal
12331 device. See Info node `(elisp)Multiple displays'. If you need to
12332 define a binding on all terminals, change `function-key-map'
12333 instead. Initially, `local-function-key-map' is an empty keymap that
12334 has `function-key-map' as its parent on all terminal devices. */);
12336 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12337 doc
: /* Keymap that decodes input escape sequences.
12338 This is used mainly for mapping ASCII function key sequences into
12339 real Emacs function key events (symbols).
12341 The `read-key-sequence' function replaces any subsequence bound by
12342 `input-decode-map' with its binding. Contrary to `function-key-map',
12343 this map applies its rebinding regardless of the presence of an ordinary
12344 binding. So it is more like `key-translation-map' except that it applies
12345 before `function-key-map' rather than after.
12347 If the binding is a function, it is called with one argument (the prompt)
12348 and its return value (a key sequence) is used.
12350 The events that come from bindings in `input-decode-map' are not
12351 themselves looked up in `input-decode-map'.
12353 This variable is keyboard-local. */);
12355 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12356 doc
: /* The parent keymap of all `local-function-key-map' instances.
12357 Function key definitions that apply to all terminal devices should go
12358 here. If a mapping is defined in both the current
12359 `local-function-key-map' binding and this variable, then the local
12360 definition will take precendence. */);
12361 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12363 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12364 doc
: /* Keymap of key translations that can override keymaps.
12365 This keymap works like `function-key-map', but comes after that,
12366 and its non-prefix bindings override ordinary bindings.
12367 Another difference is that it is global rather than keyboard-local. */);
12368 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12370 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12371 doc
: /* List of deferred actions to be performed at a later time.
12372 The precise format isn't relevant here; we just check whether it is nil. */);
12373 Vdeferred_action_list
= Qnil
;
12375 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12376 doc
: /* Function to call to handle deferred actions, after each command.
12377 This function is called with no arguments after each command
12378 whenever `deferred-action-list' is non-nil. */);
12379 Vdeferred_action_function
= Qnil
;
12381 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12382 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12383 The value can be a length of time to show the message for.
12384 If the value is non-nil and not a number, we wait 2 seconds. */);
12385 Vsuggest_key_bindings
= Qt
;
12387 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12388 doc
: /* List of active absolute time timers in order of increasing time. */);
12389 Vtimer_list
= Qnil
;
12391 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12392 doc
: /* List of active idle-time timers in order of increasing time. */);
12393 Vtimer_idle_list
= Qnil
;
12395 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12396 doc
: /* If non-nil, the function that implements the current input method.
12397 It's called with one argument, a printing character that was just read.
12398 \(That means a character with code 040...0176.)
12399 Typically this function uses `read-event' to read additional events.
12400 When it does so, it should first bind `input-method-function' to nil
12401 so it will not be called recursively.
12403 The function should return a list of zero or more events
12404 to be used as input. If it wants to put back some events
12405 to be reconsidered, separately, by the input method,
12406 it can add them to the beginning of `unread-command-events'.
12408 The input method function can find in `input-method-previous-message'
12409 the previous echo area message.
12411 The input method function should refer to the variables
12412 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12413 for guidance on what to do. */);
12414 Vinput_method_function
= Qnil
;
12416 DEFVAR_LISP ("input-method-previous-message",
12417 &Vinput_method_previous_message
,
12418 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12419 This variable exists because `read-event' clears the echo area
12420 before running the input method. It is nil if there was no message. */);
12421 Vinput_method_previous_message
= Qnil
;
12423 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12424 doc
: /* If non-nil, the function that implements the display of help.
12425 It's called with one argument, the help string to display. */);
12426 Vshow_help_function
= Qnil
;
12428 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12429 doc
: /* If non-nil, suppress point adjustment after executing a command.
12431 After a command is executed, if point is moved into a region that has
12432 special properties (e.g. composition, display), we adjust point to
12433 the boundary of the region. But, when a command sets this variable to
12434 non-nil, we suppress the point adjustment.
12436 This variable is set to nil before reading a command, and is checked
12437 just after executing the command. */);
12438 Vdisable_point_adjustment
= Qnil
;
12440 DEFVAR_LISP ("global-disable-point-adjustment",
12441 &Vglobal_disable_point_adjustment
,
12442 doc
: /* *If non-nil, always suppress point adjustment.
12444 The default value is nil, in which case, point adjustment are
12445 suppressed only after special commands that set
12446 `disable-point-adjustment' (which see) to non-nil. */);
12447 Vglobal_disable_point_adjustment
= Qnil
;
12449 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12450 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12451 If the value is not a number, such messages don't time out. */);
12452 Vminibuffer_message_timeout
= make_number (2);
12454 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12455 doc
: /* If non-nil, any keyboard input throws to this symbol.
12456 The value of that variable is passed to `quit-flag' and later causes a
12457 peculiar kind of quitting. */);
12458 Vthrow_on_input
= Qnil
;
12460 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12461 doc
: /* If non-nil, function to output error messages.
12462 The arguments are the error data, a list of the form
12463 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12464 such as just as `condition-case' would bind its variable to,
12465 the context (a string which normally goes at the start of the message),
12466 and the Lisp function within which the error was signaled. */);
12467 Vcommand_error_function
= Qnil
;
12469 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12470 &Venable_disabled_menus_and_buttons
,
12471 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12473 Help functions bind this to allow help on disabled menu items
12474 and tool-bar buttons. */);
12475 Venable_disabled_menus_and_buttons
= Qnil
;
12477 /* Create the initial keyboard. */
12478 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12479 init_kboard (initial_kboard
);
12480 /* Vwindow_system is left at t for now. */
12481 initial_kboard
->next_kboard
= all_kboards
;
12482 all_kboards
= initial_kboard
;
12486 keys_of_keyboard ()
12488 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12489 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12490 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12491 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12492 initial_define_key (meta_map
, 'x', "execute-extended-command");
12494 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12495 "handle-delete-frame");
12496 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12497 "ns-put-working-text");
12498 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12499 "ns-unput-working-text");
12500 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12501 current-prefix-arg, as is done in `handle-switch-frame'.
12502 But `handle-switch-frame is not run from the special-map.
12503 Commands from that map are run in a special way that automatically
12504 preserves the prefix-arg. Restoring the prefix arg here is not just
12505 redundant but harmful:
12507 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12508 - after the first prompt, the exit-minibuffer-hook is run which may
12509 iconify a frame and thus push a `iconify-frame' event.
12510 - after running exit-minibuffer-hook, current-prefix-arg is
12511 restored to the non-nil value it had before the prompt.
12512 - we enter the second prompt.
12513 current-prefix-arg is non-nil, prefix-arg is nil.
12514 - before running the first real event, we run the special iconify-frame
12515 event, but we pass the `special' arg to execute-command so
12516 current-prefix-arg and prefix-arg are left untouched.
12517 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12518 - the next key event will have a spuriously non-nil current-prefix-arg. */
12519 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12521 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12523 /* Handling it at such a low-level causes read_key_sequence to get
12524 * confused because it doesn't realize that the current_buffer was
12525 * changed by read_char.
12527 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12528 * "handle-select-window"); */
12529 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12530 "handle-save-session");
12533 /* Define a special event which is raised for dbus callback
12535 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12536 "dbus-handle-event");
12540 /* Mark the pointers in the kboard objects.
12541 Called by the Fgarbage_collector. */
12547 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12549 if (kb
->kbd_macro_buffer
)
12550 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12552 mark_object (kb
->Voverriding_terminal_local_map
);
12553 mark_object (kb
->Vlast_command
);
12554 mark_object (kb
->Vreal_last_command
);
12555 mark_object (kb
->Vkeyboard_translate_table
);
12556 mark_object (kb
->Vlast_repeatable_command
);
12557 mark_object (kb
->Vprefix_arg
);
12558 mark_object (kb
->Vlast_prefix_arg
);
12559 mark_object (kb
->kbd_queue
);
12560 mark_object (kb
->defining_kbd_macro
);
12561 mark_object (kb
->Vlast_kbd_macro
);
12562 mark_object (kb
->Vsystem_key_alist
);
12563 mark_object (kb
->system_key_syms
);
12564 mark_object (kb
->Vwindow_system
);
12565 mark_object (kb
->Vinput_decode_map
);
12566 mark_object (kb
->Vlocal_function_key_map
);
12567 mark_object (kb
->Vdefault_minibuffer_frame
);
12568 mark_object (kb
->echo_string
);
12571 struct input_event
*event
;
12572 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12574 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12575 event
= kbd_buffer
;
12576 if (event
->kind
!= SELECTION_REQUEST_EVENT
12577 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12579 mark_object (event
->x
);
12580 mark_object (event
->y
);
12582 mark_object (event
->frame_or_window
);
12583 mark_object (event
->arg
);
12588 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12589 (do not change this comment) */