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 /* Non-nil if the present key sequence was obtained by shift translation. */
136 Lisp_Object Vthis_command_keys_shift_translated
;
138 #define GROW_RAW_KEYBUF \
139 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
140 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
142 /* Number of elements of this_command_keys
143 that precede this key sequence. */
144 int this_single_command_key_start
;
146 /* Record values of this_command_key_count and echo_length ()
147 before this command was read. */
148 static int before_command_key_count
;
149 static int before_command_echo_length
;
151 extern int minbuf_level
;
153 extern int message_enable_multibyte
;
155 /* If non-nil, the function that implements the display of help.
156 It's called with one argument, the help string to display. */
158 Lisp_Object Vshow_help_function
;
160 /* If a string, the message displayed before displaying a help-echo
163 Lisp_Object Vpre_help_message
;
165 /* Nonzero means do menu prompting. */
167 static int menu_prompting
;
169 /* Character to see next line of menu prompt. */
171 static Lisp_Object menu_prompt_more_char
;
173 /* For longjmp to where kbd input is being done. */
175 static jmp_buf getcjmp
;
177 /* True while doing kbd input. */
178 int waiting_for_input
;
180 /* True while displaying for echoing. Delays C-g throwing. */
184 /* Non-null means we can start echoing at the next input pause even
185 though there is something in the echo area. */
187 static struct kboard
*ok_to_echo_at_next_pause
;
189 /* The kboard last echoing, or null for none. Reset to 0 in
190 cancel_echoing. If non-null, and a current echo area message
191 exists, and echo_message_buffer is eq to the current message
192 buffer, we know that the message comes from echo_kboard. */
194 struct kboard
*echo_kboard
;
196 /* The buffer used for echoing. Set in echo_now, reset in
199 Lisp_Object echo_message_buffer
;
201 /* Nonzero means disregard local maps for the menu bar. */
202 static int inhibit_local_menu_bar_menus
;
204 /* Nonzero means C-g should cause immediate error-signal. */
207 /* The user's hook function for outputting an error message. */
208 Lisp_Object Vcommand_error_function
;
210 /* The user's ERASE setting. */
211 Lisp_Object Vtty_erase_char
;
213 /* Character to recognize as the help char. */
214 Lisp_Object Vhelp_char
;
216 /* List of other event types to recognize as meaning "help". */
217 Lisp_Object Vhelp_event_list
;
219 /* Form to execute when help char is typed. */
220 Lisp_Object Vhelp_form
;
222 /* Command to run when the help character follows a prefix key. */
223 Lisp_Object Vprefix_help_command
;
225 /* List of items that should move to the end of the menu bar. */
226 Lisp_Object Vmenu_bar_final_items
;
228 /* Non-nil means show the equivalent key-binding for
229 any M-x command that has one.
230 The value can be a length of time to show the message for.
231 If the value is non-nil and not a number, we wait 2 seconds. */
232 Lisp_Object Vsuggest_key_bindings
;
234 /* How long to display an echo-area message when the minibuffer is active.
235 If the value is not a number, such messages don't time out. */
236 Lisp_Object Vminibuffer_message_timeout
;
238 /* Character that causes a quit. Normally C-g.
240 If we are running on an ordinary terminal, this must be an ordinary
241 ASCII char, since we want to make it our interrupt character.
243 If we are not running on an ordinary terminal, it still needs to be
244 an ordinary ASCII char. This character needs to be recognized in
245 the input interrupt handler. At this point, the keystroke is
246 represented as a struct input_event, while the desired quit
247 character is specified as a lispy event. The mapping from struct
248 input_events to lispy events cannot run in an interrupt handler,
249 and the reverse mapping is difficult for anything but ASCII
252 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
256 extern Lisp_Object current_global_map
;
257 extern int minibuf_level
;
259 /* If non-nil, this is a map that overrides all other local maps. */
260 Lisp_Object Voverriding_local_map
;
262 /* If non-nil, Voverriding_local_map applies to the menu bar. */
263 Lisp_Object Voverriding_local_map_menu_flag
;
265 /* Keymap that defines special misc events that should
266 be processed immediately at a low level. */
267 Lisp_Object Vspecial_event_map
;
269 /* Current depth in recursive edits. */
270 int command_loop_level
;
272 /* Total number of times command_loop has read a key sequence. */
273 EMACS_INT num_input_keys
;
275 /* Last input character read as a command. */
276 Lisp_Object last_command_char
;
278 /* Last input character read as a command, not counting menus
279 reached by the mouse. */
280 Lisp_Object last_nonmenu_event
;
282 /* Last input character read for any purpose. */
283 Lisp_Object last_input_char
;
285 /* If not Qnil, a list of objects to be read as subsequent command input. */
286 Lisp_Object Vunread_command_events
;
288 /* If not Qnil, a list of objects to be read as subsequent command input
289 including input method processing. */
290 Lisp_Object Vunread_input_method_events
;
292 /* If not Qnil, a list of objects to be read as subsequent command input
293 but NOT including input method processing. */
294 Lisp_Object Vunread_post_input_method_events
;
296 /* If not -1, an event to be read as subsequent command input. */
297 EMACS_INT unread_command_char
;
299 /* If not Qnil, this is a switch-frame event which we decided to put
300 off until the end of a key sequence. This should be read as the
301 next command input, after any unread_command_events.
303 read_key_sequence uses this to delay switch-frame events until the
304 end of the key sequence; Fread_char uses it to put off switch-frame
305 events until a non-ASCII event is acceptable as input. */
306 Lisp_Object unread_switch_frame
;
308 /* A mask of extra modifier bits to put into every keyboard char. */
309 EMACS_INT extra_keyboard_modifiers
;
311 /* Char to use as prefix when a meta character is typed in.
312 This is bound on entry to minibuffer in case ESC is changed there. */
314 Lisp_Object meta_prefix_char
;
316 /* Last size recorded for a current buffer which is not a minibuffer. */
317 static int last_non_minibuf_size
;
319 /* Number of idle seconds before an auto-save and garbage collection. */
320 static Lisp_Object Vauto_save_timeout
;
322 /* Total number of times read_char has returned. */
323 int num_input_events
;
325 /* Total number of times read_char has returned, outside of macros. */
326 EMACS_INT num_nonmacro_input_events
;
328 /* Auto-save automatically when this many characters have been typed
329 since the last time. */
331 static EMACS_INT auto_save_interval
;
333 /* Value of num_nonmacro_input_events as of last auto save. */
337 /* The command being executed by the command loop.
338 Commands may set this, and the value set will be copied into
339 current_kboard->Vlast_command instead of the actual command. */
340 Lisp_Object Vthis_command
;
342 /* This is like Vthis_command, except that commands never set it. */
343 Lisp_Object real_this_command
;
345 /* If the lookup of the command returns a binding, the original
346 command is stored in this-original-command. It is nil otherwise. */
347 Lisp_Object Vthis_original_command
;
349 /* The value of point when the last command was started. */
350 int last_point_position
;
352 /* The buffer that was current when the last command was started. */
353 Lisp_Object last_point_position_buffer
;
355 /* The window that was selected when the last command was started. */
356 Lisp_Object last_point_position_window
;
358 /* The frame in which the last input event occurred, or Qmacro if the
359 last event came from a macro. We use this to determine when to
360 generate switch-frame events. This may be cleared by functions
361 like Fselect_frame, to make sure that a switch-frame event is
362 generated by the next character. */
363 Lisp_Object internal_last_event_frame
;
365 /* A user-visible version of the above, intended to allow users to
366 figure out where the last event came from, if the event doesn't
367 carry that information itself (i.e. if it was a character). */
368 Lisp_Object Vlast_event_frame
;
370 /* The timestamp of the last input event we received from the X server.
371 X Windows wants this for selection ownership. */
372 unsigned long last_event_timestamp
;
374 Lisp_Object Qself_insert_command
;
375 Lisp_Object Qforward_char
;
376 Lisp_Object Qbackward_char
;
377 Lisp_Object Qundefined
;
378 Lisp_Object Qtimer_event_handler
;
380 /* read_key_sequence stores here the command definition of the
381 key sequence that it reads. */
382 Lisp_Object read_key_sequence_cmd
;
384 /* Echo unfinished commands after this many seconds of pause. */
385 Lisp_Object Vecho_keystrokes
;
387 /* Form to evaluate (if non-nil) when Emacs is started. */
388 Lisp_Object Vtop_level
;
390 /* If non-nil, this implements the current input method. */
391 Lisp_Object Vinput_method_function
;
392 Lisp_Object Qinput_method_function
;
394 /* When we call Vinput_method_function,
395 this holds the echo area message that was just erased. */
396 Lisp_Object Vinput_method_previous_message
;
398 /* Non-nil means deactivate the mark at end of this command. */
399 Lisp_Object Vdeactivate_mark
;
401 /* Menu bar specified in Lucid Emacs fashion. */
403 Lisp_Object Vlucid_menu_bar_dirty_flag
;
404 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
406 Lisp_Object Qecho_area_clear_hook
;
408 /* Hooks to run before and after each command. */
409 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
410 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
411 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
413 /* Parent keymap of terminal-local function-key-map instances. */
414 Lisp_Object Vfunction_key_map
;
416 /* Keymap of key translations that can override keymaps. */
417 Lisp_Object Vkey_translation_map
;
419 /* List of deferred actions to be performed at a later time.
420 The precise format isn't relevant here; we just check whether it is nil. */
421 Lisp_Object Vdeferred_action_list
;
423 /* Function to call to handle deferred actions, when there are any. */
424 Lisp_Object Vdeferred_action_function
;
425 Lisp_Object Qdeferred_action_function
;
427 Lisp_Object Qinput_method_exit_on_first_char
;
428 Lisp_Object Qinput_method_use_echo_area
;
430 /* File in which we write all commands we read. */
433 /* Nonzero if input is available. */
436 extern char *pending_malloc_warning
;
438 /* Circular buffer for pre-read keyboard input. */
440 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
442 /* Pointer to next available character in kbd_buffer.
443 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
444 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
445 next available char is in kbd_buffer[0]. */
446 static struct input_event
*kbd_fetch_ptr
;
448 /* Pointer to next place to store character in kbd_buffer. This
449 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
450 character should go in kbd_buffer[0]. */
451 static struct input_event
* volatile kbd_store_ptr
;
453 /* The above pair of variables forms a "queue empty" flag. When we
454 enqueue a non-hook event, we increment kbd_store_ptr. When we
455 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
456 there is input available if the two pointers are not equal.
458 Why not just have a flag set and cleared by the enqueuing and
459 dequeuing functions? Such a flag could be screwed up by interrupts
460 at inopportune times. */
462 /* If this flag is non-nil, we check mouse_moved to see when the
463 mouse moves, and motion events will appear in the input stream.
464 Otherwise, mouse motion is ignored. */
465 Lisp_Object do_mouse_tracking
;
467 /* Symbols to head events. */
468 Lisp_Object Qmouse_movement
;
469 Lisp_Object Qscroll_bar_movement
;
470 Lisp_Object Qswitch_frame
;
471 Lisp_Object Qdelete_frame
;
472 Lisp_Object Qiconify_frame
;
473 Lisp_Object Qmake_frame_visible
;
474 Lisp_Object Qselect_window
;
475 Lisp_Object Qhelp_echo
;
477 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
478 Lisp_Object Qmouse_fixup_help_message
;
481 /* Symbols to denote kinds of events. */
482 Lisp_Object Qfunction_key
;
483 Lisp_Object Qmouse_click
;
484 #if defined (WINDOWSNT) || defined (MAC_OS)
485 Lisp_Object Qlanguage_change
;
487 Lisp_Object Qdrag_n_drop
;
488 Lisp_Object Qsave_session
;
490 Lisp_Object Qmac_apple_event
;
493 Lisp_Object Qdbus_event
;
495 /* Lisp_Object Qmouse_movement; - also an event header */
497 /* Properties of event headers. */
498 Lisp_Object Qevent_kind
;
499 Lisp_Object Qevent_symbol_elements
;
501 /* menu item parts */
502 Lisp_Object Qmenu_alias
;
503 Lisp_Object Qmenu_enable
;
504 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
505 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
506 extern Lisp_Object Vdefine_key_rebound_commands
;
507 extern Lisp_Object Qmenu_item
;
509 /* An event header symbol HEAD may have a property named
510 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
511 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
512 mask of modifiers applied to it. If present, this is used to help
513 speed up parse_modifiers. */
514 Lisp_Object Qevent_symbol_element_mask
;
516 /* An unmodified event header BASE may have a property named
517 Qmodifier_cache, which is an alist mapping modifier masks onto
518 modified versions of BASE. If present, this helps speed up
520 Lisp_Object Qmodifier_cache
;
522 /* Symbols to use for parts of windows. */
523 Lisp_Object Qmode_line
;
524 Lisp_Object Qvertical_line
;
525 Lisp_Object Qvertical_scroll_bar
;
526 Lisp_Object Qmenu_bar
;
527 extern Lisp_Object Qleft_margin
, Qright_margin
;
528 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
529 extern Lisp_Object QCmap
;
531 Lisp_Object
recursive_edit_unwind (), command_loop ();
532 Lisp_Object
Fthis_command_keys ();
533 Lisp_Object Qextended_command_history
;
534 EMACS_TIME
timer_check ();
536 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
538 extern char *x_get_keysym_name ();
540 static void record_menu_key ();
541 static int echo_length ();
543 Lisp_Object Qpolling_period
;
545 /* List of absolute timers. Appears in order of next scheduled event. */
546 Lisp_Object Vtimer_list
;
548 /* List of idle time timers. Appears in order of next scheduled event. */
549 Lisp_Object Vtimer_idle_list
;
551 /* Incremented whenever a timer is run. */
554 extern Lisp_Object Vprint_level
, Vprint_length
;
556 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
558 EMACS_TIME
*input_available_clear_time
;
560 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
561 Default is 1 if INTERRUPT_INPUT is defined. */
564 /* Nonzero while interrupts are temporarily deferred during redisplay. */
565 int interrupts_deferred
;
567 /* Allow m- file to inhibit use of FIONREAD. */
568 #ifdef BROKEN_FIONREAD
572 /* We are unable to use interrupts if FIONREAD is not available,
573 so flush SIGIO so we won't try. */
574 #if !defined (FIONREAD)
580 /* If we support a window system, turn on the code to poll periodically
581 to detect C-g. It isn't actually used when doing interrupt input. */
582 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
583 #define POLL_FOR_INPUT
586 /* After a command is executed, if point is moved into a region that
587 has specific properties (e.g. composition, display), we adjust
588 point to the boundary of the region. But, if a command sets this
589 variable to non-nil, we suppress this point adjustment. This
590 variable is set to nil before reading a command. */
592 Lisp_Object Vdisable_point_adjustment
;
594 /* If non-nil, always disable point adjustment. */
596 Lisp_Object Vglobal_disable_point_adjustment
;
598 /* The time when Emacs started being idle. */
600 static EMACS_TIME timer_idleness_start_time
;
602 /* After Emacs stops being idle, this saves the last value
603 of timer_idleness_start_time from when it was idle. */
605 static EMACS_TIME timer_last_idleness_start_time
;
607 /* If non-nil, events produced by disabled menu items and tool-bar
608 buttons are not ignored. Help functions bind this to allow help on
609 those items and buttons. */
610 Lisp_Object Venable_disabled_menus_and_buttons
;
613 /* Global variable declarations. */
615 /* Flags for readable_events. */
616 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
617 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
618 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
620 /* Function for init_keyboard to call with no args (if nonzero). */
621 void (*keyboard_init_hook
) ();
623 static int read_avail_input
P_ ((int));
624 static void get_input_pending
P_ ((int *, int));
625 static int readable_events
P_ ((int));
626 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
627 Lisp_Object
, int *));
628 static Lisp_Object
read_char_x_menu_prompt ();
629 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
631 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
632 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
633 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
634 enum scroll_bar_part
,
635 Lisp_Object
, Lisp_Object
,
638 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
639 Lisp_Object
, char **,
640 Lisp_Object
*, unsigned));
641 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
642 static int parse_solitary_modifier
P_ ((Lisp_Object
));
643 static int parse_solitary_modifier ();
644 static void save_getcjmp
P_ ((jmp_buf));
645 static void save_getcjmp ();
646 static void restore_getcjmp
P_ ((jmp_buf));
647 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
648 static void clear_event
P_ ((struct input_event
*));
650 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
652 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
653 static void handle_interrupt
P_ ((void));
654 static void timer_start_idle
P_ ((void));
655 static void timer_stop_idle
P_ ((void));
656 static void timer_resume_idle
P_ ((void));
657 static SIGTYPE handle_user_signal
P_ ((int));
658 static char *find_user_signal_name
P_ ((int));
659 static int store_user_signal_events
P_ ((void));
661 /* Nonzero means don't try to suspend even if the operating system seems
663 static int cannot_suspend
;
665 /* Install the string STR as the beginning of the string of echoing,
666 so that it serves as a prompt for the next character.
667 Also start echoing. */
673 current_kboard
->echo_string
= str
;
674 current_kboard
->echo_after_prompt
= SCHARS (str
);
678 /* Add C to the echo string, if echoing is going on.
679 C can be a character, which is printed prettily ("M-C-x" and all that
680 jazz), or a symbol, whose name is printed. */
686 if (current_kboard
->immediate_echo
)
688 int size
= KEY_DESCRIPTION_SIZE
+ 100;
689 char *buffer
= (char *) alloca (size
);
691 Lisp_Object echo_string
;
693 echo_string
= current_kboard
->echo_string
;
695 /* If someone has passed us a composite event, use its head symbol. */
700 ptr
= push_key_description (XINT (c
), ptr
, 1);
702 else if (SYMBOLP (c
))
704 Lisp_Object name
= SYMBOL_NAME (c
);
705 int nbytes
= SBYTES (name
);
707 if (size
- (ptr
- buffer
) < nbytes
)
709 int offset
= ptr
- buffer
;
710 size
= max (2 * size
, size
+ nbytes
);
711 buffer
= (char *) alloca (size
);
712 ptr
= buffer
+ offset
;
715 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
716 STRING_MULTIBYTE (name
), 1);
719 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
722 const char *text
= " (Type ? for further options)";
723 int len
= strlen (text
);
725 if (size
- (ptr
- buffer
) < len
)
727 int offset
= ptr
- buffer
;
729 buffer
= (char *) alloca (size
);
730 ptr
= buffer
+ offset
;
733 bcopy (text
, ptr
, len
);
737 /* Replace a dash from echo_dash with a space, otherwise
738 add a space at the end as a separator between keys. */
739 if (STRINGP (echo_string
)
740 && SCHARS (echo_string
) > 1)
742 Lisp_Object last_char
, prev_char
, idx
;
744 idx
= make_number (SCHARS (echo_string
) - 2);
745 prev_char
= Faref (echo_string
, idx
);
747 idx
= make_number (SCHARS (echo_string
) - 1);
748 last_char
= Faref (echo_string
, idx
);
750 /* We test PREV_CHAR to make sure this isn't the echoing
752 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
753 Faset (echo_string
, idx
, make_number (' '));
755 echo_string
= concat2 (echo_string
, build_string (" "));
757 else if (STRINGP (echo_string
))
758 echo_string
= concat2 (echo_string
, build_string (" "));
760 current_kboard
->echo_string
761 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
767 /* Temporarily add a dash to the end of the echo string if it's not
768 empty, so that it serves as a mini-prompt for the very next character. */
773 /* Do nothing if not echoing at all. */
774 if (NILP (current_kboard
->echo_string
))
777 if (!current_kboard
->immediate_echo
778 && SCHARS (current_kboard
->echo_string
) == 0)
781 /* Do nothing if we just printed a prompt. */
782 if (current_kboard
->echo_after_prompt
783 == SCHARS (current_kboard
->echo_string
))
786 /* Do nothing if we have already put a dash at the end. */
787 if (SCHARS (current_kboard
->echo_string
) > 1)
789 Lisp_Object last_char
, prev_char
, idx
;
791 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
792 prev_char
= Faref (current_kboard
->echo_string
, idx
);
794 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
795 last_char
= Faref (current_kboard
->echo_string
, idx
);
797 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
801 /* Put a dash at the end of the buffer temporarily,
802 but make it go away when the next character is added. */
803 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
808 /* Display the current echo string, and begin echoing if not already
814 if (!current_kboard
->immediate_echo
)
817 current_kboard
->immediate_echo
= 1;
819 for (i
= 0; i
< this_command_key_count
; i
++)
823 /* Set before_command_echo_length to the value that would
824 have been saved before the start of this subcommand in
825 command_loop_1, if we had already been echoing then. */
826 if (i
== this_single_command_key_start
)
827 before_command_echo_length
= echo_length ();
829 c
= XVECTOR (this_command_keys
)->contents
[i
];
830 if (! (EVENT_HAS_PARAMETERS (c
)
831 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
835 /* Set before_command_echo_length to the value that would
836 have been saved before the start of this subcommand in
837 command_loop_1, if we had already been echoing then. */
838 if (this_command_key_count
== this_single_command_key_start
)
839 before_command_echo_length
= echo_length ();
841 /* Put a dash at the end to invite the user to type more. */
846 message3_nolog (current_kboard
->echo_string
,
847 SBYTES (current_kboard
->echo_string
),
848 STRING_MULTIBYTE (current_kboard
->echo_string
));
851 /* Record in what buffer we echoed, and from which kboard. */
852 echo_message_buffer
= echo_area_buffer
[0];
853 echo_kboard
= current_kboard
;
855 if (waiting_for_input
&& !NILP (Vquit_flag
))
856 quit_throw_to_read_char ();
859 /* Turn off echoing, for the start of a new command. */
864 current_kboard
->immediate_echo
= 0;
865 current_kboard
->echo_after_prompt
= -1;
866 current_kboard
->echo_string
= Qnil
;
867 ok_to_echo_at_next_pause
= NULL
;
869 echo_message_buffer
= Qnil
;
872 /* Return the length of the current echo string. */
877 return (STRINGP (current_kboard
->echo_string
)
878 ? SCHARS (current_kboard
->echo_string
)
882 /* Truncate the current echo message to its first LEN chars.
883 This and echo_char get used by read_key_sequence when the user
884 switches frames while entering a key sequence. */
887 echo_truncate (nchars
)
890 if (STRINGP (current_kboard
->echo_string
))
891 current_kboard
->echo_string
892 = Fsubstring (current_kboard
->echo_string
,
893 make_number (0), make_number (nchars
));
894 truncate_echo_area (nchars
);
898 /* Functions for manipulating this_command_keys. */
900 add_command_key (key
)
903 #if 0 /* Not needed after we made Freset_this_command_lengths
904 do the job immediately. */
905 /* If reset-this-command-length was called recently, obey it now.
906 See the doc string of that function for an explanation of why. */
907 if (before_command_restore_flag
)
909 this_command_key_count
= before_command_key_count_1
;
910 if (this_command_key_count
< this_single_command_key_start
)
911 this_single_command_key_start
= this_command_key_count
;
912 echo_truncate (before_command_echo_length_1
);
913 before_command_restore_flag
= 0;
917 if (this_command_key_count
>= ASIZE (this_command_keys
))
918 this_command_keys
= larger_vector (this_command_keys
,
919 2 * ASIZE (this_command_keys
),
922 ASET (this_command_keys
, this_command_key_count
, key
);
923 ++this_command_key_count
;
930 int count
= SPECPDL_INDEX ();
933 if (command_loop_level
> 0)
935 specbind (Qstandard_output
, Qt
);
936 specbind (Qstandard_input
, Qt
);
939 #ifdef HAVE_WINDOW_SYSTEM
940 /* The command loop has started an hourglass timer, so we have to
941 cancel it here, otherwise it will fire because the recursive edit
942 can take some time. Do not check for display_hourglass_p here,
943 because it could already be nil. */
947 /* This function may have been called from a debugger called from
948 within redisplay, for instance by Edebugging a function called
949 from fontification-functions. We want to allow redisplay in
950 the debugging session.
952 The recursive edit is left with a `(throw exit ...)'. The `exit'
953 tag is not caught anywhere in redisplay, i.e. when we leave the
954 recursive edit, the original redisplay leading to the recursive
955 edit will be unwound. The outcome should therefore be safe. */
956 specbind (Qinhibit_redisplay
, Qnil
);
959 val
= command_loop ();
961 Fsignal (Qquit
, Qnil
);
962 /* Handle throw from read_minibuf when using minibuffer
963 while it's active but we're in another window. */
965 xsignal1 (Qerror
, val
);
967 return unbind_to (count
, Qnil
);
970 /* When an auto-save happens, record the "time", and don't do again soon. */
975 last_auto_save
= num_nonmacro_input_events
;
978 /* Make an auto save happen as soon as possible at command level. */
981 force_auto_save_soon ()
983 last_auto_save
= - auto_save_interval
- 1;
985 record_asynch_buffer_change ();
988 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
989 doc
: /* Invoke the editor command loop recursively.
990 To get out of the recursive edit, a command can do `(throw 'exit nil)';
991 that tells this function to return.
992 Alternatively, `(throw 'exit t)' makes this function signal an error.
993 This function is called by the editor initialization to begin editing. */)
996 int count
= SPECPDL_INDEX ();
999 /* If we enter while input is blocked, don't lock up here.
1000 This may happen through the debugger during redisplay. */
1001 if (INPUT_BLOCKED_P
)
1004 command_loop_level
++;
1005 update_mode_lines
= 1;
1007 if (command_loop_level
1008 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1009 buffer
= Fcurrent_buffer ();
1013 /* If we leave recursive_edit_1 below with a `throw' for instance,
1014 like it is done in the splash screen display, we have to
1015 make sure that we restore single_kboard as command_loop_1
1016 would have done if it were left normally. */
1017 if (command_loop_level
> 0)
1018 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1019 record_unwind_protect (recursive_edit_unwind
, buffer
);
1021 recursive_edit_1 ();
1022 return unbind_to (count
, Qnil
);
1026 recursive_edit_unwind (buffer
)
1029 if (BUFFERP (buffer
))
1030 Fset_buffer (buffer
);
1032 command_loop_level
--;
1033 update_mode_lines
= 1;
1038 #if 0 /* These two functions are now replaced with
1039 temporarily_switch_to_single_kboard. */
1044 #if 0 /* Theory: if there's anything in Vunread_command_events,
1045 it will right away be read by read_key_sequence,
1046 and then if we do switch KBOARDS, it will go into the side
1047 queue then. So we don't need to do anything special here -- rms. */
1048 if (CONSP (Vunread_command_events
))
1050 current_kboard
->kbd_queue
1051 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1052 current_kboard
->kbd_queue_has_data
= 1;
1054 Vunread_command_events
= Qnil
;
1060 /* Switch to the single-kboard state, making current_kboard
1061 the only KBOARD from which further input is accepted. */
1064 single_kboard_state ()
1072 /* If we're in single_kboard state for kboard KBOARD,
1076 not_single_kboard_state (kboard
)
1080 if (kboard
== current_kboard
)
1085 /* Maintain a stack of kboards, so other parts of Emacs
1086 can switch temporarily to the kboard of a given frame
1087 and then revert to the previous status. */
1092 struct kboard_stack
*next
;
1095 static struct kboard_stack
*kboard_stack
;
1102 struct kboard_stack
*p
1103 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1105 p
->next
= kboard_stack
;
1106 p
->kboard
= current_kboard
;
1118 struct kboard_stack
*p
= kboard_stack
;
1120 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1122 if (t
->kboard
== p
->kboard
)
1124 current_kboard
= p
->kboard
;
1131 /* The terminal we remembered has been deleted. */
1132 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1135 kboard_stack
= p
->next
;
1140 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1141 from which further input is accepted. If F is non-nil, set its
1142 KBOARD as the current keyboard.
1144 This function uses record_unwind_protect to return to the previous
1147 If Emacs is already in single_kboard mode, and F's keyboard is
1148 locked, then this function will throw an errow. */
1151 temporarily_switch_to_single_kboard (f
)
1155 int was_locked
= single_kboard
;
1158 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1159 /* We can not switch keyboards while in single_kboard mode.
1160 In rare cases, Lisp code may call `recursive-edit' (or
1161 `read-minibuffer' or `y-or-n-p') after it switched to a
1162 locked frame. For example, this is likely to happen
1163 when server.el connects to a new terminal while Emacs is in
1164 single_kboard mode. It is best to throw an error instead
1165 of presenting the user with a frozen screen. */
1166 error ("Terminal %d is locked, cannot read from it",
1167 FRAME_TERMINAL (f
)->id
);
1169 /* This call is unnecessary, but helps
1170 `restore_kboard_configuration' discover if somebody changed
1171 `current_kboard' behind our back. */
1172 push_kboard (current_kboard
);
1175 current_kboard
= FRAME_KBOARD (f
);
1177 record_unwind_protect (restore_kboard_configuration
,
1178 (was_locked
? Qt
: Qnil
));
1182 #if 0 /* This function is not needed anymore. */
1184 record_single_kboard_state ()
1187 push_kboard (current_kboard
);
1188 record_unwind_protect (restore_kboard_configuration
,
1189 (single_kboard
? Qt
: Qnil
));
1195 restore_kboard_configuration (was_locked
)
1196 Lisp_Object was_locked
;
1198 if (NILP (was_locked
))
1202 struct kboard
*prev
= current_kboard
;
1205 /* The pop should not change the kboard. */
1206 if (single_kboard
&& current_kboard
!= prev
)
1214 /* Handle errors that are not handled at inner levels
1215 by printing an error message and returning to the editor command loop. */
1221 Lisp_Object old_level
, old_length
;
1222 char macroerror
[50];
1224 #ifdef HAVE_WINDOW_SYSTEM
1225 if (display_hourglass_p
)
1226 cancel_hourglass ();
1229 if (!NILP (executing_kbd_macro
))
1231 if (executing_kbd_macro_iterations
== 1)
1232 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1234 sprintf (macroerror
, "After %d kbd macro iterations: ",
1235 executing_kbd_macro_iterations
);
1240 Vstandard_output
= Qt
;
1241 Vstandard_input
= Qt
;
1242 Vexecuting_kbd_macro
= Qnil
;
1243 executing_kbd_macro
= Qnil
;
1244 current_kboard
->Vprefix_arg
= Qnil
;
1245 current_kboard
->Vlast_prefix_arg
= Qnil
;
1248 /* Avoid unquittable loop if data contains a circular list. */
1249 old_level
= Vprint_level
;
1250 old_length
= Vprint_length
;
1251 XSETFASTINT (Vprint_level
, 10);
1252 XSETFASTINT (Vprint_length
, 10);
1253 cmd_error_internal (data
, macroerror
);
1254 Vprint_level
= old_level
;
1255 Vprint_length
= old_length
;
1259 Vinhibit_quit
= Qnil
;
1260 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1262 if (command_loop_level
== 0 && minibuf_level
== 0)
1263 any_kboard_state ();
1267 return make_number (0);
1270 /* Take actions on handling an error. DATA is the data that describes
1273 CONTEXT is a C-string containing ASCII characters only which
1274 describes the context in which the error happened. If we need to
1275 generalize CONTEXT to allow multibyte characters, make it a Lisp
1279 cmd_error_internal (data
, context
)
1283 struct frame
*sf
= SELECTED_FRAME ();
1285 /* The immediate context is not interesting for Quits,
1286 since they are asyncronous. */
1287 if (EQ (XCAR (data
), Qquit
))
1288 Vsignaling_function
= Qnil
;
1293 /* Use user's specified output function if any. */
1294 if (!NILP (Vcommand_error_function
))
1295 call3 (Vcommand_error_function
, data
,
1296 context
? build_string (context
) : empty_unibyte_string
,
1297 Vsignaling_function
);
1298 /* If the window system or terminal frame hasn't been initialized
1299 yet, or we're not interactive, write the message to stderr and exit. */
1300 else if (!sf
->glyphs_initialized_p
1301 || FRAME_INITIAL_P (sf
)
1304 print_error_message (data
, Qexternal_debugging_output
,
1305 context
, Vsignaling_function
);
1306 Fterpri (Qexternal_debugging_output
);
1307 Fkill_emacs (make_number (-1));
1311 clear_message (1, 0);
1313 message_log_maybe_newline ();
1316 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1319 Vsignaling_function
= Qnil
;
1322 Lisp_Object
command_loop_1 ();
1323 Lisp_Object
command_loop_2 ();
1324 Lisp_Object
top_level_1 ();
1326 /* Entry to editor-command-loop.
1327 This level has the catches for exiting/returning to editor command loop.
1328 It returns nil to exit recursive edit, t to abort it. */
1333 if (command_loop_level
> 0 || minibuf_level
> 0)
1336 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1337 executing_kbd_macro
= Qnil
;
1343 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1344 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1345 /* Reset single_kboard in case top-level set it while
1346 evaluating an -f option, or we are stuck there for some
1348 any_kboard_state ();
1350 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1351 executing_kbd_macro
= Qnil
;
1353 /* End of file in -batch run causes exit here. */
1359 /* Here we catch errors in execution of commands within the
1360 editing loop, and reenter the editing loop.
1361 When there is an error, cmd_error runs and returns a non-nil
1362 value to us. A value of nil means that command_loop_1 itself
1363 returned due to end of file (or end of kbd macro). */
1368 register Lisp_Object val
;
1371 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1372 while (!NILP (val
));
1380 return Feval (Vtop_level
);
1386 /* On entry to the outer level, run the startup file */
1387 if (!NILP (Vtop_level
))
1388 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1389 else if (!NILP (Vpurify_flag
))
1390 message ("Bare impure Emacs (standard Lisp code not loaded)");
1392 message ("Bare Emacs (standard Lisp code not loaded)");
1396 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1397 doc
: /* Exit all recursive editing levels. */)
1400 #ifdef HAVE_WINDOW_SYSTEM
1401 if (display_hourglass_p
)
1402 cancel_hourglass ();
1405 /* Unblock input if we enter with input blocked. This may happen if
1406 redisplay traps e.g. during tool-bar update with input blocked. */
1407 while (INPUT_BLOCKED_P
)
1410 return Fthrow (Qtop_level
, Qnil
);
1413 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1414 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1417 if (command_loop_level
> 0 || minibuf_level
> 0)
1418 Fthrow (Qexit
, Qnil
);
1420 error ("No recursive edit is in progress");
1424 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1425 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1428 if (command_loop_level
> 0 || minibuf_level
> 0)
1431 error ("No recursive edit is in progress");
1435 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1437 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1438 of this function. */
1441 tracking_off (old_value
)
1442 Lisp_Object old_value
;
1444 do_mouse_tracking
= old_value
;
1445 if (NILP (old_value
))
1447 /* Redisplay may have been preempted because there was input
1448 available, and it assumes it will be called again after the
1449 input has been processed. If the only input available was
1450 the sort that we have just disabled, then we need to call
1452 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1454 redisplay_preserve_echo_area (6);
1455 get_input_pending (&input_pending
,
1456 READABLE_EVENTS_DO_TIMERS_NOW
);
1462 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1463 doc
: /* Evaluate BODY with mouse movement events enabled.
1464 Within a `track-mouse' form, mouse motion generates input events that
1465 you can read with `read-event'.
1466 Normally, mouse motion is ignored.
1467 usage: (track-mouse BODY...) */)
1471 int count
= SPECPDL_INDEX ();
1474 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1476 do_mouse_tracking
= Qt
;
1478 val
= Fprogn (args
);
1479 return unbind_to (count
, val
);
1482 /* If mouse has moved on some frame, return one of those frames.
1486 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1487 after resizing the tool-bar window. */
1489 int ignore_mouse_drag_p
;
1494 Lisp_Object tail
, frame
;
1496 if (ignore_mouse_drag_p
)
1498 /* ignore_mouse_drag_p = 0; */
1502 FOR_EACH_FRAME (tail
, frame
)
1504 if (XFRAME (frame
)->mouse_moved
)
1505 return XFRAME (frame
);
1511 #endif /* HAVE_MOUSE || HAVE_GPM */
1513 /* This is the actual command reading loop,
1514 sans error-handling encapsulation. */
1516 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1518 void safe_run_hooks
P_ ((Lisp_Object
));
1519 static void adjust_point_for_property
P_ ((int, int));
1521 /* Cancel hourglass from protect_unwind.
1523 #ifdef HAVE_WINDOW_SYSTEM
1525 cancel_hourglass_unwind (arg
)
1528 cancel_hourglass ();
1539 Lisp_Object keybuf
[30];
1541 int prev_modiff
= 0;
1542 struct buffer
*prev_buffer
= NULL
;
1543 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1545 int was_locked
= single_kboard
;
1548 int already_adjusted
= 0;
1550 current_kboard
->Vprefix_arg
= Qnil
;
1551 current_kboard
->Vlast_prefix_arg
= Qnil
;
1552 Vdeactivate_mark
= Qnil
;
1553 waiting_for_input
= 0;
1557 this_command_key_count
= 0;
1558 this_command_key_count_reset
= 0;
1559 this_single_command_key_start
= 0;
1561 if (NILP (Vmemory_full
))
1563 /* Make sure this hook runs after commands that get errors and
1564 throw to top level. */
1565 /* Note that the value cell will never directly contain nil
1566 if the symbol is a local variable. */
1567 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1568 safe_run_hooks (Qpost_command_hook
);
1570 /* If displaying a message, resize the echo area window to fit
1571 that message's size exactly. */
1572 if (!NILP (echo_area_buffer
[0]))
1573 resize_echo_area_exactly ();
1575 if (!NILP (Vdeferred_action_list
))
1576 safe_run_hooks (Qdeferred_action_function
);
1579 /* Do this after running Vpost_command_hook, for consistency. */
1580 current_kboard
->Vlast_command
= Vthis_command
;
1581 current_kboard
->Vreal_last_command
= real_this_command
;
1582 if (!CONSP (last_command_char
))
1583 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1587 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1590 /* Make sure the current window's buffer is selected. */
1591 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1592 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1594 /* Display any malloc warning that just came out. Use while because
1595 displaying one warning can cause another. */
1597 while (pending_malloc_warning
)
1598 display_malloc_warning ();
1600 Vdeactivate_mark
= Qnil
;
1602 /* If minibuffer on and echo area in use,
1603 wait a short time and redraw minibuffer. */
1606 && !NILP (echo_area_buffer
[0])
1607 && EQ (minibuf_window
, echo_area_window
)
1608 && NUMBERP (Vminibuffer_message_timeout
))
1610 /* Bind inhibit-quit to t so that C-g gets read in
1611 rather than quitting back to the minibuffer. */
1612 int count
= SPECPDL_INDEX ();
1613 specbind (Qinhibit_quit
, Qt
);
1615 sit_for (Vminibuffer_message_timeout
, 0, 2);
1617 /* Clear the echo area. */
1619 safe_run_hooks (Qecho_area_clear_hook
);
1621 unbind_to (count
, Qnil
);
1623 /* If a C-g came in before, treat it as input now. */
1624 if (!NILP (Vquit_flag
))
1627 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1632 /* Select the frame that the last event came from. Usually,
1633 switch-frame events will take care of this, but if some lisp
1634 code swallows a switch-frame event, we'll fix things up here.
1635 Is this a good idea? */
1636 if (FRAMEP (internal_last_event_frame
)
1637 && !EQ (internal_last_event_frame
, selected_frame
))
1638 Fselect_frame (internal_last_event_frame
);
1640 /* If it has changed current-menubar from previous value,
1641 really recompute the menubar from the value. */
1642 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1643 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1644 call0 (Qrecompute_lucid_menubar
);
1646 before_command_key_count
= this_command_key_count
;
1647 before_command_echo_length
= echo_length ();
1649 Vthis_command
= Qnil
;
1650 real_this_command
= Qnil
;
1651 Vthis_original_command
= Qnil
;
1652 Vthis_command_keys_shift_translated
= 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
1767 && NILP (Vthis_command_keys_shift_translated
)
1768 && !CONSP (Vtransient_mark_mode
))
1770 struct Lisp_Char_Table
*dp
1771 = window_display_table (XWINDOW (selected_window
));
1772 lose
= FETCH_CHAR (PT_BYTE
);
1774 if (! NILP (Vpost_command_hook
))
1775 /* Put this before calling adjust_point_for_property
1776 so it will only get called once in any case. */
1778 if (current_buffer
== prev_buffer
1779 && last_point_position
!= PT
1780 && NILP (Vdisable_point_adjustment
)
1781 && NILP (Vglobal_disable_point_adjustment
))
1782 adjust_point_for_property (last_point_position
, 0);
1783 already_adjusted
= 1;
1784 if (PT
== last_point_position
+ 1
1786 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1787 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1788 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1789 && (lose
>= 0x20 && lose
< 0x7f)))
1790 : (lose
>= 0x20 && lose
< 0x7f))
1791 /* To extract the case of continuation on
1792 wide-column characters. */
1793 && ASCII_BYTE_P (lose
)
1794 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1796 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1798 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1800 && !windows_or_buffers_changed
1801 && EQ (current_buffer
->selective_display
, Qnil
)
1802 && !detect_input_pending ()
1803 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1804 && NILP (Vexecuting_kbd_macro
))
1805 direct_output_forward_char (1);
1808 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1809 && NILP (Vthis_command_keys_shift_translated
)
1810 && !CONSP (Vtransient_mark_mode
))
1812 struct Lisp_Char_Table
*dp
1813 = window_display_table (XWINDOW (selected_window
));
1815 lose
= FETCH_CHAR (PT_BYTE
);
1816 if (! NILP (Vpost_command_hook
))
1818 if (current_buffer
== prev_buffer
1819 && last_point_position
!= PT
1820 && NILP (Vdisable_point_adjustment
)
1821 && NILP (Vglobal_disable_point_adjustment
))
1822 adjust_point_for_property (last_point_position
, 0);
1823 already_adjusted
= 1;
1824 if (PT
== last_point_position
- 1
1826 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1827 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1828 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1829 && (lose
>= 0x20 && lose
< 0x7f)))
1830 : (lose
>= 0x20 && lose
< 0x7f))
1831 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1833 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1835 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1837 && !windows_or_buffers_changed
1838 && EQ (current_buffer
->selective_display
, Qnil
)
1839 && !detect_input_pending ()
1840 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1841 && NILP (Vexecuting_kbd_macro
))
1842 direct_output_forward_char (-1);
1845 else if (EQ (Vthis_command
, Qself_insert_command
)
1846 /* Try this optimization only on char keystrokes. */
1847 && NATNUMP (last_command_char
)
1848 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1851 = translate_char (Vtranslation_table_for_input
,
1852 XFASTINT (last_command_char
));
1854 if (NILP (Vexecuting_kbd_macro
)
1855 && !EQ (minibuf_window
, selected_window
))
1857 if (!nonundocount
|| nonundocount
>= 20)
1865 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1867 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1869 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1871 || MODIFF
<= SAVE_MODIFF
1872 || windows_or_buffers_changed
1873 || !EQ (current_buffer
->selective_display
, Qnil
)
1874 || detect_input_pending ()
1875 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1876 || !NILP (Vexecuting_kbd_macro
));
1878 value
= internal_self_insert (c
, 0);
1883 if (! NILP (Vpost_command_hook
))
1884 /* Put this before calling adjust_point_for_property
1885 so it will only get called once in any case. */
1888 /* VALUE == 1 when AFTER-CHANGE functions are
1889 installed which is the case most of the time
1890 because FONT-LOCK installs one. */
1891 if (!lose
&& !value
)
1892 direct_output_for_insert (c
);
1897 /* Here for a command that isn't executed directly */
1900 #ifdef HAVE_WINDOW_SYSTEM
1901 int scount
= SPECPDL_INDEX ();
1903 if (display_hourglass_p
1904 && NILP (Vexecuting_kbd_macro
))
1906 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1912 if (NILP (current_kboard
->Vprefix_arg
))
1914 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1916 #ifdef HAVE_WINDOW_SYSTEM
1917 /* Do not check display_hourglass_p here, because
1918 Fcommand_execute could change it, but we should cancel
1919 hourglass cursor anyway.
1920 But don't cancel the hourglass within a macro
1921 just because a command in the macro finishes. */
1922 if (NILP (Vexecuting_kbd_macro
))
1923 unbind_to (scount
, Qnil
);
1928 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1930 /* Note that the value cell will never directly contain nil
1931 if the symbol is a local variable. */
1932 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1933 safe_run_hooks (Qpost_command_hook
);
1935 /* If displaying a message, resize the echo area window to fit
1936 that message's size exactly. */
1937 if (!NILP (echo_area_buffer
[0]))
1938 resize_echo_area_exactly ();
1940 if (!NILP (Vdeferred_action_list
))
1941 safe_run_hooks (Qdeferred_action_function
);
1943 /* If there is a prefix argument,
1944 1) We don't want Vlast_command to be ``universal-argument''
1945 (that would be dumb), so don't set Vlast_command,
1946 2) we want to leave echoing on so that the prefix will be
1947 echoed as part of this key sequence, so don't call
1949 3) we want to leave this_command_key_count non-zero, so that
1950 read_char will realize that it is re-reading a character, and
1951 not echo it a second time.
1953 If the command didn't actually create a prefix arg,
1954 but is merely a frame event that is transparent to prefix args,
1955 then the above doesn't apply. */
1956 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1958 current_kboard
->Vlast_command
= Vthis_command
;
1959 current_kboard
->Vreal_last_command
= real_this_command
;
1960 if (!CONSP (last_command_char
))
1961 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1963 this_command_key_count
= 0;
1964 this_command_key_count_reset
= 0;
1965 this_single_command_key_start
= 0;
1968 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1970 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1972 /* We could also call `deactivate'mark'. */
1973 if (EQ (Vtransient_mark_mode
, Qlambda
))
1974 Vtransient_mark_mode
= Qnil
;
1977 current_buffer
->mark_active
= Qnil
;
1978 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1981 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1982 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1987 if (current_buffer
== prev_buffer
1988 && last_point_position
!= PT
1989 && NILP (Vdisable_point_adjustment
)
1990 && NILP (Vglobal_disable_point_adjustment
)
1991 && !already_adjusted
)
1992 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1994 /* Install chars successfully executed in kbd macro. */
1996 if (!NILP (current_kboard
->defining_kbd_macro
)
1997 && NILP (current_kboard
->Vprefix_arg
))
1998 finalize_kbd_macro_chars ();
1999 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2002 any_kboard_state ();
2008 extern Lisp_Object Qcomposition
, Qdisplay
;
2010 /* Adjust point to a boundary of a region that has such a property
2011 that should be treated intangible. For the moment, we check
2012 `composition', `display' and `invisible' properties.
2013 LAST_PT is the last position of point. */
2015 extern Lisp_Object Qafter_string
, Qbefore_string
;
2016 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2019 adjust_point_for_property (last_pt
, modified
)
2024 Lisp_Object val
, overlay
, tmp
;
2025 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2028 /* FIXME: cycling is probably not necessary because these properties
2029 can't be usefully combined anyway. */
2030 while (check_composition
|| check_display
|| check_invisible
)
2032 if (check_composition
2033 && PT
> BEGV
&& PT
< ZV
2034 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2035 && COMPOSITION_VALID_P (beg
, end
, val
)
2036 && beg
< PT
/* && end > PT <- It's always the case. */
2037 && (last_pt
<= beg
|| last_pt
>= end
))
2040 SET_PT (PT
< last_pt
? beg
: end
);
2041 check_display
= check_invisible
= 1;
2043 check_composition
= 0;
2045 && PT
> BEGV
&& PT
< ZV
2046 && !NILP (val
= get_char_property_and_overlay
2047 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2048 && display_prop_intangible_p (val
)
2049 && (!OVERLAYP (overlay
)
2050 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2051 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2052 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2053 && (beg
< PT
/* && end > PT <- It's always the case. */
2054 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2057 SET_PT (PT
< last_pt
2058 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2060 check_composition
= check_invisible
= 1;
2063 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2065 int inv
, ellipsis
= 0;
2068 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2070 && !NILP (val
= get_char_property_and_overlay
2071 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2072 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2074 ellipsis
= ellipsis
|| inv
> 1
2075 || (OVERLAYP (overlay
)
2076 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2077 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2078 tmp
= Fnext_single_char_property_change
2079 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2080 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2083 && !NILP (val
= get_char_property_and_overlay
2084 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2085 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2087 ellipsis
= ellipsis
|| inv
> 1
2088 || (OVERLAYP (overlay
)
2089 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2090 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2091 tmp
= Fprevious_single_char_property_change
2092 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2093 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2096 /* Move away from the inside area. */
2097 if (beg
< PT
&& end
> PT
)
2099 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2100 /* We haven't moved yet (so we don't need to fear
2101 infinite-looping) and we were outside the range
2102 before (so either end of the range still corresponds
2103 to a move in the right direction): pretend we moved
2104 less than we actually did, so that we still have
2105 more freedom below in choosing which end of the range
2107 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2108 /* We either have moved already or the last point
2109 was already in the range: we don't get to choose
2110 which end of the range we have to go to. */
2111 : (PT
< last_pt
? beg
: end
));
2112 check_composition
= check_display
= 1;
2114 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2115 the point to something other than its argument, due to
2116 point-motion hooks, intangibility, etc. */
2117 xassert (PT
== beg
|| PT
== end
);
2120 /* Pretend the area doesn't exist if the buffer is not
2122 if (!modified
&& !ellipsis
&& beg
< end
)
2124 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2125 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2126 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2127 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2128 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2129 /* We've already moved as far as we can. Trying to go
2130 to the other end would mean moving backwards and thus
2131 could lead to an infinite loop. */
2133 else if (val
= get_pos_property (make_number (PT
),
2135 TEXT_PROP_MEANS_INVISIBLE (val
)
2136 && (val
= get_pos_property
2137 (make_number (PT
== beg
? end
: beg
),
2139 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2140 (check_composition
= check_display
= 1,
2141 SET_PT (PT
== beg
? end
: beg
));
2144 check_invisible
= 0;
2148 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2151 safe_run_hooks_1 (hook
)
2154 if (NILP (Vrun_hooks
))
2156 return call1 (Vrun_hooks
, Vinhibit_quit
);
2159 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2162 safe_run_hooks_error (data
)
2165 Lisp_Object args
[3];
2166 args
[0] = build_string ("Error in %s: %s");
2167 args
[1] = Vinhibit_quit
;
2170 return Fset (Vinhibit_quit
, Qnil
);
2173 /* If we get an error while running the hook, cause the hook variable
2174 to be nil. Also inhibit quits, so that C-g won't cause the hook
2175 to mysteriously evaporate. */
2178 safe_run_hooks (hook
)
2181 int count
= SPECPDL_INDEX ();
2182 specbind (Qinhibit_quit
, hook
);
2184 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2186 unbind_to (count
, Qnil
);
2190 /* Number of seconds between polling for input. This is a Lisp
2191 variable that can be bound. */
2193 EMACS_INT polling_period
;
2195 /* Nonzero means polling for input is temporarily suppressed. */
2197 int poll_suppress_count
;
2199 /* Asynchronous timer for polling. */
2201 struct atimer
*poll_timer
;
2204 #ifdef POLL_FOR_INPUT
2206 /* Poll for input, so what we catch a C-g if it comes in. This
2207 function is called from x_make_frame_visible, see comment
2213 if (interrupt_input_blocked
== 0
2214 && !waiting_for_input
)
2215 read_avail_input (0);
2218 /* Timer callback function for poll_timer. TIMER is equal to
2222 poll_for_input (timer
)
2223 struct atimer
*timer
;
2225 if (poll_suppress_count
== 0)
2227 interrupt_input_pending
= 1;
2229 poll_for_input_1 ();
2233 #endif /* POLL_FOR_INPUT */
2235 /* Begin signals to poll for input, if they are appropriate.
2236 This function is called unconditionally from various places. */
2241 #ifdef POLL_FOR_INPUT
2242 /* XXX This condition was (read_socket_hook && !interrupt_input),
2243 but read_socket_hook is not global anymore. Let's pretend that
2245 if (!interrupt_input
)
2247 /* Turn alarm handling on unconditionally. It might have
2248 been turned off in process.c. */
2249 turn_on_atimers (1);
2251 /* If poll timer doesn't exist, are we need one with
2252 a different interval, start a new one. */
2253 if (poll_timer
== NULL
2254 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2256 EMACS_TIME interval
;
2259 cancel_atimer (poll_timer
);
2261 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2262 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2263 poll_for_input
, NULL
);
2266 /* Let the timer's callback function poll for input
2267 if this becomes zero. */
2268 --poll_suppress_count
;
2273 /* Nonzero if we are using polling to handle input asynchronously. */
2276 input_polling_used ()
2278 #ifdef POLL_FOR_INPUT
2279 /* XXX This condition was (read_socket_hook && !interrupt_input),
2280 but read_socket_hook is not global anymore. Let's pretend that
2282 return !interrupt_input
;
2288 /* Turn off polling. */
2293 #ifdef POLL_FOR_INPUT
2294 /* XXX This condition was (read_socket_hook && !interrupt_input),
2295 but read_socket_hook is not global anymore. Let's pretend that
2297 if (!interrupt_input
)
2298 ++poll_suppress_count
;
2302 /* Set the value of poll_suppress_count to COUNT
2303 and start or stop polling accordingly. */
2306 set_poll_suppress_count (count
)
2309 #ifdef POLL_FOR_INPUT
2310 if (count
== 0 && poll_suppress_count
!= 0)
2312 poll_suppress_count
= 1;
2315 else if (count
!= 0 && poll_suppress_count
== 0)
2319 poll_suppress_count
= count
;
2323 /* Bind polling_period to a value at least N.
2324 But don't decrease it. */
2327 bind_polling_period (n
)
2330 #ifdef POLL_FOR_INPUT
2331 int new = polling_period
;
2336 stop_other_atimers (poll_timer
);
2338 specbind (Qpolling_period
, make_number (new));
2339 /* Start a new alarm with the new period. */
2344 /* Apply the control modifier to CHARACTER. */
2350 /* Save the upper bits here. */
2351 int upper
= c
& ~0177;
2353 if (! ASCII_BYTE_P (c
))
2354 return c
|= ctrl_modifier
;
2358 /* Everything in the columns containing the upper-case letters
2359 denotes a control character. */
2360 if (c
>= 0100 && c
< 0140)
2364 /* Set the shift modifier for a control char
2365 made from a shifted letter. But only for letters! */
2366 if (oc
>= 'A' && oc
<= 'Z')
2367 c
|= shift_modifier
;
2370 /* The lower-case letters denote control characters too. */
2371 else if (c
>= 'a' && c
<= 'z')
2374 /* Include the bits for control and shift
2375 only if the basic ASCII code can't indicate them. */
2379 /* Replace the high bits. */
2380 c
|= (upper
& ~ctrl_modifier
);
2385 /* Display the help-echo property of the character after the mouse pointer.
2386 Either show it in the echo area, or call show-help-function to display
2387 it by other means (maybe in a tooltip).
2389 If HELP is nil, that means clear the previous help echo.
2391 If HELP is a string, display that string. If HELP is a function,
2392 call it with OBJECT and POS as arguments; the function should
2393 return a help string or nil for none. For all other types of HELP,
2394 evaluate it to obtain a string.
2396 WINDOW is the window in which the help was generated, if any.
2397 It is nil if not in a window.
2399 If OBJECT is a buffer, POS is the position in the buffer where the
2400 `help-echo' text property was found.
2402 If OBJECT is an overlay, that overlay has a `help-echo' property,
2403 and POS is the position in the overlay's buffer under the mouse.
2405 If OBJECT is a string (an overlay string or a string displayed with
2406 the `display' property). POS is the position in that string under
2409 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2410 echo overwrites a keystroke echo currently displayed in the echo
2413 Note: this function may only be called with HELP nil or a string
2414 from X code running asynchronously. */
2417 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2418 Lisp_Object help
, window
, object
, pos
;
2419 int ok_to_overwrite_keystroke_echo
;
2421 if (!NILP (help
) && !STRINGP (help
))
2423 if (FUNCTIONP (help
))
2425 Lisp_Object args
[4];
2430 help
= safe_call (4, args
);
2433 help
= safe_eval (help
);
2435 if (!STRINGP (help
))
2439 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2440 if (!noninteractive
&& STRINGP (help
))
2442 /* The mouse-fixup-help-message Lisp function can call
2443 mouse_position_hook, which resets the mouse_moved flags.
2444 This causes trouble if we are trying to read a mouse motion
2445 event (i.e., if we are inside a `track-mouse' form), so we
2446 restore the mouse_moved flag. */
2447 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2448 help
= call1 (Qmouse_fixup_help_message
, help
);
2454 if (STRINGP (help
) || NILP (help
))
2456 if (!NILP (Vshow_help_function
))
2457 call1 (Vshow_help_function
, help
);
2458 else if (/* Don't overwrite minibuffer contents. */
2459 !MINI_WINDOW_P (XWINDOW (selected_window
))
2460 /* Don't overwrite a keystroke echo. */
2461 && (NILP (echo_message_buffer
)
2462 || ok_to_overwrite_keystroke_echo
)
2463 /* Don't overwrite a prompt. */
2464 && !cursor_in_echo_area
)
2468 int count
= SPECPDL_INDEX ();
2470 if (!help_echo_showing_p
)
2471 Vpre_help_message
= current_message ();
2473 specbind (Qmessage_truncate_lines
, Qt
);
2474 message3_nolog (help
, SBYTES (help
),
2475 STRING_MULTIBYTE (help
));
2476 unbind_to (count
, Qnil
);
2478 else if (STRINGP (Vpre_help_message
))
2480 message3_nolog (Vpre_help_message
,
2481 SBYTES (Vpre_help_message
),
2482 STRING_MULTIBYTE (Vpre_help_message
));
2483 Vpre_help_message
= Qnil
;
2489 help_echo_showing_p
= STRINGP (help
);
2495 /* Input of single characters from keyboard */
2497 Lisp_Object
print_help ();
2498 static Lisp_Object
kbd_buffer_get_event ();
2499 static void record_char ();
2501 static Lisp_Object help_form_saved_window_configs
;
2503 read_char_help_form_unwind (arg
)
2505 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2506 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2507 if (!NILP (window_config
))
2508 Fset_window_configuration (window_config
);
2512 #define STOP_POLLING \
2513 do { if (! polling_stopped_here) stop_polling (); \
2514 polling_stopped_here = 1; } while (0)
2516 #define RESUME_POLLING \
2517 do { if (polling_stopped_here) start_polling (); \
2518 polling_stopped_here = 0; } while (0)
2520 /* read a character from the keyboard; call the redisplay if needed */
2521 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2522 -1 means do not do redisplay, but do do autosaving.
2525 /* The arguments MAPS and NMAPS are for menu prompting.
2526 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2528 PREV_EVENT is the previous input event, or nil if we are reading
2529 the first event of a key sequence (or not reading a key sequence).
2530 If PREV_EVENT is t, that is a "magic" value that says
2531 not to run input methods, but in other respects to act as if
2532 not reading a key sequence.
2534 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2535 if we used a mouse menu to read the input, or zero otherwise. If
2536 USED_MOUSE_MENU is null, we don't dereference it.
2538 Value is -2 when we find input on another keyboard. A second call
2539 to read_char will read it.
2541 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2542 specifying the maximum time to wait until. If no input arrives by
2543 that time, stop waiting and return nil.
2545 Value is t if we showed a menu and the user rejected it. */
2548 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2552 Lisp_Object prev_event
;
2553 int *used_mouse_menu
;
2554 EMACS_TIME
*end_time
;
2556 volatile Lisp_Object c
;
2557 int count
, jmpcount
;
2558 jmp_buf local_getcjmp
;
2560 volatile int key_already_recorded
= 0;
2561 Lisp_Object tem
, save
;
2562 volatile Lisp_Object previous_echo_area_message
;
2563 volatile Lisp_Object also_record
;
2564 volatile int reread
;
2565 struct gcpro gcpro1
, gcpro2
;
2566 int polling_stopped_here
= 0;
2567 struct kboard
*orig_kboard
= current_kboard
;
2571 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2572 before_command_key_count
= this_command_key_count
;
2573 before_command_echo_length
= echo_length ();
2576 previous_echo_area_message
= Qnil
;
2578 GCPRO2 (c
, previous_echo_area_message
);
2583 if (CONSP (Vunread_post_input_method_events
))
2585 c
= XCAR (Vunread_post_input_method_events
);
2586 Vunread_post_input_method_events
2587 = XCDR (Vunread_post_input_method_events
);
2589 /* Undo what read_char_x_menu_prompt did when it unread
2590 additional keys returned by Fx_popup_menu. */
2592 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2600 if (unread_command_char
!= -1)
2602 XSETINT (c
, unread_command_char
);
2603 unread_command_char
= -1;
2609 if (CONSP (Vunread_command_events
))
2611 c
= XCAR (Vunread_command_events
);
2612 Vunread_command_events
= XCDR (Vunread_command_events
);
2616 /* Undo what sit-for did when it unread additional keys
2617 inside universal-argument. */
2620 && EQ (XCAR (c
), Qt
))
2626 /* Undo what read_char_x_menu_prompt did when it unread
2627 additional keys returned by Fx_popup_menu. */
2629 && EQ (XCDR (c
), Qdisabled
)
2630 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2633 /* If the queued event is something that used the mouse,
2634 set used_mouse_menu accordingly. */
2636 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2637 *used_mouse_menu
= 1;
2639 goto reread_for_input_method
;
2642 if (CONSP (Vunread_input_method_events
))
2644 c
= XCAR (Vunread_input_method_events
);
2645 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2647 /* Undo what read_char_x_menu_prompt did when it unread
2648 additional keys returned by Fx_popup_menu. */
2650 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2654 goto reread_for_input_method
;
2657 this_command_key_count_reset
= 0;
2659 if (!NILP (Vexecuting_kbd_macro
))
2661 /* We set this to Qmacro; since that's not a frame, nobody will
2662 try to switch frames on us, and the selected window will
2665 Since this event came from a macro, it would be misleading to
2666 leave internal_last_event_frame set to wherever the last
2667 real event came from. Normally, a switch-frame event selects
2668 internal_last_event_frame after each command is read, but
2669 events read from a macro should never cause a new frame to be
2671 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2673 /* Exit the macro if we are at the end.
2674 Also, some things replace the macro with t
2675 to force an early exit. */
2676 if (EQ (Vexecuting_kbd_macro
, Qt
)
2677 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2683 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2684 if (STRINGP (Vexecuting_kbd_macro
)
2685 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2686 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2688 executing_kbd_macro_index
++;
2693 if (!NILP (unread_switch_frame
))
2695 c
= unread_switch_frame
;
2696 unread_switch_frame
= Qnil
;
2698 /* This event should make it into this_command_keys, and get echoed
2699 again, so we do not set `reread'. */
2703 /* if redisplay was requested */
2704 if (commandflag
>= 0)
2706 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2708 /* If there is pending input, process any events which are not
2709 user-visible, such as X selection_request events. */
2711 || detect_input_pending_run_timers (0))
2712 swallow_events (0); /* may clear input_pending */
2714 /* Redisplay if no pending input. */
2715 while (!input_pending
)
2717 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2718 redisplay_preserve_echo_area (5);
2723 /* Normal case: no input arrived during redisplay. */
2726 /* Input arrived and pre-empted redisplay.
2727 Process any events which are not user-visible. */
2729 /* If that cleared input_pending, try again to redisplay. */
2732 /* Prevent the redisplay we just did
2733 from messing up echoing of the input after the prompt. */
2734 if (commandflag
== 0 && echo_current
)
2735 echo_message_buffer
= echo_area_buffer
[0];
2739 /* Message turns off echoing unless more keystrokes turn it on again.
2741 The code in 20.x for the condition was
2743 1. echo_area_glyphs && *echo_area_glyphs
2744 2. && echo_area_glyphs != current_kboard->echobuf
2745 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2747 (1) means there's a current message displayed
2749 (2) means it's not the message from echoing from the current
2752 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2753 is set to a non-null value. This is done in read_char and it is
2754 set to echo_area_glyphs after a call to echo_char. That means
2755 ok_to_echo_at_next_pause is either null or
2756 current_kboard->echobuf with the appropriate current_kboard at
2759 So, condition (3) means in clear text ok_to_echo_at_next_pause
2760 must be either null, or the current message isn't from echoing at
2761 all, or it's from echoing from a different kboard than the
2764 if (/* There currently is something in the echo area. */
2765 !NILP (echo_area_buffer
[0])
2766 && (/* And it's either not from echoing. */
2767 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2768 /* Or it's an echo from a different kboard. */
2769 || echo_kboard
!= current_kboard
2770 /* Or we explicitly allow overwriting whatever there is. */
2771 || ok_to_echo_at_next_pause
== NULL
))
2776 /* Try reading a character via menu prompting in the minibuf.
2777 Try this before the sit-for, because the sit-for
2778 would do the wrong thing if we are supposed to do
2779 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2780 after a mouse event so don't try a minibuf menu. */
2782 if (nmaps
> 0 && INTERACTIVE
2783 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2784 /* Don't bring up a menu if we already have another event. */
2785 && NILP (Vunread_command_events
)
2786 && unread_command_char
< 0
2787 && !detect_input_pending_run_timers (0))
2789 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2791 if (INTEGERP (c
) && XINT (c
) == -2)
2792 return c
; /* wrong_kboard_jmpbuf */
2796 key_already_recorded
= 1;
2801 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2802 We will do that below, temporarily for short sections of code,
2803 when appropriate. local_getcjmp must be in effect
2804 around any call to sit_for or kbd_buffer_get_event;
2805 it *must not* be in effect when we call redisplay. */
2807 jmpcount
= SPECPDL_INDEX ();
2808 if (_setjmp (local_getcjmp
))
2810 /* Handle quits while reading the keyboard. */
2811 /* We must have saved the outer value of getcjmp here,
2812 so restore it now. */
2813 restore_getcjmp (save_jump
);
2814 unbind_to (jmpcount
, Qnil
);
2815 XSETINT (c
, quit_char
);
2816 internal_last_event_frame
= selected_frame
;
2817 Vlast_event_frame
= internal_last_event_frame
;
2818 /* If we report the quit char as an event,
2819 don't do so more than once. */
2820 if (!NILP (Vinhibit_quit
))
2825 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2826 if (kb
!= current_kboard
)
2828 Lisp_Object link
= kb
->kbd_queue
;
2829 /* We shouldn't get here if we were in single-kboard mode! */
2834 while (CONSP (XCDR (link
)))
2836 if (!NILP (XCDR (link
)))
2840 kb
->kbd_queue
= Fcons (c
, Qnil
);
2842 XSETCDR (link
, Fcons (c
, Qnil
));
2843 kb
->kbd_queue_has_data
= 1;
2844 current_kboard
= kb
;
2845 /* This is going to exit from read_char
2846 so we had better get rid of this frame's stuff. */
2848 return make_number (-2); /* wrong_kboard_jmpbuf */
2855 /* Start idle timers if no time limit is supplied. We don't do it
2856 if a time limit is supplied to avoid an infinite recursion in the
2857 situation where an idle timer calls `sit-for'. */
2860 timer_start_idle ();
2862 /* If in middle of key sequence and minibuffer not active,
2863 start echoing if enough time elapses. */
2865 if (minibuf_level
== 0
2867 && !current_kboard
->immediate_echo
2868 && this_command_key_count
> 0
2870 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2871 && NILP (Fzerop (Vecho_keystrokes
))
2872 && (/* No message. */
2873 NILP (echo_area_buffer
[0])
2874 /* Or empty message. */
2875 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2876 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2877 /* Or already echoing from same kboard. */
2878 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2879 /* Or not echoing before and echoing allowed. */
2880 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2882 /* After a mouse event, start echoing right away.
2883 This is because we are probably about to display a menu,
2884 and we don't want to delay before doing so. */
2885 if (EVENT_HAS_PARAMETERS (prev_event
))
2891 save_getcjmp (save_jump
);
2892 restore_getcjmp (local_getcjmp
);
2893 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2894 restore_getcjmp (save_jump
);
2896 && ! CONSP (Vunread_command_events
))
2901 /* Maybe auto save due to number of keystrokes. */
2903 if (commandflag
!= 0
2904 && auto_save_interval
> 0
2905 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2906 && !detect_input_pending_run_timers (0))
2908 Fdo_auto_save (Qnil
, Qnil
);
2909 /* Hooks can actually change some buffers in auto save. */
2913 /* Try reading using an X menu.
2914 This is never confused with reading using the minibuf
2915 because the recursive call of read_char in read_char_minibuf_menu_prompt
2916 does not pass on any keymaps. */
2918 if (nmaps
> 0 && INTERACTIVE
2919 && !NILP (prev_event
)
2920 && EVENT_HAS_PARAMETERS (prev_event
)
2921 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2922 && !EQ (XCAR (prev_event
), Qtool_bar
)
2923 /* Don't bring up a menu if we already have another event. */
2924 && NILP (Vunread_command_events
)
2925 && unread_command_char
< 0)
2927 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2929 /* Now that we have read an event, Emacs is not idle. */
2936 /* Maybe autosave and/or garbage collect due to idleness. */
2938 if (INTERACTIVE
&& NILP (c
))
2940 int delay_level
, buffer_size
;
2942 /* Slow down auto saves logarithmically in size of current buffer,
2943 and garbage collect while we're at it. */
2944 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2945 last_non_minibuf_size
= Z
- BEG
;
2946 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2948 while (buffer_size
> 64)
2949 delay_level
++, buffer_size
-= buffer_size
>> 2;
2950 if (delay_level
< 4) delay_level
= 4;
2951 /* delay_level is 4 for files under around 50k, 7 at 100k,
2952 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2954 /* Auto save if enough time goes by without input. */
2955 if (commandflag
!= 0
2956 && num_nonmacro_input_events
> last_auto_save
2957 && INTEGERP (Vauto_save_timeout
)
2958 && XINT (Vauto_save_timeout
) > 0)
2961 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2963 save_getcjmp (save_jump
);
2964 restore_getcjmp (local_getcjmp
);
2965 tem0
= sit_for (make_number (timeout
), 1, 1);
2966 restore_getcjmp (save_jump
);
2969 && ! CONSP (Vunread_command_events
))
2971 Fdo_auto_save (Qnil
, Qnil
);
2973 /* If we have auto-saved and there is still no input
2974 available, garbage collect if there has been enough
2975 consing going on to make it worthwhile. */
2976 if (!detect_input_pending_run_timers (0)
2977 && consing_since_gc
> gc_cons_threshold
/ 2)
2978 Fgarbage_collect ();
2985 /* Notify the caller if an autosave hook, or a timer, sentinel or
2986 filter in the sit_for calls above have changed the current
2987 kboard. This could happen if they use the minibuffer or start a
2988 recursive edit, like the fancy splash screen in server.el's
2989 filter. If this longjmp wasn't here, read_key_sequence would
2990 interpret the next key sequence using the wrong translation
2991 tables and function keymaps. */
2992 if (NILP (c
) && current_kboard
!= orig_kboard
)
2995 return make_number (-2); /* wrong_kboard_jmpbuf */
2998 /* If this has become non-nil here, it has been set by a timer
2999 or sentinel or filter. */
3000 if (CONSP (Vunread_command_events
))
3002 c
= XCAR (Vunread_command_events
);
3003 Vunread_command_events
= XCDR (Vunread_command_events
);
3006 /* Read something from current KBOARD's side queue, if possible. */
3010 if (current_kboard
->kbd_queue_has_data
)
3012 if (!CONSP (current_kboard
->kbd_queue
))
3014 c
= XCAR (current_kboard
->kbd_queue
);
3015 current_kboard
->kbd_queue
3016 = XCDR (current_kboard
->kbd_queue
);
3017 if (NILP (current_kboard
->kbd_queue
))
3018 current_kboard
->kbd_queue_has_data
= 0;
3019 input_pending
= readable_events (0);
3020 if (EVENT_HAS_PARAMETERS (c
)
3021 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
3022 internal_last_event_frame
= XCAR (XCDR (c
));
3023 Vlast_event_frame
= internal_last_event_frame
;
3028 /* If current_kboard's side queue is empty check the other kboards.
3029 If one of them has data that we have not yet seen here,
3030 switch to it and process the data waiting for it.
3032 Note: if the events queued up for another kboard
3033 have already been seen here, and therefore are not a complete command,
3034 the kbd_queue_has_data field is 0, so we skip that kboard here.
3035 That's to avoid an infinite loop switching between kboards here. */
3036 if (NILP (c
) && !single_kboard
)
3039 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3040 if (kb
->kbd_queue_has_data
)
3042 current_kboard
= kb
;
3043 /* This is going to exit from read_char
3044 so we had better get rid of this frame's stuff. */
3046 return make_number (-2); /* wrong_kboard_jmpbuf */
3055 /* Finally, we read from the main queue,
3056 and if that gives us something we can't use yet, we put it on the
3057 appropriate side queue and try again. */
3066 EMACS_GET_TIME (now
);
3067 if (EMACS_TIME_GE (now
, *end_time
))
3071 /* Actually read a character, waiting if necessary. */
3072 save_getcjmp (save_jump
);
3073 restore_getcjmp (local_getcjmp
);
3075 timer_start_idle ();
3076 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3077 restore_getcjmp (save_jump
);
3080 if (! NILP (c
) && (kb
!= current_kboard
))
3082 Lisp_Object link
= kb
->kbd_queue
;
3085 while (CONSP (XCDR (link
)))
3087 if (!NILP (XCDR (link
)))
3091 kb
->kbd_queue
= Fcons (c
, Qnil
);
3093 XSETCDR (link
, Fcons (c
, Qnil
));
3094 kb
->kbd_queue_has_data
= 1;
3098 current_kboard
= kb
;
3099 /* This is going to exit from read_char
3100 so we had better get rid of this frame's stuff. */
3102 return make_number (-2);
3107 /* Terminate Emacs in batch mode if at eof. */
3108 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3109 Fkill_emacs (make_number (1));
3113 /* Add in any extra modifiers, where appropriate. */
3114 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3115 || ((extra_keyboard_modifiers
& 0177) < ' '
3116 && (extra_keyboard_modifiers
& 0177) != 0))
3117 XSETINT (c
, make_ctrl_char (XINT (c
)));
3119 /* Transfer any other modifier bits directly from
3120 extra_keyboard_modifiers to c. Ignore the actual character code
3121 in the low 16 bits of extra_keyboard_modifiers. */
3122 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3133 if (commandflag
>= 0
3134 && !input_pending
&& !detect_input_pending_run_timers (0))
3142 /* Buffer switch events are only for internal wakeups
3143 so don't show them to the user.
3144 Also, don't record a key if we already did. */
3145 if (BUFFERP (c
) || key_already_recorded
)
3148 /* Process special events within read_char
3149 and loop around to read another event. */
3152 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3157 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3158 int was_locked
= single_kboard
;
3159 int count
= SPECPDL_INDEX ();
3160 record_single_kboard_state ();
3163 last_input_char
= c
;
3164 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3166 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3167 /* We stopped being idle for this event; undo that. This
3168 prevents automatic window selection (under
3169 mouse_autoselect_window from acting as a real input event, for
3170 example banishing the mouse under mouse-avoidance-mode. */
3171 timer_resume_idle ();
3173 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3174 /* Resume allowing input from any kboard, if that was true before. */
3176 any_kboard_state ();
3177 unbind_to (count
, Qnil
);
3183 /* Handle things that only apply to characters. */
3186 /* If kbd_buffer_get_event gave us an EOF, return that. */
3190 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3191 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3192 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3193 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3194 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3198 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3199 /* nil in keyboard-translate-table means no translation. */
3205 /* If this event is a mouse click in the menu bar,
3206 return just menu-bar for now. Modify the mouse click event
3207 so we won't do this twice, then queue it up. */
3208 if (EVENT_HAS_PARAMETERS (c
)
3210 && CONSP (EVENT_START (c
))
3211 && CONSP (XCDR (EVENT_START (c
))))
3215 posn
= POSN_POSN (EVENT_START (c
));
3216 /* Handle menu-bar events:
3217 insert the dummy prefix event `menu-bar'. */
3218 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3220 /* Change menu-bar to (menu-bar) as the event "position". */
3221 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3224 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3229 /* Store these characters into recent_keys, the dribble file if any,
3230 and the keyboard macro being defined, if any. */
3232 if (! NILP (also_record
))
3233 record_char (also_record
);
3235 /* Wipe the echo area.
3236 But first, if we are about to use an input method,
3237 save the echo area contents for it to refer to. */
3239 && ! NILP (Vinput_method_function
)
3240 && (unsigned) XINT (c
) >= ' '
3241 && (unsigned) XINT (c
) != 127
3242 && (unsigned) XINT (c
) < 256)
3244 previous_echo_area_message
= Fcurrent_message ();
3245 Vinput_method_previous_message
= previous_echo_area_message
;
3248 /* Now wipe the echo area, except for help events which do their
3249 own stuff with the echo area. */
3251 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3252 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3254 if (!NILP (echo_area_buffer
[0]))
3255 safe_run_hooks (Qecho_area_clear_hook
);
3256 clear_message (1, 0);
3259 reread_for_input_method
:
3261 /* Pass this to the input method, if appropriate. */
3263 && ! NILP (Vinput_method_function
)
3264 /* Don't run the input method within a key sequence,
3265 after the first event of the key sequence. */
3266 && NILP (prev_event
)
3267 && (unsigned) XINT (c
) >= ' '
3268 && (unsigned) XINT (c
) != 127
3269 && (unsigned) XINT (c
) < 256)
3272 int key_count
, key_count_reset
;
3273 struct gcpro gcpro1
;
3274 int count
= SPECPDL_INDEX ();
3276 /* Save the echo status. */
3277 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3278 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3279 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3280 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3283 if (before_command_restore_flag
)
3285 this_command_key_count
= before_command_key_count_1
;
3286 if (this_command_key_count
< this_single_command_key_start
)
3287 this_single_command_key_start
= this_command_key_count
;
3288 echo_truncate (before_command_echo_length_1
);
3289 before_command_restore_flag
= 0;
3293 /* Save the this_command_keys status. */
3294 key_count
= this_command_key_count
;
3295 key_count_reset
= this_command_key_count_reset
;
3298 keys
= Fcopy_sequence (this_command_keys
);
3303 /* Clear out this_command_keys. */
3304 this_command_key_count
= 0;
3305 this_command_key_count_reset
= 0;
3307 /* Now wipe the echo area. */
3308 if (!NILP (echo_area_buffer
[0]))
3309 safe_run_hooks (Qecho_area_clear_hook
);
3310 clear_message (1, 0);
3313 /* If we are not reading a key sequence,
3314 never use the echo area. */
3317 specbind (Qinput_method_use_echo_area
, Qt
);
3320 /* Call the input method. */
3321 tem
= call1 (Vinput_method_function
, c
);
3323 tem
= unbind_to (count
, tem
);
3325 /* Restore the saved echoing state
3326 and this_command_keys state. */
3327 this_command_key_count
= key_count
;
3328 this_command_key_count_reset
= key_count_reset
;
3330 this_command_keys
= keys
;
3333 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3334 current_kboard
->echo_string
= saved_echo_string
;
3335 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3336 if (saved_immediate_echo
)
3341 /* The input method can return no events. */
3344 /* Bring back the previous message, if any. */
3345 if (! NILP (previous_echo_area_message
))
3346 message_with_string ("%s", previous_echo_area_message
, 0);
3349 /* It returned one event or more. */
3351 Vunread_post_input_method_events
3352 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3357 /* Display help if not echoing. */
3358 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3360 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3361 Lisp_Object help
, object
, position
, window
, tem
;
3363 tem
= Fcdr (XCDR (c
));
3366 window
= Fcar (tem
);
3368 object
= Fcar (tem
);
3370 position
= Fcar (tem
);
3372 show_help_echo (help
, window
, object
, position
, 0);
3374 /* We stopped being idle for this event; undo that. */
3376 timer_resume_idle ();
3380 if ((! reread
|| this_command_key_count
== 0
3381 || this_command_key_count_reset
)
3385 /* Don't echo mouse motion events. */
3386 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3387 && NILP (Fzerop (Vecho_keystrokes
))
3388 && ! (EVENT_HAS_PARAMETERS (c
)
3389 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3392 if (! NILP (also_record
))
3393 echo_char (also_record
);
3394 /* Once we reread a character, echoing can happen
3395 the next time we pause to read a new one. */
3396 ok_to_echo_at_next_pause
= current_kboard
;
3399 /* Record this character as part of the current key. */
3400 add_command_key (c
);
3401 if (! NILP (also_record
))
3402 add_command_key (also_record
);
3405 last_input_char
= c
;
3408 /* Process the help character specially if enabled */
3409 if (!NILP (Vhelp_form
) && help_char_p (c
))
3412 count
= SPECPDL_INDEX ();
3414 help_form_saved_window_configs
3415 = Fcons (Fcurrent_window_configuration (Qnil
),
3416 help_form_saved_window_configs
);
3417 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3419 tem0
= Feval (Vhelp_form
);
3421 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3426 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3427 if (EVENT_HAS_PARAMETERS (c
)
3428 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3429 XSETCAR (help_form_saved_window_configs
, Qnil
);
3431 while (BUFFERP (c
));
3432 /* Remove the help from the frame */
3433 unbind_to (count
, Qnil
);
3436 if (EQ (c
, make_number (040)))
3440 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3441 while (BUFFERP (c
));
3450 /* Record a key that came from a mouse menu.
3451 Record it for echoing, for this-command-keys, and so on. */
3457 /* Wipe the echo area. */
3458 clear_message (1, 0);
3463 before_command_key_count
= this_command_key_count
;
3464 before_command_echo_length
= echo_length ();
3467 /* Don't echo mouse motion events. */
3468 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3469 && NILP (Fzerop (Vecho_keystrokes
)))
3473 /* Once we reread a character, echoing can happen
3474 the next time we pause to read a new one. */
3475 ok_to_echo_at_next_pause
= 0;
3478 /* Record this character as part of the current key. */
3479 add_command_key (c
);
3481 /* Re-reading in the middle of a command */
3482 last_input_char
= c
;
3486 /* Return 1 if should recognize C as "the help character". */
3494 if (EQ (c
, Vhelp_char
))
3496 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3497 if (EQ (c
, XCAR (tail
)))
3502 /* Record the input event C in various ways. */
3510 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3512 /* To avoid filling recent_keys with help-echo and mouse-movement
3513 events, we filter out repeated help-echo events, only store the
3514 first and last in a series of mouse-movement events, and don't
3515 store repeated help-echo events which are only separated by
3516 mouse-movement events. */
3518 Lisp_Object ev1
, ev2
, ev3
;
3521 if ((ix1
= recent_keys_index
- 1) < 0)
3522 ix1
= NUM_RECENT_KEYS
- 1;
3523 ev1
= AREF (recent_keys
, ix1
);
3525 if ((ix2
= ix1
- 1) < 0)
3526 ix2
= NUM_RECENT_KEYS
- 1;
3527 ev2
= AREF (recent_keys
, ix2
);
3529 if ((ix3
= ix2
- 1) < 0)
3530 ix3
= NUM_RECENT_KEYS
- 1;
3531 ev3
= AREF (recent_keys
, ix3
);
3533 if (EQ (XCAR (c
), Qhelp_echo
))
3535 /* Don't record `help-echo' in recent_keys unless it shows some help
3536 message, and a different help than the previously recorded
3538 Lisp_Object help
, last_help
;
3540 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3541 if (!STRINGP (help
))
3543 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3544 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3546 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3547 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3548 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3550 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3551 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3552 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3553 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3556 else if (EQ (XCAR (c
), Qmouse_movement
))
3558 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3559 So additional mouse movement events replace the last element. */
3560 Lisp_Object last_window
, window
;
3562 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3563 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3564 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3565 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3566 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3568 ASET (recent_keys
, ix1
, c
);
3574 store_kbd_macro_char (c
);
3579 ASET (recent_keys
, recent_keys_index
, c
);
3580 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3581 recent_keys_index
= 0;
3583 else if (recorded
< 0)
3585 /* We need to remove one or two events from recent_keys.
3586 To do this, we simply put nil at those events and move the
3587 recent_keys_index backwards over those events. Usually,
3588 users will never see those nil events, as they will be
3589 overwritten by the command keys entered to see recent_keys
3592 while (recorded
++ < 0 && total_keys
> 0)
3594 if (total_keys
< NUM_RECENT_KEYS
)
3596 if (--recent_keys_index
< 0)
3597 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3598 ASET (recent_keys
, recent_keys_index
, Qnil
);
3602 num_nonmacro_input_events
++;
3604 /* Write c to the dribble file. If c is a lispy event, write
3605 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3606 If you, dear reader, have a better idea, you've got the source. :-) */
3612 if (XUINT (c
) < 0x100)
3613 putc (XINT (c
), dribble
);
3615 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3619 Lisp_Object dribblee
;
3621 /* If it's a structured event, take the event header. */
3622 dribblee
= EVENT_HEAD (c
);
3624 if (SYMBOLP (dribblee
))
3626 putc ('<', dribble
);
3627 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3628 SBYTES (SYMBOL_NAME (dribblee
)),
3630 putc ('>', dribble
);
3643 struct buffer
*old
= current_buffer
;
3644 Fprinc (object
, Qnil
);
3645 set_buffer_internal (XBUFFER (Vstandard_output
));
3646 call0 (intern ("help-mode"));
3647 set_buffer_internal (old
);
3651 /* Copy out or in the info on where C-g should throw to.
3652 This is used when running Lisp code from within get_char,
3653 in case get_char is called recursively.
3654 See read_process_output. */
3660 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3664 restore_getcjmp (temp
)
3667 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3670 /* Low level keyboard/mouse input.
3671 kbd_buffer_store_event places events in kbd_buffer, and
3672 kbd_buffer_get_event retrieves them. */
3674 /* Return true if there are any events in the queue that read-char
3675 would return. If this returns false, a read-char would block. */
3677 readable_events (flags
)
3680 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3683 /* If the buffer contains only FOCUS_IN_EVENT events, and
3684 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3685 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3687 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3688 #ifdef USE_TOOLKIT_SCROLL_BARS
3689 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3693 struct input_event
*event
;
3695 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3702 #ifdef USE_TOOLKIT_SCROLL_BARS
3703 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3705 event
->kind
== FOCUS_IN_EVENT
)
3706 #ifdef USE_TOOLKIT_SCROLL_BARS
3707 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3708 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3709 && event
->part
== scroll_bar_handle
3710 && event
->modifiers
== 0)
3715 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3718 while (event
!= kbd_store_ptr
);
3724 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3725 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3726 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3731 if (current_kboard
->kbd_queue_has_data
)
3737 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3738 if (kb
->kbd_queue_has_data
)
3744 /* Set this for debugging, to have a way to get out */
3749 event_to_kboard (event
)
3750 struct input_event
*event
;
3753 frame
= event
->frame_or_window
;
3755 frame
= XCAR (frame
);
3756 else if (WINDOWP (frame
))
3757 frame
= WINDOW_FRAME (XWINDOW (frame
));
3759 /* There are still some events that don't set this field.
3760 For now, just ignore the problem.
3761 Also ignore dead frames here. */
3762 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3765 return FRAME_KBOARD (XFRAME (frame
));
3770 Lisp_Object Vthrow_on_input
;
3772 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3775 kbd_buffer_store_event (event
)
3776 register struct input_event
*event
;
3778 kbd_buffer_store_event_hold (event
, 0);
3781 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3783 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3784 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3785 Else, if EVENT is a quit event, store the quit event
3786 in HOLD_QUIT, and return (thus ignoring further events).
3788 This is used in read_avail_input to postpone the processing
3789 of the quit event until all subsequent input events have been
3790 parsed (and discarded).
3794 kbd_buffer_store_event_hold (event
, hold_quit
)
3795 register struct input_event
*event
;
3796 struct input_event
*hold_quit
;
3798 if (event
->kind
== NO_EVENT
)
3801 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3804 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3806 register int c
= event
->code
& 0377;
3808 if (event
->modifiers
& ctrl_modifier
)
3809 c
= make_ctrl_char (c
);
3811 c
|= (event
->modifiers
3812 & (meta_modifier
| alt_modifier
3813 | hyper_modifier
| super_modifier
));
3818 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3819 struct input_event
*sp
;
3821 if (single_kboard
&& kb
!= current_kboard
)
3824 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3825 Fcons (make_number (c
), Qnil
));
3826 kb
->kbd_queue_has_data
= 1;
3827 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3829 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3832 if (event_to_kboard (sp
) == kb
)
3834 sp
->kind
= NO_EVENT
;
3835 sp
->frame_or_window
= Qnil
;
3845 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3849 /* If this results in a quit_char being returned to Emacs as
3850 input, set Vlast_event_frame properly. If this doesn't
3851 get returned to Emacs as an event, the next event read
3852 will set Vlast_event_frame again, so this is safe to do. */
3856 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3858 focus
= event
->frame_or_window
;
3859 internal_last_event_frame
= focus
;
3860 Vlast_event_frame
= focus
;
3863 last_event_timestamp
= event
->timestamp
;
3864 handle_interrupt ();
3868 if (c
&& c
== stop_character
)
3874 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3875 Just ignore the second one. */
3876 else if (event
->kind
== BUFFER_SWITCH_EVENT
3877 && kbd_fetch_ptr
!= kbd_store_ptr
3878 && ((kbd_store_ptr
== kbd_buffer
3879 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3880 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3883 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3884 kbd_store_ptr
= kbd_buffer
;
3886 /* Don't let the very last slot in the buffer become full,
3887 since that would make the two pointers equal,
3888 and that is indistinguishable from an empty buffer.
3889 Discard the event if it would fill the last slot. */
3890 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3892 *kbd_store_ptr
= *event
;
3896 /* If we're inside while-no-input, and this event qualifies
3897 as input, set quit-flag to cause an interrupt. */
3898 if (!NILP (Vthrow_on_input
)
3899 && event
->kind
!= FOCUS_IN_EVENT
3900 && event
->kind
!= HELP_EVENT
3901 && event
->kind
!= DEICONIFY_EVENT
)
3903 Vquit_flag
= Vthrow_on_input
;
3904 /* If we're inside a function that wants immediate quits,
3906 if (immediate_quit
&& NILP (Vinhibit_quit
))
3916 /* Put an input event back in the head of the event queue. */
3919 kbd_buffer_unget_event (event
)
3920 register struct input_event
*event
;
3922 if (kbd_fetch_ptr
== kbd_buffer
)
3923 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3925 /* Don't let the very last slot in the buffer become full, */
3926 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3929 *kbd_fetch_ptr
= *event
;
3934 /* Generate HELP_EVENT input_events in BUFP which has room for
3935 SIZE events. If there's not enough room in BUFP, ignore this
3938 HELP is the help form.
3940 FRAME is the frame on which the help is generated. OBJECT is the
3941 Lisp object where the help was found (a buffer, a string, an
3942 overlay, or nil if neither from a string nor from a buffer. POS is
3943 the position within OBJECT where the help was found.
3945 Value is the number of input_events generated. */
3948 gen_help_event (help
, frame
, window
, object
, pos
)
3949 Lisp_Object help
, frame
, object
, window
;
3952 struct input_event event
;
3956 event
.kind
= HELP_EVENT
;
3957 event
.frame_or_window
= frame
;
3959 event
.x
= WINDOWP (window
) ? window
: frame
;
3962 kbd_buffer_store_event (&event
);
3966 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3969 kbd_buffer_store_help_event (frame
, help
)
3970 Lisp_Object frame
, help
;
3972 struct input_event event
;
3974 event
.kind
= HELP_EVENT
;
3975 event
.frame_or_window
= frame
;
3980 kbd_buffer_store_event (&event
);
3984 /* Discard any mouse events in the event buffer by setting them to
3987 discard_mouse_events ()
3989 struct input_event
*sp
;
3990 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3992 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3995 if (sp
->kind
== MOUSE_CLICK_EVENT
3996 || sp
->kind
== WHEEL_EVENT
3997 || sp
->kind
== HORIZ_WHEEL_EVENT
3999 || sp
->kind
== GPM_CLICK_EVENT
4001 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
4003 sp
->kind
= NO_EVENT
;
4009 /* Return non-zero if there are any real events waiting in the event
4010 buffer, not counting `NO_EVENT's.
4012 If DISCARD is non-zero, discard NO_EVENT events at the front of
4013 the input queue, possibly leaving the input queue empty if there
4014 are no real input events. */
4017 kbd_buffer_events_waiting (discard
)
4020 struct input_event
*sp
;
4022 for (sp
= kbd_fetch_ptr
;
4023 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
4026 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4033 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
4037 /* Clear input event EVENT. */
4041 struct input_event
*event
;
4043 event
->kind
= NO_EVENT
;
4047 /* Read one event from the event buffer, waiting if necessary.
4048 The value is a Lisp object representing the event.
4049 The value is nil for an event that should be ignored,
4050 or that was handled here.
4051 We always read and discard one event. */
4054 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4056 int *used_mouse_menu
;
4057 EMACS_TIME
*end_time
;
4066 *kbp
= current_kboard
;
4070 /* Wait until there is input available. */
4073 /* Break loop if there's an unread command event. Needed in
4074 moused window autoselection which uses a timer to insert such
4076 if (CONSP (Vunread_command_events
))
4079 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4081 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4082 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4086 /* If the quit flag is set, then read_char will return
4087 quit_char, so that counts as "available input." */
4088 if (!NILP (Vquit_flag
))
4089 quit_throw_to_read_char ();
4091 /* One way or another, wait until input is available; then, if
4092 interrupt handlers have not read it, read it now. */
4095 wait_for_kbd_input ();
4097 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4101 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4103 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4104 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4109 EMACS_TIME duration
;
4110 EMACS_GET_TIME (duration
);
4111 if (EMACS_TIME_GE (duration
, *end_time
))
4112 return Qnil
; /* finished waiting */
4115 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4116 wait_reading_process_output (EMACS_SECS (duration
),
4117 EMACS_USECS (duration
),
4118 -1, 1, Qnil
, NULL
, 0);
4122 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4124 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4125 /* Pass 1 for EXPECT since we just waited to have input. */
4126 read_avail_input (1);
4127 #endif /* not VMS */
4130 if (CONSP (Vunread_command_events
))
4133 first
= XCAR (Vunread_command_events
);
4134 Vunread_command_events
= XCDR (Vunread_command_events
);
4135 *kbp
= current_kboard
;
4139 /* At this point, we know that there is a readable event available
4140 somewhere. If the event queue is empty, then there must be a
4141 mouse movement enabled and available. */
4142 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4144 struct input_event
*event
;
4146 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4150 last_event_timestamp
= event
->timestamp
;
4153 *kbp
= event_to_kboard (event
);
4155 *kbp
= current_kboard
; /* Better than returning null ptr? */
4157 *kbp
= &the_only_kboard
;
4162 /* These two kinds of events get special handling
4163 and don't actually appear to the command loop.
4164 We return nil for them. */
4165 if (event
->kind
== SELECTION_REQUEST_EVENT
4166 || event
->kind
== SELECTION_CLEAR_EVENT
)
4169 struct input_event copy
;
4171 /* Remove it from the buffer before processing it,
4172 since otherwise swallow_events will see it
4173 and process it again. */
4175 kbd_fetch_ptr
= event
+ 1;
4176 input_pending
= readable_events (0);
4177 x_handle_selection_event (©
);
4179 /* We're getting selection request events, but we don't have
4185 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4186 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4188 /* Make an event (delete-frame (FRAME)). */
4189 obj
= Fcons (event
->frame_or_window
, Qnil
);
4190 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4191 kbd_fetch_ptr
= event
+ 1;
4194 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4195 else if (event
->kind
== ICONIFY_EVENT
)
4197 /* Make an event (iconify-frame (FRAME)). */
4198 obj
= Fcons (event
->frame_or_window
, Qnil
);
4199 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4200 kbd_fetch_ptr
= event
+ 1;
4202 else if (event
->kind
== DEICONIFY_EVENT
)
4204 /* Make an event (make-frame-visible (FRAME)). */
4205 obj
= Fcons (event
->frame_or_window
, Qnil
);
4206 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4207 kbd_fetch_ptr
= event
+ 1;
4210 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4212 /* The value doesn't matter here; only the type is tested. */
4213 XSETBUFFER (obj
, current_buffer
);
4214 kbd_fetch_ptr
= event
+ 1;
4216 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4217 || defined (USE_GTK)
4218 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4220 kbd_fetch_ptr
= event
+ 1;
4221 input_pending
= readable_events (0);
4222 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4223 x_activate_menubar (XFRAME (event
->frame_or_window
));
4226 #if defined (WINDOWSNT) || defined (MAC_OS)
4227 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4230 /* Make an event (language-change (KEY_SCRIPT)). */
4231 obj
= Fcons (make_number (event
->code
), Qnil
);
4233 /* Make an event (language-change (FRAME CHARSET LCID)). */
4234 obj
= Fcons (event
->frame_or_window
, Qnil
);
4236 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4237 kbd_fetch_ptr
= event
+ 1;
4240 else if (event
->kind
== SAVE_SESSION_EVENT
)
4242 obj
= Fcons (Qsave_session
, Qnil
);
4243 kbd_fetch_ptr
= event
+ 1;
4245 /* Just discard these, by returning nil.
4246 With MULTI_KBOARD, these events are used as placeholders
4247 when we need to randomly delete events from the queue.
4248 (They shouldn't otherwise be found in the buffer,
4249 but on some machines it appears they do show up
4250 even without MULTI_KBOARD.) */
4251 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4252 mouse events during a popup-menu call. */
4253 else if (event
->kind
== NO_EVENT
)
4254 kbd_fetch_ptr
= event
+ 1;
4255 else if (event
->kind
== HELP_EVENT
)
4257 Lisp_Object object
, position
, help
, frame
, window
;
4259 frame
= event
->frame_or_window
;
4260 object
= event
->arg
;
4261 position
= make_number (event
->code
);
4264 clear_event (event
);
4266 kbd_fetch_ptr
= event
+ 1;
4267 if (!WINDOWP (window
))
4269 obj
= Fcons (Qhelp_echo
,
4270 list5 (frame
, help
, window
, object
, position
));
4272 else if (event
->kind
== FOCUS_IN_EVENT
)
4274 /* Notification of a FocusIn event. The frame receiving the
4275 focus is in event->frame_or_window. Generate a
4276 switch-frame event if necessary. */
4277 Lisp_Object frame
, focus
;
4279 frame
= event
->frame_or_window
;
4280 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4284 if (!EQ (frame
, internal_last_event_frame
)
4285 && !EQ (frame
, selected_frame
))
4286 obj
= make_lispy_switch_frame (frame
);
4287 internal_last_event_frame
= frame
;
4288 kbd_fetch_ptr
= event
+ 1;
4291 else if (event
->kind
== DBUS_EVENT
)
4293 obj
= make_lispy_event (event
);
4294 kbd_fetch_ptr
= event
+ 1;
4299 /* If this event is on a different frame, return a switch-frame this
4300 time, and leave the event in the queue for next time. */
4304 frame
= event
->frame_or_window
;
4306 frame
= XCAR (frame
);
4307 else if (WINDOWP (frame
))
4308 frame
= WINDOW_FRAME (XWINDOW (frame
));
4310 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4314 if (! EQ (frame
, internal_last_event_frame
)
4315 && !EQ (frame
, selected_frame
))
4316 obj
= make_lispy_switch_frame (frame
);
4317 internal_last_event_frame
= frame
;
4319 /* If we didn't decide to make a switch-frame event, go ahead
4320 and build a real event from the queue entry. */
4324 obj
= make_lispy_event (event
);
4326 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4327 || defined (USE_GTK)
4328 /* If this was a menu selection, then set the flag to inhibit
4329 writing to last_nonmenu_event. Don't do this if the event
4330 we're returning is (menu-bar), though; that indicates the
4331 beginning of the menu sequence, and we might as well leave
4332 that as the `event with parameters' for this selection. */
4334 && !EQ (event
->frame_or_window
, event
->arg
)
4335 && (event
->kind
== MENU_BAR_EVENT
4336 || event
->kind
== TOOL_BAR_EVENT
))
4337 *used_mouse_menu
= 1;
4340 /* Wipe out this event, to catch bugs. */
4341 clear_event (event
);
4342 kbd_fetch_ptr
= event
+ 1;
4346 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4347 /* Try generating a mouse motion event. */
4348 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4350 FRAME_PTR f
= some_mouse_moved ();
4351 Lisp_Object bar_window
;
4352 enum scroll_bar_part part
;
4356 *kbp
= current_kboard
;
4357 /* Note that this uses F to determine which terminal to look at.
4358 If there is no valid info, it does not store anything
4359 so x remains nil. */
4362 /* XXX Can f or mouse_position_hook be NULL here? */
4363 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4364 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4365 &part
, &x
, &y
, &time
);
4369 /* Decide if we should generate a switch-frame event. Don't
4370 generate switch-frame events for motion outside of all Emacs
4376 frame
= FRAME_FOCUS_FRAME (f
);
4378 XSETFRAME (frame
, f
);
4380 if (! EQ (frame
, internal_last_event_frame
)
4381 && !EQ (frame
, selected_frame
))
4382 obj
= make_lispy_switch_frame (frame
);
4383 internal_last_event_frame
= frame
;
4386 /* If we didn't decide to make a switch-frame event, go ahead and
4387 return a mouse-motion event. */
4388 if (!NILP (x
) && NILP (obj
))
4389 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4391 #endif /* HAVE_MOUSE || HAVE GPM */
4393 /* We were promised by the above while loop that there was
4394 something for us to read! */
4397 input_pending
= readable_events (0);
4399 Vlast_event_frame
= internal_last_event_frame
;
4404 /* Process any events that are not user-visible,
4405 then return, without reading any user-visible events. */
4408 swallow_events (do_display
)
4413 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4415 struct input_event
*event
;
4417 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4421 last_event_timestamp
= event
->timestamp
;
4423 /* These two kinds of events get special handling
4424 and don't actually appear to the command loop. */
4425 if (event
->kind
== SELECTION_REQUEST_EVENT
4426 || event
->kind
== SELECTION_CLEAR_EVENT
)
4429 struct input_event copy
;
4431 /* Remove it from the buffer before processing it,
4432 since otherwise swallow_events called recursively could see it
4433 and process it again. */
4435 kbd_fetch_ptr
= event
+ 1;
4436 input_pending
= readable_events (0);
4437 x_handle_selection_event (©
);
4439 /* We're getting selection request events, but we don't have
4448 old_timers_run
= timers_run
;
4449 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4451 if (timers_run
!= old_timers_run
&& do_display
)
4452 redisplay_preserve_echo_area (7);
4455 /* Record the start of when Emacs is idle,
4456 for the sake of running idle-time timers. */
4463 /* If we are already in the idle state, do nothing. */
4464 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4467 EMACS_GET_TIME (timer_idleness_start_time
);
4469 timer_last_idleness_start_time
= timer_idleness_start_time
;
4471 /* Mark all idle-time timers as once again candidates for running. */
4472 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4476 timer
= XCAR (timers
);
4478 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4480 XVECTOR (timer
)->contents
[0] = Qnil
;
4484 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4489 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4492 /* Resume idle timer from last idle start time. */
4495 timer_resume_idle ()
4497 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4500 timer_idleness_start_time
= timer_last_idleness_start_time
;
4503 /* This is only for debugging. */
4504 struct input_event last_timer_event
;
4506 /* List of elisp functions to call, delayed because they were generated in
4507 a context where Elisp could not be safely run (e.g. redisplay, signal,
4508 ...). Each lement has the form (FUN . ARGS). */
4509 Lisp_Object pending_funcalls
;
4511 extern Lisp_Object Qapply
;
4513 /* Check whether a timer has fired. To prevent larger problems we simply
4514 disregard elements that are not proper timers. Do not make a circular
4515 timer list for the time being.
4517 Returns the number of seconds to wait until the next timer fires. If a
4518 timer is triggering now, return zero seconds.
4519 If no timer is active, return -1 seconds.
4521 If a timer is ripe, we run it, with quitting turned off.
4523 DO_IT_NOW is now ignored. It used to mean that we should
4524 run the timer directly instead of queueing a timer-event.
4525 Now we always run timers directly. */
4528 timer_check (do_it_now
)
4531 EMACS_TIME nexttime
;
4532 EMACS_TIME now
, idleness_now
;
4533 Lisp_Object timers
, idle_timers
, chosen_timer
;
4534 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4536 EMACS_SET_SECS (nexttime
, -1);
4537 EMACS_SET_USECS (nexttime
, -1);
4539 /* Always consider the ordinary timers. */
4540 timers
= Vtimer_list
;
4541 /* Consider the idle timers only if Emacs is idle. */
4542 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4543 idle_timers
= Vtimer_idle_list
;
4546 chosen_timer
= Qnil
;
4547 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4549 /* First run the code that was delayed. */
4550 while (CONSP (pending_funcalls
))
4552 Lisp_Object funcall
= XCAR (pending_funcalls
);
4553 pending_funcalls
= XCDR (pending_funcalls
);
4554 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4557 if (CONSP (timers
) || CONSP (idle_timers
))
4559 EMACS_GET_TIME (now
);
4560 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4561 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4564 while (CONSP (timers
) || CONSP (idle_timers
))
4566 Lisp_Object
*vector
;
4567 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4568 EMACS_TIME timer_time
, idle_timer_time
;
4569 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4571 /* Skip past invalid timers and timers already handled. */
4574 timer
= XCAR (timers
);
4575 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4577 timers
= XCDR (timers
);
4580 vector
= XVECTOR (timer
)->contents
;
4582 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4583 || !INTEGERP (vector
[3])
4584 || ! NILP (vector
[0]))
4586 timers
= XCDR (timers
);
4590 if (!NILP (idle_timers
))
4592 timer
= XCAR (idle_timers
);
4593 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4595 idle_timers
= XCDR (idle_timers
);
4598 vector
= XVECTOR (timer
)->contents
;
4600 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4601 || !INTEGERP (vector
[3])
4602 || ! NILP (vector
[0]))
4604 idle_timers
= XCDR (idle_timers
);
4609 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4610 based on the next ordinary timer.
4611 TIMER_DIFFERENCE is the distance in time from NOW to when
4612 this timer becomes ripe (negative if it's already ripe). */
4615 timer
= XCAR (timers
);
4616 vector
= XVECTOR (timer
)->contents
;
4617 EMACS_SET_SECS (timer_time
,
4618 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4619 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4620 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4623 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4624 based on the next idle timer. */
4625 if (!NILP (idle_timers
))
4627 idle_timer
= XCAR (idle_timers
);
4628 vector
= XVECTOR (idle_timer
)->contents
;
4629 EMACS_SET_SECS (idle_timer_time
,
4630 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4631 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4632 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4635 /* Decide which timer is the next timer,
4636 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4637 Also step down the list where we found that timer. */
4639 if (! NILP (timers
) && ! NILP (idle_timers
))
4642 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4643 if (EMACS_TIME_NEG_P (temp
))
4645 chosen_timer
= timer
;
4646 timers
= XCDR (timers
);
4647 difference
= timer_difference
;
4651 chosen_timer
= idle_timer
;
4652 idle_timers
= XCDR (idle_timers
);
4653 difference
= idle_timer_difference
;
4656 else if (! NILP (timers
))
4658 chosen_timer
= timer
;
4659 timers
= XCDR (timers
);
4660 difference
= timer_difference
;
4664 chosen_timer
= idle_timer
;
4665 idle_timers
= XCDR (idle_timers
);
4666 difference
= idle_timer_difference
;
4668 vector
= XVECTOR (chosen_timer
)->contents
;
4670 /* If timer is ripe, run it if it hasn't been run. */
4671 if (EMACS_TIME_NEG_P (difference
)
4672 || (EMACS_SECS (difference
) == 0
4673 && EMACS_USECS (difference
) == 0))
4675 if (NILP (vector
[0]))
4677 int count
= SPECPDL_INDEX ();
4678 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4680 #if 0 /* This shouldn't be necessary anymore. --lorentey */
4681 /* On unbind_to, resume allowing input from any kboard, if that
4683 record_single_kboard_state ();
4685 /* Mark the timer as triggered to prevent problems if the lisp
4686 code fails to reschedule it right. */
4689 specbind (Qinhibit_quit
, Qt
);
4691 call1 (Qtimer_event_handler
, chosen_timer
);
4692 Vdeactivate_mark
= old_deactivate_mark
;
4694 unbind_to (count
, Qnil
);
4696 /* Since we have handled the event,
4697 we don't need to tell the caller to wake up and do it. */
4701 /* When we encounter a timer that is still waiting,
4702 return the amount of time to wait before it is ripe. */
4709 /* No timers are pending in the future. */
4710 /* Return 0 if we generated an event, and -1 if not. */
4715 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4716 doc
: /* Return the current length of Emacs idleness, or nil.
4717 The value when Emacs is idle is a list of three integers. The first has the
4718 most significant 16 bits of the seconds, while the second has the
4719 least significant 16 bits. The third integer gives the microsecond
4722 The value when Emacs is not idle is nil.
4724 The microsecond count is zero on systems that do not provide
4725 resolution finer than a second. */)
4728 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4730 EMACS_TIME now
, idleness_now
;
4732 EMACS_GET_TIME (now
);
4733 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4735 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4736 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4737 make_number (EMACS_USECS (idleness_now
)));
4743 /* Caches for modify_event_symbol. */
4744 static Lisp_Object accent_key_syms
;
4745 static Lisp_Object func_key_syms
;
4746 static Lisp_Object mouse_syms
;
4747 static Lisp_Object wheel_syms
;
4748 static Lisp_Object drag_n_drop_syms
;
4750 /* This is a list of keysym codes for special "accent" characters.
4751 It parallels lispy_accent_keys. */
4753 static int lispy_accent_codes
[] =
4755 #ifdef XK_dead_circumflex
4760 #ifdef XK_dead_grave
4765 #ifdef XK_dead_tilde
4770 #ifdef XK_dead_diaeresis
4775 #ifdef XK_dead_macron
4780 #ifdef XK_dead_degree
4785 #ifdef XK_dead_acute
4790 #ifdef XK_dead_cedilla
4795 #ifdef XK_dead_breve
4800 #ifdef XK_dead_ogonek
4805 #ifdef XK_dead_caron
4810 #ifdef XK_dead_doubleacute
4811 XK_dead_doubleacute
,
4815 #ifdef XK_dead_abovedot
4820 #ifdef XK_dead_abovering
4830 #ifdef XK_dead_belowdot
4835 #ifdef XK_dead_voiced_sound
4836 XK_dead_voiced_sound
,
4840 #ifdef XK_dead_semivoiced_sound
4841 XK_dead_semivoiced_sound
,
4857 /* This is a list of Lisp names for special "accent" characters.
4858 It parallels lispy_accent_codes. */
4860 static char *lispy_accent_keys
[] =
4878 "dead-voiced-sound",
4879 "dead-semivoiced-sound",
4885 #define FUNCTION_KEY_OFFSET 0x0
4887 char *lispy_function_keys
[] =
4891 0, /* VK_LBUTTON 0x01 */
4892 0, /* VK_RBUTTON 0x02 */
4893 "cancel", /* VK_CANCEL 0x03 */
4894 0, /* VK_MBUTTON 0x04 */
4896 0, 0, 0, /* 0x05 .. 0x07 */
4898 "backspace", /* VK_BACK 0x08 */
4899 "tab", /* VK_TAB 0x09 */
4901 0, 0, /* 0x0A .. 0x0B */
4903 "clear", /* VK_CLEAR 0x0C */
4904 "return", /* VK_RETURN 0x0D */
4906 0, 0, /* 0x0E .. 0x0F */
4908 0, /* VK_SHIFT 0x10 */
4909 0, /* VK_CONTROL 0x11 */
4910 0, /* VK_MENU 0x12 */
4911 "pause", /* VK_PAUSE 0x13 */
4912 "capslock", /* VK_CAPITAL 0x14 */
4913 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4915 "junja", /* VK_JUNJA 0x17 */
4916 "final", /* VK_FINAL 0x18 */
4917 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4919 "escape", /* VK_ESCAPE 0x1B */
4920 "convert", /* VK_CONVERT 0x1C */
4921 "non-convert", /* VK_NONCONVERT 0x1D */
4922 "accept", /* VK_ACCEPT 0x1E */
4923 "mode-change", /* VK_MODECHANGE 0x1F */
4924 0, /* VK_SPACE 0x20 */
4925 "prior", /* VK_PRIOR 0x21 */
4926 "next", /* VK_NEXT 0x22 */
4927 "end", /* VK_END 0x23 */
4928 "home", /* VK_HOME 0x24 */
4929 "left", /* VK_LEFT 0x25 */
4930 "up", /* VK_UP 0x26 */
4931 "right", /* VK_RIGHT 0x27 */
4932 "down", /* VK_DOWN 0x28 */
4933 "select", /* VK_SELECT 0x29 */
4934 "print", /* VK_PRINT 0x2A */
4935 "execute", /* VK_EXECUTE 0x2B */
4936 "snapshot", /* VK_SNAPSHOT 0x2C */
4937 "insert", /* VK_INSERT 0x2D */
4938 "delete", /* VK_DELETE 0x2E */
4939 "help", /* VK_HELP 0x2F */
4941 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4943 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4945 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4947 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4949 0, 0, 0, 0, 0, 0, 0, 0, 0,
4950 0, 0, 0, 0, 0, 0, 0, 0, 0,
4951 0, 0, 0, 0, 0, 0, 0, 0,
4953 "lwindow", /* VK_LWIN 0x5B */
4954 "rwindow", /* VK_RWIN 0x5C */
4955 "apps", /* VK_APPS 0x5D */
4958 "kp-0", /* VK_NUMPAD0 0x60 */
4959 "kp-1", /* VK_NUMPAD1 0x61 */
4960 "kp-2", /* VK_NUMPAD2 0x62 */
4961 "kp-3", /* VK_NUMPAD3 0x63 */
4962 "kp-4", /* VK_NUMPAD4 0x64 */
4963 "kp-5", /* VK_NUMPAD5 0x65 */
4964 "kp-6", /* VK_NUMPAD6 0x66 */
4965 "kp-7", /* VK_NUMPAD7 0x67 */
4966 "kp-8", /* VK_NUMPAD8 0x68 */
4967 "kp-9", /* VK_NUMPAD9 0x69 */
4968 "kp-multiply", /* VK_MULTIPLY 0x6A */
4969 "kp-add", /* VK_ADD 0x6B */
4970 "kp-separator", /* VK_SEPARATOR 0x6C */
4971 "kp-subtract", /* VK_SUBTRACT 0x6D */
4972 "kp-decimal", /* VK_DECIMAL 0x6E */
4973 "kp-divide", /* VK_DIVIDE 0x6F */
4974 "f1", /* VK_F1 0x70 */
4975 "f2", /* VK_F2 0x71 */
4976 "f3", /* VK_F3 0x72 */
4977 "f4", /* VK_F4 0x73 */
4978 "f5", /* VK_F5 0x74 */
4979 "f6", /* VK_F6 0x75 */
4980 "f7", /* VK_F7 0x76 */
4981 "f8", /* VK_F8 0x77 */
4982 "f9", /* VK_F9 0x78 */
4983 "f10", /* VK_F10 0x79 */
4984 "f11", /* VK_F11 0x7A */
4985 "f12", /* VK_F12 0x7B */
4986 "f13", /* VK_F13 0x7C */
4987 "f14", /* VK_F14 0x7D */
4988 "f15", /* VK_F15 0x7E */
4989 "f16", /* VK_F16 0x7F */
4990 "f17", /* VK_F17 0x80 */
4991 "f18", /* VK_F18 0x81 */
4992 "f19", /* VK_F19 0x82 */
4993 "f20", /* VK_F20 0x83 */
4994 "f21", /* VK_F21 0x84 */
4995 "f22", /* VK_F22 0x85 */
4996 "f23", /* VK_F23 0x86 */
4997 "f24", /* VK_F24 0x87 */
4999 0, 0, 0, 0, /* 0x88 .. 0x8B */
5000 0, 0, 0, 0, /* 0x8C .. 0x8F */
5002 "kp-numlock", /* VK_NUMLOCK 0x90 */
5003 "scroll", /* VK_SCROLL 0x91 */
5004 /* Not sure where the following block comes from.
5005 Windows headers have NEC and Fujitsu specific keys in
5006 this block, but nothing generic. */
5007 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
5008 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
5009 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
5010 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
5011 "kp-end", /* VK_NUMPAD_END 0x96 */
5012 "kp-home", /* VK_NUMPAD_HOME 0x97 */
5013 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
5014 "kp-up", /* VK_NUMPAD_UP 0x99 */
5015 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
5016 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
5017 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
5018 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
5020 0, 0, /* 0x9E .. 0x9F */
5023 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
5024 * Used only as parameters to GetAsyncKeyState and GetKeyState.
5025 * No other API or message will distinguish left and right keys this way.
5030 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
5031 to enable them selectively, and gives access to a few more functions.
5032 See lispy_multimedia_keys below. */
5033 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
5034 0, 0, 0, /* 0xAD .. 0xAF Volume */
5035 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
5036 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
5038 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
5039 0, 0, 0, 0, 0, 0, 0, 0, 0,
5041 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
5042 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5043 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5046 "ax", /* VK_OEM_AX 0xE1 */
5047 0, /* VK_OEM_102 0xE2 */
5048 "ico-help", /* VK_ICO_HELP 0xE3 */
5049 "ico-00", /* VK_ICO_00 0xE4 */
5050 0, /* VK_PROCESSKEY 0xE5 */
5051 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5052 "packet", /* VK_PACKET 0xE7 */
5054 "reset", /* VK_OEM_RESET 0xE9 */
5055 "jump", /* VK_OEM_JUMP 0xEA */
5056 "oem-pa1", /* VK_OEM_PA1 0xEB */
5057 "oem-pa2", /* VK_OEM_PA2 0xEC */
5058 "oem-pa3", /* VK_OEM_PA3 0xED */
5059 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5060 "cusel", /* VK_OEM_CUSEL 0xEF */
5061 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5062 "finish", /* VK_OEM_FINISH 0xF1 */
5063 "copy", /* VK_OEM_COPY 0xF2 */
5064 "auto", /* VK_OEM_AUTO 0xF3 */
5065 "enlw", /* VK_OEM_ENLW 0xF4 */
5066 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5067 "attn", /* VK_ATTN 0xF6 */
5068 "crsel", /* VK_CRSEL 0xF7 */
5069 "exsel", /* VK_EXSEL 0xF8 */
5070 "ereof", /* VK_EREOF 0xF9 */
5071 "play", /* VK_PLAY 0xFA */
5072 "zoom", /* VK_ZOOM 0xFB */
5073 "noname", /* VK_NONAME 0xFC */
5074 "pa1", /* VK_PA1 0xFD */
5075 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5079 /* Some of these duplicate the "Media keys" on newer keyboards,
5080 but they are delivered to the application in a different way. */
5081 static char *lispy_multimedia_keys
[] =
5089 "browser-favorites",
5126 "toggle-dictate-command",
5132 "media-fast-forward",
5135 "media-channel-down"
5138 #else /* not HAVE_NTGUI */
5140 /* This should be dealt with in XTread_socket now, and that doesn't
5141 depend on the client system having the Kana syms defined. See also
5142 the XK_kana_A case below. */
5145 static char *lispy_kana_keys
[] =
5147 /* X Keysym value */
5148 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5149 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5150 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5151 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5152 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5153 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5154 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5155 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5156 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5157 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5158 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5159 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5160 "kana-i", "kana-u", "kana-e", "kana-o",
5161 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5162 "prolongedsound", "kana-A", "kana-I", "kana-U",
5163 "kana-E", "kana-O", "kana-KA", "kana-KI",
5164 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5165 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5166 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5167 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5168 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5169 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5170 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5171 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5172 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5173 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5174 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5175 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5177 #endif /* XK_kana_A */
5180 #define FUNCTION_KEY_OFFSET 0xff00
5182 /* You'll notice that this table is arranged to be conveniently
5183 indexed by X Windows keysym values. */
5184 static char *lispy_function_keys
[] =
5186 /* X Keysym value */
5188 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5189 "backspace", "tab", "linefeed", "clear",
5191 0, 0, 0, "pause", /* 0xff10...1f */
5192 0, 0, 0, 0, 0, 0, 0, "escape",
5194 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5195 "romaji", "hiragana", "katakana", "hiragana-katakana",
5196 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5197 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5198 "eisu-toggle", /* 0xff30...3f */
5199 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5200 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5202 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5203 "down", "prior", "next", "end",
5204 "begin", 0, 0, 0, 0, 0, 0, 0,
5205 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5216 "break", /* 0xff6b */
5219 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5220 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5221 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5222 0, 0, 0, 0, 0, 0, 0, 0,
5223 "kp-tab", /* 0xff89 */
5225 "kp-enter", /* 0xff8d */
5227 "kp-f1", /* 0xff91 */
5231 "kp-home", /* 0xff95 */
5236 "kp-prior", /* kp-page-up */
5237 "kp-next", /* kp-page-down */
5243 0, 0, 0, 0, 0, 0, 0, 0, 0,
5244 "kp-multiply", /* 0xffaa */
5249 "kp-divide", /* 0xffaf */
5250 "kp-0", /* 0xffb0 */
5251 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5254 "kp-equal", /* 0xffbd */
5255 "f1", /* 0xffbe */ /* IsFunctionKey */
5257 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5258 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5259 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5260 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5261 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5262 0, 0, 0, 0, 0, 0, 0, 0,
5263 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5264 0, 0, 0, 0, 0, 0, 0, "delete"
5267 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5268 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5270 static char *iso_lispy_function_keys
[] =
5272 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5273 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5274 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5275 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5276 "iso-lefttab", /* 0xfe20 */
5277 "iso-move-line-up", "iso-move-line-down",
5278 "iso-partial-line-up", "iso-partial-line-down",
5279 "iso-partial-space-left", "iso-partial-space-right",
5280 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5281 "iso-release-margin-left", "iso-release-margin-right",
5282 "iso-release-both-margins",
5283 "iso-fast-cursor-left", "iso-fast-cursor-right",
5284 "iso-fast-cursor-up", "iso-fast-cursor-down",
5285 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5286 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5289 #endif /* not HAVE_NTGUI */
5291 Lisp_Object Vlispy_mouse_stem
;
5293 static char *lispy_wheel_names
[] =
5295 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5298 /* drag-n-drop events are generated when a set of selected files are
5299 dragged from another application and dropped onto an Emacs window. */
5300 static char *lispy_drag_n_drop_names
[] =
5305 /* Scroll bar parts. */
5306 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5307 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5308 Lisp_Object Qtop
, Qratio
;
5310 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5311 Lisp_Object
*scroll_bar_parts
[] = {
5312 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5313 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5316 /* A vector, indexed by button number, giving the down-going location
5317 of currently depressed buttons, both scroll bar and non-scroll bar.
5319 The elements have the form
5320 (BUTTON-NUMBER MODIFIER-MASK . REST)
5321 where REST is the cdr of a position as it would be reported in the event.
5323 The make_lispy_event function stores positions here to tell the
5324 difference between click and drag events, and to store the starting
5325 location to be included in drag events. */
5327 static Lisp_Object button_down_location
;
5329 /* Information about the most recent up-going button event: Which
5330 button, what location, and what time. */
5332 static int last_mouse_button
;
5333 static int last_mouse_x
;
5334 static int last_mouse_y
;
5335 static unsigned long button_down_time
;
5337 /* The maximum time between clicks to make a double-click, or Qnil to
5338 disable double-click detection, or Qt for no time limit. */
5340 Lisp_Object Vdouble_click_time
;
5342 /* Maximum number of pixels the mouse may be moved between clicks
5343 to make a double-click. */
5345 EMACS_INT double_click_fuzz
;
5347 /* The number of clicks in this multiple-click. */
5349 int double_click_count
;
5351 /* Return position of a mouse click or wheel event */
5354 make_lispy_position (f
, x
, y
, time
)
5360 enum window_part part
;
5361 Lisp_Object posn
= Qnil
;
5362 Lisp_Object extra_info
= Qnil
;
5365 /* Set `window' to the window under frame pixel coordinates (x,y) */
5367 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5368 &part
, &wx
, &wy
, 0);
5372 if (WINDOWP (window
))
5374 /* It's a click in window window at frame coordinates (x,y) */
5375 struct window
*w
= XWINDOW (window
);
5376 Lisp_Object string_info
= Qnil
;
5377 int textpos
= -1, rx
= -1, ry
= -1;
5378 int dx
= -1, dy
= -1;
5379 int width
= -1, height
= -1;
5380 Lisp_Object object
= Qnil
;
5382 /* Set event coordinates to window-relative coordinates
5383 for constructing the Lisp event below. */
5387 if (part
== ON_TEXT
)
5389 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5391 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5393 /* Mode line or header line. Look for a string under
5394 the mouse that may have a `local-map' property. */
5398 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5400 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5401 &object
, &dx
, &dy
, &width
, &height
);
5402 if (STRINGP (string
))
5403 string_info
= Fcons (string
, make_number (charpos
));
5404 if (w
== XWINDOW (selected_window
))
5407 textpos
= XMARKER (w
->pointm
)->charpos
;
5409 else if (part
== ON_VERTICAL_BORDER
)
5411 posn
= Qvertical_line
;
5416 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5421 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5423 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5424 &object
, &dx
, &dy
, &width
, &height
);
5425 if (STRINGP (string
))
5426 string_info
= Fcons (string
, make_number (charpos
));
5427 if (part
== ON_LEFT_MARGIN
)
5430 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5432 else if (part
== ON_LEFT_FRINGE
)
5434 posn
= Qleft_fringe
;
5437 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5439 : window_box_width (w
, LEFT_MARGIN_AREA
));
5442 else if (part
== ON_RIGHT_FRINGE
)
5444 posn
= Qright_fringe
;
5447 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5448 + window_box_width (w
, TEXT_AREA
)
5449 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5450 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5456 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5457 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5462 Lisp_Object string2
, object2
= Qnil
;
5463 struct display_pos p
;
5465 int width2
, height2
;
5466 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5467 &object2
, &dx2
, &dy2
,
5469 textpos
= CHARPOS (p
.pos
);
5470 if (rx
< 0) rx
= wx
;
5471 if (ry
< 0) ry
= wy
;
5472 if (dx
< 0) dx
= dx2
;
5473 if (dy
< 0) dy
= dy2
;
5474 if (width
< 0) width
= width2
;
5475 if (height
< 0) height
= height2
;
5479 posn
= make_number (textpos
);
5480 if (STRINGP (string2
))
5481 string_info
= Fcons (string2
,
5482 make_number (CHARPOS (p
.string_pos
)));
5488 #ifdef HAVE_WINDOW_SYSTEM
5489 if (IMAGEP (object
))
5491 Lisp_Object image_map
, hotspot
;
5492 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5494 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5496 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5497 posn
= XCAR (hotspot
);
5502 extra_info
= Fcons (object
,
5503 Fcons (Fcons (make_number (dx
),
5505 Fcons (Fcons (make_number (width
),
5506 make_number (height
)),
5510 extra_info
= Fcons (string_info
,
5511 Fcons (make_number (textpos
),
5512 Fcons (Fcons (make_number (rx
),
5518 XSETFRAME (window
, f
);
5523 XSETFASTINT (*x
, 0);
5524 XSETFASTINT (*y
, 0);
5527 return Fcons (window
,
5529 Fcons (Fcons (*x
, *y
),
5530 Fcons (make_number (time
),
5534 /* Given a struct input_event, build the lisp event which represents
5535 it. If EVENT is 0, build a mouse movement event from the mouse
5536 movement buffer, which should have a movement event in it.
5538 Note that events must be passed to this function in the order they
5539 are received; this function stores the location of button presses
5540 in order to build drag events when the button is released. */
5543 make_lispy_event (event
)
5544 struct input_event
*event
;
5548 switch (SWITCH_ENUM_CAST (event
->kind
))
5550 /* A simple keystroke. */
5551 case ASCII_KEYSTROKE_EVENT
:
5552 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5554 Lisp_Object lispy_c
;
5555 int c
= event
->code
;
5556 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5559 eassert (c
== event
->code
);
5560 /* Turn ASCII characters into control characters
5562 if (event
->modifiers
& ctrl_modifier
)
5564 c
= make_ctrl_char (c
);
5565 event
->modifiers
&= ~ctrl_modifier
;
5569 /* Add in the other modifier bits. The shift key was taken care
5570 of by the X code. */
5571 c
|= (event
->modifiers
5572 & (meta_modifier
| alt_modifier
5573 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5574 /* Distinguish Shift-SPC from SPC. */
5575 if ((event
->code
) == 040
5576 && event
->modifiers
& shift_modifier
)
5577 c
|= shift_modifier
;
5578 button_down_time
= 0;
5579 XSETFASTINT (lispy_c
, c
);
5583 /* A function key. The symbol may need to have modifier prefixes
5585 case NON_ASCII_KEYSTROKE_EVENT
:
5586 button_down_time
= 0;
5588 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5589 if (event
->code
== lispy_accent_codes
[i
])
5590 return modify_event_symbol (i
,
5592 Qfunction_key
, Qnil
,
5593 lispy_accent_keys
, &accent_key_syms
,
5594 (sizeof (lispy_accent_keys
)
5595 / sizeof (lispy_accent_keys
[0])));
5599 if (event
->code
>= 0x400 && event
->code
< 0x500)
5600 return modify_event_symbol (event
->code
- 0x400,
5601 event
->modifiers
& ~shift_modifier
,
5602 Qfunction_key
, Qnil
,
5603 lispy_kana_keys
, &func_key_syms
,
5604 (sizeof (lispy_kana_keys
)
5605 / sizeof (lispy_kana_keys
[0])));
5606 #endif /* XK_kana_A */
5609 #ifdef ISO_FUNCTION_KEY_OFFSET
5610 if (event
->code
< FUNCTION_KEY_OFFSET
5611 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5612 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5614 Qfunction_key
, Qnil
,
5615 iso_lispy_function_keys
, &func_key_syms
,
5616 (sizeof (iso_lispy_function_keys
)
5617 / sizeof (iso_lispy_function_keys
[0])));
5620 /* Handle system-specific or unknown keysyms. */
5621 if (event
->code
& (1 << 28)
5622 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5623 || (event
->code
- FUNCTION_KEY_OFFSET
5624 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5625 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5627 /* We need to use an alist rather than a vector as the cache
5628 since we can't make a vector long enuf. */
5629 if (NILP (current_kboard
->system_key_syms
))
5630 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5631 return modify_event_symbol (event
->code
,
5634 current_kboard
->Vsystem_key_alist
,
5635 0, ¤t_kboard
->system_key_syms
,
5639 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5641 Qfunction_key
, Qnil
,
5642 lispy_function_keys
, &func_key_syms
,
5643 (sizeof (lispy_function_keys
)
5644 / sizeof (lispy_function_keys
[0])));
5647 case MULTIMEDIA_KEY_EVENT
:
5648 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5649 / sizeof (lispy_multimedia_keys
[0]))
5650 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5652 return modify_event_symbol (event
->code
, event
->modifiers
,
5653 Qfunction_key
, Qnil
,
5654 lispy_multimedia_keys
, &func_key_syms
,
5655 (sizeof (lispy_multimedia_keys
)
5656 / sizeof (lispy_multimedia_keys
[0])));
5662 /* A mouse click. Figure out where it is, decide whether it's
5663 a press, click or drag, and build the appropriate structure. */
5664 case MOUSE_CLICK_EVENT
:
5665 #ifndef USE_TOOLKIT_SCROLL_BARS
5666 case SCROLL_BAR_CLICK_EVENT
:
5669 int button
= event
->code
;
5671 Lisp_Object position
;
5672 Lisp_Object
*start_pos_ptr
;
5673 Lisp_Object start_pos
;
5677 /* Build the position as appropriate for this mouse click. */
5678 if (event
->kind
== MOUSE_CLICK_EVENT
)
5680 struct frame
*f
= XFRAME (event
->frame_or_window
);
5681 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5685 /* Ignore mouse events that were made on frame that
5686 have been deleted. */
5687 if (! FRAME_LIVE_P (f
))
5690 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5691 /* EVENT->x and EVENT->y are frame-relative pixel
5692 coordinates at this place. Under old redisplay, COLUMN
5693 and ROW are set to frame relative glyph coordinates
5694 which are then used to determine whether this click is
5695 in a menu (non-toolkit version). */
5696 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5697 &column
, &row
, NULL
, 1);
5699 /* In the non-toolkit version, clicks on the menu bar
5700 are ordinary button events in the event buffer.
5701 Distinguish them, and invoke the menu.
5703 (In the toolkit version, the toolkit handles the menu bar
5704 and Emacs doesn't know about it until after the user
5705 makes a selection.) */
5706 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5707 && (event
->modifiers
& down_modifier
))
5709 Lisp_Object items
, item
;
5714 /* Activate the menu bar on the down event. If the
5715 up event comes in before the menu code can deal with it,
5717 if (! (event
->modifiers
& down_modifier
))
5721 /* Find the menu bar item under `column'. */
5723 items
= FRAME_MENU_BAR_ITEMS (f
);
5724 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5726 Lisp_Object pos
, string
;
5727 string
= AREF (items
, i
+ 1);
5728 pos
= AREF (items
, i
+ 3);
5731 if (column
>= XINT (pos
)
5732 && column
< XINT (pos
) + SCHARS (string
))
5734 item
= AREF (items
, i
);
5739 /* ELisp manual 2.4b says (x y) are window relative but
5740 code says they are frame-relative. */
5742 = Fcons (event
->frame_or_window
,
5744 Fcons (Fcons (event
->x
, event
->y
),
5745 Fcons (make_number (event
->timestamp
),
5748 return Fcons (item
, Fcons (position
, Qnil
));
5750 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5752 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5755 #ifndef USE_TOOLKIT_SCROLL_BARS
5758 /* It's a scrollbar click. */
5760 Lisp_Object portion_whole
;
5763 window
= event
->frame_or_window
;
5764 portion_whole
= Fcons (event
->x
, event
->y
);
5765 part
= *scroll_bar_parts
[(int) event
->part
];
5769 Fcons (Qvertical_scroll_bar
,
5770 Fcons (portion_whole
,
5771 Fcons (make_number (event
->timestamp
),
5772 Fcons (part
, Qnil
)))));
5774 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5776 if (button
>= ASIZE (button_down_location
))
5778 button_down_location
= larger_vector (button_down_location
,
5780 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5783 start_pos_ptr
= &AREF (button_down_location
, button
);
5784 start_pos
= *start_pos_ptr
;
5785 *start_pos_ptr
= Qnil
;
5788 /* On window-system frames, use the value of
5789 double-click-fuzz as is. On other frames, interpret it
5790 as a multiple of 1/8 characters. */
5794 if (WINDOWP (event
->frame_or_window
))
5795 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5796 else if (FRAMEP (event
->frame_or_window
))
5797 f
= XFRAME (event
->frame_or_window
);
5801 if (FRAME_WINDOW_P (f
))
5802 fuzz
= double_click_fuzz
;
5804 fuzz
= double_click_fuzz
/ 8;
5806 is_double
= (button
== last_mouse_button
5807 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5808 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5809 && button_down_time
!= 0
5810 && (EQ (Vdouble_click_time
, Qt
)
5811 || (INTEGERP (Vdouble_click_time
)
5812 && ((int)(event
->timestamp
- button_down_time
)
5813 < XINT (Vdouble_click_time
)))));
5816 last_mouse_button
= button
;
5817 last_mouse_x
= XINT (event
->x
);
5818 last_mouse_y
= XINT (event
->y
);
5820 /* If this is a button press, squirrel away the location, so
5821 we can decide later whether it was a click or a drag. */
5822 if (event
->modifiers
& down_modifier
)
5826 double_click_count
++;
5827 event
->modifiers
|= ((double_click_count
> 2)
5832 double_click_count
= 1;
5833 button_down_time
= event
->timestamp
;
5834 *start_pos_ptr
= Fcopy_alist (position
);
5835 ignore_mouse_drag_p
= 0;
5838 /* Now we're releasing a button - check the co-ordinates to
5839 see if this was a click or a drag. */
5840 else if (event
->modifiers
& up_modifier
)
5842 /* If we did not see a down before this up, ignore the up.
5843 Probably this happened because the down event chose a
5844 menu item. It would be an annoyance to treat the
5845 release of the button that chose the menu item as a
5848 if (!CONSP (start_pos
))
5851 event
->modifiers
&= ~up_modifier
;
5852 #if 0 /* Formerly we treated an up with no down as a click event. */
5853 if (!CONSP (start_pos
))
5854 event
->modifiers
|= click_modifier
;
5859 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5861 /* The third element of every position
5862 should be the (x,y) pair. */
5863 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5865 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5867 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5868 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5871 if (ignore_mouse_drag_p
)
5873 event
->modifiers
|= click_modifier
;
5874 ignore_mouse_drag_p
= 0;
5876 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5877 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5878 /* Maybe the mouse has moved a lot, caused scrolling, and
5879 eventually ended up at the same screen position (but
5880 not buffer position) in which case it is a drag, not
5882 /* FIXME: OTOH if the buffer position has changed
5883 because of a timer or process filter rather than
5884 because of mouse movement, it should be considered as
5885 a click. But mouse-drag-region completely ignores
5886 this case and it hasn't caused any real problem, so
5887 it's probably OK to ignore it as well. */
5888 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5889 /* Mouse hasn't moved (much). */
5890 event
->modifiers
|= click_modifier
;
5893 button_down_time
= 0;
5894 event
->modifiers
|= drag_modifier
;
5897 /* Don't check is_double; treat this as multiple
5898 if the down-event was multiple. */
5899 if (double_click_count
> 1)
5900 event
->modifiers
|= ((double_click_count
> 2)
5906 /* Every mouse event should either have the down_modifier or
5907 the up_modifier set. */
5911 /* Get the symbol we should use for the mouse click. */
5914 head
= modify_event_symbol (button
,
5916 Qmouse_click
, Vlispy_mouse_stem
,
5919 XVECTOR (mouse_syms
)->size
);
5920 if (event
->modifiers
& drag_modifier
)
5925 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5928 Fcons (make_number (double_click_count
),
5938 case HORIZ_WHEEL_EVENT
:
5940 Lisp_Object position
;
5943 /* Build the position as appropriate for this mouse click. */
5944 struct frame
*f
= XFRAME (event
->frame_or_window
);
5946 /* Ignore wheel events that were made on frame that have been
5948 if (! FRAME_LIVE_P (f
))
5951 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5954 /* Set double or triple modifiers to indicate the wheel speed. */
5956 /* On window-system frames, use the value of
5957 double-click-fuzz as is. On other frames, interpret it
5958 as a multiple of 1/8 characters. */
5963 if (WINDOWP (event
->frame_or_window
))
5964 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5965 else if (FRAMEP (event
->frame_or_window
))
5966 f
= XFRAME (event
->frame_or_window
);
5970 if (FRAME_WINDOW_P (f
))
5971 fuzz
= double_click_fuzz
;
5973 fuzz
= double_click_fuzz
/ 8;
5975 is_double
= (last_mouse_button
< 0
5976 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5977 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5978 && button_down_time
!= 0
5979 && (EQ (Vdouble_click_time
, Qt
)
5980 || (INTEGERP (Vdouble_click_time
)
5981 && ((int)(event
->timestamp
- button_down_time
)
5982 < XINT (Vdouble_click_time
)))));
5985 double_click_count
++;
5986 event
->modifiers
|= ((double_click_count
> 2)
5992 double_click_count
= 1;
5993 event
->modifiers
|= click_modifier
;
5996 button_down_time
= event
->timestamp
;
5997 /* Use a negative value to distinguish wheel from mouse button. */
5998 last_mouse_button
= -1;
5999 last_mouse_x
= XINT (event
->x
);
6000 last_mouse_y
= XINT (event
->y
);
6006 if (event
->modifiers
& up_modifier
)
6008 /* Emit a wheel-up event. */
6009 event
->modifiers
&= ~up_modifier
;
6012 else if (event
->modifiers
& down_modifier
)
6014 /* Emit a wheel-down event. */
6015 event
->modifiers
&= ~down_modifier
;
6019 /* Every wheel event should either have the down_modifier or
6020 the up_modifier set. */
6023 if (event
->kind
== HORIZ_WHEEL_EVENT
)
6026 /* Get the symbol we should use for the wheel event. */
6027 head
= modify_event_symbol (symbol_num
,
6033 ASIZE (wheel_syms
));
6036 if (event
->modifiers
& (double_modifier
| triple_modifier
))
6039 Fcons (make_number (double_click_count
),
6048 #ifdef USE_TOOLKIT_SCROLL_BARS
6050 /* We don't have down and up events if using toolkit scroll bars,
6051 so make this always a click event. Store in the `part' of
6052 the Lisp event a symbol which maps to the following actions:
6054 `above_handle' page up
6055 `below_handle' page down
6059 `bottom' bottom of buffer
6060 `handle' thumb has been dragged.
6061 `end-scroll' end of interaction with scroll bar
6063 The incoming input_event contains in its `part' member an
6064 index of type `enum scroll_bar_part' which we can use as an
6065 index in scroll_bar_parts to get the appropriate symbol. */
6067 case SCROLL_BAR_CLICK_EVENT
:
6069 Lisp_Object position
, head
, window
, portion_whole
, part
;
6071 window
= event
->frame_or_window
;
6072 portion_whole
= Fcons (event
->x
, event
->y
);
6073 part
= *scroll_bar_parts
[(int) event
->part
];
6077 Fcons (Qvertical_scroll_bar
,
6078 Fcons (portion_whole
,
6079 Fcons (make_number (event
->timestamp
),
6080 Fcons (part
, Qnil
)))));
6082 /* Always treat scroll bar events as clicks. */
6083 event
->modifiers
|= click_modifier
;
6084 event
->modifiers
&= ~up_modifier
;
6086 if (event
->code
>= ASIZE (mouse_syms
))
6087 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6089 /* Get the symbol we should use for the mouse click. */
6090 head
= modify_event_symbol (event
->code
,
6095 XVECTOR (mouse_syms
)->size
);
6096 return Fcons (head
, Fcons (position
, Qnil
));
6099 #endif /* USE_TOOLKIT_SCROLL_BARS */
6101 case DRAG_N_DROP_EVENT
:
6104 Lisp_Object head
, position
;
6107 f
= XFRAME (event
->frame_or_window
);
6110 /* Ignore mouse events that were made on frames that
6111 have been deleted. */
6112 if (! FRAME_LIVE_P (f
))
6115 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6118 head
= modify_event_symbol (0, event
->modifiers
,
6120 lispy_drag_n_drop_names
,
6121 &drag_n_drop_syms
, 1);
6127 #endif /* HAVE_MOUSE */
6129 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
6130 || defined (USE_GTK)
6131 case MENU_BAR_EVENT
:
6132 if (EQ (event
->arg
, event
->frame_or_window
))
6133 /* This is the prefix key. We translate this to
6134 `(menu_bar)' because the code in keyboard.c for menu
6135 events, which we use, relies on this. */
6136 return Fcons (Qmenu_bar
, Qnil
);
6140 case SELECT_WINDOW_EVENT
:
6141 /* Make an event (select-window (WINDOW)). */
6142 return Fcons (Qselect_window
,
6143 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6146 case TOOL_BAR_EVENT
:
6147 if (EQ (event
->arg
, event
->frame_or_window
))
6148 /* This is the prefix key. We translate this to
6149 `(tool_bar)' because the code in keyboard.c for tool bar
6150 events, which we use, relies on this. */
6151 return Fcons (Qtool_bar
, Qnil
);
6152 else if (SYMBOLP (event
->arg
))
6153 return apply_modifiers (event
->modifiers
, event
->arg
);
6156 case USER_SIGNAL_EVENT
:
6157 /* A user signal. */
6159 char *name
= find_user_signal_name (event
->code
);
6162 return intern (name
);
6165 case SAVE_SESSION_EVENT
:
6166 return Qsave_session
;
6169 case MAC_APPLE_EVENT
:
6171 Lisp_Object spec
[2];
6175 return Fcons (Qmac_apple_event
,
6176 Fcons (Fvector (2, spec
),
6177 Fcons (event
->arg
, Qnil
)));
6184 return Fcons (Qdbus_event
, event
->arg
);
6186 #endif /* HAVE_DBUS */
6189 case GPM_CLICK_EVENT
:
6191 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6192 Lisp_Object head
, position
;
6193 Lisp_Object
*start_pos_ptr
;
6194 Lisp_Object start_pos
;
6195 int button
= event
->code
;
6197 if (button
>= ASIZE (button_down_location
))
6199 button_down_location
= larger_vector (button_down_location
,
6201 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6204 start_pos_ptr
= &AREF (button_down_location
, button
);
6205 start_pos
= *start_pos_ptr
;
6207 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6210 if (event
->modifiers
& down_modifier
)
6211 *start_pos_ptr
= Fcopy_alist (position
);
6212 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6214 if (!CONSP (start_pos
))
6216 event
->modifiers
&= ~up_modifier
;
6219 head
= modify_event_symbol (button
,
6221 Qmouse_click
, Vlispy_mouse_stem
,
6224 XVECTOR (mouse_syms
)->size
);
6226 if (event
->modifiers
& drag_modifier
)
6231 else if (event
->modifiers
& double_modifier
)
6234 Fcons (make_number (2),
6236 else if (event
->modifiers
& triple_modifier
)
6239 Fcons (make_number (3),
6246 #endif /* HAVE_GPM */
6248 /* The 'kind' field of the event is something we don't recognize. */
6254 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6257 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6259 Lisp_Object bar_window
;
6260 enum scroll_bar_part part
;
6264 /* Is it a scroll bar movement? */
6265 if (frame
&& ! NILP (bar_window
))
6267 Lisp_Object part_sym
;
6269 part_sym
= *scroll_bar_parts
[(int) part
];
6270 return Fcons (Qscroll_bar_movement
,
6271 (Fcons (Fcons (bar_window
,
6272 Fcons (Qvertical_scroll_bar
,
6273 Fcons (Fcons (x
, y
),
6274 Fcons (make_number (time
),
6280 /* Or is it an ordinary mouse movement? */
6283 Lisp_Object position
;
6285 position
= make_lispy_position (frame
, &x
, &y
, time
);
6287 return Fcons (Qmouse_movement
,
6293 #endif /* HAVE_MOUSE || HAVE GPM */
6295 /* Construct a switch frame event. */
6297 make_lispy_switch_frame (frame
)
6300 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6303 /* Manipulating modifiers. */
6305 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6307 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6308 SYMBOL's name of the end of the modifiers; the string from this
6309 position is the unmodified symbol name.
6311 This doesn't use any caches. */
6314 parse_modifiers_uncached (symbol
, modifier_end
)
6322 CHECK_SYMBOL (symbol
);
6325 name
= SYMBOL_NAME (symbol
);
6327 for (i
= 0; i
+2 <= SBYTES (name
); )
6329 int this_mod_end
= 0;
6332 /* See if the name continues with a modifier word.
6333 Check that the word appears, but don't check what follows it.
6334 Set this_mod and this_mod_end to record what we find. */
6336 switch (SREF (name
, i
))
6338 #define SINGLE_LETTER_MOD(BIT) \
6339 (this_mod_end = i + 1, this_mod = BIT)
6342 SINGLE_LETTER_MOD (alt_modifier
);
6346 SINGLE_LETTER_MOD (ctrl_modifier
);
6350 SINGLE_LETTER_MOD (hyper_modifier
);
6354 SINGLE_LETTER_MOD (meta_modifier
);
6358 SINGLE_LETTER_MOD (shift_modifier
);
6362 SINGLE_LETTER_MOD (super_modifier
);
6365 #undef SINGLE_LETTER_MOD
6367 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6368 if (i + LEN + 1 <= SBYTES (name) \
6369 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6371 this_mod_end = i + LEN; \
6376 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6377 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6378 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6382 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6384 #undef MULTI_LETTER_MOD
6388 /* If we found no modifier, stop looking for them. */
6389 if (this_mod_end
== 0)
6392 /* Check there is a dash after the modifier, so that it
6393 really is a modifier. */
6394 if (this_mod_end
>= SBYTES (name
)
6395 || SREF (name
, this_mod_end
) != '-')
6398 /* This modifier is real; look for another. */
6399 modifiers
|= this_mod
;
6400 i
= this_mod_end
+ 1;
6403 /* Should we include the `click' modifier? */
6404 if (! (modifiers
& (down_modifier
| drag_modifier
6405 | double_modifier
| triple_modifier
))
6406 && i
+ 7 == SBYTES (name
)
6407 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6408 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6409 modifiers
|= click_modifier
;
6417 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6418 prepended to the string BASE[0..BASE_LEN-1].
6419 This doesn't use any caches. */
6421 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6424 int base_len
, base_len_byte
;
6426 /* Since BASE could contain nulls, we can't use intern here; we have
6427 to use Fintern, which expects a genuine Lisp_String, and keeps a
6430 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6436 /* Only the event queue may use the `up' modifier; it should always
6437 be turned into a click or drag event before presented to lisp code. */
6438 if (modifiers
& up_modifier
)
6441 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6442 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6443 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6444 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6445 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6446 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6447 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6448 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6449 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6450 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6451 /* The click modifier is denoted by the absence of other modifiers. */
6455 mod_len
= p
- new_mods
;
6459 Lisp_Object new_name
;
6461 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6462 mod_len
+ base_len_byte
);
6463 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6464 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6466 return Fintern (new_name
, Qnil
);
6471 static char *modifier_names
[] =
6473 "up", "down", "drag", "click", "double", "triple", 0, 0,
6474 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6475 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6477 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6479 static Lisp_Object modifier_symbols
;
6481 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6483 lispy_modifier_list (modifiers
)
6486 Lisp_Object modifier_list
;
6489 modifier_list
= Qnil
;
6490 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6491 if (modifiers
& (1<<i
))
6492 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6495 return modifier_list
;
6499 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6500 where UNMODIFIED is the unmodified form of SYMBOL,
6501 MASK is the set of modifiers present in SYMBOL's name.
6502 This is similar to parse_modifiers_uncached, but uses the cache in
6503 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6504 Qevent_symbol_elements property. */
6506 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6509 parse_modifiers (symbol
)
6512 Lisp_Object elements
;
6514 if (INTEGERP (symbol
))
6515 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6516 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6518 else if (!SYMBOLP (symbol
))
6521 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6522 if (CONSP (elements
))
6527 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6528 Lisp_Object unmodified
;
6531 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6532 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6535 if (modifiers
& ~INTMASK
)
6537 XSETFASTINT (mask
, modifiers
);
6538 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6540 /* Cache the parsing results on SYMBOL. */
6541 Fput (symbol
, Qevent_symbol_element_mask
,
6543 Fput (symbol
, Qevent_symbol_elements
,
6544 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6546 /* Since we know that SYMBOL is modifiers applied to unmodified,
6547 it would be nice to put that in unmodified's cache.
6548 But we can't, since we're not sure that parse_modifiers is
6555 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6556 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6557 doc
: /* Parse the event symbol. For internal use. */)
6561 /* Fill the cache if needed. */
6562 parse_modifiers (symbol
);
6563 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6564 and use the Lispier representation stored on Qevent_symbol_elements
6566 return Fget (symbol
, Qevent_symbol_elements
);
6569 /* Apply the modifiers MODIFIERS to the symbol BASE.
6570 BASE must be unmodified.
6572 This is like apply_modifiers_uncached, but uses BASE's
6573 Qmodifier_cache property, if present. It also builds
6574 Qevent_symbol_elements properties, since it has that info anyway.
6576 apply_modifiers copies the value of BASE's Qevent_kind property to
6577 the modified symbol. */
6579 apply_modifiers (modifiers
, base
)
6583 Lisp_Object cache
, index
, entry
, new_symbol
;
6585 /* Mask out upper bits. We don't know where this value's been. */
6586 modifiers
&= INTMASK
;
6588 if (INTEGERP (base
))
6589 return make_number (XINT (base
) | modifiers
);
6591 /* The click modifier never figures into cache indices. */
6592 cache
= Fget (base
, Qmodifier_cache
);
6593 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6594 entry
= assq_no_quit (index
, cache
);
6597 new_symbol
= XCDR (entry
);
6600 /* We have to create the symbol ourselves. */
6601 new_symbol
= apply_modifiers_uncached (modifiers
,
6602 SDATA (SYMBOL_NAME (base
)),
6603 SCHARS (SYMBOL_NAME (base
)),
6604 SBYTES (SYMBOL_NAME (base
)));
6606 /* Add the new symbol to the base's cache. */
6607 entry
= Fcons (index
, new_symbol
);
6608 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6610 /* We have the parsing info now for free, so we could add it to
6612 XSETFASTINT (index, modifiers);
6613 Fput (new_symbol, Qevent_symbol_element_mask,
6614 Fcons (base, Fcons (index, Qnil)));
6615 Fput (new_symbol, Qevent_symbol_elements,
6616 Fcons (base, lispy_modifier_list (modifiers)));
6617 Sadly, this is only correct if `base' is indeed a base event,
6618 which is not necessarily the case. -stef */
6621 /* Make sure this symbol is of the same kind as BASE.
6623 You'd think we could just set this once and for all when we
6624 intern the symbol above, but reorder_modifiers may call us when
6625 BASE's property isn't set right; we can't assume that just
6626 because it has a Qmodifier_cache property it must have its
6627 Qevent_kind set right as well. */
6628 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6632 kind
= Fget (base
, Qevent_kind
);
6634 Fput (new_symbol
, Qevent_kind
, kind
);
6641 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6642 return a symbol with the modifiers placed in the canonical order.
6643 Canonical order is alphabetical, except for down and drag, which
6644 always come last. The 'click' modifier is never written out.
6646 Fdefine_key calls this to make sure that (for example) C-M-foo
6647 and M-C-foo end up being equivalent in the keymap. */
6650 reorder_modifiers (symbol
)
6653 /* It's hopefully okay to write the code this way, since everything
6654 will soon be in caches, and no consing will be done at all. */
6657 parsed
= parse_modifiers (symbol
);
6658 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6663 /* For handling events, we often want to produce a symbol whose name
6664 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6665 to some base, like the name of a function key or mouse button.
6666 modify_event_symbol produces symbols of this sort.
6668 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6669 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6672 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6673 into symbol names, or a string specifying a name stem used to
6674 construct a symbol name or the form `STEM-N', where N is the decimal
6675 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6676 non-nil; otherwise NAME_TABLE is used.
6678 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6679 persist between calls to modify_event_symbol that it can use to
6680 store a cache of the symbols it's generated for this NAME_TABLE
6681 before. The object stored there may be a vector or an alist.
6683 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6685 MODIFIERS is a set of modifier bits (as given in struct input_events)
6686 whose prefixes should be applied to the symbol name.
6688 SYMBOL_KIND is the value to be placed in the event_kind property of
6689 the returned symbol.
6691 The symbols we create are supposed to have an
6692 `event-symbol-elements' property, which lists the modifiers present
6693 in the symbol's name. */
6696 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6697 name_table
, symbol_table
, table_size
)
6700 Lisp_Object symbol_kind
;
6701 Lisp_Object name_alist_or_stem
;
6703 Lisp_Object
*symbol_table
;
6704 unsigned int table_size
;
6707 Lisp_Object symbol_int
;
6709 /* Get rid of the "vendor-specific" bit here. */
6710 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6712 /* Is this a request for a valid symbol? */
6713 if (symbol_num
< 0 || symbol_num
>= table_size
)
6716 if (CONSP (*symbol_table
))
6717 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6719 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6720 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6721 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6722 we've never used that symbol before. */
6725 if (! VECTORP (*symbol_table
)
6726 || XVECTOR (*symbol_table
)->size
!= table_size
)
6730 XSETFASTINT (size
, table_size
);
6731 *symbol_table
= Fmake_vector (size
, Qnil
);
6734 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6737 /* Have we already used this symbol before? */
6740 /* No; let's create it. */
6741 if (CONSP (name_alist_or_stem
))
6742 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6743 else if (STRINGP (name_alist_or_stem
))
6745 int len
= SBYTES (name_alist_or_stem
);
6746 char *buf
= (char *) alloca (len
+ 50);
6747 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6748 (long) XINT (symbol_int
) + 1);
6749 value
= intern (buf
);
6751 else if (name_table
!= 0 && name_table
[symbol_num
])
6752 value
= intern (name_table
[symbol_num
]);
6754 #ifdef HAVE_WINDOW_SYSTEM
6757 char *name
= x_get_keysym_name (symbol_num
);
6759 value
= intern (name
);
6766 sprintf (buf
, "key-%d", symbol_num
);
6767 value
= intern (buf
);
6770 if (CONSP (*symbol_table
))
6771 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6773 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6775 /* Fill in the cache entries for this symbol; this also
6776 builds the Qevent_symbol_elements property, which the user
6778 apply_modifiers (modifiers
& click_modifier
, value
);
6779 Fput (value
, Qevent_kind
, symbol_kind
);
6782 /* Apply modifiers to that symbol. */
6783 return apply_modifiers (modifiers
, value
);
6786 /* Convert a list that represents an event type,
6787 such as (ctrl meta backspace), into the usual representation of that
6788 event type as a number or a symbol. */
6790 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6791 doc
: /* Convert the event description list EVENT-DESC to an event type.
6792 EVENT-DESC should contain one base event type (a character or symbol)
6793 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6794 drag, down, double or triple). The base must be last.
6795 The return value is an event type (a character or symbol) which
6796 has the same base event type and all the specified modifiers. */)
6798 Lisp_Object event_desc
;
6806 while (CONSP (rest
))
6814 /* Given a symbol, see if it is a modifier name. */
6815 if (SYMBOLP (elt
) && CONSP (rest
))
6816 this = parse_solitary_modifier (elt
);
6820 else if (!NILP (base
))
6821 error ("Two bases given in one event");
6827 /* Let the symbol A refer to the character A. */
6828 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6829 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6831 if (INTEGERP (base
))
6833 /* Turn (shift a) into A. */
6834 if ((modifiers
& shift_modifier
) != 0
6835 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6837 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6838 modifiers
&= ~shift_modifier
;
6841 /* Turn (control a) into C-a. */
6842 if (modifiers
& ctrl_modifier
)
6843 return make_number ((modifiers
& ~ctrl_modifier
)
6844 | make_ctrl_char (XINT (base
)));
6846 return make_number (modifiers
| XINT (base
));
6848 else if (SYMBOLP (base
))
6849 return apply_modifiers (modifiers
, base
);
6852 error ("Invalid base event");
6857 /* Try to recognize SYMBOL as a modifier name.
6858 Return the modifier flag bit, or 0 if not recognized. */
6861 parse_solitary_modifier (symbol
)
6864 Lisp_Object name
= SYMBOL_NAME (symbol
);
6866 switch (SREF (name
, 0))
6868 #define SINGLE_LETTER_MOD(BIT) \
6869 if (SBYTES (name) == 1) \
6872 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6873 if (LEN == SBYTES (name) \
6874 && ! strncmp (SDATA (name), NAME, LEN)) \
6878 SINGLE_LETTER_MOD (alt_modifier
);
6882 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6886 SINGLE_LETTER_MOD (ctrl_modifier
);
6890 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6891 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6895 SINGLE_LETTER_MOD (hyper_modifier
);
6899 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6903 SINGLE_LETTER_MOD (meta_modifier
);
6907 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6911 SINGLE_LETTER_MOD (shift_modifier
);
6915 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6916 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6917 SINGLE_LETTER_MOD (super_modifier
);
6921 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6922 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6923 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6927 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6930 #undef SINGLE_LETTER_MOD
6931 #undef MULTI_LETTER_MOD
6937 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6938 Such a list is not valid as an event,
6939 but it can be a Lucid-style event type list. */
6942 lucid_event_type_list_p (object
)
6947 if (! CONSP (object
))
6950 if (EQ (XCAR (object
), Qhelp_echo
)
6951 || EQ (XCAR (object
), Qvertical_line
)
6952 || EQ (XCAR (object
), Qmode_line
)
6953 || EQ (XCAR (object
), Qheader_line
))
6956 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6960 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6967 /* Store into *addr a value nonzero if terminal input chars are available.
6968 Serves the purpose of ioctl (0, FIONREAD, addr)
6969 but works even if FIONREAD does not exist.
6970 (In fact, this may actually read some input.)
6972 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6973 timer events that are ripe.
6974 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6975 events (FOCUS_IN_EVENT).
6976 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6977 movements and toolkit scroll bar thumb drags. */
6980 get_input_pending (addr
, flags
)
6984 /* First of all, have we already counted some input? */
6985 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6987 /* If input is being read as it arrives, and we have none, there is none. */
6988 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6991 /* Try to read some input and see how much we get. */
6993 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6996 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6999 gobble_input (expected
)
7003 /* Check whether a D-Bus message has arrived. */
7004 xd_read_queued_messages ();
7005 #endif /* HAVE_DBUS */
7009 if (interrupt_input
)
7012 mask
= sigblock (sigmask (SIGIO
));
7013 read_avail_input (expected
);
7017 #ifdef POLL_FOR_INPUT
7018 /* XXX This condition was (read_socket_hook && !interrupt_input),
7019 but read_socket_hook is not global anymore. Let's pretend that
7021 if (!interrupt_input
&& poll_suppress_count
== 0)
7024 mask
= sigblock (sigmask (SIGALRM
));
7025 read_avail_input (expected
);
7031 read_avail_input (expected
);
7035 /* Put a BUFFER_SWITCH_EVENT in the buffer
7036 so that read_key_sequence will notice the new current buffer. */
7039 record_asynch_buffer_change ()
7041 struct input_event event
;
7045 event
.kind
= BUFFER_SWITCH_EVENT
;
7046 event
.frame_or_window
= Qnil
;
7050 /* We don't need a buffer-switch event unless Emacs is waiting for input.
7051 The purpose of the event is to make read_key_sequence look up the
7052 keymaps again. If we aren't in read_key_sequence, we don't need one,
7053 and the event could cause trouble by messing up (input-pending-p). */
7054 tem
= Fwaiting_for_user_input_p ();
7058 /* We never need these events if we have no asynchronous subprocesses. */
7062 /* Make sure no interrupt happens while storing the event. */
7064 if (interrupt_input
)
7067 mask
= sigblock (sigmask (SIGIO
));
7068 kbd_buffer_store_event (&event
);
7075 kbd_buffer_store_event (&event
);
7082 /* Read any terminal input already buffered up by the system
7083 into the kbd_buffer, but do not wait.
7085 EXPECTED should be nonzero if the caller knows there is some input.
7087 Except on VMS, all input is read by this function.
7088 If interrupt_input is nonzero, this function MUST be called
7089 only when SIGIO is blocked.
7091 Returns the number of keyboard chars read, or -1 meaning
7092 this is a bad time to try to read input. */
7095 read_avail_input (expected
)
7102 /* Store pending user signal events, if any. */
7103 if (store_user_signal_events ())
7106 /* Loop through the available terminals, and call their input hooks. */
7110 struct terminal
*next
= t
->next_terminal
;
7112 if (t
->read_socket_hook
)
7115 struct input_event hold_quit
;
7117 EVENT_INIT (hold_quit
);
7118 hold_quit
.kind
= NO_EVENT
;
7120 /* No need for FIONREAD or fcntl; just say don't wait. */
7121 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7127 if (nr
== -1) /* Not OK to read input now. */
7131 else if (nr
== -2) /* Non-transient error. */
7133 /* The terminal device terminated; it should be closed. */
7135 /* Kill Emacs if this was our last terminal. */
7136 if (!terminal_list
->next_terminal
)
7137 /* Formerly simply reported no input, but that
7138 sometimes led to a failure of Emacs to terminate.
7139 SIGHUP seems appropriate if we can't reach the
7141 /* ??? Is it really right to send the signal just to
7142 this process rather than to the whole process
7143 group? Perhaps on systems with FIONREAD Emacs is
7144 alone in its group. */
7145 kill (getpid (), SIGHUP
);
7147 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
7150 XSETTERMINAL (tmp
, t
);
7151 Fdelete_terminal (tmp
, Qnoelisp
);
7155 if (hold_quit
.kind
!= NO_EVENT
)
7156 kbd_buffer_store_event (&hold_quit
);
7168 /* This is the tty way of reading available input.
7170 Note that each terminal device has its own `struct terminal' object,
7171 and so this function is called once for each individual termcap
7172 terminal. The first parameter indicates which terminal to read from. */
7175 tty_read_avail_input (struct terminal
*terminal
,
7177 struct input_event
*hold_quit
)
7179 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7180 the kbd_buffer can really hold. That may prevent loss
7181 of characters on some systems when input is stuffed at us. */
7182 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7184 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7187 if (!terminal
->name
) /* Don't read from a dead terminal. */
7190 if (terminal
->type
!= output_termcap
)
7193 /* XXX I think the following code should be moved to separate hook
7194 functions in system-dependent files. */
7197 #else /* not WINDOWSNT */
7199 n_to_read
= dos_keysns ();
7203 cbuf
[0] = dos_keyread ();
7206 #else /* not MSDOS */
7208 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7212 return 0; /* The terminal is suspended. */
7218 struct input_event hold_quit
;
7221 EVENT_INIT (hold_quit
);
7222 hold_quit
.kind
= NO_EVENT
;
7224 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7225 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7227 if (hold_quit
.kind
!= NO_EVENT
)
7228 kbd_buffer_store_event (&hold_quit
);
7232 #endif /* HAVE_GPM */
7234 /* Determine how many characters we should *try* to read. */
7236 /* Find out how much input is available. */
7237 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7239 if (! noninteractive
)
7240 return -2; /* Close this terminal. */
7246 if (n_to_read
> sizeof cbuf
)
7247 n_to_read
= sizeof cbuf
;
7248 #else /* no FIONREAD */
7249 #if defined (USG) || defined(CYGWIN)
7250 /* Read some input if available, but don't wait. */
7251 n_to_read
= sizeof cbuf
;
7252 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7258 /* Now read; for one reason or another, this will not block.
7259 NREAD is set to the number of chars read. */
7262 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7263 /* POSIX infers that processes which are not in the session leader's
7264 process group won't get SIGHUP's at logout time. BSDI adheres to
7265 this part standard and returns -1 from read (0) with errno==EIO
7266 when the control tty is taken away.
7267 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7268 if (nread
== -1 && errno
== EIO
)
7269 return -2; /* Close this terminal. */
7270 #if defined (AIX) && defined (_BSD)
7271 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7272 This looks incorrect, but it isn't, because _BSD causes
7273 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7274 and that causes a value other than 0 when there is no input. */
7276 return -2; /* Close this terminal. */
7280 /* We used to retry the read if it was interrupted.
7281 But this does the wrong thing when O_NDELAY causes
7282 an EAGAIN error. Does anybody know of a situation
7283 where a retry is actually needed? */
7285 nread
< 0 && (errno
== EAGAIN
7299 #if defined (USG) || defined (CYGWIN)
7300 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7301 #endif /* USG or CYGWIN */
7302 #endif /* no FIONREAD */
7307 #endif /* not MSDOS */
7308 #endif /* not WINDOWSNT */
7310 for (i
= 0; i
< nread
; i
++)
7312 struct input_event buf
;
7314 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7316 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7317 buf
.modifiers
= meta_modifier
;
7318 if (tty
->meta_key
!= 2)
7322 /* Set the frame corresponding to the active tty. Note that the
7323 value of selected_frame is not reliable here, redisplay tends
7324 to temporarily change it. */
7325 buf
.frame_or_window
= tty
->top_frame
;
7328 kbd_buffer_store_event (&buf
);
7329 /* Don't look at input that follows a C-g too closely.
7330 This reduces lossage due to autorepeat on C-g. */
7331 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7332 && buf
.code
== quit_char
)
7338 #endif /* not VMS */
7341 handle_async_input ()
7344 extern int select_alarmed
;
7347 interrupt_input_pending
= 0;
7352 nread
= read_avail_input (1);
7353 /* -1 means it's not ok to read the input now.
7354 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7355 0 means there was no keyboard input available. */
7360 select_alarmed
= 1; /* Force the select emulator back to life */
7365 #ifdef SIGIO /* for entire page */
7366 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7369 input_available_signal (signo
)
7372 /* Must preserve main program's value of errno. */
7373 int old_errno
= errno
;
7374 #if defined (USG) && !defined (POSIX_SIGNALS)
7375 /* USG systems forget handlers when they are used;
7376 must reestablish each time */
7377 signal (signo
, input_available_signal
);
7385 interrupt_input_pending
= 1;
7387 SIGNAL_THREAD_CHECK (signo
);
7390 if (input_available_clear_time
)
7391 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7394 handle_async_input ();
7404 /* Send ourselves a SIGIO.
7406 This function exists so that the UNBLOCK_INPUT macro in
7407 blockinput.h can have some way to take care of input we put off
7408 dealing with, without assuming that every file which uses
7409 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7411 reinvoke_input_signal ()
7414 handle_async_input ();
7420 /* User signal events. */
7422 struct user_signal_info
7424 /* Signal number. */
7427 /* Name of the signal. */
7430 /* Number of pending signals. */
7433 struct user_signal_info
*next
;
7436 /* List of user signals. */
7437 static struct user_signal_info
*user_signals
= NULL
;
7440 add_user_signal (sig
, name
)
7444 struct user_signal_info
*p
;
7446 for (p
= user_signals
; p
; p
= p
->next
)
7448 /* Already added. */
7451 p
= xmalloc (sizeof (struct user_signal_info
));
7453 p
->name
= xstrdup (name
);
7455 p
->next
= user_signals
;
7458 signal (sig
, handle_user_signal
);
7462 handle_user_signal (sig
)
7465 int old_errno
= errno
;
7466 struct user_signal_info
*p
;
7468 #if defined (USG) && !defined (POSIX_SIGNALS)
7469 /* USG systems forget handlers when they are used;
7470 must reestablish each time */
7471 signal (sig
, handle_user_signal
);
7474 SIGNAL_THREAD_CHECK (sig
);
7476 for (p
= user_signals
; p
; p
= p
->next
)
7481 if (interrupt_input
)
7482 kill (getpid (), SIGIO
);
7486 /* Tell wait_reading_process_output that it needs to wake
7487 up and look around. */
7488 if (input_available_clear_time
)
7489 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7498 find_user_signal_name (sig
)
7501 struct user_signal_info
*p
;
7503 for (p
= user_signals
; p
; p
= p
->next
)
7511 store_user_signal_events ()
7513 struct user_signal_info
*p
;
7514 struct input_event buf
;
7517 for (p
= user_signals
; p
; p
= p
->next
)
7518 if (p
->npending
> 0)
7524 bzero (&buf
, sizeof buf
);
7525 buf
.kind
= USER_SIGNAL_EVENT
;
7526 buf
.frame_or_window
= selected_frame
;
7528 nstored
+= p
->npending
;
7530 mask
= sigblock (sigmask (p
->sig
));
7534 kbd_buffer_store_event (&buf
);
7537 while (p
->npending
> 0);
7545 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7546 static Lisp_Object menu_bar_one_keymap_changed_items
;
7548 /* These variables hold the vector under construction within
7549 menu_bar_items and its subroutines, and the current index
7550 for storing into that vector. */
7551 static Lisp_Object menu_bar_items_vector
;
7552 static int menu_bar_items_index
;
7554 /* Return a vector of menu items for a menu bar, appropriate
7555 to the current buffer. Each item has three elements in the vector:
7558 OLD is an old vector we can optionally reuse, or nil. */
7561 menu_bar_items (old
)
7564 /* The number of keymaps we're scanning right now, and the number of
7565 keymaps we have allocated space for. */
7568 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7569 in the current keymaps, or nil where it is not a prefix. */
7572 Lisp_Object def
, tail
;
7581 /* In order to build the menus, we need to call the keymap
7582 accessors. They all call QUIT. But this function is called
7583 during redisplay, during which a quit is fatal. So inhibit
7584 quitting while building the menus.
7585 We do this instead of specbind because (1) errors will clear it anyway
7586 and (2) this avoids risk of specpdl overflow. */
7587 oquit
= Vinhibit_quit
;
7591 menu_bar_items_vector
= old
;
7593 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7594 menu_bar_items_index
= 0;
7596 /* Build our list of keymaps.
7597 If we recognize a function key and replace its escape sequence in
7598 keybuf with its symbol, or if the sequence starts with a mouse
7599 click and we need to switch buffers, we jump back here to rebuild
7600 the initial keymaps from the current buffer. */
7604 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7605 if (!NILP (Voverriding_local_map_menu_flag
))
7607 /* Yes, use them (if non-nil) as well as the global map. */
7608 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7610 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7611 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7612 if (!NILP (Voverriding_local_map
))
7613 maps
[nmaps
++] = Voverriding_local_map
;
7617 /* No, so use major and minor mode keymaps and keymap property.
7618 Note that menu-bar bindings in the local-map and keymap
7619 properties may not work reliable, as they are only
7620 recognized when the menu-bar (or mode-line) is updated,
7621 which does not normally happen after every command. */
7624 nminor
= current_minor_maps (NULL
, &tmaps
);
7625 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7627 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7628 maps
[nmaps
++] = tem
;
7629 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7631 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7633 maps
[nmaps
++] = current_global_map
;
7636 /* Look up in each map the dummy prefix key `menu-bar'. */
7640 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7641 if (!NILP (maps
[mapno
]))
7643 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7647 menu_bar_one_keymap_changed_items
= Qnil
;
7648 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7652 /* Move to the end those items that should be at the end. */
7654 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7657 int end
= menu_bar_items_index
;
7659 for (i
= 0; i
< end
; i
+= 4)
7660 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7662 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7663 /* Move the item at index I to the end,
7664 shifting all the others forward. */
7665 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7666 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7667 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7668 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7670 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7671 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7672 (end
- i
- 4) * sizeof (Lisp_Object
));
7673 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7674 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7675 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7676 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7681 /* Add nil, nil, nil, nil at the end. */
7682 i
= menu_bar_items_index
;
7683 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7684 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7685 /* Add this item. */
7686 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7687 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7688 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7689 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7690 menu_bar_items_index
= i
;
7692 Vinhibit_quit
= oquit
;
7693 return menu_bar_items_vector
;
7696 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7697 If there's already an item for KEY, add this DEF to it. */
7699 Lisp_Object item_properties
;
7702 menu_bar_item (key
, item
, dummy1
, dummy2
)
7703 Lisp_Object key
, item
, dummy1
;
7706 struct gcpro gcpro1
;
7710 if (EQ (item
, Qundefined
))
7712 /* If a map has an explicit `undefined' as definition,
7713 discard any previously made menu bar item. */
7715 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7716 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7718 if (menu_bar_items_index
> i
+ 4)
7719 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7720 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7721 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7722 menu_bar_items_index
-= 4;
7726 /* If this keymap has already contributed to this KEY,
7727 don't contribute to it a second time. */
7728 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7729 if (!NILP (tem
) || NILP (item
))
7732 menu_bar_one_keymap_changed_items
7733 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7735 /* We add to menu_bar_one_keymap_changed_items before doing the
7736 parse_menu_item, so that if it turns out it wasn't a menu item,
7737 it still correctly hides any further menu item. */
7739 i
= parse_menu_item (item
, 0, 1);
7744 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7746 /* Find any existing item for this KEY. */
7747 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7748 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7751 /* If we did not find this KEY, add it at the end. */
7752 if (i
== menu_bar_items_index
)
7754 /* If vector is too small, get a bigger one. */
7755 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7756 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7757 /* Add this item. */
7758 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7759 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7760 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7761 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7762 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7763 menu_bar_items_index
= i
;
7765 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7769 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7770 /* If the new and the old items are not both keymaps,
7771 the lookup will only find `item'. */
7772 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7773 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7777 /* This is used as the handler when calling menu_item_eval_property. */
7779 menu_item_eval_property_1 (arg
)
7782 /* If we got a quit from within the menu computation,
7783 quit all the way out of it. This takes care of C-] in the debugger. */
7784 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7785 Fsignal (Qquit
, Qnil
);
7790 /* Evaluate an expression and return the result (or nil if something
7791 went wrong). Used to evaluate dynamic parts of menu items. */
7793 menu_item_eval_property (sexpr
)
7796 int count
= SPECPDL_INDEX ();
7798 specbind (Qinhibit_redisplay
, Qt
);
7799 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7800 menu_item_eval_property_1
);
7801 return unbind_to (count
, val
);
7804 /* This function parses a menu item and leaves the result in the
7805 vector item_properties.
7806 ITEM is a key binding, a possible menu item.
7807 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7808 evaluate dynamic expressions in the menu item.
7809 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7811 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7812 parse_menu_item returns true if the item is a menu item and false
7816 parse_menu_item (item
, notreal
, inmenubar
)
7818 int notreal
, inmenubar
;
7820 Lisp_Object def
, tem
, item_string
, start
;
7821 Lisp_Object cachelist
;
7823 Lisp_Object keyhint
;
7834 /* Create item_properties vector if necessary. */
7835 if (NILP (item_properties
))
7837 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7839 /* Initialize optional entries. */
7840 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7841 ASET (item_properties
, i
, Qnil
);
7842 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7844 /* Save the item here to protect it from GC. */
7845 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7847 item_string
= XCAR (item
);
7851 if (STRINGP (item_string
))
7853 /* Old format menu item. */
7854 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7856 /* Maybe help string. */
7857 if (CONSP (item
) && STRINGP (XCAR (item
)))
7859 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7864 /* Maybe key binding cache. */
7865 if (CONSP (item
) && CONSP (XCAR (item
))
7866 && (NILP (XCAR (XCAR (item
)))
7867 || VECTORP (XCAR (XCAR (item
)))))
7869 cachelist
= XCAR (item
);
7873 /* This is the real definition--the function to run. */
7874 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7876 /* Get enable property, if any. */
7879 tem
= Fget (item
, Qmenu_enable
);
7880 if (!NILP (Venable_disabled_menus_and_buttons
))
7881 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7882 else if (!NILP (tem
))
7883 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7886 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7888 /* New format menu item. */
7889 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7890 start
= XCDR (item
);
7893 /* We have a real binding. */
7894 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7896 item
= XCDR (start
);
7897 /* Is there a cache list with key equivalences. */
7898 if (CONSP (item
) && CONSP (XCAR (item
)))
7900 cachelist
= XCAR (item
);
7904 /* Parse properties. */
7905 while (CONSP (item
) && CONSP (XCDR (item
)))
7910 if (EQ (tem
, QCenable
))
7912 if (!NILP (Venable_disabled_menus_and_buttons
))
7913 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7915 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7917 else if (EQ (tem
, QCvisible
) && !notreal
)
7919 /* If got a visible property and that evaluates to nil
7920 then ignore this item. */
7921 tem
= menu_item_eval_property (XCAR (item
));
7925 else if (EQ (tem
, QChelp
))
7926 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7927 else if (EQ (tem
, QCfilter
))
7929 else if (EQ (tem
, QCkey_sequence
))
7932 if (NILP (cachelist
)
7933 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7934 /* Be GC protected. Set keyhint to item instead of tem. */
7937 else if (EQ (tem
, QCkeys
))
7940 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7941 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7943 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7948 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7950 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7952 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7958 else if (inmenubar
|| !NILP (start
))
7962 return 0; /* not a menu item */
7964 /* If item string is not a string, evaluate it to get string.
7965 If we don't get a string, skip this item. */
7966 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7967 if (!(STRINGP (item_string
) || notreal
))
7969 item_string
= menu_item_eval_property (item_string
);
7970 if (!STRINGP (item_string
))
7972 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7975 /* If got a filter apply it on definition. */
7976 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7979 def
= menu_item_eval_property (list2 (XCAR (filter
),
7980 list2 (Qquote
, def
)));
7982 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7985 /* Enable or disable selection of item. */
7986 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7992 tem
= menu_item_eval_property (tem
);
7993 if (inmenubar
&& NILP (tem
))
7994 return 0; /* Ignore disabled items in menu bar. */
7995 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7998 /* If we got no definition, this item is just unselectable text which
7999 is OK in a submenu but not in the menubar. */
8001 return (inmenubar
? 0 : 1);
8003 /* See if this is a separate pane or a submenu. */
8004 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8005 tem
= get_keymap (def
, 0, 1);
8006 /* For a subkeymap, just record its details and exit. */
8009 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
8010 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
8014 /* At the top level in the menu bar, do likewise for commands also.
8015 The menu bar does not display equivalent key bindings anyway.
8016 ITEM_PROPERTY_DEF is already set up properly. */
8020 /* This is a command. See if there is an equivalent key binding. */
8021 if (NILP (cachelist
))
8023 /* We have to create a cachelist. */
8024 CHECK_IMPURE (start
);
8025 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
8026 cachelist
= XCAR (XCDR (start
));
8028 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8029 if (!NILP (keyhint
))
8031 XSETCAR (cachelist
, XCAR (keyhint
));
8034 else if (STRINGP (tem
))
8036 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
8037 XSETCAR (cachelist
, Qt
);
8041 tem
= XCAR (cachelist
);
8048 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
8050 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
8053 def
= XCAR (prefix
);
8054 prefix
= XCDR (prefix
);
8057 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
8059 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
8061 if (newcache
/* Always check first time. */
8062 /* Should we check everything when precomputing key
8064 /* If something had no key binding before, don't recheck it
8065 because that is too slow--except if we have a list of
8066 rebound commands in Vdefine_key_rebound_commands, do
8067 recheck any command that appears in that list. */
8068 || (CONSP (Vdefine_key_rebound_commands
)
8069 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
8072 /* We had a saved key. Is it still bound to the command? */
8075 /* If the command is an alias for another
8076 (such as lmenu.el set it up), check if the
8077 original command matches the cached command. */
8078 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8079 chkcache
= 1; /* Need to recompute key binding. */
8083 /* Recompute equivalent key binding. If the command is an alias
8084 for another (such as lmenu.el set it up), see if the original
8085 command name has equivalent keys. Otherwise look up the
8086 specified command itself. We don't try both, because that
8087 makes lmenu menus slow. */
8089 && SYMBOLP (XSYMBOL (def
)->function
)
8090 && ! NILP (Fget (def
, Qmenu_alias
)))
8091 def
= XSYMBOL (def
)->function
;
8092 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8093 XSETCAR (cachelist
, tem
);
8096 XSETCDR (cachelist
, Qnil
);
8100 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8102 tem
= XCAR (cachelist
);
8106 newcache
= chkcache
;
8109 tem
= Fkey_description (tem
, Qnil
);
8112 if (STRINGP (XCAR (prefix
)))
8113 tem
= concat2 (XCAR (prefix
), tem
);
8114 if (STRINGP (XCDR (prefix
)))
8115 tem
= concat2 (tem
, XCDR (prefix
));
8117 XSETCDR (cachelist
, tem
);
8121 tem
= XCDR (cachelist
);
8122 if (newcache
&& !NILP (tem
))
8124 tem
= concat2 (build_string (" "), tem
);
8125 // tem = concat3 (build_string (" ("), tem, build_string (")"));
8126 XSETCDR (cachelist
, tem
);
8129 /* If we only want to precompute equivalent key bindings, stop here. */
8133 /* If we have an equivalent key binding, use that. */
8134 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8136 /* Include this when menu help is implemented.
8137 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8138 if (!(NILP (tem) || STRINGP (tem)))
8140 tem = menu_item_eval_property (tem);
8143 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8147 /* Handle radio buttons or toggle boxes. */
8148 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8150 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8151 menu_item_eval_property (tem
));
8158 /***********************************************************************
8160 ***********************************************************************/
8162 /* A vector holding tool bar items while they are parsed in function
8163 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8166 static Lisp_Object tool_bar_items_vector
;
8168 /* A vector holding the result of parse_tool_bar_item. Layout is like
8169 the one for a single item in tool_bar_items_vector. */
8171 static Lisp_Object tool_bar_item_properties
;
8173 /* Next free index in tool_bar_items_vector. */
8175 static int ntool_bar_items
;
8177 /* The symbols `tool-bar', `:image' and `:rtl'. */
8179 extern Lisp_Object Qtool_bar
;
8180 Lisp_Object QCimage
;
8183 /* Function prototypes. */
8185 static void init_tool_bar_items
P_ ((Lisp_Object
));
8186 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8187 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8188 static void append_tool_bar_item
P_ ((void));
8191 /* Return a vector of tool bar items for keymaps currently in effect.
8192 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8193 tool bar items found. */
8196 tool_bar_items (reuse
, nitems
)
8207 /* In order to build the menus, we need to call the keymap
8208 accessors. They all call QUIT. But this function is called
8209 during redisplay, during which a quit is fatal. So inhibit
8210 quitting while building the menus. We do this instead of
8211 specbind because (1) errors will clear it anyway and (2) this
8212 avoids risk of specpdl overflow. */
8213 oquit
= Vinhibit_quit
;
8216 /* Initialize tool_bar_items_vector and protect it from GC. */
8217 init_tool_bar_items (reuse
);
8219 /* Build list of keymaps in maps. Set nmaps to the number of maps
8222 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8223 if (!NILP (Voverriding_local_map_menu_flag
))
8225 /* Yes, use them (if non-nil) as well as the global map. */
8226 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8228 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8229 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8230 if (!NILP (Voverriding_local_map
))
8231 maps
[nmaps
++] = Voverriding_local_map
;
8235 /* No, so use major and minor mode keymaps and keymap property.
8236 Note that tool-bar bindings in the local-map and keymap
8237 properties may not work reliable, as they are only
8238 recognized when the tool-bar (or mode-line) is updated,
8239 which does not normally happen after every command. */
8242 nminor
= current_minor_maps (NULL
, &tmaps
);
8243 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8245 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8246 maps
[nmaps
++] = tem
;
8247 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8249 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8252 /* Add global keymap at the end. */
8253 maps
[nmaps
++] = current_global_map
;
8255 /* Process maps in reverse order and look up in each map the prefix
8257 for (i
= nmaps
- 1; i
>= 0; --i
)
8258 if (!NILP (maps
[i
]))
8262 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8264 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8267 Vinhibit_quit
= oquit
;
8268 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8269 return tool_bar_items_vector
;
8273 /* Process the definition of KEY which is DEF. */
8276 process_tool_bar_item (key
, def
, data
, args
)
8277 Lisp_Object key
, def
, data
;
8281 extern Lisp_Object Qundefined
;
8282 struct gcpro gcpro1
, gcpro2
;
8284 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8288 if (EQ (def
, Qundefined
))
8290 /* If a map has an explicit `undefined' as definition,
8291 discard any previously made item. */
8292 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8294 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8296 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8298 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8299 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8300 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8301 * sizeof (Lisp_Object
)));
8302 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8307 else if (parse_tool_bar_item (key
, def
))
8308 /* Append a new tool bar item to tool_bar_items_vector. Accept
8309 more than one definition for the same key. */
8310 append_tool_bar_item ();
8316 /* Parse a tool bar item specification ITEM for key KEY and return the
8317 result in tool_bar_item_properties. Value is zero if ITEM is
8320 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8322 CAPTION is the caption of the item, If it's not a string, it is
8323 evaluated to get a string.
8325 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8326 as binding are currently ignored.
8328 The following properties are recognized:
8332 FORM is evaluated and specifies whether the tool bar item is
8333 enabled or disabled.
8337 FORM is evaluated and specifies whether the tool bar item is visible.
8339 - `:filter FUNCTION'
8341 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8342 result is stored as the new binding.
8344 - `:button (TYPE SELECTED)'
8346 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8347 and specifies whether the button is selected (pressed) or not.
8351 IMAGES is either a single image specification or a vector of four
8352 image specifications. See enum tool_bar_item_images.
8354 - `:help HELP-STRING'.
8356 Gives a help string to display for the tool bar item. */
8359 parse_tool_bar_item (key
, item
)
8360 Lisp_Object key
, item
;
8362 /* Access slot with index IDX of vector tool_bar_item_properties. */
8363 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8365 Lisp_Object filter
= Qnil
;
8366 Lisp_Object caption
;
8369 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8370 Rule out items that aren't lists, don't start with
8371 `menu-item' or whose rest following `tool-bar-item' is not a
8374 || !EQ (XCAR (item
), Qmenu_item
)
8375 || (item
= XCDR (item
),
8379 /* Create tool_bar_item_properties vector if necessary. Reset it to
8381 if (VECTORP (tool_bar_item_properties
))
8383 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8387 tool_bar_item_properties
8388 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8391 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8392 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8394 /* Get the caption of the item. If the caption is not a string,
8395 evaluate it to get a string. If we don't get a string, skip this
8397 caption
= XCAR (item
);
8398 if (!STRINGP (caption
))
8400 caption
= menu_item_eval_property (caption
);
8401 if (!STRINGP (caption
))
8404 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8406 /* Give up if rest following the caption is not a list. */
8411 /* Store the binding. */
8412 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8415 /* Ignore cached key binding, if any. */
8416 if (CONSP (item
) && CONSP (XCAR (item
)))
8419 /* Process the rest of the properties. */
8420 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8422 Lisp_Object key
, value
;
8425 value
= XCAR (XCDR (item
));
8427 if (EQ (key
, QCenable
))
8429 /* `:enable FORM'. */
8430 if (!NILP (Venable_disabled_menus_and_buttons
))
8431 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8433 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8435 else if (EQ (key
, QCvisible
))
8437 /* `:visible FORM'. If got a visible property and that
8438 evaluates to nil then ignore this item. */
8439 if (NILP (menu_item_eval_property (value
)))
8442 else if (EQ (key
, QChelp
))
8443 /* `:help HELP-STRING'. */
8444 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8445 else if (EQ (key
, QCfilter
))
8446 /* ':filter FORM'. */
8448 else if (EQ (key
, QCbutton
) && CONSP (value
))
8450 /* `:button (TYPE . SELECTED)'. */
8451 Lisp_Object type
, selected
;
8453 type
= XCAR (value
);
8454 selected
= XCDR (value
);
8455 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8457 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8458 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8461 else if (EQ (key
, QCimage
)
8463 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8464 /* Value is either a single image specification or a vector
8465 of 4 such specifications for the different button states. */
8466 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8467 else if (EQ (key
, Qrtl
))
8469 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8472 /* If got a filter apply it on binding. */
8474 PROP (TOOL_BAR_ITEM_BINDING
)
8475 = menu_item_eval_property (list2 (filter
,
8477 PROP (TOOL_BAR_ITEM_BINDING
))));
8479 /* See if the binding is a keymap. Give up if it is. */
8480 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8483 /* Enable or disable selection of item. */
8484 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8485 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8486 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8488 /* Handle radio buttons or toggle boxes. */
8489 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8490 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8491 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8499 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8500 that can be reused. */
8503 init_tool_bar_items (reuse
)
8506 if (VECTORP (reuse
))
8507 tool_bar_items_vector
= reuse
;
8509 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8510 ntool_bar_items
= 0;
8514 /* Append parsed tool bar item properties from
8515 tool_bar_item_properties */
8518 append_tool_bar_item ()
8520 Lisp_Object
*to
, *from
;
8522 /* Enlarge tool_bar_items_vector if necessary. */
8523 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8524 >= XVECTOR (tool_bar_items_vector
)->size
)
8525 tool_bar_items_vector
8526 = larger_vector (tool_bar_items_vector
,
8527 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8529 /* Append entries from tool_bar_item_properties to the end of
8530 tool_bar_items_vector. */
8531 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8532 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8533 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8534 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8541 /* Read a character using menus based on maps in the array MAPS.
8542 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8543 Return t if we displayed a menu but the user rejected it.
8545 PREV_EVENT is the previous input event, or nil if we are reading
8546 the first event of a key sequence.
8548 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8549 if we used a mouse menu to read the input, or zero otherwise. If
8550 USED_MOUSE_MENU is null, we don't dereference it.
8552 The prompting is done based on the prompt-string of the map
8553 and the strings associated with various map elements.
8555 This can be done with X menus or with menus put in the minibuf.
8556 These are done in different ways, depending on how the input will be read.
8557 Menus using X are done after auto-saving in read-char, getting the input
8558 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8559 and do auto-saving in the inner call of read_char. */
8562 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8565 Lisp_Object prev_event
;
8566 int *used_mouse_menu
;
8569 register Lisp_Object name
= Qnil
;
8571 if (used_mouse_menu
)
8572 *used_mouse_menu
= 0;
8574 /* Use local over global Menu maps */
8576 if (! menu_prompting
)
8579 /* Optionally disregard all but the global map. */
8580 if (inhibit_local_menu_bar_menus
)
8582 maps
+= (nmaps
- 1);
8586 /* Get the menu name from the first map that has one (a prompt string). */
8587 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8589 name
= Fkeymap_prompt (maps
[mapno
]);
8594 /* If we don't have any menus, just read a character normally. */
8595 if (!STRINGP (name
))
8599 /* If we got to this point via a mouse click,
8600 use a real menu for mouse selection. */
8601 if (EVENT_HAS_PARAMETERS (prev_event
)
8602 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8603 && !EQ (XCAR (prev_event
), Qtool_bar
))
8605 /* Display the menu and get the selection. */
8606 Lisp_Object
*realmaps
8607 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8611 /* Use the maps that are not nil. */
8612 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8613 if (!NILP (maps
[mapno
]))
8614 realmaps
[nmaps1
++] = maps
[mapno
];
8616 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8621 record_menu_key (XCAR (value
));
8623 /* If we got multiple events, unread all but
8625 There is no way to prevent those unread events
8626 from showing up later in last_nonmenu_event.
8627 So turn symbol and integer events into lists,
8628 to indicate that they came from a mouse menu,
8629 so that when present in last_nonmenu_event
8630 they won't confuse things. */
8631 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8633 record_menu_key (XCAR (tem
));
8634 if (SYMBOLP (XCAR (tem
))
8635 || INTEGERP (XCAR (tem
)))
8636 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8639 /* If we got more than one event, put all but the first
8640 onto this list to be read later.
8641 Return just the first event now. */
8642 Vunread_command_events
8643 = nconc2 (XCDR (value
), Vunread_command_events
);
8644 value
= XCAR (value
);
8646 else if (NILP (value
))
8648 if (used_mouse_menu
)
8649 *used_mouse_menu
= 1;
8652 #endif /* HAVE_MENUS */
8656 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8657 We make this bigger when necessary, and never free it. */
8658 static char *read_char_minibuf_menu_text
;
8659 /* Size of that buffer. */
8660 static int read_char_minibuf_menu_width
;
8663 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8669 register Lisp_Object name
;
8671 /* FIXME: Use the minibuffer's frame width. */
8672 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8675 Lisp_Object rest
, vector
;
8681 if (! menu_prompting
)
8684 /* Make sure we have a big enough buffer for the menu text. */
8685 if (read_char_minibuf_menu_text
== 0)
8687 read_char_minibuf_menu_width
= width
+ 4;
8688 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8690 else if (width
+ 4 > read_char_minibuf_menu_width
)
8692 read_char_minibuf_menu_width
= width
+ 4;
8693 read_char_minibuf_menu_text
8694 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8696 menu
= read_char_minibuf_menu_text
;
8698 /* Get the menu name from the first map that has one (a prompt string). */
8699 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8701 name
= Fkeymap_prompt (maps
[mapno
]);
8706 /* If we don't have any menus, just read a character normally. */
8707 if (!STRINGP (name
))
8710 /* Prompt string always starts with map's prompt, and a space. */
8711 strcpy (menu
, SDATA (name
));
8712 nlength
= SBYTES (name
);
8713 menu
[nlength
++] = ':';
8714 menu
[nlength
++] = ' ';
8717 /* Start prompting at start of first map. */
8721 /* Present the documented bindings, a line at a time. */
8728 Lisp_Object orig_defn_macro
;
8730 /* Loop over elements of map. */
8735 /* If reached end of map, start at beginning of next map. */
8739 /* At end of last map, wrap around to first map if just starting,
8740 or end this line if already have something on it. */
8744 if (notfirst
|| nobindings
) break;
8749 /* Look at the next element of the map. */
8751 elt
= XVECTOR (vector
)->contents
[idx
];
8753 elt
= Fcar_safe (rest
);
8755 if (idx
< 0 && VECTORP (elt
))
8757 /* If we found a dense table in the keymap,
8758 advanced past it, but start scanning its contents. */
8759 rest
= Fcdr_safe (rest
);
8765 /* An ordinary element. */
8766 Lisp_Object event
, tem
;
8770 event
= Fcar_safe (elt
); /* alist */
8771 elt
= Fcdr_safe (elt
);
8775 XSETINT (event
, idx
); /* vector */
8778 /* Ignore the element if it has no prompt string. */
8779 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8781 /* 1 if the char to type matches the string. */
8783 Lisp_Object upcased_event
, downcased_event
;
8784 Lisp_Object desc
= Qnil
;
8786 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8788 upcased_event
= Fupcase (event
);
8789 downcased_event
= Fdowncase (event
);
8790 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8791 || XINT (downcased_event
) == SREF (s
, 0));
8793 desc
= Fsingle_key_description (event
, Qnil
);
8795 #if 0 /* It is redundant to list the equivalent key bindings because
8796 the prefix is what the user has already typed. */
8798 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8800 /* Insert equivalent keybinding. */
8801 s
= concat2 (s
, tem
);
8804 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8805 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8807 /* Insert button prefix. */
8808 Lisp_Object selected
8809 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8810 if (EQ (tem
, QCradio
))
8811 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8813 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8814 s
= concat2 (tem
, s
);
8818 /* If we have room for the prompt string, add it to this line.
8819 If this is the first on the line, always add it. */
8820 if ((SCHARS (s
) + i
+ 2
8821 + (char_matches
? 0 : SCHARS (desc
) + 3))
8827 /* Punctuate between strings. */
8830 strcpy (menu
+ i
, ", ");
8836 /* If the char to type doesn't match the string's
8837 first char, explicitly show what char to type. */
8840 /* Add as much of string as fits. */
8841 thiswidth
= SCHARS (desc
);
8842 if (thiswidth
+ i
> width
)
8843 thiswidth
= width
- i
;
8844 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8846 strcpy (menu
+ i
, " = ");
8850 /* Add as much of string as fits. */
8851 thiswidth
= SCHARS (s
);
8852 if (thiswidth
+ i
> width
)
8853 thiswidth
= width
- i
;
8854 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8860 /* If this element does not fit, end the line now,
8861 and save the element for the next line. */
8862 strcpy (menu
+ i
, "...");
8867 /* Move past this element. */
8868 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8869 /* Handle reaching end of dense table. */
8874 rest
= Fcdr_safe (rest
);
8878 /* Prompt with that and read response. */
8879 message2_nolog (menu
, strlen (menu
),
8880 ! NILP (current_buffer
->enable_multibyte_characters
));
8882 /* Make believe its not a keyboard macro in case the help char
8883 is pressed. Help characters are not recorded because menu prompting
8884 is not used on replay.
8886 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8887 current_kboard
->defining_kbd_macro
= Qnil
;
8889 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8890 while (BUFFERP (obj
));
8891 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8893 if (!INTEGERP (obj
))
8895 else if (XINT (obj
) == -2)
8900 if (! EQ (obj
, menu_prompt_more_char
)
8901 && (!INTEGERP (menu_prompt_more_char
)
8902 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8904 if (!NILP (current_kboard
->defining_kbd_macro
))
8905 store_kbd_macro_char (obj
);
8908 /* Help char - go round again */
8912 /* Reading key sequences. */
8914 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8915 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8916 keymap, or nil otherwise. Return the index of the first keymap in
8917 which KEY has any binding, or NMAPS if no map has a binding.
8919 If KEY is a meta ASCII character, treat it like meta-prefix-char
8920 followed by the corresponding non-meta character. Keymaps in
8921 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8924 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8927 NEXT may be the same array as CURRENT. */
8930 follow_key (key
, nmaps
, current
, defs
, next
)
8932 Lisp_Object
*current
, *defs
, *next
;
8935 int i
, first_binding
;
8937 first_binding
= nmaps
;
8938 for (i
= nmaps
- 1; i
>= 0; i
--)
8940 if (! NILP (current
[i
]))
8942 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8943 if (! NILP (defs
[i
]))
8950 /* Given the set of bindings we've found, produce the next set of maps. */
8951 if (first_binding
< nmaps
)
8952 for (i
= 0; i
< nmaps
; i
++)
8953 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8955 return first_binding
;
8958 /* Structure used to keep track of partial application of key remapping
8959 such as Vfunction_key_map and Vkey_translation_map. */
8960 typedef struct keyremap
8962 /* This is the map originally specified for this use. */
8964 /* This is a submap reached by looking up, in PARENT,
8965 the events from START to END. */
8967 /* Positions [START, END) in the key sequence buffer
8968 are the key that we have scanned so far.
8969 Those events are the ones that we will replace
8970 if PAREHT maps them into a key sequence. */
8974 /* Lookup KEY in MAP.
8975 MAP is a keymap mapping keys to key vectors or functions.
8976 If the mapping is a function and DO_FUNCTION is non-zero, then
8977 the function is called with PROMPT as parameter and its return
8978 value is used as the return value of this function (after checking
8979 that it is indeed a vector). */
8982 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8983 Lisp_Object map
, key
, prompt
;
8988 next
= access_keymap (map
, key
, 1, 0, 1);
8990 /* Handle symbol with autoload definition. */
8991 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8992 && CONSP (XSYMBOL (next
)->function
)
8993 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8994 do_autoload (XSYMBOL (next
)->function
, next
);
8996 /* Handle a symbol whose function definition is a keymap
8998 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8999 && (ARRAYP (XSYMBOL (next
)->function
)
9000 || KEYMAPP (XSYMBOL (next
)->function
)))
9001 next
= XSYMBOL (next
)->function
;
9003 /* If the keymap gives a function, not an
9004 array, then call the function with one arg and use
9005 its value instead. */
9006 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
9011 next
= call1 (next
, prompt
);
9012 /* If the function returned something invalid,
9013 barf--don't ignore it.
9014 (To ignore it safely, we would need to gcpro a bunch of
9015 other variables.) */
9016 if (! (VECTORP (next
) || STRINGP (next
)))
9017 error ("Function %s returns invalid key sequence", tem
);
9022 /* Do one step of the key remapping used for function-key-map and
9023 key-translation-map:
9024 KEYBUF is the buffer holding the input events.
9025 BUFSIZE is its maximum size.
9026 FKEY is a pointer to the keyremap structure to use.
9027 INPUT is the index of the last element in KEYBUF.
9028 DOIT if non-zero says that the remapping can actually take place.
9029 DIFF is used to return the number of keys added/removed by the remapping.
9030 PARENT is the root of the keymap.
9031 PROMPT is the prompt to use if the remapping happens through a function.
9032 The return value is non-zero if the remapping actually took place. */
9035 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
9036 Lisp_Object
*keybuf
, prompt
;
9038 int input
, doit
, *diff
, bufsize
;
9040 Lisp_Object next
, key
;
9042 key
= keybuf
[fkey
->end
++];
9044 if (KEYMAPP (fkey
->parent
))
9045 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
9049 /* If keybuf[fkey->start..fkey->end] is bound in the
9050 map and we're in a position to do the key remapping, replace it with
9051 the binding and restart with fkey->start at the end. */
9052 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
9054 int len
= XFASTINT (Flength (next
));
9057 *diff
= len
- (fkey
->end
- fkey
->start
);
9059 if (input
+ *diff
>= bufsize
)
9060 error ("Key sequence too long");
9062 /* Shift the keys that follow fkey->end. */
9064 for (i
= fkey
->end
; i
< input
; i
++)
9065 keybuf
[i
+ *diff
] = keybuf
[i
];
9067 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9068 keybuf
[i
+ *diff
] = keybuf
[i
];
9069 /* Overwrite the old keys with the new ones. */
9070 for (i
= 0; i
< len
; i
++)
9071 keybuf
[fkey
->start
+ i
]
9072 = Faref (next
, make_number (i
));
9074 fkey
->start
= fkey
->end
+= *diff
;
9075 fkey
->map
= fkey
->parent
;
9080 fkey
->map
= get_keymap (next
, 0, 1);
9082 /* If we no longer have a bound suffix, try a new position for
9084 if (!CONSP (fkey
->map
))
9086 fkey
->end
= ++fkey
->start
;
9087 fkey
->map
= fkey
->parent
;
9092 /* Read a sequence of keys that ends with a non prefix character,
9093 storing it in KEYBUF, a buffer of size BUFSIZE.
9095 Return the length of the key sequence stored.
9096 Return -1 if the user rejected a command menu.
9098 Echo starting immediately unless `prompt' is 0.
9100 Where a key sequence ends depends on the currently active keymaps.
9101 These include any minor mode keymaps active in the current buffer,
9102 the current buffer's local map, and the global map.
9104 If a key sequence has no other bindings, we check Vfunction_key_map
9105 to see if some trailing subsequence might be the beginning of a
9106 function key's sequence. If so, we try to read the whole function
9107 key, and substitute its symbolic name into the key sequence.
9109 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9110 `double-' events into similar click events, if that would make them
9111 bound. We try to turn `triple-' events first into `double-' events,
9114 If we get a mouse click in a mode line, vertical divider, or other
9115 non-text area, we treat the click as if it were prefixed by the
9116 symbol denoting that area - `mode-line', `vertical-line', or
9119 If the sequence starts with a mouse click, we read the key sequence
9120 with respect to the buffer clicked on, not the current buffer.
9122 If the user switches frames in the midst of a key sequence, we put
9123 off the switch-frame event until later; the next call to
9124 read_char will return it.
9126 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9127 from the selected window's buffer. */
9130 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9131 can_return_switch_frame
, fix_current_buffer
)
9132 Lisp_Object
*keybuf
;
9135 int dont_downcase_last
;
9136 int can_return_switch_frame
;
9137 int fix_current_buffer
;
9139 volatile Lisp_Object from_string
;
9140 volatile int count
= SPECPDL_INDEX ();
9142 /* How many keys there are in the current key sequence. */
9145 /* The length of the echo buffer when we started reading, and
9146 the length of this_command_keys when we started reading. */
9147 volatile int echo_start
;
9148 volatile int keys_start
;
9150 /* The number of keymaps we're scanning right now, and the number of
9151 keymaps we have allocated space for. */
9153 volatile int nmaps_allocated
= 0;
9155 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9156 the current keymaps. */
9157 Lisp_Object
*volatile defs
= NULL
;
9159 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9160 in the current keymaps, or nil where it is not a prefix. */
9161 Lisp_Object
*volatile submaps
= NULL
;
9163 /* The local map to start out with at start of key sequence. */
9164 volatile Lisp_Object orig_local_map
;
9166 /* The map from the `keymap' property to start out with at start of
9168 volatile Lisp_Object orig_keymap
;
9170 /* 1 if we have already considered switching to the local-map property
9171 of the place where a mouse click occurred. */
9172 volatile int localized_local_map
= 0;
9174 /* The index in submaps[] of the first keymap that has a binding for
9175 this key sequence. In other words, the lowest i such that
9176 submaps[i] is non-nil. */
9177 volatile int first_binding
;
9178 /* Index of the first key that has no binding.
9179 It is useless to try fkey.start larger than that. */
9180 volatile int first_unbound
;
9182 /* If t < mock_input, then KEYBUF[t] should be read as the next
9185 We use this to recover after recognizing a function key. Once we
9186 realize that a suffix of the current key sequence is actually a
9187 function key's escape sequence, we replace the suffix with the
9188 function key's binding from Vfunction_key_map. Now keybuf
9189 contains a new and different key sequence, so the echo area,
9190 this_command_keys, and the submaps and defs arrays are wrong. In
9191 this situation, we set mock_input to t, set t to 0, and jump to
9192 restart_sequence; the loop will read keys from keybuf up until
9193 mock_input, thus rebuilding the state; and then it will resume
9194 reading characters from the keyboard. */
9195 volatile int mock_input
= 0;
9197 /* If the sequence is unbound in submaps[], then
9198 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9199 and fkey.map is its binding.
9201 These might be > t, indicating that all function key scanning
9202 should hold off until t reaches them. We do this when we've just
9203 recognized a function key, to avoid searching for the function
9204 key's again in Vfunction_key_map. */
9205 volatile keyremap fkey
;
9207 /* Likewise, for key_translation_map and input-decode-map. */
9208 volatile keyremap keytran
, indec
;
9210 /* Non-zero if we are trying to map a key by changing an upper-case
9211 letter to lower case, or a shifted function key to an unshifted
9213 volatile int shift_translated
= 0;
9215 /* If we receive a `switch-frame' or `select-window' event in the middle of
9216 a key sequence, we put it off for later.
9217 While we're reading, we keep the event here. */
9218 volatile Lisp_Object delayed_switch_frame
;
9220 /* See the comment below... */
9221 #if defined (GOBBLE_FIRST_EVENT)
9222 Lisp_Object first_event
;
9225 volatile Lisp_Object original_uppercase
;
9226 volatile int original_uppercase_position
= -1;
9228 /* Gets around Microsoft compiler limitations. */
9231 struct buffer
*starting_buffer
;
9233 /* List of events for which a fake prefix key has been generated. */
9234 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9236 #if defined (GOBBLE_FIRST_EVENT)
9240 struct gcpro gcpro1
;
9242 GCPRO1 (fake_prefixed_keys
);
9243 raw_keybuf_count
= 0;
9245 last_nonmenu_event
= Qnil
;
9247 delayed_switch_frame
= Qnil
;
9252 echo_prompt (prompt
);
9253 else if (cursor_in_echo_area
9254 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9255 && NILP (Fzerop (Vecho_keystrokes
)))
9256 /* This doesn't put in a dash if the echo buffer is empty, so
9257 you don't always see a dash hanging out in the minibuffer. */
9261 /* Record the initial state of the echo area and this_command_keys;
9262 we will need to restore them if we replay a key sequence. */
9264 echo_start
= echo_length ();
9265 keys_start
= this_command_key_count
;
9266 this_single_command_key_start
= keys_start
;
9268 #if defined (GOBBLE_FIRST_EVENT)
9269 /* This doesn't quite work, because some of the things that read_char
9270 does cannot safely be bypassed. It seems too risky to try to make
9273 /* Read the first char of the sequence specially, before setting
9274 up any keymaps, in case a filter runs and switches buffers on us. */
9275 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9277 #endif /* GOBBLE_FIRST_EVENT */
9279 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9280 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9283 /* The multi-tty merge moved the code below to right after
9284 `replay_sequence' which caused all these translation maps to be applied
9285 repeatedly, even tho their doc says very clearly they are not applied to
9287 The reason for this move was: "We may switch keyboards between rescans,
9288 so we need to reinitialize fkey and keytran before each replay".
9289 This move was wrong (even if we switch keyboards, keybuf still holds the
9290 keys we've read already from the original keyboard and some of those keys
9291 may have already been translated). So there may still be a bug out there
9293 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9294 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9295 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9296 indec
.start
= indec
.end
= 0;
9297 fkey
.start
= fkey
.end
= 0;
9298 keytran
.start
= keytran
.end
= 0;
9300 /* We jump here when the key sequence has been thoroughly changed, and
9301 we need to rescan it starting from the beginning. When we jump here,
9302 keybuf[0..mock_input] holds the sequence we should reread. */
9305 starting_buffer
= current_buffer
;
9306 first_unbound
= bufsize
+ 1;
9308 /* Build our list of keymaps.
9309 If we recognize a function key and replace its escape sequence in
9310 keybuf with its symbol, or if the sequence starts with a mouse
9311 click and we need to switch buffers, we jump back here to rebuild
9312 the initial keymaps from the current buffer. */
9315 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9317 if (2 > nmaps_allocated
)
9319 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9320 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9321 nmaps_allocated
= 2;
9323 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9324 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9326 else if (!NILP (Voverriding_local_map
))
9328 if (2 > nmaps_allocated
)
9330 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9331 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9332 nmaps_allocated
= 2;
9334 if (!NILP (Voverriding_local_map
))
9335 submaps
[nmaps
++] = Voverriding_local_map
;
9343 nminor
= current_minor_maps (0, &maps
);
9344 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9346 if (total
> nmaps_allocated
)
9348 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9349 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9350 nmaps_allocated
= total
;
9353 if (!NILP (orig_keymap
))
9354 submaps
[nmaps
++] = orig_keymap
;
9356 bcopy (maps
, (void *) (submaps
+ nmaps
),
9357 nminor
* sizeof (submaps
[0]));
9361 submaps
[nmaps
++] = orig_local_map
;
9363 submaps
[nmaps
++] = current_global_map
;
9365 /* Find an accurate initial value for first_binding. */
9366 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9367 if (! NILP (submaps
[first_binding
]))
9370 /* Start from the beginning in keybuf. */
9373 /* These are no-ops the first time through, but if we restart, they
9374 revert the echo area and this_command_keys to their original state. */
9375 this_command_key_count
= keys_start
;
9376 if (INTERACTIVE
&& t
< mock_input
)
9377 echo_truncate (echo_start
);
9379 /* If the best binding for the current key sequence is a keymap, or
9380 we may be looking at a function key's escape sequence, keep on
9382 while (first_binding
< nmaps
9383 /* Keep reading as long as there's a prefix binding. */
9384 ? !NILP (submaps
[first_binding
])
9385 /* Don't return in the middle of a possible function key sequence,
9386 if the only bindings we found were via case conversion.
9387 Thus, if ESC O a has a function-key-map translation
9388 and ESC o has a binding, don't return after ESC O,
9389 so that we can translate ESC O plus the next character. */
9390 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9393 int used_mouse_menu
= 0;
9395 /* Where the last real key started. If we need to throw away a
9396 key that has expanded into more than one element of keybuf
9397 (say, a mouse click on the mode line which is being treated
9398 as [mode-line (mouse-...)], then we backtrack to this point
9400 volatile int last_real_key_start
;
9402 /* These variables are analogous to echo_start and keys_start;
9403 while those allow us to restart the entire key sequence,
9404 echo_local_start and keys_local_start allow us to throw away
9406 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9408 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9409 eassert (indec
.start
<= indec
.end
);
9410 eassert (fkey
.start
<= fkey
.end
);
9411 eassert (keytran
.start
<= keytran
.end
);
9412 /* key-translation-map is applied *after* function-key-map
9413 which is itself applied *after* input-decode-map. */
9414 eassert (fkey
.end
<= indec
.start
);
9415 eassert (keytran
.end
<= fkey
.start
);
9417 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9418 first_unbound
< keytran
.start
)
9419 { /* The prefix upto first_unbound has no binding and has
9420 no translation left to do either, so we know it's unbound.
9421 If we don't stop now, we risk staying here indefinitely
9422 (if the user keeps entering fkey or keytran prefixes
9423 like C-c ESC ESC ESC ESC ...) */
9425 for (i
= first_unbound
+ 1; i
< t
; i
++)
9426 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9427 mock_input
= t
- first_unbound
- 1;
9428 indec
.end
= indec
.start
-= first_unbound
+ 1;
9429 indec
.map
= indec
.parent
;
9430 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9431 fkey
.map
= fkey
.parent
;
9432 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9433 keytran
.map
= keytran
.parent
;
9434 goto replay_sequence
;
9438 error ("Key sequence too long");
9441 echo_local_start
= echo_length ();
9442 keys_local_start
= this_command_key_count
;
9443 local_first_binding
= first_binding
;
9446 /* These are no-ops, unless we throw away a keystroke below and
9447 jumped back up to replay_key; in that case, these restore the
9448 variables to their original state, allowing us to replay the
9450 if (INTERACTIVE
&& t
< mock_input
)
9451 echo_truncate (echo_local_start
);
9452 this_command_key_count
= keys_local_start
;
9453 first_binding
= local_first_binding
;
9455 /* By default, assume each event is "real". */
9456 last_real_key_start
= t
;
9458 /* Does mock_input indicate that we are re-reading a key sequence? */
9462 add_command_key (key
);
9463 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9464 && NILP (Fzerop (Vecho_keystrokes
)))
9468 /* If not, we should actually read a character. */
9473 KBOARD
*interrupted_kboard
= current_kboard
;
9474 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9476 key
= read_char (NILP (prompt
), nmaps
,
9477 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9478 &used_mouse_menu
, NULL
);
9480 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9485 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9486 if (k
== interrupted_kboard
)
9491 /* Don't touch interrupted_kboard when it's been
9493 delayed_switch_frame
= Qnil
;
9494 goto replay_sequence
;
9497 if (!NILP (delayed_switch_frame
))
9499 interrupted_kboard
->kbd_queue
9500 = Fcons (delayed_switch_frame
,
9501 interrupted_kboard
->kbd_queue
);
9502 delayed_switch_frame
= Qnil
;
9506 interrupted_kboard
->kbd_queue
9507 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9509 /* If the side queue is non-empty, ensure it begins with a
9510 switch-frame, so we'll replay it in the right context. */
9511 if (CONSP (interrupted_kboard
->kbd_queue
)
9512 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9513 !(EVENT_HAS_PARAMETERS (key
)
9514 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9518 XSETFRAME (frame
, interrupted_frame
);
9519 interrupted_kboard
->kbd_queue
9520 = Fcons (make_lispy_switch_frame (frame
),
9521 interrupted_kboard
->kbd_queue
);
9524 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9525 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9526 goto replay_sequence
;
9531 /* read_char returns t when it shows a menu and the user rejects it.
9535 unbind_to (count
, Qnil
);
9540 /* read_char returns -1 at the end of a macro.
9541 Emacs 18 handles this by returning immediately with a
9542 zero, so that's what we'll do. */
9543 if (INTEGERP (key
) && XINT (key
) == -1)
9546 /* The Microsoft C compiler can't handle the goto that
9552 /* If the current buffer has been changed from under us, the
9553 keymap may have changed, so replay the sequence. */
9556 timer_resume_idle ();
9559 /* Reset the current buffer from the selected window
9560 in case something changed the former and not the latter.
9561 This is to be more consistent with the behavior
9562 of the command_loop_1. */
9563 if (fix_current_buffer
)
9565 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9567 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9568 Fset_buffer (XWINDOW (selected_window
)->buffer
);
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
;
9576 /* If we have a quit that was typed in another frame, and
9577 quit_throw_to_read_char switched buffers,
9578 replay to get the right keymap. */
9580 && XINT (key
) == quit_char
9581 && current_buffer
!= starting_buffer
)
9584 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9588 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9589 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9590 goto replay_sequence
;
9595 if (EVENT_HAS_PARAMETERS (key
)
9596 /* Either a `switch-frame' or a `select-window' event. */
9597 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9599 /* If we're at the beginning of a key sequence, and the caller
9600 says it's okay, go ahead and return this event. If we're
9601 in the midst of a key sequence, delay it until the end. */
9602 if (t
> 0 || !can_return_switch_frame
)
9604 delayed_switch_frame
= key
;
9610 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9614 /* Clicks in non-text areas get prefixed by the symbol
9615 in their CHAR-ADDRESS field. For example, a click on
9616 the mode line is prefixed by the symbol `mode-line'.
9618 Furthermore, key sequences beginning with mouse clicks
9619 are read using the keymaps of the buffer clicked on, not
9620 the current buffer. So we may have to switch the buffer
9623 When we turn one event into two events, we must make sure
9624 that neither of the two looks like the original--so that,
9625 if we replay the events, they won't be expanded again.
9626 If not for this, such reexpansion could happen either here
9627 or when user programs play with this-command-keys. */
9628 if (EVENT_HAS_PARAMETERS (key
))
9633 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9634 if (EQ (kind
, Qmouse_click
))
9636 Lisp_Object window
, posn
;
9638 window
= POSN_WINDOW (EVENT_START (key
));
9639 posn
= POSN_POSN (EVENT_START (key
));
9642 || (!NILP (fake_prefixed_keys
)
9643 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9645 /* We're looking a second time at an event for which
9646 we generated a fake prefix key. Set
9647 last_real_key_start appropriately. */
9649 last_real_key_start
= t
- 1;
9652 /* Key sequences beginning with mouse clicks are
9653 read using the keymaps in the buffer clicked on,
9654 not the current buffer. If we're at the
9655 beginning of a key sequence, switch buffers. */
9656 if (last_real_key_start
== 0
9658 && BUFFERP (XWINDOW (window
)->buffer
)
9659 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9661 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9665 /* Arrange to go back to the original buffer once we're
9666 done reading the key sequence. Note that we can't
9667 use save_excursion_{save,restore} here, because they
9668 save point as well as the current buffer; we don't
9669 want to save point, because redisplay may change it,
9670 to accommodate a Fset_window_start or something. We
9671 don't want to do this at the top of the function,
9672 because we may get input from a subprocess which
9673 wants to change the selected window and stuff (say,
9675 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9677 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9679 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9680 orig_local_map
= get_local_map (PT
, current_buffer
,
9682 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9683 goto replay_sequence
;
9686 /* For a mouse click, get the local text-property keymap
9687 of the place clicked on, rather than point. */
9688 if (last_real_key_start
== 0
9689 && CONSP (XCDR (key
))
9690 && ! localized_local_map
)
9692 Lisp_Object map_here
, start
, pos
;
9694 localized_local_map
= 1;
9695 start
= EVENT_START (key
);
9697 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9699 pos
= POSN_BUFFER_POSN (start
);
9701 && XINT (pos
) >= BEGV
9702 && XINT (pos
) <= ZV
)
9704 map_here
= get_local_map (XINT (pos
),
9705 current_buffer
, Qlocal_map
);
9706 if (!EQ (map_here
, orig_local_map
))
9708 orig_local_map
= map_here
;
9709 ++localized_local_map
;
9712 map_here
= get_local_map (XINT (pos
),
9713 current_buffer
, Qkeymap
);
9714 if (!EQ (map_here
, orig_keymap
))
9716 orig_keymap
= map_here
;
9717 ++localized_local_map
;
9720 if (localized_local_map
> 1)
9725 goto replay_sequence
;
9731 /* Expand mode-line and scroll-bar events into two events:
9732 use posn as a fake prefix key. */
9734 && (NILP (fake_prefixed_keys
)
9735 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9737 if (t
+ 1 >= bufsize
)
9738 error ("Key sequence too long");
9741 keybuf
[t
+ 1] = key
;
9744 /* Record that a fake prefix key has been generated
9745 for KEY. Don't modify the event; this would
9746 prevent proper action when the event is pushed
9747 back into unread-command-events. */
9748 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9750 /* If on a mode line string with a local keymap,
9751 reconsider the key sequence with that keymap. */
9752 if (string
= POSN_STRING (EVENT_START (key
)),
9753 (CONSP (string
) && STRINGP (XCAR (string
))))
9755 Lisp_Object pos
, map
, map2
;
9757 pos
= XCDR (string
);
9758 string
= XCAR (string
);
9760 && XINT (pos
) < SCHARS (string
))
9762 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9764 orig_local_map
= map
;
9765 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9768 if (!NILP (map
) || !NILP (map2
))
9769 goto replay_sequence
;
9775 else if (NILP (from_string
)
9776 && (string
= POSN_STRING (EVENT_START (key
)),
9777 (CONSP (string
) && STRINGP (XCAR (string
)))))
9779 /* For a click on a string, i.e. overlay string or a
9780 string displayed via the `display' property,
9781 consider `local-map' and `keymap' properties of
9783 Lisp_Object pos
, map
, map2
;
9785 pos
= XCDR (string
);
9786 string
= XCAR (string
);
9788 && XINT (pos
) < SCHARS (string
))
9790 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9792 orig_local_map
= map
;
9793 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9797 if (!NILP (map
) || !NILP (map2
))
9799 from_string
= string
;
9802 goto replay_sequence
;
9807 else if (CONSP (XCDR (key
))
9808 && CONSP (EVENT_START (key
))
9809 && CONSP (XCDR (EVENT_START (key
))))
9813 posn
= POSN_POSN (EVENT_START (key
));
9814 /* Handle menu-bar events:
9815 insert the dummy prefix event `menu-bar'. */
9816 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9818 if (t
+ 1 >= bufsize
)
9819 error ("Key sequence too long");
9823 /* Zap the position in key, so we know that we've
9824 expanded it, and don't try to do so again. */
9825 POSN_SET_POSN (EVENT_START (key
),
9826 Fcons (posn
, Qnil
));
9829 goto replay_sequence
;
9831 else if (CONSP (posn
))
9833 /* We're looking at the second event of a
9834 sequence which we expanded before. Set
9835 last_real_key_start appropriately. */
9836 if (last_real_key_start
== t
&& t
> 0)
9837 last_real_key_start
= t
- 1;
9842 /* We have finally decided that KEY is something we might want
9844 first_binding
= (follow_key (key
,
9845 nmaps
- first_binding
,
9846 submaps
+ first_binding
,
9847 defs
+ first_binding
,
9848 submaps
+ first_binding
)
9851 /* If KEY wasn't bound, we'll try some fallbacks. */
9852 if (first_binding
< nmaps
)
9853 /* This is needed for the following scenario:
9854 event 0: a down-event that gets dropped by calling replay_key.
9855 event 1: some normal prefix like C-h.
9856 After event 0, first_unbound is 0, after event 1 indec.start,
9857 fkey.start, and keytran.start are all 1, so when we see that
9858 C-h is bound, we need to update first_unbound. */
9859 first_unbound
= max (t
+ 1, first_unbound
);
9864 /* Remember the position to put an upper bound on indec.start. */
9865 first_unbound
= min (t
, first_unbound
);
9867 head
= EVENT_HEAD (key
);
9868 if (help_char_p (head
) && t
> 0)
9870 read_key_sequence_cmd
= Vprefix_help_command
;
9872 last_nonmenu_event
= key
;
9873 /* The Microsoft C compiler can't handle the goto that
9881 Lisp_Object breakdown
;
9884 breakdown
= parse_modifiers (head
);
9885 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9886 /* Attempt to reduce an unbound mouse event to a simpler
9887 event that is bound:
9888 Drags reduce to clicks.
9889 Double-clicks reduce to clicks.
9890 Triple-clicks reduce to double-clicks, then to clicks.
9891 Down-clicks are eliminated.
9892 Double-downs reduce to downs, then are eliminated.
9893 Triple-downs reduce to double-downs, then to downs,
9894 then are eliminated. */
9895 if (modifiers
& (down_modifier
| drag_modifier
9896 | double_modifier
| triple_modifier
))
9898 while (modifiers
& (down_modifier
| drag_modifier
9899 | double_modifier
| triple_modifier
))
9901 Lisp_Object new_head
, new_click
;
9902 if (modifiers
& triple_modifier
)
9903 modifiers
^= (double_modifier
| triple_modifier
);
9904 else if (modifiers
& double_modifier
)
9905 modifiers
&= ~double_modifier
;
9906 else if (modifiers
& drag_modifier
)
9907 modifiers
&= ~drag_modifier
;
9910 /* Dispose of this `down' event by simply jumping
9911 back to replay_key, to get another event.
9913 Note that if this event came from mock input,
9914 then just jumping back to replay_key will just
9915 hand it to us again. So we have to wipe out any
9918 We could delete keybuf[t] and shift everything
9919 after that to the left by one spot, but we'd also
9920 have to fix up any variable that points into
9921 keybuf, and shifting isn't really necessary
9924 Adding prefixes for non-textual mouse clicks
9925 creates two characters of mock input, and both
9926 must be thrown away. If we're only looking at
9927 the prefix now, we can just jump back to
9928 replay_key. On the other hand, if we've already
9929 processed the prefix, and now the actual click
9930 itself is giving us trouble, then we've lost the
9931 state of the keymaps we want to backtrack to, and
9932 we need to replay the whole sequence to rebuild
9935 Beyond that, only function key expansion could
9936 create more than two keys, but that should never
9937 generate mouse events, so it's okay to zero
9938 mock_input in that case too.
9940 FIXME: The above paragraph seems just plain
9941 wrong, if you consider things like
9942 xterm-mouse-mode. -stef
9944 Isn't this just the most wonderful code ever? */
9946 /* If mock_input > t + 1, the above simplification
9947 will actually end up dropping keys on the floor.
9948 This is probably OK for now, but even
9949 if mock_input <= t + 1, we need to adjust indec,
9951 Typical case [header-line down-mouse-N]:
9952 mock_input = 2, t = 1, fkey.end = 1,
9953 last_real_key_start = 0. */
9954 if (indec
.end
> last_real_key_start
)
9956 indec
.end
= indec
.start
9957 = min (last_real_key_start
, indec
.start
);
9958 indec
.map
= indec
.parent
;
9959 if (fkey
.end
> last_real_key_start
)
9961 fkey
.end
= fkey
.start
9962 = min (last_real_key_start
, fkey
.start
);
9963 fkey
.map
= fkey
.parent
;
9964 if (keytran
.end
> last_real_key_start
)
9966 keytran
.end
= keytran
.start
9967 = min (last_real_key_start
, keytran
.start
);
9968 keytran
.map
= keytran
.parent
;
9972 if (t
== last_real_key_start
)
9979 mock_input
= last_real_key_start
;
9980 goto replay_sequence
;
9985 = apply_modifiers (modifiers
, XCAR (breakdown
));
9987 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9989 /* Look for a binding for this new key. follow_key
9990 promises that it didn't munge submaps the
9991 last time we called it, since key was unbound. */
9993 = (follow_key (new_click
,
9994 nmaps
- local_first_binding
,
9995 submaps
+ local_first_binding
,
9996 defs
+ local_first_binding
,
9997 submaps
+ local_first_binding
)
9998 + local_first_binding
);
10000 /* If that click is bound, go for it. */
10001 if (first_binding
< nmaps
)
10006 /* Otherwise, we'll leave key set to the drag event. */
10013 /* Normally, last_nonmenu_event gets the previous key we read.
10014 But when a mouse popup menu is being used,
10015 we don't update last_nonmenu_event; it continues to hold the mouse
10016 event that preceded the first level of menu. */
10017 if (!used_mouse_menu
)
10018 last_nonmenu_event
= key
;
10020 /* Record what part of this_command_keys is the current key sequence. */
10021 this_single_command_key_start
= this_command_key_count
- t
;
10023 /* Look for this sequence in input-decode-map.
10024 Scan from indec.end until we find a bound suffix. */
10025 while (indec
.end
< t
)
10027 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10030 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10031 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
10036 mock_input
= diff
+ max (t
, mock_input
);
10037 goto replay_sequence
;
10041 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
10042 && indec
.start
>= t
)
10043 /* There is a binding and it's not a prefix.
10044 (and it doesn't have any input-decode-map translation pending).
10045 There is thus no function-key in this sequence.
10046 Moving fkey.start is important in this case to allow keytran.start
10047 to go over the sequence before we return (since we keep the
10048 invariant that keytran.end <= fkey.start). */
10050 if (fkey
.start
< t
)
10051 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
10054 /* If the sequence is unbound, see if we can hang a function key
10055 off the end of it. */
10056 /* Continue scan from fkey.end until we find a bound suffix. */
10057 while (fkey
.end
< indec
.start
)
10059 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10062 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10063 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
10064 max (t
, mock_input
),
10065 /* If there's a binding (i.e.
10066 first_binding >= nmaps) we don't want
10067 to apply this function-key-mapping. */
10068 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10073 mock_input
= diff
+ max (t
, mock_input
);
10074 /* Adjust the input-decode-map counters. */
10076 indec
.start
+= diff
;
10078 goto replay_sequence
;
10082 /* Look for this sequence in key-translation-map.
10083 Scan from keytran.end until we find a bound suffix. */
10084 while (keytran
.end
< fkey
.start
)
10086 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10089 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10090 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10095 mock_input
= diff
+ max (t
, mock_input
);
10096 /* Adjust the function-key-map and input-decode-map counters. */
10098 indec
.start
+= diff
;
10100 fkey
.start
+= diff
;
10102 goto replay_sequence
;
10106 /* If KEY is not defined in any of the keymaps,
10107 and cannot be part of a function key or translation,
10108 and is an upper case letter
10109 use the corresponding lower-case letter instead. */
10110 if (first_binding
>= nmaps
10111 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10113 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10114 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10115 || (XINT (key
) & shift_modifier
)))
10117 Lisp_Object new_key
;
10119 original_uppercase
= key
;
10120 original_uppercase_position
= t
- 1;
10122 if (XINT (key
) & shift_modifier
)
10123 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10125 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10126 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10128 /* We have to do this unconditionally, regardless of whether
10129 the lower-case char is defined in the keymaps, because they
10130 might get translated through function-key-map. */
10131 keybuf
[t
- 1] = new_key
;
10132 mock_input
= max (t
, mock_input
);
10133 shift_translated
= 1;
10135 goto replay_sequence
;
10137 /* If KEY is not defined in any of the keymaps,
10138 and cannot be part of a function key or translation,
10139 and is a shifted function key,
10140 use the corresponding unshifted function key instead. */
10141 if (first_binding
>= nmaps
10142 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10144 Lisp_Object breakdown
= parse_modifiers (key
);
10146 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10148 if (modifiers
& shift_modifier
10149 /* Treat uppercase keys as shifted. */
10151 && (KEY_TO_CHAR (key
)
10152 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10153 && UPPERCASEP (KEY_TO_CHAR (key
))))
10155 Lisp_Object new_key
10156 = (modifiers
& shift_modifier
10157 ? apply_modifiers (modifiers
& ~shift_modifier
,
10159 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10161 original_uppercase
= key
;
10162 original_uppercase_position
= t
- 1;
10164 /* We have to do this unconditionally, regardless of whether
10165 the lower-case char is defined in the keymaps, because they
10166 might get translated through function-key-map. */
10167 keybuf
[t
- 1] = new_key
;
10168 mock_input
= max (t
, mock_input
);
10169 /* Reset fkey (and consequently keytran) to apply
10170 function-key-map on the result, so that S-backspace is
10171 correctly mapped to DEL (via backspace). OTOH,
10172 input-decode-map doesn't need to go through it again. */
10173 fkey
.start
= fkey
.end
= 0;
10174 keytran
.start
= keytran
.end
= 0;
10175 shift_translated
= 1;
10177 goto replay_sequence
;
10182 read_key_sequence_cmd
= (first_binding
< nmaps
10183 ? defs
[first_binding
]
10186 unread_switch_frame
= delayed_switch_frame
;
10187 unbind_to (count
, Qnil
);
10189 /* Don't downcase the last character if the caller says don't.
10190 Don't downcase it if the result is undefined, either. */
10191 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10193 && t
- 1 == original_uppercase_position
)
10195 keybuf
[t
- 1] = original_uppercase
;
10196 shift_translated
= 0;
10199 if (shift_translated
)
10200 Vthis_command_keys_shift_translated
= Qt
;
10202 /* Occasionally we fabricate events, perhaps by expanding something
10203 according to function-key-map, or by adding a prefix symbol to a
10204 mouse click in the scroll bar or modeline. In this cases, return
10205 the entire generated key sequence, even if we hit an unbound
10206 prefix or a definition before the end. This means that you will
10207 be able to push back the event properly, and also means that
10208 read-key-sequence will always return a logical unit.
10211 for (; t
< mock_input
; t
++)
10213 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10214 && NILP (Fzerop (Vecho_keystrokes
)))
10215 echo_char (keybuf
[t
]);
10216 add_command_key (keybuf
[t
]);
10223 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10224 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10225 The sequence is sufficient to specify a non-prefix command in the
10226 current local and global maps.
10228 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10229 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10230 as a continuation of the previous key.
10232 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10233 convert the last event to lower case. (Normally any upper case event
10234 is converted to lower case if the original event is undefined and the lower
10235 case equivalent is defined.) A non-nil value is appropriate for reading
10236 a key sequence to be defined.
10238 A C-g typed while in this function is treated like any other character,
10239 and `quit-flag' is not set.
10241 If the key sequence starts with a mouse click, then the sequence is read
10242 using the keymaps of the buffer of the window clicked in, not the buffer
10243 of the selected window as normal.
10245 `read-key-sequence' drops unbound button-down events, since you normally
10246 only care about the click or drag events which follow them. If a drag
10247 or multi-click event is unbound, but the corresponding click event would
10248 be bound, `read-key-sequence' turns the event into a click event at the
10249 drag's starting position. This means that you don't have to distinguish
10250 between click and drag, double, or triple events unless you want to.
10252 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10253 lines separating windows, and scroll bars with imaginary keys
10254 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10256 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10257 function will process a switch-frame event if the user switches frames
10258 before typing anything. If the user switches frames in the middle of a
10259 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10260 is nil, then the event will be put off until after the current key sequence.
10262 `read-key-sequence' checks `function-key-map' for function key
10263 sequences, where they wouldn't conflict with ordinary bindings. See
10264 `function-key-map' for more details.
10266 The optional fifth argument COMMAND-LOOP, if non-nil, means
10267 that this key sequence is being read by something that will
10268 read commands one after another. It should be nil if the caller
10269 will read just one key sequence. */)
10270 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10272 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10273 Lisp_Object can_return_switch_frame
, command_loop
;
10275 Lisp_Object keybuf
[30];
10277 struct gcpro gcpro1
;
10278 int count
= SPECPDL_INDEX ();
10280 if (!NILP (prompt
))
10281 CHECK_STRING (prompt
);
10284 specbind (Qinput_method_exit_on_first_char
,
10285 (NILP (command_loop
) ? Qt
: Qnil
));
10286 specbind (Qinput_method_use_echo_area
,
10287 (NILP (command_loop
) ? Qt
: Qnil
));
10289 bzero (keybuf
, sizeof keybuf
);
10290 GCPRO1 (keybuf
[0]);
10291 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10293 if (NILP (continue_echo
))
10295 this_command_key_count
= 0;
10296 this_command_key_count_reset
= 0;
10297 this_single_command_key_start
= 0;
10300 #ifdef HAVE_WINDOW_SYSTEM
10301 if (display_hourglass_p
)
10302 cancel_hourglass ();
10305 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10306 prompt
, ! NILP (dont_downcase_last
),
10307 ! NILP (can_return_switch_frame
), 0);
10309 #if 0 /* The following is fine for code reading a key sequence and
10310 then proceeding with a lenghty computation, but it's not good
10311 for code reading keys in a loop, like an input method. */
10312 #ifdef HAVE_WINDOW_SYSTEM
10313 if (display_hourglass_p
)
10314 start_hourglass ();
10324 return unbind_to (count
, make_event_array (i
, keybuf
));
10327 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10328 Sread_key_sequence_vector
, 1, 5, 0,
10329 doc
: /* Like `read-key-sequence' but always return a vector. */)
10330 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10332 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10333 Lisp_Object can_return_switch_frame
, command_loop
;
10335 Lisp_Object keybuf
[30];
10337 struct gcpro gcpro1
;
10338 int count
= SPECPDL_INDEX ();
10340 if (!NILP (prompt
))
10341 CHECK_STRING (prompt
);
10344 specbind (Qinput_method_exit_on_first_char
,
10345 (NILP (command_loop
) ? Qt
: Qnil
));
10346 specbind (Qinput_method_use_echo_area
,
10347 (NILP (command_loop
) ? Qt
: Qnil
));
10349 bzero (keybuf
, sizeof keybuf
);
10350 GCPRO1 (keybuf
[0]);
10351 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10353 if (NILP (continue_echo
))
10355 this_command_key_count
= 0;
10356 this_command_key_count_reset
= 0;
10357 this_single_command_key_start
= 0;
10360 #ifdef HAVE_WINDOW_SYSTEM
10361 if (display_hourglass_p
)
10362 cancel_hourglass ();
10365 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10366 prompt
, ! NILP (dont_downcase_last
),
10367 ! NILP (can_return_switch_frame
), 0);
10369 #ifdef HAVE_WINDOW_SYSTEM
10370 if (display_hourglass_p
)
10371 start_hourglass ();
10380 return unbind_to (count
, Fvector (i
, keybuf
));
10383 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10384 doc
: /* Execute CMD as an editor command.
10385 CMD must be a symbol that satisfies the `commandp' predicate.
10386 Optional second arg RECORD-FLAG non-nil
10387 means unconditionally put this command in `command-history'.
10388 Otherwise, that is done only if an arg is read using the minibuffer.
10389 The argument KEYS specifies the value to use instead of (this-command-keys)
10390 when reading the arguments; if it is nil, (this-command-keys) is used.
10391 The argument SPECIAL, if non-nil, means that this command is executing
10392 a special event, so ignore the prefix argument and don't clear it. */)
10393 (cmd
, record_flag
, keys
, special
)
10394 Lisp_Object cmd
, record_flag
, keys
, special
;
10396 register Lisp_Object final
;
10397 register Lisp_Object tem
;
10398 Lisp_Object prefixarg
;
10399 extern int debug_on_next_call
;
10401 debug_on_next_call
= 0;
10403 if (NILP (special
))
10405 prefixarg
= current_kboard
->Vprefix_arg
;
10406 Vcurrent_prefix_arg
= prefixarg
;
10407 current_kboard
->Vprefix_arg
= Qnil
;
10414 tem
= Fget (cmd
, Qdisabled
);
10415 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10417 tem
= Fsymbol_value (Qdisabled_command_function
);
10419 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10425 final
= Findirect_function (cmd
, Qnil
);
10427 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10429 struct gcpro gcpro1
, gcpro2
;
10431 GCPRO2 (cmd
, prefixarg
);
10432 do_autoload (final
, cmd
);
10439 if (STRINGP (final
) || VECTORP (final
))
10441 /* If requested, place the macro in the command history. For
10442 other sorts of commands, call-interactively takes care of
10444 if (!NILP (record_flag
))
10447 = Fcons (Fcons (Qexecute_kbd_macro
,
10448 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10451 /* Don't keep command history around forever. */
10452 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10454 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10456 XSETCDR (tem
, Qnil
);
10460 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10463 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10464 /* Don't call Fcall_interactively directly because we want to make
10465 sure the backtrace has an entry for `call-interactively'.
10466 For the same reason, pass `cmd' rather than `final'. */
10467 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10474 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10476 doc
: /* Read function name, then read its arguments and call it.
10478 To pass a numeric argument to the command you are invoking with, specify
10479 the numeric argument to this command.
10481 Noninteractively, the argument PREFIXARG is the prefix argument to
10482 give to the command you invoke, if it asks for an argument. */)
10484 Lisp_Object prefixarg
;
10486 Lisp_Object function
;
10488 int saved_last_point_position
;
10489 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10490 Lisp_Object bindings
, value
;
10491 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10492 #ifdef HAVE_WINDOW_SYSTEM
10493 /* The call to Fcompleting_read wil start and cancel the hourglass,
10494 but if the hourglass was already scheduled, this means that no
10495 hourglass will be shown for the actual M-x command itself.
10496 So we restart it if it is already scheduled. Note that checking
10497 hourglass_shown_p is not enough, normally the hourglass is not shown,
10498 just scheduled to be shown. */
10499 int hstarted
= hourglass_started ();
10502 saved_keys
= Fvector (this_command_key_count
,
10503 XVECTOR (this_command_keys
)->contents
);
10504 saved_last_point_position_buffer
= last_point_position_buffer
;
10505 saved_last_point_position
= last_point_position
;
10507 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10509 if (EQ (prefixarg
, Qminus
))
10510 strcpy (buf
, "- ");
10511 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10512 strcpy (buf
, "C-u ");
10513 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10514 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10515 else if (INTEGERP (prefixarg
))
10516 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10518 /* This isn't strictly correct if execute-extended-command
10519 is bound to anything else. Perhaps it should use
10520 this_command_keys? */
10521 strcat (buf
, "M-x ");
10523 /* Prompt with buf, and then read a string, completing from and
10524 restricting to the set of all defined commands. Don't provide
10525 any initial input. Save the command read on the extended-command
10527 function
= Fcompleting_read (build_string (buf
),
10528 Vobarray
, Qcommandp
,
10529 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10532 #ifdef HAVE_WINDOW_SYSTEM
10533 if (hstarted
) start_hourglass ();
10536 if (STRINGP (function
) && SCHARS (function
) == 0)
10537 error ("No command name given");
10539 /* Set this_command_keys to the concatenation of saved_keys and
10540 function, followed by a RET. */
10545 this_command_key_count
= 0;
10546 this_command_key_count_reset
= 0;
10547 this_single_command_key_start
= 0;
10549 keys
= XVECTOR (saved_keys
)->contents
;
10550 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10551 add_command_key (keys
[i
]);
10553 for (i
= 0; i
< SCHARS (function
); i
++)
10554 add_command_key (Faref (function
, make_number (i
)));
10556 add_command_key (make_number ('\015'));
10559 last_point_position
= saved_last_point_position
;
10560 last_point_position_buffer
= saved_last_point_position_buffer
;
10564 function
= Fintern (function
, Qnil
);
10565 current_kboard
->Vprefix_arg
= prefixarg
;
10566 Vthis_command
= function
;
10567 real_this_command
= function
;
10569 /* If enabled, show which key runs this command. */
10570 if (!NILP (Vsuggest_key_bindings
)
10571 && NILP (Vexecuting_kbd_macro
)
10572 && SYMBOLP (function
))
10573 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10579 GCPRO3 (bindings
, value
, function
);
10580 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10582 /* If the command has a key binding, print it now. */
10583 if (!NILP (bindings
)
10584 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10587 /* But first wait, and skip the message if there is input. */
10588 Lisp_Object waited
;
10590 /* If this command displayed something in the echo area;
10591 wait a few seconds, then display our suggestion message. */
10592 if (NILP (echo_area_buffer
[0]))
10593 waited
= sit_for (make_number (0), 0, 2);
10594 else if (NUMBERP (Vsuggest_key_bindings
))
10595 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10597 waited
= sit_for (make_number (2), 0, 2);
10599 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10601 Lisp_Object binding
;
10603 int message_p
= push_message ();
10604 int count
= SPECPDL_INDEX ();
10606 record_unwind_protect (pop_message_unwind
, Qnil
);
10607 binding
= Fkey_description (bindings
, Qnil
);
10610 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10613 sprintf (newmessage
, "You can run the command `%s' with %s",
10614 SDATA (SYMBOL_NAME (function
)),
10616 message2_nolog (newmessage
,
10617 strlen (newmessage
),
10618 STRING_MULTIBYTE (binding
));
10619 if (NUMBERP (Vsuggest_key_bindings
))
10620 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10622 waited
= sit_for (make_number (2), 0, 2);
10624 if (!NILP (waited
) && message_p
)
10625 restore_message ();
10627 unbind_to (count
, Qnil
);
10631 RETURN_UNGCPRO (value
);
10635 /* Return nonzero if input events are pending. */
10638 detect_input_pending ()
10640 if (!input_pending
)
10641 get_input_pending (&input_pending
, 0);
10643 return input_pending
;
10646 /* Return nonzero if input events other than mouse movements are
10650 detect_input_pending_ignore_squeezables ()
10652 if (!input_pending
)
10653 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10655 return input_pending
;
10658 /* Return nonzero if input events are pending, and run any pending timers. */
10661 detect_input_pending_run_timers (do_display
)
10664 int old_timers_run
= timers_run
;
10666 if (!input_pending
)
10667 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10669 if (old_timers_run
!= timers_run
&& do_display
)
10671 redisplay_preserve_echo_area (8);
10672 /* The following fixes a bug when using lazy-lock with
10673 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10674 from an idle timer function. The symptom of the bug is that
10675 the cursor sometimes doesn't become visible until the next X
10676 event is processed. --gerd. */
10678 Lisp_Object tail
, frame
;
10679 FOR_EACH_FRAME (tail
, frame
)
10680 if (FRAME_RIF (XFRAME (frame
)))
10681 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10685 return input_pending
;
10688 /* This is called in some cases before a possible quit.
10689 It cases the next call to detect_input_pending to recompute input_pending.
10690 So calling this function unnecessarily can't do any harm. */
10693 clear_input_pending ()
10698 /* Return nonzero if there are pending requeued events.
10699 This isn't used yet. The hope is to make wait_reading_process_output
10700 call it, and return if it runs Lisp code that unreads something.
10701 The problem is, kbd_buffer_get_event needs to be fixed to know what
10702 to do in that case. It isn't trivial. */
10705 requeued_events_pending_p ()
10707 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10711 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10712 doc
: /* Return t if command input is currently available with no wait.
10713 Actually, the value is nil only if we can be sure that no input is available;
10714 if there is a doubt, the value is t. */)
10717 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10718 || !NILP (Vunread_post_input_method_events
)
10719 || !NILP (Vunread_input_method_events
))
10722 get_input_pending (&input_pending
,
10723 READABLE_EVENTS_DO_TIMERS_NOW
10724 | READABLE_EVENTS_FILTER_EVENTS
);
10725 return input_pending
> 0 ? Qt
: Qnil
;
10728 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10729 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10732 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10735 if (total_keys
< NUM_RECENT_KEYS
)
10736 return Fvector (total_keys
, keys
);
10739 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10740 bcopy (keys
+ recent_keys_index
,
10741 XVECTOR (val
)->contents
,
10742 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10744 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10745 recent_keys_index
* sizeof (Lisp_Object
));
10750 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10751 doc
: /* Return the key sequence that invoked this command.
10752 However, if the command has called `read-key-sequence', it returns
10753 the last key sequence that has been read.
10754 The value is a string or a vector.
10756 See also `this-command-keys-vector'. */)
10759 return make_event_array (this_command_key_count
,
10760 XVECTOR (this_command_keys
)->contents
);
10763 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10764 doc
: /* Return the key sequence that invoked this command, as a vector.
10765 However, if the command has called `read-key-sequence', it returns
10766 the last key sequence that has been read.
10768 See also `this-command-keys'. */)
10771 return Fvector (this_command_key_count
,
10772 XVECTOR (this_command_keys
)->contents
);
10775 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10776 Sthis_single_command_keys
, 0, 0, 0,
10777 doc
: /* Return the key sequence that invoked this command.
10778 More generally, it returns the last key sequence read, either by
10779 the command loop or by `read-key-sequence'.
10780 Unlike `this-command-keys', this function's value
10781 does not include prefix arguments.
10782 The value is always a vector. */)
10785 return Fvector (this_command_key_count
10786 - this_single_command_key_start
,
10787 (XVECTOR (this_command_keys
)->contents
10788 + this_single_command_key_start
));
10791 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10792 Sthis_single_command_raw_keys
, 0, 0, 0,
10793 doc
: /* Return the raw events that were read for this command.
10794 More generally, it returns the last key sequence read, either by
10795 the command loop or by `read-key-sequence'.
10796 Unlike `this-single-command-keys', this function's value
10797 shows the events before all translations (except for input methods).
10798 The value is always a vector. */)
10801 return Fvector (raw_keybuf_count
,
10802 (XVECTOR (raw_keybuf
)->contents
));
10805 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10806 Sreset_this_command_lengths
, 0, 0, 0,
10807 doc
: /* Make the unread events replace the last command and echo.
10808 Used in `universal-argument-other-key'.
10810 `universal-argument-other-key' rereads the event just typed.
10811 It then gets translated through `function-key-map'.
10812 The translated event has to replace the real events,
10813 both in the value of (this-command-keys) and in echoing.
10814 To achieve this, `universal-argument-other-key' calls
10815 `reset-this-command-lengths', which discards the record of reading
10816 these events the first time. */)
10819 this_command_key_count
= before_command_key_count
;
10820 if (this_command_key_count
< this_single_command_key_start
)
10821 this_single_command_key_start
= this_command_key_count
;
10823 echo_truncate (before_command_echo_length
);
10825 /* Cause whatever we put into unread-command-events
10826 to echo as if it were being freshly read from the keyboard. */
10827 this_command_key_count_reset
= 1;
10832 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10833 Sclear_this_command_keys
, 0, 1, 0,
10834 doc
: /* Clear out the vector that `this-command-keys' returns.
10835 Also clear the record of the last 100 events, unless optional arg
10836 KEEP-RECORD is non-nil. */)
10838 Lisp_Object keep_record
;
10842 this_command_key_count
= 0;
10843 this_command_key_count_reset
= 0;
10845 if (NILP (keep_record
))
10847 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10848 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10850 recent_keys_index
= 0;
10855 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10856 doc
: /* Return the current depth in recursive edits. */)
10860 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10864 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10865 "FOpen dribble file: ",
10866 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10867 If FILE is nil, close any open dribble file. */)
10880 file
= Fexpand_file_name (file
, Qnil
);
10881 dribble
= fopen (SDATA (file
), "w");
10883 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10888 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10889 doc
: /* Discard the contents of the terminal input buffer.
10890 Also end any kbd macro being defined. */)
10893 if (!NILP (current_kboard
->defining_kbd_macro
))
10895 /* Discard the last command from the macro. */
10896 Fcancel_kbd_macro_events ();
10900 update_mode_lines
++;
10902 Vunread_command_events
= Qnil
;
10903 unread_command_char
= -1;
10905 discard_tty_input ();
10907 kbd_fetch_ptr
= kbd_store_ptr
;
10913 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10914 doc
: /* Stop Emacs and return to superior process. You can resume later.
10915 If `cannot-suspend' is non-nil, or if the system doesn't support job
10916 control, run a subshell instead.
10918 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10919 to be read as terminal input by Emacs's parent, after suspension.
10921 Before suspending, run the normal hook `suspend-hook'.
10922 After resumption run the normal hook `suspend-resume-hook'.
10924 Some operating systems cannot stop the Emacs process and resume it later.
10925 On such systems, Emacs starts a subshell instead of suspending. */)
10927 Lisp_Object stuffstring
;
10929 int count
= SPECPDL_INDEX ();
10930 int old_height
, old_width
;
10932 struct gcpro gcpro1
;
10934 if (tty_list
&& tty_list
->next
)
10935 error ("There are other tty frames open; close them before suspending Emacs");
10937 if (!NILP (stuffstring
))
10938 CHECK_STRING (stuffstring
);
10940 /* Run the functions in suspend-hook. */
10941 if (!NILP (Vrun_hooks
))
10942 call1 (Vrun_hooks
, intern ("suspend-hook"));
10944 GCPRO1 (stuffstring
);
10945 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10946 reset_all_sys_modes ();
10947 /* sys_suspend can get an error if it tries to fork a subshell
10948 and the system resources aren't available for that. */
10949 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10951 stuff_buffered_input (stuffstring
);
10952 if (cannot_suspend
)
10956 unbind_to (count
, Qnil
);
10958 /* Check if terminal/window size has changed.
10959 Note that this is not useful when we are running directly
10960 with a window system; but suspend should be disabled in that case. */
10961 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10962 if (width
!= old_width
|| height
!= old_height
)
10963 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10965 /* Run suspend-resume-hook. */
10966 if (!NILP (Vrun_hooks
))
10967 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10973 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10974 Then in any case stuff anything Emacs has read ahead and not used. */
10977 stuff_buffered_input (stuffstring
)
10978 Lisp_Object stuffstring
;
10980 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10981 register unsigned char *p
;
10983 if (STRINGP (stuffstring
))
10985 register int count
;
10987 p
= SDATA (stuffstring
);
10988 count
= SBYTES (stuffstring
);
10989 while (count
-- > 0)
10994 /* Anything we have read ahead, put back for the shell to read. */
10995 /* ?? What should this do when we have multiple keyboards??
10996 Should we ignore anything that was typed in at the "wrong" kboard?
10998 rms: we should stuff everything back into the kboard
11000 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
11003 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11004 kbd_fetch_ptr
= kbd_buffer
;
11005 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
11006 stuff_char (kbd_fetch_ptr
->code
);
11008 clear_event (kbd_fetch_ptr
);
11012 #endif /* SIGTSTP */
11016 set_waiting_for_input (time_to_clear
)
11017 EMACS_TIME
*time_to_clear
;
11019 input_available_clear_time
= time_to_clear
;
11021 /* Tell handle_interrupt to throw back to read_char, */
11022 waiting_for_input
= 1;
11024 /* If handle_interrupt was called before and buffered a C-g,
11025 make it run again now, to avoid timing error. */
11026 if (!NILP (Vquit_flag
))
11027 quit_throw_to_read_char ();
11031 clear_waiting_for_input ()
11033 /* Tell handle_interrupt not to throw back to read_char, */
11034 waiting_for_input
= 0;
11035 input_available_clear_time
= 0;
11038 /* The SIGINT handler.
11040 If we have a frame on the controlling tty, we assume that the
11041 SIGINT was generated by C-g, so we call handle_interrupt.
11042 Otherwise, the handler kills Emacs. */
11045 interrupt_signal (signalnum
) /* If we don't have an argument, */
11046 int signalnum
; /* some compilers complain in signal calls. */
11048 /* Must preserve main program's value of errno. */
11049 int old_errno
= errno
;
11050 struct terminal
*terminal
;
11052 #if defined (USG) && !defined (POSIX_SIGNALS)
11053 /* USG systems forget handlers when they are used;
11054 must reestablish each time */
11055 signal (SIGINT
, interrupt_signal
);
11056 signal (SIGQUIT
, interrupt_signal
);
11059 SIGNAL_THREAD_CHECK (signalnum
);
11061 /* See if we have an active terminal on our controlling tty. */
11062 terminal
= get_named_tty ("/dev/tty");
11065 /* If there are no frames there, let's pretend that we are a
11066 well-behaving UN*X program and quit. */
11067 Fkill_emacs (Qnil
);
11071 /* Otherwise, the SIGINT was probably generated by C-g. */
11073 /* Set internal_last_event_frame to the top frame of the
11074 controlling tty, if we have a frame there. We disable the
11075 interrupt key on secondary ttys, so the SIGINT must have come
11076 from the controlling tty. */
11077 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11079 handle_interrupt ();
11085 /* This routine is called at interrupt level in response to C-g.
11087 It is called from the SIGINT handler or kbd_buffer_store_event.
11089 If `waiting_for_input' is non zero, then unless `echoing' is
11090 nonzero, immediately throw back to read_char.
11092 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11093 eval to throw, when it gets a chance. If quit-flag is already
11094 non-nil, it stops the job right away. */
11097 handle_interrupt ()
11103 /* XXX This code needs to be revised for multi-tty support. */
11104 if (!NILP (Vquit_flag
)
11106 && get_named_tty ("/dev/tty")
11110 /* If SIGINT isn't blocked, don't let us be interrupted by
11111 another SIGINT, it might be harmful due to non-reentrancy
11112 in I/O functions. */
11113 sigblock (sigmask (SIGINT
));
11116 reset_all_sys_modes ();
11118 #ifdef SIGTSTP /* Support possible in later USG versions */
11120 * On systems which can suspend the current process and return to the original
11121 * shell, this command causes the user to end up back at the shell.
11122 * The "Auto-save" and "Abort" questions are not asked until
11123 * the user elects to return to emacs, at which point he can save the current
11124 * job and either dump core or continue.
11129 if (sys_suspend () == -1)
11131 printf ("Not running as a subprocess;\n");
11132 printf ("you can continue or abort.\n");
11134 #else /* not VMS */
11135 /* Perhaps should really fork an inferior shell?
11136 But that would not provide any way to get back
11137 to the original shell, ever. */
11138 printf ("No support for stopping a process on this operating system;\n");
11139 printf ("you can continue or abort.\n");
11140 #endif /* not VMS */
11141 #endif /* not SIGTSTP */
11143 /* We must remain inside the screen area when the internal terminal
11144 is used. Note that [Enter] is not echoed by dos. */
11147 /* It doesn't work to autosave while GC is in progress;
11148 the code used for auto-saving doesn't cope with the mark bit. */
11149 if (!gc_in_progress
)
11151 printf ("Auto-save? (y or n) ");
11153 if (((c
= getchar ()) & ~040) == 'Y')
11155 Fdo_auto_save (Qt
, Qnil
);
11157 printf ("\r\nAuto-save done");
11158 #else /* not MSDOS */
11159 printf ("Auto-save done\n");
11160 #endif /* not MSDOS */
11162 while (c
!= '\n') c
= getchar ();
11166 /* During GC, it must be safe to reenable quitting again. */
11167 Vinhibit_quit
= Qnil
;
11170 #endif /* not MSDOS */
11171 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11172 printf ("but will instead do a real quit after garbage collection ends\r\n");
11177 printf ("\r\nAbort? (y or n) ");
11178 #else /* not MSDOS */
11180 printf ("Abort (and enter debugger)? (y or n) ");
11181 #else /* not VMS */
11182 printf ("Abort (and dump core)? (y or n) ");
11183 #endif /* not VMS */
11184 #endif /* not MSDOS */
11186 if (((c
= getchar ()) & ~040) == 'Y')
11188 while (c
!= '\n') c
= getchar ();
11190 printf ("\r\nContinuing...\r\n");
11191 #else /* not MSDOS */
11192 printf ("Continuing...\n");
11193 #endif /* not MSDOS */
11195 init_all_sys_modes ();
11200 /* If executing a function that wants to be interrupted out of
11201 and the user has not deferred quitting by binding `inhibit-quit'
11202 then quit right away. */
11203 if (immediate_quit
&& NILP (Vinhibit_quit
))
11205 struct gl_state_s saved
;
11206 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11208 immediate_quit
= 0;
11211 GCPRO4 (saved
.object
, saved
.global_code
,
11212 saved
.current_syntax_table
, saved
.old_prop
);
11213 Fsignal (Qquit
, Qnil
);
11218 /* Else request quit when it's safe */
11222 if (waiting_for_input
&& !echoing
)
11223 quit_throw_to_read_char ();
11226 /* Handle a C-g by making read_char return C-g. */
11229 quit_throw_to_read_char ()
11232 /* Prevent another signal from doing this before we finish. */
11233 clear_waiting_for_input ();
11236 Vunread_command_events
= Qnil
;
11237 unread_command_char
= -1;
11239 #if 0 /* Currently, sit_for is called from read_char without turning
11240 off polling. And that can call set_waiting_for_input.
11241 It seems to be harmless. */
11242 #ifdef POLL_FOR_INPUT
11243 /* May be > 1 if in recursive minibuffer. */
11244 if (poll_suppress_count
== 0)
11248 if (FRAMEP (internal_last_event_frame
)
11249 && !EQ (internal_last_event_frame
, selected_frame
))
11250 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11253 _longjmp (getcjmp
, 1);
11256 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11257 doc
: /* Set interrupt mode of reading keyboard input.
11258 If INTERRUPT is non-nil, Emacs will use input interrupts;
11259 otherwise Emacs uses CBREAK mode.
11261 See also `current-input-mode'. */)
11263 Lisp_Object interrupt
;
11265 int new_interrupt_input
;
11267 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11268 #ifdef HAVE_X_WINDOWS
11269 if (x_display_list
!= NULL
)
11271 /* When using X, don't give the user a real choice,
11272 because we haven't implemented the mechanisms to support it. */
11273 #ifdef NO_SOCK_SIGIO
11274 new_interrupt_input
= 0;
11275 #else /* not NO_SOCK_SIGIO */
11276 new_interrupt_input
= 1;
11277 #endif /* NO_SOCK_SIGIO */
11281 new_interrupt_input
= !NILP (interrupt
);
11282 #else /* not SIGIO */
11283 new_interrupt_input
= 0;
11284 #endif /* not SIGIO */
11286 /* Our VMS input only works by interrupts, as of now. */
11288 new_interrupt_input
= 1;
11291 if (new_interrupt_input
!= interrupt_input
)
11293 #ifdef POLL_FOR_INPUT
11297 /* this causes startup screen to be restored and messes with the mouse */
11298 reset_all_sys_modes ();
11300 interrupt_input
= new_interrupt_input
;
11302 init_all_sys_modes ();
11305 #ifdef POLL_FOR_INPUT
11306 poll_suppress_count
= 1;
11313 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11314 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11315 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11316 C-q in key sequences.
11318 This setting only has an effect on tty terminals and only when
11319 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11321 See also `current-input-mode'. */)
11323 Lisp_Object flow
, terminal
;
11325 struct terminal
*t
= get_terminal (terminal
, 1);
11326 struct tty_display_info
*tty
;
11327 if (t
== NULL
|| t
->type
!= output_termcap
)
11329 tty
= t
->display_info
.tty
;
11331 if (tty
->flow_control
!= !NILP (flow
))
11334 /* this causes startup screen to be restored and messes with the mouse */
11335 reset_sys_modes (tty
);
11338 tty
->flow_control
= !NILP (flow
);
11341 init_sys_modes (tty
);
11347 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11348 doc
: /* Enable or disable 8-bit input on TERMINAL.
11349 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11350 bit as the Meta modifier.
11352 If META is nil, Emacs will ignore the top bit, on the assumption it is
11355 Otherwise, Emacs will accept and pass through 8-bit input without
11356 specially interpreting the top bit.
11358 This setting only has an effect on tty terminal devices.
11360 Optional parameter TERMINAL specifies the tty terminal device to use.
11361 It may be a terminal id, a frame, or nil for the terminal used by the
11362 currently selected frame.
11364 See also `current-input-mode'. */)
11366 Lisp_Object meta
, terminal
;
11368 struct terminal
*t
= get_terminal (terminal
, 1);
11369 struct tty_display_info
*tty
;
11372 if (t
== NULL
|| t
->type
!= output_termcap
)
11374 tty
= t
->display_info
.tty
;
11378 else if (EQ (meta
, Qt
))
11383 if (tty
->meta_key
!= new_meta
)
11386 /* this causes startup screen to be restored and messes with the mouse */
11387 reset_sys_modes (tty
);
11390 tty
->meta_key
= new_meta
;
11393 init_sys_modes (tty
);
11399 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11400 doc
: /* Specify character used for quitting.
11401 QUIT must be an ASCII character.
11403 This function only has an effect on the controlling tty of the Emacs
11406 See also `current-input-mode'. */)
11410 struct terminal
*t
= get_named_tty ("/dev/tty");
11411 struct tty_display_info
*tty
;
11412 if (t
== NULL
|| t
->type
!= output_termcap
)
11414 tty
= t
->display_info
.tty
;
11416 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11417 error ("QUIT must be an ASCII character");
11420 /* this causes startup screen to be restored and messes with the mouse */
11421 reset_sys_modes (tty
);
11424 /* Don't let this value be out of range. */
11425 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11428 init_sys_modes (tty
);
11434 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11435 doc
: /* Set mode of reading keyboard input.
11436 First arg INTERRUPT non-nil means use input interrupts;
11437 nil means use CBREAK mode.
11438 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11439 (no effect except in CBREAK mode).
11440 Third arg META t means accept 8-bit input (for a Meta key).
11441 META nil means ignore the top bit, on the assumption it is parity.
11442 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11443 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11444 See also `current-input-mode'. */)
11445 (interrupt
, flow
, meta
, quit
)
11446 Lisp_Object interrupt
, flow
, meta
, quit
;
11448 Fset_input_interrupt_mode (interrupt
);
11449 Fset_output_flow_control (flow
, Qnil
);
11450 Fset_input_meta_mode (meta
, Qnil
);
11452 Fset_quit_char (quit
);
11456 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11457 doc
: /* Return information about the way Emacs currently reads keyboard input.
11458 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11459 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11460 nil, Emacs is using CBREAK mode.
11461 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11462 terminal; this does not apply if Emacs uses interrupt-driven input.
11463 META is t if accepting 8-bit input with 8th bit as Meta flag.
11464 META nil means ignoring the top bit, on the assumption it is parity.
11465 META is neither t nor nil if accepting 8-bit input and using
11466 all 8 bits as the character code.
11467 QUIT is the character Emacs currently uses to quit.
11468 The elements of this list correspond to the arguments of
11469 `set-input-mode'. */)
11472 Lisp_Object val
[4];
11473 struct frame
*sf
= XFRAME (selected_frame
);
11475 val
[0] = interrupt_input
? Qt
: Qnil
;
11476 if (FRAME_TERMCAP_P (sf
))
11478 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11479 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11481 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11488 XSETFASTINT (val
[3], quit_char
);
11490 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11493 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11494 doc
: /* Return position information for pixel coordinates X and Y.
11495 By default, X and Y are relative to text area of the selected window.
11496 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11497 If optional fourth arg WHOLE is non-nil, X is relative to the left
11498 edge of the window.
11500 The return value is similar to a mouse click position:
11501 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11502 IMAGE (DX . DY) (WIDTH . HEIGHT))
11503 The `posn-' functions access elements of such lists. */)
11504 (x
, y
, frame_or_window
, whole
)
11505 Lisp_Object x
, y
, frame_or_window
, whole
;
11510 if (NILP (frame_or_window
))
11511 frame_or_window
= selected_window
;
11513 if (WINDOWP (frame_or_window
))
11517 CHECK_LIVE_WINDOW (frame_or_window
);
11519 w
= XWINDOW (frame_or_window
);
11520 XSETINT (x
, (XINT (x
)
11521 + WINDOW_LEFT_EDGE_X (w
)
11523 ? window_box_left_offset (w
, TEXT_AREA
)
11525 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11526 frame_or_window
= w
->frame
;
11529 CHECK_LIVE_FRAME (frame_or_window
);
11531 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11534 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11535 doc
: /* Return position information for buffer POS in WINDOW.
11536 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11538 Return nil if position is not visible in window. Otherwise,
11539 the return value is similar to that returned by `event-start' for
11540 a mouse click at the upper left corner of the glyph corresponding
11541 to the given buffer position:
11542 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11543 IMAGE (DX . DY) (WIDTH . HEIGHT))
11544 The `posn-' functions access elements of such lists. */)
11546 Lisp_Object pos
, window
;
11551 window
= selected_window
;
11553 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11556 Lisp_Object x
= XCAR (tem
);
11557 Lisp_Object y
= XCAR (XCDR (tem
));
11559 /* Point invisible due to hscrolling? */
11562 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11570 * Set up a new kboard object with reasonable initial values.
11576 kb
->Voverriding_terminal_local_map
= Qnil
;
11577 kb
->Vlast_command
= Qnil
;
11578 kb
->Vreal_last_command
= Qnil
;
11579 kb
->Vkeyboard_translate_table
= Qnil
;
11580 kb
->Vlast_repeatable_command
= Qnil
;
11581 kb
->Vprefix_arg
= Qnil
;
11582 kb
->Vlast_prefix_arg
= Qnil
;
11583 kb
->kbd_queue
= Qnil
;
11584 kb
->kbd_queue_has_data
= 0;
11585 kb
->immediate_echo
= 0;
11586 kb
->echo_string
= Qnil
;
11587 kb
->echo_after_prompt
= -1;
11588 kb
->kbd_macro_buffer
= 0;
11589 kb
->kbd_macro_bufsize
= 0;
11590 kb
->defining_kbd_macro
= Qnil
;
11591 kb
->Vlast_kbd_macro
= Qnil
;
11592 kb
->reference_count
= 0;
11593 kb
->Vsystem_key_alist
= Qnil
;
11594 kb
->system_key_syms
= Qnil
;
11595 kb
->Vwindow_system
= Qt
; /* Unset. */
11596 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11597 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11598 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11599 kb
->Vdefault_minibuffer_frame
= Qnil
;
11603 * Destroy the contents of a kboard object, but not the object itself.
11604 * We use this just before deleting it, or if we're going to initialize
11605 * it a second time.
11611 if (kb
->kbd_macro_buffer
)
11612 xfree (kb
->kbd_macro_buffer
);
11615 #ifdef MULTI_KBOARD
11617 /* Free KB and memory referenced from it. */
11625 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11628 *kbp
= kb
->next_kboard
;
11630 /* Prevent a dangling reference to KB. */
11631 if (kb
== current_kboard
11632 && FRAMEP (selected_frame
)
11633 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11635 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11637 if (current_kboard
== kb
)
11645 #endif /* MULTI_KBOARD */
11650 /* This is correct before outermost invocation of the editor loop */
11651 command_loop_level
= -1;
11652 immediate_quit
= 0;
11653 quit_char
= Ctl ('g');
11654 Vunread_command_events
= Qnil
;
11655 unread_command_char
= -1;
11656 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11658 recent_keys_index
= 0;
11659 kbd_fetch_ptr
= kbd_buffer
;
11660 kbd_store_ptr
= kbd_buffer
;
11661 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11662 do_mouse_tracking
= Qnil
;
11665 interrupt_input_blocked
= 0;
11666 interrupt_input_pending
= 0;
11668 /* This means that command_loop_1 won't try to select anything the first
11670 internal_last_event_frame
= Qnil
;
11671 Vlast_event_frame
= internal_last_event_frame
;
11673 #ifdef MULTI_KBOARD
11674 current_kboard
= initial_kboard
;
11676 /* Re-initialize the keyboard again. */
11677 wipe_kboard (current_kboard
);
11678 init_kboard (current_kboard
);
11679 /* A value of nil for Vwindow_system normally means a tty, but we also use
11680 it for the initial terminal since there is no window system there. */
11681 current_kboard
->Vwindow_system
= Qnil
;
11683 if (!noninteractive
)
11685 /* Before multi-tty support, these handlers used to be installed
11686 only if the current session was a tty session. Now an Emacs
11687 session may have multiple display types, so we always handle
11688 SIGINT. There is special code in interrupt_signal to exit
11689 Emacs on SIGINT when there are no termcap frames on the
11690 controlling terminal. */
11691 signal (SIGINT
, interrupt_signal
);
11692 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11693 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11694 SIGQUIT and we can't tell which one it will give us. */
11695 signal (SIGQUIT
, interrupt_signal
);
11696 #endif /* HAVE_TERMIO */
11698 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11700 if (!noninteractive
)
11701 signal (SIGIO
, input_available_signal
);
11704 /* Use interrupt input by default, if it works and noninterrupt input
11705 has deficiencies. */
11707 #ifdef INTERRUPT_INPUT
11708 interrupt_input
= 1;
11710 interrupt_input
= 0;
11713 /* Our VMS input only works by interrupts, as of now. */
11715 interrupt_input
= 1;
11721 if (keyboard_init_hook
)
11722 (*keyboard_init_hook
) ();
11724 #ifdef POLL_FOR_INPUT
11725 poll_suppress_count
= 1;
11730 /* This type's only use is in syms_of_keyboard, to initialize the
11731 event header symbols and put properties on them. */
11732 struct event_head
{
11738 struct event_head head_table
[] = {
11739 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11740 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11741 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11742 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11743 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11744 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11745 /* `select-window' should be handled just like `switch-frame'
11746 in read_key_sequence. */
11747 {&Qselect_window
, "select-window", &Qswitch_frame
}
11751 syms_of_keyboard ()
11753 pending_funcalls
= Qnil
;
11755 Vpre_help_message
= Qnil
;
11756 staticpro (&Vpre_help_message
);
11758 Vlispy_mouse_stem
= build_string ("mouse");
11759 staticpro (&Vlispy_mouse_stem
);
11762 QCimage
= intern (":image");
11763 staticpro (&QCimage
);
11765 staticpro (&Qhelp_echo
);
11766 Qhelp_echo
= intern ("help-echo");
11769 Qrtl
= intern (":rtl");
11771 staticpro (&item_properties
);
11772 item_properties
= Qnil
;
11774 staticpro (&tool_bar_item_properties
);
11775 tool_bar_item_properties
= Qnil
;
11776 staticpro (&tool_bar_items_vector
);
11777 tool_bar_items_vector
= Qnil
;
11779 staticpro (&real_this_command
);
11780 real_this_command
= Qnil
;
11782 Qtimer_event_handler
= intern ("timer-event-handler");
11783 staticpro (&Qtimer_event_handler
);
11785 Qdisabled_command_function
= intern ("disabled-command-function");
11786 staticpro (&Qdisabled_command_function
);
11788 Qself_insert_command
= intern ("self-insert-command");
11789 staticpro (&Qself_insert_command
);
11791 Qforward_char
= intern ("forward-char");
11792 staticpro (&Qforward_char
);
11794 Qbackward_char
= intern ("backward-char");
11795 staticpro (&Qbackward_char
);
11797 Qdisabled
= intern ("disabled");
11798 staticpro (&Qdisabled
);
11800 Qundefined
= intern ("undefined");
11801 staticpro (&Qundefined
);
11803 Qpre_command_hook
= intern ("pre-command-hook");
11804 staticpro (&Qpre_command_hook
);
11806 Qpost_command_hook
= intern ("post-command-hook");
11807 staticpro (&Qpost_command_hook
);
11809 Qdeferred_action_function
= intern ("deferred-action-function");
11810 staticpro (&Qdeferred_action_function
);
11812 Qcommand_hook_internal
= intern ("command-hook-internal");
11813 staticpro (&Qcommand_hook_internal
);
11815 Qfunction_key
= intern ("function-key");
11816 staticpro (&Qfunction_key
);
11817 Qmouse_click
= intern ("mouse-click");
11818 staticpro (&Qmouse_click
);
11819 #if defined (WINDOWSNT) || defined (MAC_OS)
11820 Qlanguage_change
= intern ("language-change");
11821 staticpro (&Qlanguage_change
);
11823 Qdrag_n_drop
= intern ("drag-n-drop");
11824 staticpro (&Qdrag_n_drop
);
11826 Qsave_session
= intern ("save-session");
11827 staticpro (&Qsave_session
);
11830 Qmac_apple_event
= intern ("mac-apple-event");
11831 staticpro (&Qmac_apple_event
);
11835 Qdbus_event
= intern ("dbus-event");
11836 staticpro (&Qdbus_event
);
11839 Qmenu_enable
= intern ("menu-enable");
11840 staticpro (&Qmenu_enable
);
11841 Qmenu_alias
= intern ("menu-alias");
11842 staticpro (&Qmenu_alias
);
11843 QCenable
= intern (":enable");
11844 staticpro (&QCenable
);
11845 QCvisible
= intern (":visible");
11846 staticpro (&QCvisible
);
11847 QChelp
= intern (":help");
11848 staticpro (&QChelp
);
11849 QCfilter
= intern (":filter");
11850 staticpro (&QCfilter
);
11851 QCbutton
= intern (":button");
11852 staticpro (&QCbutton
);
11853 QCkeys
= intern (":keys");
11854 staticpro (&QCkeys
);
11855 QCkey_sequence
= intern (":key-sequence");
11856 staticpro (&QCkey_sequence
);
11857 QCtoggle
= intern (":toggle");
11858 staticpro (&QCtoggle
);
11859 QCradio
= intern (":radio");
11860 staticpro (&QCradio
);
11862 Qmode_line
= intern ("mode-line");
11863 staticpro (&Qmode_line
);
11864 Qvertical_line
= intern ("vertical-line");
11865 staticpro (&Qvertical_line
);
11866 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11867 staticpro (&Qvertical_scroll_bar
);
11868 Qmenu_bar
= intern ("menu-bar");
11869 staticpro (&Qmenu_bar
);
11871 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11872 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11873 staticpro (&Qmouse_fixup_help_message
);
11876 Qabove_handle
= intern ("above-handle");
11877 staticpro (&Qabove_handle
);
11878 Qhandle
= intern ("handle");
11879 staticpro (&Qhandle
);
11880 Qbelow_handle
= intern ("below-handle");
11881 staticpro (&Qbelow_handle
);
11882 Qup
= intern ("up");
11884 Qdown
= intern ("down");
11885 staticpro (&Qdown
);
11886 Qtop
= intern ("top");
11888 Qbottom
= intern ("bottom");
11889 staticpro (&Qbottom
);
11890 Qend_scroll
= intern ("end-scroll");
11891 staticpro (&Qend_scroll
);
11892 Qratio
= intern ("ratio");
11893 staticpro (&Qratio
);
11895 Qevent_kind
= intern ("event-kind");
11896 staticpro (&Qevent_kind
);
11897 Qevent_symbol_elements
= intern ("event-symbol-elements");
11898 staticpro (&Qevent_symbol_elements
);
11899 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11900 staticpro (&Qevent_symbol_element_mask
);
11901 Qmodifier_cache
= intern ("modifier-cache");
11902 staticpro (&Qmodifier_cache
);
11904 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11905 staticpro (&Qrecompute_lucid_menubar
);
11906 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11907 staticpro (&Qactivate_menubar_hook
);
11909 Qpolling_period
= intern ("polling-period");
11910 staticpro (&Qpolling_period
);
11912 Qinput_method_function
= intern ("input-method-function");
11913 staticpro (&Qinput_method_function
);
11915 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11916 staticpro (&Qinput_method_exit_on_first_char
);
11917 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11918 staticpro (&Qinput_method_use_echo_area
);
11920 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11921 Fset (Qinput_method_use_echo_area
, Qnil
);
11923 last_point_position_buffer
= Qnil
;
11924 last_point_position_window
= Qnil
;
11927 struct event_head
*p
;
11929 for (p
= head_table
;
11930 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11933 *p
->var
= intern (p
->name
);
11934 staticpro (p
->var
);
11935 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11936 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11940 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11941 staticpro (&button_down_location
);
11942 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11943 staticpro (&mouse_syms
);
11944 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11945 staticpro (&wheel_syms
);
11949 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11951 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11952 for (i
= 0; i
< len
; i
++)
11953 if (modifier_names
[i
])
11954 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11955 staticpro (&modifier_symbols
);
11958 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11959 staticpro (&recent_keys
);
11961 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11962 staticpro (&this_command_keys
);
11964 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11965 staticpro (&raw_keybuf
);
11967 Qextended_command_history
= intern ("extended-command-history");
11968 Fset (Qextended_command_history
, Qnil
);
11969 staticpro (&Qextended_command_history
);
11971 accent_key_syms
= Qnil
;
11972 staticpro (&accent_key_syms
);
11974 func_key_syms
= Qnil
;
11975 staticpro (&func_key_syms
);
11977 drag_n_drop_syms
= Qnil
;
11978 staticpro (&drag_n_drop_syms
);
11980 unread_switch_frame
= Qnil
;
11981 staticpro (&unread_switch_frame
);
11983 internal_last_event_frame
= Qnil
;
11984 staticpro (&internal_last_event_frame
);
11986 read_key_sequence_cmd
= Qnil
;
11987 staticpro (&read_key_sequence_cmd
);
11989 menu_bar_one_keymap_changed_items
= Qnil
;
11990 staticpro (&menu_bar_one_keymap_changed_items
);
11992 menu_bar_items_vector
= Qnil
;
11993 staticpro (&menu_bar_items_vector
);
11995 help_form_saved_window_configs
= Qnil
;
11996 staticpro (&help_form_saved_window_configs
);
11998 defsubr (&Scurrent_idle_time
);
11999 defsubr (&Sevent_symbol_parse_modifiers
);
12000 defsubr (&Sevent_convert_list
);
12001 defsubr (&Sread_key_sequence
);
12002 defsubr (&Sread_key_sequence_vector
);
12003 defsubr (&Srecursive_edit
);
12004 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
12005 defsubr (&Strack_mouse
);
12007 defsubr (&Sinput_pending_p
);
12008 defsubr (&Scommand_execute
);
12009 defsubr (&Srecent_keys
);
12010 defsubr (&Sthis_command_keys
);
12011 defsubr (&Sthis_command_keys_vector
);
12012 defsubr (&Sthis_single_command_keys
);
12013 defsubr (&Sthis_single_command_raw_keys
);
12014 defsubr (&Sreset_this_command_lengths
);
12015 defsubr (&Sclear_this_command_keys
);
12016 defsubr (&Ssuspend_emacs
);
12017 defsubr (&Sabort_recursive_edit
);
12018 defsubr (&Sexit_recursive_edit
);
12019 defsubr (&Srecursion_depth
);
12020 defsubr (&Stop_level
);
12021 defsubr (&Sdiscard_input
);
12022 defsubr (&Sopen_dribble_file
);
12023 defsubr (&Sset_input_interrupt_mode
);
12024 defsubr (&Sset_output_flow_control
);
12025 defsubr (&Sset_input_meta_mode
);
12026 defsubr (&Sset_quit_char
);
12027 defsubr (&Sset_input_mode
);
12028 defsubr (&Scurrent_input_mode
);
12029 defsubr (&Sexecute_extended_command
);
12030 defsubr (&Sposn_at_point
);
12031 defsubr (&Sposn_at_x_y
);
12033 DEFVAR_LISP ("last-command-char", &last_command_char
,
12034 doc
: /* Last input event that was part of a command. */);
12036 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
12037 doc
: /* Last input event that was part of a command. */);
12039 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
12040 doc
: /* Last input event in a command, except for mouse menu events.
12041 Mouse menus give back keys that don't look like mouse events;
12042 this variable holds the actual mouse event that led to the menu,
12043 so that you can determine whether the command was run by mouse or not. */);
12045 DEFVAR_LISP ("last-input-char", &last_input_char
,
12046 doc
: /* Last input event. */);
12048 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
12049 doc
: /* Last input event. */);
12051 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
12052 doc
: /* List of events to be read as the command input.
12053 These events are processed first, before actual keyboard input.
12054 Events read from this list are not normally added to `this-command-keys',
12055 as they will already have been added once as they were read for the first time.
12056 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
12057 Vunread_command_events
= Qnil
;
12059 DEFVAR_INT ("unread-command-char", &unread_command_char
,
12060 doc
: /* If not -1, an object to be read as next command input event. */);
12062 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
12063 doc
: /* List of events to be processed as input by input methods.
12064 These events are processed before `unread-command-events'
12065 and actual keyboard input, but are not given to `input-method-function'. */);
12066 Vunread_post_input_method_events
= Qnil
;
12068 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
12069 doc
: /* List of events to be processed as input by input methods.
12070 These events are processed after `unread-command-events', but
12071 before actual keyboard input.
12072 If there's an active input method, the events are given to
12073 `input-method-function'. */);
12074 Vunread_input_method_events
= Qnil
;
12076 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
12077 doc
: /* Meta-prefix character code.
12078 Meta-foo as command input turns into this character followed by foo. */);
12079 XSETINT (meta_prefix_char
, 033);
12081 DEFVAR_KBOARD ("last-command", Vlast_command
,
12082 doc
: /* The last command executed.
12083 Normally a symbol with a function definition, but can be whatever was found
12084 in the keymap, or whatever the variable `this-command' was set to by that
12087 The value `mode-exit' is special; it means that the previous command
12088 read an event that told it to exit, and it did so and unread that event.
12089 In other words, the present command is the event that made the previous
12092 The value `kill-region' is special; it means that the previous command
12093 was a kill command.
12095 `last-command' has a separate binding for each terminal device.
12096 See Info node `(elisp)Multiple displays'. */);
12098 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12099 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12101 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12102 doc
: /* Last command that may be repeated.
12103 The last command executed that was not bound to an input event.
12104 This is the command `repeat' will try to repeat. */);
12106 DEFVAR_LISP ("this-command", &Vthis_command
,
12107 doc
: /* The command now being executed.
12108 The command can set this variable; whatever is put here
12109 will be in `last-command' during the following command. */);
12110 Vthis_command
= Qnil
;
12112 DEFVAR_LISP ("this-command-keys-shift-translated",
12113 &Vthis_command_keys_shift_translated
,
12114 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12115 Shift-translation occurs when there is no binding for the key sequence
12116 as entered, but a binding was found by changing an upper-case letter
12117 to lower-case, or a shifted function key to an unshifted one. */);
12118 Vthis_command_keys_shift_translated
= Qnil
;
12120 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12121 doc
: /* The command bound to the current key sequence before remapping.
12122 It equals `this-command' if the original command was not remapped through
12123 any of the active keymaps. Otherwise, the value of `this-command' is the
12124 result of looking up the original command in the active keymaps. */);
12125 Vthis_original_command
= Qnil
;
12127 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12128 doc
: /* *Number of input events between auto-saves.
12129 Zero means disable autosaving due to number of characters typed. */);
12130 auto_save_interval
= 300;
12132 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12133 doc
: /* *Number of seconds idle time before auto-save.
12134 Zero or nil means disable auto-saving due to idleness.
12135 After auto-saving due to this many seconds of idle time,
12136 Emacs also does a garbage collection if that seems to be warranted. */);
12137 XSETFASTINT (Vauto_save_timeout
, 30);
12139 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12140 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12141 The value may be integer or floating point. */);
12142 Vecho_keystrokes
= make_number (1);
12144 DEFVAR_INT ("polling-period", &polling_period
,
12145 doc
: /* *Interval between polling for input during Lisp execution.
12146 The reason for polling is to make C-g work to stop a running program.
12147 Polling is needed only when using X windows and SIGIO does not work.
12148 Polling is automatically disabled in all other cases. */);
12149 polling_period
= 2;
12151 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12152 doc
: /* *Maximum time between mouse clicks to make a double-click.
12153 Measured in milliseconds. The value nil means disable double-click
12154 recognition; t means double-clicks have no time limit and are detected
12155 by position only. */);
12156 Vdouble_click_time
= make_number (500);
12158 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12159 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12160 On window-system frames, value is the number of pixels the mouse may have
12161 moved horizontally or vertically between two clicks to make a double-click.
12162 On non window-system frames, value is interpreted in units of 1/8 characters
12165 This variable is also the threshold for motion of the mouse
12166 to count as a drag. */);
12167 double_click_fuzz
= 3;
12169 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12170 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12171 inhibit_local_menu_bar_menus
= 0;
12173 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12174 doc
: /* Number of complete key sequences read as input so far.
12175 This includes key sequences read from keyboard macros.
12176 The number is effectively the number of interactive command invocations. */);
12177 num_input_keys
= 0;
12179 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12180 doc
: /* Number of input events read from the keyboard so far.
12181 This does not include events generated by keyboard macros. */);
12182 num_nonmacro_input_events
= 0;
12184 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12185 doc
: /* The frame in which the most recently read event occurred.
12186 If the last event came from a keyboard macro, this is set to `macro'. */);
12187 Vlast_event_frame
= Qnil
;
12189 /* This variable is set up in sysdep.c. */
12190 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12191 doc
: /* The ERASE character as set by the user with stty. */);
12193 DEFVAR_LISP ("help-char", &Vhelp_char
,
12194 doc
: /* Character to recognize as meaning Help.
12195 When it is read, do `(eval help-form)', and display result if it's a string.
12196 If the value of `help-form' is nil, this char can be read normally. */);
12197 XSETINT (Vhelp_char
, Ctl ('H'));
12199 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12200 doc
: /* List of input events to recognize as meaning Help.
12201 These work just like the value of `help-char' (see that). */);
12202 Vhelp_event_list
= Qnil
;
12204 DEFVAR_LISP ("help-form", &Vhelp_form
,
12205 doc
: /* Form to execute when character `help-char' is read.
12206 If the form returns a string, that string is displayed.
12207 If `help-form' is nil, the help char is not recognized. */);
12210 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12211 doc
: /* Command to run when `help-char' character follows a prefix key.
12212 This command is used only when there is no actual binding
12213 for that character after that prefix key. */);
12214 Vprefix_help_command
= Qnil
;
12216 DEFVAR_LISP ("top-level", &Vtop_level
,
12217 doc
: /* Form to evaluate when Emacs starts up.
12218 Useful to set before you dump a modified Emacs. */);
12221 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12222 doc
: /* Translate table for local keyboard input, or nil.
12223 If non-nil, the value should be a char-table. Each character read
12224 from the keyboard is looked up in this char-table. If the value found
12225 there is non-nil, then it is used instead of the actual input character.
12227 The value can also be a string or vector, but this is considered obsolete.
12228 If it is a string or vector of length N, character codes N and up are left
12229 untranslated. In a vector, an element which is nil means "no translation".
12231 This is applied to the characters supplied to input methods, not their
12232 output. See also `translation-table-for-input'.
12234 This variable has a separate binding for each terminal. See Info node
12235 `(elisp)Multiple displays'. */);
12237 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12238 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12239 \(Even if the operating system has support for stopping a process.\) */);
12240 cannot_suspend
= 0;
12242 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12243 doc
: /* Non-nil means prompt with menus when appropriate.
12244 This is done when reading from a keymap that has a prompt string,
12245 for elements that have prompt strings.
12246 The menu is displayed on the screen
12247 if X menus were enabled at configuration
12248 time and the previous event was a mouse click prefix key.
12249 Otherwise, menu prompting uses the echo area. */);
12250 menu_prompting
= 1;
12252 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12253 doc
: /* Character to see next line of menu prompt.
12254 Type this character while in a menu prompt to rotate around the lines of it. */);
12255 XSETINT (menu_prompt_more_char
, ' ');
12257 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12258 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12259 Emacs applies the modifiers of the character stored here to each keyboard
12260 character it reads. For example, after evaluating the expression
12261 (setq extra-keyboard-modifiers ?\\C-x)
12262 all input characters will have the control modifier applied to them.
12264 Note that the character ?\\C-@, equivalent to the integer zero, does
12265 not count as a control character; rather, it counts as a character
12266 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12267 cancels any modification. */);
12268 extra_keyboard_modifiers
= 0;
12270 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12271 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12272 The command loop sets this to nil before each command,
12273 and tests the value when the command returns.
12274 Buffer modification stores t in this variable. */);
12275 Vdeactivate_mark
= Qnil
;
12277 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12278 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
12279 Vcommand_hook_internal
= Qnil
;
12281 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12282 doc
: /* Normal hook run before each command is executed.
12283 If an unhandled error happens in running this hook,
12284 the hook value is set to nil, since otherwise the error
12285 might happen repeatedly and make Emacs nonfunctional. */);
12286 Vpre_command_hook
= Qnil
;
12288 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12289 doc
: /* Normal hook run after each command is executed.
12290 If an unhandled error happens in running this hook,
12291 the hook value is set to nil, since otherwise the error
12292 might happen repeatedly and make Emacs nonfunctional. */);
12293 Vpost_command_hook
= Qnil
;
12296 DEFVAR_LISP ("echo-area-clear-hook", ...,
12297 doc
: /* Normal hook run when clearing the echo area. */);
12299 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12300 staticpro (&Qecho_area_clear_hook
);
12301 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12303 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12304 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12305 Vlucid_menu_bar_dirty_flag
= Qnil
;
12307 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12308 doc
: /* List of menu bar items to move to the end of the menu bar.
12309 The elements of the list are event types that may have menu bar bindings. */);
12310 Vmenu_bar_final_items
= Qnil
;
12312 DEFVAR_KBOARD ("overriding-terminal-local-map",
12313 Voverriding_terminal_local_map
,
12314 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12315 If this variable is non-nil, it is used as a keymap instead of the
12316 buffer's local map, and the minor mode keymaps and text property keymaps.
12317 It also replaces `overriding-local-map'.
12319 This variable is intended to let commands such as `universal-argument'
12320 set up a different keymap for reading the next command.
12322 `overriding-terminal-local-map' has a separate binding for each
12324 See Info node `(elisp)Multiple displays'. */);
12326 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12327 doc
: /* Keymap that overrides all other local keymaps.
12328 If this variable is non-nil, it is used as a keymap--replacing the
12329 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12330 Voverriding_local_map
= Qnil
;
12332 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12333 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12334 Otherwise, the menu bar continues to reflect the buffer's local map
12335 and the minor mode maps regardless of `overriding-local-map'. */);
12336 Voverriding_local_map_menu_flag
= Qnil
;
12338 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12339 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12340 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12342 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12343 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12345 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12346 doc
: /* Alist of system-specific X windows key symbols.
12347 Each element should have the form (N . SYMBOL) where N is the
12348 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12349 and SYMBOL is its name.
12351 `system-key-alist' has a separate binding for each terminal device.
12352 See Info node `(elisp)Multiple displays'. */);
12354 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12355 doc
: /* Keymap that translates key sequences to key sequences during input.
12356 This is used mainly for mapping key sequences into some preferred
12357 key events (symbols).
12359 The `read-key-sequence' function replaces any subsequence bound by
12360 `local-function-key-map' with its binding. More precisely, when the
12361 active keymaps have no binding for the current key sequence but
12362 `local-function-key-map' binds a suffix of the sequence to a vector or
12363 string, `read-key-sequence' replaces the matching suffix with its
12364 binding, and continues with the new sequence.
12366 If the binding is a function, it is called with one argument (the prompt)
12367 and its return value (a key sequence) is used.
12369 The events that come from bindings in `local-function-key-map' are not
12370 themselves looked up in `local-function-key-map'.
12372 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12373 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12374 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12375 typing `ESC O P x' would return [f1 x].
12377 `local-function-key-map' has a separate binding for each terminal
12378 device. See Info node `(elisp)Multiple displays'. If you need to
12379 define a binding on all terminals, change `function-key-map'
12380 instead. Initially, `local-function-key-map' is an empty keymap that
12381 has `function-key-map' as its parent on all terminal devices. */);
12383 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12384 doc
: /* Keymap that decodes input escape sequences.
12385 This is used mainly for mapping ASCII function key sequences into
12386 real Emacs function key events (symbols).
12388 The `read-key-sequence' function replaces any subsequence bound by
12389 `local-function-key-map' with its binding. Contrary to `function-key-map',
12390 this map applies its rebinding regardless of the presence of an ordinary
12391 binding. So it is more like `key-translation-map' except that it applies
12392 before `function-key-map' rather than after.
12394 If the binding is a function, it is called with one argument (the prompt)
12395 and its return value (a key sequence) is used.
12397 The events that come from bindings in `input-decode-map' are not
12398 themselves looked up in `input-decode-map'.
12400 This variable is keyboard-local. */);
12402 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12403 doc
: /* The parent keymap of all `local-function-key-map' instances.
12404 Function key definitions that apply to all terminal devices should go
12405 here. If a mapping is defined in both the current
12406 `local-function-key-map' binding and this variable, then the local
12407 definition will take precendence. */);
12408 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12410 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12411 doc
: /* Keymap of key translations that can override keymaps.
12412 This keymap works like `function-key-map', but comes after that,
12413 and its non-prefix bindings override ordinary bindings.
12414 Another difference is that it is global rather than keyboard-local. */);
12415 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12417 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12418 doc
: /* List of deferred actions to be performed at a later time.
12419 The precise format isn't relevant here; we just check whether it is nil. */);
12420 Vdeferred_action_list
= Qnil
;
12422 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12423 doc
: /* Function to call to handle deferred actions, after each command.
12424 This function is called with no arguments after each command
12425 whenever `deferred-action-list' is non-nil. */);
12426 Vdeferred_action_function
= Qnil
;
12428 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12429 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12430 The value can be a length of time to show the message for.
12431 If the value is non-nil and not a number, we wait 2 seconds. */);
12432 Vsuggest_key_bindings
= Qt
;
12434 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12435 doc
: /* List of active absolute time timers in order of increasing time. */);
12436 Vtimer_list
= Qnil
;
12438 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12439 doc
: /* List of active idle-time timers in order of increasing time. */);
12440 Vtimer_idle_list
= Qnil
;
12442 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12443 doc
: /* If non-nil, the function that implements the current input method.
12444 It's called with one argument, a printing character that was just read.
12445 \(That means a character with code 040...0176.)
12446 Typically this function uses `read-event' to read additional events.
12447 When it does so, it should first bind `input-method-function' to nil
12448 so it will not be called recursively.
12450 The function should return a list of zero or more events
12451 to be used as input. If it wants to put back some events
12452 to be reconsidered, separately, by the input method,
12453 it can add them to the beginning of `unread-command-events'.
12455 The input method function can find in `input-method-previous-method'
12456 the previous echo area message.
12458 The input method function should refer to the variables
12459 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12460 for guidance on what to do. */);
12461 Vinput_method_function
= Qnil
;
12463 DEFVAR_LISP ("input-method-previous-message",
12464 &Vinput_method_previous_message
,
12465 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12466 This variable exists because `read-event' clears the echo area
12467 before running the input method. It is nil if there was no message. */);
12468 Vinput_method_previous_message
= Qnil
;
12470 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12471 doc
: /* If non-nil, the function that implements the display of help.
12472 It's called with one argument, the help string to display. */);
12473 Vshow_help_function
= Qnil
;
12475 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12476 doc
: /* If non-nil, suppress point adjustment after executing a command.
12478 After a command is executed, if point is moved into a region that has
12479 special properties (e.g. composition, display), we adjust point to
12480 the boundary of the region. But, when a command sets this variable to
12481 non-nil, we suppress the point adjustment.
12483 This variable is set to nil before reading a command, and is checked
12484 just after executing the command. */);
12485 Vdisable_point_adjustment
= Qnil
;
12487 DEFVAR_LISP ("global-disable-point-adjustment",
12488 &Vglobal_disable_point_adjustment
,
12489 doc
: /* *If non-nil, always suppress point adjustment.
12491 The default value is nil, in which case, point adjustment are
12492 suppressed only after special commands that set
12493 `disable-point-adjustment' (which see) to non-nil. */);
12494 Vglobal_disable_point_adjustment
= Qnil
;
12496 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12497 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12498 If the value is not a number, such messages don't time out. */);
12499 Vminibuffer_message_timeout
= make_number (2);
12501 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12502 doc
: /* If non-nil, any keyboard input throws to this symbol.
12503 The value of that variable is passed to `quit-flag' and later causes a
12504 peculiar kind of quitting. */);
12505 Vthrow_on_input
= Qnil
;
12507 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12508 doc
: /* If non-nil, function to output error messages.
12509 The arguments are the error data, a list of the form
12510 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12511 such as just as `condition-case' would bind its variable to,
12512 the context (a string which normally goes at the start of the message),
12513 and the Lisp function within which the error was signaled. */);
12514 Vcommand_error_function
= Qnil
;
12516 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12517 &Venable_disabled_menus_and_buttons
,
12518 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12520 Help functions bind this to allow help on disabled menu items
12521 and tool-bar buttons. */);
12522 Venable_disabled_menus_and_buttons
= Qnil
;
12524 #ifdef MULTI_KBOARD
12525 /* Create the initial keyboard. */
12526 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12527 init_kboard (initial_kboard
);
12528 /* Vwindow_system is left at t for now. */
12529 initial_kboard
->next_kboard
= all_kboards
;
12530 all_kboards
= initial_kboard
;
12535 keys_of_keyboard ()
12537 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12538 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12539 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12540 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12541 initial_define_key (meta_map
, 'x', "execute-extended-command");
12543 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12544 "handle-delete-frame");
12545 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12546 current-prefix-arg, as is done in `handle-switch-frame'.
12547 But `handle-switch-frame is not run from the special-map.
12548 Commands from that map are run in a special way that automatically
12549 preserves the prefix-arg. Restoring the prefix arg here is not just
12550 redundant but harmful:
12552 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12553 - after the first prompt, the exit-minibuffer-hook is run which may
12554 iconify a frame and thus push a `iconify-frame' event.
12555 - after running exit-minibuffer-hook, current-prefix-arg is
12556 restored to the non-nil value it had before the prompt.
12557 - we enter the second prompt.
12558 current-prefix-arg is non-nil, prefix-arg is nil.
12559 - before running the first real event, we run the special iconify-frame
12560 event, but we pass the `special' arg to execute-command so
12561 current-prefix-arg and prefix-arg are left untouched.
12562 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12563 - the next key event will have a spuriously non-nil current-prefix-arg. */
12564 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12566 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12568 /* Handling it at such a low-level causes read_key_sequence to get
12569 * confused because it doesn't realize that the current_buffer was
12570 * changed by read_char.
12572 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12573 * "handle-select-window"); */
12574 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12575 "handle-save-session");
12578 /* Define a special event which is raised for dbus callback
12580 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12581 "dbus-handle-event");
12585 /* Mark the pointers in the kboard objects.
12586 Called by the Fgarbage_collector. */
12592 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12594 if (kb
->kbd_macro_buffer
)
12595 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12597 mark_object (kb
->Voverriding_terminal_local_map
);
12598 mark_object (kb
->Vlast_command
);
12599 mark_object (kb
->Vreal_last_command
);
12600 mark_object (kb
->Vkeyboard_translate_table
);
12601 mark_object (kb
->Vlast_repeatable_command
);
12602 mark_object (kb
->Vprefix_arg
);
12603 mark_object (kb
->Vlast_prefix_arg
);
12604 mark_object (kb
->kbd_queue
);
12605 mark_object (kb
->defining_kbd_macro
);
12606 mark_object (kb
->Vlast_kbd_macro
);
12607 mark_object (kb
->Vsystem_key_alist
);
12608 mark_object (kb
->system_key_syms
);
12609 mark_object (kb
->Vwindow_system
);
12610 mark_object (kb
->Vinput_decode_map
);
12611 mark_object (kb
->Vlocal_function_key_map
);
12612 mark_object (kb
->Vdefault_minibuffer_frame
);
12613 mark_object (kb
->echo_string
);
12616 struct input_event
*event
;
12617 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12619 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12620 event
= kbd_buffer
;
12621 if (event
->kind
!= SELECTION_REQUEST_EVENT
12622 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12624 mark_object (event
->x
);
12625 mark_object (event
->y
);
12627 mark_object (event
->frame_or_window
);
12628 mark_object (event
->arg
);
12633 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12634 (do not change this comment) */