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 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
30 #include "termhooks.h"
36 #include "character.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
63 #include <sys/types.h>
72 /* This is to get the definitions of the XK_ symbols. */
79 #endif /* HAVE_NTGUI */
89 /* Variables for blockinput.h: */
91 /* Non-zero if interrupt input is blocked right now. */
92 volatile int interrupt_input_blocked
;
94 /* Nonzero means an input interrupt has arrived
95 during the current critical section. */
96 int interrupt_input_pending
;
98 #define KBD_BUFFER_SIZE 4096
101 KBOARD
*initial_kboard
;
102 KBOARD
*current_kboard
;
106 KBOARD the_only_kboard
;
109 /* Non-nil disable property on a command means
110 do not execute it; call disabled-command-function's value instead. */
111 Lisp_Object Qdisabled
, Qdisabled_command_function
;
113 #define NUM_RECENT_KEYS (300)
114 int recent_keys_index
; /* Index for storing next element into recent_keys */
115 int total_keys
; /* Total number of elements stored into recent_keys */
116 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
118 /* Vector holding the key sequence that invoked the current command.
119 It is reused for each command, and it may be longer than the current
120 sequence; this_command_key_count indicates how many elements
121 actually mean something.
122 It's easier to staticpro a single Lisp_Object than an array. */
123 Lisp_Object this_command_keys
;
124 int this_command_key_count
;
126 /* 1 after calling Freset_this_command_lengths.
128 int this_command_key_count_reset
;
130 /* This vector is used as a buffer to record the events that were actually read
131 by read_key_sequence. */
132 Lisp_Object raw_keybuf
;
133 int raw_keybuf_count
;
135 #define GROW_RAW_KEYBUF \
136 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
137 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
139 /* Number of elements of this_command_keys
140 that precede this key sequence. */
141 int this_single_command_key_start
;
143 /* Record values of this_command_key_count and echo_length ()
144 before this command was read. */
145 static int before_command_key_count
;
146 static int before_command_echo_length
;
148 extern int minbuf_level
;
150 extern int message_enable_multibyte
;
152 /* If non-nil, the function that implements the display of help.
153 It's called with one argument, the help string to display. */
155 Lisp_Object Vshow_help_function
;
157 /* If a string, the message displayed before displaying a help-echo
160 Lisp_Object Vpre_help_message
;
162 /* Nonzero means do menu prompting. */
164 static int menu_prompting
;
166 /* Character to see next line of menu prompt. */
168 static Lisp_Object menu_prompt_more_char
;
170 /* For longjmp to where kbd input is being done. */
172 static jmp_buf getcjmp
;
174 /* True while doing kbd input. */
175 int waiting_for_input
;
177 /* True while displaying for echoing. Delays C-g throwing. */
181 /* Non-null means we can start echoing at the next input pause even
182 though there is something in the echo area. */
184 static struct kboard
*ok_to_echo_at_next_pause
;
186 /* The kboard last echoing, or null for none. Reset to 0 in
187 cancel_echoing. If non-null, and a current echo area message
188 exists, and echo_message_buffer is eq to the current message
189 buffer, we know that the message comes from echo_kboard. */
191 struct kboard
*echo_kboard
;
193 /* The buffer used for echoing. Set in echo_now, reset in
196 Lisp_Object echo_message_buffer
;
198 /* Nonzero means disregard local maps for the menu bar. */
199 static int inhibit_local_menu_bar_menus
;
201 /* Nonzero means C-g should cause immediate error-signal. */
204 /* The user's hook function for outputting an error message. */
205 Lisp_Object Vcommand_error_function
;
207 /* The user's ERASE setting. */
208 Lisp_Object Vtty_erase_char
;
210 /* Character to recognize as the help char. */
211 Lisp_Object Vhelp_char
;
213 /* List of other event types to recognize as meaning "help". */
214 Lisp_Object Vhelp_event_list
;
216 /* Form to execute when help char is typed. */
217 Lisp_Object Vhelp_form
;
219 /* Command to run when the help character follows a prefix key. */
220 Lisp_Object Vprefix_help_command
;
222 /* List of items that should move to the end of the menu bar. */
223 Lisp_Object Vmenu_bar_final_items
;
225 /* Non-nil means show the equivalent key-binding for
226 any M-x command that has one.
227 The value can be a length of time to show the message for.
228 If the value is non-nil and not a number, we wait 2 seconds. */
229 Lisp_Object Vsuggest_key_bindings
;
231 /* How long to display an echo-area message when the minibuffer is active.
232 If the value is not a number, such messages don't time out. */
233 Lisp_Object Vminibuffer_message_timeout
;
235 /* Character that causes a quit. Normally C-g.
237 If we are running on an ordinary terminal, this must be an ordinary
238 ASCII char, since we want to make it our interrupt character.
240 If we are not running on an ordinary terminal, it still needs to be
241 an ordinary ASCII char. This character needs to be recognized in
242 the input interrupt handler. At this point, the keystroke is
243 represented as a struct input_event, while the desired quit
244 character is specified as a lispy event. The mapping from struct
245 input_events to lispy events cannot run in an interrupt handler,
246 and the reverse mapping is difficult for anything but ASCII
249 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
253 extern Lisp_Object current_global_map
;
254 extern int minibuf_level
;
256 /* If non-nil, this is a map that overrides all other local maps. */
257 Lisp_Object Voverriding_local_map
;
259 /* If non-nil, Voverriding_local_map applies to the menu bar. */
260 Lisp_Object Voverriding_local_map_menu_flag
;
262 /* Keymap that defines special misc events that should
263 be processed immediately at a low level. */
264 Lisp_Object Vspecial_event_map
;
266 /* Current depth in recursive edits. */
267 int command_loop_level
;
269 /* Total number of times command_loop has read a key sequence. */
270 EMACS_INT num_input_keys
;
272 /* Last input character read as a command. */
273 Lisp_Object last_command_char
;
275 /* Last input character read as a command, not counting menus
276 reached by the mouse. */
277 Lisp_Object last_nonmenu_event
;
279 /* Last input character read for any purpose. */
280 Lisp_Object last_input_char
;
282 /* If not Qnil, a list of objects to be read as subsequent command input. */
283 Lisp_Object Vunread_command_events
;
285 /* If not Qnil, a list of objects to be read as subsequent command input
286 including input method processing. */
287 Lisp_Object Vunread_input_method_events
;
289 /* If not Qnil, a list of objects to be read as subsequent command input
290 but NOT including input method processing. */
291 Lisp_Object Vunread_post_input_method_events
;
293 /* If not -1, an event to be read as subsequent command input. */
294 EMACS_INT unread_command_char
;
296 /* If not Qnil, this is a switch-frame event which we decided to put
297 off until the end of a key sequence. This should be read as the
298 next command input, after any unread_command_events.
300 read_key_sequence uses this to delay switch-frame events until the
301 end of the key sequence; Fread_char uses it to put off switch-frame
302 events until a non-ASCII event is acceptable as input. */
303 Lisp_Object unread_switch_frame
;
305 /* A mask of extra modifier bits to put into every keyboard char. */
306 EMACS_INT extra_keyboard_modifiers
;
308 /* Char to use as prefix when a meta character is typed in.
309 This is bound on entry to minibuffer in case ESC is changed there. */
311 Lisp_Object meta_prefix_char
;
313 /* Last size recorded for a current buffer which is not a minibuffer. */
314 static int last_non_minibuf_size
;
316 /* Number of idle seconds before an auto-save and garbage collection. */
317 static Lisp_Object Vauto_save_timeout
;
319 /* Total number of times read_char has returned. */
320 int num_input_events
;
322 /* Total number of times read_char has returned, outside of macros. */
323 EMACS_INT num_nonmacro_input_events
;
325 /* Auto-save automatically when this many characters have been typed
326 since the last time. */
328 static EMACS_INT auto_save_interval
;
330 /* Value of num_nonmacro_input_events as of last auto save. */
334 /* The command being executed by the command loop.
335 Commands may set this, and the value set will be copied into
336 current_kboard->Vlast_command instead of the actual command. */
337 Lisp_Object Vthis_command
;
339 /* This is like Vthis_command, except that commands never set it. */
340 Lisp_Object real_this_command
;
342 /* If the lookup of the command returns a binding, the original
343 command is stored in this-original-command. It is nil otherwise. */
344 Lisp_Object Vthis_original_command
;
346 /* The value of point when the last command was started. */
347 int last_point_position
;
349 /* The buffer that was current when the last command was started. */
350 Lisp_Object last_point_position_buffer
;
352 /* The window that was selected when the last command was started. */
353 Lisp_Object last_point_position_window
;
355 /* The frame in which the last input event occurred, or Qmacro if the
356 last event came from a macro. We use this to determine when to
357 generate switch-frame events. This may be cleared by functions
358 like Fselect_frame, to make sure that a switch-frame event is
359 generated by the next character. */
360 Lisp_Object internal_last_event_frame
;
362 /* A user-visible version of the above, intended to allow users to
363 figure out where the last event came from, if the event doesn't
364 carry that information itself (i.e. if it was a character). */
365 Lisp_Object Vlast_event_frame
;
367 /* The timestamp of the last input event we received from the X server.
368 X Windows wants this for selection ownership. */
369 unsigned long last_event_timestamp
;
371 Lisp_Object Qself_insert_command
;
372 Lisp_Object Qforward_char
;
373 Lisp_Object Qbackward_char
;
374 Lisp_Object Qundefined
;
375 Lisp_Object Qtimer_event_handler
;
377 /* read_key_sequence stores here the command definition of the
378 key sequence that it reads. */
379 Lisp_Object read_key_sequence_cmd
;
381 /* Echo unfinished commands after this many seconds of pause. */
382 Lisp_Object Vecho_keystrokes
;
384 /* Form to evaluate (if non-nil) when Emacs is started. */
385 Lisp_Object Vtop_level
;
387 /* If non-nil, this implements the current input method. */
388 Lisp_Object Vinput_method_function
;
389 Lisp_Object Qinput_method_function
;
391 /* When we call Vinput_method_function,
392 this holds the echo area message that was just erased. */
393 Lisp_Object Vinput_method_previous_message
;
395 /* Non-nil means deactivate the mark at end of this command. */
396 Lisp_Object Vdeactivate_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 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
475 Lisp_Object Qmouse_fixup_help_message
;
478 /* Symbols to denote kinds of events. */
479 Lisp_Object Qfunction_key
;
480 Lisp_Object Qmouse_click
;
481 #if defined (WINDOWSNT) || defined (MAC_OS)
482 Lisp_Object Qlanguage_change
;
484 Lisp_Object Qdrag_n_drop
;
485 Lisp_Object Qsave_session
;
487 Lisp_Object Qmac_apple_event
;
490 Lisp_Object Qdbus_event
;
492 /* Lisp_Object Qmouse_movement; - also an event header */
494 /* Properties of event headers. */
495 Lisp_Object Qevent_kind
;
496 Lisp_Object Qevent_symbol_elements
;
498 /* menu item parts */
499 Lisp_Object Qmenu_alias
;
500 Lisp_Object Qmenu_enable
;
501 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
502 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
503 extern Lisp_Object Vdefine_key_rebound_commands
;
504 extern Lisp_Object Qmenu_item
;
506 /* An event header symbol HEAD may have a property named
507 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
508 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
509 mask of modifiers applied to it. If present, this is used to help
510 speed up parse_modifiers. */
511 Lisp_Object Qevent_symbol_element_mask
;
513 /* An unmodified event header BASE may have a property named
514 Qmodifier_cache, which is an alist mapping modifier masks onto
515 modified versions of BASE. If present, this helps speed up
517 Lisp_Object Qmodifier_cache
;
519 /* Symbols to use for parts of windows. */
520 Lisp_Object Qmode_line
;
521 Lisp_Object Qvertical_line
;
522 Lisp_Object Qvertical_scroll_bar
;
523 Lisp_Object Qmenu_bar
;
524 extern Lisp_Object Qleft_margin
, Qright_margin
;
525 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
526 extern Lisp_Object QCmap
;
528 Lisp_Object
recursive_edit_unwind (), command_loop ();
529 Lisp_Object
Fthis_command_keys ();
530 Lisp_Object Qextended_command_history
;
531 EMACS_TIME
timer_check ();
533 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
535 extern char *x_get_keysym_name ();
537 static void record_menu_key ();
538 static int echo_length ();
540 Lisp_Object Qpolling_period
;
542 /* List of absolute timers. Appears in order of next scheduled event. */
543 Lisp_Object Vtimer_list
;
545 /* List of idle time timers. Appears in order of next scheduled event. */
546 Lisp_Object Vtimer_idle_list
;
548 /* Incremented whenever a timer is run. */
551 extern Lisp_Object Vprint_level
, Vprint_length
;
553 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
555 EMACS_TIME
*input_available_clear_time
;
557 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
558 Default is 1 if INTERRUPT_INPUT is defined. */
561 /* Nonzero while interrupts are temporarily deferred during redisplay. */
562 int interrupts_deferred
;
564 /* Allow m- file to inhibit use of FIONREAD. */
565 #ifdef BROKEN_FIONREAD
569 /* We are unable to use interrupts if FIONREAD is not available,
570 so flush SIGIO so we won't try. */
571 #if !defined (FIONREAD)
577 /* If we support a window system, turn on the code to poll periodically
578 to detect C-g. It isn't actually used when doing interrupt input. */
579 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
580 #define POLL_FOR_INPUT
583 /* After a command is executed, if point is moved into a region that
584 has specific properties (e.g. composition, display), we adjust
585 point to the boundary of the region. But, if a command sets this
586 variable to non-nil, we suppress this point adjustment. This
587 variable is set to nil before reading a command. */
589 Lisp_Object Vdisable_point_adjustment
;
591 /* If non-nil, always disable point adjustment. */
593 Lisp_Object Vglobal_disable_point_adjustment
;
595 /* The time when Emacs started being idle. */
597 static EMACS_TIME timer_idleness_start_time
;
599 /* After Emacs stops being idle, this saves the last value
600 of timer_idleness_start_time from when it was idle. */
602 static EMACS_TIME timer_last_idleness_start_time
;
604 /* If non-nil, events produced by disabled menu items and tool-bar
605 buttons are not ignored. Help functions bind this to allow help on
606 those items and buttons. */
607 Lisp_Object Venable_disabled_menus_and_buttons
;
610 /* Global variable declarations. */
612 /* Flags for readable_events. */
613 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
614 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
615 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
617 /* Function for init_keyboard to call with no args (if nonzero). */
618 void (*keyboard_init_hook
) ();
620 static int read_avail_input
P_ ((int));
621 static void get_input_pending
P_ ((int *, int));
622 static int readable_events
P_ ((int));
623 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
624 Lisp_Object
, int *));
625 static Lisp_Object
read_char_x_menu_prompt ();
626 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
628 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
629 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
630 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
631 enum scroll_bar_part
,
632 Lisp_Object
, Lisp_Object
,
635 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
636 Lisp_Object
, char **,
637 Lisp_Object
*, unsigned));
638 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
639 static int parse_solitary_modifier
P_ ((Lisp_Object
));
640 static int parse_solitary_modifier ();
641 static void save_getcjmp
P_ ((jmp_buf));
642 static void save_getcjmp ();
643 static void restore_getcjmp
P_ ((jmp_buf));
644 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
645 static void clear_event
P_ ((struct input_event
*));
647 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
649 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
650 static void handle_interrupt
P_ ((void));
651 static void timer_start_idle
P_ ((void));
652 static void timer_stop_idle
P_ ((void));
653 static void timer_resume_idle
P_ ((void));
654 static SIGTYPE handle_user_signal
P_ ((int));
655 static char *find_user_signal_name
P_ ((int));
656 static int store_user_signal_events
P_ ((void));
658 /* Nonzero means don't try to suspend even if the operating system seems
660 static int cannot_suspend
;
662 extern Lisp_Object Qidentity
, Qonly
;
664 /* Install the string STR as the beginning of the string of echoing,
665 so that it serves as a prompt for the next character.
666 Also start echoing. */
672 current_kboard
->echo_string
= str
;
673 current_kboard
->echo_after_prompt
= SCHARS (str
);
677 /* Add C to the echo string, if echoing is going on.
678 C can be a character, which is printed prettily ("M-C-x" and all that
679 jazz), or a symbol, whose name is printed. */
685 if (current_kboard
->immediate_echo
)
687 int size
= KEY_DESCRIPTION_SIZE
+ 100;
688 char *buffer
= (char *) alloca (size
);
690 Lisp_Object echo_string
;
692 echo_string
= current_kboard
->echo_string
;
694 /* If someone has passed us a composite event, use its head symbol. */
699 ptr
= push_key_description (XINT (c
), ptr
, 1);
701 else if (SYMBOLP (c
))
703 Lisp_Object name
= SYMBOL_NAME (c
);
704 int nbytes
= SBYTES (name
);
706 if (size
- (ptr
- buffer
) < nbytes
)
708 int offset
= ptr
- buffer
;
709 size
= max (2 * size
, size
+ nbytes
);
710 buffer
= (char *) alloca (size
);
711 ptr
= buffer
+ offset
;
714 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
715 STRING_MULTIBYTE (name
), 1);
718 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
721 const char *text
= " (Type ? for further options)";
722 int len
= strlen (text
);
724 if (size
- (ptr
- buffer
) < len
)
726 int offset
= ptr
- buffer
;
728 buffer
= (char *) alloca (size
);
729 ptr
= buffer
+ offset
;
732 bcopy (text
, ptr
, len
);
736 /* Replace a dash from echo_dash with a space, otherwise
737 add a space at the end as a separator between keys. */
738 if (STRINGP (echo_string
)
739 && SCHARS (echo_string
) > 1)
741 Lisp_Object last_char
, prev_char
, idx
;
743 idx
= make_number (SCHARS (echo_string
) - 2);
744 prev_char
= Faref (echo_string
, idx
);
746 idx
= make_number (SCHARS (echo_string
) - 1);
747 last_char
= Faref (echo_string
, idx
);
749 /* We test PREV_CHAR to make sure this isn't the echoing
751 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
752 Faset (echo_string
, idx
, make_number (' '));
754 echo_string
= concat2 (echo_string
, build_string (" "));
756 else if (STRINGP (echo_string
))
757 echo_string
= concat2 (echo_string
, build_string (" "));
759 current_kboard
->echo_string
760 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
766 /* Temporarily add a dash to the end of the echo string if it's not
767 empty, so that it serves as a mini-prompt for the very next character. */
772 /* Do nothing if not echoing at all. */
773 if (NILP (current_kboard
->echo_string
))
776 if (!current_kboard
->immediate_echo
777 && SCHARS (current_kboard
->echo_string
) == 0)
780 /* Do nothing if we just printed a prompt. */
781 if (current_kboard
->echo_after_prompt
782 == SCHARS (current_kboard
->echo_string
))
785 /* Do nothing if we have already put a dash at the end. */
786 if (SCHARS (current_kboard
->echo_string
) > 1)
788 Lisp_Object last_char
, prev_char
, idx
;
790 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
791 prev_char
= Faref (current_kboard
->echo_string
, idx
);
793 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
794 last_char
= Faref (current_kboard
->echo_string
, idx
);
796 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
800 /* Put a dash at the end of the buffer temporarily,
801 but make it go away when the next character is added. */
802 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
807 /* Display the current echo string, and begin echoing if not already
813 if (!current_kboard
->immediate_echo
)
816 current_kboard
->immediate_echo
= 1;
818 for (i
= 0; i
< this_command_key_count
; i
++)
822 /* Set before_command_echo_length to the value that would
823 have been saved before the start of this subcommand in
824 command_loop_1, if we had already been echoing then. */
825 if (i
== this_single_command_key_start
)
826 before_command_echo_length
= echo_length ();
828 c
= XVECTOR (this_command_keys
)->contents
[i
];
829 if (! (EVENT_HAS_PARAMETERS (c
)
830 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
834 /* Set before_command_echo_length to the value that would
835 have been saved before the start of this subcommand in
836 command_loop_1, if we had already been echoing then. */
837 if (this_command_key_count
== this_single_command_key_start
)
838 before_command_echo_length
= echo_length ();
840 /* Put a dash at the end to invite the user to type more. */
845 message3_nolog (current_kboard
->echo_string
,
846 SBYTES (current_kboard
->echo_string
),
847 STRING_MULTIBYTE (current_kboard
->echo_string
));
850 /* Record in what buffer we echoed, and from which kboard. */
851 echo_message_buffer
= echo_area_buffer
[0];
852 echo_kboard
= current_kboard
;
854 if (waiting_for_input
&& !NILP (Vquit_flag
))
855 quit_throw_to_read_char ();
858 /* Turn off echoing, for the start of a new command. */
863 current_kboard
->immediate_echo
= 0;
864 current_kboard
->echo_after_prompt
= -1;
865 current_kboard
->echo_string
= Qnil
;
866 ok_to_echo_at_next_pause
= NULL
;
868 echo_message_buffer
= Qnil
;
871 /* Return the length of the current echo string. */
876 return (STRINGP (current_kboard
->echo_string
)
877 ? SCHARS (current_kboard
->echo_string
)
881 /* Truncate the current echo message to its first LEN chars.
882 This and echo_char get used by read_key_sequence when the user
883 switches frames while entering a key sequence. */
886 echo_truncate (nchars
)
889 if (STRINGP (current_kboard
->echo_string
))
890 current_kboard
->echo_string
891 = Fsubstring (current_kboard
->echo_string
,
892 make_number (0), make_number (nchars
));
893 truncate_echo_area (nchars
);
897 /* Functions for manipulating this_command_keys. */
899 add_command_key (key
)
902 #if 0 /* Not needed after we made Freset_this_command_lengths
903 do the job immediately. */
904 /* If reset-this-command-length was called recently, obey it now.
905 See the doc string of that function for an explanation of why. */
906 if (before_command_restore_flag
)
908 this_command_key_count
= before_command_key_count_1
;
909 if (this_command_key_count
< this_single_command_key_start
)
910 this_single_command_key_start
= this_command_key_count
;
911 echo_truncate (before_command_echo_length_1
);
912 before_command_restore_flag
= 0;
916 if (this_command_key_count
>= ASIZE (this_command_keys
))
917 this_command_keys
= larger_vector (this_command_keys
,
918 2 * ASIZE (this_command_keys
),
921 ASET (this_command_keys
, this_command_key_count
, key
);
922 ++this_command_key_count
;
929 int count
= SPECPDL_INDEX ();
932 if (command_loop_level
> 0)
934 specbind (Qstandard_output
, Qt
);
935 specbind (Qstandard_input
, Qt
);
938 #ifdef HAVE_X_WINDOWS
939 /* The command loop has started an hourglass timer, so we have to
940 cancel it here, otherwise it will fire because the recursive edit
941 can take some time. Do not check for display_hourglass_p here,
942 because it could already be nil. */
946 /* This function may have been called from a debugger called from
947 within redisplay, for instance by Edebugging a function called
948 from fontification-functions. We want to allow redisplay in
949 the debugging session.
951 The recursive edit is left with a `(throw exit ...)'. The `exit'
952 tag is not caught anywhere in redisplay, i.e. when we leave the
953 recursive edit, the original redisplay leading to the recursive
954 edit will be unwound. The outcome should therefore be safe. */
955 specbind (Qinhibit_redisplay
, Qnil
);
958 val
= command_loop ();
960 Fsignal (Qquit
, Qnil
);
961 /* Handle throw from read_minibuf when using minibuffer
962 while it's active but we're in another window. */
964 xsignal1 (Qerror
, val
);
966 return unbind_to (count
, Qnil
);
969 /* When an auto-save happens, record the "time", and don't do again soon. */
974 last_auto_save
= num_nonmacro_input_events
;
977 /* Make an auto save happen as soon as possible at command level. */
980 force_auto_save_soon ()
982 last_auto_save
= - auto_save_interval
- 1;
984 record_asynch_buffer_change ();
987 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
988 doc
: /* Invoke the editor command loop recursively.
989 To get out of the recursive edit, a command can do `(throw 'exit nil)';
990 that tells this function to return.
991 Alternatively, `(throw 'exit t)' makes this function signal an error.
992 This function is called by the editor initialization to begin editing. */)
995 int count
= SPECPDL_INDEX ();
998 /* If we enter while input is blocked, don't lock up here.
999 This may happen through the debugger during redisplay. */
1000 if (INPUT_BLOCKED_P
)
1003 command_loop_level
++;
1004 update_mode_lines
= 1;
1006 if (command_loop_level
1007 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1008 buffer
= Fcurrent_buffer ();
1012 /* If we leave recursive_edit_1 below with a `throw' for instance,
1013 like it is done in the splash screen display, we have to
1014 make sure that we restore single_kboard as command_loop_1
1015 would have done if it were left normally. */
1016 if (command_loop_level
> 0)
1017 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1018 record_unwind_protect (recursive_edit_unwind
, buffer
);
1020 recursive_edit_1 ();
1021 return unbind_to (count
, Qnil
);
1025 recursive_edit_unwind (buffer
)
1028 if (BUFFERP (buffer
))
1029 Fset_buffer (buffer
);
1031 command_loop_level
--;
1032 update_mode_lines
= 1;
1037 #if 0 /* These two functions are now replaced with
1038 temporarily_switch_to_single_kboard. */
1043 #if 0 /* Theory: if there's anything in Vunread_command_events,
1044 it will right away be read by read_key_sequence,
1045 and then if we do switch KBOARDS, it will go into the side
1046 queue then. So we don't need to do anything special here -- rms. */
1047 if (CONSP (Vunread_command_events
))
1049 current_kboard
->kbd_queue
1050 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1051 current_kboard
->kbd_queue_has_data
= 1;
1053 Vunread_command_events
= Qnil
;
1059 /* Switch to the single-kboard state, making current_kboard
1060 the only KBOARD from which further input is accepted. */
1063 single_kboard_state ()
1071 /* If we're in single_kboard state for kboard KBOARD,
1075 not_single_kboard_state (kboard
)
1079 if (kboard
== current_kboard
)
1084 /* Maintain a stack of kboards, so other parts of Emacs
1085 can switch temporarily to the kboard of a given frame
1086 and then revert to the previous status. */
1091 struct kboard_stack
*next
;
1094 static struct kboard_stack
*kboard_stack
;
1101 struct kboard_stack
*p
1102 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1104 p
->next
= kboard_stack
;
1105 p
->kboard
= current_kboard
;
1117 struct kboard_stack
*p
= kboard_stack
;
1119 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1121 if (t
->kboard
== p
->kboard
)
1123 current_kboard
= p
->kboard
;
1130 /* The terminal we remembered has been deleted. */
1131 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1134 kboard_stack
= p
->next
;
1139 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1140 from which further input is accepted. If F is non-nil, set its
1141 KBOARD as the current keyboard.
1143 This function uses record_unwind_protect to return to the previous
1146 If Emacs is already in single_kboard mode, and F's keyboard is
1147 locked, then this function will throw an errow. */
1150 temporarily_switch_to_single_kboard (f
)
1154 int was_locked
= single_kboard
;
1157 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1158 /* We can not switch keyboards while in single_kboard mode.
1159 In rare cases, Lisp code may call `recursive-edit' (or
1160 `read-minibuffer' or `y-or-n-p') after it switched to a
1161 locked frame. For example, this is likely to happen
1162 when server.el connects to a new terminal while Emacs is in
1163 single_kboard mode. It is best to throw an error instead
1164 of presenting the user with a frozen screen. */
1165 error ("Terminal %d is locked, cannot read from it",
1166 FRAME_TERMINAL (f
)->id
);
1168 /* This call is unnecessary, but helps
1169 `restore_kboard_configuration' discover if somebody changed
1170 `current_kboard' behind our back. */
1171 push_kboard (current_kboard
);
1174 current_kboard
= FRAME_KBOARD (f
);
1176 record_unwind_protect (restore_kboard_configuration
,
1177 (was_locked
? Qt
: Qnil
));
1181 #if 0 /* This function is not needed anymore. */
1183 record_single_kboard_state ()
1186 push_kboard (current_kboard
);
1187 record_unwind_protect (restore_kboard_configuration
,
1188 (single_kboard
? Qt
: Qnil
));
1194 restore_kboard_configuration (was_locked
)
1195 Lisp_Object was_locked
;
1197 if (NILP (was_locked
))
1201 struct kboard
*prev
= current_kboard
;
1204 /* The pop should not change the kboard. */
1205 if (single_kboard
&& current_kboard
!= prev
)
1213 /* Handle errors that are not handled at inner levels
1214 by printing an error message and returning to the editor command loop. */
1220 Lisp_Object old_level
, old_length
;
1221 char macroerror
[50];
1223 #ifdef HAVE_X_WINDOWS
1224 if (display_hourglass_p
)
1225 cancel_hourglass ();
1228 if (!NILP (executing_kbd_macro
))
1230 if (executing_kbd_macro_iterations
== 1)
1231 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1233 sprintf (macroerror
, "After %d kbd macro iterations: ",
1234 executing_kbd_macro_iterations
);
1239 Vstandard_output
= Qt
;
1240 Vstandard_input
= Qt
;
1241 Vexecuting_kbd_macro
= Qnil
;
1242 executing_kbd_macro
= Qnil
;
1243 current_kboard
->Vprefix_arg
= Qnil
;
1244 current_kboard
->Vlast_prefix_arg
= Qnil
;
1247 /* Avoid unquittable loop if data contains a circular list. */
1248 old_level
= Vprint_level
;
1249 old_length
= Vprint_length
;
1250 XSETFASTINT (Vprint_level
, 10);
1251 XSETFASTINT (Vprint_length
, 10);
1252 cmd_error_internal (data
, macroerror
);
1253 Vprint_level
= old_level
;
1254 Vprint_length
= old_length
;
1258 Vinhibit_quit
= Qnil
;
1259 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1261 if (command_loop_level
== 0 && minibuf_level
== 0)
1262 any_kboard_state ();
1266 return make_number (0);
1269 /* Take actions on handling an error. DATA is the data that describes
1272 CONTEXT is a C-string containing ASCII characters only which
1273 describes the context in which the error happened. If we need to
1274 generalize CONTEXT to allow multibyte characters, make it a Lisp
1278 cmd_error_internal (data
, context
)
1282 struct frame
*sf
= SELECTED_FRAME ();
1284 /* The immediate context is not interesting for Quits,
1285 since they are asyncronous. */
1286 if (EQ (XCAR (data
), Qquit
))
1287 Vsignaling_function
= Qnil
;
1292 /* Use user's specified output function if any. */
1293 if (!NILP (Vcommand_error_function
))
1294 call3 (Vcommand_error_function
, data
,
1295 context
? build_string (context
) : empty_unibyte_string
,
1296 Vsignaling_function
);
1297 /* If the window system or terminal frame hasn't been initialized
1298 yet, or we're not interactive, write the message to stderr and exit. */
1299 else if (!sf
->glyphs_initialized_p
1300 || FRAME_INITIAL_P (sf
)
1303 print_error_message (data
, Qexternal_debugging_output
,
1304 context
, Vsignaling_function
);
1305 Fterpri (Qexternal_debugging_output
);
1306 Fkill_emacs (make_number (-1));
1310 clear_message (1, 0);
1312 message_log_maybe_newline ();
1315 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1318 Vsignaling_function
= Qnil
;
1321 Lisp_Object
command_loop_1 ();
1322 Lisp_Object
command_loop_2 ();
1323 Lisp_Object
top_level_1 ();
1325 /* Entry to editor-command-loop.
1326 This level has the catches for exiting/returning to editor command loop.
1327 It returns nil to exit recursive edit, t to abort it. */
1332 if (command_loop_level
> 0 || minibuf_level
> 0)
1335 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1336 executing_kbd_macro
= Qnil
;
1342 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1343 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1344 /* Reset single_kboard in case top-level set it while
1345 evaluating an -f option, or we are stuck there for some
1347 any_kboard_state ();
1349 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1350 executing_kbd_macro
= Qnil
;
1352 /* End of file in -batch run causes exit here. */
1358 /* Here we catch errors in execution of commands within the
1359 editing loop, and reenter the editing loop.
1360 When there is an error, cmd_error runs and returns a non-nil
1361 value to us. A value of nil means that command_loop_1 itself
1362 returned due to end of file (or end of kbd macro). */
1367 register Lisp_Object val
;
1370 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1371 while (!NILP (val
));
1379 return Feval (Vtop_level
);
1385 /* On entry to the outer level, run the startup file */
1386 if (!NILP (Vtop_level
))
1387 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1388 else if (!NILP (Vpurify_flag
))
1389 message ("Bare impure Emacs (standard Lisp code not loaded)");
1391 message ("Bare Emacs (standard Lisp code not loaded)");
1395 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1396 doc
: /* Exit all recursive editing levels. */)
1399 #ifdef HAVE_X_WINDOWS
1400 if (display_hourglass_p
)
1401 cancel_hourglass ();
1404 /* Unblock input if we enter with input blocked. This may happen if
1405 redisplay traps e.g. during tool-bar update with input blocked. */
1406 while (INPUT_BLOCKED_P
)
1409 return Fthrow (Qtop_level
, Qnil
);
1412 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1413 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1416 if (command_loop_level
> 0 || minibuf_level
> 0)
1417 Fthrow (Qexit
, Qnil
);
1419 error ("No recursive edit is in progress");
1423 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1424 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1427 if (command_loop_level
> 0 || minibuf_level
> 0)
1430 error ("No recursive edit is in progress");
1434 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1436 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1437 of this function. */
1440 tracking_off (old_value
)
1441 Lisp_Object old_value
;
1443 do_mouse_tracking
= old_value
;
1444 if (NILP (old_value
))
1446 /* Redisplay may have been preempted because there was input
1447 available, and it assumes it will be called again after the
1448 input has been processed. If the only input available was
1449 the sort that we have just disabled, then we need to call
1451 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1453 redisplay_preserve_echo_area (6);
1454 get_input_pending (&input_pending
,
1455 READABLE_EVENTS_DO_TIMERS_NOW
);
1461 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1462 doc
: /* Evaluate BODY with mouse movement events enabled.
1463 Within a `track-mouse' form, mouse motion generates input events that
1464 you can read with `read-event'.
1465 Normally, mouse motion is ignored.
1466 usage: (track-mouse BODY...) */)
1470 int count
= SPECPDL_INDEX ();
1473 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1475 do_mouse_tracking
= Qt
;
1477 val
= Fprogn (args
);
1478 return unbind_to (count
, val
);
1481 /* If mouse has moved on some frame, return one of those frames.
1485 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1486 after resizing the tool-bar window. */
1488 int ignore_mouse_drag_p
;
1493 Lisp_Object tail
, frame
;
1495 if (ignore_mouse_drag_p
)
1497 /* ignore_mouse_drag_p = 0; */
1501 FOR_EACH_FRAME (tail
, frame
)
1503 if (XFRAME (frame
)->mouse_moved
)
1504 return XFRAME (frame
);
1510 #endif /* HAVE_MOUSE || HAVE_GPM */
1512 /* This is the actual command reading loop,
1513 sans error-handling encapsulation. */
1515 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1517 void safe_run_hooks
P_ ((Lisp_Object
));
1518 static void adjust_point_for_property
P_ ((int, int));
1520 /* Cancel hourglass from protect_unwind.
1522 #ifdef HAVE_X_WINDOWS
1524 cancel_hourglass_unwind (arg
)
1527 cancel_hourglass ();
1538 Lisp_Object keybuf
[30];
1540 int prev_modiff
= 0;
1541 struct buffer
*prev_buffer
= NULL
;
1542 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1544 int was_locked
= single_kboard
;
1547 int already_adjusted
= 0;
1549 current_kboard
->Vprefix_arg
= Qnil
;
1550 current_kboard
->Vlast_prefix_arg
= Qnil
;
1551 Vdeactivate_mark
= Qnil
;
1552 waiting_for_input
= 0;
1556 this_command_key_count
= 0;
1557 this_command_key_count_reset
= 0;
1558 this_single_command_key_start
= 0;
1560 if (NILP (Vmemory_full
))
1562 /* Make sure this hook runs after commands that get errors and
1563 throw to top level. */
1564 /* Note that the value cell will never directly contain nil
1565 if the symbol is a local variable. */
1566 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1567 safe_run_hooks (Qpost_command_hook
);
1569 /* If displaying a message, resize the echo area window to fit
1570 that message's size exactly. */
1571 if (!NILP (echo_area_buffer
[0]))
1572 resize_echo_area_exactly ();
1574 if (!NILP (Vdeferred_action_list
))
1575 safe_run_hooks (Qdeferred_action_function
);
1578 /* Do this after running Vpost_command_hook, for consistency. */
1579 current_kboard
->Vlast_command
= Vthis_command
;
1580 current_kboard
->Vreal_last_command
= real_this_command
;
1581 if (!CONSP (last_command_char
))
1582 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1586 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1589 /* Make sure the current window's buffer is selected. */
1590 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1591 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1593 /* Display any malloc warning that just came out. Use while because
1594 displaying one warning can cause another. */
1596 while (pending_malloc_warning
)
1597 display_malloc_warning ();
1599 Vdeactivate_mark
= Qnil
;
1601 /* If minibuffer on and echo area in use,
1602 wait a short time and redraw minibuffer. */
1605 && !NILP (echo_area_buffer
[0])
1606 && EQ (minibuf_window
, echo_area_window
))
1608 /* Bind inhibit-quit to t so that C-g gets read in
1609 rather than quitting back to the minibuffer. */
1610 int count
= SPECPDL_INDEX ();
1611 specbind (Qinhibit_quit
, Qt
);
1613 if (NUMBERP (Vminibuffer_message_timeout
))
1614 sit_for (Vminibuffer_message_timeout
, 0, 2);
1618 /* Clear the echo area. */
1620 safe_run_hooks (Qecho_area_clear_hook
);
1622 unbind_to (count
, Qnil
);
1624 /* If a C-g came in before, treat it as input now. */
1625 if (!NILP (Vquit_flag
))
1628 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1633 /* Select the frame that the last event came from. Usually,
1634 switch-frame events will take care of this, but if some lisp
1635 code swallows a switch-frame event, we'll fix things up here.
1636 Is this a good idea? */
1637 if (FRAMEP (internal_last_event_frame
)
1638 && !EQ (internal_last_event_frame
, selected_frame
))
1639 Fselect_frame (internal_last_event_frame
);
1641 /* If it has changed current-menubar from previous value,
1642 really recompute the menubar from the value. */
1643 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1644 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1645 call0 (Qrecompute_lucid_menubar
);
1647 before_command_key_count
= this_command_key_count
;
1648 before_command_echo_length
= echo_length ();
1650 Vthis_command
= Qnil
;
1651 real_this_command
= Qnil
;
1652 Vthis_original_command
= Qnil
;
1654 /* Read next key sequence; i gets its length. */
1655 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1658 /* A filter may have run while we were reading the input. */
1659 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1661 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1662 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1666 /* Now we have read a key sequence of length I,
1667 or else I is 0 and we found end of file. */
1669 if (i
== 0) /* End of file -- happens only in */
1670 return Qnil
; /* a kbd macro, at the end. */
1671 /* -1 means read_key_sequence got a menu that was rejected.
1672 Just loop around and read another command. */
1676 this_command_key_count
= 0;
1677 this_command_key_count_reset
= 0;
1678 this_single_command_key_start
= 0;
1682 last_command_char
= keybuf
[i
- 1];
1684 /* If the previous command tried to force a specific window-start,
1685 forget about that, in case this command moves point far away
1686 from that position. But also throw away beg_unchanged and
1687 end_unchanged information in that case, so that redisplay will
1688 update the whole window properly. */
1689 if (!NILP (XWINDOW (selected_window
)->force_start
))
1692 XWINDOW (selected_window
)->force_start
= Qnil
;
1693 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1694 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1697 cmd
= read_key_sequence_cmd
;
1698 if (!NILP (Vexecuting_kbd_macro
))
1700 if (!NILP (Vquit_flag
))
1702 Vexecuting_kbd_macro
= Qt
;
1703 QUIT
; /* Make some noise. */
1704 /* Will return since macro now empty. */
1708 /* Do redisplay processing after this command except in special
1709 cases identified below. */
1710 prev_buffer
= current_buffer
;
1711 prev_modiff
= MODIFF
;
1712 last_point_position
= PT
;
1713 last_point_position_window
= selected_window
;
1714 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1716 /* By default, we adjust point to a boundary of a region that
1717 has such a property that should be treated intangible
1718 (e.g. composition, display). But, some commands will set
1719 this variable differently. */
1720 Vdisable_point_adjustment
= Qnil
;
1722 /* Process filters and timers may have messed with deactivate-mark.
1723 reset it before we execute the command. */
1724 Vdeactivate_mark
= Qnil
;
1726 /* Remap command through active keymaps */
1727 Vthis_original_command
= cmd
;
1731 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1735 /* Execute the command. */
1737 Vthis_command
= cmd
;
1738 real_this_command
= cmd
;
1739 /* Note that the value cell will never directly contain nil
1740 if the symbol is a local variable. */
1741 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1742 safe_run_hooks (Qpre_command_hook
);
1744 already_adjusted
= 0;
1746 if (NILP (Vthis_command
))
1748 /* nil means key is undefined. */
1749 Lisp_Object keys
= Fvector (i
, keybuf
);
1750 keys
= Fkey_description (keys
, Qnil
);
1752 message_with_string ("%s is undefined", keys
, 0);
1753 current_kboard
->defining_kbd_macro
= Qnil
;
1754 update_mode_lines
= 1;
1755 current_kboard
->Vprefix_arg
= Qnil
;
1759 if (NILP (current_kboard
->Vprefix_arg
))
1761 /* In case we jump to directly_done. */
1762 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1764 /* Recognize some common commands in common situations and
1765 do them directly. */
1766 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1768 struct Lisp_Char_Table
*dp
1769 = window_display_table (XWINDOW (selected_window
));
1770 lose
= FETCH_CHAR (PT_BYTE
);
1772 if (! NILP (Vpost_command_hook
))
1773 /* Put this before calling adjust_point_for_property
1774 so it will only get called once in any case. */
1776 if (current_buffer
== prev_buffer
1777 && last_point_position
!= PT
1778 && NILP (Vdisable_point_adjustment
)
1779 && NILP (Vglobal_disable_point_adjustment
))
1780 adjust_point_for_property (last_point_position
, 0);
1781 already_adjusted
= 1;
1782 if (PT
== last_point_position
+ 1
1784 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1785 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1786 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1787 && (lose
>= 0x20 && lose
< 0x7f)))
1788 : (lose
>= 0x20 && lose
< 0x7f))
1789 /* To extract the case of continuation on
1790 wide-column characters. */
1791 && ASCII_BYTE_P (lose
)
1792 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1794 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1796 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1798 && !windows_or_buffers_changed
1799 && EQ (current_buffer
->selective_display
, Qnil
)
1800 && !detect_input_pending ()
1801 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1802 && NILP (Vexecuting_kbd_macro
))
1803 direct_output_forward_char (1);
1806 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1808 struct Lisp_Char_Table
*dp
1809 = window_display_table (XWINDOW (selected_window
));
1811 lose
= FETCH_CHAR (PT_BYTE
);
1812 if (! NILP (Vpost_command_hook
))
1814 if (current_buffer
== prev_buffer
1815 && last_point_position
!= PT
1816 && NILP (Vdisable_point_adjustment
)
1817 && NILP (Vglobal_disable_point_adjustment
))
1818 adjust_point_for_property (last_point_position
, 0);
1819 already_adjusted
= 1;
1820 if (PT
== last_point_position
- 1
1822 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1823 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1824 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1825 && (lose
>= 0x20 && lose
< 0x7f)))
1826 : (lose
>= 0x20 && lose
< 0x7f))
1827 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1829 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1831 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1833 && !windows_or_buffers_changed
1834 && EQ (current_buffer
->selective_display
, Qnil
)
1835 && !detect_input_pending ()
1836 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1837 && NILP (Vexecuting_kbd_macro
))
1838 direct_output_forward_char (-1);
1841 else if (EQ (Vthis_command
, Qself_insert_command
)
1842 /* Try this optimization only on char keystrokes. */
1843 && NATNUMP (last_command_char
)
1844 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1847 = translate_char (Vtranslation_table_for_input
,
1848 XFASTINT (last_command_char
));
1850 if (NILP (Vexecuting_kbd_macro
)
1851 && !EQ (minibuf_window
, selected_window
))
1853 if (!nonundocount
|| nonundocount
>= 20)
1861 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1863 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1865 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1867 || MODIFF
<= SAVE_MODIFF
1868 || windows_or_buffers_changed
1869 || !EQ (current_buffer
->selective_display
, Qnil
)
1870 || detect_input_pending ()
1871 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1872 || !NILP (Vexecuting_kbd_macro
));
1874 value
= internal_self_insert (c
, 0);
1879 if (! NILP (Vpost_command_hook
))
1880 /* Put this before calling adjust_point_for_property
1881 so it will only get called once in any case. */
1884 /* VALUE == 1 when AFTER-CHANGE functions are
1885 installed which is the case most of the time
1886 because FONT-LOCK installs one. */
1887 if (!lose
&& !value
)
1888 direct_output_for_insert (c
);
1893 /* Here for a command that isn't executed directly */
1896 #ifdef HAVE_X_WINDOWS
1897 int scount
= SPECPDL_INDEX ();
1899 if (display_hourglass_p
1900 && NILP (Vexecuting_kbd_macro
))
1902 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1908 if (NILP (current_kboard
->Vprefix_arg
))
1910 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1912 #ifdef HAVE_X_WINDOWS
1913 /* Do not check display_hourglass_p here, because
1914 Fcommand_execute could change it, but we should cancel
1915 hourglass cursor anyway.
1916 But don't cancel the hourglass within a macro
1917 just because a command in the macro finishes. */
1918 if (NILP (Vexecuting_kbd_macro
))
1919 unbind_to (scount
, Qnil
);
1924 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1926 /* Note that the value cell will never directly contain nil
1927 if the symbol is a local variable. */
1928 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1929 safe_run_hooks (Qpost_command_hook
);
1931 /* If displaying a message, resize the echo area window to fit
1932 that message's size exactly. */
1933 if (!NILP (echo_area_buffer
[0]))
1934 resize_echo_area_exactly ();
1936 if (!NILP (Vdeferred_action_list
))
1937 safe_run_hooks (Qdeferred_action_function
);
1939 /* If there is a prefix argument,
1940 1) We don't want Vlast_command to be ``universal-argument''
1941 (that would be dumb), so don't set Vlast_command,
1942 2) we want to leave echoing on so that the prefix will be
1943 echoed as part of this key sequence, so don't call
1945 3) we want to leave this_command_key_count non-zero, so that
1946 read_char will realize that it is re-reading a character, and
1947 not echo it a second time.
1949 If the command didn't actually create a prefix arg,
1950 but is merely a frame event that is transparent to prefix args,
1951 then the above doesn't apply. */
1952 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1954 current_kboard
->Vlast_command
= Vthis_command
;
1955 current_kboard
->Vreal_last_command
= real_this_command
;
1956 if (!CONSP (last_command_char
))
1957 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1959 this_command_key_count
= 0;
1960 this_command_key_count_reset
= 0;
1961 this_single_command_key_start
= 0;
1964 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1966 /* Setting transient-mark-mode to `only' is a way of
1967 turning it on for just one command. */
1969 if (EQ (Vtransient_mark_mode
, Qidentity
))
1970 Vtransient_mark_mode
= Qnil
;
1971 if (EQ (Vtransient_mark_mode
, Qonly
))
1972 Vtransient_mark_mode
= Qidentity
;
1974 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1976 /* We could also call `deactivate'mark'. */
1977 if (EQ (Vtransient_mark_mode
, Qlambda
))
1978 Vtransient_mark_mode
= Qnil
;
1981 current_buffer
->mark_active
= Qnil
;
1982 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1985 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1986 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1991 if (current_buffer
== prev_buffer
1992 && last_point_position
!= PT
1993 && NILP (Vdisable_point_adjustment
)
1994 && NILP (Vglobal_disable_point_adjustment
)
1995 && !already_adjusted
)
1996 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1998 /* Install chars successfully executed in kbd macro. */
2000 if (!NILP (current_kboard
->defining_kbd_macro
)
2001 && NILP (current_kboard
->Vprefix_arg
))
2002 finalize_kbd_macro_chars ();
2003 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2006 any_kboard_state ();
2012 extern Lisp_Object Qcomposition
, Qdisplay
;
2014 /* Adjust point to a boundary of a region that has such a property
2015 that should be treated intangible. For the moment, we check
2016 `composition', `display' and `invisible' properties.
2017 LAST_PT is the last position of point. */
2019 extern Lisp_Object Qafter_string
, Qbefore_string
;
2020 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2023 adjust_point_for_property (last_pt
, modified
)
2028 Lisp_Object val
, overlay
, tmp
;
2029 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2032 /* FIXME: cycling is probably not necessary because these properties
2033 can't be usefully combined anyway. */
2034 while (check_composition
|| check_display
|| check_invisible
)
2036 if (check_composition
2037 && PT
> BEGV
&& PT
< ZV
2038 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2039 && COMPOSITION_VALID_P (beg
, end
, val
)
2040 && beg
< PT
/* && end > PT <- It's always the case. */
2041 && (last_pt
<= beg
|| last_pt
>= end
))
2044 SET_PT (PT
< last_pt
? beg
: end
);
2045 check_display
= check_invisible
= 1;
2047 check_composition
= 0;
2049 && PT
> BEGV
&& PT
< ZV
2050 && !NILP (val
= get_char_property_and_overlay
2051 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2052 && display_prop_intangible_p (val
)
2053 && (!OVERLAYP (overlay
)
2054 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2055 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2056 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2057 && (beg
< PT
/* && end > PT <- It's always the case. */
2058 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2061 SET_PT (PT
< last_pt
2062 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2064 check_composition
= check_invisible
= 1;
2067 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2069 int inv
, ellipsis
= 0;
2072 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2074 && !NILP (val
= get_char_property_and_overlay
2075 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2076 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2078 ellipsis
= ellipsis
|| inv
> 1
2079 || (OVERLAYP (overlay
)
2080 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2081 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2082 tmp
= Fnext_single_char_property_change
2083 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2084 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2087 && !NILP (val
= get_char_property_and_overlay
2088 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2089 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2091 ellipsis
= ellipsis
|| inv
> 1
2092 || (OVERLAYP (overlay
)
2093 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2094 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2095 tmp
= Fprevious_single_char_property_change
2096 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2097 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2100 /* Move away from the inside area. */
2101 if (beg
< PT
&& end
> PT
)
2103 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2104 /* We haven't moved yet (so we don't need to fear
2105 infinite-looping) and we were outside the range
2106 before (so either end of the range still corresponds
2107 to a move in the right direction): pretend we moved
2108 less than we actually did, so that we still have
2109 more freedom below in choosing which end of the range
2111 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2112 /* We either have moved already or the last point
2113 was already in the range: we don't get to choose
2114 which end of the range we have to go to. */
2115 : (PT
< last_pt
? beg
: end
));
2116 check_composition
= check_display
= 1;
2118 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2119 the point to something other than its argument, due to
2120 point-motion hooks, intangibility, etc. */
2121 xassert (PT
== beg
|| PT
== end
);
2124 /* Pretend the area doesn't exist if the buffer is not
2126 if (!modified
&& !ellipsis
&& beg
< end
)
2128 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2129 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2130 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2131 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2132 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2133 /* We've already moved as far as we can. Trying to go
2134 to the other end would mean moving backwards and thus
2135 could lead to an infinite loop. */
2137 else if (val
= get_pos_property (make_number (PT
),
2139 TEXT_PROP_MEANS_INVISIBLE (val
)
2140 && (val
= get_pos_property
2141 (make_number (PT
== beg
? end
: beg
),
2143 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2144 (check_composition
= check_display
= 1,
2145 SET_PT (PT
== beg
? end
: beg
));
2148 check_invisible
= 0;
2152 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2155 safe_run_hooks_1 (hook
)
2158 if (NILP (Vrun_hooks
))
2160 return call1 (Vrun_hooks
, Vinhibit_quit
);
2163 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2166 safe_run_hooks_error (data
)
2169 Lisp_Object args
[3];
2170 args
[0] = build_string ("Error in %s: %s");
2171 args
[1] = Vinhibit_quit
;
2174 return Fset (Vinhibit_quit
, Qnil
);
2177 /* If we get an error while running the hook, cause the hook variable
2178 to be nil. Also inhibit quits, so that C-g won't cause the hook
2179 to mysteriously evaporate. */
2182 safe_run_hooks (hook
)
2185 int count
= SPECPDL_INDEX ();
2186 specbind (Qinhibit_quit
, hook
);
2188 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2190 unbind_to (count
, Qnil
);
2194 /* Number of seconds between polling for input. This is a Lisp
2195 variable that can be bound. */
2197 EMACS_INT polling_period
;
2199 /* Nonzero means polling for input is temporarily suppressed. */
2201 int poll_suppress_count
;
2203 /* Asynchronous timer for polling. */
2205 struct atimer
*poll_timer
;
2208 #ifdef POLL_FOR_INPUT
2210 /* Poll for input, so what we catch a C-g if it comes in. This
2211 function is called from x_make_frame_visible, see comment
2217 if (interrupt_input_blocked
== 0
2218 && !waiting_for_input
)
2219 read_avail_input (0);
2222 /* Timer callback function for poll_timer. TIMER is equal to
2226 poll_for_input (timer
)
2227 struct atimer
*timer
;
2229 if (poll_suppress_count
== 0)
2231 interrupt_input_pending
= 1;
2233 poll_for_input_1 ();
2237 #endif /* POLL_FOR_INPUT */
2239 /* Begin signals to poll for input, if they are appropriate.
2240 This function is called unconditionally from various places. */
2245 #ifdef POLL_FOR_INPUT
2246 /* XXX This condition was (read_socket_hook && !interrupt_input),
2247 but read_socket_hook is not global anymore. Let's pretend that
2249 if (!interrupt_input
)
2251 /* Turn alarm handling on unconditionally. It might have
2252 been turned off in process.c. */
2253 turn_on_atimers (1);
2255 /* If poll timer doesn't exist, are we need one with
2256 a different interval, start a new one. */
2257 if (poll_timer
== NULL
2258 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2260 EMACS_TIME interval
;
2263 cancel_atimer (poll_timer
);
2265 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2266 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2267 poll_for_input
, NULL
);
2270 /* Let the timer's callback function poll for input
2271 if this becomes zero. */
2272 --poll_suppress_count
;
2277 /* Nonzero if we are using polling to handle input asynchronously. */
2280 input_polling_used ()
2282 #ifdef POLL_FOR_INPUT
2283 /* XXX This condition was (read_socket_hook && !interrupt_input),
2284 but read_socket_hook is not global anymore. Let's pretend that
2286 return !interrupt_input
;
2292 /* Turn off polling. */
2297 #ifdef POLL_FOR_INPUT
2298 /* XXX This condition was (read_socket_hook && !interrupt_input),
2299 but read_socket_hook is not global anymore. Let's pretend that
2301 if (!interrupt_input
)
2302 ++poll_suppress_count
;
2306 /* Set the value of poll_suppress_count to COUNT
2307 and start or stop polling accordingly. */
2310 set_poll_suppress_count (count
)
2313 #ifdef POLL_FOR_INPUT
2314 if (count
== 0 && poll_suppress_count
!= 0)
2316 poll_suppress_count
= 1;
2319 else if (count
!= 0 && poll_suppress_count
== 0)
2323 poll_suppress_count
= count
;
2327 /* Bind polling_period to a value at least N.
2328 But don't decrease it. */
2331 bind_polling_period (n
)
2334 #ifdef POLL_FOR_INPUT
2335 int new = polling_period
;
2340 stop_other_atimers (poll_timer
);
2342 specbind (Qpolling_period
, make_number (new));
2343 /* Start a new alarm with the new period. */
2348 /* Apply the control modifier to CHARACTER. */
2354 /* Save the upper bits here. */
2355 int upper
= c
& ~0177;
2357 if (! ASCII_BYTE_P (c
))
2358 return c
|= ctrl_modifier
;
2362 /* Everything in the columns containing the upper-case letters
2363 denotes a control character. */
2364 if (c
>= 0100 && c
< 0140)
2368 /* Set the shift modifier for a control char
2369 made from a shifted letter. But only for letters! */
2370 if (oc
>= 'A' && oc
<= 'Z')
2371 c
|= shift_modifier
;
2374 /* The lower-case letters denote control characters too. */
2375 else if (c
>= 'a' && c
<= 'z')
2378 /* Include the bits for control and shift
2379 only if the basic ASCII code can't indicate them. */
2383 /* Replace the high bits. */
2384 c
|= (upper
& ~ctrl_modifier
);
2389 /* Display the help-echo property of the character after the mouse pointer.
2390 Either show it in the echo area, or call show-help-function to display
2391 it by other means (maybe in a tooltip).
2393 If HELP is nil, that means clear the previous help echo.
2395 If HELP is a string, display that string. If HELP is a function,
2396 call it with OBJECT and POS as arguments; the function should
2397 return a help string or nil for none. For all other types of HELP,
2398 evaluate it to obtain a string.
2400 WINDOW is the window in which the help was generated, if any.
2401 It is nil if not in a window.
2403 If OBJECT is a buffer, POS is the position in the buffer where the
2404 `help-echo' text property was found.
2406 If OBJECT is an overlay, that overlay has a `help-echo' property,
2407 and POS is the position in the overlay's buffer under the mouse.
2409 If OBJECT is a string (an overlay string or a string displayed with
2410 the `display' property). POS is the position in that string under
2413 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2414 echo overwrites a keystroke echo currently displayed in the echo
2417 Note: this function may only be called with HELP nil or a string
2418 from X code running asynchronously. */
2421 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2422 Lisp_Object help
, window
, object
, pos
;
2423 int ok_to_overwrite_keystroke_echo
;
2425 if (!NILP (help
) && !STRINGP (help
))
2427 if (FUNCTIONP (help
))
2429 Lisp_Object args
[4];
2434 help
= safe_call (4, args
);
2437 help
= safe_eval (help
);
2439 if (!STRINGP (help
))
2443 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2444 if (!noninteractive
&& STRINGP (help
))
2446 /* The mouse-fixup-help-message Lisp function can call
2447 mouse_position_hook, which resets the mouse_moved flags.
2448 This causes trouble if we are trying to read a mouse motion
2449 event (i.e., if we are inside a `track-mouse' form), so we
2450 restore the mouse_moved flag. */
2451 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2452 help
= call1 (Qmouse_fixup_help_message
, help
);
2458 if (STRINGP (help
) || NILP (help
))
2460 if (!NILP (Vshow_help_function
))
2461 call1 (Vshow_help_function
, help
);
2462 else if (/* Don't overwrite minibuffer contents. */
2463 !MINI_WINDOW_P (XWINDOW (selected_window
))
2464 /* Don't overwrite a keystroke echo. */
2465 && (NILP (echo_message_buffer
)
2466 || ok_to_overwrite_keystroke_echo
)
2467 /* Don't overwrite a prompt. */
2468 && !cursor_in_echo_area
)
2472 int count
= SPECPDL_INDEX ();
2474 if (!help_echo_showing_p
)
2475 Vpre_help_message
= current_message ();
2477 specbind (Qmessage_truncate_lines
, Qt
);
2478 message3_nolog (help
, SBYTES (help
),
2479 STRING_MULTIBYTE (help
));
2480 unbind_to (count
, Qnil
);
2482 else if (STRINGP (Vpre_help_message
))
2484 message3_nolog (Vpre_help_message
,
2485 SBYTES (Vpre_help_message
),
2486 STRING_MULTIBYTE (Vpre_help_message
));
2487 Vpre_help_message
= Qnil
;
2493 help_echo_showing_p
= STRINGP (help
);
2499 /* Input of single characters from keyboard */
2501 Lisp_Object
print_help ();
2502 static Lisp_Object
kbd_buffer_get_event ();
2503 static void record_char ();
2505 static Lisp_Object help_form_saved_window_configs
;
2507 read_char_help_form_unwind (arg
)
2509 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2510 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2511 if (!NILP (window_config
))
2512 Fset_window_configuration (window_config
);
2516 #define STOP_POLLING \
2517 do { if (! polling_stopped_here) stop_polling (); \
2518 polling_stopped_here = 1; } while (0)
2520 #define RESUME_POLLING \
2521 do { if (polling_stopped_here) start_polling (); \
2522 polling_stopped_here = 0; } while (0)
2524 /* read a character from the keyboard; call the redisplay if needed */
2525 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2526 -1 means do not do redisplay, but do do autosaving.
2529 /* The arguments MAPS and NMAPS are for menu prompting.
2530 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2532 PREV_EVENT is the previous input event, or nil if we are reading
2533 the first event of a key sequence (or not reading a key sequence).
2534 If PREV_EVENT is t, that is a "magic" value that says
2535 not to run input methods, but in other respects to act as if
2536 not reading a key sequence.
2538 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2539 if we used a mouse menu to read the input, or zero otherwise. If
2540 USED_MOUSE_MENU is null, we don't dereference it.
2542 Value is -2 when we find input on another keyboard. A second call
2543 to read_char will read it.
2545 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2546 specifying the maximum time to wait until. If no input arrives by
2547 that time, stop waiting and return nil.
2549 Value is t if we showed a menu and the user rejected it. */
2552 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2556 Lisp_Object prev_event
;
2557 int *used_mouse_menu
;
2558 EMACS_TIME
*end_time
;
2560 volatile Lisp_Object c
;
2561 int count
, jmpcount
;
2562 jmp_buf local_getcjmp
;
2564 volatile int key_already_recorded
= 0;
2565 Lisp_Object tem
, save
;
2566 volatile Lisp_Object previous_echo_area_message
;
2567 volatile Lisp_Object also_record
;
2568 volatile int reread
;
2569 struct gcpro gcpro1
, gcpro2
;
2570 int polling_stopped_here
= 0;
2571 struct kboard
*orig_kboard
= current_kboard
;
2575 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2576 before_command_key_count
= this_command_key_count
;
2577 before_command_echo_length
= echo_length ();
2580 previous_echo_area_message
= Qnil
;
2582 GCPRO2 (c
, previous_echo_area_message
);
2587 if (CONSP (Vunread_post_input_method_events
))
2589 c
= XCAR (Vunread_post_input_method_events
);
2590 Vunread_post_input_method_events
2591 = XCDR (Vunread_post_input_method_events
);
2593 /* Undo what read_char_x_menu_prompt did when it unread
2594 additional keys returned by Fx_popup_menu. */
2596 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2604 if (unread_command_char
!= -1)
2606 XSETINT (c
, unread_command_char
);
2607 unread_command_char
= -1;
2613 if (CONSP (Vunread_command_events
))
2615 c
= XCAR (Vunread_command_events
);
2616 Vunread_command_events
= XCDR (Vunread_command_events
);
2620 /* Undo what sit-for did when it unread additional keys
2621 inside universal-argument. */
2624 && EQ (XCAR (c
), Qt
))
2630 /* Undo what read_char_x_menu_prompt did when it unread
2631 additional keys returned by Fx_popup_menu. */
2633 && EQ (XCDR (c
), Qdisabled
)
2634 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2637 /* If the queued event is something that used the mouse,
2638 set used_mouse_menu accordingly. */
2640 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2641 *used_mouse_menu
= 1;
2643 goto reread_for_input_method
;
2646 if (CONSP (Vunread_input_method_events
))
2648 c
= XCAR (Vunread_input_method_events
);
2649 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2651 /* Undo what read_char_x_menu_prompt did when it unread
2652 additional keys returned by Fx_popup_menu. */
2654 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2658 goto reread_for_input_method
;
2661 this_command_key_count_reset
= 0;
2663 if (!NILP (Vexecuting_kbd_macro
))
2665 /* We set this to Qmacro; since that's not a frame, nobody will
2666 try to switch frames on us, and the selected window will
2669 Since this event came from a macro, it would be misleading to
2670 leave internal_last_event_frame set to wherever the last
2671 real event came from. Normally, a switch-frame event selects
2672 internal_last_event_frame after each command is read, but
2673 events read from a macro should never cause a new frame to be
2675 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2677 /* Exit the macro if we are at the end.
2678 Also, some things replace the macro with t
2679 to force an early exit. */
2680 if (EQ (Vexecuting_kbd_macro
, Qt
)
2681 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2687 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2688 if (STRINGP (Vexecuting_kbd_macro
)
2689 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2690 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2692 executing_kbd_macro_index
++;
2697 if (!NILP (unread_switch_frame
))
2699 c
= unread_switch_frame
;
2700 unread_switch_frame
= Qnil
;
2702 /* This event should make it into this_command_keys, and get echoed
2703 again, so we do not set `reread'. */
2707 /* if redisplay was requested */
2708 if (commandflag
>= 0)
2710 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2712 /* If there is pending input, process any events which are not
2713 user-visible, such as X selection_request events. */
2715 || detect_input_pending_run_timers (0))
2716 swallow_events (0); /* may clear input_pending */
2718 /* Redisplay if no pending input. */
2719 while (!input_pending
)
2721 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2722 redisplay_preserve_echo_area (5);
2727 /* Normal case: no input arrived during redisplay. */
2730 /* Input arrived and pre-empted redisplay.
2731 Process any events which are not user-visible. */
2733 /* If that cleared input_pending, try again to redisplay. */
2736 /* Prevent the redisplay we just did
2737 from messing up echoing of the input after the prompt. */
2738 if (commandflag
== 0 && echo_current
)
2739 echo_message_buffer
= echo_area_buffer
[0];
2743 /* Message turns off echoing unless more keystrokes turn it on again.
2745 The code in 20.x for the condition was
2747 1. echo_area_glyphs && *echo_area_glyphs
2748 2. && echo_area_glyphs != current_kboard->echobuf
2749 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2751 (1) means there's a current message displayed
2753 (2) means it's not the message from echoing from the current
2756 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2757 is set to a non-null value. This is done in read_char and it is
2758 set to echo_area_glyphs after a call to echo_char. That means
2759 ok_to_echo_at_next_pause is either null or
2760 current_kboard->echobuf with the appropriate current_kboard at
2763 So, condition (3) means in clear text ok_to_echo_at_next_pause
2764 must be either null, or the current message isn't from echoing at
2765 all, or it's from echoing from a different kboard than the
2768 if (/* There currently is something in the echo area. */
2769 !NILP (echo_area_buffer
[0])
2770 && (/* And it's either not from echoing. */
2771 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2772 /* Or it's an echo from a different kboard. */
2773 || echo_kboard
!= current_kboard
2774 /* Or we explicitly allow overwriting whatever there is. */
2775 || ok_to_echo_at_next_pause
== NULL
))
2780 /* Try reading a character via menu prompting in the minibuf.
2781 Try this before the sit-for, because the sit-for
2782 would do the wrong thing if we are supposed to do
2783 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2784 after a mouse event so don't try a minibuf menu. */
2786 if (nmaps
> 0 && INTERACTIVE
2787 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2788 /* Don't bring up a menu if we already have another event. */
2789 && NILP (Vunread_command_events
)
2790 && unread_command_char
< 0
2791 && !detect_input_pending_run_timers (0))
2793 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2795 if (INTEGERP (c
) && XINT (c
) == -2)
2796 return c
; /* wrong_kboard_jmpbuf */
2800 key_already_recorded
= 1;
2805 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2806 We will do that below, temporarily for short sections of code,
2807 when appropriate. local_getcjmp must be in effect
2808 around any call to sit_for or kbd_buffer_get_event;
2809 it *must not* be in effect when we call redisplay. */
2811 jmpcount
= SPECPDL_INDEX ();
2812 if (_setjmp (local_getcjmp
))
2814 /* Handle quits while reading the keyboard. */
2815 /* We must have saved the outer value of getcjmp here,
2816 so restore it now. */
2817 restore_getcjmp (save_jump
);
2818 unbind_to (jmpcount
, Qnil
);
2819 XSETINT (c
, quit_char
);
2820 internal_last_event_frame
= selected_frame
;
2821 Vlast_event_frame
= internal_last_event_frame
;
2822 /* If we report the quit char as an event,
2823 don't do so more than once. */
2824 if (!NILP (Vinhibit_quit
))
2829 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2830 if (kb
!= current_kboard
)
2832 Lisp_Object link
= kb
->kbd_queue
;
2833 /* We shouldn't get here if we were in single-kboard mode! */
2838 while (CONSP (XCDR (link
)))
2840 if (!NILP (XCDR (link
)))
2844 kb
->kbd_queue
= Fcons (c
, Qnil
);
2846 XSETCDR (link
, Fcons (c
, Qnil
));
2847 kb
->kbd_queue_has_data
= 1;
2848 current_kboard
= kb
;
2849 /* This is going to exit from read_char
2850 so we had better get rid of this frame's stuff. */
2852 return make_number (-2); /* wrong_kboard_jmpbuf */
2859 /* Start idle timers if no time limit is supplied. We don't do it
2860 if a time limit is supplied to avoid an infinite recursion in the
2861 situation where an idle timer calls `sit-for'. */
2864 timer_start_idle ();
2866 /* If in middle of key sequence and minibuffer not active,
2867 start echoing if enough time elapses. */
2869 if (minibuf_level
== 0
2871 && !current_kboard
->immediate_echo
2872 && this_command_key_count
> 0
2874 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2875 && NILP (Fzerop (Vecho_keystrokes
))
2876 && (/* No message. */
2877 NILP (echo_area_buffer
[0])
2878 /* Or empty message. */
2879 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2880 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2881 /* Or already echoing from same kboard. */
2882 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2883 /* Or not echoing before and echoing allowed. */
2884 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2886 /* After a mouse event, start echoing right away.
2887 This is because we are probably about to display a menu,
2888 and we don't want to delay before doing so. */
2889 if (EVENT_HAS_PARAMETERS (prev_event
))
2895 save_getcjmp (save_jump
);
2896 restore_getcjmp (local_getcjmp
);
2897 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2898 restore_getcjmp (save_jump
);
2900 && ! CONSP (Vunread_command_events
))
2905 /* Maybe auto save due to number of keystrokes. */
2907 if (commandflag
!= 0
2908 && auto_save_interval
> 0
2909 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2910 && !detect_input_pending_run_timers (0))
2912 Fdo_auto_save (Qnil
, Qnil
);
2913 /* Hooks can actually change some buffers in auto save. */
2917 /* Try reading using an X menu.
2918 This is never confused with reading using the minibuf
2919 because the recursive call of read_char in read_char_minibuf_menu_prompt
2920 does not pass on any keymaps. */
2922 if (nmaps
> 0 && INTERACTIVE
2923 && !NILP (prev_event
)
2924 && EVENT_HAS_PARAMETERS (prev_event
)
2925 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2926 && !EQ (XCAR (prev_event
), Qtool_bar
)
2927 /* Don't bring up a menu if we already have another event. */
2928 && NILP (Vunread_command_events
)
2929 && unread_command_char
< 0)
2931 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2933 /* Now that we have read an event, Emacs is not idle. */
2940 /* Maybe autosave and/or garbage collect due to idleness. */
2942 if (INTERACTIVE
&& NILP (c
))
2944 int delay_level
, buffer_size
;
2946 /* Slow down auto saves logarithmically in size of current buffer,
2947 and garbage collect while we're at it. */
2948 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2949 last_non_minibuf_size
= Z
- BEG
;
2950 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2952 while (buffer_size
> 64)
2953 delay_level
++, buffer_size
-= buffer_size
>> 2;
2954 if (delay_level
< 4) delay_level
= 4;
2955 /* delay_level is 4 for files under around 50k, 7 at 100k,
2956 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2958 /* Auto save if enough time goes by without input. */
2959 if (commandflag
!= 0
2960 && num_nonmacro_input_events
> last_auto_save
2961 && INTEGERP (Vauto_save_timeout
)
2962 && XINT (Vauto_save_timeout
) > 0)
2965 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2967 save_getcjmp (save_jump
);
2968 restore_getcjmp (local_getcjmp
);
2969 tem0
= sit_for (make_number (timeout
), 1, 1);
2970 restore_getcjmp (save_jump
);
2973 && ! CONSP (Vunread_command_events
))
2975 Fdo_auto_save (Qnil
, Qnil
);
2977 /* If we have auto-saved and there is still no input
2978 available, garbage collect if there has been enough
2979 consing going on to make it worthwhile. */
2980 if (!detect_input_pending_run_timers (0)
2981 && consing_since_gc
> gc_cons_threshold
/ 2)
2982 Fgarbage_collect ();
2989 /* Notify the caller if an autosave hook, or a timer, sentinel or
2990 filter in the sit_for calls above have changed the current
2991 kboard. This could happen if they use the minibuffer or start a
2992 recursive edit, like the fancy splash screen in server.el's
2993 filter. If this longjmp wasn't here, read_key_sequence would
2994 interpret the next key sequence using the wrong translation
2995 tables and function keymaps. */
2996 if (NILP (c
) && current_kboard
!= orig_kboard
)
2999 return make_number (-2); /* wrong_kboard_jmpbuf */
3002 /* If this has become non-nil here, it has been set by a timer
3003 or sentinel or filter. */
3004 if (CONSP (Vunread_command_events
))
3006 c
= XCAR (Vunread_command_events
);
3007 Vunread_command_events
= XCDR (Vunread_command_events
);
3010 /* Read something from current KBOARD's side queue, if possible. */
3014 if (current_kboard
->kbd_queue_has_data
)
3016 if (!CONSP (current_kboard
->kbd_queue
))
3018 c
= XCAR (current_kboard
->kbd_queue
);
3019 current_kboard
->kbd_queue
3020 = XCDR (current_kboard
->kbd_queue
);
3021 if (NILP (current_kboard
->kbd_queue
))
3022 current_kboard
->kbd_queue_has_data
= 0;
3023 input_pending
= readable_events (0);
3024 if (EVENT_HAS_PARAMETERS (c
)
3025 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
3026 internal_last_event_frame
= XCAR (XCDR (c
));
3027 Vlast_event_frame
= internal_last_event_frame
;
3032 /* If current_kboard's side queue is empty check the other kboards.
3033 If one of them has data that we have not yet seen here,
3034 switch to it and process the data waiting for it.
3036 Note: if the events queued up for another kboard
3037 have already been seen here, and therefore are not a complete command,
3038 the kbd_queue_has_data field is 0, so we skip that kboard here.
3039 That's to avoid an infinite loop switching between kboards here. */
3040 if (NILP (c
) && !single_kboard
)
3043 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3044 if (kb
->kbd_queue_has_data
)
3046 current_kboard
= kb
;
3047 /* This is going to exit from read_char
3048 so we had better get rid of this frame's stuff. */
3050 return make_number (-2); /* wrong_kboard_jmpbuf */
3059 /* Finally, we read from the main queue,
3060 and if that gives us something we can't use yet, we put it on the
3061 appropriate side queue and try again. */
3070 EMACS_GET_TIME (now
);
3071 if (EMACS_TIME_GE (now
, *end_time
))
3075 /* Actually read a character, waiting if necessary. */
3076 save_getcjmp (save_jump
);
3077 restore_getcjmp (local_getcjmp
);
3079 timer_start_idle ();
3080 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3081 restore_getcjmp (save_jump
);
3084 if (! NILP (c
) && (kb
!= current_kboard
))
3086 Lisp_Object link
= kb
->kbd_queue
;
3089 while (CONSP (XCDR (link
)))
3091 if (!NILP (XCDR (link
)))
3095 kb
->kbd_queue
= Fcons (c
, Qnil
);
3097 XSETCDR (link
, Fcons (c
, Qnil
));
3098 kb
->kbd_queue_has_data
= 1;
3102 current_kboard
= kb
;
3103 /* This is going to exit from read_char
3104 so we had better get rid of this frame's stuff. */
3106 return make_number (-2);
3111 /* Terminate Emacs in batch mode if at eof. */
3112 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3113 Fkill_emacs (make_number (1));
3117 /* Add in any extra modifiers, where appropriate. */
3118 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3119 || ((extra_keyboard_modifiers
& 0177) < ' '
3120 && (extra_keyboard_modifiers
& 0177) != 0))
3121 XSETINT (c
, make_ctrl_char (XINT (c
)));
3123 /* Transfer any other modifier bits directly from
3124 extra_keyboard_modifiers to c. Ignore the actual character code
3125 in the low 16 bits of extra_keyboard_modifiers. */
3126 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3137 if (commandflag
>= 0
3138 && !input_pending
&& !detect_input_pending_run_timers (0))
3146 /* Buffer switch events are only for internal wakeups
3147 so don't show them to the user.
3148 Also, don't record a key if we already did. */
3149 if (BUFFERP (c
) || key_already_recorded
)
3152 /* Process special events within read_char
3153 and loop around to read another event. */
3156 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3161 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3162 int was_locked
= single_kboard
;
3163 int count
= SPECPDL_INDEX ();
3164 record_single_kboard_state ();
3167 last_input_char
= c
;
3168 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3170 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3171 /* We stopped being idle for this event; undo that. This
3172 prevents automatic window selection (under
3173 mouse_autoselect_window from acting as a real input event, for
3174 example banishing the mouse under mouse-avoidance-mode. */
3175 timer_resume_idle ();
3177 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3178 /* Resume allowing input from any kboard, if that was true before. */
3180 any_kboard_state ();
3181 unbind_to (count
, Qnil
);
3187 /* Handle things that only apply to characters. */
3190 /* If kbd_buffer_get_event gave us an EOF, return that. */
3194 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3195 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3196 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3197 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3198 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3202 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3203 /* nil in keyboard-translate-table means no translation. */
3209 /* If this event is a mouse click in the menu bar,
3210 return just menu-bar for now. Modify the mouse click event
3211 so we won't do this twice, then queue it up. */
3212 if (EVENT_HAS_PARAMETERS (c
)
3214 && CONSP (EVENT_START (c
))
3215 && CONSP (XCDR (EVENT_START (c
))))
3219 posn
= POSN_POSN (EVENT_START (c
));
3220 /* Handle menu-bar events:
3221 insert the dummy prefix event `menu-bar'. */
3222 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3224 /* Change menu-bar to (menu-bar) as the event "position". */
3225 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3228 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3233 /* Store these characters into recent_keys, the dribble file if any,
3234 and the keyboard macro being defined, if any. */
3236 if (! NILP (also_record
))
3237 record_char (also_record
);
3239 /* Wipe the echo area.
3240 But first, if we are about to use an input method,
3241 save the echo area contents for it to refer to. */
3243 && ! NILP (Vinput_method_function
)
3244 && (unsigned) XINT (c
) >= ' '
3245 && (unsigned) XINT (c
) != 127
3246 && (unsigned) XINT (c
) < 256)
3248 previous_echo_area_message
= Fcurrent_message ();
3249 Vinput_method_previous_message
= previous_echo_area_message
;
3252 /* Now wipe the echo area, except for help events which do their
3253 own stuff with the echo area. */
3255 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3256 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3258 if (!NILP (echo_area_buffer
[0]))
3259 safe_run_hooks (Qecho_area_clear_hook
);
3260 clear_message (1, 0);
3263 reread_for_input_method
:
3265 /* Pass this to the input method, if appropriate. */
3267 && ! NILP (Vinput_method_function
)
3268 /* Don't run the input method within a key sequence,
3269 after the first event of the key sequence. */
3270 && NILP (prev_event
)
3271 && (unsigned) XINT (c
) >= ' '
3272 && (unsigned) XINT (c
) != 127
3273 && (unsigned) XINT (c
) < 256)
3276 int key_count
, key_count_reset
;
3277 struct gcpro gcpro1
;
3278 int count
= SPECPDL_INDEX ();
3280 /* Save the echo status. */
3281 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3282 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3283 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3284 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3287 if (before_command_restore_flag
)
3289 this_command_key_count
= before_command_key_count_1
;
3290 if (this_command_key_count
< this_single_command_key_start
)
3291 this_single_command_key_start
= this_command_key_count
;
3292 echo_truncate (before_command_echo_length_1
);
3293 before_command_restore_flag
= 0;
3297 /* Save the this_command_keys status. */
3298 key_count
= this_command_key_count
;
3299 key_count_reset
= this_command_key_count_reset
;
3302 keys
= Fcopy_sequence (this_command_keys
);
3307 /* Clear out this_command_keys. */
3308 this_command_key_count
= 0;
3309 this_command_key_count_reset
= 0;
3311 /* Now wipe the echo area. */
3312 if (!NILP (echo_area_buffer
[0]))
3313 safe_run_hooks (Qecho_area_clear_hook
);
3314 clear_message (1, 0);
3317 /* If we are not reading a key sequence,
3318 never use the echo area. */
3321 specbind (Qinput_method_use_echo_area
, Qt
);
3324 /* Call the input method. */
3325 tem
= call1 (Vinput_method_function
, c
);
3327 tem
= unbind_to (count
, tem
);
3329 /* Restore the saved echoing state
3330 and this_command_keys state. */
3331 this_command_key_count
= key_count
;
3332 this_command_key_count_reset
= key_count_reset
;
3334 this_command_keys
= keys
;
3337 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3338 current_kboard
->echo_string
= saved_echo_string
;
3339 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3340 if (saved_immediate_echo
)
3345 /* The input method can return no events. */
3348 /* Bring back the previous message, if any. */
3349 if (! NILP (previous_echo_area_message
))
3350 message_with_string ("%s", previous_echo_area_message
, 0);
3353 /* It returned one event or more. */
3355 Vunread_post_input_method_events
3356 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3361 /* Display help if not echoing. */
3362 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3364 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3365 Lisp_Object help
, object
, position
, window
, tem
;
3367 tem
= Fcdr (XCDR (c
));
3370 window
= Fcar (tem
);
3372 object
= Fcar (tem
);
3374 position
= Fcar (tem
);
3376 show_help_echo (help
, window
, object
, position
, 0);
3378 /* We stopped being idle for this event; undo that. */
3380 timer_resume_idle ();
3384 if ((! reread
|| this_command_key_count
== 0
3385 || this_command_key_count_reset
)
3389 /* Don't echo mouse motion events. */
3390 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3391 && NILP (Fzerop (Vecho_keystrokes
))
3392 && ! (EVENT_HAS_PARAMETERS (c
)
3393 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3396 if (! NILP (also_record
))
3397 echo_char (also_record
);
3398 /* Once we reread a character, echoing can happen
3399 the next time we pause to read a new one. */
3400 ok_to_echo_at_next_pause
= current_kboard
;
3403 /* Record this character as part of the current key. */
3404 add_command_key (c
);
3405 if (! NILP (also_record
))
3406 add_command_key (also_record
);
3409 last_input_char
= c
;
3412 /* Process the help character specially if enabled */
3413 if (!NILP (Vhelp_form
) && help_char_p (c
))
3416 count
= SPECPDL_INDEX ();
3418 help_form_saved_window_configs
3419 = Fcons (Fcurrent_window_configuration (Qnil
),
3420 help_form_saved_window_configs
);
3421 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3423 tem0
= Feval (Vhelp_form
);
3425 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3430 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3431 if (EVENT_HAS_PARAMETERS (c
)
3432 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3433 XSETCAR (help_form_saved_window_configs
, Qnil
);
3435 while (BUFFERP (c
));
3436 /* Remove the help from the frame */
3437 unbind_to (count
, Qnil
);
3440 if (EQ (c
, make_number (040)))
3444 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3445 while (BUFFERP (c
));
3454 /* Record a key that came from a mouse menu.
3455 Record it for echoing, for this-command-keys, and so on. */
3461 /* Wipe the echo area. */
3462 clear_message (1, 0);
3467 before_command_key_count
= this_command_key_count
;
3468 before_command_echo_length
= echo_length ();
3471 /* Don't echo mouse motion events. */
3472 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3473 && NILP (Fzerop (Vecho_keystrokes
)))
3477 /* Once we reread a character, echoing can happen
3478 the next time we pause to read a new one. */
3479 ok_to_echo_at_next_pause
= 0;
3482 /* Record this character as part of the current key. */
3483 add_command_key (c
);
3485 /* Re-reading in the middle of a command */
3486 last_input_char
= c
;
3490 /* Return 1 if should recognize C as "the help character". */
3498 if (EQ (c
, Vhelp_char
))
3500 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3501 if (EQ (c
, XCAR (tail
)))
3506 /* Record the input event C in various ways. */
3514 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3516 /* To avoid filling recent_keys with help-echo and mouse-movement
3517 events, we filter out repeated help-echo events, only store the
3518 first and last in a series of mouse-movement events, and don't
3519 store repeated help-echo events which are only separated by
3520 mouse-movement events. */
3522 Lisp_Object ev1
, ev2
, ev3
;
3525 if ((ix1
= recent_keys_index
- 1) < 0)
3526 ix1
= NUM_RECENT_KEYS
- 1;
3527 ev1
= AREF (recent_keys
, ix1
);
3529 if ((ix2
= ix1
- 1) < 0)
3530 ix2
= NUM_RECENT_KEYS
- 1;
3531 ev2
= AREF (recent_keys
, ix2
);
3533 if ((ix3
= ix2
- 1) < 0)
3534 ix3
= NUM_RECENT_KEYS
- 1;
3535 ev3
= AREF (recent_keys
, ix3
);
3537 if (EQ (XCAR (c
), Qhelp_echo
))
3539 /* Don't record `help-echo' in recent_keys unless it shows some help
3540 message, and a different help than the previously recorded
3542 Lisp_Object help
, last_help
;
3544 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3545 if (!STRINGP (help
))
3547 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3548 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3550 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3551 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3552 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3554 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3555 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3556 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3557 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3560 else if (EQ (XCAR (c
), Qmouse_movement
))
3562 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3563 So additional mouse movement events replace the last element. */
3564 Lisp_Object last_window
, window
;
3566 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3567 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3568 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3569 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3570 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3572 ASET (recent_keys
, ix1
, c
);
3578 store_kbd_macro_char (c
);
3583 ASET (recent_keys
, recent_keys_index
, c
);
3584 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3585 recent_keys_index
= 0;
3587 else if (recorded
< 0)
3589 /* We need to remove one or two events from recent_keys.
3590 To do this, we simply put nil at those events and move the
3591 recent_keys_index backwards over those events. Usually,
3592 users will never see those nil events, as they will be
3593 overwritten by the command keys entered to see recent_keys
3596 while (recorded
++ < 0 && total_keys
> 0)
3598 if (total_keys
< NUM_RECENT_KEYS
)
3600 if (--recent_keys_index
< 0)
3601 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3602 ASET (recent_keys
, recent_keys_index
, Qnil
);
3606 num_nonmacro_input_events
++;
3608 /* Write c to the dribble file. If c is a lispy event, write
3609 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3610 If you, dear reader, have a better idea, you've got the source. :-) */
3616 if (XUINT (c
) < 0x100)
3617 putc (XINT (c
), dribble
);
3619 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3623 Lisp_Object dribblee
;
3625 /* If it's a structured event, take the event header. */
3626 dribblee
= EVENT_HEAD (c
);
3628 if (SYMBOLP (dribblee
))
3630 putc ('<', dribble
);
3631 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3632 SBYTES (SYMBOL_NAME (dribblee
)),
3634 putc ('>', dribble
);
3647 struct buffer
*old
= current_buffer
;
3648 Fprinc (object
, Qnil
);
3649 set_buffer_internal (XBUFFER (Vstandard_output
));
3650 call0 (intern ("help-mode"));
3651 set_buffer_internal (old
);
3655 /* Copy out or in the info on where C-g should throw to.
3656 This is used when running Lisp code from within get_char,
3657 in case get_char is called recursively.
3658 See read_process_output. */
3664 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3668 restore_getcjmp (temp
)
3671 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3674 /* Low level keyboard/mouse input.
3675 kbd_buffer_store_event places events in kbd_buffer, and
3676 kbd_buffer_get_event retrieves them. */
3678 /* Return true if there are any events in the queue that read-char
3679 would return. If this returns false, a read-char would block. */
3681 readable_events (flags
)
3684 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3687 /* If the buffer contains only FOCUS_IN_EVENT events, and
3688 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3689 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3691 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3692 #ifdef USE_TOOLKIT_SCROLL_BARS
3693 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3697 struct input_event
*event
;
3699 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3706 #ifdef USE_TOOLKIT_SCROLL_BARS
3707 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3709 event
->kind
== FOCUS_IN_EVENT
)
3710 #ifdef USE_TOOLKIT_SCROLL_BARS
3711 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3712 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3713 && event
->part
== scroll_bar_handle
3714 && event
->modifiers
== 0)
3719 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3722 while (event
!= kbd_store_ptr
);
3728 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3729 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3730 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3735 if (current_kboard
->kbd_queue_has_data
)
3741 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3742 if (kb
->kbd_queue_has_data
)
3748 /* Set this for debugging, to have a way to get out */
3753 event_to_kboard (event
)
3754 struct input_event
*event
;
3757 frame
= event
->frame_or_window
;
3759 frame
= XCAR (frame
);
3760 else if (WINDOWP (frame
))
3761 frame
= WINDOW_FRAME (XWINDOW (frame
));
3763 /* There are still some events that don't set this field.
3764 For now, just ignore the problem.
3765 Also ignore dead frames here. */
3766 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3769 return FRAME_KBOARD (XFRAME (frame
));
3774 Lisp_Object Vthrow_on_input
;
3776 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3779 kbd_buffer_store_event (event
)
3780 register struct input_event
*event
;
3782 kbd_buffer_store_event_hold (event
, 0);
3785 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3787 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3788 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3789 Else, if EVENT is a quit event, store the quit event
3790 in HOLD_QUIT, and return (thus ignoring further events).
3792 This is used in read_avail_input to postpone the processing
3793 of the quit event until all subsequent input events have been
3794 parsed (and discarded).
3798 kbd_buffer_store_event_hold (event
, hold_quit
)
3799 register struct input_event
*event
;
3800 struct input_event
*hold_quit
;
3802 if (event
->kind
== NO_EVENT
)
3805 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3808 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3810 register int c
= event
->code
& 0377;
3812 if (event
->modifiers
& ctrl_modifier
)
3813 c
= make_ctrl_char (c
);
3815 c
|= (event
->modifiers
3816 & (meta_modifier
| alt_modifier
3817 | hyper_modifier
| super_modifier
));
3822 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3823 struct input_event
*sp
;
3825 if (single_kboard
&& kb
!= current_kboard
)
3828 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3829 Fcons (make_number (c
), Qnil
));
3830 kb
->kbd_queue_has_data
= 1;
3831 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3833 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3836 if (event_to_kboard (sp
) == kb
)
3838 sp
->kind
= NO_EVENT
;
3839 sp
->frame_or_window
= Qnil
;
3849 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3853 /* If this results in a quit_char being returned to Emacs as
3854 input, set Vlast_event_frame properly. If this doesn't
3855 get returned to Emacs as an event, the next event read
3856 will set Vlast_event_frame again, so this is safe to do. */
3860 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3862 focus
= event
->frame_or_window
;
3863 internal_last_event_frame
= focus
;
3864 Vlast_event_frame
= focus
;
3867 last_event_timestamp
= event
->timestamp
;
3868 handle_interrupt ();
3872 if (c
&& c
== stop_character
)
3878 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3879 Just ignore the second one. */
3880 else if (event
->kind
== BUFFER_SWITCH_EVENT
3881 && kbd_fetch_ptr
!= kbd_store_ptr
3882 && ((kbd_store_ptr
== kbd_buffer
3883 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3884 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3887 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3888 kbd_store_ptr
= kbd_buffer
;
3890 /* Don't let the very last slot in the buffer become full,
3891 since that would make the two pointers equal,
3892 and that is indistinguishable from an empty buffer.
3893 Discard the event if it would fill the last slot. */
3894 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3896 *kbd_store_ptr
= *event
;
3900 /* If we're inside while-no-input, and this event qualifies
3901 as input, set quit-flag to cause an interrupt. */
3902 if (!NILP (Vthrow_on_input
)
3903 && event
->kind
!= FOCUS_IN_EVENT
3904 && event
->kind
!= HELP_EVENT
3905 && event
->kind
!= DEICONIFY_EVENT
)
3907 Vquit_flag
= Vthrow_on_input
;
3908 /* If we're inside a function that wants immediate quits,
3910 if (immediate_quit
&& NILP (Vinhibit_quit
))
3920 /* Put an input event back in the head of the event queue. */
3923 kbd_buffer_unget_event (event
)
3924 register struct input_event
*event
;
3926 if (kbd_fetch_ptr
== kbd_buffer
)
3927 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3929 /* Don't let the very last slot in the buffer become full, */
3930 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3933 *kbd_fetch_ptr
= *event
;
3938 /* Generate HELP_EVENT input_events in BUFP which has room for
3939 SIZE events. If there's not enough room in BUFP, ignore this
3942 HELP is the help form.
3944 FRAME is the frame on which the help is generated. OBJECT is the
3945 Lisp object where the help was found (a buffer, a string, an
3946 overlay, or nil if neither from a string nor from a buffer. POS is
3947 the position within OBJECT where the help was found.
3949 Value is the number of input_events generated. */
3952 gen_help_event (help
, frame
, window
, object
, pos
)
3953 Lisp_Object help
, frame
, object
, window
;
3956 struct input_event event
;
3960 event
.kind
= HELP_EVENT
;
3961 event
.frame_or_window
= frame
;
3963 event
.x
= WINDOWP (window
) ? window
: frame
;
3966 kbd_buffer_store_event (&event
);
3970 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3973 kbd_buffer_store_help_event (frame
, help
)
3974 Lisp_Object frame
, help
;
3976 struct input_event event
;
3978 event
.kind
= HELP_EVENT
;
3979 event
.frame_or_window
= frame
;
3984 kbd_buffer_store_event (&event
);
3988 /* Discard any mouse events in the event buffer by setting them to
3991 discard_mouse_events ()
3993 struct input_event
*sp
;
3994 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3996 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3999 if (sp
->kind
== MOUSE_CLICK_EVENT
4000 || sp
->kind
== WHEEL_EVENT
4001 || sp
->kind
== HORIZ_WHEEL_EVENT
4003 || sp
->kind
== GPM_CLICK_EVENT
4005 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
4007 sp
->kind
= NO_EVENT
;
4013 /* Return non-zero if there are any real events waiting in the event
4014 buffer, not counting `NO_EVENT's.
4016 If DISCARD is non-zero, discard NO_EVENT events at the front of
4017 the input queue, possibly leaving the input queue empty if there
4018 are no real input events. */
4021 kbd_buffer_events_waiting (discard
)
4024 struct input_event
*sp
;
4026 for (sp
= kbd_fetch_ptr
;
4027 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4030 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4037 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4041 /* Clear input event EVENT. */
4045 struct input_event
*event
;
4047 event
->kind
= NO_EVENT
;
4051 /* Read one event from the event buffer, waiting if necessary.
4052 The value is a Lisp object representing the event.
4053 The value is nil for an event that should be ignored,
4054 or that was handled here.
4055 We always read and discard one event. */
4058 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4060 int *used_mouse_menu
;
4061 EMACS_TIME
*end_time
;
4070 *kbp
= current_kboard
;
4074 /* Wait until there is input available. */
4077 /* Break loop if there's an unread command event. Needed in
4078 moused window autoselection which uses a timer to insert such
4080 if (CONSP (Vunread_command_events
))
4083 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4085 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4086 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4090 /* If the quit flag is set, then read_char will return
4091 quit_char, so that counts as "available input." */
4092 if (!NILP (Vquit_flag
))
4093 quit_throw_to_read_char ();
4095 /* One way or another, wait until input is available; then, if
4096 interrupt handlers have not read it, read it now. */
4099 wait_for_kbd_input ();
4101 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4105 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4107 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4108 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4113 EMACS_TIME duration
;
4114 EMACS_GET_TIME (duration
);
4115 if (EMACS_TIME_GE (duration
, *end_time
))
4116 return Qnil
; /* finished waiting */
4119 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4120 wait_reading_process_output (EMACS_SECS (duration
),
4121 EMACS_USECS (duration
),
4122 -1, 1, Qnil
, NULL
, 0);
4126 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4128 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4129 /* Pass 1 for EXPECT since we just waited to have input. */
4130 read_avail_input (1);
4131 #endif /* not VMS */
4134 if (CONSP (Vunread_command_events
))
4137 first
= XCAR (Vunread_command_events
);
4138 Vunread_command_events
= XCDR (Vunread_command_events
);
4139 *kbp
= current_kboard
;
4143 /* At this point, we know that there is a readable event available
4144 somewhere. If the event queue is empty, then there must be a
4145 mouse movement enabled and available. */
4146 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4148 struct input_event
*event
;
4150 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4154 last_event_timestamp
= event
->timestamp
;
4157 *kbp
= event_to_kboard (event
);
4159 *kbp
= current_kboard
; /* Better than returning null ptr? */
4161 *kbp
= &the_only_kboard
;
4166 /* These two kinds of events get special handling
4167 and don't actually appear to the command loop.
4168 We return nil for them. */
4169 if (event
->kind
== SELECTION_REQUEST_EVENT
4170 || event
->kind
== SELECTION_CLEAR_EVENT
)
4173 struct input_event copy
;
4175 /* Remove it from the buffer before processing it,
4176 since otherwise swallow_events will see it
4177 and process it again. */
4179 kbd_fetch_ptr
= event
+ 1;
4180 input_pending
= readable_events (0);
4181 x_handle_selection_event (©
);
4183 /* We're getting selection request events, but we don't have
4189 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4190 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4192 /* Make an event (delete-frame (FRAME)). */
4193 obj
= Fcons (event
->frame_or_window
, Qnil
);
4194 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4195 kbd_fetch_ptr
= event
+ 1;
4198 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4199 else if (event
->kind
== ICONIFY_EVENT
)
4201 /* Make an event (iconify-frame (FRAME)). */
4202 obj
= Fcons (event
->frame_or_window
, Qnil
);
4203 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4204 kbd_fetch_ptr
= event
+ 1;
4206 else if (event
->kind
== DEICONIFY_EVENT
)
4208 /* Make an event (make-frame-visible (FRAME)). */
4209 obj
= Fcons (event
->frame_or_window
, Qnil
);
4210 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4211 kbd_fetch_ptr
= event
+ 1;
4214 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4216 /* The value doesn't matter here; only the type is tested. */
4217 XSETBUFFER (obj
, current_buffer
);
4218 kbd_fetch_ptr
= event
+ 1;
4220 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4221 || defined (USE_GTK)
4222 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4224 kbd_fetch_ptr
= event
+ 1;
4225 input_pending
= readable_events (0);
4226 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4227 x_activate_menubar (XFRAME (event
->frame_or_window
));
4230 #if defined (WINDOWSNT) || defined (MAC_OS)
4231 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4234 /* Make an event (language-change (KEY_SCRIPT)). */
4235 obj
= Fcons (make_number (event
->code
), Qnil
);
4237 /* Make an event (language-change (FRAME CHARSET LCID)). */
4238 obj
= Fcons (event
->frame_or_window
, Qnil
);
4240 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4241 kbd_fetch_ptr
= event
+ 1;
4244 else if (event
->kind
== SAVE_SESSION_EVENT
)
4246 obj
= Fcons (Qsave_session
, Qnil
);
4247 kbd_fetch_ptr
= event
+ 1;
4249 /* Just discard these, by returning nil.
4250 With MULTI_KBOARD, these events are used as placeholders
4251 when we need to randomly delete events from the queue.
4252 (They shouldn't otherwise be found in the buffer,
4253 but on some machines it appears they do show up
4254 even without MULTI_KBOARD.) */
4255 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4256 mouse events during a popup-menu call. */
4257 else if (event
->kind
== NO_EVENT
)
4258 kbd_fetch_ptr
= event
+ 1;
4259 else if (event
->kind
== HELP_EVENT
)
4261 Lisp_Object object
, position
, help
, frame
, window
;
4263 frame
= event
->frame_or_window
;
4264 object
= event
->arg
;
4265 position
= make_number (event
->code
);
4268 clear_event (event
);
4270 kbd_fetch_ptr
= event
+ 1;
4271 if (!WINDOWP (window
))
4273 obj
= Fcons (Qhelp_echo
,
4274 list5 (frame
, help
, window
, object
, position
));
4276 else if (event
->kind
== FOCUS_IN_EVENT
)
4278 /* Notification of a FocusIn event. The frame receiving the
4279 focus is in event->frame_or_window. Generate a
4280 switch-frame event if necessary. */
4281 Lisp_Object frame
, focus
;
4283 frame
= event
->frame_or_window
;
4284 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4288 if (!EQ (frame
, internal_last_event_frame
)
4289 && !EQ (frame
, selected_frame
))
4290 obj
= make_lispy_switch_frame (frame
);
4291 internal_last_event_frame
= frame
;
4292 kbd_fetch_ptr
= event
+ 1;
4295 else if (event
->kind
== DBUS_EVENT
)
4297 obj
= make_lispy_event (event
);
4298 kbd_fetch_ptr
= event
+ 1;
4303 /* If this event is on a different frame, return a switch-frame this
4304 time, and leave the event in the queue for next time. */
4308 frame
= event
->frame_or_window
;
4310 frame
= XCAR (frame
);
4311 else if (WINDOWP (frame
))
4312 frame
= WINDOW_FRAME (XWINDOW (frame
));
4314 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4318 if (! EQ (frame
, internal_last_event_frame
)
4319 && !EQ (frame
, selected_frame
))
4320 obj
= make_lispy_switch_frame (frame
);
4321 internal_last_event_frame
= frame
;
4323 /* If we didn't decide to make a switch-frame event, go ahead
4324 and build a real event from the queue entry. */
4328 obj
= make_lispy_event (event
);
4330 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4331 || defined (USE_GTK)
4332 /* If this was a menu selection, then set the flag to inhibit
4333 writing to last_nonmenu_event. Don't do this if the event
4334 we're returning is (menu-bar), though; that indicates the
4335 beginning of the menu sequence, and we might as well leave
4336 that as the `event with parameters' for this selection. */
4338 && !EQ (event
->frame_or_window
, event
->arg
)
4339 && (event
->kind
== MENU_BAR_EVENT
4340 || event
->kind
== TOOL_BAR_EVENT
))
4341 *used_mouse_menu
= 1;
4344 /* Wipe out this event, to catch bugs. */
4345 clear_event (event
);
4346 kbd_fetch_ptr
= event
+ 1;
4350 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4351 /* Try generating a mouse motion event. */
4352 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4354 FRAME_PTR f
= some_mouse_moved ();
4355 Lisp_Object bar_window
;
4356 enum scroll_bar_part part
;
4360 *kbp
= current_kboard
;
4361 /* Note that this uses F to determine which terminal to look at.
4362 If there is no valid info, it does not store anything
4363 so x remains nil. */
4366 /* XXX Can f or mouse_position_hook be NULL here? */
4367 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4368 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4369 &part
, &x
, &y
, &time
);
4373 /* Decide if we should generate a switch-frame event. Don't
4374 generate switch-frame events for motion outside of all Emacs
4380 frame
= FRAME_FOCUS_FRAME (f
);
4382 XSETFRAME (frame
, f
);
4384 if (! EQ (frame
, internal_last_event_frame
)
4385 && !EQ (frame
, selected_frame
))
4386 obj
= make_lispy_switch_frame (frame
);
4387 internal_last_event_frame
= frame
;
4390 /* If we didn't decide to make a switch-frame event, go ahead and
4391 return a mouse-motion event. */
4392 if (!NILP (x
) && NILP (obj
))
4393 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4395 #endif /* HAVE_MOUSE || HAVE GPM */
4397 /* We were promised by the above while loop that there was
4398 something for us to read! */
4401 input_pending
= readable_events (0);
4403 Vlast_event_frame
= internal_last_event_frame
;
4408 /* Process any events that are not user-visible,
4409 then return, without reading any user-visible events. */
4412 swallow_events (do_display
)
4417 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4419 struct input_event
*event
;
4421 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4425 last_event_timestamp
= event
->timestamp
;
4427 /* These two kinds of events get special handling
4428 and don't actually appear to the command loop. */
4429 if (event
->kind
== SELECTION_REQUEST_EVENT
4430 || event
->kind
== SELECTION_CLEAR_EVENT
)
4433 struct input_event copy
;
4435 /* Remove it from the buffer before processing it,
4436 since otherwise swallow_events called recursively could see it
4437 and process it again. */
4439 kbd_fetch_ptr
= event
+ 1;
4440 input_pending
= readable_events (0);
4441 x_handle_selection_event (©
);
4443 /* We're getting selection request events, but we don't have
4452 old_timers_run
= timers_run
;
4453 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4455 if (timers_run
!= old_timers_run
&& do_display
)
4456 redisplay_preserve_echo_area (7);
4459 /* Record the start of when Emacs is idle,
4460 for the sake of running idle-time timers. */
4467 /* If we are already in the idle state, do nothing. */
4468 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4471 EMACS_GET_TIME (timer_idleness_start_time
);
4473 timer_last_idleness_start_time
= timer_idleness_start_time
;
4475 /* Mark all idle-time timers as once again candidates for running. */
4476 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4480 timer
= XCAR (timers
);
4482 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4484 XVECTOR (timer
)->contents
[0] = Qnil
;
4488 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4493 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4496 /* Resume idle timer from last idle start time. */
4499 timer_resume_idle ()
4501 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4504 timer_idleness_start_time
= timer_last_idleness_start_time
;
4507 /* This is only for debugging. */
4508 struct input_event last_timer_event
;
4510 /* Check whether a timer has fired. To prevent larger problems we simply
4511 disregard elements that are not proper timers. Do not make a circular
4512 timer list for the time being.
4514 Returns the number of seconds to wait until the next timer fires. If a
4515 timer is triggering now, return zero seconds.
4516 If no timer is active, return -1 seconds.
4518 If a timer is ripe, we run it, with quitting turned off.
4520 DO_IT_NOW is now ignored. It used to mean that we should
4521 run the timer directly instead of queueing a timer-event.
4522 Now we always run timers directly. */
4525 timer_check (do_it_now
)
4528 EMACS_TIME nexttime
;
4529 EMACS_TIME now
, idleness_now
;
4530 Lisp_Object timers
, idle_timers
, chosen_timer
;
4531 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4533 EMACS_SET_SECS (nexttime
, -1);
4534 EMACS_SET_USECS (nexttime
, -1);
4536 /* Always consider the ordinary timers. */
4537 timers
= Vtimer_list
;
4538 /* Consider the idle timers only if Emacs is idle. */
4539 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4540 idle_timers
= Vtimer_idle_list
;
4543 chosen_timer
= Qnil
;
4544 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4546 if (CONSP (timers
) || CONSP (idle_timers
))
4548 EMACS_GET_TIME (now
);
4549 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4550 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4553 while (CONSP (timers
) || CONSP (idle_timers
))
4555 Lisp_Object
*vector
;
4556 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4557 EMACS_TIME timer_time
, idle_timer_time
;
4558 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4560 /* Skip past invalid timers and timers already handled. */
4563 timer
= XCAR (timers
);
4564 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4566 timers
= XCDR (timers
);
4569 vector
= XVECTOR (timer
)->contents
;
4571 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4572 || !INTEGERP (vector
[3])
4573 || ! NILP (vector
[0]))
4575 timers
= XCDR (timers
);
4579 if (!NILP (idle_timers
))
4581 timer
= XCAR (idle_timers
);
4582 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4584 idle_timers
= XCDR (idle_timers
);
4587 vector
= XVECTOR (timer
)->contents
;
4589 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4590 || !INTEGERP (vector
[3])
4591 || ! NILP (vector
[0]))
4593 idle_timers
= XCDR (idle_timers
);
4598 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4599 based on the next ordinary timer.
4600 TIMER_DIFFERENCE is the distance in time from NOW to when
4601 this timer becomes ripe (negative if it's already ripe). */
4604 timer
= XCAR (timers
);
4605 vector
= XVECTOR (timer
)->contents
;
4606 EMACS_SET_SECS (timer_time
,
4607 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4608 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4609 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4612 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4613 based on the next idle timer. */
4614 if (!NILP (idle_timers
))
4616 idle_timer
= XCAR (idle_timers
);
4617 vector
= XVECTOR (idle_timer
)->contents
;
4618 EMACS_SET_SECS (idle_timer_time
,
4619 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4620 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4621 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4624 /* Decide which timer is the next timer,
4625 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4626 Also step down the list where we found that timer. */
4628 if (! NILP (timers
) && ! NILP (idle_timers
))
4631 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4632 if (EMACS_TIME_NEG_P (temp
))
4634 chosen_timer
= timer
;
4635 timers
= XCDR (timers
);
4636 difference
= timer_difference
;
4640 chosen_timer
= idle_timer
;
4641 idle_timers
= XCDR (idle_timers
);
4642 difference
= idle_timer_difference
;
4645 else if (! NILP (timers
))
4647 chosen_timer
= timer
;
4648 timers
= XCDR (timers
);
4649 difference
= timer_difference
;
4653 chosen_timer
= idle_timer
;
4654 idle_timers
= XCDR (idle_timers
);
4655 difference
= idle_timer_difference
;
4657 vector
= XVECTOR (chosen_timer
)->contents
;
4659 /* If timer is ripe, run it if it hasn't been run. */
4660 if (EMACS_TIME_NEG_P (difference
)
4661 || (EMACS_SECS (difference
) == 0
4662 && EMACS_USECS (difference
) == 0))
4664 if (NILP (vector
[0]))
4666 int count
= SPECPDL_INDEX ();
4667 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4669 #if 0 /* This shouldn't be necessary anymore. --lorentey */
4670 /* On unbind_to, resume allowing input from any kboard, if that
4672 record_single_kboard_state ();
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 the
4707 most significant 16 bits of the seconds, while the second has the
4708 least significant 16 bits. The third integer gives the microsecond
4711 The value when Emacs is not idle is nil.
4713 The microsecond count is zero on systems that do not provide
4714 resolution finer than a second. */)
4717 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4719 EMACS_TIME now
, idleness_now
;
4721 EMACS_GET_TIME (now
);
4722 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4724 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4725 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4726 make_number (EMACS_USECS (idleness_now
)));
4732 /* Caches for modify_event_symbol. */
4733 static Lisp_Object accent_key_syms
;
4734 static Lisp_Object func_key_syms
;
4735 static Lisp_Object mouse_syms
;
4736 static Lisp_Object wheel_syms
;
4737 static Lisp_Object drag_n_drop_syms
;
4739 /* This is a list of keysym codes for special "accent" characters.
4740 It parallels lispy_accent_keys. */
4742 static int lispy_accent_codes
[] =
4744 #ifdef XK_dead_circumflex
4749 #ifdef XK_dead_grave
4754 #ifdef XK_dead_tilde
4759 #ifdef XK_dead_diaeresis
4764 #ifdef XK_dead_macron
4769 #ifdef XK_dead_degree
4774 #ifdef XK_dead_acute
4779 #ifdef XK_dead_cedilla
4784 #ifdef XK_dead_breve
4789 #ifdef XK_dead_ogonek
4794 #ifdef XK_dead_caron
4799 #ifdef XK_dead_doubleacute
4800 XK_dead_doubleacute
,
4804 #ifdef XK_dead_abovedot
4809 #ifdef XK_dead_abovering
4819 #ifdef XK_dead_belowdot
4824 #ifdef XK_dead_voiced_sound
4825 XK_dead_voiced_sound
,
4829 #ifdef XK_dead_semivoiced_sound
4830 XK_dead_semivoiced_sound
,
4846 /* This is a list of Lisp names for special "accent" characters.
4847 It parallels lispy_accent_codes. */
4849 static char *lispy_accent_keys
[] =
4867 "dead-voiced-sound",
4868 "dead-semivoiced-sound",
4874 #define FUNCTION_KEY_OFFSET 0x0
4876 char *lispy_function_keys
[] =
4880 0, /* VK_LBUTTON 0x01 */
4881 0, /* VK_RBUTTON 0x02 */
4882 "cancel", /* VK_CANCEL 0x03 */
4883 0, /* VK_MBUTTON 0x04 */
4885 0, 0, 0, /* 0x05 .. 0x07 */
4887 "backspace", /* VK_BACK 0x08 */
4888 "tab", /* VK_TAB 0x09 */
4890 0, 0, /* 0x0A .. 0x0B */
4892 "clear", /* VK_CLEAR 0x0C */
4893 "return", /* VK_RETURN 0x0D */
4895 0, 0, /* 0x0E .. 0x0F */
4897 0, /* VK_SHIFT 0x10 */
4898 0, /* VK_CONTROL 0x11 */
4899 0, /* VK_MENU 0x12 */
4900 "pause", /* VK_PAUSE 0x13 */
4901 "capslock", /* VK_CAPITAL 0x14 */
4902 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4904 "junja", /* VK_JUNJA 0x17 */
4905 "final", /* VK_FINAL 0x18 */
4906 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4908 "escape", /* VK_ESCAPE 0x1B */
4909 "convert", /* VK_CONVERT 0x1C */
4910 "non-convert", /* VK_NONCONVERT 0x1D */
4911 "accept", /* VK_ACCEPT 0x1E */
4912 "mode-change", /* VK_MODECHANGE 0x1F */
4913 0, /* VK_SPACE 0x20 */
4914 "prior", /* VK_PRIOR 0x21 */
4915 "next", /* VK_NEXT 0x22 */
4916 "end", /* VK_END 0x23 */
4917 "home", /* VK_HOME 0x24 */
4918 "left", /* VK_LEFT 0x25 */
4919 "up", /* VK_UP 0x26 */
4920 "right", /* VK_RIGHT 0x27 */
4921 "down", /* VK_DOWN 0x28 */
4922 "select", /* VK_SELECT 0x29 */
4923 "print", /* VK_PRINT 0x2A */
4924 "execute", /* VK_EXECUTE 0x2B */
4925 "snapshot", /* VK_SNAPSHOT 0x2C */
4926 "insert", /* VK_INSERT 0x2D */
4927 "delete", /* VK_DELETE 0x2E */
4928 "help", /* VK_HELP 0x2F */
4930 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4932 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4934 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4936 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4938 0, 0, 0, 0, 0, 0, 0, 0, 0,
4939 0, 0, 0, 0, 0, 0, 0, 0, 0,
4940 0, 0, 0, 0, 0, 0, 0, 0,
4942 "lwindow", /* VK_LWIN 0x5B */
4943 "rwindow", /* VK_RWIN 0x5C */
4944 "apps", /* VK_APPS 0x5D */
4947 "kp-0", /* VK_NUMPAD0 0x60 */
4948 "kp-1", /* VK_NUMPAD1 0x61 */
4949 "kp-2", /* VK_NUMPAD2 0x62 */
4950 "kp-3", /* VK_NUMPAD3 0x63 */
4951 "kp-4", /* VK_NUMPAD4 0x64 */
4952 "kp-5", /* VK_NUMPAD5 0x65 */
4953 "kp-6", /* VK_NUMPAD6 0x66 */
4954 "kp-7", /* VK_NUMPAD7 0x67 */
4955 "kp-8", /* VK_NUMPAD8 0x68 */
4956 "kp-9", /* VK_NUMPAD9 0x69 */
4957 "kp-multiply", /* VK_MULTIPLY 0x6A */
4958 "kp-add", /* VK_ADD 0x6B */
4959 "kp-separator", /* VK_SEPARATOR 0x6C */
4960 "kp-subtract", /* VK_SUBTRACT 0x6D */
4961 "kp-decimal", /* VK_DECIMAL 0x6E */
4962 "kp-divide", /* VK_DIVIDE 0x6F */
4963 "f1", /* VK_F1 0x70 */
4964 "f2", /* VK_F2 0x71 */
4965 "f3", /* VK_F3 0x72 */
4966 "f4", /* VK_F4 0x73 */
4967 "f5", /* VK_F5 0x74 */
4968 "f6", /* VK_F6 0x75 */
4969 "f7", /* VK_F7 0x76 */
4970 "f8", /* VK_F8 0x77 */
4971 "f9", /* VK_F9 0x78 */
4972 "f10", /* VK_F10 0x79 */
4973 "f11", /* VK_F11 0x7A */
4974 "f12", /* VK_F12 0x7B */
4975 "f13", /* VK_F13 0x7C */
4976 "f14", /* VK_F14 0x7D */
4977 "f15", /* VK_F15 0x7E */
4978 "f16", /* VK_F16 0x7F */
4979 "f17", /* VK_F17 0x80 */
4980 "f18", /* VK_F18 0x81 */
4981 "f19", /* VK_F19 0x82 */
4982 "f20", /* VK_F20 0x83 */
4983 "f21", /* VK_F21 0x84 */
4984 "f22", /* VK_F22 0x85 */
4985 "f23", /* VK_F23 0x86 */
4986 "f24", /* VK_F24 0x87 */
4988 0, 0, 0, 0, /* 0x88 .. 0x8B */
4989 0, 0, 0, 0, /* 0x8C .. 0x8F */
4991 "kp-numlock", /* VK_NUMLOCK 0x90 */
4992 "scroll", /* VK_SCROLL 0x91 */
4993 /* Not sure where the following block comes from.
4994 Windows headers have NEC and Fujitsu specific keys in
4995 this block, but nothing generic. */
4996 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4997 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4998 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4999 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
5000 "kp-end", /* VK_NUMPAD_END 0x96 */
5001 "kp-home", /* VK_NUMPAD_HOME 0x97 */
5002 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
5003 "kp-up", /* VK_NUMPAD_UP 0x99 */
5004 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
5005 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
5006 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
5007 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
5009 0, 0, /* 0x9E .. 0x9F */
5012 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5013 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5014 * No other API or message will distinguish left and right keys this way.
5019 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5020 to enable them selectively, and gives access to a few more functions.
5021 See lispy_multimedia_keys below. */
5022 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5023 0, 0, 0, /* 0xAD .. 0xAF Volume */
5024 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5025 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5027 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5028 0, 0, 0, 0, 0, 0, 0, 0, 0,
5030 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5031 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5032 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5035 "ax", /* VK_OEM_AX 0xE1 */
5036 0, /* VK_OEM_102 0xE2 */
5037 "ico-help", /* VK_ICO_HELP 0xE3 */
5038 "ico-00", /* VK_ICO_00 0xE4 */
5039 0, /* VK_PROCESSKEY 0xE5 */
5040 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5041 "packet", /* VK_PACKET 0xE7 */
5043 "reset", /* VK_OEM_RESET 0xE9 */
5044 "jump", /* VK_OEM_JUMP 0xEA */
5045 "oem-pa1", /* VK_OEM_PA1 0xEB */
5046 "oem-pa2", /* VK_OEM_PA2 0xEC */
5047 "oem-pa3", /* VK_OEM_PA3 0xED */
5048 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5049 "cusel", /* VK_OEM_CUSEL 0xEF */
5050 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5051 "finish", /* VK_OEM_FINISH 0xF1 */
5052 "copy", /* VK_OEM_COPY 0xF2 */
5053 "auto", /* VK_OEM_AUTO 0xF3 */
5054 "enlw", /* VK_OEM_ENLW 0xF4 */
5055 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5056 "attn", /* VK_ATTN 0xF6 */
5057 "crsel", /* VK_CRSEL 0xF7 */
5058 "exsel", /* VK_EXSEL 0xF8 */
5059 "ereof", /* VK_EREOF 0xF9 */
5060 "play", /* VK_PLAY 0xFA */
5061 "zoom", /* VK_ZOOM 0xFB */
5062 "noname", /* VK_NONAME 0xFC */
5063 "pa1", /* VK_PA1 0xFD */
5064 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5068 /* Some of these duplicate the "Media keys" on newer keyboards,
5069 but they are delivered to the application in a different way. */
5070 static char *lispy_multimedia_keys
[] =
5078 "browser-favorites",
5115 "toggle-dictate-command",
5121 "media-fast-forward",
5124 "media-channel-down"
5127 #else /* not HAVE_NTGUI */
5129 /* This should be dealt with in XTread_socket now, and that doesn't
5130 depend on the client system having the Kana syms defined. See also
5131 the XK_kana_A case below. */
5134 static char *lispy_kana_keys
[] =
5136 /* X Keysym value */
5137 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5138 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5139 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5140 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5141 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5142 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5143 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5144 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5145 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5146 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5147 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5148 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5149 "kana-i", "kana-u", "kana-e", "kana-o",
5150 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5151 "prolongedsound", "kana-A", "kana-I", "kana-U",
5152 "kana-E", "kana-O", "kana-KA", "kana-KI",
5153 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5154 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5155 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5156 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5157 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5158 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5159 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5160 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5161 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5162 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5163 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5164 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5166 #endif /* XK_kana_A */
5169 #define FUNCTION_KEY_OFFSET 0xff00
5171 /* You'll notice that this table is arranged to be conveniently
5172 indexed by X Windows keysym values. */
5173 static char *lispy_function_keys
[] =
5175 /* X Keysym value */
5177 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5178 "backspace", "tab", "linefeed", "clear",
5180 0, 0, 0, "pause", /* 0xff10...1f */
5181 0, 0, 0, 0, 0, 0, 0, "escape",
5183 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5184 "romaji", "hiragana", "katakana", "hiragana-katakana",
5185 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5186 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5187 "eisu-toggle", /* 0xff30...3f */
5188 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5189 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5191 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5192 "down", "prior", "next", "end",
5193 "begin", 0, 0, 0, 0, 0, 0, 0,
5194 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5205 "break", /* 0xff6b */
5208 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5209 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5210 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5211 0, 0, 0, 0, 0, 0, 0, 0,
5212 "kp-tab", /* 0xff89 */
5214 "kp-enter", /* 0xff8d */
5216 "kp-f1", /* 0xff91 */
5220 "kp-home", /* 0xff95 */
5225 "kp-prior", /* kp-page-up */
5226 "kp-next", /* kp-page-down */
5232 0, 0, 0, 0, 0, 0, 0, 0, 0,
5233 "kp-multiply", /* 0xffaa */
5238 "kp-divide", /* 0xffaf */
5239 "kp-0", /* 0xffb0 */
5240 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5243 "kp-equal", /* 0xffbd */
5244 "f1", /* 0xffbe */ /* IsFunctionKey */
5246 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5247 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5248 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5249 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5250 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5251 0, 0, 0, 0, 0, 0, 0, 0,
5252 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5253 0, 0, 0, 0, 0, 0, 0, "delete"
5256 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5257 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5259 static char *iso_lispy_function_keys
[] =
5261 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5262 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5263 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5264 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5265 "iso-lefttab", /* 0xfe20 */
5266 "iso-move-line-up", "iso-move-line-down",
5267 "iso-partial-line-up", "iso-partial-line-down",
5268 "iso-partial-space-left", "iso-partial-space-right",
5269 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5270 "iso-release-margin-left", "iso-release-margin-right",
5271 "iso-release-both-margins",
5272 "iso-fast-cursor-left", "iso-fast-cursor-right",
5273 "iso-fast-cursor-up", "iso-fast-cursor-down",
5274 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5275 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5278 #endif /* not HAVE_NTGUI */
5280 Lisp_Object Vlispy_mouse_stem
;
5282 static char *lispy_wheel_names
[] =
5284 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5287 /* drag-n-drop events are generated when a set of selected files are
5288 dragged from another application and dropped onto an Emacs window. */
5289 static char *lispy_drag_n_drop_names
[] =
5294 /* Scroll bar parts. */
5295 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5296 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5297 Lisp_Object Qtop
, Qratio
;
5299 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5300 Lisp_Object
*scroll_bar_parts
[] = {
5301 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5302 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5305 /* A vector, indexed by button number, giving the down-going location
5306 of currently depressed buttons, both scroll bar and non-scroll bar.
5308 The elements have the form
5309 (BUTTON-NUMBER MODIFIER-MASK . REST)
5310 where REST is the cdr of a position as it would be reported in the event.
5312 The make_lispy_event function stores positions here to tell the
5313 difference between click and drag events, and to store the starting
5314 location to be included in drag events. */
5316 static Lisp_Object button_down_location
;
5318 /* Information about the most recent up-going button event: Which
5319 button, what location, and what time. */
5321 static int last_mouse_button
;
5322 static int last_mouse_x
;
5323 static int last_mouse_y
;
5324 static unsigned long button_down_time
;
5326 /* The maximum time between clicks to make a double-click, or Qnil to
5327 disable double-click detection, or Qt for no time limit. */
5329 Lisp_Object Vdouble_click_time
;
5331 /* Maximum number of pixels the mouse may be moved between clicks
5332 to make a double-click. */
5334 EMACS_INT double_click_fuzz
;
5336 /* The number of clicks in this multiple-click. */
5338 int double_click_count
;
5340 /* Return position of a mouse click or wheel event */
5343 make_lispy_position (f
, x
, y
, time
)
5349 enum window_part part
;
5350 Lisp_Object posn
= Qnil
;
5351 Lisp_Object extra_info
= Qnil
;
5354 /* Set `window' to the window under frame pixel coordinates (x,y) */
5356 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5357 &part
, &wx
, &wy
, 0);
5361 if (WINDOWP (window
))
5363 /* It's a click in window window at frame coordinates (x,y) */
5364 struct window
*w
= XWINDOW (window
);
5365 Lisp_Object string_info
= Qnil
;
5366 int textpos
= -1, rx
= -1, ry
= -1;
5367 int dx
= -1, dy
= -1;
5368 int width
= -1, height
= -1;
5369 Lisp_Object object
= Qnil
;
5371 /* Set event coordinates to window-relative coordinates
5372 for constructing the Lisp event below. */
5376 if (part
== ON_TEXT
)
5378 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5380 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5382 /* Mode line or header line. Look for a string under
5383 the mouse that may have a `local-map' property. */
5387 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5389 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5390 &object
, &dx
, &dy
, &width
, &height
);
5391 if (STRINGP (string
))
5392 string_info
= Fcons (string
, make_number (charpos
));
5393 if (w
== XWINDOW (selected_window
))
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
);
5572 /* A function key. The symbol may need to have modifier prefixes
5574 case NON_ASCII_KEYSTROKE_EVENT
:
5575 button_down_time
= 0;
5577 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5578 if (event
->code
== lispy_accent_codes
[i
])
5579 return modify_event_symbol (i
,
5581 Qfunction_key
, Qnil
,
5582 lispy_accent_keys
, &accent_key_syms
,
5583 (sizeof (lispy_accent_keys
)
5584 / sizeof (lispy_accent_keys
[0])));
5588 if (event
->code
>= 0x400 && event
->code
< 0x500)
5589 return modify_event_symbol (event
->code
- 0x400,
5590 event
->modifiers
& ~shift_modifier
,
5591 Qfunction_key
, Qnil
,
5592 lispy_kana_keys
, &func_key_syms
,
5593 (sizeof (lispy_kana_keys
)
5594 / sizeof (lispy_kana_keys
[0])));
5595 #endif /* XK_kana_A */
5598 #ifdef ISO_FUNCTION_KEY_OFFSET
5599 if (event
->code
< FUNCTION_KEY_OFFSET
5600 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5601 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5603 Qfunction_key
, Qnil
,
5604 iso_lispy_function_keys
, &func_key_syms
,
5605 (sizeof (iso_lispy_function_keys
)
5606 / sizeof (iso_lispy_function_keys
[0])));
5609 /* Handle system-specific or unknown keysyms. */
5610 if (event
->code
& (1 << 28)
5611 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5612 || (event
->code
- FUNCTION_KEY_OFFSET
5613 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5614 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5616 /* We need to use an alist rather than a vector as the cache
5617 since we can't make a vector long enuf. */
5618 if (NILP (current_kboard
->system_key_syms
))
5619 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5620 return modify_event_symbol (event
->code
,
5623 current_kboard
->Vsystem_key_alist
,
5624 0, ¤t_kboard
->system_key_syms
,
5628 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5630 Qfunction_key
, Qnil
,
5631 lispy_function_keys
, &func_key_syms
,
5632 (sizeof (lispy_function_keys
)
5633 / sizeof (lispy_function_keys
[0])));
5636 case MULTIMEDIA_KEY_EVENT
:
5637 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5638 / sizeof (lispy_multimedia_keys
[0]))
5639 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5641 return modify_event_symbol (event
->code
, event
->modifiers
,
5642 Qfunction_key
, Qnil
,
5643 lispy_multimedia_keys
, &func_key_syms
,
5644 (sizeof (lispy_multimedia_keys
)
5645 / sizeof (lispy_multimedia_keys
[0])));
5651 /* A mouse click. Figure out where it is, decide whether it's
5652 a press, click or drag, and build the appropriate structure. */
5653 case MOUSE_CLICK_EVENT
:
5654 #ifndef USE_TOOLKIT_SCROLL_BARS
5655 case SCROLL_BAR_CLICK_EVENT
:
5658 int button
= event
->code
;
5660 Lisp_Object position
;
5661 Lisp_Object
*start_pos_ptr
;
5662 Lisp_Object start_pos
;
5666 /* Build the position as appropriate for this mouse click. */
5667 if (event
->kind
== MOUSE_CLICK_EVENT
)
5669 struct frame
*f
= XFRAME (event
->frame_or_window
);
5670 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5674 /* Ignore mouse events that were made on frame that
5675 have been deleted. */
5676 if (! FRAME_LIVE_P (f
))
5679 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5680 /* EVENT->x and EVENT->y are frame-relative pixel
5681 coordinates at this place. Under old redisplay, COLUMN
5682 and ROW are set to frame relative glyph coordinates
5683 which are then used to determine whether this click is
5684 in a menu (non-toolkit version). */
5685 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5686 &column
, &row
, NULL
, 1);
5688 /* In the non-toolkit version, clicks on the menu bar
5689 are ordinary button events in the event buffer.
5690 Distinguish them, and invoke the menu.
5692 (In the toolkit version, the toolkit handles the menu bar
5693 and Emacs doesn't know about it until after the user
5694 makes a selection.) */
5695 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5696 && (event
->modifiers
& down_modifier
))
5698 Lisp_Object items
, item
;
5703 /* Activate the menu bar on the down event. If the
5704 up event comes in before the menu code can deal with it,
5706 if (! (event
->modifiers
& down_modifier
))
5710 /* Find the menu bar item under `column'. */
5712 items
= FRAME_MENU_BAR_ITEMS (f
);
5713 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5715 Lisp_Object pos
, string
;
5716 string
= AREF (items
, i
+ 1);
5717 pos
= AREF (items
, i
+ 3);
5720 if (column
>= XINT (pos
)
5721 && column
< XINT (pos
) + SCHARS (string
))
5723 item
= AREF (items
, i
);
5728 /* ELisp manual 2.4b says (x y) are window relative but
5729 code says they are frame-relative. */
5731 = Fcons (event
->frame_or_window
,
5733 Fcons (Fcons (event
->x
, event
->y
),
5734 Fcons (make_number (event
->timestamp
),
5737 return Fcons (item
, Fcons (position
, Qnil
));
5739 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5741 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5744 #ifndef USE_TOOLKIT_SCROLL_BARS
5747 /* It's a scrollbar click. */
5749 Lisp_Object portion_whole
;
5752 window
= event
->frame_or_window
;
5753 portion_whole
= Fcons (event
->x
, event
->y
);
5754 part
= *scroll_bar_parts
[(int) event
->part
];
5758 Fcons (Qvertical_scroll_bar
,
5759 Fcons (portion_whole
,
5760 Fcons (make_number (event
->timestamp
),
5761 Fcons (part
, Qnil
)))));
5763 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5765 if (button
>= ASIZE (button_down_location
))
5767 button_down_location
= larger_vector (button_down_location
,
5769 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5772 start_pos_ptr
= &AREF (button_down_location
, button
);
5773 start_pos
= *start_pos_ptr
;
5774 *start_pos_ptr
= Qnil
;
5777 /* On window-system frames, use the value of
5778 double-click-fuzz as is. On other frames, interpret it
5779 as a multiple of 1/8 characters. */
5783 if (WINDOWP (event
->frame_or_window
))
5784 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5785 else if (FRAMEP (event
->frame_or_window
))
5786 f
= XFRAME (event
->frame_or_window
);
5790 if (FRAME_WINDOW_P (f
))
5791 fuzz
= double_click_fuzz
;
5793 fuzz
= double_click_fuzz
/ 8;
5795 is_double
= (button
== last_mouse_button
5796 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5797 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5798 && button_down_time
!= 0
5799 && (EQ (Vdouble_click_time
, Qt
)
5800 || (INTEGERP (Vdouble_click_time
)
5801 && ((int)(event
->timestamp
- button_down_time
)
5802 < XINT (Vdouble_click_time
)))));
5805 last_mouse_button
= button
;
5806 last_mouse_x
= XINT (event
->x
);
5807 last_mouse_y
= XINT (event
->y
);
5809 /* If this is a button press, squirrel away the location, so
5810 we can decide later whether it was a click or a drag. */
5811 if (event
->modifiers
& down_modifier
)
5815 double_click_count
++;
5816 event
->modifiers
|= ((double_click_count
> 2)
5821 double_click_count
= 1;
5822 button_down_time
= event
->timestamp
;
5823 *start_pos_ptr
= Fcopy_alist (position
);
5824 ignore_mouse_drag_p
= 0;
5827 /* Now we're releasing a button - check the co-ordinates to
5828 see if this was a click or a drag. */
5829 else if (event
->modifiers
& up_modifier
)
5831 /* If we did not see a down before this up, ignore the up.
5832 Probably this happened because the down event chose a
5833 menu item. It would be an annoyance to treat the
5834 release of the button that chose the menu item as a
5837 if (!CONSP (start_pos
))
5840 event
->modifiers
&= ~up_modifier
;
5841 #if 0 /* Formerly we treated an up with no down as a click event. */
5842 if (!CONSP (start_pos
))
5843 event
->modifiers
|= click_modifier
;
5848 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5850 /* The third element of every position
5851 should be the (x,y) pair. */
5852 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5854 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5856 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5857 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5860 if (ignore_mouse_drag_p
)
5862 event
->modifiers
|= click_modifier
;
5863 ignore_mouse_drag_p
= 0;
5865 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5866 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5867 /* Maybe the mouse has moved a lot, caused scrolling, and
5868 eventually ended up at the same screen position (but
5869 not buffer position) in which case it is a drag, not
5871 /* FIXME: OTOH if the buffer position has changed
5872 because of a timer or process filter rather than
5873 because of mouse movement, it should be considered as
5874 a click. But mouse-drag-region completely ignores
5875 this case and it hasn't caused any real problem, so
5876 it's probably OK to ignore it as well. */
5877 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5878 /* Mouse hasn't moved (much). */
5879 event
->modifiers
|= click_modifier
;
5882 button_down_time
= 0;
5883 event
->modifiers
|= drag_modifier
;
5886 /* Don't check is_double; treat this as multiple
5887 if the down-event was multiple. */
5888 if (double_click_count
> 1)
5889 event
->modifiers
|= ((double_click_count
> 2)
5895 /* Every mouse event should either have the down_modifier or
5896 the up_modifier set. */
5900 /* Get the symbol we should use for the mouse click. */
5903 head
= modify_event_symbol (button
,
5905 Qmouse_click
, Vlispy_mouse_stem
,
5908 XVECTOR (mouse_syms
)->size
);
5909 if (event
->modifiers
& drag_modifier
)
5914 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5917 Fcons (make_number (double_click_count
),
5927 case HORIZ_WHEEL_EVENT
:
5929 Lisp_Object position
;
5932 /* Build the position as appropriate for this mouse click. */
5933 struct frame
*f
= XFRAME (event
->frame_or_window
);
5935 /* Ignore wheel events that were made on frame that have been
5937 if (! FRAME_LIVE_P (f
))
5940 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5943 /* Set double or triple modifiers to indicate the wheel speed. */
5945 /* On window-system frames, use the value of
5946 double-click-fuzz as is. On other frames, interpret it
5947 as a multiple of 1/8 characters. */
5952 if (WINDOWP (event
->frame_or_window
))
5953 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5954 else if (FRAMEP (event
->frame_or_window
))
5955 f
= XFRAME (event
->frame_or_window
);
5959 if (FRAME_WINDOW_P (f
))
5960 fuzz
= double_click_fuzz
;
5962 fuzz
= double_click_fuzz
/ 8;
5964 is_double
= (last_mouse_button
< 0
5965 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5966 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5967 && button_down_time
!= 0
5968 && (EQ (Vdouble_click_time
, Qt
)
5969 || (INTEGERP (Vdouble_click_time
)
5970 && ((int)(event
->timestamp
- button_down_time
)
5971 < XINT (Vdouble_click_time
)))));
5974 double_click_count
++;
5975 event
->modifiers
|= ((double_click_count
> 2)
5981 double_click_count
= 1;
5982 event
->modifiers
|= click_modifier
;
5985 button_down_time
= event
->timestamp
;
5986 /* Use a negative value to distinguish wheel from mouse button. */
5987 last_mouse_button
= -1;
5988 last_mouse_x
= XINT (event
->x
);
5989 last_mouse_y
= XINT (event
->y
);
5995 if (event
->modifiers
& up_modifier
)
5997 /* Emit a wheel-up event. */
5998 event
->modifiers
&= ~up_modifier
;
6001 else if (event
->modifiers
& down_modifier
)
6003 /* Emit a wheel-down event. */
6004 event
->modifiers
&= ~down_modifier
;
6008 /* Every wheel event should either have the down_modifier or
6009 the up_modifier set. */
6012 if (event
->kind
== HORIZ_WHEEL_EVENT
)
6015 /* Get the symbol we should use for the wheel event. */
6016 head
= modify_event_symbol (symbol_num
,
6022 ASIZE (wheel_syms
));
6025 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6028 Fcons (make_number (double_click_count
),
6037 #ifdef USE_TOOLKIT_SCROLL_BARS
6039 /* We don't have down and up events if using toolkit scroll bars,
6040 so make this always a click event. Store in the `part' of
6041 the Lisp event a symbol which maps to the following actions:
6043 `above_handle' page up
6044 `below_handle' page down
6048 `bottom' bottom of buffer
6049 `handle' thumb has been dragged.
6050 `end-scroll' end of interaction with scroll bar
6052 The incoming input_event contains in its `part' member an
6053 index of type `enum scroll_bar_part' which we can use as an
6054 index in scroll_bar_parts to get the appropriate symbol. */
6056 case SCROLL_BAR_CLICK_EVENT
:
6058 Lisp_Object position
, head
, window
, portion_whole
, part
;
6060 window
= event
->frame_or_window
;
6061 portion_whole
= Fcons (event
->x
, event
->y
);
6062 part
= *scroll_bar_parts
[(int) event
->part
];
6066 Fcons (Qvertical_scroll_bar
,
6067 Fcons (portion_whole
,
6068 Fcons (make_number (event
->timestamp
),
6069 Fcons (part
, Qnil
)))));
6071 /* Always treat scroll bar events as clicks. */
6072 event
->modifiers
|= click_modifier
;
6073 event
->modifiers
&= ~up_modifier
;
6075 if (event
->code
>= ASIZE (mouse_syms
))
6076 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6078 /* Get the symbol we should use for the mouse click. */
6079 head
= modify_event_symbol (event
->code
,
6084 XVECTOR (mouse_syms
)->size
);
6085 return Fcons (head
, Fcons (position
, Qnil
));
6088 #endif /* USE_TOOLKIT_SCROLL_BARS */
6090 case DRAG_N_DROP_EVENT
:
6093 Lisp_Object head
, position
;
6096 f
= XFRAME (event
->frame_or_window
);
6099 /* Ignore mouse events that were made on frames that
6100 have been deleted. */
6101 if (! FRAME_LIVE_P (f
))
6104 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6107 head
= modify_event_symbol (0, event
->modifiers
,
6109 lispy_drag_n_drop_names
,
6110 &drag_n_drop_syms
, 1);
6116 #endif /* HAVE_MOUSE */
6118 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
6119 || defined (USE_GTK)
6120 case MENU_BAR_EVENT
:
6121 if (EQ (event
->arg
, event
->frame_or_window
))
6122 /* This is the prefix key. We translate this to
6123 `(menu_bar)' because the code in keyboard.c for menu
6124 events, which we use, relies on this. */
6125 return Fcons (Qmenu_bar
, Qnil
);
6129 case SELECT_WINDOW_EVENT
:
6130 /* Make an event (select-window (WINDOW)). */
6131 return Fcons (Qselect_window
,
6132 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6135 case TOOL_BAR_EVENT
:
6136 if (EQ (event
->arg
, event
->frame_or_window
))
6137 /* This is the prefix key. We translate this to
6138 `(tool_bar)' because the code in keyboard.c for tool bar
6139 events, which we use, relies on this. */
6140 return Fcons (Qtool_bar
, Qnil
);
6141 else if (SYMBOLP (event
->arg
))
6142 return apply_modifiers (event
->modifiers
, event
->arg
);
6145 case USER_SIGNAL_EVENT
:
6146 /* A user signal. */
6148 char *name
= find_user_signal_name (event
->code
);
6151 return intern (name
);
6154 case SAVE_SESSION_EVENT
:
6155 return Qsave_session
;
6158 case MAC_APPLE_EVENT
:
6160 Lisp_Object spec
[2];
6164 return Fcons (Qmac_apple_event
,
6165 Fcons (Fvector (2, spec
),
6166 Fcons (event
->arg
, Qnil
)));
6173 return Fcons (Qdbus_event
, event
->arg
);
6175 #endif /* HAVE_DBUS */
6178 case GPM_CLICK_EVENT
:
6180 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6181 Lisp_Object head
, position
;
6182 Lisp_Object
*start_pos_ptr
;
6183 Lisp_Object start_pos
;
6184 int button
= event
->code
;
6186 if (button
>= ASIZE (button_down_location
))
6188 button_down_location
= larger_vector (button_down_location
,
6190 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6193 start_pos_ptr
= &AREF (button_down_location
, button
);
6194 start_pos
= *start_pos_ptr
;
6196 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6199 if (event
->modifiers
& down_modifier
)
6200 *start_pos_ptr
= Fcopy_alist (position
);
6201 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6203 if (!CONSP (start_pos
))
6205 event
->modifiers
&= ~up_modifier
;
6208 head
= modify_event_symbol (button
,
6210 Qmouse_click
, Vlispy_mouse_stem
,
6213 XVECTOR (mouse_syms
)->size
);
6215 if (event
->modifiers
& drag_modifier
)
6220 else if (event
->modifiers
& double_modifier
)
6223 Fcons (make_number (2),
6225 else if (event
->modifiers
& triple_modifier
)
6228 Fcons (make_number (3),
6235 #endif /* HAVE_GPM */
6237 /* The 'kind' field of the event is something we don't recognize. */
6243 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6246 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6248 Lisp_Object bar_window
;
6249 enum scroll_bar_part part
;
6253 /* Is it a scroll bar movement? */
6254 if (frame
&& ! NILP (bar_window
))
6256 Lisp_Object part_sym
;
6258 part_sym
= *scroll_bar_parts
[(int) part
];
6259 return Fcons (Qscroll_bar_movement
,
6260 (Fcons (Fcons (bar_window
,
6261 Fcons (Qvertical_scroll_bar
,
6262 Fcons (Fcons (x
, y
),
6263 Fcons (make_number (time
),
6269 /* Or is it an ordinary mouse movement? */
6272 Lisp_Object position
;
6274 position
= make_lispy_position (frame
, &x
, &y
, time
);
6276 return Fcons (Qmouse_movement
,
6282 #endif /* HAVE_MOUSE || HAVE GPM */
6284 /* Construct a switch frame event. */
6286 make_lispy_switch_frame (frame
)
6289 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6292 /* Manipulating modifiers. */
6294 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6296 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6297 SYMBOL's name of the end of the modifiers; the string from this
6298 position is the unmodified symbol name.
6300 This doesn't use any caches. */
6303 parse_modifiers_uncached (symbol
, modifier_end
)
6311 CHECK_SYMBOL (symbol
);
6314 name
= SYMBOL_NAME (symbol
);
6316 for (i
= 0; i
+2 <= SBYTES (name
); )
6318 int this_mod_end
= 0;
6321 /* See if the name continues with a modifier word.
6322 Check that the word appears, but don't check what follows it.
6323 Set this_mod and this_mod_end to record what we find. */
6325 switch (SREF (name
, i
))
6327 #define SINGLE_LETTER_MOD(BIT) \
6328 (this_mod_end = i + 1, this_mod = BIT)
6331 SINGLE_LETTER_MOD (alt_modifier
);
6335 SINGLE_LETTER_MOD (ctrl_modifier
);
6339 SINGLE_LETTER_MOD (hyper_modifier
);
6343 SINGLE_LETTER_MOD (meta_modifier
);
6347 SINGLE_LETTER_MOD (shift_modifier
);
6351 SINGLE_LETTER_MOD (super_modifier
);
6354 #undef SINGLE_LETTER_MOD
6356 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6357 if (i + LEN + 1 <= SBYTES (name) \
6358 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6360 this_mod_end = i + LEN; \
6365 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6366 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6367 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6371 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6373 #undef MULTI_LETTER_MOD
6377 /* If we found no modifier, stop looking for them. */
6378 if (this_mod_end
== 0)
6381 /* Check there is a dash after the modifier, so that it
6382 really is a modifier. */
6383 if (this_mod_end
>= SBYTES (name
)
6384 || SREF (name
, this_mod_end
) != '-')
6387 /* This modifier is real; look for another. */
6388 modifiers
|= this_mod
;
6389 i
= this_mod_end
+ 1;
6392 /* Should we include the `click' modifier? */
6393 if (! (modifiers
& (down_modifier
| drag_modifier
6394 | double_modifier
| triple_modifier
))
6395 && i
+ 7 == SBYTES (name
)
6396 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6397 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6398 modifiers
|= click_modifier
;
6406 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6407 prepended to the string BASE[0..BASE_LEN-1].
6408 This doesn't use any caches. */
6410 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6413 int base_len
, base_len_byte
;
6415 /* Since BASE could contain nulls, we can't use intern here; we have
6416 to use Fintern, which expects a genuine Lisp_String, and keeps a
6419 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6425 /* Only the event queue may use the `up' modifier; it should always
6426 be turned into a click or drag event before presented to lisp code. */
6427 if (modifiers
& up_modifier
)
6430 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6431 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6432 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6433 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6434 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6435 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6436 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6437 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6438 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6439 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6440 /* The click modifier is denoted by the absence of other modifiers. */
6444 mod_len
= p
- new_mods
;
6448 Lisp_Object new_name
;
6450 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6451 mod_len
+ base_len_byte
);
6452 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6453 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6455 return Fintern (new_name
, Qnil
);
6460 static char *modifier_names
[] =
6462 "up", "down", "drag", "click", "double", "triple", 0, 0,
6463 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6464 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6466 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6468 static Lisp_Object modifier_symbols
;
6470 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6472 lispy_modifier_list (modifiers
)
6475 Lisp_Object modifier_list
;
6478 modifier_list
= Qnil
;
6479 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6480 if (modifiers
& (1<<i
))
6481 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6484 return modifier_list
;
6488 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6489 where UNMODIFIED is the unmodified form of SYMBOL,
6490 MASK is the set of modifiers present in SYMBOL's name.
6491 This is similar to parse_modifiers_uncached, but uses the cache in
6492 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6493 Qevent_symbol_elements property. */
6495 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6498 parse_modifiers (symbol
)
6501 Lisp_Object elements
;
6503 if (INTEGERP (symbol
))
6504 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6505 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6507 else if (!SYMBOLP (symbol
))
6510 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6511 if (CONSP (elements
))
6516 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6517 Lisp_Object unmodified
;
6520 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6521 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6524 if (modifiers
& ~INTMASK
)
6526 XSETFASTINT (mask
, modifiers
);
6527 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6529 /* Cache the parsing results on SYMBOL. */
6530 Fput (symbol
, Qevent_symbol_element_mask
,
6532 Fput (symbol
, Qevent_symbol_elements
,
6533 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6535 /* Since we know that SYMBOL is modifiers applied to unmodified,
6536 it would be nice to put that in unmodified's cache.
6537 But we can't, since we're not sure that parse_modifiers is
6544 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6545 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6546 doc
: /* Parse the event symbol. For internal use. */)
6550 /* Fill the cache if needed. */
6551 parse_modifiers (symbol
);
6552 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6553 and use the Lispier representation stored on Qevent_symbol_elements
6555 return Fget (symbol
, Qevent_symbol_elements
);
6558 /* Apply the modifiers MODIFIERS to the symbol BASE.
6559 BASE must be unmodified.
6561 This is like apply_modifiers_uncached, but uses BASE's
6562 Qmodifier_cache property, if present. It also builds
6563 Qevent_symbol_elements properties, since it has that info anyway.
6565 apply_modifiers copies the value of BASE's Qevent_kind property to
6566 the modified symbol. */
6568 apply_modifiers (modifiers
, base
)
6572 Lisp_Object cache
, index
, entry
, new_symbol
;
6574 /* Mask out upper bits. We don't know where this value's been. */
6575 modifiers
&= INTMASK
;
6577 if (INTEGERP (base
))
6578 return make_number (XINT (base
) | modifiers
);
6580 /* The click modifier never figures into cache indices. */
6581 cache
= Fget (base
, Qmodifier_cache
);
6582 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6583 entry
= assq_no_quit (index
, cache
);
6586 new_symbol
= XCDR (entry
);
6589 /* We have to create the symbol ourselves. */
6590 new_symbol
= apply_modifiers_uncached (modifiers
,
6591 SDATA (SYMBOL_NAME (base
)),
6592 SCHARS (SYMBOL_NAME (base
)),
6593 SBYTES (SYMBOL_NAME (base
)));
6595 /* Add the new symbol to the base's cache. */
6596 entry
= Fcons (index
, new_symbol
);
6597 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6599 /* We have the parsing info now for free, so we could add it to
6601 XSETFASTINT (index, modifiers);
6602 Fput (new_symbol, Qevent_symbol_element_mask,
6603 Fcons (base, Fcons (index, Qnil)));
6604 Fput (new_symbol, Qevent_symbol_elements,
6605 Fcons (base, lispy_modifier_list (modifiers)));
6606 Sadly, this is only correct if `base' is indeed a base event,
6607 which is not necessarily the case. -stef */
6610 /* Make sure this symbol is of the same kind as BASE.
6612 You'd think we could just set this once and for all when we
6613 intern the symbol above, but reorder_modifiers may call us when
6614 BASE's property isn't set right; we can't assume that just
6615 because it has a Qmodifier_cache property it must have its
6616 Qevent_kind set right as well. */
6617 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6621 kind
= Fget (base
, Qevent_kind
);
6623 Fput (new_symbol
, Qevent_kind
, kind
);
6630 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6631 return a symbol with the modifiers placed in the canonical order.
6632 Canonical order is alphabetical, except for down and drag, which
6633 always come last. The 'click' modifier is never written out.
6635 Fdefine_key calls this to make sure that (for example) C-M-foo
6636 and M-C-foo end up being equivalent in the keymap. */
6639 reorder_modifiers (symbol
)
6642 /* It's hopefully okay to write the code this way, since everything
6643 will soon be in caches, and no consing will be done at all. */
6646 parsed
= parse_modifiers (symbol
);
6647 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6652 /* For handling events, we often want to produce a symbol whose name
6653 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6654 to some base, like the name of a function key or mouse button.
6655 modify_event_symbol produces symbols of this sort.
6657 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6658 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6661 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6662 into symbol names, or a string specifying a name stem used to
6663 construct a symbol name or the form `STEM-N', where N is the decimal
6664 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6665 non-nil; otherwise NAME_TABLE is used.
6667 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6668 persist between calls to modify_event_symbol that it can use to
6669 store a cache of the symbols it's generated for this NAME_TABLE
6670 before. The object stored there may be a vector or an alist.
6672 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6674 MODIFIERS is a set of modifier bits (as given in struct input_events)
6675 whose prefixes should be applied to the symbol name.
6677 SYMBOL_KIND is the value to be placed in the event_kind property of
6678 the returned symbol.
6680 The symbols we create are supposed to have an
6681 `event-symbol-elements' property, which lists the modifiers present
6682 in the symbol's name. */
6685 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6686 name_table
, symbol_table
, table_size
)
6689 Lisp_Object symbol_kind
;
6690 Lisp_Object name_alist_or_stem
;
6692 Lisp_Object
*symbol_table
;
6693 unsigned int table_size
;
6696 Lisp_Object symbol_int
;
6698 /* Get rid of the "vendor-specific" bit here. */
6699 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6701 /* Is this a request for a valid symbol? */
6702 if (symbol_num
< 0 || symbol_num
>= table_size
)
6705 if (CONSP (*symbol_table
))
6706 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6708 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6709 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6710 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6711 we've never used that symbol before. */
6714 if (! VECTORP (*symbol_table
)
6715 || XVECTOR (*symbol_table
)->size
!= table_size
)
6719 XSETFASTINT (size
, table_size
);
6720 *symbol_table
= Fmake_vector (size
, Qnil
);
6723 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6726 /* Have we already used this symbol before? */
6729 /* No; let's create it. */
6730 if (CONSP (name_alist_or_stem
))
6731 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6732 else if (STRINGP (name_alist_or_stem
))
6734 int len
= SBYTES (name_alist_or_stem
);
6735 char *buf
= (char *) alloca (len
+ 50);
6736 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6737 (long) XINT (symbol_int
) + 1);
6738 value
= intern (buf
);
6740 else if (name_table
!= 0 && name_table
[symbol_num
])
6741 value
= intern (name_table
[symbol_num
]);
6743 #ifdef HAVE_WINDOW_SYSTEM
6746 char *name
= x_get_keysym_name (symbol_num
);
6748 value
= intern (name
);
6755 sprintf (buf
, "key-%d", symbol_num
);
6756 value
= intern (buf
);
6759 if (CONSP (*symbol_table
))
6760 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6762 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6764 /* Fill in the cache entries for this symbol; this also
6765 builds the Qevent_symbol_elements property, which the user
6767 apply_modifiers (modifiers
& click_modifier
, value
);
6768 Fput (value
, Qevent_kind
, symbol_kind
);
6771 /* Apply modifiers to that symbol. */
6772 return apply_modifiers (modifiers
, value
);
6775 /* Convert a list that represents an event type,
6776 such as (ctrl meta backspace), into the usual representation of that
6777 event type as a number or a symbol. */
6779 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6780 doc
: /* Convert the event description list EVENT-DESC to an event type.
6781 EVENT-DESC should contain one base event type (a character or symbol)
6782 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6783 drag, down, double or triple). The base must be last.
6784 The return value is an event type (a character or symbol) which
6785 has the same base event type and all the specified modifiers. */)
6787 Lisp_Object event_desc
;
6795 while (CONSP (rest
))
6803 /* Given a symbol, see if it is a modifier name. */
6804 if (SYMBOLP (elt
) && CONSP (rest
))
6805 this = parse_solitary_modifier (elt
);
6809 else if (!NILP (base
))
6810 error ("Two bases given in one event");
6816 /* Let the symbol A refer to the character A. */
6817 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6818 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6820 if (INTEGERP (base
))
6822 /* Turn (shift a) into A. */
6823 if ((modifiers
& shift_modifier
) != 0
6824 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6826 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6827 modifiers
&= ~shift_modifier
;
6830 /* Turn (control a) into C-a. */
6831 if (modifiers
& ctrl_modifier
)
6832 return make_number ((modifiers
& ~ctrl_modifier
)
6833 | make_ctrl_char (XINT (base
)));
6835 return make_number (modifiers
| XINT (base
));
6837 else if (SYMBOLP (base
))
6838 return apply_modifiers (modifiers
, base
);
6841 error ("Invalid base event");
6846 /* Try to recognize SYMBOL as a modifier name.
6847 Return the modifier flag bit, or 0 if not recognized. */
6850 parse_solitary_modifier (symbol
)
6853 Lisp_Object name
= SYMBOL_NAME (symbol
);
6855 switch (SREF (name
, 0))
6857 #define SINGLE_LETTER_MOD(BIT) \
6858 if (SBYTES (name) == 1) \
6861 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6862 if (LEN == SBYTES (name) \
6863 && ! strncmp (SDATA (name), NAME, LEN)) \
6867 SINGLE_LETTER_MOD (alt_modifier
);
6871 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6875 SINGLE_LETTER_MOD (ctrl_modifier
);
6879 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6880 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6884 SINGLE_LETTER_MOD (hyper_modifier
);
6888 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6892 SINGLE_LETTER_MOD (meta_modifier
);
6896 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6900 SINGLE_LETTER_MOD (shift_modifier
);
6904 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6905 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6906 SINGLE_LETTER_MOD (super_modifier
);
6910 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6911 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6912 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6916 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6919 #undef SINGLE_LETTER_MOD
6920 #undef MULTI_LETTER_MOD
6926 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6927 Such a list is not valid as an event,
6928 but it can be a Lucid-style event type list. */
6931 lucid_event_type_list_p (object
)
6936 if (! CONSP (object
))
6939 if (EQ (XCAR (object
), Qhelp_echo
)
6940 || EQ (XCAR (object
), Qvertical_line
)
6941 || EQ (XCAR (object
), Qmode_line
)
6942 || EQ (XCAR (object
), Qheader_line
))
6945 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6949 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6956 /* Store into *addr a value nonzero if terminal input chars are available.
6957 Serves the purpose of ioctl (0, FIONREAD, addr)
6958 but works even if FIONREAD does not exist.
6959 (In fact, this may actually read some input.)
6961 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6962 timer events that are ripe.
6963 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6964 events (FOCUS_IN_EVENT).
6965 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6966 movements and toolkit scroll bar thumb drags. */
6969 get_input_pending (addr
, flags
)
6973 /* First of all, have we already counted some input? */
6974 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6976 /* If input is being read as it arrives, and we have none, there is none. */
6977 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6980 /* Try to read some input and see how much we get. */
6982 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6985 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6988 gobble_input (expected
)
6992 /* Check whether a D-Bus message has arrived. */
6993 xd_read_queued_messages ();
6994 #endif /* HAVE_DBUS */
6998 if (interrupt_input
)
7001 mask
= sigblock (sigmask (SIGIO
));
7002 read_avail_input (expected
);
7006 #ifdef POLL_FOR_INPUT
7007 /* XXX This condition was (read_socket_hook && !interrupt_input),
7008 but read_socket_hook is not global anymore. Let's pretend that
7010 if (!interrupt_input
&& poll_suppress_count
== 0)
7013 mask
= sigblock (sigmask (SIGALRM
));
7014 read_avail_input (expected
);
7020 read_avail_input (expected
);
7024 /* Put a BUFFER_SWITCH_EVENT in the buffer
7025 so that read_key_sequence will notice the new current buffer. */
7028 record_asynch_buffer_change ()
7030 struct input_event event
;
7034 event
.kind
= BUFFER_SWITCH_EVENT
;
7035 event
.frame_or_window
= Qnil
;
7039 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7040 The purpose of the event is to make read_key_sequence look up the
7041 keymaps again. If we aren't in read_key_sequence, we don't need one,
7042 and the event could cause trouble by messing up (input-pending-p). */
7043 tem
= Fwaiting_for_user_input_p ();
7047 /* We never need these events if we have no asynchronous subprocesses. */
7051 /* Make sure no interrupt happens while storing the event. */
7053 if (interrupt_input
)
7056 mask
= sigblock (sigmask (SIGIO
));
7057 kbd_buffer_store_event (&event
);
7064 kbd_buffer_store_event (&event
);
7071 /* Read any terminal input already buffered up by the system
7072 into the kbd_buffer, but do not wait.
7074 EXPECTED should be nonzero if the caller knows there is some input.
7076 Except on VMS, all input is read by this function.
7077 If interrupt_input is nonzero, this function MUST be called
7078 only when SIGIO is blocked.
7080 Returns the number of keyboard chars read, or -1 meaning
7081 this is a bad time to try to read input. */
7084 read_avail_input (expected
)
7091 /* Store pending user signal events, if any. */
7092 if (store_user_signal_events ())
7095 /* Loop through the available terminals, and call their input hooks. */
7099 struct terminal
*next
= t
->next_terminal
;
7101 if (t
->read_socket_hook
)
7104 struct input_event hold_quit
;
7106 EVENT_INIT (hold_quit
);
7107 hold_quit
.kind
= NO_EVENT
;
7109 /* No need for FIONREAD or fcntl; just say don't wait. */
7110 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7116 if (nr
== -1) /* Not OK to read input now. */
7120 else if (nr
== -2) /* Non-transient error. */
7122 /* The terminal device terminated; it should be closed. */
7124 /* Kill Emacs if this was our last terminal. */
7125 if (!terminal_list
->next_terminal
)
7126 /* Formerly simply reported no input, but that
7127 sometimes led to a failure of Emacs to terminate.
7128 SIGHUP seems appropriate if we can't reach the
7130 /* ??? Is it really right to send the signal just to
7131 this process rather than to the whole process
7132 group? Perhaps on systems with FIONREAD Emacs is
7133 alone in its group. */
7134 kill (getpid (), SIGHUP
);
7136 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
7137 if (t
->delete_terminal_hook
)
7138 (*t
->delete_terminal_hook
) (t
);
7140 delete_terminal (t
);
7143 if (hold_quit
.kind
!= NO_EVENT
)
7144 kbd_buffer_store_event (&hold_quit
);
7156 /* This is the tty way of reading available input.
7158 Note that each terminal device has its own `struct terminal' object,
7159 and so this function is called once for each individual termcap
7160 terminal. The first parameter indicates which terminal to read from. */
7163 tty_read_avail_input (struct terminal
*terminal
,
7165 struct input_event
*hold_quit
)
7167 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7168 the kbd_buffer can really hold. That may prevent loss
7169 of characters on some systems when input is stuffed at us. */
7170 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7172 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7175 if (!terminal
->name
) /* Don't read from a dead terminal. */
7178 if (terminal
->type
!= output_termcap
)
7181 /* XXX I think the following code should be moved to separate hook
7182 functions in system-dependent files. */
7185 #else /* not WINDOWSNT */
7187 n_to_read
= dos_keysns ();
7191 cbuf
[0] = dos_keyread ();
7194 #else /* not MSDOS */
7196 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7200 return 0; /* The terminal is suspended. */
7206 struct input_event hold_quit
;
7209 EVENT_INIT (hold_quit
);
7210 hold_quit
.kind
= NO_EVENT
;
7212 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7213 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7215 if (hold_quit
.kind
!= NO_EVENT
)
7216 kbd_buffer_store_event (&hold_quit
);
7220 #endif /* HAVE_GPM */
7222 /* Determine how many characters we should *try* to read. */
7224 /* Find out how much input is available. */
7225 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7227 if (! noninteractive
)
7228 return -2; /* Close this terminal. */
7234 if (n_to_read
> sizeof cbuf
)
7235 n_to_read
= sizeof cbuf
;
7236 #else /* no FIONREAD */
7237 #if defined (USG) || defined(CYGWIN)
7238 /* Read some input if available, but don't wait. */
7239 n_to_read
= sizeof cbuf
;
7240 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7246 /* Now read; for one reason or another, this will not block.
7247 NREAD is set to the number of chars read. */
7250 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7251 /* POSIX infers that processes which are not in the session leader's
7252 process group won't get SIGHUP's at logout time. BSDI adheres to
7253 this part standard and returns -1 from read (0) with errno==EIO
7254 when the control tty is taken away.
7255 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7256 if (nread
== -1 && errno
== EIO
)
7257 return -2; /* Close this terminal. */
7258 #if defined (AIX) && defined (_BSD)
7259 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7260 This looks incorrect, but it isn't, because _BSD causes
7261 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7262 and that causes a value other than 0 when there is no input. */
7264 return -2; /* Close this terminal. */
7268 /* We used to retry the read if it was interrupted.
7269 But this does the wrong thing when O_NDELAY causes
7270 an EAGAIN error. Does anybody know of a situation
7271 where a retry is actually needed? */
7273 nread
< 0 && (errno
== EAGAIN
7287 #if defined (USG) || defined (CYGWIN)
7288 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7289 #endif /* USG or CYGWIN */
7290 #endif /* no FIONREAD */
7295 #endif /* not MSDOS */
7296 #endif /* not WINDOWSNT */
7298 for (i
= 0; i
< nread
; i
++)
7300 struct input_event buf
;
7302 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7304 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7305 buf
.modifiers
= meta_modifier
;
7306 if (tty
->meta_key
!= 2)
7310 /* Set the frame corresponding to the active tty. Note that the
7311 value of selected_frame is not reliable here, redisplay tends
7312 to temporarily change it. */
7313 buf
.frame_or_window
= tty
->top_frame
;
7316 kbd_buffer_store_event (&buf
);
7317 /* Don't look at input that follows a C-g too closely.
7318 This reduces lossage due to autorepeat on C-g. */
7319 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7320 && buf
.code
== quit_char
)
7326 #endif /* not VMS */
7329 handle_async_input ()
7332 extern int select_alarmed
;
7335 interrupt_input_pending
= 0;
7340 nread
= read_avail_input (1);
7341 /* -1 means it's not ok to read the input now.
7342 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7343 0 means there was no keyboard input available. */
7348 select_alarmed
= 1; /* Force the select emulator back to life */
7353 #ifdef SIGIO /* for entire page */
7354 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7357 input_available_signal (signo
)
7360 /* Must preserve main program's value of errno. */
7361 int old_errno
= errno
;
7362 #if defined (USG) && !defined (POSIX_SIGNALS)
7363 /* USG systems forget handlers when they are used;
7364 must reestablish each time */
7365 signal (signo
, input_available_signal
);
7373 interrupt_input_pending
= 1;
7375 SIGNAL_THREAD_CHECK (signo
);
7378 if (input_available_clear_time
)
7379 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7382 handle_async_input ();
7392 /* Send ourselves a SIGIO.
7394 This function exists so that the UNBLOCK_INPUT macro in
7395 blockinput.h can have some way to take care of input we put off
7396 dealing with, without assuming that every file which uses
7397 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7399 reinvoke_input_signal ()
7402 handle_async_input ();
7408 /* User signal events. */
7410 struct user_signal_info
7412 /* Signal number. */
7415 /* Name of the signal. */
7418 /* Number of pending signals. */
7421 struct user_signal_info
*next
;
7424 /* List of user signals. */
7425 static struct user_signal_info
*user_signals
= NULL
;
7428 add_user_signal (sig
, name
)
7432 struct user_signal_info
*p
;
7434 for (p
= user_signals
; p
; p
= p
->next
)
7436 /* Already added. */
7439 p
= xmalloc (sizeof (struct user_signal_info
));
7441 p
->name
= xstrdup (name
);
7443 p
->next
= user_signals
;
7446 signal (sig
, handle_user_signal
);
7450 handle_user_signal (sig
)
7453 int old_errno
= errno
;
7454 struct user_signal_info
*p
;
7456 #if defined (USG) && !defined (POSIX_SIGNALS)
7457 /* USG systems forget handlers when they are used;
7458 must reestablish each time */
7459 signal (sig
, handle_user_signal
);
7462 SIGNAL_THREAD_CHECK (sig
);
7464 for (p
= user_signals
; p
; p
= p
->next
)
7469 if (interrupt_input
)
7470 kill (getpid (), SIGIO
);
7474 /* Tell wait_reading_process_output that it needs to wake
7475 up and look around. */
7476 if (input_available_clear_time
)
7477 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7486 find_user_signal_name (sig
)
7489 struct user_signal_info
*p
;
7491 for (p
= user_signals
; p
; p
= p
->next
)
7499 store_user_signal_events ()
7501 struct user_signal_info
*p
;
7502 struct input_event buf
;
7505 for (p
= user_signals
; p
; p
= p
->next
)
7506 if (p
->npending
> 0)
7512 bzero (&buf
, sizeof buf
);
7513 buf
.kind
= USER_SIGNAL_EVENT
;
7514 buf
.frame_or_window
= selected_frame
;
7516 nstored
+= p
->npending
;
7518 mask
= sigblock (sigmask (p
->sig
));
7522 kbd_buffer_store_event (&buf
);
7525 while (p
->npending
> 0);
7533 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7534 static Lisp_Object menu_bar_one_keymap_changed_items
;
7536 /* These variables hold the vector under construction within
7537 menu_bar_items and its subroutines, and the current index
7538 for storing into that vector. */
7539 static Lisp_Object menu_bar_items_vector
;
7540 static int menu_bar_items_index
;
7542 /* Return a vector of menu items for a menu bar, appropriate
7543 to the current buffer. Each item has three elements in the vector:
7546 OLD is an old vector we can optionally reuse, or nil. */
7549 menu_bar_items (old
)
7552 /* The number of keymaps we're scanning right now, and the number of
7553 keymaps we have allocated space for. */
7556 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7557 in the current keymaps, or nil where it is not a prefix. */
7560 Lisp_Object def
, tail
;
7569 /* In order to build the menus, we need to call the keymap
7570 accessors. They all call QUIT. But this function is called
7571 during redisplay, during which a quit is fatal. So inhibit
7572 quitting while building the menus.
7573 We do this instead of specbind because (1) errors will clear it anyway
7574 and (2) this avoids risk of specpdl overflow. */
7575 oquit
= Vinhibit_quit
;
7579 menu_bar_items_vector
= old
;
7581 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7582 menu_bar_items_index
= 0;
7584 /* Build our list of keymaps.
7585 If we recognize a function key and replace its escape sequence in
7586 keybuf with its symbol, or if the sequence starts with a mouse
7587 click and we need to switch buffers, we jump back here to rebuild
7588 the initial keymaps from the current buffer. */
7592 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7593 if (!NILP (Voverriding_local_map_menu_flag
))
7595 /* Yes, use them (if non-nil) as well as the global map. */
7596 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7598 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7599 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7600 if (!NILP (Voverriding_local_map
))
7601 maps
[nmaps
++] = Voverriding_local_map
;
7605 /* No, so use major and minor mode keymaps and keymap property.
7606 Note that menu-bar bindings in the local-map and keymap
7607 properties may not work reliable, as they are only
7608 recognized when the menu-bar (or mode-line) is updated,
7609 which does not normally happen after every command. */
7612 nminor
= current_minor_maps (NULL
, &tmaps
);
7613 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7615 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7616 maps
[nmaps
++] = tem
;
7617 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7619 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7621 maps
[nmaps
++] = current_global_map
;
7624 /* Look up in each map the dummy prefix key `menu-bar'. */
7628 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7629 if (!NILP (maps
[mapno
]))
7631 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7635 menu_bar_one_keymap_changed_items
= Qnil
;
7636 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7640 /* Move to the end those items that should be at the end. */
7642 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7645 int end
= menu_bar_items_index
;
7647 for (i
= 0; i
< end
; i
+= 4)
7648 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7650 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7651 /* Move the item at index I to the end,
7652 shifting all the others forward. */
7653 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7654 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7655 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7656 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7658 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7659 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7660 (end
- i
- 4) * sizeof (Lisp_Object
));
7661 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7662 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7663 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7664 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7669 /* Add nil, nil, nil, nil at the end. */
7670 i
= menu_bar_items_index
;
7671 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7672 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7673 /* Add this item. */
7674 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7675 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7676 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7677 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7678 menu_bar_items_index
= i
;
7680 Vinhibit_quit
= oquit
;
7681 return menu_bar_items_vector
;
7684 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7685 If there's already an item for KEY, add this DEF to it. */
7687 Lisp_Object item_properties
;
7690 menu_bar_item (key
, item
, dummy1
, dummy2
)
7691 Lisp_Object key
, item
, dummy1
;
7694 struct gcpro gcpro1
;
7698 if (EQ (item
, Qundefined
))
7700 /* If a map has an explicit `undefined' as definition,
7701 discard any previously made menu bar item. */
7703 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7704 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7706 if (menu_bar_items_index
> i
+ 4)
7707 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7708 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7709 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7710 menu_bar_items_index
-= 4;
7714 /* If this keymap has already contributed to this KEY,
7715 don't contribute to it a second time. */
7716 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7717 if (!NILP (tem
) || NILP (item
))
7720 menu_bar_one_keymap_changed_items
7721 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7723 /* We add to menu_bar_one_keymap_changed_items before doing the
7724 parse_menu_item, so that if it turns out it wasn't a menu item,
7725 it still correctly hides any further menu item. */
7727 i
= parse_menu_item (item
, 0, 1);
7732 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7734 /* Find any existing item for this KEY. */
7735 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7736 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7739 /* If we did not find this KEY, add it at the end. */
7740 if (i
== menu_bar_items_index
)
7742 /* If vector is too small, get a bigger one. */
7743 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7744 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7745 /* Add this item. */
7746 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7747 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7748 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7749 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7750 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7751 menu_bar_items_index
= i
;
7753 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7757 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7758 /* If the new and the old items are not both keymaps,
7759 the lookup will only find `item'. */
7760 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7761 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7765 /* This is used as the handler when calling menu_item_eval_property. */
7767 menu_item_eval_property_1 (arg
)
7770 /* If we got a quit from within the menu computation,
7771 quit all the way out of it. This takes care of C-] in the debugger. */
7772 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7773 Fsignal (Qquit
, Qnil
);
7778 /* Evaluate an expression and return the result (or nil if something
7779 went wrong). Used to evaluate dynamic parts of menu items. */
7781 menu_item_eval_property (sexpr
)
7784 int count
= SPECPDL_INDEX ();
7786 specbind (Qinhibit_redisplay
, Qt
);
7787 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7788 menu_item_eval_property_1
);
7789 return unbind_to (count
, val
);
7792 /* This function parses a menu item and leaves the result in the
7793 vector item_properties.
7794 ITEM is a key binding, a possible menu item.
7795 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7796 evaluate dynamic expressions in the menu item.
7797 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7799 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7800 parse_menu_item returns true if the item is a menu item and false
7804 parse_menu_item (item
, notreal
, inmenubar
)
7806 int notreal
, inmenubar
;
7808 Lisp_Object def
, tem
, item_string
, start
;
7809 Lisp_Object cachelist
;
7811 Lisp_Object keyhint
;
7822 /* Create item_properties vector if necessary. */
7823 if (NILP (item_properties
))
7825 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7827 /* Initialize optional entries. */
7828 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7829 ASET (item_properties
, i
, Qnil
);
7830 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7832 /* Save the item here to protect it from GC. */
7833 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7835 item_string
= XCAR (item
);
7839 if (STRINGP (item_string
))
7841 /* Old format menu item. */
7842 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7844 /* Maybe help string. */
7845 if (CONSP (item
) && STRINGP (XCAR (item
)))
7847 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7852 /* Maybe key binding cache. */
7853 if (CONSP (item
) && CONSP (XCAR (item
))
7854 && (NILP (XCAR (XCAR (item
)))
7855 || VECTORP (XCAR (XCAR (item
)))))
7857 cachelist
= XCAR (item
);
7861 /* This is the real definition--the function to run. */
7862 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7864 /* Get enable property, if any. */
7867 tem
= Fget (item
, Qmenu_enable
);
7868 if (!NILP (Venable_disabled_menus_and_buttons
))
7869 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7870 else if (!NILP (tem
))
7871 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7874 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7876 /* New format menu item. */
7877 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7878 start
= XCDR (item
);
7881 /* We have a real binding. */
7882 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7884 item
= XCDR (start
);
7885 /* Is there a cache list with key equivalences. */
7886 if (CONSP (item
) && CONSP (XCAR (item
)))
7888 cachelist
= XCAR (item
);
7892 /* Parse properties. */
7893 while (CONSP (item
) && CONSP (XCDR (item
)))
7898 if (EQ (tem
, QCenable
))
7900 if (!NILP (Venable_disabled_menus_and_buttons
))
7901 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7903 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7905 else if (EQ (tem
, QCvisible
) && !notreal
)
7907 /* If got a visible property and that evaluates to nil
7908 then ignore this item. */
7909 tem
= menu_item_eval_property (XCAR (item
));
7913 else if (EQ (tem
, QChelp
))
7914 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7915 else if (EQ (tem
, QCfilter
))
7917 else if (EQ (tem
, QCkey_sequence
))
7920 if (NILP (cachelist
)
7921 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7922 /* Be GC protected. Set keyhint to item instead of tem. */
7925 else if (EQ (tem
, QCkeys
))
7928 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7929 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7931 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7936 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7938 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7940 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7946 else if (inmenubar
|| !NILP (start
))
7950 return 0; /* not a menu item */
7952 /* If item string is not a string, evaluate it to get string.
7953 If we don't get a string, skip this item. */
7954 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7955 if (!(STRINGP (item_string
) || notreal
))
7957 item_string
= menu_item_eval_property (item_string
);
7958 if (!STRINGP (item_string
))
7960 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7963 /* If got a filter apply it on definition. */
7964 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7967 def
= menu_item_eval_property (list2 (XCAR (filter
),
7968 list2 (Qquote
, def
)));
7970 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7973 /* Enable or disable selection of item. */
7974 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7980 tem
= menu_item_eval_property (tem
);
7981 if (inmenubar
&& NILP (tem
))
7982 return 0; /* Ignore disabled items in menu bar. */
7983 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7986 /* If we got no definition, this item is just unselectable text which
7987 is OK in a submenu but not in the menubar. */
7989 return (inmenubar
? 0 : 1);
7991 /* See if this is a separate pane or a submenu. */
7992 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7993 tem
= get_keymap (def
, 0, 1);
7994 /* For a subkeymap, just record its details and exit. */
7997 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7998 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
8002 /* At the top level in the menu bar, do likewise for commands also.
8003 The menu bar does not display equivalent key bindings anyway.
8004 ITEM_PROPERTY_DEF is already set up properly. */
8008 /* This is a command. See if there is an equivalent key binding. */
8009 if (NILP (cachelist
))
8011 /* We have to create a cachelist. */
8012 CHECK_IMPURE (start
);
8013 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
8014 cachelist
= XCAR (XCDR (start
));
8016 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8017 if (!NILP (keyhint
))
8019 XSETCAR (cachelist
, XCAR (keyhint
));
8022 else if (STRINGP (tem
))
8024 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
8025 XSETCAR (cachelist
, Qt
);
8029 tem
= XCAR (cachelist
);
8036 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
8038 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8041 def
= XCAR (prefix
);
8042 prefix
= XCDR (prefix
);
8045 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8047 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
8049 if (newcache
/* Always check first time. */
8050 /* Should we check everything when precomputing key
8052 /* If something had no key binding before, don't recheck it
8053 because that is too slow--except if we have a list of
8054 rebound commands in Vdefine_key_rebound_commands, do
8055 recheck any command that appears in that list. */
8056 || (CONSP (Vdefine_key_rebound_commands
)
8057 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
8060 /* We had a saved key. Is it still bound to the command? */
8063 /* If the command is an alias for another
8064 (such as lmenu.el set it up), check if the
8065 original command matches the cached command. */
8066 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8067 chkcache
= 1; /* Need to recompute key binding. */
8071 /* Recompute equivalent key binding. If the command is an alias
8072 for another (such as lmenu.el set it up), see if the original
8073 command name has equivalent keys. Otherwise look up the
8074 specified command itself. We don't try both, because that
8075 makes lmenu menus slow. */
8077 && SYMBOLP (XSYMBOL (def
)->function
)
8078 && ! NILP (Fget (def
, Qmenu_alias
)))
8079 def
= XSYMBOL (def
)->function
;
8080 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8081 XSETCAR (cachelist
, tem
);
8084 XSETCDR (cachelist
, Qnil
);
8088 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8090 tem
= XCAR (cachelist
);
8094 newcache
= chkcache
;
8097 tem
= Fkey_description (tem
, Qnil
);
8100 if (STRINGP (XCAR (prefix
)))
8101 tem
= concat2 (XCAR (prefix
), tem
);
8102 if (STRINGP (XCDR (prefix
)))
8103 tem
= concat2 (tem
, XCDR (prefix
));
8105 XSETCDR (cachelist
, tem
);
8109 tem
= XCDR (cachelist
);
8110 if (newcache
&& !NILP (tem
))
8112 tem
= concat2 (build_string (" "), tem
);
8113 // tem = concat3 (build_string (" ("), tem, build_string (")"));
8114 XSETCDR (cachelist
, tem
);
8117 /* If we only want to precompute equivalent key bindings, stop here. */
8121 /* If we have an equivalent key binding, use that. */
8122 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8124 /* Include this when menu help is implemented.
8125 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8126 if (!(NILP (tem) || STRINGP (tem)))
8128 tem = menu_item_eval_property (tem);
8131 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8135 /* Handle radio buttons or toggle boxes. */
8136 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8138 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8139 menu_item_eval_property (tem
));
8146 /***********************************************************************
8148 ***********************************************************************/
8150 /* A vector holding tool bar items while they are parsed in function
8151 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8154 static Lisp_Object tool_bar_items_vector
;
8156 /* A vector holding the result of parse_tool_bar_item. Layout is like
8157 the one for a single item in tool_bar_items_vector. */
8159 static Lisp_Object tool_bar_item_properties
;
8161 /* Next free index in tool_bar_items_vector. */
8163 static int ntool_bar_items
;
8165 /* The symbols `tool-bar', `:image' and `:rtl'. */
8167 extern Lisp_Object Qtool_bar
;
8168 Lisp_Object QCimage
;
8171 /* Function prototypes. */
8173 static void init_tool_bar_items
P_ ((Lisp_Object
));
8174 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8175 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8176 static void append_tool_bar_item
P_ ((void));
8179 /* Return a vector of tool bar items for keymaps currently in effect.
8180 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8181 tool bar items found. */
8184 tool_bar_items (reuse
, nitems
)
8195 /* In order to build the menus, we need to call the keymap
8196 accessors. They all call QUIT. But this function is called
8197 during redisplay, during which a quit is fatal. So inhibit
8198 quitting while building the menus. We do this instead of
8199 specbind because (1) errors will clear it anyway and (2) this
8200 avoids risk of specpdl overflow. */
8201 oquit
= Vinhibit_quit
;
8204 /* Initialize tool_bar_items_vector and protect it from GC. */
8205 init_tool_bar_items (reuse
);
8207 /* Build list of keymaps in maps. Set nmaps to the number of maps
8210 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8211 if (!NILP (Voverriding_local_map_menu_flag
))
8213 /* Yes, use them (if non-nil) as well as the global map. */
8214 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8216 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8217 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8218 if (!NILP (Voverriding_local_map
))
8219 maps
[nmaps
++] = Voverriding_local_map
;
8223 /* No, so use major and minor mode keymaps and keymap property.
8224 Note that tool-bar bindings in the local-map and keymap
8225 properties may not work reliable, as they are only
8226 recognized when the tool-bar (or mode-line) is updated,
8227 which does not normally happen after every command. */
8230 nminor
= current_minor_maps (NULL
, &tmaps
);
8231 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8233 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8234 maps
[nmaps
++] = tem
;
8235 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8237 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8240 /* Add global keymap at the end. */
8241 maps
[nmaps
++] = current_global_map
;
8243 /* Process maps in reverse order and look up in each map the prefix
8245 for (i
= nmaps
- 1; i
>= 0; --i
)
8246 if (!NILP (maps
[i
]))
8250 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8252 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8255 Vinhibit_quit
= oquit
;
8256 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8257 return tool_bar_items_vector
;
8261 /* Process the definition of KEY which is DEF. */
8264 process_tool_bar_item (key
, def
, data
, args
)
8265 Lisp_Object key
, def
, data
;
8269 extern Lisp_Object Qundefined
;
8270 struct gcpro gcpro1
, gcpro2
;
8272 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8276 if (EQ (def
, Qundefined
))
8278 /* If a map has an explicit `undefined' as definition,
8279 discard any previously made item. */
8280 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8282 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8284 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8286 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8287 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8288 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8289 * sizeof (Lisp_Object
)));
8290 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8295 else if (parse_tool_bar_item (key
, def
))
8296 /* Append a new tool bar item to tool_bar_items_vector. Accept
8297 more than one definition for the same key. */
8298 append_tool_bar_item ();
8304 /* Parse a tool bar item specification ITEM for key KEY and return the
8305 result in tool_bar_item_properties. Value is zero if ITEM is
8308 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8310 CAPTION is the caption of the item, If it's not a string, it is
8311 evaluated to get a string.
8313 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8314 as binding are currently ignored.
8316 The following properties are recognized:
8320 FORM is evaluated and specifies whether the tool bar item is
8321 enabled or disabled.
8325 FORM is evaluated and specifies whether the tool bar item is visible.
8327 - `:filter FUNCTION'
8329 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8330 result is stored as the new binding.
8332 - `:button (TYPE SELECTED)'
8334 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8335 and specifies whether the button is selected (pressed) or not.
8339 IMAGES is either a single image specification or a vector of four
8340 image specifications. See enum tool_bar_item_images.
8342 - `:help HELP-STRING'.
8344 Gives a help string to display for the tool bar item. */
8347 parse_tool_bar_item (key
, item
)
8348 Lisp_Object key
, item
;
8350 /* Access slot with index IDX of vector tool_bar_item_properties. */
8351 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8353 Lisp_Object filter
= Qnil
;
8354 Lisp_Object caption
;
8357 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8358 Rule out items that aren't lists, don't start with
8359 `menu-item' or whose rest following `tool-bar-item' is not a
8362 || !EQ (XCAR (item
), Qmenu_item
)
8363 || (item
= XCDR (item
),
8367 /* Create tool_bar_item_properties vector if necessary. Reset it to
8369 if (VECTORP (tool_bar_item_properties
))
8371 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8375 tool_bar_item_properties
8376 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8379 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8380 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8382 /* Get the caption of the item. If the caption is not a string,
8383 evaluate it to get a string. If we don't get a string, skip this
8385 caption
= XCAR (item
);
8386 if (!STRINGP (caption
))
8388 caption
= menu_item_eval_property (caption
);
8389 if (!STRINGP (caption
))
8392 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8394 /* Give up if rest following the caption is not a list. */
8399 /* Store the binding. */
8400 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8403 /* Ignore cached key binding, if any. */
8404 if (CONSP (item
) && CONSP (XCAR (item
)))
8407 /* Process the rest of the properties. */
8408 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8410 Lisp_Object key
, value
;
8413 value
= XCAR (XCDR (item
));
8415 if (EQ (key
, QCenable
))
8417 /* `:enable FORM'. */
8418 if (!NILP (Venable_disabled_menus_and_buttons
))
8419 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8421 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8423 else if (EQ (key
, QCvisible
))
8425 /* `:visible FORM'. If got a visible property and that
8426 evaluates to nil then ignore this item. */
8427 if (NILP (menu_item_eval_property (value
)))
8430 else if (EQ (key
, QChelp
))
8431 /* `:help HELP-STRING'. */
8432 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8433 else if (EQ (key
, QCfilter
))
8434 /* ':filter FORM'. */
8436 else if (EQ (key
, QCbutton
) && CONSP (value
))
8438 /* `:button (TYPE . SELECTED)'. */
8439 Lisp_Object type
, selected
;
8441 type
= XCAR (value
);
8442 selected
= XCDR (value
);
8443 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8445 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8446 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8449 else if (EQ (key
, QCimage
)
8451 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8452 /* Value is either a single image specification or a vector
8453 of 4 such specifications for the different button states. */
8454 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8455 else if (EQ (key
, Qrtl
))
8457 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8460 /* If got a filter apply it on binding. */
8462 PROP (TOOL_BAR_ITEM_BINDING
)
8463 = menu_item_eval_property (list2 (filter
,
8465 PROP (TOOL_BAR_ITEM_BINDING
))));
8467 /* See if the binding is a keymap. Give up if it is. */
8468 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8471 /* Enable or disable selection of item. */
8472 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8473 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8474 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8476 /* Handle radio buttons or toggle boxes. */
8477 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8478 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8479 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8487 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8488 that can be reused. */
8491 init_tool_bar_items (reuse
)
8494 if (VECTORP (reuse
))
8495 tool_bar_items_vector
= reuse
;
8497 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8498 ntool_bar_items
= 0;
8502 /* Append parsed tool bar item properties from
8503 tool_bar_item_properties */
8506 append_tool_bar_item ()
8508 Lisp_Object
*to
, *from
;
8510 /* Enlarge tool_bar_items_vector if necessary. */
8511 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8512 >= XVECTOR (tool_bar_items_vector
)->size
)
8513 tool_bar_items_vector
8514 = larger_vector (tool_bar_items_vector
,
8515 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8517 /* Append entries from tool_bar_item_properties to the end of
8518 tool_bar_items_vector. */
8519 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8520 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8521 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8522 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8529 /* Read a character using menus based on maps in the array MAPS.
8530 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8531 Return t if we displayed a menu but the user rejected it.
8533 PREV_EVENT is the previous input event, or nil if we are reading
8534 the first event of a key sequence.
8536 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8537 if we used a mouse menu to read the input, or zero otherwise. If
8538 USED_MOUSE_MENU is null, we don't dereference it.
8540 The prompting is done based on the prompt-string of the map
8541 and the strings associated with various map elements.
8543 This can be done with X menus or with menus put in the minibuf.
8544 These are done in different ways, depending on how the input will be read.
8545 Menus using X are done after auto-saving in read-char, getting the input
8546 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8547 and do auto-saving in the inner call of read_char. */
8550 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8553 Lisp_Object prev_event
;
8554 int *used_mouse_menu
;
8557 register Lisp_Object name
= Qnil
;
8559 if (used_mouse_menu
)
8560 *used_mouse_menu
= 0;
8562 /* Use local over global Menu maps */
8564 if (! menu_prompting
)
8567 /* Optionally disregard all but the global map. */
8568 if (inhibit_local_menu_bar_menus
)
8570 maps
+= (nmaps
- 1);
8574 /* Get the menu name from the first map that has one (a prompt string). */
8575 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8577 name
= Fkeymap_prompt (maps
[mapno
]);
8582 /* If we don't have any menus, just read a character normally. */
8583 if (!STRINGP (name
))
8587 /* If we got to this point via a mouse click,
8588 use a real menu for mouse selection. */
8589 if (EVENT_HAS_PARAMETERS (prev_event
)
8590 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8591 && !EQ (XCAR (prev_event
), Qtool_bar
))
8593 /* Display the menu and get the selection. */
8594 Lisp_Object
*realmaps
8595 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8599 /* Use the maps that are not nil. */
8600 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8601 if (!NILP (maps
[mapno
]))
8602 realmaps
[nmaps1
++] = maps
[mapno
];
8604 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8609 record_menu_key (XCAR (value
));
8611 /* If we got multiple events, unread all but
8613 There is no way to prevent those unread events
8614 from showing up later in last_nonmenu_event.
8615 So turn symbol and integer events into lists,
8616 to indicate that they came from a mouse menu,
8617 so that when present in last_nonmenu_event
8618 they won't confuse things. */
8619 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8621 record_menu_key (XCAR (tem
));
8622 if (SYMBOLP (XCAR (tem
))
8623 || INTEGERP (XCAR (tem
)))
8624 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8627 /* If we got more than one event, put all but the first
8628 onto this list to be read later.
8629 Return just the first event now. */
8630 Vunread_command_events
8631 = nconc2 (XCDR (value
), Vunread_command_events
);
8632 value
= XCAR (value
);
8634 else if (NILP (value
))
8636 if (used_mouse_menu
)
8637 *used_mouse_menu
= 1;
8640 #endif /* HAVE_MENUS */
8644 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8645 We make this bigger when necessary, and never free it. */
8646 static char *read_char_minibuf_menu_text
;
8647 /* Size of that buffer. */
8648 static int read_char_minibuf_menu_width
;
8651 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8657 register Lisp_Object name
;
8659 /* FIXME: Use the minibuffer's frame width. */
8660 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8663 Lisp_Object rest
, vector
;
8669 if (! menu_prompting
)
8672 /* Make sure we have a big enough buffer for the menu text. */
8673 if (read_char_minibuf_menu_text
== 0)
8675 read_char_minibuf_menu_width
= width
+ 4;
8676 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8678 else if (width
+ 4 > read_char_minibuf_menu_width
)
8680 read_char_minibuf_menu_width
= width
+ 4;
8681 read_char_minibuf_menu_text
8682 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8684 menu
= read_char_minibuf_menu_text
;
8686 /* Get the menu name from the first map that has one (a prompt string). */
8687 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8689 name
= Fkeymap_prompt (maps
[mapno
]);
8694 /* If we don't have any menus, just read a character normally. */
8695 if (!STRINGP (name
))
8698 /* Prompt string always starts with map's prompt, and a space. */
8699 strcpy (menu
, SDATA (name
));
8700 nlength
= SBYTES (name
);
8701 menu
[nlength
++] = ':';
8702 menu
[nlength
++] = ' ';
8705 /* Start prompting at start of first map. */
8709 /* Present the documented bindings, a line at a time. */
8716 Lisp_Object orig_defn_macro
;
8718 /* Loop over elements of map. */
8723 /* If reached end of map, start at beginning of next map. */
8727 /* At end of last map, wrap around to first map if just starting,
8728 or end this line if already have something on it. */
8732 if (notfirst
|| nobindings
) break;
8737 /* Look at the next element of the map. */
8739 elt
= XVECTOR (vector
)->contents
[idx
];
8741 elt
= Fcar_safe (rest
);
8743 if (idx
< 0 && VECTORP (elt
))
8745 /* If we found a dense table in the keymap,
8746 advanced past it, but start scanning its contents. */
8747 rest
= Fcdr_safe (rest
);
8753 /* An ordinary element. */
8754 Lisp_Object event
, tem
;
8758 event
= Fcar_safe (elt
); /* alist */
8759 elt
= Fcdr_safe (elt
);
8763 XSETINT (event
, idx
); /* vector */
8766 /* Ignore the element if it has no prompt string. */
8767 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8769 /* 1 if the char to type matches the string. */
8771 Lisp_Object upcased_event
, downcased_event
;
8772 Lisp_Object desc
= Qnil
;
8774 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8776 upcased_event
= Fupcase (event
);
8777 downcased_event
= Fdowncase (event
);
8778 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8779 || XINT (downcased_event
) == SREF (s
, 0));
8781 desc
= Fsingle_key_description (event
, Qnil
);
8783 #if 0 /* It is redundant to list the equivalent key bindings because
8784 the prefix is what the user has already typed. */
8786 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8788 /* Insert equivalent keybinding. */
8789 s
= concat2 (s
, tem
);
8792 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8793 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8795 /* Insert button prefix. */
8796 Lisp_Object selected
8797 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8798 if (EQ (tem
, QCradio
))
8799 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8801 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8802 s
= concat2 (tem
, s
);
8806 /* If we have room for the prompt string, add it to this line.
8807 If this is the first on the line, always add it. */
8808 if ((SCHARS (s
) + i
+ 2
8809 + (char_matches
? 0 : SCHARS (desc
) + 3))
8815 /* Punctuate between strings. */
8818 strcpy (menu
+ i
, ", ");
8824 /* If the char to type doesn't match the string's
8825 first char, explicitly show what char to type. */
8828 /* Add as much of string as fits. */
8829 thiswidth
= SCHARS (desc
);
8830 if (thiswidth
+ i
> width
)
8831 thiswidth
= width
- i
;
8832 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8834 strcpy (menu
+ i
, " = ");
8838 /* Add as much of string as fits. */
8839 thiswidth
= SCHARS (s
);
8840 if (thiswidth
+ i
> width
)
8841 thiswidth
= width
- i
;
8842 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8848 /* If this element does not fit, end the line now,
8849 and save the element for the next line. */
8850 strcpy (menu
+ i
, "...");
8855 /* Move past this element. */
8856 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8857 /* Handle reaching end of dense table. */
8862 rest
= Fcdr_safe (rest
);
8866 /* Prompt with that and read response. */
8867 message2_nolog (menu
, strlen (menu
),
8868 ! NILP (current_buffer
->enable_multibyte_characters
));
8870 /* Make believe its not a keyboard macro in case the help char
8871 is pressed. Help characters are not recorded because menu prompting
8872 is not used on replay.
8874 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8875 current_kboard
->defining_kbd_macro
= Qnil
;
8877 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8878 while (BUFFERP (obj
));
8879 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8881 if (!INTEGERP (obj
))
8883 else if (XINT (obj
) == -2)
8888 if (! EQ (obj
, menu_prompt_more_char
)
8889 && (!INTEGERP (menu_prompt_more_char
)
8890 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8892 if (!NILP (current_kboard
->defining_kbd_macro
))
8893 store_kbd_macro_char (obj
);
8896 /* Help char - go round again */
8900 /* Reading key sequences. */
8902 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8903 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8904 keymap, or nil otherwise. Return the index of the first keymap in
8905 which KEY has any binding, or NMAPS if no map has a binding.
8907 If KEY is a meta ASCII character, treat it like meta-prefix-char
8908 followed by the corresponding non-meta character. Keymaps in
8909 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8912 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8915 NEXT may be the same array as CURRENT. */
8918 follow_key (key
, nmaps
, current
, defs
, next
)
8920 Lisp_Object
*current
, *defs
, *next
;
8923 int i
, first_binding
;
8925 first_binding
= nmaps
;
8926 for (i
= nmaps
- 1; i
>= 0; i
--)
8928 if (! NILP (current
[i
]))
8930 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8931 if (! NILP (defs
[i
]))
8938 /* Given the set of bindings we've found, produce the next set of maps. */
8939 if (first_binding
< nmaps
)
8940 for (i
= 0; i
< nmaps
; i
++)
8941 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8943 return first_binding
;
8946 /* Structure used to keep track of partial application of key remapping
8947 such as Vfunction_key_map and Vkey_translation_map. */
8948 typedef struct keyremap
8950 /* This is the map originally specified for this use. */
8952 /* This is a submap reached by looking up, in PARENT,
8953 the events from START to END. */
8955 /* Positions [START, END) in the key sequence buffer
8956 are the key that we have scanned so far.
8957 Those events are the ones that we will replace
8958 if PAREHT maps them into a key sequence. */
8962 /* Lookup KEY in MAP.
8963 MAP is a keymap mapping keys to key vectors or functions.
8964 If the mapping is a function and DO_FUNCTION is non-zero, then
8965 the function is called with PROMPT as parameter and its return
8966 value is used as the return value of this function (after checking
8967 that it is indeed a vector). */
8970 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8971 Lisp_Object map
, key
, prompt
;
8976 next
= access_keymap (map
, key
, 1, 0, 1);
8978 /* Handle symbol with autoload definition. */
8979 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8980 && CONSP (XSYMBOL (next
)->function
)
8981 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8982 do_autoload (XSYMBOL (next
)->function
, next
);
8984 /* Handle a symbol whose function definition is a keymap
8986 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8987 && (ARRAYP (XSYMBOL (next
)->function
)
8988 || KEYMAPP (XSYMBOL (next
)->function
)))
8989 next
= XSYMBOL (next
)->function
;
8991 /* If the keymap gives a function, not an
8992 array, then call the function with one arg and use
8993 its value instead. */
8994 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8999 next
= call1 (next
, prompt
);
9000 /* If the function returned something invalid,
9001 barf--don't ignore it.
9002 (To ignore it safely, we would need to gcpro a bunch of
9003 other variables.) */
9004 if (! (VECTORP (next
) || STRINGP (next
)))
9005 error ("Function %s returns invalid key sequence", tem
);
9010 /* Do one step of the key remapping used for function-key-map and
9011 key-translation-map:
9012 KEYBUF is the buffer holding the input events.
9013 BUFSIZE is its maximum size.
9014 FKEY is a pointer to the keyremap structure to use.
9015 INPUT is the index of the last element in KEYBUF.
9016 DOIT if non-zero says that the remapping can actually take place.
9017 DIFF is used to return the number of keys added/removed by the remapping.
9018 PARENT is the root of the keymap.
9019 PROMPT is the prompt to use if the remapping happens through a function.
9020 The return value is non-zero if the remapping actually took place. */
9023 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
9024 Lisp_Object
*keybuf
, prompt
;
9026 int input
, doit
, *diff
, bufsize
;
9028 Lisp_Object next
, key
;
9030 key
= keybuf
[fkey
->end
++];
9032 if (KEYMAPP (fkey
->parent
))
9033 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9037 /* If keybuf[fkey->start..fkey->end] is bound in the
9038 map and we're in a position to do the key remapping, replace it with
9039 the binding and restart with fkey->start at the end. */
9040 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9042 int len
= XFASTINT (Flength (next
));
9045 *diff
= len
- (fkey
->end
- fkey
->start
);
9047 if (input
+ *diff
>= bufsize
)
9048 error ("Key sequence too long");
9050 /* Shift the keys that follow fkey->end. */
9052 for (i
= fkey
->end
; i
< input
; i
++)
9053 keybuf
[i
+ *diff
] = keybuf
[i
];
9055 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9056 keybuf
[i
+ *diff
] = keybuf
[i
];
9057 /* Overwrite the old keys with the new ones. */
9058 for (i
= 0; i
< len
; i
++)
9059 keybuf
[fkey
->start
+ i
]
9060 = Faref (next
, make_number (i
));
9062 fkey
->start
= fkey
->end
+= *diff
;
9063 fkey
->map
= fkey
->parent
;
9068 fkey
->map
= get_keymap (next
, 0, 1);
9070 /* If we no longer have a bound suffix, try a new position for
9072 if (!CONSP (fkey
->map
))
9074 fkey
->end
= ++fkey
->start
;
9075 fkey
->map
= fkey
->parent
;
9080 /* Read a sequence of keys that ends with a non prefix character,
9081 storing it in KEYBUF, a buffer of size BUFSIZE.
9083 Return the length of the key sequence stored.
9084 Return -1 if the user rejected a command menu.
9086 Echo starting immediately unless `prompt' is 0.
9088 Where a key sequence ends depends on the currently active keymaps.
9089 These include any minor mode keymaps active in the current buffer,
9090 the current buffer's local map, and the global map.
9092 If a key sequence has no other bindings, we check Vfunction_key_map
9093 to see if some trailing subsequence might be the beginning of a
9094 function key's sequence. If so, we try to read the whole function
9095 key, and substitute its symbolic name into the key sequence.
9097 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9098 `double-' events into similar click events, if that would make them
9099 bound. We try to turn `triple-' events first into `double-' events,
9102 If we get a mouse click in a mode line, vertical divider, or other
9103 non-text area, we treat the click as if it were prefixed by the
9104 symbol denoting that area - `mode-line', `vertical-line', or
9107 If the sequence starts with a mouse click, we read the key sequence
9108 with respect to the buffer clicked on, not the current buffer.
9110 If the user switches frames in the midst of a key sequence, we put
9111 off the switch-frame event until later; the next call to
9112 read_char will return it.
9114 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9115 from the selected window's buffer. */
9118 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9119 can_return_switch_frame
, fix_current_buffer
)
9120 Lisp_Object
*keybuf
;
9123 int dont_downcase_last
;
9124 int can_return_switch_frame
;
9125 int fix_current_buffer
;
9127 volatile Lisp_Object from_string
;
9128 volatile int count
= SPECPDL_INDEX ();
9130 /* How many keys there are in the current key sequence. */
9133 /* The length of the echo buffer when we started reading, and
9134 the length of this_command_keys when we started reading. */
9135 volatile int echo_start
;
9136 volatile int keys_start
;
9138 /* The number of keymaps we're scanning right now, and the number of
9139 keymaps we have allocated space for. */
9141 volatile int nmaps_allocated
= 0;
9143 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9144 the current keymaps. */
9145 Lisp_Object
*volatile defs
= NULL
;
9147 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9148 in the current keymaps, or nil where it is not a prefix. */
9149 Lisp_Object
*volatile submaps
= NULL
;
9151 /* The local map to start out with at start of key sequence. */
9152 volatile Lisp_Object orig_local_map
;
9154 /* The map from the `keymap' property to start out with at start of
9156 volatile Lisp_Object orig_keymap
;
9158 /* 1 if we have already considered switching to the local-map property
9159 of the place where a mouse click occurred. */
9160 volatile int localized_local_map
= 0;
9162 /* The index in submaps[] of the first keymap that has a binding for
9163 this key sequence. In other words, the lowest i such that
9164 submaps[i] is non-nil. */
9165 volatile int first_binding
;
9166 /* Index of the first key that has no binding.
9167 It is useless to try fkey.start larger than that. */
9168 volatile int first_unbound
;
9170 /* If t < mock_input, then KEYBUF[t] should be read as the next
9173 We use this to recover after recognizing a function key. Once we
9174 realize that a suffix of the current key sequence is actually a
9175 function key's escape sequence, we replace the suffix with the
9176 function key's binding from Vfunction_key_map. Now keybuf
9177 contains a new and different key sequence, so the echo area,
9178 this_command_keys, and the submaps and defs arrays are wrong. In
9179 this situation, we set mock_input to t, set t to 0, and jump to
9180 restart_sequence; the loop will read keys from keybuf up until
9181 mock_input, thus rebuilding the state; and then it will resume
9182 reading characters from the keyboard. */
9183 volatile int mock_input
= 0;
9185 /* If the sequence is unbound in submaps[], then
9186 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9187 and fkey.map is its binding.
9189 These might be > t, indicating that all function key scanning
9190 should hold off until t reaches them. We do this when we've just
9191 recognized a function key, to avoid searching for the function
9192 key's again in Vfunction_key_map. */
9193 volatile keyremap fkey
;
9195 /* Likewise, for key_translation_map and input-decode-map. */
9196 volatile keyremap keytran
, indec
;
9198 /* If we receive a `switch-frame' or `select-window' event in the middle of
9199 a key sequence, we put it off for later.
9200 While we're reading, we keep the event here. */
9201 volatile Lisp_Object delayed_switch_frame
;
9203 /* See the comment below... */
9204 #if defined (GOBBLE_FIRST_EVENT)
9205 Lisp_Object first_event
;
9208 volatile Lisp_Object original_uppercase
;
9209 volatile int original_uppercase_position
= -1;
9211 /* Gets around Microsoft compiler limitations. */
9214 struct buffer
*starting_buffer
;
9216 /* List of events for which a fake prefix key has been generated. */
9217 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9219 #if defined (GOBBLE_FIRST_EVENT)
9223 struct gcpro gcpro1
;
9225 GCPRO1 (fake_prefixed_keys
);
9226 raw_keybuf_count
= 0;
9228 last_nonmenu_event
= Qnil
;
9230 delayed_switch_frame
= Qnil
;
9235 echo_prompt (prompt
);
9236 else if (cursor_in_echo_area
9237 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9238 && NILP (Fzerop (Vecho_keystrokes
)))
9239 /* This doesn't put in a dash if the echo buffer is empty, so
9240 you don't always see a dash hanging out in the minibuffer. */
9244 /* Record the initial state of the echo area and this_command_keys;
9245 we will need to restore them if we replay a key sequence. */
9247 echo_start
= echo_length ();
9248 keys_start
= this_command_key_count
;
9249 this_single_command_key_start
= keys_start
;
9251 #if defined (GOBBLE_FIRST_EVENT)
9252 /* This doesn't quite work, because some of the things that read_char
9253 does cannot safely be bypassed. It seems too risky to try to make
9256 /* Read the first char of the sequence specially, before setting
9257 up any keymaps, in case a filter runs and switches buffers on us. */
9258 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9260 #endif /* GOBBLE_FIRST_EVENT */
9262 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9263 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9266 /* The multi-tty merge moved the code below to right after
9267 `replay_sequence' which caused all these translation maps to be applied
9268 repeatedly, even tho their doc says very clearly they are not applied to
9270 The reason for this move was: "We may switch keyboards between rescans,
9271 so we need to reinitialize fkey and keytran before each replay".
9272 This move was wrong (even if we switch keyboards, keybuf still holds the
9273 keys we've read already from the original keyboard and some of those keys
9274 may have already been translated). So there may still be a bug out there
9276 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9277 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9278 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9279 indec
.start
= indec
.end
= 0;
9280 fkey
.start
= fkey
.end
= 0;
9281 keytran
.start
= keytran
.end
= 0;
9283 /* We jump here when the key sequence has been thoroughly changed, and
9284 we need to rescan it starting from the beginning. When we jump here,
9285 keybuf[0..mock_input] holds the sequence we should reread. */
9288 starting_buffer
= current_buffer
;
9289 first_unbound
= bufsize
+ 1;
9291 /* Build our list of keymaps.
9292 If we recognize a function key and replace its escape sequence in
9293 keybuf with its symbol, or if the sequence starts with a mouse
9294 click and we need to switch buffers, we jump back here to rebuild
9295 the initial keymaps from the current buffer. */
9298 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9300 if (2 > nmaps_allocated
)
9302 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9303 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9304 nmaps_allocated
= 2;
9306 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9307 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9309 else if (!NILP (Voverriding_local_map
))
9311 if (2 > nmaps_allocated
)
9313 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9314 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9315 nmaps_allocated
= 2;
9317 if (!NILP (Voverriding_local_map
))
9318 submaps
[nmaps
++] = Voverriding_local_map
;
9326 nminor
= current_minor_maps (0, &maps
);
9327 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9329 if (total
> nmaps_allocated
)
9331 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9332 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9333 nmaps_allocated
= total
;
9336 if (!NILP (orig_keymap
))
9337 submaps
[nmaps
++] = orig_keymap
;
9339 bcopy (maps
, (void *) (submaps
+ nmaps
),
9340 nminor
* sizeof (submaps
[0]));
9344 submaps
[nmaps
++] = orig_local_map
;
9346 submaps
[nmaps
++] = current_global_map
;
9348 /* Find an accurate initial value for first_binding. */
9349 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9350 if (! NILP (submaps
[first_binding
]))
9353 /* Start from the beginning in keybuf. */
9356 /* These are no-ops the first time through, but if we restart, they
9357 revert the echo area and this_command_keys to their original state. */
9358 this_command_key_count
= keys_start
;
9359 if (INTERACTIVE
&& t
< mock_input
)
9360 echo_truncate (echo_start
);
9362 /* If the best binding for the current key sequence is a keymap, or
9363 we may be looking at a function key's escape sequence, keep on
9365 while (first_binding
< nmaps
9366 /* Keep reading as long as there's a prefix binding. */
9367 ? !NILP (submaps
[first_binding
])
9368 /* Don't return in the middle of a possible function key sequence,
9369 if the only bindings we found were via case conversion.
9370 Thus, if ESC O a has a function-key-map translation
9371 and ESC o has a binding, don't return after ESC O,
9372 so that we can translate ESC O plus the next character. */
9373 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9376 int used_mouse_menu
= 0;
9378 /* Where the last real key started. If we need to throw away a
9379 key that has expanded into more than one element of keybuf
9380 (say, a mouse click on the mode line which is being treated
9381 as [mode-line (mouse-...)], then we backtrack to this point
9383 volatile int last_real_key_start
;
9385 /* These variables are analogous to echo_start and keys_start;
9386 while those allow us to restart the entire key sequence,
9387 echo_local_start and keys_local_start allow us to throw away
9389 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9391 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9392 eassert (indec
.start
<= indec
.end
);
9393 eassert (fkey
.start
<= fkey
.end
);
9394 eassert (keytran
.start
<= keytran
.end
);
9395 /* key-translation-map is applied *after* function-key-map
9396 which is itself applied *after* input-decode-map. */
9397 eassert (fkey
.end
<= indec
.start
);
9398 eassert (keytran
.end
<= fkey
.start
);
9400 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9401 first_unbound
< keytran
.start
)
9402 { /* The prefix upto first_unbound has no binding and has
9403 no translation left to do either, so we know it's unbound.
9404 If we don't stop now, we risk staying here indefinitely
9405 (if the user keeps entering fkey or keytran prefixes
9406 like C-c ESC ESC ESC ESC ...) */
9408 for (i
= first_unbound
+ 1; i
< t
; i
++)
9409 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9410 mock_input
= t
- first_unbound
- 1;
9411 indec
.end
= indec
.start
-= first_unbound
+ 1;
9412 indec
.map
= indec
.parent
;
9413 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9414 fkey
.map
= fkey
.parent
;
9415 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9416 keytran
.map
= keytran
.parent
;
9417 goto replay_sequence
;
9421 error ("Key sequence too long");
9424 echo_local_start
= echo_length ();
9425 keys_local_start
= this_command_key_count
;
9426 local_first_binding
= first_binding
;
9429 /* These are no-ops, unless we throw away a keystroke below and
9430 jumped back up to replay_key; in that case, these restore the
9431 variables to their original state, allowing us to replay the
9433 if (INTERACTIVE
&& t
< mock_input
)
9434 echo_truncate (echo_local_start
);
9435 this_command_key_count
= keys_local_start
;
9436 first_binding
= local_first_binding
;
9438 /* By default, assume each event is "real". */
9439 last_real_key_start
= t
;
9441 /* Does mock_input indicate that we are re-reading a key sequence? */
9445 add_command_key (key
);
9446 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9447 && NILP (Fzerop (Vecho_keystrokes
)))
9451 /* If not, we should actually read a character. */
9456 KBOARD
*interrupted_kboard
= current_kboard
;
9457 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9459 key
= read_char (NILP (prompt
), nmaps
,
9460 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9461 &used_mouse_menu
, NULL
);
9463 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9468 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9469 if (k
== interrupted_kboard
)
9474 /* Don't touch interrupted_kboard when it's been
9476 delayed_switch_frame
= Qnil
;
9477 goto replay_sequence
;
9480 if (!NILP (delayed_switch_frame
))
9482 interrupted_kboard
->kbd_queue
9483 = Fcons (delayed_switch_frame
,
9484 interrupted_kboard
->kbd_queue
);
9485 delayed_switch_frame
= Qnil
;
9489 interrupted_kboard
->kbd_queue
9490 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9492 /* If the side queue is non-empty, ensure it begins with a
9493 switch-frame, so we'll replay it in the right context. */
9494 if (CONSP (interrupted_kboard
->kbd_queue
)
9495 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9496 !(EVENT_HAS_PARAMETERS (key
)
9497 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9501 XSETFRAME (frame
, interrupted_frame
);
9502 interrupted_kboard
->kbd_queue
9503 = Fcons (make_lispy_switch_frame (frame
),
9504 interrupted_kboard
->kbd_queue
);
9507 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9508 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9509 goto replay_sequence
;
9514 /* read_char returns t when it shows a menu and the user rejects it.
9518 unbind_to (count
, Qnil
);
9523 /* read_char returns -1 at the end of a macro.
9524 Emacs 18 handles this by returning immediately with a
9525 zero, so that's what we'll do. */
9526 if (INTEGERP (key
) && XINT (key
) == -1)
9529 /* The Microsoft C compiler can't handle the goto that
9535 /* If the current buffer has been changed from under us, the
9536 keymap may have changed, so replay the sequence. */
9539 timer_resume_idle ();
9542 /* Reset the current buffer from the selected window
9543 in case something changed the former and not the latter.
9544 This is to be more consistent with the behavior
9545 of the command_loop_1. */
9546 if (fix_current_buffer
)
9548 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9550 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9551 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9554 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9555 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9556 goto replay_sequence
;
9559 /* If we have a quit that was typed in another frame, and
9560 quit_throw_to_read_char switched buffers,
9561 replay to get the right keymap. */
9563 && XINT (key
) == quit_char
9564 && current_buffer
!= starting_buffer
)
9567 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9571 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9572 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9573 goto replay_sequence
;
9578 if (EVENT_HAS_PARAMETERS (key
)
9579 /* Either a `switch-frame' or a `select-window' event. */
9580 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9582 /* If we're at the beginning of a key sequence, and the caller
9583 says it's okay, go ahead and return this event. If we're
9584 in the midst of a key sequence, delay it until the end. */
9585 if (t
> 0 || !can_return_switch_frame
)
9587 delayed_switch_frame
= key
;
9593 ASET (raw_keybuf
, raw_keybuf_count
++, key
);
9596 /* Clicks in non-text areas get prefixed by the symbol
9597 in their CHAR-ADDRESS field. For example, a click on
9598 the mode line is prefixed by the symbol `mode-line'.
9600 Furthermore, key sequences beginning with mouse clicks
9601 are read using the keymaps of the buffer clicked on, not
9602 the current buffer. So we may have to switch the buffer
9605 When we turn one event into two events, we must make sure
9606 that neither of the two looks like the original--so that,
9607 if we replay the events, they won't be expanded again.
9608 If not for this, such reexpansion could happen either here
9609 or when user programs play with this-command-keys. */
9610 if (EVENT_HAS_PARAMETERS (key
))
9615 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9616 if (EQ (kind
, Qmouse_click
))
9618 Lisp_Object window
, posn
;
9620 window
= POSN_WINDOW (EVENT_START (key
));
9621 posn
= POSN_POSN (EVENT_START (key
));
9624 || (!NILP (fake_prefixed_keys
)
9625 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9627 /* We're looking a second time at an event for which
9628 we generated a fake prefix key. Set
9629 last_real_key_start appropriately. */
9631 last_real_key_start
= t
- 1;
9634 /* Key sequences beginning with mouse clicks are
9635 read using the keymaps in the buffer clicked on,
9636 not the current buffer. If we're at the
9637 beginning of a key sequence, switch buffers. */
9638 if (last_real_key_start
== 0
9640 && BUFFERP (XWINDOW (window
)->buffer
)
9641 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9643 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9647 /* Arrange to go back to the original buffer once we're
9648 done reading the key sequence. Note that we can't
9649 use save_excursion_{save,restore} here, because they
9650 save point as well as the current buffer; we don't
9651 want to save point, because redisplay may change it,
9652 to accommodate a Fset_window_start or something. We
9653 don't want to do this at the top of the function,
9654 because we may get input from a subprocess which
9655 wants to change the selected window and stuff (say,
9657 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9659 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9661 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9662 orig_local_map
= get_local_map (PT
, current_buffer
,
9664 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9665 goto replay_sequence
;
9668 /* For a mouse click, get the local text-property keymap
9669 of the place clicked on, rather than point. */
9670 if (last_real_key_start
== 0
9671 && CONSP (XCDR (key
))
9672 && ! localized_local_map
)
9674 Lisp_Object map_here
, start
, pos
;
9676 localized_local_map
= 1;
9677 start
= EVENT_START (key
);
9679 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9681 pos
= POSN_BUFFER_POSN (start
);
9683 && XINT (pos
) >= BEGV
9684 && XINT (pos
) <= ZV
)
9686 map_here
= get_local_map (XINT (pos
),
9687 current_buffer
, Qlocal_map
);
9688 if (!EQ (map_here
, orig_local_map
))
9690 orig_local_map
= map_here
;
9691 ++localized_local_map
;
9694 map_here
= get_local_map (XINT (pos
),
9695 current_buffer
, Qkeymap
);
9696 if (!EQ (map_here
, orig_keymap
))
9698 orig_keymap
= map_here
;
9699 ++localized_local_map
;
9702 if (localized_local_map
> 1)
9707 goto replay_sequence
;
9713 /* Expand mode-line and scroll-bar events into two events:
9714 use posn as a fake prefix key. */
9716 && (NILP (fake_prefixed_keys
)
9717 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9719 if (t
+ 1 >= bufsize
)
9720 error ("Key sequence too long");
9723 keybuf
[t
+ 1] = key
;
9726 /* Record that a fake prefix key has been generated
9727 for KEY. Don't modify the event; this would
9728 prevent proper action when the event is pushed
9729 back into unread-command-events. */
9730 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9732 /* If on a mode line string with a local keymap,
9733 reconsider the key sequence with that keymap. */
9734 if (string
= POSN_STRING (EVENT_START (key
)),
9735 (CONSP (string
) && STRINGP (XCAR (string
))))
9737 Lisp_Object pos
, map
, map2
;
9739 pos
= XCDR (string
);
9740 string
= XCAR (string
);
9742 && XINT (pos
) < SCHARS (string
))
9744 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9746 orig_local_map
= map
;
9747 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9750 if (!NILP (map
) || !NILP (map2
))
9751 goto replay_sequence
;
9757 else if (NILP (from_string
)
9758 && (string
= POSN_STRING (EVENT_START (key
)),
9759 (CONSP (string
) && STRINGP (XCAR (string
)))))
9761 /* For a click on a string, i.e. overlay string or a
9762 string displayed via the `display' property,
9763 consider `local-map' and `keymap' properties of
9765 Lisp_Object pos
, map
, map2
;
9767 pos
= XCDR (string
);
9768 string
= XCAR (string
);
9770 && XINT (pos
) < SCHARS (string
))
9772 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9774 orig_local_map
= map
;
9775 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9779 if (!NILP (map
) || !NILP (map2
))
9781 from_string
= string
;
9784 goto replay_sequence
;
9789 else if (CONSP (XCDR (key
))
9790 && CONSP (EVENT_START (key
))
9791 && CONSP (XCDR (EVENT_START (key
))))
9795 posn
= POSN_POSN (EVENT_START (key
));
9796 /* Handle menu-bar events:
9797 insert the dummy prefix event `menu-bar'. */
9798 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9800 if (t
+ 1 >= bufsize
)
9801 error ("Key sequence too long");
9805 /* Zap the position in key, so we know that we've
9806 expanded it, and don't try to do so again. */
9807 POSN_SET_POSN (EVENT_START (key
),
9808 Fcons (posn
, Qnil
));
9811 goto replay_sequence
;
9813 else if (CONSP (posn
))
9815 /* We're looking at the second event of a
9816 sequence which we expanded before. Set
9817 last_real_key_start appropriately. */
9818 if (last_real_key_start
== t
&& t
> 0)
9819 last_real_key_start
= t
- 1;
9824 /* We have finally decided that KEY is something we might want
9826 first_binding
= (follow_key (key
,
9827 nmaps
- first_binding
,
9828 submaps
+ first_binding
,
9829 defs
+ first_binding
,
9830 submaps
+ first_binding
)
9833 /* If KEY wasn't bound, we'll try some fallbacks. */
9834 if (first_binding
< nmaps
)
9835 /* This is needed for the following scenario:
9836 event 0: a down-event that gets dropped by calling replay_key.
9837 event 1: some normal prefix like C-h.
9838 After event 0, first_unbound is 0, after event 1 indec.start,
9839 fkey.start, and keytran.start are all 1, so when we see that
9840 C-h is bound, we need to update first_unbound. */
9841 first_unbound
= max (t
+ 1, first_unbound
);
9846 /* Remember the position to put an upper bound on indec.start. */
9847 first_unbound
= min (t
, first_unbound
);
9849 head
= EVENT_HEAD (key
);
9850 if (help_char_p (head
) && t
> 0)
9852 read_key_sequence_cmd
= Vprefix_help_command
;
9854 last_nonmenu_event
= key
;
9855 /* The Microsoft C compiler can't handle the goto that
9863 Lisp_Object breakdown
;
9866 breakdown
= parse_modifiers (head
);
9867 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9868 /* Attempt to reduce an unbound mouse event to a simpler
9869 event that is bound:
9870 Drags reduce to clicks.
9871 Double-clicks reduce to clicks.
9872 Triple-clicks reduce to double-clicks, then to clicks.
9873 Down-clicks are eliminated.
9874 Double-downs reduce to downs, then are eliminated.
9875 Triple-downs reduce to double-downs, then to downs,
9876 then are eliminated. */
9877 if (modifiers
& (down_modifier
| drag_modifier
9878 | double_modifier
| triple_modifier
))
9880 while (modifiers
& (down_modifier
| drag_modifier
9881 | double_modifier
| triple_modifier
))
9883 Lisp_Object new_head
, new_click
;
9884 if (modifiers
& triple_modifier
)
9885 modifiers
^= (double_modifier
| triple_modifier
);
9886 else if (modifiers
& double_modifier
)
9887 modifiers
&= ~double_modifier
;
9888 else if (modifiers
& drag_modifier
)
9889 modifiers
&= ~drag_modifier
;
9892 /* Dispose of this `down' event by simply jumping
9893 back to replay_key, to get another event.
9895 Note that if this event came from mock input,
9896 then just jumping back to replay_key will just
9897 hand it to us again. So we have to wipe out any
9900 We could delete keybuf[t] and shift everything
9901 after that to the left by one spot, but we'd also
9902 have to fix up any variable that points into
9903 keybuf, and shifting isn't really necessary
9906 Adding prefixes for non-textual mouse clicks
9907 creates two characters of mock input, and both
9908 must be thrown away. If we're only looking at
9909 the prefix now, we can just jump back to
9910 replay_key. On the other hand, if we've already
9911 processed the prefix, and now the actual click
9912 itself is giving us trouble, then we've lost the
9913 state of the keymaps we want to backtrack to, and
9914 we need to replay the whole sequence to rebuild
9917 Beyond that, only function key expansion could
9918 create more than two keys, but that should never
9919 generate mouse events, so it's okay to zero
9920 mock_input in that case too.
9922 FIXME: The above paragraph seems just plain
9923 wrong, if you consider things like
9924 xterm-mouse-mode. -stef
9926 Isn't this just the most wonderful code ever? */
9928 /* If mock_input > t + 1, the above simplification
9929 will actually end up dropping keys on the floor.
9930 This is probably OK for now, but even
9931 if mock_input <= t + 1, we need to adjust indec,
9933 Typical case [header-line down-mouse-N]:
9934 mock_input = 2, t = 1, fkey.end = 1,
9935 last_real_key_start = 0. */
9936 if (indec
.end
> last_real_key_start
)
9938 indec
.end
= indec
.start
9939 = min (last_real_key_start
, indec
.start
);
9940 indec
.map
= indec
.parent
;
9941 if (fkey
.end
> last_real_key_start
)
9943 fkey
.end
= fkey
.start
9944 = min (last_real_key_start
, fkey
.start
);
9945 fkey
.map
= fkey
.parent
;
9946 if (keytran
.end
> last_real_key_start
)
9948 keytran
.end
= keytran
.start
9949 = min (last_real_key_start
, keytran
.start
);
9950 keytran
.map
= keytran
.parent
;
9954 if (t
== last_real_key_start
)
9961 mock_input
= last_real_key_start
;
9962 goto replay_sequence
;
9967 = apply_modifiers (modifiers
, XCAR (breakdown
));
9969 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9971 /* Look for a binding for this new key. follow_key
9972 promises that it didn't munge submaps the
9973 last time we called it, since key was unbound. */
9975 = (follow_key (new_click
,
9976 nmaps
- local_first_binding
,
9977 submaps
+ local_first_binding
,
9978 defs
+ local_first_binding
,
9979 submaps
+ local_first_binding
)
9980 + local_first_binding
);
9982 /* If that click is bound, go for it. */
9983 if (first_binding
< nmaps
)
9988 /* Otherwise, we'll leave key set to the drag event. */
9995 /* Normally, last_nonmenu_event gets the previous key we read.
9996 But when a mouse popup menu is being used,
9997 we don't update last_nonmenu_event; it continues to hold the mouse
9998 event that preceded the first level of menu. */
9999 if (!used_mouse_menu
)
10000 last_nonmenu_event
= key
;
10002 /* Record what part of this_command_keys is the current key sequence. */
10003 this_single_command_key_start
= this_command_key_count
- t
;
10005 /* Look for this sequence in input-decode-map.
10006 Scan from indec.end until we find a bound suffix. */
10007 while (indec
.end
< t
)
10009 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10012 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10013 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
10018 mock_input
= diff
+ max (t
, mock_input
);
10019 goto replay_sequence
;
10023 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
10024 && indec
.start
>= t
)
10025 /* There is a binding and it's not a prefix.
10026 (and it doesn't have any input-decode-map translation pending).
10027 There is thus no function-key in this sequence.
10028 Moving fkey.start is important in this case to allow keytran.start
10029 to go over the sequence before we return (since we keep the
10030 invariant that keytran.end <= fkey.start). */
10032 if (fkey
.start
< t
)
10033 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10036 /* If the sequence is unbound, see if we can hang a function key
10037 off the end of it. */
10038 /* Continue scan from fkey.end until we find a bound suffix. */
10039 while (fkey
.end
< indec
.start
)
10041 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10044 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10045 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10046 max (t
, mock_input
),
10047 /* If there's a binding (i.e.
10048 first_binding >= nmaps) we don't want
10049 to apply this function-key-mapping. */
10050 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10055 mock_input
= diff
+ max (t
, mock_input
);
10056 /* Adjust the input-decode-map counters. */
10058 indec
.start
+= diff
;
10060 goto replay_sequence
;
10064 /* Look for this sequence in key-translation-map.
10065 Scan from keytran.end until we find a bound suffix. */
10066 while (keytran
.end
< fkey
.start
)
10068 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10071 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10072 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10077 mock_input
= diff
+ max (t
, mock_input
);
10078 /* Adjust the function-key-map and input-decode-map counters. */
10080 indec
.start
+= diff
;
10082 fkey
.start
+= diff
;
10084 goto replay_sequence
;
10088 /* If KEY is not defined in any of the keymaps,
10089 and cannot be part of a function key or translation,
10090 and is an upper case letter
10091 use the corresponding lower-case letter instead. */
10092 if (first_binding
>= nmaps
10093 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10095 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10096 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10097 || (XINT (key
) & shift_modifier
)))
10099 Lisp_Object new_key
;
10101 original_uppercase
= key
;
10102 original_uppercase_position
= t
- 1;
10104 if (XINT (key
) & shift_modifier
)
10105 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10107 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10108 | (XINT (key
) & ~CHAR_MODIFIER_MASK
)));
10110 /* We have to do this unconditionally, regardless of whether
10111 the lower-case char is defined in the keymaps, because they
10112 might get translated through function-key-map. */
10113 keybuf
[t
- 1] = new_key
;
10114 mock_input
= max (t
, mock_input
);
10116 goto replay_sequence
;
10118 /* If KEY is not defined in any of the keymaps,
10119 and cannot be part of a function key or translation,
10120 and is a shifted function key,
10121 use the corresponding unshifted function key instead. */
10122 if (first_binding
>= nmaps
10123 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10125 Lisp_Object breakdown
= parse_modifiers (key
);
10127 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10129 if (modifiers
& shift_modifier
10130 /* Treat uppercase keys as shifted. */
10132 && (KEY_TO_CHAR (key
)
10133 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10134 && UPPERCASEP (KEY_TO_CHAR (key
))))
10136 Lisp_Object new_key
10137 = (modifiers
& shift_modifier
10138 ? apply_modifiers (modifiers
& ~shift_modifier
,
10140 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10142 original_uppercase
= key
;
10143 original_uppercase_position
= t
- 1;
10145 /* We have to do this unconditionally, regardless of whether
10146 the lower-case char is defined in the keymaps, because they
10147 might get translated through function-key-map. */
10148 keybuf
[t
- 1] = new_key
;
10149 mock_input
= max (t
, mock_input
);
10150 /* Reset fkey (and consequently keytran) to apply
10151 function-key-map on the result, so that S-backspace is
10152 correctly mapped to DEL (via backspace). OTOH,
10153 input-decode-map doesn't need to go through it again. */
10154 fkey
.start
= fkey
.end
= 0;
10155 keytran
.start
= keytran
.end
= 0;
10157 goto replay_sequence
;
10162 read_key_sequence_cmd
= (first_binding
< nmaps
10163 ? defs
[first_binding
]
10166 unread_switch_frame
= delayed_switch_frame
;
10167 unbind_to (count
, Qnil
);
10169 /* Don't downcase the last character if the caller says don't.
10170 Don't downcase it if the result is undefined, either. */
10171 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10173 && t
- 1 == original_uppercase_position
)
10174 keybuf
[t
- 1] = original_uppercase
;
10176 /* Occasionally we fabricate events, perhaps by expanding something
10177 according to function-key-map, or by adding a prefix symbol to a
10178 mouse click in the scroll bar or modeline. In this cases, return
10179 the entire generated key sequence, even if we hit an unbound
10180 prefix or a definition before the end. This means that you will
10181 be able to push back the event properly, and also means that
10182 read-key-sequence will always return a logical unit.
10185 for (; t
< mock_input
; t
++)
10187 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10188 && NILP (Fzerop (Vecho_keystrokes
)))
10189 echo_char (keybuf
[t
]);
10190 add_command_key (keybuf
[t
]);
10199 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10200 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10201 The sequence is sufficient to specify a non-prefix command in the
10202 current local and global maps.
10204 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10205 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10206 as a continuation of the previous key.
10208 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10209 convert the last event to lower case. (Normally any upper case event
10210 is converted to lower case if the original event is undefined and the lower
10211 case equivalent is defined.) A non-nil value is appropriate for reading
10212 a key sequence to be defined.
10214 A C-g typed while in this function is treated like any other character,
10215 and `quit-flag' is not set.
10217 If the key sequence starts with a mouse click, then the sequence is read
10218 using the keymaps of the buffer of the window clicked in, not the buffer
10219 of the selected window as normal.
10221 `read-key-sequence' drops unbound button-down events, since you normally
10222 only care about the click or drag events which follow them. If a drag
10223 or multi-click event is unbound, but the corresponding click event would
10224 be bound, `read-key-sequence' turns the event into a click event at the
10225 drag's starting position. This means that you don't have to distinguish
10226 between click and drag, double, or triple events unless you want to.
10228 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10229 lines separating windows, and scroll bars with imaginary keys
10230 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10232 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10233 function will process a switch-frame event if the user switches frames
10234 before typing anything. If the user switches frames in the middle of a
10235 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10236 is nil, then the event will be put off until after the current key sequence.
10238 `read-key-sequence' checks `function-key-map' for function key
10239 sequences, where they wouldn't conflict with ordinary bindings. See
10240 `function-key-map' for more details.
10242 The optional fifth argument COMMAND-LOOP, if non-nil, means
10243 that this key sequence is being read by something that will
10244 read commands one after another. It should be nil if the caller
10245 will read just one key sequence. */)
10246 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10248 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10249 Lisp_Object can_return_switch_frame
, command_loop
;
10251 Lisp_Object keybuf
[30];
10253 struct gcpro gcpro1
;
10254 int count
= SPECPDL_INDEX ();
10256 if (!NILP (prompt
))
10257 CHECK_STRING (prompt
);
10260 specbind (Qinput_method_exit_on_first_char
,
10261 (NILP (command_loop
) ? Qt
: Qnil
));
10262 specbind (Qinput_method_use_echo_area
,
10263 (NILP (command_loop
) ? Qt
: Qnil
));
10265 bzero (keybuf
, sizeof keybuf
);
10266 GCPRO1 (keybuf
[0]);
10267 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10269 if (NILP (continue_echo
))
10271 this_command_key_count
= 0;
10272 this_command_key_count_reset
= 0;
10273 this_single_command_key_start
= 0;
10276 #ifdef HAVE_X_WINDOWS
10277 if (display_hourglass_p
)
10278 cancel_hourglass ();
10281 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10282 prompt
, ! NILP (dont_downcase_last
),
10283 ! NILP (can_return_switch_frame
), 0);
10285 #if 0 /* The following is fine for code reading a key sequence and
10286 then proceeding with a lenghty computation, but it's not good
10287 for code reading keys in a loop, like an input method. */
10288 #ifdef HAVE_X_WINDOWS
10289 if (display_hourglass_p
)
10290 start_hourglass ();
10300 return unbind_to (count
, make_event_array (i
, keybuf
));
10303 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10304 Sread_key_sequence_vector
, 1, 5, 0,
10305 doc
: /* Like `read-key-sequence' but always return a vector. */)
10306 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10308 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10309 Lisp_Object can_return_switch_frame
, command_loop
;
10311 Lisp_Object keybuf
[30];
10313 struct gcpro gcpro1
;
10314 int count
= SPECPDL_INDEX ();
10316 if (!NILP (prompt
))
10317 CHECK_STRING (prompt
);
10320 specbind (Qinput_method_exit_on_first_char
,
10321 (NILP (command_loop
) ? Qt
: Qnil
));
10322 specbind (Qinput_method_use_echo_area
,
10323 (NILP (command_loop
) ? Qt
: Qnil
));
10325 bzero (keybuf
, sizeof keybuf
);
10326 GCPRO1 (keybuf
[0]);
10327 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10329 if (NILP (continue_echo
))
10331 this_command_key_count
= 0;
10332 this_command_key_count_reset
= 0;
10333 this_single_command_key_start
= 0;
10336 #ifdef HAVE_X_WINDOWS
10337 if (display_hourglass_p
)
10338 cancel_hourglass ();
10341 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10342 prompt
, ! NILP (dont_downcase_last
),
10343 ! NILP (can_return_switch_frame
), 0);
10345 #ifdef HAVE_X_WINDOWS
10346 if (display_hourglass_p
)
10347 start_hourglass ();
10356 return unbind_to (count
, Fvector (i
, keybuf
));
10359 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10360 doc
: /* Execute CMD as an editor command.
10361 CMD must be a symbol that satisfies the `commandp' predicate.
10362 Optional second arg RECORD-FLAG non-nil
10363 means unconditionally put this command in `command-history'.
10364 Otherwise, that is done only if an arg is read using the minibuffer.
10365 The argument KEYS specifies the value to use instead of (this-command-keys)
10366 when reading the arguments; if it is nil, (this-command-keys) is used.
10367 The argument SPECIAL, if non-nil, means that this command is executing
10368 a special event, so ignore the prefix argument and don't clear it. */)
10369 (cmd
, record_flag
, keys
, special
)
10370 Lisp_Object cmd
, record_flag
, keys
, special
;
10372 register Lisp_Object final
;
10373 register Lisp_Object tem
;
10374 Lisp_Object prefixarg
;
10375 extern int debug_on_next_call
;
10377 debug_on_next_call
= 0;
10379 if (NILP (special
))
10381 prefixarg
= current_kboard
->Vprefix_arg
;
10382 Vcurrent_prefix_arg
= prefixarg
;
10383 current_kboard
->Vprefix_arg
= Qnil
;
10390 tem
= Fget (cmd
, Qdisabled
);
10391 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10393 tem
= Fsymbol_value (Qdisabled_command_function
);
10395 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10401 final
= Findirect_function (cmd
, Qnil
);
10403 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10405 struct gcpro gcpro1
, gcpro2
;
10407 GCPRO2 (cmd
, prefixarg
);
10408 do_autoload (final
, cmd
);
10415 if (STRINGP (final
) || VECTORP (final
))
10417 /* If requested, place the macro in the command history. For
10418 other sorts of commands, call-interactively takes care of
10420 if (!NILP (record_flag
))
10423 = Fcons (Fcons (Qexecute_kbd_macro
,
10424 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10427 /* Don't keep command history around forever. */
10428 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10430 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10432 XSETCDR (tem
, Qnil
);
10436 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10439 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10440 /* Don't call Fcall_interactively directly because we want to make
10441 sure the backtrace has an entry for `call-interactively'.
10442 For the same reason, pass `cmd' rather than `final'. */
10443 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10450 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10452 doc
: /* Read function name, then read its arguments and call it.
10454 To pass a numeric argument to the command you are invoking with, specify
10455 the numeric argument to this command.
10457 Noninteractively, the argument PREFIXARG is the prefix argument to
10458 give to the command you invoke, if it asks for an argument. */)
10460 Lisp_Object prefixarg
;
10462 Lisp_Object function
;
10464 int saved_last_point_position
;
10465 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10466 Lisp_Object bindings
, value
;
10467 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10468 #ifdef HAVE_X_WINDOWS
10469 /* The call to Fcompleting_read wil start and cancel the hourglass,
10470 but if the hourglass was already scheduled, this means that no
10471 hourglass will be shown for the actual M-x command itself.
10472 So we restart it if it is already scheduled. Note that checking
10473 hourglass_shown_p is not enough, normally the hourglass is not shown,
10474 just scheduled to be shown. */
10475 int hstarted
= hourglass_started ();
10478 saved_keys
= Fvector (this_command_key_count
,
10479 XVECTOR (this_command_keys
)->contents
);
10480 saved_last_point_position_buffer
= last_point_position_buffer
;
10481 saved_last_point_position
= last_point_position
;
10483 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10485 if (EQ (prefixarg
, Qminus
))
10486 strcpy (buf
, "- ");
10487 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10488 strcpy (buf
, "C-u ");
10489 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10490 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10491 else if (INTEGERP (prefixarg
))
10492 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10494 /* This isn't strictly correct if execute-extended-command
10495 is bound to anything else. Perhaps it should use
10496 this_command_keys? */
10497 strcat (buf
, "M-x ");
10499 /* Prompt with buf, and then read a string, completing from and
10500 restricting to the set of all defined commands. Don't provide
10501 any initial input. Save the command read on the extended-command
10503 function
= Fcompleting_read (build_string (buf
),
10504 Vobarray
, Qcommandp
,
10505 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10508 #ifdef HAVE_X_WINDOWS
10509 if (hstarted
) start_hourglass ();
10512 if (STRINGP (function
) && SCHARS (function
) == 0)
10513 error ("No command name given");
10515 /* Set this_command_keys to the concatenation of saved_keys and
10516 function, followed by a RET. */
10521 this_command_key_count
= 0;
10522 this_command_key_count_reset
= 0;
10523 this_single_command_key_start
= 0;
10525 keys
= XVECTOR (saved_keys
)->contents
;
10526 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10527 add_command_key (keys
[i
]);
10529 for (i
= 0; i
< SCHARS (function
); i
++)
10530 add_command_key (Faref (function
, make_number (i
)));
10532 add_command_key (make_number ('\015'));
10535 last_point_position
= saved_last_point_position
;
10536 last_point_position_buffer
= saved_last_point_position_buffer
;
10540 function
= Fintern (function
, Qnil
);
10541 current_kboard
->Vprefix_arg
= prefixarg
;
10542 Vthis_command
= function
;
10543 real_this_command
= function
;
10545 /* If enabled, show which key runs this command. */
10546 if (!NILP (Vsuggest_key_bindings
)
10547 && NILP (Vexecuting_kbd_macro
)
10548 && SYMBOLP (function
))
10549 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10555 GCPRO3 (bindings
, value
, function
);
10556 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10558 /* If the command has a key binding, print it now. */
10559 if (!NILP (bindings
)
10560 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10563 /* But first wait, and skip the message if there is input. */
10564 Lisp_Object waited
;
10566 /* If this command displayed something in the echo area;
10567 wait a few seconds, then display our suggestion message. */
10568 if (NILP (echo_area_buffer
[0]))
10569 waited
= sit_for (make_number (0), 0, 2);
10570 else if (NUMBERP (Vsuggest_key_bindings
))
10571 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10573 waited
= sit_for (make_number (2), 0, 2);
10575 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10577 Lisp_Object binding
;
10579 int message_p
= push_message ();
10580 int count
= SPECPDL_INDEX ();
10582 record_unwind_protect (pop_message_unwind
, Qnil
);
10583 binding
= Fkey_description (bindings
, Qnil
);
10586 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10589 sprintf (newmessage
, "You can run the command `%s' with %s",
10590 SDATA (SYMBOL_NAME (function
)),
10592 message2_nolog (newmessage
,
10593 strlen (newmessage
),
10594 STRING_MULTIBYTE (binding
));
10595 if (NUMBERP (Vsuggest_key_bindings
))
10596 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10598 waited
= sit_for (make_number (2), 0, 2);
10600 if (!NILP (waited
) && message_p
)
10601 restore_message ();
10603 unbind_to (count
, Qnil
);
10607 RETURN_UNGCPRO (value
);
10611 /* Return nonzero if input events are pending. */
10614 detect_input_pending ()
10616 if (!input_pending
)
10617 get_input_pending (&input_pending
, 0);
10619 return input_pending
;
10622 /* Return nonzero if input events other than mouse movements are
10626 detect_input_pending_ignore_squeezables ()
10628 if (!input_pending
)
10629 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10631 return input_pending
;
10634 /* Return nonzero if input events are pending, and run any pending timers. */
10637 detect_input_pending_run_timers (do_display
)
10640 int old_timers_run
= timers_run
;
10642 if (!input_pending
)
10643 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10645 if (old_timers_run
!= timers_run
&& do_display
)
10647 redisplay_preserve_echo_area (8);
10648 /* The following fixes a bug when using lazy-lock with
10649 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10650 from an idle timer function. The symptom of the bug is that
10651 the cursor sometimes doesn't become visible until the next X
10652 event is processed. --gerd. */
10654 Lisp_Object tail
, frame
;
10655 FOR_EACH_FRAME (tail
, frame
)
10656 if (FRAME_RIF (XFRAME (frame
)))
10657 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10661 return input_pending
;
10664 /* This is called in some cases before a possible quit.
10665 It cases the next call to detect_input_pending to recompute input_pending.
10666 So calling this function unnecessarily can't do any harm. */
10669 clear_input_pending ()
10674 /* Return nonzero if there are pending requeued events.
10675 This isn't used yet. The hope is to make wait_reading_process_output
10676 call it, and return if it runs Lisp code that unreads something.
10677 The problem is, kbd_buffer_get_event needs to be fixed to know what
10678 to do in that case. It isn't trivial. */
10681 requeued_events_pending_p ()
10683 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10687 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10688 doc
: /* Return t if command input is currently available with no wait.
10689 Actually, the value is nil only if we can be sure that no input is available;
10690 if there is a doubt, the value is t. */)
10693 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10694 || !NILP (Vunread_post_input_method_events
)
10695 || !NILP (Vunread_input_method_events
))
10698 get_input_pending (&input_pending
,
10699 READABLE_EVENTS_DO_TIMERS_NOW
10700 | READABLE_EVENTS_FILTER_EVENTS
);
10701 return input_pending
> 0 ? Qt
: Qnil
;
10704 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10705 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10708 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10711 if (total_keys
< NUM_RECENT_KEYS
)
10712 return Fvector (total_keys
, keys
);
10715 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10716 bcopy (keys
+ recent_keys_index
,
10717 XVECTOR (val
)->contents
,
10718 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10720 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10721 recent_keys_index
* sizeof (Lisp_Object
));
10726 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10727 doc
: /* Return the key sequence that invoked this command.
10728 However, if the command has called `read-key-sequence', it returns
10729 the last key sequence that has been read.
10730 The value is a string or a vector.
10732 See also `this-command-keys-vector'. */)
10735 return make_event_array (this_command_key_count
,
10736 XVECTOR (this_command_keys
)->contents
);
10739 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10740 doc
: /* Return the key sequence that invoked this command, as a vector.
10741 However, if the command has called `read-key-sequence', it returns
10742 the last key sequence that has been read.
10744 See also `this-command-keys'. */)
10747 return Fvector (this_command_key_count
,
10748 XVECTOR (this_command_keys
)->contents
);
10751 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10752 Sthis_single_command_keys
, 0, 0, 0,
10753 doc
: /* Return the key sequence that invoked this command.
10754 More generally, it returns the last key sequence read, either by
10755 the command loop or by `read-key-sequence'.
10756 Unlike `this-command-keys', this function's value
10757 does not include prefix arguments.
10758 The value is always a vector. */)
10761 return Fvector (this_command_key_count
10762 - this_single_command_key_start
,
10763 (XVECTOR (this_command_keys
)->contents
10764 + this_single_command_key_start
));
10767 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10768 Sthis_single_command_raw_keys
, 0, 0, 0,
10769 doc
: /* Return the raw events that were read for this command.
10770 More generally, it returns the last key sequence read, either by
10771 the command loop or by `read-key-sequence'.
10772 Unlike `this-single-command-keys', this function's value
10773 shows the events before all translations (except for input methods).
10774 The value is always a vector. */)
10777 return Fvector (raw_keybuf_count
,
10778 (XVECTOR (raw_keybuf
)->contents
));
10781 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10782 Sreset_this_command_lengths
, 0, 0, 0,
10783 doc
: /* Make the unread events replace the last command and echo.
10784 Used in `universal-argument-other-key'.
10786 `universal-argument-other-key' rereads the event just typed.
10787 It then gets translated through `function-key-map'.
10788 The translated event has to replace the real events,
10789 both in the value of (this-command-keys) and in echoing.
10790 To achieve this, `universal-argument-other-key' calls
10791 `reset-this-command-lengths', which discards the record of reading
10792 these events the first time. */)
10795 this_command_key_count
= before_command_key_count
;
10796 if (this_command_key_count
< this_single_command_key_start
)
10797 this_single_command_key_start
= this_command_key_count
;
10799 echo_truncate (before_command_echo_length
);
10801 /* Cause whatever we put into unread-command-events
10802 to echo as if it were being freshly read from the keyboard. */
10803 this_command_key_count_reset
= 1;
10808 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10809 Sclear_this_command_keys
, 0, 1, 0,
10810 doc
: /* Clear out the vector that `this-command-keys' returns.
10811 Also clear the record of the last 100 events, unless optional arg
10812 KEEP-RECORD is non-nil. */)
10814 Lisp_Object keep_record
;
10818 this_command_key_count
= 0;
10819 this_command_key_count_reset
= 0;
10821 if (NILP (keep_record
))
10823 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10824 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10826 recent_keys_index
= 0;
10831 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10832 doc
: /* Return the current depth in recursive edits. */)
10836 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10840 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10841 "FOpen dribble file: ",
10842 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10843 If FILE is nil, close any open dribble file. */)
10856 file
= Fexpand_file_name (file
, Qnil
);
10857 dribble
= fopen (SDATA (file
), "w");
10859 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10864 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10865 doc
: /* Discard the contents of the terminal input buffer.
10866 Also end any kbd macro being defined. */)
10869 if (!NILP (current_kboard
->defining_kbd_macro
))
10871 /* Discard the last command from the macro. */
10872 Fcancel_kbd_macro_events ();
10876 update_mode_lines
++;
10878 Vunread_command_events
= Qnil
;
10879 unread_command_char
= -1;
10881 discard_tty_input ();
10883 kbd_fetch_ptr
= kbd_store_ptr
;
10889 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10890 doc
: /* Stop Emacs and return to superior process. You can resume later.
10891 If `cannot-suspend' is non-nil, or if the system doesn't support job
10892 control, run a subshell instead.
10894 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10895 to be read as terminal input by Emacs's parent, after suspension.
10897 Before suspending, run the normal hook `suspend-hook'.
10898 After resumption run the normal hook `suspend-resume-hook'.
10900 Some operating systems cannot stop the Emacs process and resume it later.
10901 On such systems, Emacs starts a subshell instead of suspending. */)
10903 Lisp_Object stuffstring
;
10905 int count
= SPECPDL_INDEX ();
10906 int old_height
, old_width
;
10908 struct gcpro gcpro1
;
10910 if (tty_list
&& tty_list
->next
)
10911 error ("There are other tty frames open; close them before suspending Emacs");
10913 if (!NILP (stuffstring
))
10914 CHECK_STRING (stuffstring
);
10916 /* Run the functions in suspend-hook. */
10917 if (!NILP (Vrun_hooks
))
10918 call1 (Vrun_hooks
, intern ("suspend-hook"));
10920 GCPRO1 (stuffstring
);
10921 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10922 reset_all_sys_modes ();
10923 /* sys_suspend can get an error if it tries to fork a subshell
10924 and the system resources aren't available for that. */
10925 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10927 stuff_buffered_input (stuffstring
);
10928 if (cannot_suspend
)
10932 unbind_to (count
, Qnil
);
10934 /* Check if terminal/window size has changed.
10935 Note that this is not useful when we are running directly
10936 with a window system; but suspend should be disabled in that case. */
10937 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10938 if (width
!= old_width
|| height
!= old_height
)
10939 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10941 /* Run suspend-resume-hook. */
10942 if (!NILP (Vrun_hooks
))
10943 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10949 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10950 Then in any case stuff anything Emacs has read ahead and not used. */
10953 stuff_buffered_input (stuffstring
)
10954 Lisp_Object stuffstring
;
10956 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10957 register unsigned char *p
;
10959 if (STRINGP (stuffstring
))
10961 register int count
;
10963 p
= SDATA (stuffstring
);
10964 count
= SBYTES (stuffstring
);
10965 while (count
-- > 0)
10970 /* Anything we have read ahead, put back for the shell to read. */
10971 /* ?? What should this do when we have multiple keyboards??
10972 Should we ignore anything that was typed in at the "wrong" kboard?
10974 rms: we should stuff everything back into the kboard
10976 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10979 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10980 kbd_fetch_ptr
= kbd_buffer
;
10981 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10982 stuff_char (kbd_fetch_ptr
->code
);
10984 clear_event (kbd_fetch_ptr
);
10988 #endif /* SIGTSTP */
10992 set_waiting_for_input (time_to_clear
)
10993 EMACS_TIME
*time_to_clear
;
10995 input_available_clear_time
= time_to_clear
;
10997 /* Tell handle_interrupt to throw back to read_char, */
10998 waiting_for_input
= 1;
11000 /* If handle_interrupt was called before and buffered a C-g,
11001 make it run again now, to avoid timing error. */
11002 if (!NILP (Vquit_flag
))
11003 quit_throw_to_read_char ();
11007 clear_waiting_for_input ()
11009 /* Tell handle_interrupt not to throw back to read_char, */
11010 waiting_for_input
= 0;
11011 input_available_clear_time
= 0;
11014 /* The SIGINT handler.
11016 If we have a frame on the controlling tty, we assume that the
11017 SIGINT was generated by C-g, so we call handle_interrupt.
11018 Otherwise, the handler kills Emacs. */
11021 interrupt_signal (signalnum
) /* If we don't have an argument, */
11022 int signalnum
; /* some compilers complain in signal calls. */
11024 /* Must preserve main program's value of errno. */
11025 int old_errno
= errno
;
11026 struct terminal
*terminal
;
11028 #if defined (USG) && !defined (POSIX_SIGNALS)
11029 /* USG systems forget handlers when they are used;
11030 must reestablish each time */
11031 signal (SIGINT
, interrupt_signal
);
11032 signal (SIGQUIT
, interrupt_signal
);
11035 SIGNAL_THREAD_CHECK (signalnum
);
11037 /* See if we have an active terminal on our controlling tty. */
11038 terminal
= get_named_tty ("/dev/tty");
11041 /* If there are no frames there, let's pretend that we are a
11042 well-behaving UN*X program and quit. */
11043 Fkill_emacs (Qnil
);
11047 /* Otherwise, the SIGINT was probably generated by C-g. */
11049 /* Set internal_last_event_frame to the top frame of the
11050 controlling tty, if we have a frame there. We disable the
11051 interrupt key on secondary ttys, so the SIGINT must have come
11052 from the controlling tty. */
11053 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11055 handle_interrupt ();
11061 /* This routine is called at interrupt level in response to C-g.
11063 It is called from the SIGINT handler or kbd_buffer_store_event.
11065 If `waiting_for_input' is non zero, then unless `echoing' is
11066 nonzero, immediately throw back to read_char.
11068 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11069 eval to throw, when it gets a chance. If quit-flag is already
11070 non-nil, it stops the job right away. */
11073 handle_interrupt ()
11079 /* XXX This code needs to be revised for multi-tty support. */
11080 if (!NILP (Vquit_flag
)
11082 && get_named_tty ("/dev/tty")
11086 /* If SIGINT isn't blocked, don't let us be interrupted by
11087 another SIGINT, it might be harmful due to non-reentrancy
11088 in I/O functions. */
11089 sigblock (sigmask (SIGINT
));
11092 reset_all_sys_modes ();
11094 #ifdef SIGTSTP /* Support possible in later USG versions */
11096 * On systems which can suspend the current process and return to the original
11097 * shell, this command causes the user to end up back at the shell.
11098 * The "Auto-save" and "Abort" questions are not asked until
11099 * the user elects to return to emacs, at which point he can save the current
11100 * job and either dump core or continue.
11105 if (sys_suspend () == -1)
11107 printf ("Not running as a subprocess;\n");
11108 printf ("you can continue or abort.\n");
11110 #else /* not VMS */
11111 /* Perhaps should really fork an inferior shell?
11112 But that would not provide any way to get back
11113 to the original shell, ever. */
11114 printf ("No support for stopping a process on this operating system;\n");
11115 printf ("you can continue or abort.\n");
11116 #endif /* not VMS */
11117 #endif /* not SIGTSTP */
11119 /* We must remain inside the screen area when the internal terminal
11120 is used. Note that [Enter] is not echoed by dos. */
11123 /* It doesn't work to autosave while GC is in progress;
11124 the code used for auto-saving doesn't cope with the mark bit. */
11125 if (!gc_in_progress
)
11127 printf ("Auto-save? (y or n) ");
11129 if (((c
= getchar ()) & ~040) == 'Y')
11131 Fdo_auto_save (Qt
, Qnil
);
11133 printf ("\r\nAuto-save done");
11134 #else /* not MSDOS */
11135 printf ("Auto-save done\n");
11136 #endif /* not MSDOS */
11138 while (c
!= '\n') c
= getchar ();
11142 /* During GC, it must be safe to reenable quitting again. */
11143 Vinhibit_quit
= Qnil
;
11146 #endif /* not MSDOS */
11147 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11148 printf ("but will instead do a real quit after garbage collection ends\r\n");
11153 printf ("\r\nAbort? (y or n) ");
11154 #else /* not MSDOS */
11156 printf ("Abort (and enter debugger)? (y or n) ");
11157 #else /* not VMS */
11158 printf ("Abort (and dump core)? (y or n) ");
11159 #endif /* not VMS */
11160 #endif /* not MSDOS */
11162 if (((c
= getchar ()) & ~040) == 'Y')
11164 while (c
!= '\n') c
= getchar ();
11166 printf ("\r\nContinuing...\r\n");
11167 #else /* not MSDOS */
11168 printf ("Continuing...\n");
11169 #endif /* not MSDOS */
11171 init_all_sys_modes ();
11176 /* If executing a function that wants to be interrupted out of
11177 and the user has not deferred quitting by binding `inhibit-quit'
11178 then quit right away. */
11179 if (immediate_quit
&& NILP (Vinhibit_quit
))
11181 struct gl_state_s saved
;
11182 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11184 immediate_quit
= 0;
11187 GCPRO4 (saved
.object
, saved
.global_code
,
11188 saved
.current_syntax_table
, saved
.old_prop
);
11189 Fsignal (Qquit
, Qnil
);
11194 /* Else request quit when it's safe */
11198 if (waiting_for_input
&& !echoing
)
11199 quit_throw_to_read_char ();
11202 /* Handle a C-g by making read_char return C-g. */
11205 quit_throw_to_read_char ()
11208 /* Prevent another signal from doing this before we finish. */
11209 clear_waiting_for_input ();
11212 Vunread_command_events
= Qnil
;
11213 unread_command_char
= -1;
11215 #if 0 /* Currently, sit_for is called from read_char without turning
11216 off polling. And that can call set_waiting_for_input.
11217 It seems to be harmless. */
11218 #ifdef POLL_FOR_INPUT
11219 /* May be > 1 if in recursive minibuffer. */
11220 if (poll_suppress_count
== 0)
11224 if (FRAMEP (internal_last_event_frame
)
11225 && !EQ (internal_last_event_frame
, selected_frame
))
11226 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11229 _longjmp (getcjmp
, 1);
11232 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11233 doc
: /* Set interrupt mode of reading keyboard input.
11234 If INTERRUPT is non-nil, Emacs will use input interrupts;
11235 otherwise Emacs uses CBREAK mode.
11237 See also `current-input-mode'. */)
11239 Lisp_Object interrupt
;
11241 int new_interrupt_input
;
11243 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11244 #ifdef HAVE_X_WINDOWS
11245 if (x_display_list
!= NULL
)
11247 /* When using X, don't give the user a real choice,
11248 because we haven't implemented the mechanisms to support it. */
11249 #ifdef NO_SOCK_SIGIO
11250 new_interrupt_input
= 0;
11251 #else /* not NO_SOCK_SIGIO */
11252 new_interrupt_input
= 1;
11253 #endif /* NO_SOCK_SIGIO */
11257 new_interrupt_input
= !NILP (interrupt
);
11258 #else /* not SIGIO */
11259 new_interrupt_input
= 0;
11260 #endif /* not SIGIO */
11262 /* Our VMS input only works by interrupts, as of now. */
11264 new_interrupt_input
= 1;
11267 if (new_interrupt_input
!= interrupt_input
)
11269 #ifdef POLL_FOR_INPUT
11273 /* this causes startup screen to be restored and messes with the mouse */
11274 reset_all_sys_modes ();
11276 interrupt_input
= new_interrupt_input
;
11278 init_all_sys_modes ();
11281 #ifdef POLL_FOR_INPUT
11282 poll_suppress_count
= 1;
11289 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11290 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11291 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11292 C-q in key sequences.
11294 This setting only has an effect on tty terminals and only when
11295 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11297 See also `current-input-mode'. */)
11299 Lisp_Object flow
, terminal
;
11301 struct terminal
*t
= get_terminal (terminal
, 1);
11302 struct tty_display_info
*tty
;
11303 if (t
== NULL
|| t
->type
!= output_termcap
)
11305 tty
= t
->display_info
.tty
;
11307 if (tty
->flow_control
!= !NILP (flow
))
11310 /* this causes startup screen to be restored and messes with the mouse */
11311 reset_sys_modes (tty
);
11314 tty
->flow_control
= !NILP (flow
);
11317 init_sys_modes (tty
);
11323 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11324 doc
: /* Enable or disable 8-bit input on TERMINAL.
11325 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11326 bit as the Meta modifier.
11328 If META is nil, Emacs will ignore the top bit, on the assumption it is
11331 Otherwise, Emacs will accept and pass through 8-bit input without
11332 specially interpreting the top bit.
11334 This setting only has an effect on tty terminal devices.
11336 Optional parameter TERMINAL specifies the tty terminal device to use.
11337 It may be a terminal id, a frame, or nil for the terminal used by the
11338 currently selected frame.
11340 See also `current-input-mode'. */)
11342 Lisp_Object meta
, terminal
;
11344 struct terminal
*t
= get_terminal (terminal
, 1);
11345 struct tty_display_info
*tty
;
11348 if (t
== NULL
|| t
->type
!= output_termcap
)
11350 tty
= t
->display_info
.tty
;
11354 else if (EQ (meta
, Qt
))
11359 if (tty
->meta_key
!= new_meta
)
11362 /* this causes startup screen to be restored and messes with the mouse */
11363 reset_sys_modes (tty
);
11366 tty
->meta_key
= new_meta
;
11369 init_sys_modes (tty
);
11375 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11376 doc
: /* Specify character used for quitting.
11377 QUIT must be an ASCII character.
11379 This function only has an effect on the controlling tty of the Emacs
11382 See also `current-input-mode'. */)
11386 struct terminal
*t
= get_named_tty ("/dev/tty");
11387 struct tty_display_info
*tty
;
11388 if (t
== NULL
|| t
->type
!= output_termcap
)
11390 tty
= t
->display_info
.tty
;
11392 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11393 error ("QUIT must be an ASCII character");
11396 /* this causes startup screen to be restored and messes with the mouse */
11397 reset_sys_modes (tty
);
11400 /* Don't let this value be out of range. */
11401 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11404 init_sys_modes (tty
);
11410 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11411 doc
: /* Set mode of reading keyboard input.
11412 First arg INTERRUPT non-nil means use input interrupts;
11413 nil means use CBREAK mode.
11414 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11415 (no effect except in CBREAK mode).
11416 Third arg META t means accept 8-bit input (for a Meta key).
11417 META nil means ignore the top bit, on the assumption it is parity.
11418 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11419 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11420 See also `current-input-mode'. */)
11421 (interrupt
, flow
, meta
, quit
)
11422 Lisp_Object interrupt
, flow
, meta
, quit
;
11424 Fset_input_interrupt_mode (interrupt
);
11425 Fset_output_flow_control (flow
, Qnil
);
11426 Fset_input_meta_mode (meta
, Qnil
);
11428 Fset_quit_char (quit
);
11432 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11433 doc
: /* Return information about the way Emacs currently reads keyboard input.
11434 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11435 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11436 nil, Emacs is using CBREAK mode.
11437 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11438 terminal; this does not apply if Emacs uses interrupt-driven input.
11439 META is t if accepting 8-bit input with 8th bit as Meta flag.
11440 META nil means ignoring the top bit, on the assumption it is parity.
11441 META is neither t nor nil if accepting 8-bit input and using
11442 all 8 bits as the character code.
11443 QUIT is the character Emacs currently uses to quit.
11444 The elements of this list correspond to the arguments of
11445 `set-input-mode'. */)
11448 Lisp_Object val
[4];
11449 struct frame
*sf
= XFRAME (selected_frame
);
11451 val
[0] = interrupt_input
? Qt
: Qnil
;
11452 if (FRAME_TERMCAP_P (sf
))
11454 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11455 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11457 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11464 XSETFASTINT (val
[3], quit_char
);
11466 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11469 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11470 doc
: /* Return position information for pixel coordinates X and Y.
11471 By default, X and Y are relative to text area of the selected window.
11472 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11473 If optional fourth arg WHOLE is non-nil, X is relative to the left
11474 edge of the window.
11476 The return value is similar to a mouse click position:
11477 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11478 IMAGE (DX . DY) (WIDTH . HEIGHT))
11479 The `posn-' functions access elements of such lists. */)
11480 (x
, y
, frame_or_window
, whole
)
11481 Lisp_Object x
, y
, frame_or_window
, whole
;
11486 if (NILP (frame_or_window
))
11487 frame_or_window
= selected_window
;
11489 if (WINDOWP (frame_or_window
))
11493 CHECK_LIVE_WINDOW (frame_or_window
);
11495 w
= XWINDOW (frame_or_window
);
11496 XSETINT (x
, (XINT (x
)
11497 + WINDOW_LEFT_EDGE_X (w
)
11499 ? window_box_left_offset (w
, TEXT_AREA
)
11501 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11502 frame_or_window
= w
->frame
;
11505 CHECK_LIVE_FRAME (frame_or_window
);
11507 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11510 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11511 doc
: /* Return position information for buffer POS in WINDOW.
11512 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11514 Return nil if position is not visible in window. Otherwise,
11515 the return value is similar to that returned by `event-start' for
11516 a mouse click at the upper left corner of the glyph corresponding
11517 to the given buffer position:
11518 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11519 IMAGE (DX . DY) (WIDTH . HEIGHT))
11520 The `posn-' functions access elements of such lists. */)
11522 Lisp_Object pos
, window
;
11527 window
= selected_window
;
11529 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11532 Lisp_Object x
= XCAR (tem
);
11533 Lisp_Object y
= XCAR (XCDR (tem
));
11535 /* Point invisible due to hscrolling? */
11538 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11546 * Set up a new kboard object with reasonable initial values.
11552 kb
->Voverriding_terminal_local_map
= Qnil
;
11553 kb
->Vlast_command
= Qnil
;
11554 kb
->Vreal_last_command
= Qnil
;
11555 kb
->Vkeyboard_translate_table
= Qnil
;
11556 kb
->Vlast_repeatable_command
= Qnil
;
11557 kb
->Vprefix_arg
= Qnil
;
11558 kb
->Vlast_prefix_arg
= Qnil
;
11559 kb
->kbd_queue
= Qnil
;
11560 kb
->kbd_queue_has_data
= 0;
11561 kb
->immediate_echo
= 0;
11562 kb
->echo_string
= Qnil
;
11563 kb
->echo_after_prompt
= -1;
11564 kb
->kbd_macro_buffer
= 0;
11565 kb
->kbd_macro_bufsize
= 0;
11566 kb
->defining_kbd_macro
= Qnil
;
11567 kb
->Vlast_kbd_macro
= Qnil
;
11568 kb
->reference_count
= 0;
11569 kb
->Vsystem_key_alist
= Qnil
;
11570 kb
->system_key_syms
= Qnil
;
11571 kb
->Vwindow_system
= Qt
; /* Unset. */
11572 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11573 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11574 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11575 kb
->Vdefault_minibuffer_frame
= Qnil
;
11579 * Destroy the contents of a kboard object, but not the object itself.
11580 * We use this just before deleting it, or if we're going to initialize
11581 * it a second time.
11587 if (kb
->kbd_macro_buffer
)
11588 xfree (kb
->kbd_macro_buffer
);
11591 #ifdef MULTI_KBOARD
11593 /* Free KB and memory referenced from it. */
11601 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11604 *kbp
= kb
->next_kboard
;
11606 /* Prevent a dangling reference to KB. */
11607 if (kb
== current_kboard
11608 && FRAMEP (selected_frame
)
11609 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11611 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11613 if (current_kboard
== kb
)
11621 #endif /* MULTI_KBOARD */
11626 /* This is correct before outermost invocation of the editor loop */
11627 command_loop_level
= -1;
11628 immediate_quit
= 0;
11629 quit_char
= Ctl ('g');
11630 Vunread_command_events
= Qnil
;
11631 unread_command_char
= -1;
11632 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11634 recent_keys_index
= 0;
11635 kbd_fetch_ptr
= kbd_buffer
;
11636 kbd_store_ptr
= kbd_buffer
;
11637 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11638 do_mouse_tracking
= Qnil
;
11641 interrupt_input_blocked
= 0;
11642 interrupt_input_pending
= 0;
11644 /* This means that command_loop_1 won't try to select anything the first
11646 internal_last_event_frame
= Qnil
;
11647 Vlast_event_frame
= internal_last_event_frame
;
11649 #ifdef MULTI_KBOARD
11650 current_kboard
= initial_kboard
;
11652 /* Re-initialize the keyboard again. */
11653 wipe_kboard (current_kboard
);
11654 init_kboard (current_kboard
);
11655 /* A value of nil for Vwindow_system normally means a tty, but we also use
11656 it for the initial terminal since there is no window system there. */
11657 current_kboard
->Vwindow_system
= Qnil
;
11659 if (!noninteractive
)
11661 /* Before multi-tty support, these handlers used to be installed
11662 only if the current session was a tty session. Now an Emacs
11663 session may have multiple display types, so we always handle
11664 SIGINT. There is special code in interrupt_signal to exit
11665 Emacs on SIGINT when there are no termcap frames on the
11666 controlling terminal. */
11667 signal (SIGINT
, interrupt_signal
);
11668 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11669 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11670 SIGQUIT and we can't tell which one it will give us. */
11671 signal (SIGQUIT
, interrupt_signal
);
11672 #endif /* HAVE_TERMIO */
11674 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11676 if (!noninteractive
)
11677 signal (SIGIO
, input_available_signal
);
11680 /* Use interrupt input by default, if it works and noninterrupt input
11681 has deficiencies. */
11683 #ifdef INTERRUPT_INPUT
11684 interrupt_input
= 1;
11686 interrupt_input
= 0;
11689 /* Our VMS input only works by interrupts, as of now. */
11691 interrupt_input
= 1;
11697 if (keyboard_init_hook
)
11698 (*keyboard_init_hook
) ();
11700 #ifdef POLL_FOR_INPUT
11701 poll_suppress_count
= 1;
11706 /* This type's only use is in syms_of_keyboard, to initialize the
11707 event header symbols and put properties on them. */
11708 struct event_head
{
11714 struct event_head head_table
[] = {
11715 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11716 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11717 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11718 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11719 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11720 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11721 /* `select-window' should be handled just like `switch-frame'
11722 in read_key_sequence. */
11723 {&Qselect_window
, "select-window", &Qswitch_frame
}
11727 syms_of_keyboard ()
11729 Vpre_help_message
= Qnil
;
11730 staticpro (&Vpre_help_message
);
11732 Vlispy_mouse_stem
= build_string ("mouse");
11733 staticpro (&Vlispy_mouse_stem
);
11736 QCimage
= intern (":image");
11737 staticpro (&QCimage
);
11739 staticpro (&Qhelp_echo
);
11740 Qhelp_echo
= intern ("help-echo");
11743 Qrtl
= intern (":rtl");
11745 staticpro (&item_properties
);
11746 item_properties
= Qnil
;
11748 staticpro (&tool_bar_item_properties
);
11749 tool_bar_item_properties
= Qnil
;
11750 staticpro (&tool_bar_items_vector
);
11751 tool_bar_items_vector
= Qnil
;
11753 staticpro (&real_this_command
);
11754 real_this_command
= Qnil
;
11756 Qtimer_event_handler
= intern ("timer-event-handler");
11757 staticpro (&Qtimer_event_handler
);
11759 Qdisabled_command_function
= intern ("disabled-command-function");
11760 staticpro (&Qdisabled_command_function
);
11762 Qself_insert_command
= intern ("self-insert-command");
11763 staticpro (&Qself_insert_command
);
11765 Qforward_char
= intern ("forward-char");
11766 staticpro (&Qforward_char
);
11768 Qbackward_char
= intern ("backward-char");
11769 staticpro (&Qbackward_char
);
11771 Qdisabled
= intern ("disabled");
11772 staticpro (&Qdisabled
);
11774 Qundefined
= intern ("undefined");
11775 staticpro (&Qundefined
);
11777 Qpre_command_hook
= intern ("pre-command-hook");
11778 staticpro (&Qpre_command_hook
);
11780 Qpost_command_hook
= intern ("post-command-hook");
11781 staticpro (&Qpost_command_hook
);
11783 Qdeferred_action_function
= intern ("deferred-action-function");
11784 staticpro (&Qdeferred_action_function
);
11786 Qcommand_hook_internal
= intern ("command-hook-internal");
11787 staticpro (&Qcommand_hook_internal
);
11789 Qfunction_key
= intern ("function-key");
11790 staticpro (&Qfunction_key
);
11791 Qmouse_click
= intern ("mouse-click");
11792 staticpro (&Qmouse_click
);
11793 #if defined (WINDOWSNT) || defined (MAC_OS)
11794 Qlanguage_change
= intern ("language-change");
11795 staticpro (&Qlanguage_change
);
11797 Qdrag_n_drop
= intern ("drag-n-drop");
11798 staticpro (&Qdrag_n_drop
);
11800 Qsave_session
= intern ("save-session");
11801 staticpro (&Qsave_session
);
11804 Qmac_apple_event
= intern ("mac-apple-event");
11805 staticpro (&Qmac_apple_event
);
11809 Qdbus_event
= intern ("dbus-event");
11810 staticpro (&Qdbus_event
);
11813 Qmenu_enable
= intern ("menu-enable");
11814 staticpro (&Qmenu_enable
);
11815 Qmenu_alias
= intern ("menu-alias");
11816 staticpro (&Qmenu_alias
);
11817 QCenable
= intern (":enable");
11818 staticpro (&QCenable
);
11819 QCvisible
= intern (":visible");
11820 staticpro (&QCvisible
);
11821 QChelp
= intern (":help");
11822 staticpro (&QChelp
);
11823 QCfilter
= intern (":filter");
11824 staticpro (&QCfilter
);
11825 QCbutton
= intern (":button");
11826 staticpro (&QCbutton
);
11827 QCkeys
= intern (":keys");
11828 staticpro (&QCkeys
);
11829 QCkey_sequence
= intern (":key-sequence");
11830 staticpro (&QCkey_sequence
);
11831 QCtoggle
= intern (":toggle");
11832 staticpro (&QCtoggle
);
11833 QCradio
= intern (":radio");
11834 staticpro (&QCradio
);
11836 Qmode_line
= intern ("mode-line");
11837 staticpro (&Qmode_line
);
11838 Qvertical_line
= intern ("vertical-line");
11839 staticpro (&Qvertical_line
);
11840 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11841 staticpro (&Qvertical_scroll_bar
);
11842 Qmenu_bar
= intern ("menu-bar");
11843 staticpro (&Qmenu_bar
);
11845 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11846 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11847 staticpro (&Qmouse_fixup_help_message
);
11850 Qabove_handle
= intern ("above-handle");
11851 staticpro (&Qabove_handle
);
11852 Qhandle
= intern ("handle");
11853 staticpro (&Qhandle
);
11854 Qbelow_handle
= intern ("below-handle");
11855 staticpro (&Qbelow_handle
);
11856 Qup
= intern ("up");
11858 Qdown
= intern ("down");
11859 staticpro (&Qdown
);
11860 Qtop
= intern ("top");
11862 Qbottom
= intern ("bottom");
11863 staticpro (&Qbottom
);
11864 Qend_scroll
= intern ("end-scroll");
11865 staticpro (&Qend_scroll
);
11866 Qratio
= intern ("ratio");
11867 staticpro (&Qratio
);
11869 Qevent_kind
= intern ("event-kind");
11870 staticpro (&Qevent_kind
);
11871 Qevent_symbol_elements
= intern ("event-symbol-elements");
11872 staticpro (&Qevent_symbol_elements
);
11873 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11874 staticpro (&Qevent_symbol_element_mask
);
11875 Qmodifier_cache
= intern ("modifier-cache");
11876 staticpro (&Qmodifier_cache
);
11878 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11879 staticpro (&Qrecompute_lucid_menubar
);
11880 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11881 staticpro (&Qactivate_menubar_hook
);
11883 Qpolling_period
= intern ("polling-period");
11884 staticpro (&Qpolling_period
);
11886 Qinput_method_function
= intern ("input-method-function");
11887 staticpro (&Qinput_method_function
);
11889 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11890 staticpro (&Qinput_method_exit_on_first_char
);
11891 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11892 staticpro (&Qinput_method_use_echo_area
);
11894 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11895 Fset (Qinput_method_use_echo_area
, Qnil
);
11897 last_point_position_buffer
= Qnil
;
11898 last_point_position_window
= Qnil
;
11901 struct event_head
*p
;
11903 for (p
= head_table
;
11904 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11907 *p
->var
= intern (p
->name
);
11908 staticpro (p
->var
);
11909 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11910 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11914 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11915 staticpro (&button_down_location
);
11916 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11917 staticpro (&mouse_syms
);
11918 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11919 staticpro (&wheel_syms
);
11923 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11925 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11926 for (i
= 0; i
< len
; i
++)
11927 if (modifier_names
[i
])
11928 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11929 staticpro (&modifier_symbols
);
11932 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11933 staticpro (&recent_keys
);
11935 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11936 staticpro (&this_command_keys
);
11938 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11939 staticpro (&raw_keybuf
);
11941 Qextended_command_history
= intern ("extended-command-history");
11942 Fset (Qextended_command_history
, Qnil
);
11943 staticpro (&Qextended_command_history
);
11945 accent_key_syms
= Qnil
;
11946 staticpro (&accent_key_syms
);
11948 func_key_syms
= Qnil
;
11949 staticpro (&func_key_syms
);
11951 drag_n_drop_syms
= Qnil
;
11952 staticpro (&drag_n_drop_syms
);
11954 unread_switch_frame
= Qnil
;
11955 staticpro (&unread_switch_frame
);
11957 internal_last_event_frame
= Qnil
;
11958 staticpro (&internal_last_event_frame
);
11960 read_key_sequence_cmd
= Qnil
;
11961 staticpro (&read_key_sequence_cmd
);
11963 menu_bar_one_keymap_changed_items
= Qnil
;
11964 staticpro (&menu_bar_one_keymap_changed_items
);
11966 menu_bar_items_vector
= Qnil
;
11967 staticpro (&menu_bar_items_vector
);
11969 help_form_saved_window_configs
= Qnil
;
11970 staticpro (&help_form_saved_window_configs
);
11972 defsubr (&Scurrent_idle_time
);
11973 defsubr (&Sevent_symbol_parse_modifiers
);
11974 defsubr (&Sevent_convert_list
);
11975 defsubr (&Sread_key_sequence
);
11976 defsubr (&Sread_key_sequence_vector
);
11977 defsubr (&Srecursive_edit
);
11978 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11979 defsubr (&Strack_mouse
);
11981 defsubr (&Sinput_pending_p
);
11982 defsubr (&Scommand_execute
);
11983 defsubr (&Srecent_keys
);
11984 defsubr (&Sthis_command_keys
);
11985 defsubr (&Sthis_command_keys_vector
);
11986 defsubr (&Sthis_single_command_keys
);
11987 defsubr (&Sthis_single_command_raw_keys
);
11988 defsubr (&Sreset_this_command_lengths
);
11989 defsubr (&Sclear_this_command_keys
);
11990 defsubr (&Ssuspend_emacs
);
11991 defsubr (&Sabort_recursive_edit
);
11992 defsubr (&Sexit_recursive_edit
);
11993 defsubr (&Srecursion_depth
);
11994 defsubr (&Stop_level
);
11995 defsubr (&Sdiscard_input
);
11996 defsubr (&Sopen_dribble_file
);
11997 defsubr (&Sset_input_interrupt_mode
);
11998 defsubr (&Sset_output_flow_control
);
11999 defsubr (&Sset_input_meta_mode
);
12000 defsubr (&Sset_quit_char
);
12001 defsubr (&Sset_input_mode
);
12002 defsubr (&Scurrent_input_mode
);
12003 defsubr (&Sexecute_extended_command
);
12004 defsubr (&Sposn_at_point
);
12005 defsubr (&Sposn_at_x_y
);
12007 DEFVAR_LISP ("last-command-char", &last_command_char
,
12008 doc
: /* Last input event that was part of a command. */);
12010 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
12011 doc
: /* Last input event that was part of a command. */);
12013 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
12014 doc
: /* Last input event in a command, except for mouse menu events.
12015 Mouse menus give back keys that don't look like mouse events;
12016 this variable holds the actual mouse event that led to the menu,
12017 so that you can determine whether the command was run by mouse or not. */);
12019 DEFVAR_LISP ("last-input-char", &last_input_char
,
12020 doc
: /* Last input event. */);
12022 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
12023 doc
: /* Last input event. */);
12025 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
12026 doc
: /* List of events to be read as the command input.
12027 These events are processed first, before actual keyboard input.
12028 Events read from this list are not normally added to `this-command-keys',
12029 as they will already have been added once as they were read for the first time.
12030 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12031 Vunread_command_events
= Qnil
;
12033 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12034 doc
: /* If not -1, an object to be read as next command input event. */);
12036 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12037 doc
: /* List of events to be processed as input by input methods.
12038 These events are processed before `unread-command-events'
12039 and actual keyboard input, but are not given to `input-method-function'. */);
12040 Vunread_post_input_method_events
= Qnil
;
12042 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12043 doc
: /* List of events to be processed as input by input methods.
12044 These events are processed after `unread-command-events', but
12045 before actual keyboard input.
12046 If there's an active input method, the events are given to
12047 `input-method-function'. */);
12048 Vunread_input_method_events
= Qnil
;
12050 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12051 doc
: /* Meta-prefix character code.
12052 Meta-foo as command input turns into this character followed by foo. */);
12053 XSETINT (meta_prefix_char
, 033);
12055 DEFVAR_KBOARD ("last-command", Vlast_command
,
12056 doc
: /* The last command executed.
12057 Normally a symbol with a function definition, but can be whatever was found
12058 in the keymap, or whatever the variable `this-command' was set to by that
12061 The value `mode-exit' is special; it means that the previous command
12062 read an event that told it to exit, and it did so and unread that event.
12063 In other words, the present command is the event that made the previous
12066 The value `kill-region' is special; it means that the previous command
12067 was a kill command.
12069 `last-command' has a separate binding for each terminal device.
12070 See Info node `(elisp)Multiple displays'. */);
12072 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12073 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12075 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12076 doc
: /* Last command that may be repeated.
12077 The last command executed that was not bound to an input event.
12078 This is the command `repeat' will try to repeat. */);
12080 DEFVAR_LISP ("this-command", &Vthis_command
,
12081 doc
: /* The command now being executed.
12082 The command can set this variable; whatever is put here
12083 will be in `last-command' during the following command. */);
12084 Vthis_command
= Qnil
;
12086 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12087 doc
: /* The command bound to the current key sequence before remapping.
12088 It equals `this-command' if the original command was not remapped through
12089 any of the active keymaps. Otherwise, the value of `this-command' is the
12090 result of looking up the original command in the active keymaps. */);
12091 Vthis_original_command
= Qnil
;
12093 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12094 doc
: /* *Number of input events between auto-saves.
12095 Zero means disable autosaving due to number of characters typed. */);
12096 auto_save_interval
= 300;
12098 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12099 doc
: /* *Number of seconds idle time before auto-save.
12100 Zero or nil means disable auto-saving due to idleness.
12101 After auto-saving due to this many seconds of idle time,
12102 Emacs also does a garbage collection if that seems to be warranted. */);
12103 XSETFASTINT (Vauto_save_timeout
, 30);
12105 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12106 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12107 The value may be integer or floating point. */);
12108 Vecho_keystrokes
= make_number (1);
12110 DEFVAR_INT ("polling-period", &polling_period
,
12111 doc
: /* *Interval between polling for input during Lisp execution.
12112 The reason for polling is to make C-g work to stop a running program.
12113 Polling is needed only when using X windows and SIGIO does not work.
12114 Polling is automatically disabled in all other cases. */);
12115 polling_period
= 2;
12117 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12118 doc
: /* *Maximum time between mouse clicks to make a double-click.
12119 Measured in milliseconds. The value nil means disable double-click
12120 recognition; t means double-clicks have no time limit and are detected
12121 by position only. */);
12122 Vdouble_click_time
= make_number (500);
12124 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12125 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12126 On window-system frames, value is the number of pixels the mouse may have
12127 moved horizontally or vertically between two clicks to make a double-click.
12128 On non window-system frames, value is interpreted in units of 1/8 characters
12131 This variable is also the threshold for motion of the mouse
12132 to count as a drag. */);
12133 double_click_fuzz
= 3;
12135 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12136 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12137 inhibit_local_menu_bar_menus
= 0;
12139 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12140 doc
: /* Number of complete key sequences read as input so far.
12141 This includes key sequences read from keyboard macros.
12142 The number is effectively the number of interactive command invocations. */);
12143 num_input_keys
= 0;
12145 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12146 doc
: /* Number of input events read from the keyboard so far.
12147 This does not include events generated by keyboard macros. */);
12148 num_nonmacro_input_events
= 0;
12150 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12151 doc
: /* The frame in which the most recently read event occurred.
12152 If the last event came from a keyboard macro, this is set to `macro'. */);
12153 Vlast_event_frame
= Qnil
;
12155 /* This variable is set up in sysdep.c. */
12156 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12157 doc
: /* The ERASE character as set by the user with stty. */);
12159 DEFVAR_LISP ("help-char", &Vhelp_char
,
12160 doc
: /* Character to recognize as meaning Help.
12161 When it is read, do `(eval help-form)', and display result if it's a string.
12162 If the value of `help-form' is nil, this char can be read normally. */);
12163 XSETINT (Vhelp_char
, Ctl ('H'));
12165 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12166 doc
: /* List of input events to recognize as meaning Help.
12167 These work just like the value of `help-char' (see that). */);
12168 Vhelp_event_list
= Qnil
;
12170 DEFVAR_LISP ("help-form", &Vhelp_form
,
12171 doc
: /* Form to execute when character `help-char' is read.
12172 If the form returns a string, that string is displayed.
12173 If `help-form' is nil, the help char is not recognized. */);
12176 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12177 doc
: /* Command to run when `help-char' character follows a prefix key.
12178 This command is used only when there is no actual binding
12179 for that character after that prefix key. */);
12180 Vprefix_help_command
= Qnil
;
12182 DEFVAR_LISP ("top-level", &Vtop_level
,
12183 doc
: /* Form to evaluate when Emacs starts up.
12184 Useful to set before you dump a modified Emacs. */);
12187 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12188 doc
: /* Translate table for local keyboard input, or nil.
12189 If non-nil, the value should be a char-table. Each character read
12190 from the keyboard is looked up in this char-table. If the value found
12191 there is non-nil, then it is used instead of the actual input character.
12193 The value can also be a string or vector, but this is considered obsolete.
12194 If it is a string or vector of length N, character codes N and up are left
12195 untranslated. In a vector, an element which is nil means "no translation".
12197 This is applied to the characters supplied to input methods, not their
12198 output. See also `translation-table-for-input'.
12200 This variable has a separate binding for each terminal. See Info node
12201 `(elisp)Multiple displays'. */);
12203 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12204 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12205 \(Even if the operating system has support for stopping a process.\) */);
12206 cannot_suspend
= 0;
12208 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12209 doc
: /* Non-nil means prompt with menus when appropriate.
12210 This is done when reading from a keymap that has a prompt string,
12211 for elements that have prompt strings.
12212 The menu is displayed on the screen
12213 if X menus were enabled at configuration
12214 time and the previous event was a mouse click prefix key.
12215 Otherwise, menu prompting uses the echo area. */);
12216 menu_prompting
= 1;
12218 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12219 doc
: /* Character to see next line of menu prompt.
12220 Type this character while in a menu prompt to rotate around the lines of it. */);
12221 XSETINT (menu_prompt_more_char
, ' ');
12223 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12224 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12225 Emacs applies the modifiers of the character stored here to each keyboard
12226 character it reads. For example, after evaluating the expression
12227 (setq extra-keyboard-modifiers ?\\C-x)
12228 all input characters will have the control modifier applied to them.
12230 Note that the character ?\\C-@, equivalent to the integer zero, does
12231 not count as a control character; rather, it counts as a character
12232 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12233 cancels any modification. */);
12234 extra_keyboard_modifiers
= 0;
12236 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12237 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12238 The command loop sets this to nil before each command,
12239 and tests the value when the command returns.
12240 Buffer modification stores t in this variable. */);
12241 Vdeactivate_mark
= Qnil
;
12243 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12244 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
12245 Vcommand_hook_internal
= Qnil
;
12247 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12248 doc
: /* Normal hook run before each command is executed.
12249 If an unhandled error happens in running this hook,
12250 the hook value is set to nil, since otherwise the error
12251 might happen repeatedly and make Emacs nonfunctional. */);
12252 Vpre_command_hook
= Qnil
;
12254 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12255 doc
: /* Normal hook run after each command is executed.
12256 If an unhandled error happens in running this hook,
12257 the hook value is set to nil, since otherwise the error
12258 might happen repeatedly and make Emacs nonfunctional. */);
12259 Vpost_command_hook
= Qnil
;
12262 DEFVAR_LISP ("echo-area-clear-hook", ...,
12263 doc
: /* Normal hook run when clearing the echo area. */);
12265 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12266 staticpro (&Qecho_area_clear_hook
);
12267 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12269 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12270 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12271 Vlucid_menu_bar_dirty_flag
= Qnil
;
12273 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12274 doc
: /* List of menu bar items to move to the end of the menu bar.
12275 The elements of the list are event types that may have menu bar bindings. */);
12276 Vmenu_bar_final_items
= Qnil
;
12278 DEFVAR_KBOARD ("overriding-terminal-local-map",
12279 Voverriding_terminal_local_map
,
12280 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12281 If this variable is non-nil, it is used as a keymap instead of the
12282 buffer's local map, and the minor mode keymaps and text property keymaps.
12283 It also replaces `overriding-local-map'.
12285 This variable is intended to let commands such as `universal-argument'
12286 set up a different keymap for reading the next command.
12288 `overriding-terminal-local-map' has a separate binding for each
12290 See Info node `(elisp)Multiple displays'. */);
12292 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12293 doc
: /* Keymap that overrides all other local keymaps.
12294 If this variable is non-nil, it is used as a keymap--replacing the
12295 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12296 Voverriding_local_map
= Qnil
;
12298 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12299 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12300 Otherwise, the menu bar continues to reflect the buffer's local map
12301 and the minor mode maps regardless of `overriding-local-map'. */);
12302 Voverriding_local_map_menu_flag
= Qnil
;
12304 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12305 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12306 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12308 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12309 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12311 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12312 doc
: /* Alist of system-specific X windows key symbols.
12313 Each element should have the form (N . SYMBOL) where N is the
12314 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12315 and SYMBOL is its name.
12317 `system-key-alist' has a separate binding for each terminal device.
12318 See Info node `(elisp)Multiple displays'. */);
12320 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12321 doc
: /* Keymap that translates key sequences to key sequences during input.
12322 This is used mainly for mapping key sequences into some preferred
12323 key events (symbols).
12325 The `read-key-sequence' function replaces any subsequence bound by
12326 `local-function-key-map' with its binding. More precisely, when the
12327 active keymaps have no binding for the current key sequence but
12328 `local-function-key-map' binds a suffix of the sequence to a vector or
12329 string, `read-key-sequence' replaces the matching suffix with its
12330 binding, and continues with the new sequence.
12332 If the binding is a function, it is called with one argument (the prompt)
12333 and its return value (a key sequence) is used.
12335 The events that come from bindings in `local-function-key-map' are not
12336 themselves looked up in `local-function-key-map'.
12338 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12339 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12340 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12341 typing `ESC O P x' would return [f1 x].
12343 `local-function-key-map' has a separate binding for each terminal
12344 device. See Info node `(elisp)Multiple displays'. If you need to
12345 define a binding on all terminals, change `function-key-map'
12346 instead. Initially, `local-function-key-map' is an empty keymap that
12347 has `function-key-map' as its parent on all terminal devices. */);
12349 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12350 doc
: /* Keymap that decodes input escape sequences.
12351 This is used mainly for mapping ASCII function key sequences into
12352 real Emacs function key events (symbols).
12354 The `read-key-sequence' function replaces any subsequence bound by
12355 `local-function-key-map' with its binding. Contrary to `function-key-map',
12356 this map applies its rebinding regardless of the presence of an ordinary
12357 binding. So it is more like `key-translation-map' except that it applies
12358 before `function-key-map' rather than after.
12360 If the binding is a function, it is called with one argument (the prompt)
12361 and its return value (a key sequence) is used.
12363 The events that come from bindings in `input-decode-map' are not
12364 themselves looked up in `input-decode-map'.
12366 This variable is keyboard-local. */);
12368 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12369 doc
: /* The parent keymap of all `local-function-key-map' instances.
12370 Function key definitions that apply to all terminal devices should go
12371 here. If a mapping is defined in both the current
12372 `local-function-key-map' binding and this variable, then the local
12373 definition will take precendence. */);
12374 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12376 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12377 doc
: /* Keymap of key translations that can override keymaps.
12378 This keymap works like `function-key-map', but comes after that,
12379 and its non-prefix bindings override ordinary bindings.
12380 Another difference is that it is global rather than keyboard-local. */);
12381 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12383 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12384 doc
: /* List of deferred actions to be performed at a later time.
12385 The precise format isn't relevant here; we just check whether it is nil. */);
12386 Vdeferred_action_list
= Qnil
;
12388 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12389 doc
: /* Function to call to handle deferred actions, after each command.
12390 This function is called with no arguments after each command
12391 whenever `deferred-action-list' is non-nil. */);
12392 Vdeferred_action_function
= Qnil
;
12394 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12395 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12396 The value can be a length of time to show the message for.
12397 If the value is non-nil and not a number, we wait 2 seconds. */);
12398 Vsuggest_key_bindings
= Qt
;
12400 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12401 doc
: /* List of active absolute time timers in order of increasing time. */);
12402 Vtimer_list
= Qnil
;
12404 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12405 doc
: /* List of active idle-time timers in order of increasing time. */);
12406 Vtimer_idle_list
= Qnil
;
12408 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12409 doc
: /* If non-nil, the function that implements the current input method.
12410 It's called with one argument, a printing character that was just read.
12411 \(That means a character with code 040...0176.)
12412 Typically this function uses `read-event' to read additional events.
12413 When it does so, it should first bind `input-method-function' to nil
12414 so it will not be called recursively.
12416 The function should return a list of zero or more events
12417 to be used as input. If it wants to put back some events
12418 to be reconsidered, separately, by the input method,
12419 it can add them to the beginning of `unread-command-events'.
12421 The input method function can find in `input-method-previous-method'
12422 the previous echo area message.
12424 The input method function should refer to the variables
12425 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12426 for guidance on what to do. */);
12427 Vinput_method_function
= Qnil
;
12429 DEFVAR_LISP ("input-method-previous-message",
12430 &Vinput_method_previous_message
,
12431 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12432 This variable exists because `read-event' clears the echo area
12433 before running the input method. It is nil if there was no message. */);
12434 Vinput_method_previous_message
= Qnil
;
12436 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12437 doc
: /* If non-nil, the function that implements the display of help.
12438 It's called with one argument, the help string to display. */);
12439 Vshow_help_function
= Qnil
;
12441 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12442 doc
: /* If non-nil, suppress point adjustment after executing a command.
12444 After a command is executed, if point is moved into a region that has
12445 special properties (e.g. composition, display), we adjust point to
12446 the boundary of the region. But, when a command sets this variable to
12447 non-nil, we suppress the point adjustment.
12449 This variable is set to nil before reading a command, and is checked
12450 just after executing the command. */);
12451 Vdisable_point_adjustment
= Qnil
;
12453 DEFVAR_LISP ("global-disable-point-adjustment",
12454 &Vglobal_disable_point_adjustment
,
12455 doc
: /* *If non-nil, always suppress point adjustment.
12457 The default value is nil, in which case, point adjustment are
12458 suppressed only after special commands that set
12459 `disable-point-adjustment' (which see) to non-nil. */);
12460 Vglobal_disable_point_adjustment
= Qnil
;
12462 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12463 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12464 If the value is not a number, such messages don't time out. */);
12465 Vminibuffer_message_timeout
= make_number (2);
12467 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12468 doc
: /* If non-nil, any keyboard input throws to this symbol.
12469 The value of that variable is passed to `quit-flag' and later causes a
12470 peculiar kind of quitting. */);
12471 Vthrow_on_input
= Qnil
;
12473 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12474 doc
: /* If non-nil, function to output error messages.
12475 The arguments are the error data, a list of the form
12476 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12477 such as just as `condition-case' would bind its variable to,
12478 the context (a string which normally goes at the start of the message),
12479 and the Lisp function within which the error was signaled. */);
12480 Vcommand_error_function
= Qnil
;
12482 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12483 &Venable_disabled_menus_and_buttons
,
12484 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12486 Help functions bind this to allow help on disabled menu items
12487 and tool-bar buttons. */);
12488 Venable_disabled_menus_and_buttons
= Qnil
;
12490 #ifdef MULTI_KBOARD
12491 /* Create the initial keyboard. */
12492 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12493 init_kboard (initial_kboard
);
12494 /* Vwindow_system is left at t for now. */
12495 initial_kboard
->next_kboard
= all_kboards
;
12496 all_kboards
= initial_kboard
;
12501 keys_of_keyboard ()
12503 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12504 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12505 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12506 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12507 initial_define_key (meta_map
, 'x', "execute-extended-command");
12509 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12510 "handle-delete-frame");
12511 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12512 current-prefix-arg, as is done in `handle-switch-frame'.
12513 But `handle-switch-frame is not run from the special-map.
12514 Commands from that map are run in a special way that automatically
12515 preserves the prefix-arg. Restoring the prefix arg here is not just
12516 redundant but harmful:
12518 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12519 - after the first prompt, the exit-minibuffer-hook is run which may
12520 iconify a frame and thus push a `iconify-frame' event.
12521 - after running exit-minibuffer-hook, current-prefix-arg is
12522 restored to the non-nil value it had before the prompt.
12523 - we enter the second prompt.
12524 current-prefix-arg is non-nil, prefix-arg is nil.
12525 - before running the first real event, we run the special iconify-frame
12526 event, but we pass the `special' arg to execute-command so
12527 current-prefix-arg and prefix-arg are left untouched.
12528 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12529 - the next key event will have a spuriously non-nil current-prefix-arg. */
12530 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12532 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12534 /* Handling it at such a low-level causes read_key_sequence to get
12535 * confused because it doesn't realize that the current_buffer was
12536 * changed by read_char.
12538 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12539 * "handle-select-window"); */
12540 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12541 "handle-save-session");
12544 /* Define a special event which is raised for dbus callback
12546 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12547 "dbus-handle-event");
12551 /* Mark the pointers in the kboard objects.
12552 Called by the Fgarbage_collector. */
12558 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12560 if (kb
->kbd_macro_buffer
)
12561 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12563 mark_object (kb
->Voverriding_terminal_local_map
);
12564 mark_object (kb
->Vlast_command
);
12565 mark_object (kb
->Vreal_last_command
);
12566 mark_object (kb
->Vkeyboard_translate_table
);
12567 mark_object (kb
->Vlast_repeatable_command
);
12568 mark_object (kb
->Vprefix_arg
);
12569 mark_object (kb
->Vlast_prefix_arg
);
12570 mark_object (kb
->kbd_queue
);
12571 mark_object (kb
->defining_kbd_macro
);
12572 mark_object (kb
->Vlast_kbd_macro
);
12573 mark_object (kb
->Vsystem_key_alist
);
12574 mark_object (kb
->system_key_syms
);
12575 mark_object (kb
->Vwindow_system
);
12576 mark_object (kb
->Vinput_decode_map
);
12577 mark_object (kb
->Vlocal_function_key_map
);
12578 mark_object (kb
->Vdefault_minibuffer_frame
);
12579 mark_object (kb
->echo_string
);
12582 struct input_event
*event
;
12583 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12585 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12586 event
= kbd_buffer
;
12587 if (event
->kind
!= SELECTION_REQUEST_EVENT
12588 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12590 mark_object (event
->x
);
12591 mark_object (event
->y
);
12593 mark_object (event
->frame_or_window
);
12594 mark_object (event
->arg
);
12599 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12600 (do not change this comment) */