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 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
34 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
47 #ifdef HAVE_GTK_AND_PTHREAD
55 #include <sys/ioctl.h>
57 #endif /* not MSDOS */
59 #include "syssignal.h"
61 #include <sys/types.h>
70 /* This is to get the definitions of the XK_ symbols. */
77 #endif /* HAVE_NTGUI */
87 /* Variables for blockinput.h: */
89 /* Non-zero if interrupt input is blocked right now. */
90 volatile int interrupt_input_blocked
;
92 /* Nonzero means an input interrupt has arrived
93 during the current critical section. */
94 int interrupt_input_pending
;
96 #define KBD_BUFFER_SIZE 4096
99 KBOARD
*initial_kboard
;
100 KBOARD
*current_kboard
;
104 KBOARD the_only_kboard
;
107 /* Non-nil disable property on a command means
108 do not execute it; call disabled-command-function's value instead. */
109 Lisp_Object Qdisabled
, Qdisabled_command_function
;
111 #define NUM_RECENT_KEYS (300)
112 int recent_keys_index
; /* Index for storing next element into recent_keys */
113 int total_keys
; /* Total number of elements stored into recent_keys */
114 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
116 /* Vector holding the key sequence that invoked the current command.
117 It is reused for each command, and it may be longer than the current
118 sequence; this_command_key_count indicates how many elements
119 actually mean something.
120 It's easier to staticpro a single Lisp_Object than an array. */
121 Lisp_Object this_command_keys
;
122 int this_command_key_count
;
124 /* 1 after calling Freset_this_command_lengths.
126 int this_command_key_count_reset
;
128 /* This vector is used as a buffer to record the events that were actually read
129 by read_key_sequence. */
130 Lisp_Object raw_keybuf
;
131 int raw_keybuf_count
;
133 /* Non-nil if the present key sequence was obtained by shift translation. */
134 Lisp_Object Vthis_command_keys_shift_translated
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
138 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 int this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static int before_command_key_count
;
147 static int before_command_echo_length
;
149 extern int minbuf_level
;
151 extern int message_enable_multibyte
;
153 /* If non-nil, the function that implements the display of help.
154 It's called with one argument, the help string to display. */
156 Lisp_Object Vshow_help_function
;
158 /* Nonzero means do menu prompting. */
160 static int menu_prompting
;
162 /* Character to see next line of menu prompt. */
164 static Lisp_Object menu_prompt_more_char
;
166 /* For longjmp to where kbd input is being done. */
168 static jmp_buf getcjmp
;
170 /* True while doing kbd input. */
171 int waiting_for_input
;
173 /* True while displaying for echoing. Delays C-g throwing. */
177 /* Non-null means we can start echoing at the next input pause even
178 though there is something in the echo area. */
180 static struct kboard
*ok_to_echo_at_next_pause
;
182 /* The kboard last echoing, or null for none. Reset to 0 in
183 cancel_echoing. If non-null, and a current echo area message
184 exists, and echo_message_buffer is eq to the current message
185 buffer, we know that the message comes from echo_kboard. */
187 struct kboard
*echo_kboard
;
189 /* The buffer used for echoing. Set in echo_now, reset in
192 Lisp_Object echo_message_buffer
;
194 /* Nonzero means disregard local maps for the menu bar. */
195 static int inhibit_local_menu_bar_menus
;
197 /* Nonzero means C-g should cause immediate error-signal. */
200 /* The user's hook function for outputting an error message. */
201 Lisp_Object Vcommand_error_function
;
203 /* The user's ERASE setting. */
204 Lisp_Object Vtty_erase_char
;
206 /* Character to recognize as the help char. */
207 Lisp_Object Vhelp_char
;
209 /* List of other event types to recognize as meaning "help". */
210 Lisp_Object Vhelp_event_list
;
212 /* Form to execute when help char is typed. */
213 Lisp_Object Vhelp_form
;
215 /* Command to run when the help character follows a prefix key. */
216 Lisp_Object Vprefix_help_command
;
218 /* List of items that should move to the end of the menu bar. */
219 Lisp_Object Vmenu_bar_final_items
;
221 /* Non-nil means show the equivalent key-binding for
222 any M-x command that has one.
223 The value can be a length of time to show the message for.
224 If the value is non-nil and not a number, we wait 2 seconds. */
225 Lisp_Object Vsuggest_key_bindings
;
227 /* How long to display an echo-area message when the minibuffer is active.
228 If the value is not a number, such messages don't time out. */
229 Lisp_Object Vminibuffer_message_timeout
;
231 /* Character that causes a quit. Normally C-g.
233 If we are running on an ordinary terminal, this must be an ordinary
234 ASCII char, since we want to make it our interrupt character.
236 If we are not running on an ordinary terminal, it still needs to be
237 an ordinary ASCII char. This character needs to be recognized in
238 the input interrupt handler. At this point, the keystroke is
239 represented as a struct input_event, while the desired quit
240 character is specified as a lispy event. The mapping from struct
241 input_events to lispy events cannot run in an interrupt handler,
242 and the reverse mapping is difficult for anything but ASCII
245 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
249 extern Lisp_Object current_global_map
;
250 extern int minibuf_level
;
252 /* If non-nil, this is a map that overrides all other local maps. */
253 Lisp_Object Voverriding_local_map
;
255 /* If non-nil, Voverriding_local_map applies to the menu bar. */
256 Lisp_Object Voverriding_local_map_menu_flag
;
258 /* Keymap that defines special misc events that should
259 be processed immediately at a low level. */
260 Lisp_Object Vspecial_event_map
;
262 /* Current depth in recursive edits. */
263 int command_loop_level
;
265 /* Total number of times command_loop has read a key sequence. */
266 EMACS_INT num_input_keys
;
268 /* Last input character read as a command. */
269 Lisp_Object last_command_char
;
271 /* Last input character read as a command, not counting menus
272 reached by the mouse. */
273 Lisp_Object last_nonmenu_event
;
275 /* Last input character read for any purpose. */
276 Lisp_Object last_input_char
;
278 /* If not Qnil, a list of objects to be read as subsequent command input. */
279 Lisp_Object Vunread_command_events
;
281 /* If not Qnil, a list of objects to be read as subsequent command input
282 including input method processing. */
283 Lisp_Object Vunread_input_method_events
;
285 /* If not Qnil, a list of objects to be read as subsequent command input
286 but NOT including input method processing. */
287 Lisp_Object Vunread_post_input_method_events
;
289 /* If not -1, an event to be read as subsequent command input. */
290 EMACS_INT unread_command_char
;
292 /* If not Qnil, this is a switch-frame event which we decided to put
293 off until the end of a key sequence. This should be read as the
294 next command input, after any unread_command_events.
296 read_key_sequence uses this to delay switch-frame events until the
297 end of the key sequence; Fread_char uses it to put off switch-frame
298 events until a non-ASCII event is acceptable as input. */
299 Lisp_Object unread_switch_frame
;
301 /* A mask of extra modifier bits to put into every keyboard char. */
302 EMACS_INT extra_keyboard_modifiers
;
304 /* Char to use as prefix when a meta character is typed in.
305 This is bound on entry to minibuffer in case ESC is changed there. */
307 Lisp_Object meta_prefix_char
;
309 /* Last size recorded for a current buffer which is not a minibuffer. */
310 static int last_non_minibuf_size
;
312 /* Number of idle seconds before an auto-save and garbage collection. */
313 static Lisp_Object Vauto_save_timeout
;
315 /* Total number of times read_char has returned. */
316 int num_input_events
;
318 /* Total number of times read_char has returned, outside of macros. */
319 EMACS_INT num_nonmacro_input_events
;
321 /* Auto-save automatically when this many characters have been typed
322 since the last time. */
324 static EMACS_INT auto_save_interval
;
326 /* Value of num_nonmacro_input_events as of last auto save. */
330 /* The command being executed by the command loop.
331 Commands may set this, and the value set will be copied into
332 current_kboard->Vlast_command instead of the actual command. */
333 Lisp_Object Vthis_command
;
335 /* This is like Vthis_command, except that commands never set it. */
336 Lisp_Object real_this_command
;
338 /* If the lookup of the command returns a binding, the original
339 command is stored in this-original-command. It is nil otherwise. */
340 Lisp_Object Vthis_original_command
;
342 /* The value of point when the last command was started. */
343 int last_point_position
;
345 /* The buffer that was current when the last command was started. */
346 Lisp_Object last_point_position_buffer
;
348 /* The window that was selected when the last command was started. */
349 Lisp_Object last_point_position_window
;
351 /* The frame in which the last input event occurred, or Qmacro if the
352 last event came from a macro. We use this to determine when to
353 generate switch-frame events. This may be cleared by functions
354 like Fselect_frame, to make sure that a switch-frame event is
355 generated by the next character. */
356 Lisp_Object internal_last_event_frame
;
358 /* A user-visible version of the above, intended to allow users to
359 figure out where the last event came from, if the event doesn't
360 carry that information itself (i.e. if it was a character). */
361 Lisp_Object Vlast_event_frame
;
363 /* The timestamp of the last input event we received from the X server.
364 X Windows wants this for selection ownership. */
365 unsigned long last_event_timestamp
;
367 Lisp_Object Qself_insert_command
;
368 Lisp_Object Qforward_char
;
369 Lisp_Object Qbackward_char
;
370 Lisp_Object Qundefined
;
371 Lisp_Object Qtimer_event_handler
;
373 /* read_key_sequence stores here the command definition of the
374 key sequence that it reads. */
375 Lisp_Object read_key_sequence_cmd
;
377 /* Echo unfinished commands after this many seconds of pause. */
378 Lisp_Object Vecho_keystrokes
;
380 /* Form to evaluate (if non-nil) when Emacs is started. */
381 Lisp_Object Vtop_level
;
383 /* If non-nil, this implements the current input method. */
384 Lisp_Object Vinput_method_function
;
385 Lisp_Object Qinput_method_function
;
387 /* When we call Vinput_method_function,
388 this holds the echo area message that was just erased. */
389 Lisp_Object Vinput_method_previous_message
;
391 /* Non-nil means deactivate the mark at end of this command. */
392 Lisp_Object Vdeactivate_mark
;
393 Lisp_Object Qdeactivate_mark
;
395 /* Menu bar specified in Lucid Emacs fashion. */
397 Lisp_Object Vlucid_menu_bar_dirty_flag
;
398 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
400 Lisp_Object Qecho_area_clear_hook
;
402 /* Hooks to run before and after each command. */
403 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
404 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
405 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
407 /* Parent keymap of terminal-local function-key-map instances. */
408 Lisp_Object Vfunction_key_map
;
410 /* Keymap of key translations that can override keymaps. */
411 Lisp_Object Vkey_translation_map
;
413 /* List of deferred actions to be performed at a later time.
414 The precise format isn't relevant here; we just check whether it is nil. */
415 Lisp_Object Vdeferred_action_list
;
417 /* Function to call to handle deferred actions, when there are any. */
418 Lisp_Object Vdeferred_action_function
;
419 Lisp_Object Qdeferred_action_function
;
421 Lisp_Object Qinput_method_exit_on_first_char
;
422 Lisp_Object Qinput_method_use_echo_area
;
424 /* File in which we write all commands we read. */
427 /* Nonzero if input is available. */
430 extern char *pending_malloc_warning
;
432 /* Circular buffer for pre-read keyboard input. */
434 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
436 /* Pointer to next available character in kbd_buffer.
437 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
438 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
439 next available char is in kbd_buffer[0]. */
440 static struct input_event
*kbd_fetch_ptr
;
442 /* Pointer to next place to store character in kbd_buffer. This
443 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
444 character should go in kbd_buffer[0]. */
445 static struct input_event
* volatile kbd_store_ptr
;
447 /* The above pair of variables forms a "queue empty" flag. When we
448 enqueue a non-hook event, we increment kbd_store_ptr. When we
449 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
450 there is input available if the two pointers are not equal.
452 Why not just have a flag set and cleared by the enqueuing and
453 dequeuing functions? Such a flag could be screwed up by interrupts
454 at inopportune times. */
456 /* If this flag is non-nil, we check mouse_moved to see when the
457 mouse moves, and motion events will appear in the input stream.
458 Otherwise, mouse motion is ignored. */
459 Lisp_Object do_mouse_tracking
;
461 /* Symbols to head events. */
462 Lisp_Object Qmouse_movement
;
463 Lisp_Object Qscroll_bar_movement
;
464 Lisp_Object Qswitch_frame
;
465 Lisp_Object Qdelete_frame
;
466 Lisp_Object Qiconify_frame
;
467 Lisp_Object Qmake_frame_visible
;
468 Lisp_Object Qselect_window
;
469 Lisp_Object Qhelp_echo
;
471 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
472 Lisp_Object Qmouse_fixup_help_message
;
475 /* Symbols to denote kinds of events. */
476 Lisp_Object Qfunction_key
;
477 Lisp_Object Qmouse_click
;
478 #if defined (WINDOWSNT)
479 Lisp_Object Qlanguage_change
;
481 Lisp_Object Qdrag_n_drop
;
482 Lisp_Object Qsave_session
;
484 Lisp_Object Qdbus_event
;
486 /* Lisp_Object Qmouse_movement; - also an event header */
488 /* Properties of event headers. */
489 Lisp_Object Qevent_kind
;
490 Lisp_Object Qevent_symbol_elements
;
492 /* menu item parts */
493 Lisp_Object Qmenu_alias
;
494 Lisp_Object Qmenu_enable
;
495 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
496 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
497 extern Lisp_Object Vdefine_key_rebound_commands
;
498 extern Lisp_Object Qmenu_item
;
500 /* An event header symbol HEAD may have a property named
501 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
502 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
503 mask of modifiers applied to it. If present, this is used to help
504 speed up parse_modifiers. */
505 Lisp_Object Qevent_symbol_element_mask
;
507 /* An unmodified event header BASE may have a property named
508 Qmodifier_cache, which is an alist mapping modifier masks onto
509 modified versions of BASE. If present, this helps speed up
511 Lisp_Object Qmodifier_cache
;
513 /* Symbols to use for parts of windows. */
514 Lisp_Object Qmode_line
;
515 Lisp_Object Qvertical_line
;
516 Lisp_Object Qvertical_scroll_bar
;
517 Lisp_Object Qmenu_bar
;
518 extern Lisp_Object Qleft_margin
, Qright_margin
;
519 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
520 extern Lisp_Object QCmap
;
522 Lisp_Object
recursive_edit_unwind (), command_loop ();
523 Lisp_Object
Fthis_command_keys ();
524 Lisp_Object Qextended_command_history
;
525 EMACS_TIME
timer_check ();
527 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
529 extern char *x_get_keysym_name ();
531 static void record_menu_key ();
532 static int echo_length ();
534 Lisp_Object Qpolling_period
;
536 /* List of absolute timers. Appears in order of next scheduled event. */
537 Lisp_Object Vtimer_list
;
539 /* List of idle time timers. Appears in order of next scheduled event. */
540 Lisp_Object Vtimer_idle_list
;
542 /* Incremented whenever a timer is run. */
545 extern Lisp_Object Vprint_level
, Vprint_length
;
547 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
549 EMACS_TIME
*input_available_clear_time
;
551 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
552 Default is 1 if INTERRUPT_INPUT is defined. */
555 /* Nonzero while interrupts are temporarily deferred during redisplay. */
556 int interrupts_deferred
;
558 /* Allow m- file to inhibit use of FIONREAD. */
559 #ifdef BROKEN_FIONREAD
563 /* We are unable to use interrupts if FIONREAD is not available,
564 so flush SIGIO so we won't try. */
565 #if !defined (FIONREAD)
571 /* If we support a window system, turn on the code to poll periodically
572 to detect C-g. It isn't actually used when doing interrupt input. */
573 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
574 #define POLL_FOR_INPUT
577 /* After a command is executed, if point is moved into a region that
578 has specific properties (e.g. composition, display), we adjust
579 point to the boundary of the region. But, if a command sets this
580 variable to non-nil, we suppress this point adjustment. This
581 variable is set to nil before reading a command. */
583 Lisp_Object Vdisable_point_adjustment
;
585 /* If non-nil, always disable point adjustment. */
587 Lisp_Object Vglobal_disable_point_adjustment
;
589 /* The time when Emacs started being idle. */
591 static EMACS_TIME timer_idleness_start_time
;
593 /* After Emacs stops being idle, this saves the last value
594 of timer_idleness_start_time from when it was idle. */
596 static EMACS_TIME timer_last_idleness_start_time
;
598 /* If non-nil, events produced by disabled menu items and tool-bar
599 buttons are not ignored. Help functions bind this to allow help on
600 those items and buttons. */
601 Lisp_Object Venable_disabled_menus_and_buttons
;
604 /* Global variable declarations. */
606 /* Flags for readable_events. */
607 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
608 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
609 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
611 /* Function for init_keyboard to call with no args (if nonzero). */
612 void (*keyboard_init_hook
) ();
614 static int read_avail_input
P_ ((int));
615 static void get_input_pending
P_ ((int *, int));
616 static int readable_events
P_ ((int));
617 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
618 Lisp_Object
, int *));
619 static Lisp_Object
read_char_x_menu_prompt ();
620 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
622 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
623 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
624 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
625 enum scroll_bar_part
,
626 Lisp_Object
, Lisp_Object
,
629 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
630 Lisp_Object
, char **,
631 Lisp_Object
*, unsigned));
632 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
633 static void save_getcjmp
P_ ((jmp_buf));
634 static void save_getcjmp ();
635 static void restore_getcjmp
P_ ((jmp_buf));
636 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
637 static void clear_event
P_ ((struct input_event
*));
639 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
641 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
642 static void handle_interrupt
P_ ((void));
643 static void timer_start_idle
P_ ((void));
644 static void timer_stop_idle
P_ ((void));
645 static void timer_resume_idle
P_ ((void));
646 static SIGTYPE handle_user_signal
P_ ((int));
647 static char *find_user_signal_name
P_ ((int));
648 static int store_user_signal_events
P_ ((void));
650 /* Nonzero means don't try to suspend even if the operating system seems
652 static int cannot_suspend
;
654 extern Lisp_Object Qidentity
, Qonly
;
656 /* Install the string STR as the beginning of the string of echoing,
657 so that it serves as a prompt for the next character.
658 Also start echoing. */
664 current_kboard
->echo_string
= str
;
665 current_kboard
->echo_after_prompt
= SCHARS (str
);
669 /* Add C to the echo string, if echoing is going on.
670 C can be a character, which is printed prettily ("M-C-x" and all that
671 jazz), or a symbol, whose name is printed. */
677 if (current_kboard
->immediate_echo
)
679 int size
= KEY_DESCRIPTION_SIZE
+ 100;
680 char *buffer
= (char *) alloca (size
);
682 Lisp_Object echo_string
;
684 echo_string
= current_kboard
->echo_string
;
686 /* If someone has passed us a composite event, use its head symbol. */
691 ptr
= push_key_description (XINT (c
), ptr
, 1);
693 else if (SYMBOLP (c
))
695 Lisp_Object name
= SYMBOL_NAME (c
);
696 int nbytes
= SBYTES (name
);
698 if (size
- (ptr
- buffer
) < nbytes
)
700 int offset
= ptr
- buffer
;
701 size
= max (2 * size
, size
+ nbytes
);
702 buffer
= (char *) alloca (size
);
703 ptr
= buffer
+ offset
;
706 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
707 STRING_MULTIBYTE (name
), 1);
710 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
713 const char *text
= " (Type ? for further options)";
714 int len
= strlen (text
);
716 if (size
- (ptr
- buffer
) < len
)
718 int offset
= ptr
- buffer
;
720 buffer
= (char *) alloca (size
);
721 ptr
= buffer
+ offset
;
724 bcopy (text
, ptr
, len
);
728 /* Replace a dash from echo_dash with a space, otherwise
729 add a space at the end as a separator between keys. */
730 if (STRINGP (echo_string
)
731 && SCHARS (echo_string
) > 1)
733 Lisp_Object last_char
, prev_char
, idx
;
735 idx
= make_number (SCHARS (echo_string
) - 2);
736 prev_char
= Faref (echo_string
, idx
);
738 idx
= make_number (SCHARS (echo_string
) - 1);
739 last_char
= Faref (echo_string
, idx
);
741 /* We test PREV_CHAR to make sure this isn't the echoing
743 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
744 Faset (echo_string
, idx
, make_number (' '));
746 echo_string
= concat2 (echo_string
, build_string (" "));
748 else if (STRINGP (echo_string
))
749 echo_string
= concat2 (echo_string
, build_string (" "));
751 current_kboard
->echo_string
752 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
758 /* Temporarily add a dash to the end of the echo string if it's not
759 empty, so that it serves as a mini-prompt for the very next character. */
764 /* Do nothing if not echoing at all. */
765 if (NILP (current_kboard
->echo_string
))
768 if (!current_kboard
->immediate_echo
769 && SCHARS (current_kboard
->echo_string
) == 0)
772 /* Do nothing if we just printed a prompt. */
773 if (current_kboard
->echo_after_prompt
774 == SCHARS (current_kboard
->echo_string
))
777 /* Do nothing if we have already put a dash at the end. */
778 if (SCHARS (current_kboard
->echo_string
) > 1)
780 Lisp_Object last_char
, prev_char
, idx
;
782 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
783 prev_char
= Faref (current_kboard
->echo_string
, idx
);
785 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
786 last_char
= Faref (current_kboard
->echo_string
, idx
);
788 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
792 /* Put a dash at the end of the buffer temporarily,
793 but make it go away when the next character is added. */
794 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
799 /* Display the current echo string, and begin echoing if not already
805 if (!current_kboard
->immediate_echo
)
808 current_kboard
->immediate_echo
= 1;
810 for (i
= 0; i
< this_command_key_count
; i
++)
814 /* Set before_command_echo_length to the value that would
815 have been saved before the start of this subcommand in
816 command_loop_1, if we had already been echoing then. */
817 if (i
== this_single_command_key_start
)
818 before_command_echo_length
= echo_length ();
820 c
= XVECTOR (this_command_keys
)->contents
[i
];
821 if (! (EVENT_HAS_PARAMETERS (c
)
822 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
826 /* Set before_command_echo_length to the value that would
827 have been saved before the start of this subcommand in
828 command_loop_1, if we had already been echoing then. */
829 if (this_command_key_count
== this_single_command_key_start
)
830 before_command_echo_length
= echo_length ();
832 /* Put a dash at the end to invite the user to type more. */
837 message3_nolog (current_kboard
->echo_string
,
838 SBYTES (current_kboard
->echo_string
),
839 STRING_MULTIBYTE (current_kboard
->echo_string
));
842 /* Record in what buffer we echoed, and from which kboard. */
843 echo_message_buffer
= echo_area_buffer
[0];
844 echo_kboard
= current_kboard
;
846 if (waiting_for_input
&& !NILP (Vquit_flag
))
847 quit_throw_to_read_char ();
850 /* Turn off echoing, for the start of a new command. */
855 current_kboard
->immediate_echo
= 0;
856 current_kboard
->echo_after_prompt
= -1;
857 current_kboard
->echo_string
= Qnil
;
858 ok_to_echo_at_next_pause
= NULL
;
860 echo_message_buffer
= Qnil
;
863 /* Return the length of the current echo string. */
868 return (STRINGP (current_kboard
->echo_string
)
869 ? SCHARS (current_kboard
->echo_string
)
873 /* Truncate the current echo message to its first LEN chars.
874 This and echo_char get used by read_key_sequence when the user
875 switches frames while entering a key sequence. */
878 echo_truncate (nchars
)
881 if (STRINGP (current_kboard
->echo_string
))
882 current_kboard
->echo_string
883 = Fsubstring (current_kboard
->echo_string
,
884 make_number (0), make_number (nchars
));
885 truncate_echo_area (nchars
);
889 /* Functions for manipulating this_command_keys. */
891 add_command_key (key
)
894 #if 0 /* Not needed after we made Freset_this_command_lengths
895 do the job immediately. */
896 /* If reset-this-command-length was called recently, obey it now.
897 See the doc string of that function for an explanation of why. */
898 if (before_command_restore_flag
)
900 this_command_key_count
= before_command_key_count_1
;
901 if (this_command_key_count
< this_single_command_key_start
)
902 this_single_command_key_start
= this_command_key_count
;
903 echo_truncate (before_command_echo_length_1
);
904 before_command_restore_flag
= 0;
908 if (this_command_key_count
>= ASIZE (this_command_keys
))
909 this_command_keys
= larger_vector (this_command_keys
,
910 2 * ASIZE (this_command_keys
),
913 ASET (this_command_keys
, this_command_key_count
, key
);
914 ++this_command_key_count
;
921 int count
= SPECPDL_INDEX ();
924 if (command_loop_level
> 0)
926 specbind (Qstandard_output
, Qt
);
927 specbind (Qstandard_input
, Qt
);
930 #ifdef HAVE_WINDOW_SYSTEM
931 /* The command loop has started an hourglass timer, so we have to
932 cancel it here, otherwise it will fire because the recursive edit
933 can take some time. Do not check for display_hourglass_p here,
934 because it could already be nil. */
938 /* This function may have been called from a debugger called from
939 within redisplay, for instance by Edebugging a function called
940 from fontification-functions. We want to allow redisplay in
941 the debugging session.
943 The recursive edit is left with a `(throw exit ...)'. The `exit'
944 tag is not caught anywhere in redisplay, i.e. when we leave the
945 recursive edit, the original redisplay leading to the recursive
946 edit will be unwound. The outcome should therefore be safe. */
947 specbind (Qinhibit_redisplay
, Qnil
);
950 val
= command_loop ();
952 Fsignal (Qquit
, Qnil
);
953 /* Handle throw from read_minibuf when using minibuffer
954 while it's active but we're in another window. */
956 xsignal1 (Qerror
, val
);
958 return unbind_to (count
, Qnil
);
961 /* When an auto-save happens, record the "time", and don't do again soon. */
966 last_auto_save
= num_nonmacro_input_events
;
969 /* Make an auto save happen as soon as possible at command level. */
972 force_auto_save_soon ()
974 last_auto_save
= - auto_save_interval
- 1;
976 record_asynch_buffer_change ();
979 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
980 doc
: /* Invoke the editor command loop recursively.
981 To get out of the recursive edit, a command can do `(throw 'exit nil)';
982 that tells this function to return.
983 Alternatively, `(throw 'exit t)' makes this function signal an error.
984 This function is called by the editor initialization to begin editing. */)
987 int count
= SPECPDL_INDEX ();
990 /* If we enter while input is blocked, don't lock up here.
991 This may happen through the debugger during redisplay. */
995 command_loop_level
++;
996 update_mode_lines
= 1;
998 if (command_loop_level
999 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1000 buffer
= Fcurrent_buffer ();
1004 /* If we leave recursive_edit_1 below with a `throw' for instance,
1005 like it is done in the splash screen display, we have to
1006 make sure that we restore single_kboard as command_loop_1
1007 would have done if it were left normally. */
1008 if (command_loop_level
> 0)
1009 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1010 record_unwind_protect (recursive_edit_unwind
, buffer
);
1012 recursive_edit_1 ();
1013 return unbind_to (count
, Qnil
);
1017 recursive_edit_unwind (buffer
)
1020 if (BUFFERP (buffer
))
1021 Fset_buffer (buffer
);
1023 command_loop_level
--;
1024 update_mode_lines
= 1;
1029 #if 0 /* These two functions are now replaced with
1030 temporarily_switch_to_single_kboard. */
1035 #if 0 /* Theory: if there's anything in Vunread_command_events,
1036 it will right away be read by read_key_sequence,
1037 and then if we do switch KBOARDS, it will go into the side
1038 queue then. So we don't need to do anything special here -- rms. */
1039 if (CONSP (Vunread_command_events
))
1041 current_kboard
->kbd_queue
1042 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1043 current_kboard
->kbd_queue_has_data
= 1;
1045 Vunread_command_events
= Qnil
;
1051 /* Switch to the single-kboard state, making current_kboard
1052 the only KBOARD from which further input is accepted. */
1055 single_kboard_state ()
1063 /* If we're in single_kboard state for kboard KBOARD,
1067 not_single_kboard_state (kboard
)
1071 if (kboard
== current_kboard
)
1076 /* Maintain a stack of kboards, so other parts of Emacs
1077 can switch temporarily to the kboard of a given frame
1078 and then revert to the previous status. */
1083 struct kboard_stack
*next
;
1086 static struct kboard_stack
*kboard_stack
;
1093 struct kboard_stack
*p
1094 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1096 p
->next
= kboard_stack
;
1097 p
->kboard
= current_kboard
;
1109 struct kboard_stack
*p
= kboard_stack
;
1111 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1113 if (t
->kboard
== p
->kboard
)
1115 current_kboard
= p
->kboard
;
1122 /* The terminal we remembered has been deleted. */
1123 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1126 kboard_stack
= p
->next
;
1131 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1132 from which further input is accepted. If F is non-nil, set its
1133 KBOARD as the current keyboard.
1135 This function uses record_unwind_protect to return to the previous
1138 If Emacs is already in single_kboard mode, and F's keyboard is
1139 locked, then this function will throw an errow. */
1142 temporarily_switch_to_single_kboard (f
)
1146 int was_locked
= single_kboard
;
1149 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1150 /* We can not switch keyboards while in single_kboard mode.
1151 In rare cases, Lisp code may call `recursive-edit' (or
1152 `read-minibuffer' or `y-or-n-p') after it switched to a
1153 locked frame. For example, this is likely to happen
1154 when server.el connects to a new terminal while Emacs is in
1155 single_kboard mode. It is best to throw an error instead
1156 of presenting the user with a frozen screen. */
1157 error ("Terminal %d is locked, cannot read from it",
1158 FRAME_TERMINAL (f
)->id
);
1160 /* This call is unnecessary, but helps
1161 `restore_kboard_configuration' discover if somebody changed
1162 `current_kboard' behind our back. */
1163 push_kboard (current_kboard
);
1166 current_kboard
= FRAME_KBOARD (f
);
1168 record_unwind_protect (restore_kboard_configuration
,
1169 (was_locked
? Qt
: Qnil
));
1173 #if 0 /* This function is not needed anymore. */
1175 record_single_kboard_state ()
1178 push_kboard (current_kboard
);
1179 record_unwind_protect (restore_kboard_configuration
,
1180 (single_kboard
? Qt
: Qnil
));
1186 restore_kboard_configuration (was_locked
)
1187 Lisp_Object was_locked
;
1189 if (NILP (was_locked
))
1193 struct kboard
*prev
= current_kboard
;
1196 /* The pop should not change the kboard. */
1197 if (single_kboard
&& current_kboard
!= prev
)
1205 /* Handle errors that are not handled at inner levels
1206 by printing an error message and returning to the editor command loop. */
1212 Lisp_Object old_level
, old_length
;
1213 char macroerror
[50];
1215 #ifdef HAVE_WINDOW_SYSTEM
1216 if (display_hourglass_p
)
1217 cancel_hourglass ();
1220 if (!NILP (executing_kbd_macro
))
1222 if (executing_kbd_macro_iterations
== 1)
1223 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1225 sprintf (macroerror
, "After %d kbd macro iterations: ",
1226 executing_kbd_macro_iterations
);
1231 Vstandard_output
= Qt
;
1232 Vstandard_input
= Qt
;
1233 Vexecuting_kbd_macro
= Qnil
;
1234 executing_kbd_macro
= Qnil
;
1235 current_kboard
->Vprefix_arg
= Qnil
;
1236 current_kboard
->Vlast_prefix_arg
= Qnil
;
1239 /* Avoid unquittable loop if data contains a circular list. */
1240 old_level
= Vprint_level
;
1241 old_length
= Vprint_length
;
1242 XSETFASTINT (Vprint_level
, 10);
1243 XSETFASTINT (Vprint_length
, 10);
1244 cmd_error_internal (data
, macroerror
);
1245 Vprint_level
= old_level
;
1246 Vprint_length
= old_length
;
1250 Vinhibit_quit
= Qnil
;
1251 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1253 if (command_loop_level
== 0 && minibuf_level
== 0)
1254 any_kboard_state ();
1258 return make_number (0);
1261 /* Take actions on handling an error. DATA is the data that describes
1264 CONTEXT is a C-string containing ASCII characters only which
1265 describes the context in which the error happened. If we need to
1266 generalize CONTEXT to allow multibyte characters, make it a Lisp
1270 cmd_error_internal (data
, context
)
1274 struct frame
*sf
= SELECTED_FRAME ();
1276 /* The immediate context is not interesting for Quits,
1277 since they are asyncronous. */
1278 if (EQ (XCAR (data
), Qquit
))
1279 Vsignaling_function
= Qnil
;
1284 /* Use user's specified output function if any. */
1285 if (!NILP (Vcommand_error_function
))
1286 call3 (Vcommand_error_function
, data
,
1287 context
? build_string (context
) : empty_unibyte_string
,
1288 Vsignaling_function
);
1289 /* If the window system or terminal frame hasn't been initialized
1290 yet, or we're not interactive, write the message to stderr and exit. */
1291 else if (!sf
->glyphs_initialized_p
1292 || FRAME_INITIAL_P (sf
)
1295 print_error_message (data
, Qexternal_debugging_output
,
1296 context
, Vsignaling_function
);
1297 Fterpri (Qexternal_debugging_output
);
1298 Fkill_emacs (make_number (-1));
1302 clear_message (1, 0);
1304 message_log_maybe_newline ();
1307 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1310 Vsignaling_function
= Qnil
;
1313 Lisp_Object
command_loop_1 ();
1314 Lisp_Object
command_loop_2 ();
1315 Lisp_Object
top_level_1 ();
1317 /* Entry to editor-command-loop.
1318 This level has the catches for exiting/returning to editor command loop.
1319 It returns nil to exit recursive edit, t to abort it. */
1324 if (command_loop_level
> 0 || minibuf_level
> 0)
1327 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1328 executing_kbd_macro
= Qnil
;
1334 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1335 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1336 /* Reset single_kboard in case top-level set it while
1337 evaluating an -f option, or we are stuck there for some
1339 any_kboard_state ();
1341 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1342 executing_kbd_macro
= Qnil
;
1344 /* End of file in -batch run causes exit here. */
1350 /* Here we catch errors in execution of commands within the
1351 editing loop, and reenter the editing loop.
1352 When there is an error, cmd_error runs and returns a non-nil
1353 value to us. A value of nil means that command_loop_1 itself
1354 returned due to end of file (or end of kbd macro). */
1359 register Lisp_Object val
;
1362 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1363 while (!NILP (val
));
1371 return Feval (Vtop_level
);
1377 /* On entry to the outer level, run the startup file */
1378 if (!NILP (Vtop_level
))
1379 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1380 else if (!NILP (Vpurify_flag
))
1381 message ("Bare impure Emacs (standard Lisp code not loaded)");
1383 message ("Bare Emacs (standard Lisp code not loaded)");
1387 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1388 doc
: /* Exit all recursive editing levels. */)
1391 #ifdef HAVE_WINDOW_SYSTEM
1392 if (display_hourglass_p
)
1393 cancel_hourglass ();
1396 /* Unblock input if we enter with input blocked. This may happen if
1397 redisplay traps e.g. during tool-bar update with input blocked. */
1398 while (INPUT_BLOCKED_P
)
1401 return Fthrow (Qtop_level
, Qnil
);
1404 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1405 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1408 if (command_loop_level
> 0 || minibuf_level
> 0)
1409 Fthrow (Qexit
, Qnil
);
1411 error ("No recursive edit is in progress");
1415 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1416 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1419 if (command_loop_level
> 0 || minibuf_level
> 0)
1422 error ("No recursive edit is in progress");
1426 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1428 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1429 of this function. */
1432 tracking_off (old_value
)
1433 Lisp_Object old_value
;
1435 do_mouse_tracking
= old_value
;
1436 if (NILP (old_value
))
1438 /* Redisplay may have been preempted because there was input
1439 available, and it assumes it will be called again after the
1440 input has been processed. If the only input available was
1441 the sort that we have just disabled, then we need to call
1443 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1445 redisplay_preserve_echo_area (6);
1446 get_input_pending (&input_pending
,
1447 READABLE_EVENTS_DO_TIMERS_NOW
);
1453 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1454 doc
: /* Evaluate BODY with mouse movement events enabled.
1455 Within a `track-mouse' form, mouse motion generates input events that
1456 you can read with `read-event'.
1457 Normally, mouse motion is ignored.
1458 usage: (track-mouse BODY...) */)
1462 int count
= SPECPDL_INDEX ();
1465 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1467 do_mouse_tracking
= Qt
;
1469 val
= Fprogn (args
);
1470 return unbind_to (count
, val
);
1473 /* If mouse has moved on some frame, return one of those frames.
1477 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1478 after resizing the tool-bar window. */
1480 int ignore_mouse_drag_p
;
1485 Lisp_Object tail
, frame
;
1487 if (ignore_mouse_drag_p
)
1489 /* ignore_mouse_drag_p = 0; */
1493 FOR_EACH_FRAME (tail
, frame
)
1495 if (XFRAME (frame
)->mouse_moved
)
1496 return XFRAME (frame
);
1502 #endif /* HAVE_MOUSE || HAVE_GPM */
1504 /* This is the actual command reading loop,
1505 sans error-handling encapsulation. */
1507 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1509 void safe_run_hooks
P_ ((Lisp_Object
));
1510 static void adjust_point_for_property
P_ ((int, int));
1512 /* Cancel hourglass from protect_unwind.
1514 #ifdef HAVE_WINDOW_SYSTEM
1516 cancel_hourglass_unwind (arg
)
1519 cancel_hourglass ();
1530 Lisp_Object keybuf
[30];
1532 int prev_modiff
= 0;
1533 struct buffer
*prev_buffer
= NULL
;
1534 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1536 int was_locked
= single_kboard
;
1539 int already_adjusted
= 0;
1541 current_kboard
->Vprefix_arg
= Qnil
;
1542 current_kboard
->Vlast_prefix_arg
= Qnil
;
1543 Vdeactivate_mark
= Qnil
;
1544 waiting_for_input
= 0;
1548 this_command_key_count
= 0;
1549 this_command_key_count_reset
= 0;
1550 this_single_command_key_start
= 0;
1552 if (NILP (Vmemory_full
))
1554 /* Make sure this hook runs after commands that get errors and
1555 throw to top level. */
1556 /* Note that the value cell will never directly contain nil
1557 if the symbol is a local variable. */
1558 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1559 safe_run_hooks (Qpost_command_hook
);
1561 /* If displaying a message, resize the echo area window to fit
1562 that message's size exactly. */
1563 if (!NILP (echo_area_buffer
[0]))
1564 resize_echo_area_exactly ();
1566 if (!NILP (Vdeferred_action_list
))
1567 safe_run_hooks (Qdeferred_action_function
);
1570 /* Do this after running Vpost_command_hook, for consistency. */
1571 current_kboard
->Vlast_command
= Vthis_command
;
1572 current_kboard
->Vreal_last_command
= real_this_command
;
1573 if (!CONSP (last_command_char
))
1574 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1578 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1581 /* Make sure the current window's buffer is selected. */
1582 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1583 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1585 /* Display any malloc warning that just came out. Use while because
1586 displaying one warning can cause another. */
1588 while (pending_malloc_warning
)
1589 display_malloc_warning ();
1591 Vdeactivate_mark
= Qnil
;
1593 /* If minibuffer on and echo area in use,
1594 wait a short time and redraw minibuffer. */
1597 && !NILP (echo_area_buffer
[0])
1598 && EQ (minibuf_window
, echo_area_window
)
1599 && NUMBERP (Vminibuffer_message_timeout
))
1601 /* Bind inhibit-quit to t so that C-g gets read in
1602 rather than quitting back to the minibuffer. */
1603 int count
= SPECPDL_INDEX ();
1604 specbind (Qinhibit_quit
, Qt
);
1606 sit_for (Vminibuffer_message_timeout
, 0, 2);
1608 /* Clear the echo area. */
1610 safe_run_hooks (Qecho_area_clear_hook
);
1612 unbind_to (count
, Qnil
);
1614 /* If a C-g came in before, treat it as input now. */
1615 if (!NILP (Vquit_flag
))
1618 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1623 /* Select the frame that the last event came from. Usually,
1624 switch-frame events will take care of this, but if some lisp
1625 code swallows a switch-frame event, we'll fix things up here.
1626 Is this a good idea? */
1627 if (FRAMEP (internal_last_event_frame
)
1628 && !EQ (internal_last_event_frame
, selected_frame
))
1629 Fselect_frame (internal_last_event_frame
);
1631 /* If it has changed current-menubar from previous value,
1632 really recompute the menubar from the value. */
1633 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1634 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1635 call0 (Qrecompute_lucid_menubar
);
1637 before_command_key_count
= this_command_key_count
;
1638 before_command_echo_length
= echo_length ();
1640 Vthis_command
= Qnil
;
1641 real_this_command
= Qnil
;
1642 Vthis_original_command
= Qnil
;
1643 Vthis_command_keys_shift_translated
= Qnil
;
1645 /* Read next key sequence; i gets its length. */
1646 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1649 /* A filter may have run while we were reading the input. */
1650 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1652 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1653 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1657 /* Now we have read a key sequence of length I,
1658 or else I is 0 and we found end of file. */
1660 if (i
== 0) /* End of file -- happens only in */
1661 return Qnil
; /* a kbd macro, at the end. */
1662 /* -1 means read_key_sequence got a menu that was rejected.
1663 Just loop around and read another command. */
1667 this_command_key_count
= 0;
1668 this_command_key_count_reset
= 0;
1669 this_single_command_key_start
= 0;
1673 last_command_char
= keybuf
[i
- 1];
1675 /* If the previous command tried to force a specific window-start,
1676 forget about that, in case this command moves point far away
1677 from that position. But also throw away beg_unchanged and
1678 end_unchanged information in that case, so that redisplay will
1679 update the whole window properly. */
1680 if (!NILP (XWINDOW (selected_window
)->force_start
))
1683 XWINDOW (selected_window
)->force_start
= Qnil
;
1684 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1685 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1688 cmd
= read_key_sequence_cmd
;
1689 if (!NILP (Vexecuting_kbd_macro
))
1691 if (!NILP (Vquit_flag
))
1693 Vexecuting_kbd_macro
= Qt
;
1694 QUIT
; /* Make some noise. */
1695 /* Will return since macro now empty. */
1699 /* Do redisplay processing after this command except in special
1700 cases identified below. */
1701 prev_buffer
= current_buffer
;
1702 prev_modiff
= MODIFF
;
1703 last_point_position
= PT
;
1704 last_point_position_window
= selected_window
;
1705 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1707 /* By default, we adjust point to a boundary of a region that
1708 has such a property that should be treated intangible
1709 (e.g. composition, display). But, some commands will set
1710 this variable differently. */
1711 Vdisable_point_adjustment
= Qnil
;
1713 /* Process filters and timers may have messed with deactivate-mark.
1714 reset it before we execute the command. */
1715 Vdeactivate_mark
= Qnil
;
1717 /* Remap command through active keymaps */
1718 Vthis_original_command
= cmd
;
1722 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1726 /* Execute the command. */
1728 Vthis_command
= cmd
;
1729 real_this_command
= cmd
;
1730 /* Note that the value cell will never directly contain nil
1731 if the symbol is a local variable. */
1732 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1733 safe_run_hooks (Qpre_command_hook
);
1735 already_adjusted
= 0;
1737 if (NILP (Vthis_command
))
1739 /* nil means key is undefined. */
1740 Lisp_Object keys
= Fvector (i
, keybuf
);
1741 keys
= Fkey_description (keys
, Qnil
);
1743 message_with_string ("%s is undefined", keys
, 0);
1744 current_kboard
->defining_kbd_macro
= Qnil
;
1745 update_mode_lines
= 1;
1746 current_kboard
->Vprefix_arg
= Qnil
;
1750 if (NILP (current_kboard
->Vprefix_arg
))
1752 /* In case we jump to directly_done. */
1753 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1755 /* Recognize some common commands in common situations and
1756 do them directly. */
1757 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
1758 && NILP (Vthis_command_keys_shift_translated
)
1759 && !CONSP (Vtransient_mark_mode
))
1761 struct Lisp_Char_Table
*dp
1762 = window_display_table (XWINDOW (selected_window
));
1763 lose
= FETCH_CHAR (PT_BYTE
);
1765 if (! NILP (Vpost_command_hook
))
1766 /* Put this before calling adjust_point_for_property
1767 so it will only get called once in any case. */
1769 if (current_buffer
== prev_buffer
1770 && last_point_position
!= PT
1771 && NILP (Vdisable_point_adjustment
)
1772 && NILP (Vglobal_disable_point_adjustment
))
1773 adjust_point_for_property (last_point_position
, 0);
1774 already_adjusted
= 1;
1775 if (PT
== last_point_position
+ 1
1777 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1778 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1779 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1780 && (lose
>= 0x20 && lose
< 0x7f)))
1781 : (lose
>= 0x20 && lose
< 0x7f))
1782 /* To extract the case of continuation on
1783 wide-column characters. */
1784 && ASCII_BYTE_P (lose
)
1785 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1787 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1789 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1791 && !windows_or_buffers_changed
1792 && EQ (current_buffer
->selective_display
, Qnil
)
1793 && !detect_input_pending ()
1794 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1795 && NILP (Vexecuting_kbd_macro
))
1796 direct_output_forward_char (1);
1799 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
1800 && NILP (Vthis_command_keys_shift_translated
)
1801 && !CONSP (Vtransient_mark_mode
))
1803 struct Lisp_Char_Table
*dp
1804 = window_display_table (XWINDOW (selected_window
));
1806 lose
= FETCH_CHAR (PT_BYTE
);
1807 if (! NILP (Vpost_command_hook
))
1809 if (current_buffer
== prev_buffer
1810 && last_point_position
!= PT
1811 && NILP (Vdisable_point_adjustment
)
1812 && NILP (Vglobal_disable_point_adjustment
))
1813 adjust_point_for_property (last_point_position
, 0);
1814 already_adjusted
= 1;
1815 if (PT
== last_point_position
- 1
1817 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1818 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1819 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1820 && (lose
>= 0x20 && lose
< 0x7f)))
1821 : (lose
>= 0x20 && lose
< 0x7f))
1822 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1824 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1826 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1828 && !windows_or_buffers_changed
1829 && EQ (current_buffer
->selective_display
, Qnil
)
1830 && !detect_input_pending ()
1831 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1832 && NILP (Vexecuting_kbd_macro
))
1833 direct_output_forward_char (-1);
1836 else if (EQ (Vthis_command
, Qself_insert_command
)
1837 /* Try this optimization only on char keystrokes. */
1838 && NATNUMP (last_command_char
)
1839 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1842 = translate_char (Vtranslation_table_for_input
,
1843 XFASTINT (last_command_char
));
1845 if (NILP (Vexecuting_kbd_macro
)
1846 && !EQ (minibuf_window
, selected_window
))
1848 if (!nonundocount
|| nonundocount
>= 20)
1856 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1858 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1860 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1862 || MODIFF
<= SAVE_MODIFF
1863 || windows_or_buffers_changed
1864 || !EQ (current_buffer
->selective_display
, Qnil
)
1865 || detect_input_pending ()
1866 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1867 || !NILP (Vexecuting_kbd_macro
));
1869 value
= internal_self_insert (c
, 0);
1874 if (! NILP (Vpost_command_hook
))
1875 /* Put this before calling adjust_point_for_property
1876 so it will only get called once in any case. */
1879 /* VALUE == 1 when AFTER-CHANGE functions are
1880 installed which is the case most of the time
1881 because FONT-LOCK installs one. */
1882 if (!lose
&& !value
)
1883 direct_output_for_insert (c
);
1888 /* Here for a command that isn't executed directly */
1891 #ifdef HAVE_WINDOW_SYSTEM
1892 int scount
= SPECPDL_INDEX ();
1894 if (display_hourglass_p
1895 && NILP (Vexecuting_kbd_macro
))
1897 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1903 if (NILP (current_kboard
->Vprefix_arg
))
1905 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1907 #ifdef HAVE_WINDOW_SYSTEM
1908 /* Do not check display_hourglass_p here, because
1909 Fcommand_execute could change it, but we should cancel
1910 hourglass cursor anyway.
1911 But don't cancel the hourglass within a macro
1912 just because a command in the macro finishes. */
1913 if (NILP (Vexecuting_kbd_macro
))
1914 unbind_to (scount
, Qnil
);
1919 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1921 /* Note that the value cell will never directly contain nil
1922 if the symbol is a local variable. */
1923 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1924 safe_run_hooks (Qpost_command_hook
);
1926 /* If displaying a message, resize the echo area window to fit
1927 that message's size exactly. */
1928 if (!NILP (echo_area_buffer
[0]))
1929 resize_echo_area_exactly ();
1931 if (!NILP (Vdeferred_action_list
))
1932 safe_run_hooks (Qdeferred_action_function
);
1934 /* If there is a prefix argument,
1935 1) We don't want Vlast_command to be ``universal-argument''
1936 (that would be dumb), so don't set Vlast_command,
1937 2) we want to leave echoing on so that the prefix will be
1938 echoed as part of this key sequence, so don't call
1940 3) we want to leave this_command_key_count non-zero, so that
1941 read_char will realize that it is re-reading a character, and
1942 not echo it a second time.
1944 If the command didn't actually create a prefix arg,
1945 but is merely a frame event that is transparent to prefix args,
1946 then the above doesn't apply. */
1947 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1949 current_kboard
->Vlast_command
= Vthis_command
;
1950 current_kboard
->Vreal_last_command
= real_this_command
;
1951 if (!CONSP (last_command_char
))
1952 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1954 this_command_key_count
= 0;
1955 this_command_key_count_reset
= 0;
1956 this_single_command_key_start
= 0;
1959 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1961 /* In Emacs 22, setting transient-mark-mode to `only' was a
1962 way of turning it on for just one command. This usage is
1963 obsolete, but support it anyway. */
1964 if (EQ (Vtransient_mark_mode
, Qidentity
))
1965 Vtransient_mark_mode
= Qnil
;
1966 else if (EQ (Vtransient_mark_mode
, Qonly
))
1967 Vtransient_mark_mode
= Qidentity
;
1969 if (!NILP (Vdeactivate_mark
))
1970 call0 (Qdeactivate_mark
);
1971 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1972 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1977 if (current_buffer
== prev_buffer
1978 && last_point_position
!= PT
1979 && NILP (Vdisable_point_adjustment
)
1980 && NILP (Vglobal_disable_point_adjustment
)
1981 && !already_adjusted
)
1982 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1984 /* Install chars successfully executed in kbd macro. */
1986 if (!NILP (current_kboard
->defining_kbd_macro
)
1987 && NILP (current_kboard
->Vprefix_arg
))
1988 finalize_kbd_macro_chars ();
1989 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1992 any_kboard_state ();
1998 extern Lisp_Object Qcomposition
, Qdisplay
;
2000 /* Adjust point to a boundary of a region that has such a property
2001 that should be treated intangible. For the moment, we check
2002 `composition', `display' and `invisible' properties.
2003 LAST_PT is the last position of point. */
2005 extern Lisp_Object Qafter_string
, Qbefore_string
;
2006 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
2009 adjust_point_for_property (last_pt
, modified
)
2014 Lisp_Object val
, overlay
, tmp
;
2015 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
2018 /* FIXME: cycling is probably not necessary because these properties
2019 can't be usefully combined anyway. */
2020 while (check_composition
|| check_display
|| check_invisible
)
2022 /* FIXME: check `intangible'. */
2023 if (check_composition
2024 && PT
> BEGV
&& PT
< ZV
2025 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
2026 && COMPOSITION_VALID_P (beg
, end
, val
)
2027 && beg
< PT
/* && end > PT <- It's always the case. */
2028 && (last_pt
<= beg
|| last_pt
>= end
))
2031 SET_PT (PT
< last_pt
? beg
: end
);
2032 check_display
= check_invisible
= 1;
2034 check_composition
= 0;
2036 && PT
> BEGV
&& PT
< ZV
2037 && !NILP (val
= get_char_property_and_overlay
2038 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
2039 && display_prop_intangible_p (val
)
2040 && (!OVERLAYP (overlay
)
2041 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
2042 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
2043 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
2044 && (beg
< PT
/* && end > PT <- It's always the case. */
2045 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
2048 SET_PT (PT
< last_pt
2049 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
2051 check_composition
= check_invisible
= 1;
2054 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
2056 int inv
, ellipsis
= 0;
2059 /* Find boundaries `beg' and `end' of the invisible area, if any. */
2061 && !NILP (val
= get_char_property_and_overlay
2062 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
2063 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2065 ellipsis
= ellipsis
|| inv
> 1
2066 || (OVERLAYP (overlay
)
2067 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2068 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2069 tmp
= Fnext_single_char_property_change
2070 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
2071 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
2074 && !NILP (val
= get_char_property_and_overlay
2075 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2076 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2078 ellipsis
= ellipsis
|| inv
> 1
2079 || (OVERLAYP (overlay
)
2080 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2081 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2082 tmp
= Fprevious_single_char_property_change
2083 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2084 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2087 /* Move away from the inside area. */
2088 if (beg
< PT
&& end
> PT
)
2090 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2091 /* We haven't moved yet (so we don't need to fear
2092 infinite-looping) and we were outside the range
2093 before (so either end of the range still corresponds
2094 to a move in the right direction): pretend we moved
2095 less than we actually did, so that we still have
2096 more freedom below in choosing which end of the range
2098 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2099 /* We either have moved already or the last point
2100 was already in the range: we don't get to choose
2101 which end of the range we have to go to. */
2102 : (PT
< last_pt
? beg
: end
));
2103 check_composition
= check_display
= 1;
2105 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2106 the point to something other than its argument, due to
2107 point-motion hooks, intangibility, etc. */
2108 xassert (PT
== beg
|| PT
== end
);
2111 /* Pretend the area doesn't exist if the buffer is not
2113 if (!modified
&& !ellipsis
&& beg
< end
)
2115 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2116 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2117 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2118 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2119 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2120 /* We've already moved as far as we can. Trying to go
2121 to the other end would mean moving backwards and thus
2122 could lead to an infinite loop. */
2124 else if (val
= get_pos_property (make_number (PT
),
2126 TEXT_PROP_MEANS_INVISIBLE (val
)
2127 && (val
= get_pos_property
2128 (make_number (PT
== beg
? end
: beg
),
2130 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2131 (check_composition
= check_display
= 1,
2132 SET_PT (PT
== beg
? end
: beg
));
2135 check_invisible
= 0;
2139 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2142 safe_run_hooks_1 (hook
)
2145 if (NILP (Vrun_hooks
))
2147 return call1 (Vrun_hooks
, Vinhibit_quit
);
2150 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2153 safe_run_hooks_error (data
)
2156 Lisp_Object args
[3];
2157 args
[0] = build_string ("Error in %s: %s");
2158 args
[1] = Vinhibit_quit
;
2161 return Fset (Vinhibit_quit
, Qnil
);
2164 /* If we get an error while running the hook, cause the hook variable
2165 to be nil. Also inhibit quits, so that C-g won't cause the hook
2166 to mysteriously evaporate. */
2169 safe_run_hooks (hook
)
2172 int count
= SPECPDL_INDEX ();
2173 specbind (Qinhibit_quit
, hook
);
2175 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2177 unbind_to (count
, Qnil
);
2181 /* Number of seconds between polling for input. This is a Lisp
2182 variable that can be bound. */
2184 EMACS_INT polling_period
;
2186 /* Nonzero means polling for input is temporarily suppressed. */
2188 int poll_suppress_count
;
2190 /* Asynchronous timer for polling. */
2192 struct atimer
*poll_timer
;
2195 #ifdef POLL_FOR_INPUT
2197 /* Poll for input, so what we catch a C-g if it comes in. This
2198 function is called from x_make_frame_visible, see comment
2204 if (interrupt_input_blocked
== 0
2205 && !waiting_for_input
)
2206 read_avail_input (0);
2209 /* Timer callback function for poll_timer. TIMER is equal to
2213 poll_for_input (timer
)
2214 struct atimer
*timer
;
2216 if (poll_suppress_count
== 0)
2218 interrupt_input_pending
= 1;
2220 poll_for_input_1 ();
2224 #endif /* POLL_FOR_INPUT */
2226 /* Begin signals to poll for input, if they are appropriate.
2227 This function is called unconditionally from various places. */
2232 #ifdef POLL_FOR_INPUT
2233 /* XXX This condition was (read_socket_hook && !interrupt_input),
2234 but read_socket_hook is not global anymore. Let's pretend that
2236 if (!interrupt_input
)
2238 /* Turn alarm handling on unconditionally. It might have
2239 been turned off in process.c. */
2240 turn_on_atimers (1);
2242 /* If poll timer doesn't exist, are we need one with
2243 a different interval, start a new one. */
2244 if (poll_timer
== NULL
2245 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2247 EMACS_TIME interval
;
2250 cancel_atimer (poll_timer
);
2252 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2253 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2254 poll_for_input
, NULL
);
2257 /* Let the timer's callback function poll for input
2258 if this becomes zero. */
2259 --poll_suppress_count
;
2264 /* Nonzero if we are using polling to handle input asynchronously. */
2267 input_polling_used ()
2269 #ifdef POLL_FOR_INPUT
2270 /* XXX This condition was (read_socket_hook && !interrupt_input),
2271 but read_socket_hook is not global anymore. Let's pretend that
2273 return !interrupt_input
;
2279 /* Turn off polling. */
2284 #ifdef POLL_FOR_INPUT
2285 /* XXX This condition was (read_socket_hook && !interrupt_input),
2286 but read_socket_hook is not global anymore. Let's pretend that
2288 if (!interrupt_input
)
2289 ++poll_suppress_count
;
2293 /* Set the value of poll_suppress_count to COUNT
2294 and start or stop polling accordingly. */
2297 set_poll_suppress_count (count
)
2300 #ifdef POLL_FOR_INPUT
2301 if (count
== 0 && poll_suppress_count
!= 0)
2303 poll_suppress_count
= 1;
2306 else if (count
!= 0 && poll_suppress_count
== 0)
2310 poll_suppress_count
= count
;
2314 /* Bind polling_period to a value at least N.
2315 But don't decrease it. */
2318 bind_polling_period (n
)
2321 #ifdef POLL_FOR_INPUT
2322 int new = polling_period
;
2327 stop_other_atimers (poll_timer
);
2329 specbind (Qpolling_period
, make_number (new));
2330 /* Start a new alarm with the new period. */
2335 /* Apply the control modifier to CHARACTER. */
2341 /* Save the upper bits here. */
2342 int upper
= c
& ~0177;
2344 if (! ASCII_BYTE_P (c
))
2345 return c
|= ctrl_modifier
;
2349 /* Everything in the columns containing the upper-case letters
2350 denotes a control character. */
2351 if (c
>= 0100 && c
< 0140)
2355 /* Set the shift modifier for a control char
2356 made from a shifted letter. But only for letters! */
2357 if (oc
>= 'A' && oc
<= 'Z')
2358 c
|= shift_modifier
;
2361 /* The lower-case letters denote control characters too. */
2362 else if (c
>= 'a' && c
<= 'z')
2365 /* Include the bits for control and shift
2366 only if the basic ASCII code can't indicate them. */
2370 /* Replace the high bits. */
2371 c
|= (upper
& ~ctrl_modifier
);
2376 /* Display the help-echo property of the character after the mouse pointer.
2377 Either show it in the echo area, or call show-help-function to display
2378 it by other means (maybe in a tooltip).
2380 If HELP is nil, that means clear the previous help echo.
2382 If HELP is a string, display that string. If HELP is a function,
2383 call it with OBJECT and POS as arguments; the function should
2384 return a help string or nil for none. For all other types of HELP,
2385 evaluate it to obtain a string.
2387 WINDOW is the window in which the help was generated, if any.
2388 It is nil if not in a window.
2390 If OBJECT is a buffer, POS is the position in the buffer where the
2391 `help-echo' text property was found.
2393 If OBJECT is an overlay, that overlay has a `help-echo' property,
2394 and POS is the position in the overlay's buffer under the mouse.
2396 If OBJECT is a string (an overlay string or a string displayed with
2397 the `display' property). POS is the position in that string under
2400 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2401 echo overwrites a keystroke echo currently displayed in the echo
2404 Note: this function may only be called with HELP nil or a string
2405 from X code running asynchronously. */
2408 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2409 Lisp_Object help
, window
, object
, pos
;
2410 int ok_to_overwrite_keystroke_echo
;
2412 if (!NILP (help
) && !STRINGP (help
))
2414 if (FUNCTIONP (help
))
2416 Lisp_Object args
[4];
2421 help
= safe_call (4, args
);
2424 help
= safe_eval (help
);
2426 if (!STRINGP (help
))
2430 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2431 if (!noninteractive
&& STRINGP (help
))
2433 /* The mouse-fixup-help-message Lisp function can call
2434 mouse_position_hook, which resets the mouse_moved flags.
2435 This causes trouble if we are trying to read a mouse motion
2436 event (i.e., if we are inside a `track-mouse' form), so we
2437 restore the mouse_moved flag. */
2438 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2439 help
= call1 (Qmouse_fixup_help_message
, help
);
2445 if (STRINGP (help
) || NILP (help
))
2447 if (!NILP (Vshow_help_function
))
2448 call1 (Vshow_help_function
, help
);
2449 help_echo_showing_p
= STRINGP (help
);
2455 /* Input of single characters from keyboard */
2457 Lisp_Object
print_help ();
2458 static Lisp_Object
kbd_buffer_get_event ();
2459 static void record_char ();
2461 static Lisp_Object help_form_saved_window_configs
;
2463 read_char_help_form_unwind (arg
)
2465 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2466 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2467 if (!NILP (window_config
))
2468 Fset_window_configuration (window_config
);
2472 #define STOP_POLLING \
2473 do { if (! polling_stopped_here) stop_polling (); \
2474 polling_stopped_here = 1; } while (0)
2476 #define RESUME_POLLING \
2477 do { if (polling_stopped_here) start_polling (); \
2478 polling_stopped_here = 0; } while (0)
2480 /* read a character from the keyboard; call the redisplay if needed */
2481 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2482 -1 means do not do redisplay, but do do autosaving.
2485 /* The arguments MAPS and NMAPS are for menu prompting.
2486 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2488 PREV_EVENT is the previous input event, or nil if we are reading
2489 the first event of a key sequence (or not reading a key sequence).
2490 If PREV_EVENT is t, that is a "magic" value that says
2491 not to run input methods, but in other respects to act as if
2492 not reading a key sequence.
2494 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2495 if we used a mouse menu to read the input, or zero otherwise. If
2496 USED_MOUSE_MENU is null, we don't dereference it.
2498 Value is -2 when we find input on another keyboard. A second call
2499 to read_char will read it.
2501 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2502 specifying the maximum time to wait until. If no input arrives by
2503 that time, stop waiting and return nil.
2505 Value is t if we showed a menu and the user rejected it. */
2508 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
, end_time
)
2512 Lisp_Object prev_event
;
2513 int *used_mouse_menu
;
2514 EMACS_TIME
*end_time
;
2516 volatile Lisp_Object c
;
2517 int count
, jmpcount
;
2518 jmp_buf local_getcjmp
;
2520 volatile int key_already_recorded
= 0;
2521 Lisp_Object tem
, save
;
2522 volatile Lisp_Object previous_echo_area_message
;
2523 volatile Lisp_Object also_record
;
2524 volatile int reread
;
2525 struct gcpro gcpro1
, gcpro2
;
2526 int polling_stopped_here
= 0;
2527 struct kboard
*orig_kboard
= current_kboard
;
2531 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2532 before_command_key_count
= this_command_key_count
;
2533 before_command_echo_length
= echo_length ();
2536 previous_echo_area_message
= Qnil
;
2538 GCPRO2 (c
, previous_echo_area_message
);
2543 if (CONSP (Vunread_post_input_method_events
))
2545 c
= XCAR (Vunread_post_input_method_events
);
2546 Vunread_post_input_method_events
2547 = XCDR (Vunread_post_input_method_events
);
2549 /* Undo what read_char_x_menu_prompt did when it unread
2550 additional keys returned by Fx_popup_menu. */
2552 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2560 if (unread_command_char
!= -1)
2562 XSETINT (c
, unread_command_char
);
2563 unread_command_char
= -1;
2569 if (CONSP (Vunread_command_events
))
2571 c
= XCAR (Vunread_command_events
);
2572 Vunread_command_events
= XCDR (Vunread_command_events
);
2576 /* Undo what sit-for did when it unread additional keys
2577 inside universal-argument. */
2580 && EQ (XCAR (c
), Qt
))
2586 /* Undo what read_char_x_menu_prompt did when it unread
2587 additional keys returned by Fx_popup_menu. */
2589 && EQ (XCDR (c
), Qdisabled
)
2590 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2593 /* If the queued event is something that used the mouse,
2594 set used_mouse_menu accordingly. */
2596 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2597 *used_mouse_menu
= 1;
2599 goto reread_for_input_method
;
2602 if (CONSP (Vunread_input_method_events
))
2604 c
= XCAR (Vunread_input_method_events
);
2605 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2607 /* Undo what read_char_x_menu_prompt did when it unread
2608 additional keys returned by Fx_popup_menu. */
2610 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2614 goto reread_for_input_method
;
2617 this_command_key_count_reset
= 0;
2619 if (!NILP (Vexecuting_kbd_macro
))
2621 /* We set this to Qmacro; since that's not a frame, nobody will
2622 try to switch frames on us, and the selected window will
2625 Since this event came from a macro, it would be misleading to
2626 leave internal_last_event_frame set to wherever the last
2627 real event came from. Normally, a switch-frame event selects
2628 internal_last_event_frame after each command is read, but
2629 events read from a macro should never cause a new frame to be
2631 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2633 /* Exit the macro if we are at the end.
2634 Also, some things replace the macro with t
2635 to force an early exit. */
2636 if (EQ (Vexecuting_kbd_macro
, Qt
)
2637 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2643 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2644 if (STRINGP (Vexecuting_kbd_macro
)
2645 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2646 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2648 executing_kbd_macro_index
++;
2653 if (!NILP (unread_switch_frame
))
2655 c
= unread_switch_frame
;
2656 unread_switch_frame
= Qnil
;
2658 /* This event should make it into this_command_keys, and get echoed
2659 again, so we do not set `reread'. */
2663 /* if redisplay was requested */
2664 if (commandflag
>= 0)
2666 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2668 /* If there is pending input, process any events which are not
2669 user-visible, such as X selection_request events. */
2671 || detect_input_pending_run_timers (0))
2672 swallow_events (0); /* may clear input_pending */
2674 /* Redisplay if no pending input. */
2675 while (!input_pending
)
2677 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2678 redisplay_preserve_echo_area (5);
2683 /* Normal case: no input arrived during redisplay. */
2686 /* Input arrived and pre-empted redisplay.
2687 Process any events which are not user-visible. */
2689 /* If that cleared input_pending, try again to redisplay. */
2692 /* Prevent the redisplay we just did
2693 from messing up echoing of the input after the prompt. */
2694 if (commandflag
== 0 && echo_current
)
2695 echo_message_buffer
= echo_area_buffer
[0];
2699 /* Message turns off echoing unless more keystrokes turn it on again.
2701 The code in 20.x for the condition was
2703 1. echo_area_glyphs && *echo_area_glyphs
2704 2. && echo_area_glyphs != current_kboard->echobuf
2705 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2707 (1) means there's a current message displayed
2709 (2) means it's not the message from echoing from the current
2712 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2713 is set to a non-null value. This is done in read_char and it is
2714 set to echo_area_glyphs after a call to echo_char. That means
2715 ok_to_echo_at_next_pause is either null or
2716 current_kboard->echobuf with the appropriate current_kboard at
2719 So, condition (3) means in clear text ok_to_echo_at_next_pause
2720 must be either null, or the current message isn't from echoing at
2721 all, or it's from echoing from a different kboard than the
2724 if (/* There currently is something in the echo area. */
2725 !NILP (echo_area_buffer
[0])
2726 && (/* And it's either not from echoing. */
2727 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2728 /* Or it's an echo from a different kboard. */
2729 || echo_kboard
!= current_kboard
2730 /* Or we explicitly allow overwriting whatever there is. */
2731 || ok_to_echo_at_next_pause
== NULL
))
2736 /* Try reading a character via menu prompting in the minibuf.
2737 Try this before the sit-for, because the sit-for
2738 would do the wrong thing if we are supposed to do
2739 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2740 after a mouse event so don't try a minibuf menu. */
2742 if (nmaps
> 0 && INTERACTIVE
2743 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2744 /* Don't bring up a menu if we already have another event. */
2745 && NILP (Vunread_command_events
)
2746 && unread_command_char
< 0
2747 && !detect_input_pending_run_timers (0))
2749 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2751 if (INTEGERP (c
) && XINT (c
) == -2)
2752 return c
; /* wrong_kboard_jmpbuf */
2756 key_already_recorded
= 1;
2761 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2762 We will do that below, temporarily for short sections of code,
2763 when appropriate. local_getcjmp must be in effect
2764 around any call to sit_for or kbd_buffer_get_event;
2765 it *must not* be in effect when we call redisplay. */
2767 jmpcount
= SPECPDL_INDEX ();
2768 if (_setjmp (local_getcjmp
))
2770 /* Handle quits while reading the keyboard. */
2771 /* We must have saved the outer value of getcjmp here,
2772 so restore it now. */
2773 restore_getcjmp (save_jump
);
2774 unbind_to (jmpcount
, Qnil
);
2775 XSETINT (c
, quit_char
);
2776 internal_last_event_frame
= selected_frame
;
2777 Vlast_event_frame
= internal_last_event_frame
;
2778 /* If we report the quit char as an event,
2779 don't do so more than once. */
2780 if (!NILP (Vinhibit_quit
))
2785 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2786 if (kb
!= current_kboard
)
2788 Lisp_Object link
= kb
->kbd_queue
;
2789 /* We shouldn't get here if we were in single-kboard mode! */
2794 while (CONSP (XCDR (link
)))
2796 if (!NILP (XCDR (link
)))
2800 kb
->kbd_queue
= Fcons (c
, Qnil
);
2802 XSETCDR (link
, Fcons (c
, Qnil
));
2803 kb
->kbd_queue_has_data
= 1;
2804 current_kboard
= kb
;
2805 /* This is going to exit from read_char
2806 so we had better get rid of this frame's stuff. */
2808 return make_number (-2); /* wrong_kboard_jmpbuf */
2815 /* Start idle timers if no time limit is supplied. We don't do it
2816 if a time limit is supplied to avoid an infinite recursion in the
2817 situation where an idle timer calls `sit-for'. */
2820 timer_start_idle ();
2822 /* If in middle of key sequence and minibuffer not active,
2823 start echoing if enough time elapses. */
2825 if (minibuf_level
== 0
2827 && !current_kboard
->immediate_echo
2828 && this_command_key_count
> 0
2830 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2831 && NILP (Fzerop (Vecho_keystrokes
))
2832 && (/* No message. */
2833 NILP (echo_area_buffer
[0])
2834 /* Or empty message. */
2835 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2836 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2837 /* Or already echoing from same kboard. */
2838 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2839 /* Or not echoing before and echoing allowed. */
2840 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2842 /* After a mouse event, start echoing right away.
2843 This is because we are probably about to display a menu,
2844 and we don't want to delay before doing so. */
2845 if (EVENT_HAS_PARAMETERS (prev_event
))
2851 save_getcjmp (save_jump
);
2852 restore_getcjmp (local_getcjmp
);
2853 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2854 restore_getcjmp (save_jump
);
2856 && ! CONSP (Vunread_command_events
))
2861 /* Maybe auto save due to number of keystrokes. */
2863 if (commandflag
!= 0
2864 && auto_save_interval
> 0
2865 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2866 && !detect_input_pending_run_timers (0))
2868 Fdo_auto_save (Qnil
, Qnil
);
2869 /* Hooks can actually change some buffers in auto save. */
2873 /* Try reading using an X menu.
2874 This is never confused with reading using the minibuf
2875 because the recursive call of read_char in read_char_minibuf_menu_prompt
2876 does not pass on any keymaps. */
2878 if (nmaps
> 0 && INTERACTIVE
2879 && !NILP (prev_event
)
2880 && EVENT_HAS_PARAMETERS (prev_event
)
2881 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2882 && !EQ (XCAR (prev_event
), Qtool_bar
)
2883 /* Don't bring up a menu if we already have another event. */
2884 && NILP (Vunread_command_events
)
2885 && unread_command_char
< 0)
2887 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2889 /* Now that we have read an event, Emacs is not idle. */
2896 /* Maybe autosave and/or garbage collect due to idleness. */
2898 if (INTERACTIVE
&& NILP (c
))
2900 int delay_level
, buffer_size
;
2902 /* Slow down auto saves logarithmically in size of current buffer,
2903 and garbage collect while we're at it. */
2904 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2905 last_non_minibuf_size
= Z
- BEG
;
2906 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2908 while (buffer_size
> 64)
2909 delay_level
++, buffer_size
-= buffer_size
>> 2;
2910 if (delay_level
< 4) delay_level
= 4;
2911 /* delay_level is 4 for files under around 50k, 7 at 100k,
2912 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2914 /* Auto save if enough time goes by without input. */
2915 if (commandflag
!= 0
2916 && num_nonmacro_input_events
> last_auto_save
2917 && INTEGERP (Vauto_save_timeout
)
2918 && XINT (Vauto_save_timeout
) > 0)
2921 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2923 save_getcjmp (save_jump
);
2924 restore_getcjmp (local_getcjmp
);
2925 tem0
= sit_for (make_number (timeout
), 1, 1);
2926 restore_getcjmp (save_jump
);
2929 && ! CONSP (Vunread_command_events
))
2931 Fdo_auto_save (Qnil
, Qnil
);
2933 /* If we have auto-saved and there is still no input
2934 available, garbage collect if there has been enough
2935 consing going on to make it worthwhile. */
2936 if (!detect_input_pending_run_timers (0)
2937 && consing_since_gc
> gc_cons_threshold
/ 2)
2938 Fgarbage_collect ();
2945 /* Notify the caller if an autosave hook, or a timer, sentinel or
2946 filter in the sit_for calls above have changed the current
2947 kboard. This could happen if they use the minibuffer or start a
2948 recursive edit, like the fancy splash screen in server.el's
2949 filter. If this longjmp wasn't here, read_key_sequence would
2950 interpret the next key sequence using the wrong translation
2951 tables and function keymaps. */
2952 if (NILP (c
) && current_kboard
!= orig_kboard
)
2955 return make_number (-2); /* wrong_kboard_jmpbuf */
2958 /* If this has become non-nil here, it has been set by a timer
2959 or sentinel or filter. */
2960 if (CONSP (Vunread_command_events
))
2962 c
= XCAR (Vunread_command_events
);
2963 Vunread_command_events
= XCDR (Vunread_command_events
);
2966 /* Read something from current KBOARD's side queue, if possible. */
2970 if (current_kboard
->kbd_queue_has_data
)
2972 if (!CONSP (current_kboard
->kbd_queue
))
2974 c
= XCAR (current_kboard
->kbd_queue
);
2975 current_kboard
->kbd_queue
2976 = XCDR (current_kboard
->kbd_queue
);
2977 if (NILP (current_kboard
->kbd_queue
))
2978 current_kboard
->kbd_queue_has_data
= 0;
2979 input_pending
= readable_events (0);
2980 if (EVENT_HAS_PARAMETERS (c
)
2981 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2982 internal_last_event_frame
= XCAR (XCDR (c
));
2983 Vlast_event_frame
= internal_last_event_frame
;
2988 /* If current_kboard's side queue is empty check the other kboards.
2989 If one of them has data that we have not yet seen here,
2990 switch to it and process the data waiting for it.
2992 Note: if the events queued up for another kboard
2993 have already been seen here, and therefore are not a complete command,
2994 the kbd_queue_has_data field is 0, so we skip that kboard here.
2995 That's to avoid an infinite loop switching between kboards here. */
2996 if (NILP (c
) && !single_kboard
)
2999 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3000 if (kb
->kbd_queue_has_data
)
3002 current_kboard
= kb
;
3003 /* This is going to exit from read_char
3004 so we had better get rid of this frame's stuff. */
3006 return make_number (-2); /* wrong_kboard_jmpbuf */
3015 /* Finally, we read from the main queue,
3016 and if that gives us something we can't use yet, we put it on the
3017 appropriate side queue and try again. */
3026 EMACS_GET_TIME (now
);
3027 if (EMACS_TIME_GE (now
, *end_time
))
3031 /* Actually read a character, waiting if necessary. */
3032 save_getcjmp (save_jump
);
3033 restore_getcjmp (local_getcjmp
);
3035 timer_start_idle ();
3036 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
3037 restore_getcjmp (save_jump
);
3040 if (! NILP (c
) && (kb
!= current_kboard
))
3042 Lisp_Object link
= kb
->kbd_queue
;
3045 while (CONSP (XCDR (link
)))
3047 if (!NILP (XCDR (link
)))
3051 kb
->kbd_queue
= Fcons (c
, Qnil
);
3053 XSETCDR (link
, Fcons (c
, Qnil
));
3054 kb
->kbd_queue_has_data
= 1;
3058 current_kboard
= kb
;
3059 /* This is going to exit from read_char
3060 so we had better get rid of this frame's stuff. */
3062 return make_number (-2);
3067 /* Terminate Emacs in batch mode if at eof. */
3068 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
3069 Fkill_emacs (make_number (1));
3073 /* Add in any extra modifiers, where appropriate. */
3074 if ((extra_keyboard_modifiers
& CHAR_CTL
)
3075 || ((extra_keyboard_modifiers
& 0177) < ' '
3076 && (extra_keyboard_modifiers
& 0177) != 0))
3077 XSETINT (c
, make_ctrl_char (XINT (c
)));
3079 /* Transfer any other modifier bits directly from
3080 extra_keyboard_modifiers to c. Ignore the actual character code
3081 in the low 16 bits of extra_keyboard_modifiers. */
3082 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
3093 if (commandflag
>= 0
3094 && !input_pending
&& !detect_input_pending_run_timers (0))
3102 /* Buffer switch events are only for internal wakeups
3103 so don't show them to the user.
3104 Also, don't record a key if we already did. */
3105 if (BUFFERP (c
) || key_already_recorded
)
3108 /* Process special events within read_char
3109 and loop around to read another event. */
3112 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
3117 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3118 int was_locked
= single_kboard
;
3119 int count
= SPECPDL_INDEX ();
3120 record_single_kboard_state ();
3123 last_input_char
= c
;
3124 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
3126 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3127 /* We stopped being idle for this event; undo that. This
3128 prevents automatic window selection (under
3129 mouse_autoselect_window from acting as a real input event, for
3130 example banishing the mouse under mouse-avoidance-mode. */
3131 timer_resume_idle ();
3133 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3134 /* Resume allowing input from any kboard, if that was true before. */
3136 any_kboard_state ();
3137 unbind_to (count
, Qnil
);
3143 /* Handle things that only apply to characters. */
3146 /* If kbd_buffer_get_event gave us an EOF, return that. */
3150 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3151 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3152 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3153 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3154 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3158 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3159 /* nil in keyboard-translate-table means no translation. */
3165 /* If this event is a mouse click in the menu bar,
3166 return just menu-bar for now. Modify the mouse click event
3167 so we won't do this twice, then queue it up. */
3168 if (EVENT_HAS_PARAMETERS (c
)
3170 && CONSP (EVENT_START (c
))
3171 && CONSP (XCDR (EVENT_START (c
))))
3175 posn
= POSN_POSN (EVENT_START (c
));
3176 /* Handle menu-bar events:
3177 insert the dummy prefix event `menu-bar'. */
3178 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3180 /* Change menu-bar to (menu-bar) as the event "position". */
3181 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3184 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3189 /* Store these characters into recent_keys, the dribble file if any,
3190 and the keyboard macro being defined, if any. */
3192 if (! NILP (also_record
))
3193 record_char (also_record
);
3195 /* Wipe the echo area.
3196 But first, if we are about to use an input method,
3197 save the echo area contents for it to refer to. */
3199 && ! NILP (Vinput_method_function
)
3200 && (unsigned) XINT (c
) >= ' '
3201 && (unsigned) XINT (c
) != 127
3202 && (unsigned) XINT (c
) < 256)
3204 previous_echo_area_message
= Fcurrent_message ();
3205 Vinput_method_previous_message
= previous_echo_area_message
;
3208 /* Now wipe the echo area, except for help events which do their
3209 own stuff with the echo area. */
3211 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3212 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3214 if (!NILP (echo_area_buffer
[0]))
3215 safe_run_hooks (Qecho_area_clear_hook
);
3216 clear_message (1, 0);
3219 reread_for_input_method
:
3221 /* Pass this to the input method, if appropriate. */
3223 && ! NILP (Vinput_method_function
)
3224 /* Don't run the input method within a key sequence,
3225 after the first event of the key sequence. */
3226 && NILP (prev_event
)
3227 && (unsigned) XINT (c
) >= ' '
3228 && (unsigned) XINT (c
) != 127
3229 && (unsigned) XINT (c
) < 256)
3232 int key_count
, key_count_reset
;
3233 struct gcpro gcpro1
;
3234 int count
= SPECPDL_INDEX ();
3236 /* Save the echo status. */
3237 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3238 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3239 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3240 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3243 if (before_command_restore_flag
)
3245 this_command_key_count
= before_command_key_count_1
;
3246 if (this_command_key_count
< this_single_command_key_start
)
3247 this_single_command_key_start
= this_command_key_count
;
3248 echo_truncate (before_command_echo_length_1
);
3249 before_command_restore_flag
= 0;
3253 /* Save the this_command_keys status. */
3254 key_count
= this_command_key_count
;
3255 key_count_reset
= this_command_key_count_reset
;
3258 keys
= Fcopy_sequence (this_command_keys
);
3263 /* Clear out this_command_keys. */
3264 this_command_key_count
= 0;
3265 this_command_key_count_reset
= 0;
3267 /* Now wipe the echo area. */
3268 if (!NILP (echo_area_buffer
[0]))
3269 safe_run_hooks (Qecho_area_clear_hook
);
3270 clear_message (1, 0);
3273 /* If we are not reading a key sequence,
3274 never use the echo area. */
3277 specbind (Qinput_method_use_echo_area
, Qt
);
3280 /* Call the input method. */
3281 tem
= call1 (Vinput_method_function
, c
);
3283 tem
= unbind_to (count
, tem
);
3285 /* Restore the saved echoing state
3286 and this_command_keys state. */
3287 this_command_key_count
= key_count
;
3288 this_command_key_count_reset
= key_count_reset
;
3290 this_command_keys
= keys
;
3293 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3294 current_kboard
->echo_string
= saved_echo_string
;
3295 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3296 if (saved_immediate_echo
)
3301 /* The input method can return no events. */
3304 /* Bring back the previous message, if any. */
3305 if (! NILP (previous_echo_area_message
))
3306 message_with_string ("%s", previous_echo_area_message
, 0);
3309 /* It returned one event or more. */
3311 Vunread_post_input_method_events
3312 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3317 /* Display help if not echoing. */
3318 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3320 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3321 Lisp_Object help
, object
, position
, window
, tem
;
3323 tem
= Fcdr (XCDR (c
));
3326 window
= Fcar (tem
);
3328 object
= Fcar (tem
);
3330 position
= Fcar (tem
);
3332 show_help_echo (help
, window
, object
, position
, 0);
3334 /* We stopped being idle for this event; undo that. */
3336 timer_resume_idle ();
3340 if ((! reread
|| this_command_key_count
== 0
3341 || this_command_key_count_reset
)
3345 /* Don't echo mouse motion events. */
3346 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3347 && NILP (Fzerop (Vecho_keystrokes
))
3348 && ! (EVENT_HAS_PARAMETERS (c
)
3349 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3352 if (! NILP (also_record
))
3353 echo_char (also_record
);
3354 /* Once we reread a character, echoing can happen
3355 the next time we pause to read a new one. */
3356 ok_to_echo_at_next_pause
= current_kboard
;
3359 /* Record this character as part of the current key. */
3360 add_command_key (c
);
3361 if (! NILP (also_record
))
3362 add_command_key (also_record
);
3365 last_input_char
= c
;
3368 /* Process the help character specially if enabled */
3369 if (!NILP (Vhelp_form
) && help_char_p (c
))
3372 count
= SPECPDL_INDEX ();
3374 help_form_saved_window_configs
3375 = Fcons (Fcurrent_window_configuration (Qnil
),
3376 help_form_saved_window_configs
);
3377 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3379 tem0
= Feval (Vhelp_form
);
3381 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3386 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3387 if (EVENT_HAS_PARAMETERS (c
)
3388 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3389 XSETCAR (help_form_saved_window_configs
, Qnil
);
3391 while (BUFFERP (c
));
3392 /* Remove the help from the frame */
3393 unbind_to (count
, Qnil
);
3396 if (EQ (c
, make_number (040)))
3400 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3401 while (BUFFERP (c
));
3410 /* Record a key that came from a mouse menu.
3411 Record it for echoing, for this-command-keys, and so on. */
3417 /* Wipe the echo area. */
3418 clear_message (1, 0);
3423 before_command_key_count
= this_command_key_count
;
3424 before_command_echo_length
= echo_length ();
3427 /* Don't echo mouse motion events. */
3428 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3429 && NILP (Fzerop (Vecho_keystrokes
)))
3433 /* Once we reread a character, echoing can happen
3434 the next time we pause to read a new one. */
3435 ok_to_echo_at_next_pause
= 0;
3438 /* Record this character as part of the current key. */
3439 add_command_key (c
);
3441 /* Re-reading in the middle of a command */
3442 last_input_char
= c
;
3446 /* Return 1 if should recognize C as "the help character". */
3454 if (EQ (c
, Vhelp_char
))
3456 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3457 if (EQ (c
, XCAR (tail
)))
3462 /* Record the input event C in various ways. */
3470 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3472 /* To avoid filling recent_keys with help-echo and mouse-movement
3473 events, we filter out repeated help-echo events, only store the
3474 first and last in a series of mouse-movement events, and don't
3475 store repeated help-echo events which are only separated by
3476 mouse-movement events. */
3478 Lisp_Object ev1
, ev2
, ev3
;
3481 if ((ix1
= recent_keys_index
- 1) < 0)
3482 ix1
= NUM_RECENT_KEYS
- 1;
3483 ev1
= AREF (recent_keys
, ix1
);
3485 if ((ix2
= ix1
- 1) < 0)
3486 ix2
= NUM_RECENT_KEYS
- 1;
3487 ev2
= AREF (recent_keys
, ix2
);
3489 if ((ix3
= ix2
- 1) < 0)
3490 ix3
= NUM_RECENT_KEYS
- 1;
3491 ev3
= AREF (recent_keys
, ix3
);
3493 if (EQ (XCAR (c
), Qhelp_echo
))
3495 /* Don't record `help-echo' in recent_keys unless it shows some help
3496 message, and a different help than the previously recorded
3498 Lisp_Object help
, last_help
;
3500 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3501 if (!STRINGP (help
))
3503 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3504 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3506 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3507 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3508 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3510 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3511 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3512 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3513 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3516 else if (EQ (XCAR (c
), Qmouse_movement
))
3518 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3519 So additional mouse movement events replace the last element. */
3520 Lisp_Object last_window
, window
;
3522 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3523 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3524 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3525 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3526 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3528 ASET (recent_keys
, ix1
, c
);
3534 store_kbd_macro_char (c
);
3539 ASET (recent_keys
, recent_keys_index
, c
);
3540 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3541 recent_keys_index
= 0;
3543 else if (recorded
< 0)
3545 /* We need to remove one or two events from recent_keys.
3546 To do this, we simply put nil at those events and move the
3547 recent_keys_index backwards over those events. Usually,
3548 users will never see those nil events, as they will be
3549 overwritten by the command keys entered to see recent_keys
3552 while (recorded
++ < 0 && total_keys
> 0)
3554 if (total_keys
< NUM_RECENT_KEYS
)
3556 if (--recent_keys_index
< 0)
3557 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3558 ASET (recent_keys
, recent_keys_index
, Qnil
);
3562 num_nonmacro_input_events
++;
3564 /* Write c to the dribble file. If c is a lispy event, write
3565 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3566 If you, dear reader, have a better idea, you've got the source. :-) */
3572 if (XUINT (c
) < 0x100)
3573 putc (XINT (c
), dribble
);
3575 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3579 Lisp_Object dribblee
;
3581 /* If it's a structured event, take the event header. */
3582 dribblee
= EVENT_HEAD (c
);
3584 if (SYMBOLP (dribblee
))
3586 putc ('<', dribble
);
3587 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3588 SBYTES (SYMBOL_NAME (dribblee
)),
3590 putc ('>', dribble
);
3603 struct buffer
*old
= current_buffer
;
3604 Fprinc (object
, Qnil
);
3605 set_buffer_internal (XBUFFER (Vstandard_output
));
3606 call0 (intern ("help-mode"));
3607 set_buffer_internal (old
);
3611 /* Copy out or in the info on where C-g should throw to.
3612 This is used when running Lisp code from within get_char,
3613 in case get_char is called recursively.
3614 See read_process_output. */
3620 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3624 restore_getcjmp (temp
)
3627 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3630 /* Low level keyboard/mouse input.
3631 kbd_buffer_store_event places events in kbd_buffer, and
3632 kbd_buffer_get_event retrieves them. */
3634 /* Return true if there are any events in the queue that read-char
3635 would return. If this returns false, a read-char would block. */
3637 readable_events (flags
)
3640 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3643 /* If the buffer contains only FOCUS_IN_EVENT events, and
3644 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3645 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3647 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3648 #ifdef USE_TOOLKIT_SCROLL_BARS
3649 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3653 struct input_event
*event
;
3655 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3662 #ifdef USE_TOOLKIT_SCROLL_BARS
3663 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3665 event
->kind
== FOCUS_IN_EVENT
)
3666 #ifdef USE_TOOLKIT_SCROLL_BARS
3667 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3668 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3669 && event
->part
== scroll_bar_handle
3670 && event
->modifiers
== 0)
3675 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3678 while (event
!= kbd_store_ptr
);
3684 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3685 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3686 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3691 if (current_kboard
->kbd_queue_has_data
)
3697 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3698 if (kb
->kbd_queue_has_data
)
3704 /* Set this for debugging, to have a way to get out */
3709 event_to_kboard (event
)
3710 struct input_event
*event
;
3713 frame
= event
->frame_or_window
;
3715 frame
= XCAR (frame
);
3716 else if (WINDOWP (frame
))
3717 frame
= WINDOW_FRAME (XWINDOW (frame
));
3719 /* There are still some events that don't set this field.
3720 For now, just ignore the problem.
3721 Also ignore dead frames here. */
3722 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3725 return FRAME_KBOARD (XFRAME (frame
));
3730 Lisp_Object Vthrow_on_input
;
3732 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3735 kbd_buffer_store_event (event
)
3736 register struct input_event
*event
;
3738 kbd_buffer_store_event_hold (event
, 0);
3741 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3743 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3744 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3745 Else, if EVENT is a quit event, store the quit event
3746 in HOLD_QUIT, and return (thus ignoring further events).
3748 This is used in read_avail_input to postpone the processing
3749 of the quit event until all subsequent input events have been
3750 parsed (and discarded).
3754 kbd_buffer_store_event_hold (event
, hold_quit
)
3755 register struct input_event
*event
;
3756 struct input_event
*hold_quit
;
3758 if (event
->kind
== NO_EVENT
)
3761 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3764 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3766 register int c
= event
->code
& 0377;
3768 if (event
->modifiers
& ctrl_modifier
)
3769 c
= make_ctrl_char (c
);
3771 c
|= (event
->modifiers
3772 & (meta_modifier
| alt_modifier
3773 | hyper_modifier
| super_modifier
));
3778 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3779 struct input_event
*sp
;
3781 if (single_kboard
&& kb
!= current_kboard
)
3784 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3785 Fcons (make_number (c
), Qnil
));
3786 kb
->kbd_queue_has_data
= 1;
3787 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3789 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3792 if (event_to_kboard (sp
) == kb
)
3794 sp
->kind
= NO_EVENT
;
3795 sp
->frame_or_window
= Qnil
;
3805 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3809 /* If this results in a quit_char being returned to Emacs as
3810 input, set Vlast_event_frame properly. If this doesn't
3811 get returned to Emacs as an event, the next event read
3812 will set Vlast_event_frame again, so this is safe to do. */
3816 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3818 focus
= event
->frame_or_window
;
3819 internal_last_event_frame
= focus
;
3820 Vlast_event_frame
= focus
;
3823 last_event_timestamp
= event
->timestamp
;
3824 handle_interrupt ();
3828 if (c
&& c
== stop_character
)
3834 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3835 Just ignore the second one. */
3836 else if (event
->kind
== BUFFER_SWITCH_EVENT
3837 && kbd_fetch_ptr
!= kbd_store_ptr
3838 && ((kbd_store_ptr
== kbd_buffer
3839 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3840 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3843 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3844 kbd_store_ptr
= kbd_buffer
;
3846 /* Don't let the very last slot in the buffer become full,
3847 since that would make the two pointers equal,
3848 and that is indistinguishable from an empty buffer.
3849 Discard the event if it would fill the last slot. */
3850 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3852 *kbd_store_ptr
= *event
;
3856 /* If we're inside while-no-input, and this event qualifies
3857 as input, set quit-flag to cause an interrupt. */
3858 if (!NILP (Vthrow_on_input
)
3859 && event
->kind
!= FOCUS_IN_EVENT
3860 && event
->kind
!= HELP_EVENT
3861 && event
->kind
!= DEICONIFY_EVENT
)
3863 Vquit_flag
= Vthrow_on_input
;
3864 /* If we're inside a function that wants immediate quits,
3866 if (immediate_quit
&& NILP (Vinhibit_quit
))
3876 /* Put an input event back in the head of the event queue. */
3879 kbd_buffer_unget_event (event
)
3880 register struct input_event
*event
;
3882 if (kbd_fetch_ptr
== kbd_buffer
)
3883 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3885 /* Don't let the very last slot in the buffer become full, */
3886 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3889 *kbd_fetch_ptr
= *event
;
3894 /* Generate HELP_EVENT input_events in BUFP which has room for
3895 SIZE events. If there's not enough room in BUFP, ignore this
3898 HELP is the help form.
3900 FRAME is the frame on which the help is generated. OBJECT is the
3901 Lisp object where the help was found (a buffer, a string, an
3902 overlay, or nil if neither from a string nor from a buffer. POS is
3903 the position within OBJECT where the help was found.
3905 Value is the number of input_events generated. */
3908 gen_help_event (help
, frame
, window
, object
, pos
)
3909 Lisp_Object help
, frame
, object
, window
;
3912 struct input_event event
;
3916 event
.kind
= HELP_EVENT
;
3917 event
.frame_or_window
= frame
;
3919 event
.x
= WINDOWP (window
) ? window
: frame
;
3922 kbd_buffer_store_event (&event
);
3926 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3929 kbd_buffer_store_help_event (frame
, help
)
3930 Lisp_Object frame
, help
;
3932 struct input_event event
;
3934 event
.kind
= HELP_EVENT
;
3935 event
.frame_or_window
= frame
;
3940 kbd_buffer_store_event (&event
);
3944 /* Discard any mouse events in the event buffer by setting them to
3947 discard_mouse_events ()
3949 struct input_event
*sp
;
3950 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3952 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3955 if (sp
->kind
== MOUSE_CLICK_EVENT
3956 || sp
->kind
== WHEEL_EVENT
3957 || sp
->kind
== HORIZ_WHEEL_EVENT
3959 || sp
->kind
== GPM_CLICK_EVENT
3961 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3963 sp
->kind
= NO_EVENT
;
3969 /* Return non-zero if there are any real events waiting in the event
3970 buffer, not counting `NO_EVENT's.
3972 If DISCARD is non-zero, discard NO_EVENT events at the front of
3973 the input queue, possibly leaving the input queue empty if there
3974 are no real input events. */
3977 kbd_buffer_events_waiting (discard
)
3980 struct input_event
*sp
;
3982 for (sp
= kbd_fetch_ptr
;
3983 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3986 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3993 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3997 /* Clear input event EVENT. */
4001 struct input_event
*event
;
4003 event
->kind
= NO_EVENT
;
4007 /* Read one event from the event buffer, waiting if necessary.
4008 The value is a Lisp object representing the event.
4009 The value is nil for an event that should be ignored,
4010 or that was handled here.
4011 We always read and discard one event. */
4014 kbd_buffer_get_event (kbp
, used_mouse_menu
, end_time
)
4016 int *used_mouse_menu
;
4017 EMACS_TIME
*end_time
;
4026 *kbp
= current_kboard
;
4030 /* Wait until there is input available. */
4033 /* Break loop if there's an unread command event. Needed in
4034 moused window autoselection which uses a timer to insert such
4036 if (CONSP (Vunread_command_events
))
4039 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4041 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4042 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4046 /* If the quit flag is set, then read_char will return
4047 quit_char, so that counts as "available input." */
4048 if (!NILP (Vquit_flag
))
4049 quit_throw_to_read_char ();
4051 /* One way or another, wait until input is available; then, if
4052 interrupt handlers have not read it, read it now. */
4055 wait_for_kbd_input ();
4057 /* Note SIGIO has been undef'd if FIONREAD is missing. */
4061 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4063 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4064 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4069 EMACS_TIME duration
;
4070 EMACS_GET_TIME (duration
);
4071 if (EMACS_TIME_GE (duration
, *end_time
))
4072 return Qnil
; /* finished waiting */
4075 EMACS_SUB_TIME (duration
, *end_time
, duration
);
4076 wait_reading_process_output (EMACS_SECS (duration
),
4077 EMACS_USECS (duration
),
4078 -1, 1, Qnil
, NULL
, 0);
4082 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
4084 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
4085 /* Pass 1 for EXPECT since we just waited to have input. */
4086 read_avail_input (1);
4087 #endif /* not VMS */
4090 if (CONSP (Vunread_command_events
))
4093 first
= XCAR (Vunread_command_events
);
4094 Vunread_command_events
= XCDR (Vunread_command_events
);
4095 *kbp
= current_kboard
;
4099 /* At this point, we know that there is a readable event available
4100 somewhere. If the event queue is empty, then there must be a
4101 mouse movement enabled and available. */
4102 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4104 struct input_event
*event
;
4106 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4110 last_event_timestamp
= event
->timestamp
;
4113 *kbp
= event_to_kboard (event
);
4115 *kbp
= current_kboard
; /* Better than returning null ptr? */
4117 *kbp
= &the_only_kboard
;
4122 /* These two kinds of events get special handling
4123 and don't actually appear to the command loop.
4124 We return nil for them. */
4125 if (event
->kind
== SELECTION_REQUEST_EVENT
4126 || event
->kind
== SELECTION_CLEAR_EVENT
)
4129 struct input_event copy
;
4131 /* Remove it from the buffer before processing it,
4132 since otherwise swallow_events will see it
4133 and process it again. */
4135 kbd_fetch_ptr
= event
+ 1;
4136 input_pending
= readable_events (0);
4137 x_handle_selection_event (©
);
4139 /* We're getting selection request events, but we don't have
4145 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4146 || defined (HAVE_NS)
4147 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4149 /* Make an event (delete-frame (FRAME)). */
4150 obj
= Fcons (event
->frame_or_window
, Qnil
);
4151 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4152 kbd_fetch_ptr
= event
+ 1;
4155 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4156 || defined (HAVE_NS)
4157 else if (event
->kind
== ICONIFY_EVENT
)
4159 /* Make an event (iconify-frame (FRAME)). */
4160 obj
= Fcons (event
->frame_or_window
, Qnil
);
4161 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4162 kbd_fetch_ptr
= event
+ 1;
4164 else if (event
->kind
== DEICONIFY_EVENT
)
4166 /* Make an event (make-frame-visible (FRAME)). */
4167 obj
= Fcons (event
->frame_or_window
, Qnil
);
4168 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4169 kbd_fetch_ptr
= event
+ 1;
4172 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4174 /* The value doesn't matter here; only the type is tested. */
4175 XSETBUFFER (obj
, current_buffer
);
4176 kbd_fetch_ptr
= event
+ 1;
4178 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4179 || defined(HAVE_NS) || defined (USE_GTK)
4180 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4182 kbd_fetch_ptr
= event
+ 1;
4183 input_pending
= readable_events (0);
4184 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4185 x_activate_menubar (XFRAME (event
->frame_or_window
));
4188 #if defined (WINDOWSNT)
4189 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4191 /* Make an event (language-change (FRAME CHARSET LCID)). */
4192 obj
= Fcons (event
->frame_or_window
, Qnil
);
4193 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4194 kbd_fetch_ptr
= event
+ 1;
4197 else if (event
->kind
== SAVE_SESSION_EVENT
)
4199 obj
= Fcons (Qsave_session
, Qnil
);
4200 kbd_fetch_ptr
= event
+ 1;
4202 /* Just discard these, by returning nil.
4203 With MULTI_KBOARD, these events are used as placeholders
4204 when we need to randomly delete events from the queue.
4205 (They shouldn't otherwise be found in the buffer,
4206 but on some machines it appears they do show up
4207 even without MULTI_KBOARD.) */
4208 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4209 mouse events during a popup-menu call. */
4210 else if (event
->kind
== NO_EVENT
)
4211 kbd_fetch_ptr
= event
+ 1;
4212 else if (event
->kind
== HELP_EVENT
)
4214 Lisp_Object object
, position
, help
, frame
, window
;
4216 frame
= event
->frame_or_window
;
4217 object
= event
->arg
;
4218 position
= make_number (event
->code
);
4221 clear_event (event
);
4223 kbd_fetch_ptr
= event
+ 1;
4224 if (!WINDOWP (window
))
4226 obj
= Fcons (Qhelp_echo
,
4227 list5 (frame
, help
, window
, object
, position
));
4229 else if (event
->kind
== FOCUS_IN_EVENT
)
4231 /* Notification of a FocusIn event. The frame receiving the
4232 focus is in event->frame_or_window. Generate a
4233 switch-frame event if necessary. */
4234 Lisp_Object frame
, focus
;
4236 frame
= event
->frame_or_window
;
4237 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4241 if (!EQ (frame
, internal_last_event_frame
)
4242 && !EQ (frame
, selected_frame
))
4243 obj
= make_lispy_switch_frame (frame
);
4244 internal_last_event_frame
= frame
;
4245 kbd_fetch_ptr
= event
+ 1;
4248 else if (event
->kind
== DBUS_EVENT
)
4250 obj
= make_lispy_event (event
);
4251 kbd_fetch_ptr
= event
+ 1;
4256 /* If this event is on a different frame, return a switch-frame this
4257 time, and leave the event in the queue for next time. */
4261 frame
= event
->frame_or_window
;
4263 frame
= XCAR (frame
);
4264 else if (WINDOWP (frame
))
4265 frame
= WINDOW_FRAME (XWINDOW (frame
));
4267 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4271 if (! EQ (frame
, internal_last_event_frame
)
4272 && !EQ (frame
, selected_frame
))
4273 obj
= make_lispy_switch_frame (frame
);
4274 internal_last_event_frame
= frame
;
4276 /* If we didn't decide to make a switch-frame event, go ahead
4277 and build a real event from the queue entry. */
4281 obj
= make_lispy_event (event
);
4283 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4284 || defined(HAVE_NS) || defined (USE_GTK)
4285 /* If this was a menu selection, then set the flag to inhibit
4286 writing to last_nonmenu_event. Don't do this if the event
4287 we're returning is (menu-bar), though; that indicates the
4288 beginning of the menu sequence, and we might as well leave
4289 that as the `event with parameters' for this selection. */
4291 && !EQ (event
->frame_or_window
, event
->arg
)
4292 && (event
->kind
== MENU_BAR_EVENT
4293 || event
->kind
== TOOL_BAR_EVENT
))
4294 *used_mouse_menu
= 1;
4297 /* Wipe out this event, to catch bugs. */
4298 clear_event (event
);
4299 kbd_fetch_ptr
= event
+ 1;
4303 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4304 /* Try generating a mouse motion event. */
4305 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4307 FRAME_PTR f
= some_mouse_moved ();
4308 Lisp_Object bar_window
;
4309 enum scroll_bar_part part
;
4313 *kbp
= current_kboard
;
4314 /* Note that this uses F to determine which terminal to look at.
4315 If there is no valid info, it does not store anything
4316 so x remains nil. */
4319 /* XXX Can f or mouse_position_hook be NULL here? */
4320 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4321 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4322 &part
, &x
, &y
, &time
);
4326 /* Decide if we should generate a switch-frame event. Don't
4327 generate switch-frame events for motion outside of all Emacs
4333 frame
= FRAME_FOCUS_FRAME (f
);
4335 XSETFRAME (frame
, f
);
4337 if (! EQ (frame
, internal_last_event_frame
)
4338 && !EQ (frame
, selected_frame
))
4339 obj
= make_lispy_switch_frame (frame
);
4340 internal_last_event_frame
= frame
;
4343 /* If we didn't decide to make a switch-frame event, go ahead and
4344 return a mouse-motion event. */
4345 if (!NILP (x
) && NILP (obj
))
4346 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4348 #endif /* HAVE_MOUSE || HAVE GPM */
4350 /* We were promised by the above while loop that there was
4351 something for us to read! */
4354 input_pending
= readable_events (0);
4356 Vlast_event_frame
= internal_last_event_frame
;
4361 /* Process any events that are not user-visible,
4362 then return, without reading any user-visible events. */
4365 swallow_events (do_display
)
4370 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4372 struct input_event
*event
;
4374 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4378 last_event_timestamp
= event
->timestamp
;
4380 /* These two kinds of events get special handling
4381 and don't actually appear to the command loop. */
4382 if (event
->kind
== SELECTION_REQUEST_EVENT
4383 || event
->kind
== SELECTION_CLEAR_EVENT
)
4386 struct input_event copy
;
4388 /* Remove it from the buffer before processing it,
4389 since otherwise swallow_events called recursively could see it
4390 and process it again. */
4392 kbd_fetch_ptr
= event
+ 1;
4393 input_pending
= readable_events (0);
4394 x_handle_selection_event (©
);
4396 /* We're getting selection request events, but we don't have
4405 old_timers_run
= timers_run
;
4406 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4408 if (timers_run
!= old_timers_run
&& do_display
)
4409 redisplay_preserve_echo_area (7);
4412 /* Record the start of when Emacs is idle,
4413 for the sake of running idle-time timers. */
4420 /* If we are already in the idle state, do nothing. */
4421 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4424 EMACS_GET_TIME (timer_idleness_start_time
);
4426 timer_last_idleness_start_time
= timer_idleness_start_time
;
4428 /* Mark all idle-time timers as once again candidates for running. */
4429 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4433 timer
= XCAR (timers
);
4435 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4437 XVECTOR (timer
)->contents
[0] = Qnil
;
4441 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4446 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4449 /* Resume idle timer from last idle start time. */
4452 timer_resume_idle ()
4454 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4457 timer_idleness_start_time
= timer_last_idleness_start_time
;
4460 /* This is only for debugging. */
4461 struct input_event last_timer_event
;
4463 /* List of elisp functions to call, delayed because they were generated in
4464 a context where Elisp could not be safely run (e.g. redisplay, signal,
4465 ...). Each lement has the form (FUN . ARGS). */
4466 Lisp_Object pending_funcalls
;
4468 extern Lisp_Object Qapply
;
4470 /* Check whether a timer has fired. To prevent larger problems we simply
4471 disregard elements that are not proper timers. Do not make a circular
4472 timer list for the time being.
4474 Returns the number of seconds to wait until the next timer fires. If a
4475 timer is triggering now, return zero seconds.
4476 If no timer is active, return -1 seconds.
4478 If a timer is ripe, we run it, with quitting turned off.
4480 DO_IT_NOW is now ignored. It used to mean that we should
4481 run the timer directly instead of queueing a timer-event.
4482 Now we always run timers directly. */
4485 timer_check (do_it_now
)
4488 EMACS_TIME nexttime
;
4489 EMACS_TIME now
, idleness_now
;
4490 Lisp_Object timers
, idle_timers
, chosen_timer
;
4491 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4493 EMACS_SET_SECS (nexttime
, -1);
4494 EMACS_SET_USECS (nexttime
, -1);
4496 /* Always consider the ordinary timers. */
4497 timers
= Vtimer_list
;
4498 /* Consider the idle timers only if Emacs is idle. */
4499 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4500 idle_timers
= Vtimer_idle_list
;
4503 chosen_timer
= Qnil
;
4504 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4506 /* First run the code that was delayed. */
4507 while (CONSP (pending_funcalls
))
4509 Lisp_Object funcall
= XCAR (pending_funcalls
);
4510 pending_funcalls
= XCDR (pending_funcalls
);
4511 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4514 if (CONSP (timers
) || CONSP (idle_timers
))
4516 EMACS_GET_TIME (now
);
4517 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4518 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4521 while (CONSP (timers
) || CONSP (idle_timers
))
4523 Lisp_Object
*vector
;
4524 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4525 EMACS_TIME timer_time
, idle_timer_time
;
4526 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4528 /* Skip past invalid timers and timers already handled. */
4531 timer
= XCAR (timers
);
4532 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4534 timers
= XCDR (timers
);
4537 vector
= XVECTOR (timer
)->contents
;
4539 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4540 || !INTEGERP (vector
[3])
4541 || ! NILP (vector
[0]))
4543 timers
= XCDR (timers
);
4547 if (!NILP (idle_timers
))
4549 timer
= XCAR (idle_timers
);
4550 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4552 idle_timers
= XCDR (idle_timers
);
4555 vector
= XVECTOR (timer
)->contents
;
4557 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4558 || !INTEGERP (vector
[3])
4559 || ! NILP (vector
[0]))
4561 idle_timers
= XCDR (idle_timers
);
4566 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4567 based on the next ordinary timer.
4568 TIMER_DIFFERENCE is the distance in time from NOW to when
4569 this timer becomes ripe (negative if it's already ripe). */
4572 timer
= XCAR (timers
);
4573 vector
= XVECTOR (timer
)->contents
;
4574 EMACS_SET_SECS (timer_time
,
4575 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4576 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4577 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4580 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4581 based on the next idle timer. */
4582 if (!NILP (idle_timers
))
4584 idle_timer
= XCAR (idle_timers
);
4585 vector
= XVECTOR (idle_timer
)->contents
;
4586 EMACS_SET_SECS (idle_timer_time
,
4587 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4588 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4589 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4592 /* Decide which timer is the next timer,
4593 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4594 Also step down the list where we found that timer. */
4596 if (! NILP (timers
) && ! NILP (idle_timers
))
4599 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4600 if (EMACS_TIME_NEG_P (temp
))
4602 chosen_timer
= timer
;
4603 timers
= XCDR (timers
);
4604 difference
= timer_difference
;
4608 chosen_timer
= idle_timer
;
4609 idle_timers
= XCDR (idle_timers
);
4610 difference
= idle_timer_difference
;
4613 else if (! NILP (timers
))
4615 chosen_timer
= timer
;
4616 timers
= XCDR (timers
);
4617 difference
= timer_difference
;
4621 chosen_timer
= idle_timer
;
4622 idle_timers
= XCDR (idle_timers
);
4623 difference
= idle_timer_difference
;
4625 vector
= XVECTOR (chosen_timer
)->contents
;
4627 /* If timer is ripe, run it if it hasn't been run. */
4628 if (EMACS_TIME_NEG_P (difference
)
4629 || (EMACS_SECS (difference
) == 0
4630 && EMACS_USECS (difference
) == 0))
4632 if (NILP (vector
[0]))
4634 int count
= SPECPDL_INDEX ();
4635 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4637 #if 0 /* This shouldn't be necessary anymore. --lorentey */
4638 /* On unbind_to, resume allowing input from any kboard, if that
4640 record_single_kboard_state ();
4642 /* Mark the timer as triggered to prevent problems if the lisp
4643 code fails to reschedule it right. */
4646 specbind (Qinhibit_quit
, Qt
);
4648 call1 (Qtimer_event_handler
, chosen_timer
);
4649 Vdeactivate_mark
= old_deactivate_mark
;
4651 unbind_to (count
, Qnil
);
4653 /* Since we have handled the event,
4654 we don't need to tell the caller to wake up and do it. */
4658 /* When we encounter a timer that is still waiting,
4659 return the amount of time to wait before it is ripe. */
4666 /* No timers are pending in the future. */
4667 /* Return 0 if we generated an event, and -1 if not. */
4672 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4673 doc
: /* Return the current length of Emacs idleness, or nil.
4674 The value when Emacs is idle is a list of three integers. The first has the
4675 most significant 16 bits of the seconds, while the second has the
4676 least significant 16 bits. The third integer gives the microsecond
4679 The value when Emacs is not idle is nil.
4681 The microsecond count is zero on systems that do not provide
4682 resolution finer than a second. */)
4685 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4687 EMACS_TIME now
, idleness_now
;
4689 EMACS_GET_TIME (now
);
4690 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4692 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4693 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4694 make_number (EMACS_USECS (idleness_now
)));
4700 /* Caches for modify_event_symbol. */
4701 static Lisp_Object accent_key_syms
;
4702 static Lisp_Object func_key_syms
;
4703 static Lisp_Object mouse_syms
;
4704 static Lisp_Object wheel_syms
;
4705 static Lisp_Object drag_n_drop_syms
;
4707 /* This is a list of keysym codes for special "accent" characters.
4708 It parallels lispy_accent_keys. */
4710 static int lispy_accent_codes
[] =
4712 #ifdef XK_dead_circumflex
4717 #ifdef XK_dead_grave
4722 #ifdef XK_dead_tilde
4727 #ifdef XK_dead_diaeresis
4732 #ifdef XK_dead_macron
4737 #ifdef XK_dead_degree
4742 #ifdef XK_dead_acute
4747 #ifdef XK_dead_cedilla
4752 #ifdef XK_dead_breve
4757 #ifdef XK_dead_ogonek
4762 #ifdef XK_dead_caron
4767 #ifdef XK_dead_doubleacute
4768 XK_dead_doubleacute
,
4772 #ifdef XK_dead_abovedot
4777 #ifdef XK_dead_abovering
4787 #ifdef XK_dead_belowdot
4792 #ifdef XK_dead_voiced_sound
4793 XK_dead_voiced_sound
,
4797 #ifdef XK_dead_semivoiced_sound
4798 XK_dead_semivoiced_sound
,
4814 /* This is a list of Lisp names for special "accent" characters.
4815 It parallels lispy_accent_codes. */
4817 static char *lispy_accent_keys
[] =
4835 "dead-voiced-sound",
4836 "dead-semivoiced-sound",
4842 #define FUNCTION_KEY_OFFSET 0x0
4844 char *lispy_function_keys
[] =
4848 0, /* VK_LBUTTON 0x01 */
4849 0, /* VK_RBUTTON 0x02 */
4850 "cancel", /* VK_CANCEL 0x03 */
4851 0, /* VK_MBUTTON 0x04 */
4853 0, 0, 0, /* 0x05 .. 0x07 */
4855 "backspace", /* VK_BACK 0x08 */
4856 "tab", /* VK_TAB 0x09 */
4858 0, 0, /* 0x0A .. 0x0B */
4860 "clear", /* VK_CLEAR 0x0C */
4861 "return", /* VK_RETURN 0x0D */
4863 0, 0, /* 0x0E .. 0x0F */
4865 0, /* VK_SHIFT 0x10 */
4866 0, /* VK_CONTROL 0x11 */
4867 0, /* VK_MENU 0x12 */
4868 "pause", /* VK_PAUSE 0x13 */
4869 "capslock", /* VK_CAPITAL 0x14 */
4870 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4872 "junja", /* VK_JUNJA 0x17 */
4873 "final", /* VK_FINAL 0x18 */
4874 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4876 "escape", /* VK_ESCAPE 0x1B */
4877 "convert", /* VK_CONVERT 0x1C */
4878 "non-convert", /* VK_NONCONVERT 0x1D */
4879 "accept", /* VK_ACCEPT 0x1E */
4880 "mode-change", /* VK_MODECHANGE 0x1F */
4881 0, /* VK_SPACE 0x20 */
4882 "prior", /* VK_PRIOR 0x21 */
4883 "next", /* VK_NEXT 0x22 */
4884 "end", /* VK_END 0x23 */
4885 "home", /* VK_HOME 0x24 */
4886 "left", /* VK_LEFT 0x25 */
4887 "up", /* VK_UP 0x26 */
4888 "right", /* VK_RIGHT 0x27 */
4889 "down", /* VK_DOWN 0x28 */
4890 "select", /* VK_SELECT 0x29 */
4891 "print", /* VK_PRINT 0x2A */
4892 "execute", /* VK_EXECUTE 0x2B */
4893 "snapshot", /* VK_SNAPSHOT 0x2C */
4894 "insert", /* VK_INSERT 0x2D */
4895 "delete", /* VK_DELETE 0x2E */
4896 "help", /* VK_HELP 0x2F */
4898 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4900 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4902 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4904 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4906 0, 0, 0, 0, 0, 0, 0, 0, 0,
4907 0, 0, 0, 0, 0, 0, 0, 0, 0,
4908 0, 0, 0, 0, 0, 0, 0, 0,
4910 "lwindow", /* VK_LWIN 0x5B */
4911 "rwindow", /* VK_RWIN 0x5C */
4912 "apps", /* VK_APPS 0x5D */
4915 "kp-0", /* VK_NUMPAD0 0x60 */
4916 "kp-1", /* VK_NUMPAD1 0x61 */
4917 "kp-2", /* VK_NUMPAD2 0x62 */
4918 "kp-3", /* VK_NUMPAD3 0x63 */
4919 "kp-4", /* VK_NUMPAD4 0x64 */
4920 "kp-5", /* VK_NUMPAD5 0x65 */
4921 "kp-6", /* VK_NUMPAD6 0x66 */
4922 "kp-7", /* VK_NUMPAD7 0x67 */
4923 "kp-8", /* VK_NUMPAD8 0x68 */
4924 "kp-9", /* VK_NUMPAD9 0x69 */
4925 "kp-multiply", /* VK_MULTIPLY 0x6A */
4926 "kp-add", /* VK_ADD 0x6B */
4927 "kp-separator", /* VK_SEPARATOR 0x6C */
4928 "kp-subtract", /* VK_SUBTRACT 0x6D */
4929 "kp-decimal", /* VK_DECIMAL 0x6E */
4930 "kp-divide", /* VK_DIVIDE 0x6F */
4931 "f1", /* VK_F1 0x70 */
4932 "f2", /* VK_F2 0x71 */
4933 "f3", /* VK_F3 0x72 */
4934 "f4", /* VK_F4 0x73 */
4935 "f5", /* VK_F5 0x74 */
4936 "f6", /* VK_F6 0x75 */
4937 "f7", /* VK_F7 0x76 */
4938 "f8", /* VK_F8 0x77 */
4939 "f9", /* VK_F9 0x78 */
4940 "f10", /* VK_F10 0x79 */
4941 "f11", /* VK_F11 0x7A */
4942 "f12", /* VK_F12 0x7B */
4943 "f13", /* VK_F13 0x7C */
4944 "f14", /* VK_F14 0x7D */
4945 "f15", /* VK_F15 0x7E */
4946 "f16", /* VK_F16 0x7F */
4947 "f17", /* VK_F17 0x80 */
4948 "f18", /* VK_F18 0x81 */
4949 "f19", /* VK_F19 0x82 */
4950 "f20", /* VK_F20 0x83 */
4951 "f21", /* VK_F21 0x84 */
4952 "f22", /* VK_F22 0x85 */
4953 "f23", /* VK_F23 0x86 */
4954 "f24", /* VK_F24 0x87 */
4956 0, 0, 0, 0, /* 0x88 .. 0x8B */
4957 0, 0, 0, 0, /* 0x8C .. 0x8F */
4959 "kp-numlock", /* VK_NUMLOCK 0x90 */
4960 "scroll", /* VK_SCROLL 0x91 */
4961 /* Not sure where the following block comes from.
4962 Windows headers have NEC and Fujitsu specific keys in
4963 this block, but nothing generic. */
4964 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4965 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4966 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4967 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4968 "kp-end", /* VK_NUMPAD_END 0x96 */
4969 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4970 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4971 "kp-up", /* VK_NUMPAD_UP 0x99 */
4972 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4973 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4974 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4975 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4977 0, 0, /* 0x9E .. 0x9F */
4980 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4981 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4982 * No other API or message will distinguish left and right keys this way.
4987 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4988 to enable them selectively, and gives access to a few more functions.
4989 See lispy_multimedia_keys below. */
4990 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4991 0, 0, 0, /* 0xAD .. 0xAF Volume */
4992 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4993 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4995 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4996 0, 0, 0, 0, 0, 0, 0, 0, 0,
4998 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4999 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5000 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5003 "ax", /* VK_OEM_AX 0xE1 */
5004 0, /* VK_OEM_102 0xE2 */
5005 "ico-help", /* VK_ICO_HELP 0xE3 */
5006 "ico-00", /* VK_ICO_00 0xE4 */
5007 0, /* VK_PROCESSKEY 0xE5 */
5008 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
5009 "packet", /* VK_PACKET 0xE7 */
5011 "reset", /* VK_OEM_RESET 0xE9 */
5012 "jump", /* VK_OEM_JUMP 0xEA */
5013 "oem-pa1", /* VK_OEM_PA1 0xEB */
5014 "oem-pa2", /* VK_OEM_PA2 0xEC */
5015 "oem-pa3", /* VK_OEM_PA3 0xED */
5016 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
5017 "cusel", /* VK_OEM_CUSEL 0xEF */
5018 "oem-attn", /* VK_OEM_ATTN 0xF0 */
5019 "finish", /* VK_OEM_FINISH 0xF1 */
5020 "copy", /* VK_OEM_COPY 0xF2 */
5021 "auto", /* VK_OEM_AUTO 0xF3 */
5022 "enlw", /* VK_OEM_ENLW 0xF4 */
5023 "backtab", /* VK_OEM_BACKTAB 0xF5 */
5024 "attn", /* VK_ATTN 0xF6 */
5025 "crsel", /* VK_CRSEL 0xF7 */
5026 "exsel", /* VK_EXSEL 0xF8 */
5027 "ereof", /* VK_EREOF 0xF9 */
5028 "play", /* VK_PLAY 0xFA */
5029 "zoom", /* VK_ZOOM 0xFB */
5030 "noname", /* VK_NONAME 0xFC */
5031 "pa1", /* VK_PA1 0xFD */
5032 "oem_clear", /* VK_OEM_CLEAR 0xFE */
5036 /* Some of these duplicate the "Media keys" on newer keyboards,
5037 but they are delivered to the application in a different way. */
5038 static char *lispy_multimedia_keys
[] =
5046 "browser-favorites",
5083 "toggle-dictate-command",
5089 "media-fast-forward",
5092 "media-channel-down"
5095 #else /* not HAVE_NTGUI */
5097 /* This should be dealt with in XTread_socket now, and that doesn't
5098 depend on the client system having the Kana syms defined. See also
5099 the XK_kana_A case below. */
5102 static char *lispy_kana_keys
[] =
5104 /* X Keysym value */
5105 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5106 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5107 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5108 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5109 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5110 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5111 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5112 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5113 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5114 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5115 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5116 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5117 "kana-i", "kana-u", "kana-e", "kana-o",
5118 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5119 "prolongedsound", "kana-A", "kana-I", "kana-U",
5120 "kana-E", "kana-O", "kana-KA", "kana-KI",
5121 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5122 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5123 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5124 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5125 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5126 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5127 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5128 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5129 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5130 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5131 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5132 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5134 #endif /* XK_kana_A */
5137 #define FUNCTION_KEY_OFFSET 0xff00
5139 /* You'll notice that this table is arranged to be conveniently
5140 indexed by X Windows keysym values. */
5141 static char *lispy_function_keys
[] =
5143 /* X Keysym value */
5145 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5146 "backspace", "tab", "linefeed", "clear",
5148 0, 0, 0, "pause", /* 0xff10...1f */
5149 0, 0, 0, 0, 0, 0, 0, "escape",
5151 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5152 "romaji", "hiragana", "katakana", "hiragana-katakana",
5153 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5154 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5155 "eisu-toggle", /* 0xff30...3f */
5156 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5157 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5159 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5160 "down", "prior", "next", "end",
5161 "begin", 0, 0, 0, 0, 0, 0, 0,
5162 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5173 "break", /* 0xff6b */
5176 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5177 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5178 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5179 0, 0, 0, 0, 0, 0, 0, 0,
5180 "kp-tab", /* 0xff89 */
5182 "kp-enter", /* 0xff8d */
5184 "kp-f1", /* 0xff91 */
5188 "kp-home", /* 0xff95 */
5193 "kp-prior", /* kp-page-up */
5194 "kp-next", /* kp-page-down */
5200 0, 0, 0, 0, 0, 0, 0, 0, 0,
5201 "kp-multiply", /* 0xffaa */
5206 "kp-divide", /* 0xffaf */
5207 "kp-0", /* 0xffb0 */
5208 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5211 "kp-equal", /* 0xffbd */
5212 "f1", /* 0xffbe */ /* IsFunctionKey */
5214 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5215 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5216 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5217 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5218 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5219 0, 0, 0, 0, 0, 0, 0, 0,
5220 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5221 0, 0, 0, 0, 0, 0, 0, "delete"
5224 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5225 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5227 static char *iso_lispy_function_keys
[] =
5229 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5230 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5231 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5232 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5233 "iso-lefttab", /* 0xfe20 */
5234 "iso-move-line-up", "iso-move-line-down",
5235 "iso-partial-line-up", "iso-partial-line-down",
5236 "iso-partial-space-left", "iso-partial-space-right",
5237 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5238 "iso-release-margin-left", "iso-release-margin-right",
5239 "iso-release-both-margins",
5240 "iso-fast-cursor-left", "iso-fast-cursor-right",
5241 "iso-fast-cursor-up", "iso-fast-cursor-down",
5242 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5243 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5246 #endif /* not HAVE_NTGUI */
5248 Lisp_Object Vlispy_mouse_stem
;
5250 static char *lispy_wheel_names
[] =
5252 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5255 /* drag-n-drop events are generated when a set of selected files are
5256 dragged from another application and dropped onto an Emacs window. */
5257 static char *lispy_drag_n_drop_names
[] =
5262 /* Scroll bar parts. */
5263 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5264 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5265 Lisp_Object Qtop
, Qratio
;
5267 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5268 Lisp_Object
*scroll_bar_parts
[] = {
5269 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5270 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5273 /* A vector, indexed by button number, giving the down-going location
5274 of currently depressed buttons, both scroll bar and non-scroll bar.
5276 The elements have the form
5277 (BUTTON-NUMBER MODIFIER-MASK . REST)
5278 where REST is the cdr of a position as it would be reported in the event.
5280 The make_lispy_event function stores positions here to tell the
5281 difference between click and drag events, and to store the starting
5282 location to be included in drag events. */
5284 static Lisp_Object button_down_location
;
5286 /* Information about the most recent up-going button event: Which
5287 button, what location, and what time. */
5289 static int last_mouse_button
;
5290 static int last_mouse_x
;
5291 static int last_mouse_y
;
5292 static unsigned long button_down_time
;
5294 /* The maximum time between clicks to make a double-click, or Qnil to
5295 disable double-click detection, or Qt for no time limit. */
5297 Lisp_Object Vdouble_click_time
;
5299 /* Maximum number of pixels the mouse may be moved between clicks
5300 to make a double-click. */
5302 EMACS_INT double_click_fuzz
;
5304 /* The number of clicks in this multiple-click. */
5306 int double_click_count
;
5308 /* Return position of a mouse click or wheel event */
5311 make_lispy_position (f
, x
, y
, time
)
5317 enum window_part part
;
5318 Lisp_Object posn
= Qnil
;
5319 Lisp_Object extra_info
= Qnil
;
5322 /* Set `window' to the window under frame pixel coordinates (x,y) */
5324 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5325 &part
, &wx
, &wy
, 0);
5329 if (WINDOWP (window
))
5331 /* It's a click in window window at frame coordinates (x,y) */
5332 struct window
*w
= XWINDOW (window
);
5333 Lisp_Object string_info
= Qnil
;
5334 int textpos
= -1, rx
= -1, ry
= -1;
5335 int dx
= -1, dy
= -1;
5336 int width
= -1, height
= -1;
5337 Lisp_Object object
= Qnil
;
5339 /* Set event coordinates to window-relative coordinates
5340 for constructing the Lisp event below. */
5344 if (part
== ON_TEXT
)
5346 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5348 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5350 /* Mode line or header line. Look for a string under
5351 the mouse that may have a `local-map' property. */
5355 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5357 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5358 &object
, &dx
, &dy
, &width
, &height
);
5359 if (STRINGP (string
))
5360 string_info
= Fcons (string
, make_number (charpos
));
5361 if (w
== XWINDOW (selected_window
))
5364 textpos
= XMARKER (w
->pointm
)->charpos
;
5366 else if (part
== ON_VERTICAL_BORDER
)
5368 posn
= Qvertical_line
;
5373 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5378 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5380 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5381 &object
, &dx
, &dy
, &width
, &height
);
5382 if (STRINGP (string
))
5383 string_info
= Fcons (string
, make_number (charpos
));
5384 if (part
== ON_LEFT_MARGIN
)
5387 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5389 else if (part
== ON_LEFT_FRINGE
)
5391 posn
= Qleft_fringe
;
5394 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5396 : window_box_width (w
, LEFT_MARGIN_AREA
));
5399 else if (part
== ON_RIGHT_FRINGE
)
5401 posn
= Qright_fringe
;
5404 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5405 + window_box_width (w
, TEXT_AREA
)
5406 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5407 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5413 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5414 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5419 Lisp_Object string2
, object2
= Qnil
;
5420 struct display_pos p
;
5422 int width2
, height2
;
5423 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5424 &object2
, &dx2
, &dy2
,
5426 textpos
= CHARPOS (p
.pos
);
5427 if (rx
< 0) rx
= wx
;
5428 if (ry
< 0) ry
= wy
;
5429 if (dx
< 0) dx
= dx2
;
5430 if (dy
< 0) dy
= dy2
;
5431 if (width
< 0) width
= width2
;
5432 if (height
< 0) height
= height2
;
5436 posn
= make_number (textpos
);
5437 if (STRINGP (string2
))
5438 string_info
= Fcons (string2
,
5439 make_number (CHARPOS (p
.string_pos
)));
5445 #ifdef HAVE_WINDOW_SYSTEM
5446 if (IMAGEP (object
))
5448 Lisp_Object image_map
, hotspot
;
5449 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5451 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5453 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5454 posn
= XCAR (hotspot
);
5459 extra_info
= Fcons (object
,
5460 Fcons (Fcons (make_number (dx
),
5462 Fcons (Fcons (make_number (width
),
5463 make_number (height
)),
5467 extra_info
= Fcons (string_info
,
5468 Fcons (make_number (textpos
),
5469 Fcons (Fcons (make_number (rx
),
5475 XSETFRAME (window
, f
);
5480 XSETFASTINT (*x
, 0);
5481 XSETFASTINT (*y
, 0);
5484 return Fcons (window
,
5486 Fcons (Fcons (*x
, *y
),
5487 Fcons (make_number (time
),
5491 /* Given a struct input_event, build the lisp event which represents
5492 it. If EVENT is 0, build a mouse movement event from the mouse
5493 movement buffer, which should have a movement event in it.
5495 Note that events must be passed to this function in the order they
5496 are received; this function stores the location of button presses
5497 in order to build drag events when the button is released. */
5500 make_lispy_event (event
)
5501 struct input_event
*event
;
5505 switch (SWITCH_ENUM_CAST (event
->kind
))
5507 /* A simple keystroke. */
5508 case ASCII_KEYSTROKE_EVENT
:
5509 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5511 Lisp_Object lispy_c
;
5512 int c
= event
->code
;
5513 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5516 eassert (c
== event
->code
);
5517 /* Turn ASCII characters into control characters
5519 if (event
->modifiers
& ctrl_modifier
)
5521 c
= make_ctrl_char (c
);
5522 event
->modifiers
&= ~ctrl_modifier
;
5526 /* Add in the other modifier bits. The shift key was taken care
5527 of by the X code. */
5528 c
|= (event
->modifiers
5529 & (meta_modifier
| alt_modifier
5530 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5531 /* Distinguish Shift-SPC from SPC. */
5532 if ((event
->code
) == 040
5533 && event
->modifiers
& shift_modifier
)
5534 c
|= shift_modifier
;
5535 button_down_time
= 0;
5536 XSETFASTINT (lispy_c
, c
);
5540 /* A function key. The symbol may need to have modifier prefixes
5542 case NON_ASCII_KEYSTROKE_EVENT
:
5543 button_down_time
= 0;
5545 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5546 if (event
->code
== lispy_accent_codes
[i
])
5547 return modify_event_symbol (i
,
5549 Qfunction_key
, Qnil
,
5550 lispy_accent_keys
, &accent_key_syms
,
5551 (sizeof (lispy_accent_keys
)
5552 / sizeof (lispy_accent_keys
[0])));
5556 if (event
->code
>= 0x400 && event
->code
< 0x500)
5557 return modify_event_symbol (event
->code
- 0x400,
5558 event
->modifiers
& ~shift_modifier
,
5559 Qfunction_key
, Qnil
,
5560 lispy_kana_keys
, &func_key_syms
,
5561 (sizeof (lispy_kana_keys
)
5562 / sizeof (lispy_kana_keys
[0])));
5563 #endif /* XK_kana_A */
5566 #ifdef ISO_FUNCTION_KEY_OFFSET
5567 if (event
->code
< FUNCTION_KEY_OFFSET
5568 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5569 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5571 Qfunction_key
, Qnil
,
5572 iso_lispy_function_keys
, &func_key_syms
,
5573 (sizeof (iso_lispy_function_keys
)
5574 / sizeof (iso_lispy_function_keys
[0])));
5577 /* Handle system-specific or unknown keysyms. */
5578 if (event
->code
& (1 << 28)
5579 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5580 || (event
->code
- FUNCTION_KEY_OFFSET
5581 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5582 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5584 /* We need to use an alist rather than a vector as the cache
5585 since we can't make a vector long enuf. */
5586 if (NILP (current_kboard
->system_key_syms
))
5587 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5588 return modify_event_symbol (event
->code
,
5591 current_kboard
->Vsystem_key_alist
,
5592 0, ¤t_kboard
->system_key_syms
,
5596 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5598 Qfunction_key
, Qnil
,
5599 lispy_function_keys
, &func_key_syms
,
5600 (sizeof (lispy_function_keys
)
5601 / sizeof (lispy_function_keys
[0])));
5604 case MULTIMEDIA_KEY_EVENT
:
5605 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5606 / sizeof (lispy_multimedia_keys
[0]))
5607 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5609 return modify_event_symbol (event
->code
, event
->modifiers
,
5610 Qfunction_key
, Qnil
,
5611 lispy_multimedia_keys
, &func_key_syms
,
5612 (sizeof (lispy_multimedia_keys
)
5613 / sizeof (lispy_multimedia_keys
[0])));
5619 /* A mouse click. Figure out where it is, decide whether it's
5620 a press, click or drag, and build the appropriate structure. */
5621 case MOUSE_CLICK_EVENT
:
5622 #ifndef USE_TOOLKIT_SCROLL_BARS
5623 case SCROLL_BAR_CLICK_EVENT
:
5626 int button
= event
->code
;
5628 Lisp_Object position
;
5629 Lisp_Object
*start_pos_ptr
;
5630 Lisp_Object start_pos
;
5634 /* Build the position as appropriate for this mouse click. */
5635 if (event
->kind
== MOUSE_CLICK_EVENT
)
5637 struct frame
*f
= XFRAME (event
->frame_or_window
);
5638 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5642 /* Ignore mouse events that were made on frame that
5643 have been deleted. */
5644 if (! FRAME_LIVE_P (f
))
5647 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5648 /* EVENT->x and EVENT->y are frame-relative pixel
5649 coordinates at this place. Under old redisplay, COLUMN
5650 and ROW are set to frame relative glyph coordinates
5651 which are then used to determine whether this click is
5652 in a menu (non-toolkit version). */
5653 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5654 &column
, &row
, NULL
, 1);
5656 /* In the non-toolkit version, clicks on the menu bar
5657 are ordinary button events in the event buffer.
5658 Distinguish them, and invoke the menu.
5660 (In the toolkit version, the toolkit handles the menu bar
5661 and Emacs doesn't know about it until after the user
5662 makes a selection.) */
5663 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5664 && (event
->modifiers
& down_modifier
))
5666 Lisp_Object items
, item
;
5671 /* Activate the menu bar on the down event. If the
5672 up event comes in before the menu code can deal with it,
5674 if (! (event
->modifiers
& down_modifier
))
5678 /* Find the menu bar item under `column'. */
5680 items
= FRAME_MENU_BAR_ITEMS (f
);
5681 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5683 Lisp_Object pos
, string
;
5684 string
= AREF (items
, i
+ 1);
5685 pos
= AREF (items
, i
+ 3);
5688 if (column
>= XINT (pos
)
5689 && column
< XINT (pos
) + SCHARS (string
))
5691 item
= AREF (items
, i
);
5696 /* ELisp manual 2.4b says (x y) are window relative but
5697 code says they are frame-relative. */
5699 = Fcons (event
->frame_or_window
,
5701 Fcons (Fcons (event
->x
, event
->y
),
5702 Fcons (make_number (event
->timestamp
),
5705 return Fcons (item
, Fcons (position
, Qnil
));
5707 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5709 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5712 #ifndef USE_TOOLKIT_SCROLL_BARS
5715 /* It's a scrollbar click. */
5717 Lisp_Object portion_whole
;
5720 window
= event
->frame_or_window
;
5721 portion_whole
= Fcons (event
->x
, event
->y
);
5722 part
= *scroll_bar_parts
[(int) event
->part
];
5726 Fcons (Qvertical_scroll_bar
,
5727 Fcons (portion_whole
,
5728 Fcons (make_number (event
->timestamp
),
5729 Fcons (part
, Qnil
)))));
5731 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5733 if (button
>= ASIZE (button_down_location
))
5735 button_down_location
= larger_vector (button_down_location
,
5737 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5740 start_pos_ptr
= &AREF (button_down_location
, button
);
5741 start_pos
= *start_pos_ptr
;
5742 *start_pos_ptr
= Qnil
;
5745 /* On window-system frames, use the value of
5746 double-click-fuzz as is. On other frames, interpret it
5747 as a multiple of 1/8 characters. */
5751 if (WINDOWP (event
->frame_or_window
))
5752 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5753 else if (FRAMEP (event
->frame_or_window
))
5754 f
= XFRAME (event
->frame_or_window
);
5758 if (FRAME_WINDOW_P (f
))
5759 fuzz
= double_click_fuzz
;
5761 fuzz
= double_click_fuzz
/ 8;
5763 is_double
= (button
== last_mouse_button
5764 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5765 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5766 && button_down_time
!= 0
5767 && (EQ (Vdouble_click_time
, Qt
)
5768 || (INTEGERP (Vdouble_click_time
)
5769 && ((int)(event
->timestamp
- button_down_time
)
5770 < XINT (Vdouble_click_time
)))));
5773 last_mouse_button
= button
;
5774 last_mouse_x
= XINT (event
->x
);
5775 last_mouse_y
= XINT (event
->y
);
5777 /* If this is a button press, squirrel away the location, so
5778 we can decide later whether it was a click or a drag. */
5779 if (event
->modifiers
& down_modifier
)
5783 double_click_count
++;
5784 event
->modifiers
|= ((double_click_count
> 2)
5789 double_click_count
= 1;
5790 button_down_time
= event
->timestamp
;
5791 *start_pos_ptr
= Fcopy_alist (position
);
5792 ignore_mouse_drag_p
= 0;
5795 /* Now we're releasing a button - check the co-ordinates to
5796 see if this was a click or a drag. */
5797 else if (event
->modifiers
& up_modifier
)
5799 /* If we did not see a down before this up, ignore the up.
5800 Probably this happened because the down event chose a
5801 menu item. It would be an annoyance to treat the
5802 release of the button that chose the menu item as a
5805 if (!CONSP (start_pos
))
5808 event
->modifiers
&= ~up_modifier
;
5809 #if 0 /* Formerly we treated an up with no down as a click event. */
5810 if (!CONSP (start_pos
))
5811 event
->modifiers
|= click_modifier
;
5816 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5818 /* The third element of every position
5819 should be the (x,y) pair. */
5820 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5822 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5824 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5825 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5828 if (ignore_mouse_drag_p
)
5830 event
->modifiers
|= click_modifier
;
5831 ignore_mouse_drag_p
= 0;
5833 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5834 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5835 /* Maybe the mouse has moved a lot, caused scrolling, and
5836 eventually ended up at the same screen position (but
5837 not buffer position) in which case it is a drag, not
5839 /* FIXME: OTOH if the buffer position has changed
5840 because of a timer or process filter rather than
5841 because of mouse movement, it should be considered as
5842 a click. But mouse-drag-region completely ignores
5843 this case and it hasn't caused any real problem, so
5844 it's probably OK to ignore it as well. */
5845 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5846 /* Mouse hasn't moved (much). */
5847 event
->modifiers
|= click_modifier
;
5850 button_down_time
= 0;
5851 event
->modifiers
|= drag_modifier
;
5854 /* Don't check is_double; treat this as multiple
5855 if the down-event was multiple. */
5856 if (double_click_count
> 1)
5857 event
->modifiers
|= ((double_click_count
> 2)
5863 /* Every mouse event should either have the down_modifier or
5864 the up_modifier set. */
5868 /* Get the symbol we should use for the mouse click. */
5871 head
= modify_event_symbol (button
,
5873 Qmouse_click
, Vlispy_mouse_stem
,
5876 XVECTOR (mouse_syms
)->size
);
5877 if (event
->modifiers
& drag_modifier
)
5882 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5885 Fcons (make_number (double_click_count
),
5895 case HORIZ_WHEEL_EVENT
:
5897 Lisp_Object position
;
5900 /* Build the position as appropriate for this mouse click. */
5901 struct frame
*f
= XFRAME (event
->frame_or_window
);
5903 /* Ignore wheel events that were made on frame that have been
5905 if (! FRAME_LIVE_P (f
))
5908 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5911 /* Set double or triple modifiers to indicate the wheel speed. */
5913 /* On window-system frames, use the value of
5914 double-click-fuzz as is. On other frames, interpret it
5915 as a multiple of 1/8 characters. */
5920 if (WINDOWP (event
->frame_or_window
))
5921 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5922 else if (FRAMEP (event
->frame_or_window
))
5923 f
= XFRAME (event
->frame_or_window
);
5927 if (FRAME_WINDOW_P (f
))
5928 fuzz
= double_click_fuzz
;
5930 fuzz
= double_click_fuzz
/ 8;
5932 is_double
= (last_mouse_button
< 0
5933 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5934 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5935 && button_down_time
!= 0
5936 && (EQ (Vdouble_click_time
, Qt
)
5937 || (INTEGERP (Vdouble_click_time
)
5938 && ((int)(event
->timestamp
- button_down_time
)
5939 < XINT (Vdouble_click_time
)))));
5942 double_click_count
++;
5943 event
->modifiers
|= ((double_click_count
> 2)
5949 double_click_count
= 1;
5950 event
->modifiers
|= click_modifier
;
5953 button_down_time
= event
->timestamp
;
5954 /* Use a negative value to distinguish wheel from mouse button. */
5955 last_mouse_button
= -1;
5956 last_mouse_x
= XINT (event
->x
);
5957 last_mouse_y
= XINT (event
->y
);
5963 if (event
->modifiers
& up_modifier
)
5965 /* Emit a wheel-up event. */
5966 event
->modifiers
&= ~up_modifier
;
5969 else if (event
->modifiers
& down_modifier
)
5971 /* Emit a wheel-down event. */
5972 event
->modifiers
&= ~down_modifier
;
5976 /* Every wheel event should either have the down_modifier or
5977 the up_modifier set. */
5980 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5983 /* Get the symbol we should use for the wheel event. */
5984 head
= modify_event_symbol (symbol_num
,
5990 ASIZE (wheel_syms
));
5993 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5996 Fcons (make_number (double_click_count
),
6005 #ifdef USE_TOOLKIT_SCROLL_BARS
6007 /* We don't have down and up events if using toolkit scroll bars,
6008 so make this always a click event. Store in the `part' of
6009 the Lisp event a symbol which maps to the following actions:
6011 `above_handle' page up
6012 `below_handle' page down
6016 `bottom' bottom of buffer
6017 `handle' thumb has been dragged.
6018 `end-scroll' end of interaction with scroll bar
6020 The incoming input_event contains in its `part' member an
6021 index of type `enum scroll_bar_part' which we can use as an
6022 index in scroll_bar_parts to get the appropriate symbol. */
6024 case SCROLL_BAR_CLICK_EVENT
:
6026 Lisp_Object position
, head
, window
, portion_whole
, part
;
6028 window
= event
->frame_or_window
;
6029 portion_whole
= Fcons (event
->x
, event
->y
);
6030 part
= *scroll_bar_parts
[(int) event
->part
];
6034 Fcons (Qvertical_scroll_bar
,
6035 Fcons (portion_whole
,
6036 Fcons (make_number (event
->timestamp
),
6037 Fcons (part
, Qnil
)))));
6039 /* Always treat scroll bar events as clicks. */
6040 event
->modifiers
|= click_modifier
;
6041 event
->modifiers
&= ~up_modifier
;
6043 if (event
->code
>= ASIZE (mouse_syms
))
6044 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
6046 /* Get the symbol we should use for the mouse click. */
6047 head
= modify_event_symbol (event
->code
,
6052 XVECTOR (mouse_syms
)->size
);
6053 return Fcons (head
, Fcons (position
, Qnil
));
6056 #endif /* USE_TOOLKIT_SCROLL_BARS */
6058 case DRAG_N_DROP_EVENT
:
6061 Lisp_Object head
, position
;
6064 f
= XFRAME (event
->frame_or_window
);
6067 /* Ignore mouse events that were made on frames that
6068 have been deleted. */
6069 if (! FRAME_LIVE_P (f
))
6072 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6075 head
= modify_event_symbol (0, event
->modifiers
,
6077 lispy_drag_n_drop_names
,
6078 &drag_n_drop_syms
, 1);
6084 #endif /* HAVE_MOUSE */
6086 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6087 || defined(HAVE_NS) || defined (USE_GTK)
6088 case MENU_BAR_EVENT
:
6089 if (EQ (event
->arg
, event
->frame_or_window
))
6090 /* This is the prefix key. We translate this to
6091 `(menu_bar)' because the code in keyboard.c for menu
6092 events, which we use, relies on this. */
6093 return Fcons (Qmenu_bar
, Qnil
);
6097 case SELECT_WINDOW_EVENT
:
6098 /* Make an event (select-window (WINDOW)). */
6099 return Fcons (Qselect_window
,
6100 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6103 case TOOL_BAR_EVENT
:
6104 if (EQ (event
->arg
, event
->frame_or_window
))
6105 /* This is the prefix key. We translate this to
6106 `(tool_bar)' because the code in keyboard.c for tool bar
6107 events, which we use, relies on this. */
6108 return Fcons (Qtool_bar
, Qnil
);
6109 else if (SYMBOLP (event
->arg
))
6110 return apply_modifiers (event
->modifiers
, event
->arg
);
6113 case USER_SIGNAL_EVENT
:
6114 /* A user signal. */
6116 char *name
= find_user_signal_name (event
->code
);
6119 return intern (name
);
6122 case SAVE_SESSION_EVENT
:
6123 return Qsave_session
;
6128 return Fcons (Qdbus_event
, event
->arg
);
6130 #endif /* HAVE_DBUS */
6133 case GPM_CLICK_EVENT
:
6135 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6136 Lisp_Object head
, position
;
6137 Lisp_Object
*start_pos_ptr
;
6138 Lisp_Object start_pos
;
6139 int button
= event
->code
;
6141 if (button
>= ASIZE (button_down_location
))
6143 button_down_location
= larger_vector (button_down_location
,
6145 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6148 start_pos_ptr
= &AREF (button_down_location
, button
);
6149 start_pos
= *start_pos_ptr
;
6151 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6154 if (event
->modifiers
& down_modifier
)
6155 *start_pos_ptr
= Fcopy_alist (position
);
6156 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6158 if (!CONSP (start_pos
))
6160 event
->modifiers
&= ~up_modifier
;
6163 head
= modify_event_symbol (button
,
6165 Qmouse_click
, Vlispy_mouse_stem
,
6168 XVECTOR (mouse_syms
)->size
);
6170 if (event
->modifiers
& drag_modifier
)
6175 else if (event
->modifiers
& double_modifier
)
6178 Fcons (make_number (2),
6180 else if (event
->modifiers
& triple_modifier
)
6183 Fcons (make_number (3),
6190 #endif /* HAVE_GPM */
6192 /* The 'kind' field of the event is something we don't recognize. */
6198 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6201 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
6203 Lisp_Object bar_window
;
6204 enum scroll_bar_part part
;
6208 /* Is it a scroll bar movement? */
6209 if (frame
&& ! NILP (bar_window
))
6211 Lisp_Object part_sym
;
6213 part_sym
= *scroll_bar_parts
[(int) part
];
6214 return Fcons (Qscroll_bar_movement
,
6215 (Fcons (Fcons (bar_window
,
6216 Fcons (Qvertical_scroll_bar
,
6217 Fcons (Fcons (x
, y
),
6218 Fcons (make_number (time
),
6224 /* Or is it an ordinary mouse movement? */
6227 Lisp_Object position
;
6229 position
= make_lispy_position (frame
, &x
, &y
, time
);
6231 return Fcons (Qmouse_movement
,
6237 #endif /* HAVE_MOUSE || HAVE GPM */
6239 /* Construct a switch frame event. */
6241 make_lispy_switch_frame (frame
)
6244 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6247 /* Manipulating modifiers. */
6249 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6251 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6252 SYMBOL's name of the end of the modifiers; the string from this
6253 position is the unmodified symbol name.
6255 This doesn't use any caches. */
6258 parse_modifiers_uncached (symbol
, modifier_end
)
6266 CHECK_SYMBOL (symbol
);
6269 name
= SYMBOL_NAME (symbol
);
6271 for (i
= 0; i
+2 <= SBYTES (name
); )
6273 int this_mod_end
= 0;
6276 /* See if the name continues with a modifier word.
6277 Check that the word appears, but don't check what follows it.
6278 Set this_mod and this_mod_end to record what we find. */
6280 switch (SREF (name
, i
))
6282 #define SINGLE_LETTER_MOD(BIT) \
6283 (this_mod_end = i + 1, this_mod = BIT)
6286 SINGLE_LETTER_MOD (alt_modifier
);
6290 SINGLE_LETTER_MOD (ctrl_modifier
);
6294 SINGLE_LETTER_MOD (hyper_modifier
);
6298 SINGLE_LETTER_MOD (meta_modifier
);
6302 SINGLE_LETTER_MOD (shift_modifier
);
6306 SINGLE_LETTER_MOD (super_modifier
);
6309 #undef SINGLE_LETTER_MOD
6311 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6312 if (i + LEN + 1 <= SBYTES (name) \
6313 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6315 this_mod_end = i + LEN; \
6320 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6321 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6322 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6326 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6328 #undef MULTI_LETTER_MOD
6332 /* If we found no modifier, stop looking for them. */
6333 if (this_mod_end
== 0)
6336 /* Check there is a dash after the modifier, so that it
6337 really is a modifier. */
6338 if (this_mod_end
>= SBYTES (name
)
6339 || SREF (name
, this_mod_end
) != '-')
6342 /* This modifier is real; look for another. */
6343 modifiers
|= this_mod
;
6344 i
= this_mod_end
+ 1;
6347 /* Should we include the `click' modifier? */
6348 if (! (modifiers
& (down_modifier
| drag_modifier
6349 | double_modifier
| triple_modifier
))
6350 && i
+ 7 == SBYTES (name
)
6351 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6352 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6353 modifiers
|= click_modifier
;
6361 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6362 prepended to the string BASE[0..BASE_LEN-1].
6363 This doesn't use any caches. */
6365 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6368 int base_len
, base_len_byte
;
6370 /* Since BASE could contain nulls, we can't use intern here; we have
6371 to use Fintern, which expects a genuine Lisp_String, and keeps a
6374 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6380 /* Only the event queue may use the `up' modifier; it should always
6381 be turned into a click or drag event before presented to lisp code. */
6382 if (modifiers
& up_modifier
)
6385 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6386 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6387 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6388 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6389 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6390 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6391 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6392 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6393 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6394 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6395 /* The click modifier is denoted by the absence of other modifiers. */
6399 mod_len
= p
- new_mods
;
6403 Lisp_Object new_name
;
6405 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6406 mod_len
+ base_len_byte
);
6407 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6408 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6410 return Fintern (new_name
, Qnil
);
6415 static char *modifier_names
[] =
6417 "up", "down", "drag", "click", "double", "triple", 0, 0,
6418 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6419 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6421 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6423 static Lisp_Object modifier_symbols
;
6425 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6427 lispy_modifier_list (modifiers
)
6430 Lisp_Object modifier_list
;
6433 modifier_list
= Qnil
;
6434 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6435 if (modifiers
& (1<<i
))
6436 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6439 return modifier_list
;
6443 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6444 where UNMODIFIED is the unmodified form of SYMBOL,
6445 MASK is the set of modifiers present in SYMBOL's name.
6446 This is similar to parse_modifiers_uncached, but uses the cache in
6447 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6448 Qevent_symbol_elements property. */
6450 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6453 parse_modifiers (symbol
)
6456 Lisp_Object elements
;
6458 if (INTEGERP (symbol
))
6459 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6460 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6462 else if (!SYMBOLP (symbol
))
6465 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6466 if (CONSP (elements
))
6471 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6472 Lisp_Object unmodified
;
6475 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6476 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6479 if (modifiers
& ~INTMASK
)
6481 XSETFASTINT (mask
, modifiers
);
6482 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6484 /* Cache the parsing results on SYMBOL. */
6485 Fput (symbol
, Qevent_symbol_element_mask
,
6487 Fput (symbol
, Qevent_symbol_elements
,
6488 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6490 /* Since we know that SYMBOL is modifiers applied to unmodified,
6491 it would be nice to put that in unmodified's cache.
6492 But we can't, since we're not sure that parse_modifiers is
6499 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6500 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6501 doc
: /* Parse the event symbol. For internal use. */)
6505 /* Fill the cache if needed. */
6506 parse_modifiers (symbol
);
6507 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6508 and use the Lispier representation stored on Qevent_symbol_elements
6510 return Fget (symbol
, Qevent_symbol_elements
);
6513 /* Apply the modifiers MODIFIERS to the symbol BASE.
6514 BASE must be unmodified.
6516 This is like apply_modifiers_uncached, but uses BASE's
6517 Qmodifier_cache property, if present. It also builds
6518 Qevent_symbol_elements properties, since it has that info anyway.
6520 apply_modifiers copies the value of BASE's Qevent_kind property to
6521 the modified symbol. */
6523 apply_modifiers (modifiers
, base
)
6527 Lisp_Object cache
, index
, entry
, new_symbol
;
6529 /* Mask out upper bits. We don't know where this value's been. */
6530 modifiers
&= INTMASK
;
6532 if (INTEGERP (base
))
6533 return make_number (XINT (base
) | modifiers
);
6535 /* The click modifier never figures into cache indices. */
6536 cache
= Fget (base
, Qmodifier_cache
);
6537 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6538 entry
= assq_no_quit (index
, cache
);
6541 new_symbol
= XCDR (entry
);
6544 /* We have to create the symbol ourselves. */
6545 new_symbol
= apply_modifiers_uncached (modifiers
,
6546 SDATA (SYMBOL_NAME (base
)),
6547 SCHARS (SYMBOL_NAME (base
)),
6548 SBYTES (SYMBOL_NAME (base
)));
6550 /* Add the new symbol to the base's cache. */
6551 entry
= Fcons (index
, new_symbol
);
6552 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6554 /* We have the parsing info now for free, so we could add it to
6556 XSETFASTINT (index, modifiers);
6557 Fput (new_symbol, Qevent_symbol_element_mask,
6558 Fcons (base, Fcons (index, Qnil)));
6559 Fput (new_symbol, Qevent_symbol_elements,
6560 Fcons (base, lispy_modifier_list (modifiers)));
6561 Sadly, this is only correct if `base' is indeed a base event,
6562 which is not necessarily the case. -stef */
6565 /* Make sure this symbol is of the same kind as BASE.
6567 You'd think we could just set this once and for all when we
6568 intern the symbol above, but reorder_modifiers may call us when
6569 BASE's property isn't set right; we can't assume that just
6570 because it has a Qmodifier_cache property it must have its
6571 Qevent_kind set right as well. */
6572 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6576 kind
= Fget (base
, Qevent_kind
);
6578 Fput (new_symbol
, Qevent_kind
, kind
);
6585 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6586 return a symbol with the modifiers placed in the canonical order.
6587 Canonical order is alphabetical, except for down and drag, which
6588 always come last. The 'click' modifier is never written out.
6590 Fdefine_key calls this to make sure that (for example) C-M-foo
6591 and M-C-foo end up being equivalent in the keymap. */
6594 reorder_modifiers (symbol
)
6597 /* It's hopefully okay to write the code this way, since everything
6598 will soon be in caches, and no consing will be done at all. */
6601 parsed
= parse_modifiers (symbol
);
6602 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6607 /* For handling events, we often want to produce a symbol whose name
6608 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6609 to some base, like the name of a function key or mouse button.
6610 modify_event_symbol produces symbols of this sort.
6612 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6613 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6616 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6617 into symbol names, or a string specifying a name stem used to
6618 construct a symbol name or the form `STEM-N', where N is the decimal
6619 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6620 non-nil; otherwise NAME_TABLE is used.
6622 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6623 persist between calls to modify_event_symbol that it can use to
6624 store a cache of the symbols it's generated for this NAME_TABLE
6625 before. The object stored there may be a vector or an alist.
6627 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6629 MODIFIERS is a set of modifier bits (as given in struct input_events)
6630 whose prefixes should be applied to the symbol name.
6632 SYMBOL_KIND is the value to be placed in the event_kind property of
6633 the returned symbol.
6635 The symbols we create are supposed to have an
6636 `event-symbol-elements' property, which lists the modifiers present
6637 in the symbol's name. */
6640 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6641 name_table
, symbol_table
, table_size
)
6644 Lisp_Object symbol_kind
;
6645 Lisp_Object name_alist_or_stem
;
6647 Lisp_Object
*symbol_table
;
6648 unsigned int table_size
;
6651 Lisp_Object symbol_int
;
6653 /* Get rid of the "vendor-specific" bit here. */
6654 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6656 /* Is this a request for a valid symbol? */
6657 if (symbol_num
< 0 || symbol_num
>= table_size
)
6660 if (CONSP (*symbol_table
))
6661 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6663 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6664 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6665 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6666 we've never used that symbol before. */
6669 if (! VECTORP (*symbol_table
)
6670 || XVECTOR (*symbol_table
)->size
!= table_size
)
6674 XSETFASTINT (size
, table_size
);
6675 *symbol_table
= Fmake_vector (size
, Qnil
);
6678 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6681 /* Have we already used this symbol before? */
6684 /* No; let's create it. */
6685 if (CONSP (name_alist_or_stem
))
6686 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6687 else if (STRINGP (name_alist_or_stem
))
6689 int len
= SBYTES (name_alist_or_stem
);
6690 char *buf
= (char *) alloca (len
+ 50);
6691 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6692 (long) XINT (symbol_int
) + 1);
6693 value
= intern (buf
);
6695 else if (name_table
!= 0 && name_table
[symbol_num
])
6696 value
= intern (name_table
[symbol_num
]);
6698 #ifdef HAVE_WINDOW_SYSTEM
6701 char *name
= x_get_keysym_name (symbol_num
);
6703 value
= intern (name
);
6710 sprintf (buf
, "key-%d", symbol_num
);
6711 value
= intern (buf
);
6714 if (CONSP (*symbol_table
))
6715 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6717 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6719 /* Fill in the cache entries for this symbol; this also
6720 builds the Qevent_symbol_elements property, which the user
6722 apply_modifiers (modifiers
& click_modifier
, value
);
6723 Fput (value
, Qevent_kind
, symbol_kind
);
6726 /* Apply modifiers to that symbol. */
6727 return apply_modifiers (modifiers
, value
);
6730 /* Convert a list that represents an event type,
6731 such as (ctrl meta backspace), into the usual representation of that
6732 event type as a number or a symbol. */
6734 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6735 doc
: /* Convert the event description list EVENT-DESC to an event type.
6736 EVENT-DESC should contain one base event type (a character or symbol)
6737 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6738 drag, down, double or triple). The base must be last.
6739 The return value is an event type (a character or symbol) which
6740 has the same base event type and all the specified modifiers. */)
6742 Lisp_Object event_desc
;
6750 while (CONSP (rest
))
6758 /* Given a symbol, see if it is a modifier name. */
6759 if (SYMBOLP (elt
) && CONSP (rest
))
6760 this = parse_solitary_modifier (elt
);
6764 else if (!NILP (base
))
6765 error ("Two bases given in one event");
6771 /* Let the symbol A refer to the character A. */
6772 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6773 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6775 if (INTEGERP (base
))
6777 /* Turn (shift a) into A. */
6778 if ((modifiers
& shift_modifier
) != 0
6779 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6781 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6782 modifiers
&= ~shift_modifier
;
6785 /* Turn (control a) into C-a. */
6786 if (modifiers
& ctrl_modifier
)
6787 return make_number ((modifiers
& ~ctrl_modifier
)
6788 | make_ctrl_char (XINT (base
)));
6790 return make_number (modifiers
| XINT (base
));
6792 else if (SYMBOLP (base
))
6793 return apply_modifiers (modifiers
, base
);
6796 error ("Invalid base event");
6801 /* Try to recognize SYMBOL as a modifier name.
6802 Return the modifier flag bit, or 0 if not recognized. */
6805 parse_solitary_modifier (Lisp_Object symbol
)
6807 Lisp_Object name
= SYMBOL_NAME (symbol
);
6809 switch (SREF (name
, 0))
6811 #define SINGLE_LETTER_MOD(BIT) \
6812 if (SBYTES (name) == 1) \
6815 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6816 if (LEN == SBYTES (name) \
6817 && ! strncmp (SDATA (name), NAME, LEN)) \
6821 SINGLE_LETTER_MOD (alt_modifier
);
6825 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6829 SINGLE_LETTER_MOD (ctrl_modifier
);
6833 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6834 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6838 SINGLE_LETTER_MOD (hyper_modifier
);
6842 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6846 SINGLE_LETTER_MOD (meta_modifier
);
6850 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6854 SINGLE_LETTER_MOD (shift_modifier
);
6858 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6859 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6860 SINGLE_LETTER_MOD (super_modifier
);
6864 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6865 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6866 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6870 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6873 #undef SINGLE_LETTER_MOD
6874 #undef MULTI_LETTER_MOD
6880 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6881 Such a list is not valid as an event,
6882 but it can be a Lucid-style event type list. */
6885 lucid_event_type_list_p (object
)
6890 if (! CONSP (object
))
6893 if (EQ (XCAR (object
), Qhelp_echo
)
6894 || EQ (XCAR (object
), Qvertical_line
)
6895 || EQ (XCAR (object
), Qmode_line
)
6896 || EQ (XCAR (object
), Qheader_line
))
6899 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6903 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6910 /* Store into *addr a value nonzero if terminal input chars are available.
6911 Serves the purpose of ioctl (0, FIONREAD, addr)
6912 but works even if FIONREAD does not exist.
6913 (In fact, this may actually read some input.)
6915 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6916 timer events that are ripe.
6917 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6918 events (FOCUS_IN_EVENT).
6919 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6920 movements and toolkit scroll bar thumb drags. */
6923 get_input_pending (addr
, flags
)
6927 /* First of all, have we already counted some input? */
6928 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6930 /* If input is being read as it arrives, and we have none, there is none. */
6931 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6934 /* Try to read some input and see how much we get. */
6936 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6939 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6942 gobble_input (expected
)
6946 /* Check whether a D-Bus message has arrived. */
6947 xd_read_queued_messages ();
6948 #endif /* HAVE_DBUS */
6952 if (interrupt_input
)
6955 mask
= sigblock (sigmask (SIGIO
));
6956 read_avail_input (expected
);
6960 #ifdef POLL_FOR_INPUT
6961 /* XXX This condition was (read_socket_hook && !interrupt_input),
6962 but read_socket_hook is not global anymore. Let's pretend that
6964 if (!interrupt_input
&& poll_suppress_count
== 0)
6967 mask
= sigblock (sigmask (SIGALRM
));
6968 read_avail_input (expected
);
6974 read_avail_input (expected
);
6978 /* Put a BUFFER_SWITCH_EVENT in the buffer
6979 so that read_key_sequence will notice the new current buffer. */
6982 record_asynch_buffer_change ()
6984 struct input_event event
;
6988 event
.kind
= BUFFER_SWITCH_EVENT
;
6989 event
.frame_or_window
= Qnil
;
6993 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6994 The purpose of the event is to make read_key_sequence look up the
6995 keymaps again. If we aren't in read_key_sequence, we don't need one,
6996 and the event could cause trouble by messing up (input-pending-p). */
6997 tem
= Fwaiting_for_user_input_p ();
7001 /* We never need these events if we have no asynchronous subprocesses. */
7005 /* Make sure no interrupt happens while storing the event. */
7007 if (interrupt_input
)
7010 mask
= sigblock (sigmask (SIGIO
));
7011 kbd_buffer_store_event (&event
);
7018 kbd_buffer_store_event (&event
);
7025 /* Read any terminal input already buffered up by the system
7026 into the kbd_buffer, but do not wait.
7028 EXPECTED should be nonzero if the caller knows there is some input.
7030 Except on VMS, all input is read by this function.
7031 If interrupt_input is nonzero, this function MUST be called
7032 only when SIGIO is blocked.
7034 Returns the number of keyboard chars read, or -1 meaning
7035 this is a bad time to try to read input. */
7038 read_avail_input (expected
)
7045 /* Store pending user signal events, if any. */
7046 if (store_user_signal_events ())
7049 /* Loop through the available terminals, and call their input hooks. */
7053 struct terminal
*next
= t
->next_terminal
;
7055 if (t
->read_socket_hook
)
7058 struct input_event hold_quit
;
7060 EVENT_INIT (hold_quit
);
7061 hold_quit
.kind
= NO_EVENT
;
7063 /* No need for FIONREAD or fcntl; just say don't wait. */
7064 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
7070 if (nr
== -1) /* Not OK to read input now. */
7074 else if (nr
== -2) /* Non-transient error. */
7076 /* The terminal device terminated; it should be closed. */
7078 /* Kill Emacs if this was our last terminal. */
7079 if (!terminal_list
->next_terminal
)
7080 /* Formerly simply reported no input, but that
7081 sometimes led to a failure of Emacs to terminate.
7082 SIGHUP seems appropriate if we can't reach the
7084 /* ??? Is it really right to send the signal just to
7085 this process rather than to the whole process
7086 group? Perhaps on systems with FIONREAD Emacs is
7087 alone in its group. */
7088 kill (getpid (), SIGHUP
);
7090 /* XXX Is calling delete_terminal safe here? It calls Fdelete_frame. */
7093 XSETTERMINAL (tmp
, t
);
7094 Fdelete_terminal (tmp
, Qnoelisp
);
7098 if (hold_quit
.kind
!= NO_EVENT
)
7099 kbd_buffer_store_event (&hold_quit
);
7111 /* This is the tty way of reading available input.
7113 Note that each terminal device has its own `struct terminal' object,
7114 and so this function is called once for each individual termcap
7115 terminal. The first parameter indicates which terminal to read from. */
7118 tty_read_avail_input (struct terminal
*terminal
,
7120 struct input_event
*hold_quit
)
7122 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7123 the kbd_buffer can really hold. That may prevent loss
7124 of characters on some systems when input is stuffed at us. */
7125 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7127 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7130 if (!terminal
->name
) /* Don't read from a dead terminal. */
7133 if (terminal
->type
!= output_termcap
)
7136 /* XXX I think the following code should be moved to separate hook
7137 functions in system-dependent files. */
7140 #else /* not WINDOWSNT */
7142 n_to_read
= dos_keysns ();
7146 cbuf
[0] = dos_keyread ();
7149 #else /* not MSDOS */
7151 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7155 return 0; /* The terminal is suspended. */
7161 struct input_event hold_quit
;
7164 EVENT_INIT (hold_quit
);
7165 hold_quit
.kind
= NO_EVENT
;
7167 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7168 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7170 if (hold_quit
.kind
!= NO_EVENT
)
7171 kbd_buffer_store_event (&hold_quit
);
7175 #endif /* HAVE_GPM */
7177 /* Determine how many characters we should *try* to read. */
7179 /* Find out how much input is available. */
7180 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7182 if (! noninteractive
)
7183 return -2; /* Close this terminal. */
7189 if (n_to_read
> sizeof cbuf
)
7190 n_to_read
= sizeof cbuf
;
7191 #else /* no FIONREAD */
7192 #if defined (USG) || defined(CYGWIN)
7193 /* Read some input if available, but don't wait. */
7194 n_to_read
= sizeof cbuf
;
7195 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7201 /* Now read; for one reason or another, this will not block.
7202 NREAD is set to the number of chars read. */
7205 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7206 /* POSIX infers that processes which are not in the session leader's
7207 process group won't get SIGHUP's at logout time. BSDI adheres to
7208 this part standard and returns -1 from read (0) with errno==EIO
7209 when the control tty is taken away.
7210 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7211 if (nread
== -1 && errno
== EIO
)
7212 return -2; /* Close this terminal. */
7213 #if defined (AIX) && defined (_BSD)
7214 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7215 This looks incorrect, but it isn't, because _BSD causes
7216 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7217 and that causes a value other than 0 when there is no input. */
7219 return -2; /* Close this terminal. */
7223 /* We used to retry the read if it was interrupted.
7224 But this does the wrong thing when O_NDELAY causes
7225 an EAGAIN error. Does anybody know of a situation
7226 where a retry is actually needed? */
7228 nread
< 0 && (errno
== EAGAIN
7242 #if defined (USG) || defined (CYGWIN)
7243 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7244 #endif /* USG or CYGWIN */
7245 #endif /* no FIONREAD */
7250 #endif /* not MSDOS */
7251 #endif /* not WINDOWSNT */
7253 for (i
= 0; i
< nread
; i
++)
7255 struct input_event buf
;
7257 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7259 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7260 buf
.modifiers
= meta_modifier
;
7261 if (tty
->meta_key
!= 2)
7265 /* Set the frame corresponding to the active tty. Note that the
7266 value of selected_frame is not reliable here, redisplay tends
7267 to temporarily change it. */
7268 buf
.frame_or_window
= tty
->top_frame
;
7271 kbd_buffer_store_event (&buf
);
7272 /* Don't look at input that follows a C-g too closely.
7273 This reduces lossage due to autorepeat on C-g. */
7274 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7275 && buf
.code
== quit_char
)
7281 #endif /* not VMS */
7284 handle_async_input ()
7286 interrupt_input_pending
= 0;
7291 nread
= read_avail_input (1);
7292 /* -1 means it's not ok to read the input now.
7293 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7294 0 means there was no keyboard input available. */
7300 #ifdef SIGIO /* for entire page */
7301 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7304 input_available_signal (signo
)
7307 /* Must preserve main program's value of errno. */
7308 int old_errno
= errno
;
7309 #if defined (USG) && !defined (POSIX_SIGNALS)
7310 /* USG systems forget handlers when they are used;
7311 must reestablish each time */
7312 signal (signo
, input_available_signal
);
7316 interrupt_input_pending
= 1;
7318 SIGNAL_THREAD_CHECK (signo
);
7321 if (input_available_clear_time
)
7322 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7325 handle_async_input ();
7332 /* Send ourselves a SIGIO.
7334 This function exists so that the UNBLOCK_INPUT macro in
7335 blockinput.h can have some way to take care of input we put off
7336 dealing with, without assuming that every file which uses
7337 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7339 reinvoke_input_signal ()
7342 handle_async_input ();
7348 /* User signal events. */
7350 struct user_signal_info
7352 /* Signal number. */
7355 /* Name of the signal. */
7358 /* Number of pending signals. */
7361 struct user_signal_info
*next
;
7364 /* List of user signals. */
7365 static struct user_signal_info
*user_signals
= NULL
;
7368 add_user_signal (sig
, name
)
7372 struct user_signal_info
*p
;
7374 for (p
= user_signals
; p
; p
= p
->next
)
7376 /* Already added. */
7379 p
= xmalloc (sizeof (struct user_signal_info
));
7381 p
->name
= xstrdup (name
);
7383 p
->next
= user_signals
;
7386 signal (sig
, handle_user_signal
);
7390 handle_user_signal (sig
)
7393 int old_errno
= errno
;
7394 struct user_signal_info
*p
;
7396 #if defined (USG) && !defined (POSIX_SIGNALS)
7397 /* USG systems forget handlers when they are used;
7398 must reestablish each time */
7399 signal (sig
, handle_user_signal
);
7402 SIGNAL_THREAD_CHECK (sig
);
7404 for (p
= user_signals
; p
; p
= p
->next
)
7409 if (interrupt_input
)
7410 kill (getpid (), SIGIO
);
7414 /* Tell wait_reading_process_output that it needs to wake
7415 up and look around. */
7416 if (input_available_clear_time
)
7417 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7426 find_user_signal_name (sig
)
7429 struct user_signal_info
*p
;
7431 for (p
= user_signals
; p
; p
= p
->next
)
7439 store_user_signal_events ()
7441 struct user_signal_info
*p
;
7442 struct input_event buf
;
7445 for (p
= user_signals
; p
; p
= p
->next
)
7446 if (p
->npending
> 0)
7452 bzero (&buf
, sizeof buf
);
7453 buf
.kind
= USER_SIGNAL_EVENT
;
7454 buf
.frame_or_window
= selected_frame
;
7456 nstored
+= p
->npending
;
7458 mask
= sigblock (sigmask (p
->sig
));
7462 kbd_buffer_store_event (&buf
);
7465 while (p
->npending
> 0);
7473 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7474 static Lisp_Object menu_bar_one_keymap_changed_items
;
7476 /* These variables hold the vector under construction within
7477 menu_bar_items and its subroutines, and the current index
7478 for storing into that vector. */
7479 static Lisp_Object menu_bar_items_vector
;
7480 static int menu_bar_items_index
;
7482 /* Return a vector of menu items for a menu bar, appropriate
7483 to the current buffer. Each item has three elements in the vector:
7486 OLD is an old vector we can optionally reuse, or nil. */
7489 menu_bar_items (old
)
7492 /* The number of keymaps we're scanning right now, and the number of
7493 keymaps we have allocated space for. */
7496 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7497 in the current keymaps, or nil where it is not a prefix. */
7500 Lisp_Object def
, tail
;
7509 /* In order to build the menus, we need to call the keymap
7510 accessors. They all call QUIT. But this function is called
7511 during redisplay, during which a quit is fatal. So inhibit
7512 quitting while building the menus.
7513 We do this instead of specbind because (1) errors will clear it anyway
7514 and (2) this avoids risk of specpdl overflow. */
7515 oquit
= Vinhibit_quit
;
7519 menu_bar_items_vector
= old
;
7521 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7522 menu_bar_items_index
= 0;
7524 /* Build our list of keymaps.
7525 If we recognize a function key and replace its escape sequence in
7526 keybuf with its symbol, or if the sequence starts with a mouse
7527 click and we need to switch buffers, we jump back here to rebuild
7528 the initial keymaps from the current buffer. */
7532 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7533 if (!NILP (Voverriding_local_map_menu_flag
))
7535 /* Yes, use them (if non-nil) as well as the global map. */
7536 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7538 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7539 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7540 if (!NILP (Voverriding_local_map
))
7541 maps
[nmaps
++] = Voverriding_local_map
;
7545 /* No, so use major and minor mode keymaps and keymap property.
7546 Note that menu-bar bindings in the local-map and keymap
7547 properties may not work reliable, as they are only
7548 recognized when the menu-bar (or mode-line) is updated,
7549 which does not normally happen after every command. */
7552 nminor
= current_minor_maps (NULL
, &tmaps
);
7553 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7555 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7556 maps
[nmaps
++] = tem
;
7557 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7559 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7561 maps
[nmaps
++] = current_global_map
;
7564 /* Look up in each map the dummy prefix key `menu-bar'. */
7568 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7569 if (!NILP (maps
[mapno
]))
7571 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7575 menu_bar_one_keymap_changed_items
= Qnil
;
7576 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7580 /* Move to the end those items that should be at the end. */
7582 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7585 int end
= menu_bar_items_index
;
7587 for (i
= 0; i
< end
; i
+= 4)
7588 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7590 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7591 /* Move the item at index I to the end,
7592 shifting all the others forward. */
7593 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7594 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7595 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7596 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7598 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7599 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7600 (end
- i
- 4) * sizeof (Lisp_Object
));
7601 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7602 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7603 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7604 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7609 /* Add nil, nil, nil, nil at the end. */
7610 i
= menu_bar_items_index
;
7611 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7612 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7613 /* Add this item. */
7614 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7615 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7616 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7617 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7618 menu_bar_items_index
= i
;
7620 Vinhibit_quit
= oquit
;
7621 return menu_bar_items_vector
;
7624 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7625 If there's already an item for KEY, add this DEF to it. */
7627 Lisp_Object item_properties
;
7630 menu_bar_item (key
, item
, dummy1
, dummy2
)
7631 Lisp_Object key
, item
, dummy1
;
7634 struct gcpro gcpro1
;
7638 if (EQ (item
, Qundefined
))
7640 /* If a map has an explicit `undefined' as definition,
7641 discard any previously made menu bar item. */
7643 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7644 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7646 if (menu_bar_items_index
> i
+ 4)
7647 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7648 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7649 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7650 menu_bar_items_index
-= 4;
7654 /* If this keymap has already contributed to this KEY,
7655 don't contribute to it a second time. */
7656 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7657 if (!NILP (tem
) || NILP (item
))
7660 menu_bar_one_keymap_changed_items
7661 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7663 /* We add to menu_bar_one_keymap_changed_items before doing the
7664 parse_menu_item, so that if it turns out it wasn't a menu item,
7665 it still correctly hides any further menu item. */
7667 i
= parse_menu_item (item
, 0, 1);
7672 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7674 /* Find any existing item for this KEY. */
7675 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7676 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7679 /* If we did not find this KEY, add it at the end. */
7680 if (i
== menu_bar_items_index
)
7682 /* If vector is too small, get a bigger one. */
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
++] = key
;
7687 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7688 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7689 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7690 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7691 menu_bar_items_index
= i
;
7693 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7697 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7698 /* If the new and the old items are not both keymaps,
7699 the lookup will only find `item'. */
7700 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7701 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7705 /* This is used as the handler when calling menu_item_eval_property. */
7707 menu_item_eval_property_1 (arg
)
7710 /* If we got a quit from within the menu computation,
7711 quit all the way out of it. This takes care of C-] in the debugger. */
7712 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7713 Fsignal (Qquit
, Qnil
);
7718 /* Evaluate an expression and return the result (or nil if something
7719 went wrong). Used to evaluate dynamic parts of menu items. */
7721 menu_item_eval_property (sexpr
)
7724 int count
= SPECPDL_INDEX ();
7726 specbind (Qinhibit_redisplay
, Qt
);
7727 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7728 menu_item_eval_property_1
);
7729 return unbind_to (count
, val
);
7732 /* This function parses a menu item and leaves the result in the
7733 vector item_properties.
7734 ITEM is a key binding, a possible menu item.
7735 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7736 evaluate dynamic expressions in the menu item.
7737 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7739 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7740 parse_menu_item returns true if the item is a menu item and false
7744 parse_menu_item (item
, notreal
, inmenubar
)
7746 int notreal
, inmenubar
;
7748 Lisp_Object def
, tem
, item_string
, start
;
7749 Lisp_Object cachelist
;
7751 Lisp_Object keyhint
;
7762 /* Create item_properties vector if necessary. */
7763 if (NILP (item_properties
))
7765 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7767 /* Initialize optional entries. */
7768 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7769 ASET (item_properties
, i
, Qnil
);
7770 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7772 /* Save the item here to protect it from GC. */
7773 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7775 item_string
= XCAR (item
);
7779 if (STRINGP (item_string
))
7781 /* Old format menu item. */
7782 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7784 /* Maybe help string. */
7785 if (CONSP (item
) && STRINGP (XCAR (item
)))
7787 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7792 /* Maybe key binding cache. */
7793 if (CONSP (item
) && CONSP (XCAR (item
))
7794 && (NILP (XCAR (XCAR (item
)))
7795 || VECTORP (XCAR (XCAR (item
)))))
7797 cachelist
= XCAR (item
);
7801 /* This is the real definition--the function to run. */
7802 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7804 /* Get enable property, if any. */
7807 tem
= Fget (item
, Qmenu_enable
);
7808 if (!NILP (Venable_disabled_menus_and_buttons
))
7809 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7810 else if (!NILP (tem
))
7811 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7814 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7816 /* New format menu item. */
7817 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7818 start
= XCDR (item
);
7821 /* We have a real binding. */
7822 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7824 item
= XCDR (start
);
7825 /* Is there a cache list with key equivalences. */
7826 if (CONSP (item
) && CONSP (XCAR (item
)))
7828 cachelist
= XCAR (item
);
7832 /* Parse properties. */
7833 while (CONSP (item
) && CONSP (XCDR (item
)))
7838 if (EQ (tem
, QCenable
))
7840 if (!NILP (Venable_disabled_menus_and_buttons
))
7841 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7843 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7845 else if (EQ (tem
, QCvisible
) && !notreal
)
7847 /* If got a visible property and that evaluates to nil
7848 then ignore this item. */
7849 tem
= menu_item_eval_property (XCAR (item
));
7853 else if (EQ (tem
, QChelp
))
7854 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7855 else if (EQ (tem
, QCfilter
))
7857 else if (EQ (tem
, QCkey_sequence
))
7860 if (NILP (cachelist
)
7861 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7862 /* Be GC protected. Set keyhint to item instead of tem. */
7865 else if (EQ (tem
, QCkeys
))
7868 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7869 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7871 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7876 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7878 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7880 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7886 else if (inmenubar
|| !NILP (start
))
7890 return 0; /* not a menu item */
7892 /* If item string is not a string, evaluate it to get string.
7893 If we don't get a string, skip this item. */
7894 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7895 if (!(STRINGP (item_string
) || notreal
))
7897 item_string
= menu_item_eval_property (item_string
);
7898 if (!STRINGP (item_string
))
7900 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7903 /* If got a filter apply it on definition. */
7904 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7907 def
= menu_item_eval_property (list2 (XCAR (filter
),
7908 list2 (Qquote
, def
)));
7910 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7913 /* Enable or disable selection of item. */
7914 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7920 tem
= menu_item_eval_property (tem
);
7921 if (inmenubar
&& NILP (tem
))
7922 return 0; /* Ignore disabled items in menu bar. */
7923 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7926 /* If we got no definition, this item is just unselectable text which
7927 is OK in a submenu but not in the menubar. */
7929 return (inmenubar
? 0 : 1);
7931 /* See if this is a separate pane or a submenu. */
7932 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7933 tem
= get_keymap (def
, 0, 1);
7934 /* For a subkeymap, just record its details and exit. */
7937 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7938 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7942 /* At the top level in the menu bar, do likewise for commands also.
7943 The menu bar does not display equivalent key bindings anyway.
7944 ITEM_PROPERTY_DEF is already set up properly. */
7948 /* This is a command. See if there is an equivalent key binding. */
7949 if (NILP (cachelist
))
7951 /* We have to create a cachelist. */
7952 /* With the introduction of where_is_cache, the computation
7953 of equivalent key bindings is sufficiently fast that we
7954 do not need to cache it here any more. */
7955 /* CHECK_IMPURE (start);
7956 XSETCDR (start, Fcons (Fcons (Qnil, Qnil), XCDR (start)));
7957 cachelist = XCAR (XCDR (start)); */
7958 cachelist
= Fcons (Qnil
, Qnil
);
7960 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7961 if (!NILP (keyhint
))
7963 XSETCAR (cachelist
, XCAR (keyhint
));
7966 else if (STRINGP (tem
))
7968 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7969 XSETCAR (cachelist
, Qt
);
7973 tem
= XCAR (cachelist
);
7980 tem
= Fkey_binding (tem
, Qnil
, Qnil
, Qnil
);
7982 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7985 def
= XCAR (prefix
);
7986 prefix
= XCDR (prefix
);
7989 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7991 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7993 if (newcache
/* Always check first time. */
7994 /* Should we check everything when precomputing key
7996 /* If something had no key binding before, don't recheck it
7997 because that is too slow--except if we have a list of
7998 rebound commands in Vdefine_key_rebound_commands, do
7999 recheck any command that appears in that list. */
8000 || (CONSP (Vdefine_key_rebound_commands
)
8001 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
8004 /* We had a saved key. Is it still bound to the command? */
8007 /* If the command is an alias for another
8008 (such as lmenu.el set it up), check if the
8009 original command matches the cached command. */
8010 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
8011 chkcache
= 1; /* Need to recompute key binding. */
8015 /* Recompute equivalent key binding. If the command is an alias
8016 for another (such as lmenu.el set it up), see if the original
8017 command name has equivalent keys. Otherwise look up the
8018 specified command itself. We don't try both, because that
8019 makes lmenu menus slow. */
8021 && SYMBOLP (XSYMBOL (def
)->function
)
8022 && ! NILP (Fget (def
, Qmenu_alias
)))
8023 def
= XSYMBOL (def
)->function
;
8024 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
8025 XSETCAR (cachelist
, tem
);
8028 XSETCDR (cachelist
, Qnil
);
8032 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
8034 tem
= XCAR (cachelist
);
8038 newcache
= chkcache
;
8041 tem
= Fkey_description (tem
, Qnil
);
8044 if (STRINGP (XCAR (prefix
)))
8045 tem
= concat2 (XCAR (prefix
), tem
);
8046 if (STRINGP (XCDR (prefix
)))
8047 tem
= concat2 (tem
, XCDR (prefix
));
8049 XSETCDR (cachelist
, tem
);
8053 tem
= XCDR (cachelist
);
8054 if (newcache
&& !NILP (tem
))
8056 tem
= concat2 (build_string (" "), tem
);
8057 /* tem = concat3 (build_string (" ("), tem, build_string (")")); */
8058 XSETCDR (cachelist
, tem
);
8061 /* If we only want to precompute equivalent key bindings, stop here. */
8065 /* If we have an equivalent key binding, use that. */
8066 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
8068 /* Include this when menu help is implemented.
8069 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
8070 if (!(NILP (tem) || STRINGP (tem)))
8072 tem = menu_item_eval_property (tem);
8075 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8079 /* Handle radio buttons or toggle boxes. */
8080 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8082 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8083 menu_item_eval_property (tem
));
8090 /***********************************************************************
8092 ***********************************************************************/
8094 /* A vector holding tool bar items while they are parsed in function
8095 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8098 static Lisp_Object tool_bar_items_vector
;
8100 /* A vector holding the result of parse_tool_bar_item. Layout is like
8101 the one for a single item in tool_bar_items_vector. */
8103 static Lisp_Object tool_bar_item_properties
;
8105 /* Next free index in tool_bar_items_vector. */
8107 static int ntool_bar_items
;
8109 /* The symbols `tool-bar', `:image' and `:rtl'. */
8111 extern Lisp_Object Qtool_bar
;
8112 Lisp_Object QCimage
;
8115 /* Function prototypes. */
8117 static void init_tool_bar_items
P_ ((Lisp_Object
));
8118 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
8119 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
8120 static void append_tool_bar_item
P_ ((void));
8123 /* Return a vector of tool bar items for keymaps currently in effect.
8124 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8125 tool bar items found. */
8128 tool_bar_items (reuse
, nitems
)
8139 /* In order to build the menus, we need to call the keymap
8140 accessors. They all call QUIT. But this function is called
8141 during redisplay, during which a quit is fatal. So inhibit
8142 quitting while building the menus. We do this instead of
8143 specbind because (1) errors will clear it anyway and (2) this
8144 avoids risk of specpdl overflow. */
8145 oquit
= Vinhibit_quit
;
8148 /* Initialize tool_bar_items_vector and protect it from GC. */
8149 init_tool_bar_items (reuse
);
8151 /* Build list of keymaps in maps. Set nmaps to the number of maps
8154 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8155 if (!NILP (Voverriding_local_map_menu_flag
))
8157 /* Yes, use them (if non-nil) as well as the global map. */
8158 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8160 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8161 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8162 if (!NILP (Voverriding_local_map
))
8163 maps
[nmaps
++] = Voverriding_local_map
;
8167 /* No, so use major and minor mode keymaps and keymap property.
8168 Note that tool-bar bindings in the local-map and keymap
8169 properties may not work reliable, as they are only
8170 recognized when the tool-bar (or mode-line) is updated,
8171 which does not normally happen after every command. */
8174 nminor
= current_minor_maps (NULL
, &tmaps
);
8175 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8177 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8178 maps
[nmaps
++] = tem
;
8179 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
8181 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8184 /* Add global keymap at the end. */
8185 maps
[nmaps
++] = current_global_map
;
8187 /* Process maps in reverse order and look up in each map the prefix
8189 for (i
= nmaps
- 1; i
>= 0; --i
)
8190 if (!NILP (maps
[i
]))
8194 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8196 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8199 Vinhibit_quit
= oquit
;
8200 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8201 return tool_bar_items_vector
;
8205 /* Process the definition of KEY which is DEF. */
8208 process_tool_bar_item (key
, def
, data
, args
)
8209 Lisp_Object key
, def
, data
;
8213 extern Lisp_Object Qundefined
;
8214 struct gcpro gcpro1
, gcpro2
;
8216 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8220 if (EQ (def
, Qundefined
))
8222 /* If a map has an explicit `undefined' as definition,
8223 discard any previously made item. */
8224 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8226 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8228 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8230 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8231 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
8232 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8233 * sizeof (Lisp_Object
)));
8234 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8239 else if (parse_tool_bar_item (key
, def
))
8240 /* Append a new tool bar item to tool_bar_items_vector. Accept
8241 more than one definition for the same key. */
8242 append_tool_bar_item ();
8248 /* Parse a tool bar item specification ITEM for key KEY and return the
8249 result in tool_bar_item_properties. Value is zero if ITEM is
8252 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8254 CAPTION is the caption of the item, If it's not a string, it is
8255 evaluated to get a string.
8257 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8258 as binding are currently ignored.
8260 The following properties are recognized:
8264 FORM is evaluated and specifies whether the tool bar item is
8265 enabled or disabled.
8269 FORM is evaluated and specifies whether the tool bar item is visible.
8271 - `:filter FUNCTION'
8273 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8274 result is stored as the new binding.
8276 - `:button (TYPE SELECTED)'
8278 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8279 and specifies whether the button is selected (pressed) or not.
8283 IMAGES is either a single image specification or a vector of four
8284 image specifications. See enum tool_bar_item_images.
8286 - `:help HELP-STRING'.
8288 Gives a help string to display for the tool bar item. */
8291 parse_tool_bar_item (key
, item
)
8292 Lisp_Object key
, item
;
8294 /* Access slot with index IDX of vector tool_bar_item_properties. */
8295 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8297 Lisp_Object filter
= Qnil
;
8298 Lisp_Object caption
;
8301 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8302 Rule out items that aren't lists, don't start with
8303 `menu-item' or whose rest following `tool-bar-item' is not a
8306 || !EQ (XCAR (item
), Qmenu_item
)
8307 || (item
= XCDR (item
),
8311 /* Create tool_bar_item_properties vector if necessary. Reset it to
8313 if (VECTORP (tool_bar_item_properties
))
8315 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8319 tool_bar_item_properties
8320 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8323 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8324 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8326 /* Get the caption of the item. If the caption is not a string,
8327 evaluate it to get a string. If we don't get a string, skip this
8329 caption
= XCAR (item
);
8330 if (!STRINGP (caption
))
8332 caption
= menu_item_eval_property (caption
);
8333 if (!STRINGP (caption
))
8336 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8338 /* Give up if rest following the caption is not a list. */
8343 /* Store the binding. */
8344 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8347 /* Ignore cached key binding, if any. */
8348 if (CONSP (item
) && CONSP (XCAR (item
)))
8351 /* Process the rest of the properties. */
8352 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8354 Lisp_Object key
, value
;
8357 value
= XCAR (XCDR (item
));
8359 if (EQ (key
, QCenable
))
8361 /* `:enable FORM'. */
8362 if (!NILP (Venable_disabled_menus_and_buttons
))
8363 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8365 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8367 else if (EQ (key
, QCvisible
))
8369 /* `:visible FORM'. If got a visible property and that
8370 evaluates to nil then ignore this item. */
8371 if (NILP (menu_item_eval_property (value
)))
8374 else if (EQ (key
, QChelp
))
8375 /* `:help HELP-STRING'. */
8376 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8377 else if (EQ (key
, QCfilter
))
8378 /* ':filter FORM'. */
8380 else if (EQ (key
, QCbutton
) && CONSP (value
))
8382 /* `:button (TYPE . SELECTED)'. */
8383 Lisp_Object type
, selected
;
8385 type
= XCAR (value
);
8386 selected
= XCDR (value
);
8387 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8389 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8390 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8393 else if (EQ (key
, QCimage
)
8395 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8396 /* Value is either a single image specification or a vector
8397 of 4 such specifications for the different button states. */
8398 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8399 else if (EQ (key
, Qrtl
))
8401 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8404 /* If got a filter apply it on binding. */
8406 PROP (TOOL_BAR_ITEM_BINDING
)
8407 = menu_item_eval_property (list2 (filter
,
8409 PROP (TOOL_BAR_ITEM_BINDING
))));
8411 /* See if the binding is a keymap. Give up if it is. */
8412 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8415 /* Enable or disable selection of item. */
8416 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8417 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8418 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8420 /* Handle radio buttons or toggle boxes. */
8421 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8422 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8423 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8431 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8432 that can be reused. */
8435 init_tool_bar_items (reuse
)
8438 if (VECTORP (reuse
))
8439 tool_bar_items_vector
= reuse
;
8441 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8442 ntool_bar_items
= 0;
8446 /* Append parsed tool bar item properties from
8447 tool_bar_item_properties */
8450 append_tool_bar_item ()
8452 Lisp_Object
*to
, *from
;
8454 /* Enlarge tool_bar_items_vector if necessary. */
8455 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8456 >= XVECTOR (tool_bar_items_vector
)->size
)
8457 tool_bar_items_vector
8458 = larger_vector (tool_bar_items_vector
,
8459 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8461 /* Append entries from tool_bar_item_properties to the end of
8462 tool_bar_items_vector. */
8463 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8464 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8465 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8466 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8473 /* Read a character using menus based on maps in the array MAPS.
8474 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8475 Return t if we displayed a menu but the user rejected it.
8477 PREV_EVENT is the previous input event, or nil if we are reading
8478 the first event of a key sequence.
8480 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8481 if we used a mouse menu to read the input, or zero otherwise. If
8482 USED_MOUSE_MENU is null, we don't dereference it.
8484 The prompting is done based on the prompt-string of the map
8485 and the strings associated with various map elements.
8487 This can be done with X menus or with menus put in the minibuf.
8488 These are done in different ways, depending on how the input will be read.
8489 Menus using X are done after auto-saving in read-char, getting the input
8490 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8491 and do auto-saving in the inner call of read_char. */
8494 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8497 Lisp_Object prev_event
;
8498 int *used_mouse_menu
;
8501 register Lisp_Object name
= Qnil
;
8503 if (used_mouse_menu
)
8504 *used_mouse_menu
= 0;
8506 /* Use local over global Menu maps */
8508 if (! menu_prompting
)
8511 /* Optionally disregard all but the global map. */
8512 if (inhibit_local_menu_bar_menus
)
8514 maps
+= (nmaps
- 1);
8518 /* Get the menu name from the first map that has one (a prompt string). */
8519 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8521 name
= Fkeymap_prompt (maps
[mapno
]);
8526 /* If we don't have any menus, just read a character normally. */
8527 if (!STRINGP (name
))
8531 /* If we got to this point via a mouse click,
8532 use a real menu for mouse selection. */
8533 if (EVENT_HAS_PARAMETERS (prev_event
)
8534 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8535 && !EQ (XCAR (prev_event
), Qtool_bar
))
8537 /* Display the menu and get the selection. */
8538 Lisp_Object
*realmaps
8539 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8543 /* Use the maps that are not nil. */
8544 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8545 if (!NILP (maps
[mapno
]))
8546 realmaps
[nmaps1
++] = maps
[mapno
];
8548 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8553 record_menu_key (XCAR (value
));
8555 /* If we got multiple events, unread all but
8557 There is no way to prevent those unread events
8558 from showing up later in last_nonmenu_event.
8559 So turn symbol and integer events into lists,
8560 to indicate that they came from a mouse menu,
8561 so that when present in last_nonmenu_event
8562 they won't confuse things. */
8563 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8565 record_menu_key (XCAR (tem
));
8566 if (SYMBOLP (XCAR (tem
))
8567 || INTEGERP (XCAR (tem
)))
8568 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8571 /* If we got more than one event, put all but the first
8572 onto this list to be read later.
8573 Return just the first event now. */
8574 Vunread_command_events
8575 = nconc2 (XCDR (value
), Vunread_command_events
);
8576 value
= XCAR (value
);
8578 else if (NILP (value
))
8580 if (used_mouse_menu
)
8581 *used_mouse_menu
= 1;
8584 #endif /* HAVE_MENUS */
8588 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8589 We make this bigger when necessary, and never free it. */
8590 static char *read_char_minibuf_menu_text
;
8591 /* Size of that buffer. */
8592 static int read_char_minibuf_menu_width
;
8595 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8601 register Lisp_Object name
;
8603 /* FIXME: Use the minibuffer's frame width. */
8604 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8607 Lisp_Object rest
, vector
;
8613 if (! menu_prompting
)
8616 /* Make sure we have a big enough buffer for the menu text. */
8617 if (read_char_minibuf_menu_text
== 0)
8619 read_char_minibuf_menu_width
= width
+ 4;
8620 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8622 else if (width
+ 4 > read_char_minibuf_menu_width
)
8624 read_char_minibuf_menu_width
= width
+ 4;
8625 read_char_minibuf_menu_text
8626 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8628 menu
= read_char_minibuf_menu_text
;
8630 /* Get the menu name from the first map that has one (a prompt string). */
8631 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8633 name
= Fkeymap_prompt (maps
[mapno
]);
8638 /* If we don't have any menus, just read a character normally. */
8639 if (!STRINGP (name
))
8642 /* Prompt string always starts with map's prompt, and a space. */
8643 strcpy (menu
, SDATA (name
));
8644 nlength
= SBYTES (name
);
8645 menu
[nlength
++] = ':';
8646 menu
[nlength
++] = ' ';
8649 /* Start prompting at start of first map. */
8653 /* Present the documented bindings, a line at a time. */
8660 Lisp_Object orig_defn_macro
;
8662 /* Loop over elements of map. */
8667 /* If reached end of map, start at beginning of next map. */
8671 /* At end of last map, wrap around to first map if just starting,
8672 or end this line if already have something on it. */
8676 if (notfirst
|| nobindings
) break;
8681 /* Look at the next element of the map. */
8683 elt
= XVECTOR (vector
)->contents
[idx
];
8685 elt
= Fcar_safe (rest
);
8687 if (idx
< 0 && VECTORP (elt
))
8689 /* If we found a dense table in the keymap,
8690 advanced past it, but start scanning its contents. */
8691 rest
= Fcdr_safe (rest
);
8697 /* An ordinary element. */
8698 Lisp_Object event
, tem
;
8702 event
= Fcar_safe (elt
); /* alist */
8703 elt
= Fcdr_safe (elt
);
8707 XSETINT (event
, idx
); /* vector */
8710 /* Ignore the element if it has no prompt string. */
8711 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8713 /* 1 if the char to type matches the string. */
8715 Lisp_Object upcased_event
, downcased_event
;
8716 Lisp_Object desc
= Qnil
;
8718 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8720 upcased_event
= Fupcase (event
);
8721 downcased_event
= Fdowncase (event
);
8722 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8723 || XINT (downcased_event
) == SREF (s
, 0));
8725 desc
= Fsingle_key_description (event
, Qnil
);
8727 #if 0 /* It is redundant to list the equivalent key bindings because
8728 the prefix is what the user has already typed. */
8730 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8732 /* Insert equivalent keybinding. */
8733 s
= concat2 (s
, tem
);
8736 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8737 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8739 /* Insert button prefix. */
8740 Lisp_Object selected
8741 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8742 if (EQ (tem
, QCradio
))
8743 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8745 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8746 s
= concat2 (tem
, s
);
8750 /* If we have room for the prompt string, add it to this line.
8751 If this is the first on the line, always add it. */
8752 if ((SCHARS (s
) + i
+ 2
8753 + (char_matches
? 0 : SCHARS (desc
) + 3))
8759 /* Punctuate between strings. */
8762 strcpy (menu
+ i
, ", ");
8768 /* If the char to type doesn't match the string's
8769 first char, explicitly show what char to type. */
8772 /* Add as much of string as fits. */
8773 thiswidth
= SCHARS (desc
);
8774 if (thiswidth
+ i
> width
)
8775 thiswidth
= width
- i
;
8776 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8778 strcpy (menu
+ i
, " = ");
8782 /* Add as much of string as fits. */
8783 thiswidth
= SCHARS (s
);
8784 if (thiswidth
+ i
> width
)
8785 thiswidth
= width
- i
;
8786 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8792 /* If this element does not fit, end the line now,
8793 and save the element for the next line. */
8794 strcpy (menu
+ i
, "...");
8799 /* Move past this element. */
8800 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8801 /* Handle reaching end of dense table. */
8806 rest
= Fcdr_safe (rest
);
8810 /* Prompt with that and read response. */
8811 message2_nolog (menu
, strlen (menu
),
8812 ! NILP (current_buffer
->enable_multibyte_characters
));
8814 /* Make believe its not a keyboard macro in case the help char
8815 is pressed. Help characters are not recorded because menu prompting
8816 is not used on replay.
8818 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8819 current_kboard
->defining_kbd_macro
= Qnil
;
8821 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8822 while (BUFFERP (obj
));
8823 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8825 if (!INTEGERP (obj
))
8827 else if (XINT (obj
) == -2)
8832 if (! EQ (obj
, menu_prompt_more_char
)
8833 && (!INTEGERP (menu_prompt_more_char
)
8834 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8836 if (!NILP (current_kboard
->defining_kbd_macro
))
8837 store_kbd_macro_char (obj
);
8840 /* Help char - go round again */
8844 /* Reading key sequences. */
8846 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8847 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8848 keymap, or nil otherwise. Return the index of the first keymap in
8849 which KEY has any binding, or NMAPS if no map has a binding.
8851 If KEY is a meta ASCII character, treat it like meta-prefix-char
8852 followed by the corresponding non-meta character. Keymaps in
8853 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8856 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8859 NEXT may be the same array as CURRENT. */
8862 follow_key (key
, nmaps
, current
, defs
, next
)
8864 Lisp_Object
*current
, *defs
, *next
;
8867 int i
, first_binding
;
8869 first_binding
= nmaps
;
8870 for (i
= nmaps
- 1; i
>= 0; i
--)
8872 if (! NILP (current
[i
]))
8874 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8875 if (! NILP (defs
[i
]))
8882 /* Given the set of bindings we've found, produce the next set of maps. */
8883 if (first_binding
< nmaps
)
8884 for (i
= 0; i
< nmaps
; i
++)
8885 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8887 return first_binding
;
8890 /* Structure used to keep track of partial application of key remapping
8891 such as Vfunction_key_map and Vkey_translation_map. */
8892 typedef struct keyremap
8894 /* This is the map originally specified for this use. */
8896 /* This is a submap reached by looking up, in PARENT,
8897 the events from START to END. */
8899 /* Positions [START, END) in the key sequence buffer
8900 are the key that we have scanned so far.
8901 Those events are the ones that we will replace
8902 if PAREHT maps them into a key sequence. */
8906 /* Lookup KEY in MAP.
8907 MAP is a keymap mapping keys to key vectors or functions.
8908 If the mapping is a function and DO_FUNCTION is non-zero, then
8909 the function is called with PROMPT as parameter and its return
8910 value is used as the return value of this function (after checking
8911 that it is indeed a vector). */
8914 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8915 Lisp_Object map
, key
, prompt
;
8920 next
= access_keymap (map
, key
, 1, 0, 1);
8922 /* Handle symbol with autoload definition. */
8923 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8924 && CONSP (XSYMBOL (next
)->function
)
8925 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8926 do_autoload (XSYMBOL (next
)->function
, next
);
8928 /* Handle a symbol whose function definition is a keymap
8930 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8931 && (ARRAYP (XSYMBOL (next
)->function
)
8932 || KEYMAPP (XSYMBOL (next
)->function
)))
8933 next
= XSYMBOL (next
)->function
;
8935 /* If the keymap gives a function, not an
8936 array, then call the function with one arg and use
8937 its value instead. */
8938 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8943 next
= call1 (next
, prompt
);
8944 /* If the function returned something invalid,
8945 barf--don't ignore it.
8946 (To ignore it safely, we would need to gcpro a bunch of
8947 other variables.) */
8948 if (! (VECTORP (next
) || STRINGP (next
)))
8949 error ("Function %s returns invalid key sequence", tem
);
8954 /* Do one step of the key remapping used for function-key-map and
8955 key-translation-map:
8956 KEYBUF is the buffer holding the input events.
8957 BUFSIZE is its maximum size.
8958 FKEY is a pointer to the keyremap structure to use.
8959 INPUT is the index of the last element in KEYBUF.
8960 DOIT if non-zero says that the remapping can actually take place.
8961 DIFF is used to return the number of keys added/removed by the remapping.
8962 PARENT is the root of the keymap.
8963 PROMPT is the prompt to use if the remapping happens through a function.
8964 The return value is non-zero if the remapping actually took place. */
8967 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8968 Lisp_Object
*keybuf
, prompt
;
8970 int input
, doit
, *diff
, bufsize
;
8972 Lisp_Object next
, key
;
8974 key
= keybuf
[fkey
->end
++];
8976 if (KEYMAPP (fkey
->parent
))
8977 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8981 /* If keybuf[fkey->start..fkey->end] is bound in the
8982 map and we're in a position to do the key remapping, replace it with
8983 the binding and restart with fkey->start at the end. */
8984 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8986 int len
= XFASTINT (Flength (next
));
8989 *diff
= len
- (fkey
->end
- fkey
->start
);
8991 if (input
+ *diff
>= bufsize
)
8992 error ("Key sequence too long");
8994 /* Shift the keys that follow fkey->end. */
8996 for (i
= fkey
->end
; i
< input
; i
++)
8997 keybuf
[i
+ *diff
] = keybuf
[i
];
8999 for (i
= input
- 1; i
>= fkey
->end
; i
--)
9000 keybuf
[i
+ *diff
] = keybuf
[i
];
9001 /* Overwrite the old keys with the new ones. */
9002 for (i
= 0; i
< len
; i
++)
9003 keybuf
[fkey
->start
+ i
]
9004 = Faref (next
, make_number (i
));
9006 fkey
->start
= fkey
->end
+= *diff
;
9007 fkey
->map
= fkey
->parent
;
9012 fkey
->map
= get_keymap (next
, 0, 1);
9014 /* If we no longer have a bound suffix, try a new position for
9016 if (!CONSP (fkey
->map
))
9018 fkey
->end
= ++fkey
->start
;
9019 fkey
->map
= fkey
->parent
;
9024 /* Read a sequence of keys that ends with a non prefix character,
9025 storing it in KEYBUF, a buffer of size BUFSIZE.
9027 Return the length of the key sequence stored.
9028 Return -1 if the user rejected a command menu.
9030 Echo starting immediately unless `prompt' is 0.
9032 Where a key sequence ends depends on the currently active keymaps.
9033 These include any minor mode keymaps active in the current buffer,
9034 the current buffer's local map, and the global map.
9036 If a key sequence has no other bindings, we check Vfunction_key_map
9037 to see if some trailing subsequence might be the beginning of a
9038 function key's sequence. If so, we try to read the whole function
9039 key, and substitute its symbolic name into the key sequence.
9041 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
9042 `double-' events into similar click events, if that would make them
9043 bound. We try to turn `triple-' events first into `double-' events,
9046 If we get a mouse click in a mode line, vertical divider, or other
9047 non-text area, we treat the click as if it were prefixed by the
9048 symbol denoting that area - `mode-line', `vertical-line', or
9051 If the sequence starts with a mouse click, we read the key sequence
9052 with respect to the buffer clicked on, not the current buffer.
9054 If the user switches frames in the midst of a key sequence, we put
9055 off the switch-frame event until later; the next call to
9056 read_char will return it.
9058 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9059 from the selected window's buffer. */
9062 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
9063 can_return_switch_frame
, fix_current_buffer
)
9064 Lisp_Object
*keybuf
;
9067 int dont_downcase_last
;
9068 int can_return_switch_frame
;
9069 int fix_current_buffer
;
9071 volatile Lisp_Object from_string
;
9072 volatile int count
= SPECPDL_INDEX ();
9074 /* How many keys there are in the current key sequence. */
9077 /* The length of the echo buffer when we started reading, and
9078 the length of this_command_keys when we started reading. */
9079 volatile int echo_start
;
9080 volatile int keys_start
;
9082 /* The number of keymaps we're scanning right now, and the number of
9083 keymaps we have allocated space for. */
9085 volatile int nmaps_allocated
= 0;
9087 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9088 the current keymaps. */
9089 Lisp_Object
*volatile defs
= NULL
;
9091 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9092 in the current keymaps, or nil where it is not a prefix. */
9093 Lisp_Object
*volatile submaps
= NULL
;
9095 /* The local map to start out with at start of key sequence. */
9096 volatile Lisp_Object orig_local_map
;
9098 /* The map from the `keymap' property to start out with at start of
9100 volatile Lisp_Object orig_keymap
;
9102 /* 1 if we have already considered switching to the local-map property
9103 of the place where a mouse click occurred. */
9104 volatile int localized_local_map
= 0;
9106 /* The index in submaps[] of the first keymap that has a binding for
9107 this key sequence. In other words, the lowest i such that
9108 submaps[i] is non-nil. */
9109 volatile int first_binding
;
9110 /* Index of the first key that has no binding.
9111 It is useless to try fkey.start larger than that. */
9112 volatile int first_unbound
;
9114 /* If t < mock_input, then KEYBUF[t] should be read as the next
9117 We use this to recover after recognizing a function key. Once we
9118 realize that a suffix of the current key sequence is actually a
9119 function key's escape sequence, we replace the suffix with the
9120 function key's binding from Vfunction_key_map. Now keybuf
9121 contains a new and different key sequence, so the echo area,
9122 this_command_keys, and the submaps and defs arrays are wrong. In
9123 this situation, we set mock_input to t, set t to 0, and jump to
9124 restart_sequence; the loop will read keys from keybuf up until
9125 mock_input, thus rebuilding the state; and then it will resume
9126 reading characters from the keyboard. */
9127 volatile int mock_input
= 0;
9129 /* If the sequence is unbound in submaps[], then
9130 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9131 and fkey.map is its binding.
9133 These might be > t, indicating that all function key scanning
9134 should hold off until t reaches them. We do this when we've just
9135 recognized a function key, to avoid searching for the function
9136 key's again in Vfunction_key_map. */
9137 volatile keyremap fkey
;
9139 /* Likewise, for key_translation_map and input-decode-map. */
9140 volatile keyremap keytran
, indec
;
9142 /* Non-zero if we are trying to map a key by changing an upper-case
9143 letter to lower case, or a shifted function key to an unshifted
9145 volatile int shift_translated
= 0;
9147 /* If we receive a `switch-frame' or `select-window' event in the middle of
9148 a key sequence, we put it off for later.
9149 While we're reading, we keep the event here. */
9150 volatile Lisp_Object delayed_switch_frame
;
9152 /* See the comment below... */
9153 #if defined (GOBBLE_FIRST_EVENT)
9154 Lisp_Object first_event
;
9157 volatile Lisp_Object original_uppercase
;
9158 volatile int original_uppercase_position
= -1;
9160 /* Gets around Microsoft compiler limitations. */
9163 struct buffer
*starting_buffer
;
9165 /* List of events for which a fake prefix key has been generated. */
9166 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9168 #if defined (GOBBLE_FIRST_EVENT)
9172 struct gcpro gcpro1
;
9174 GCPRO1 (fake_prefixed_keys
);
9175 raw_keybuf_count
= 0;
9177 last_nonmenu_event
= Qnil
;
9179 delayed_switch_frame
= Qnil
;
9184 echo_prompt (prompt
);
9185 else if (cursor_in_echo_area
9186 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9187 && NILP (Fzerop (Vecho_keystrokes
)))
9188 /* This doesn't put in a dash if the echo buffer is empty, so
9189 you don't always see a dash hanging out in the minibuffer. */
9193 /* Record the initial state of the echo area and this_command_keys;
9194 we will need to restore them if we replay a key sequence. */
9196 echo_start
= echo_length ();
9197 keys_start
= this_command_key_count
;
9198 this_single_command_key_start
= keys_start
;
9200 #if defined (GOBBLE_FIRST_EVENT)
9201 /* This doesn't quite work, because some of the things that read_char
9202 does cannot safely be bypassed. It seems too risky to try to make
9205 /* Read the first char of the sequence specially, before setting
9206 up any keymaps, in case a filter runs and switches buffers on us. */
9207 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9209 #endif /* GOBBLE_FIRST_EVENT */
9211 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9212 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9215 /* The multi-tty merge moved the code below to right after
9216 `replay_sequence' which caused all these translation maps to be applied
9217 repeatedly, even tho their doc says very clearly they are not applied to
9219 The reason for this move was: "We may switch keyboards between rescans,
9220 so we need to reinitialize fkey and keytran before each replay".
9221 This move was wrong (even if we switch keyboards, keybuf still holds the
9222 keys we've read already from the original keyboard and some of those keys
9223 may have already been translated). So there may still be a bug out there
9225 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9226 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9227 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9228 indec
.start
= indec
.end
= 0;
9229 fkey
.start
= fkey
.end
= 0;
9230 keytran
.start
= keytran
.end
= 0;
9232 /* We jump here when the key sequence has been thoroughly changed, and
9233 we need to rescan it starting from the beginning. When we jump here,
9234 keybuf[0..mock_input] holds the sequence we should reread. */
9237 starting_buffer
= current_buffer
;
9238 first_unbound
= bufsize
+ 1;
9240 /* Build our list of keymaps.
9241 If we recognize a function key and replace its escape sequence in
9242 keybuf with its symbol, or if the sequence starts with a mouse
9243 click and we need to switch buffers, we jump back here to rebuild
9244 the initial keymaps from the current buffer. */
9247 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9249 if (2 > nmaps_allocated
)
9251 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9252 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9253 nmaps_allocated
= 2;
9255 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9257 else if (!NILP (Voverriding_local_map
))
9259 if (2 > nmaps_allocated
)
9261 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9262 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9263 nmaps_allocated
= 2;
9265 submaps
[nmaps
++] = Voverriding_local_map
;
9273 nminor
= current_minor_maps (0, &maps
);
9274 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9276 if (total
> nmaps_allocated
)
9278 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9279 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9280 nmaps_allocated
= total
;
9283 if (!NILP (orig_keymap
))
9284 submaps
[nmaps
++] = orig_keymap
;
9286 bcopy (maps
, (void *) (submaps
+ nmaps
),
9287 nminor
* sizeof (submaps
[0]));
9291 submaps
[nmaps
++] = orig_local_map
;
9293 submaps
[nmaps
++] = current_global_map
;
9295 /* Find an accurate initial value for first_binding. */
9296 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9297 if (! NILP (submaps
[first_binding
]))
9300 /* Start from the beginning in keybuf. */
9303 /* These are no-ops the first time through, but if we restart, they
9304 revert the echo area and this_command_keys to their original state. */
9305 this_command_key_count
= keys_start
;
9306 if (INTERACTIVE
&& t
< mock_input
)
9307 echo_truncate (echo_start
);
9309 /* If the best binding for the current key sequence is a keymap, or
9310 we may be looking at a function key's escape sequence, keep on
9312 while (first_binding
< nmaps
9313 /* Keep reading as long as there's a prefix binding. */
9314 ? !NILP (submaps
[first_binding
])
9315 /* Don't return in the middle of a possible function key sequence,
9316 if the only bindings we found were via case conversion.
9317 Thus, if ESC O a has a function-key-map translation
9318 and ESC o has a binding, don't return after ESC O,
9319 so that we can translate ESC O plus the next character. */
9320 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9323 int used_mouse_menu
= 0;
9325 /* Where the last real key started. If we need to throw away a
9326 key that has expanded into more than one element of keybuf
9327 (say, a mouse click on the mode line which is being treated
9328 as [mode-line (mouse-...)], then we backtrack to this point
9330 volatile int last_real_key_start
;
9332 /* These variables are analogous to echo_start and keys_start;
9333 while those allow us to restart the entire key sequence,
9334 echo_local_start and keys_local_start allow us to throw away
9336 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9338 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9339 eassert (indec
.start
<= indec
.end
);
9340 eassert (fkey
.start
<= fkey
.end
);
9341 eassert (keytran
.start
<= keytran
.end
);
9342 /* key-translation-map is applied *after* function-key-map
9343 which is itself applied *after* input-decode-map. */
9344 eassert (fkey
.end
<= indec
.start
);
9345 eassert (keytran
.end
<= fkey
.start
);
9347 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9348 first_unbound
< keytran
.start
)
9349 { /* The prefix upto first_unbound has no binding and has
9350 no translation left to do either, so we know it's unbound.
9351 If we don't stop now, we risk staying here indefinitely
9352 (if the user keeps entering fkey or keytran prefixes
9353 like C-c ESC ESC ESC ESC ...) */
9355 for (i
= first_unbound
+ 1; i
< t
; i
++)
9356 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9357 mock_input
= t
- first_unbound
- 1;
9358 indec
.end
= indec
.start
-= first_unbound
+ 1;
9359 indec
.map
= indec
.parent
;
9360 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9361 fkey
.map
= fkey
.parent
;
9362 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9363 keytran
.map
= keytran
.parent
;
9364 goto replay_sequence
;
9368 error ("Key sequence too long");
9371 echo_local_start
= echo_length ();
9372 keys_local_start
= this_command_key_count
;
9373 local_first_binding
= first_binding
;
9376 /* These are no-ops, unless we throw away a keystroke below and
9377 jumped back up to replay_key; in that case, these restore the
9378 variables to their original state, allowing us to replay the
9380 if (INTERACTIVE
&& t
< mock_input
)
9381 echo_truncate (echo_local_start
);
9382 this_command_key_count
= keys_local_start
;
9383 first_binding
= local_first_binding
;
9385 /* By default, assume each event is "real". */
9386 last_real_key_start
= t
;
9388 /* Does mock_input indicate that we are re-reading a key sequence? */
9392 add_command_key (key
);
9393 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9394 && NILP (Fzerop (Vecho_keystrokes
)))
9398 /* If not, we should actually read a character. */
9403 KBOARD
*interrupted_kboard
= current_kboard
;
9404 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9406 key
= read_char (NILP (prompt
), nmaps
,
9407 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9408 &used_mouse_menu
, NULL
);
9410 if (INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9415 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9416 if (k
== interrupted_kboard
)
9421 /* Don't touch interrupted_kboard when it's been
9423 delayed_switch_frame
= Qnil
;
9424 goto replay_sequence
;
9427 if (!NILP (delayed_switch_frame
))
9429 interrupted_kboard
->kbd_queue
9430 = Fcons (delayed_switch_frame
,
9431 interrupted_kboard
->kbd_queue
);
9432 delayed_switch_frame
= Qnil
;
9436 interrupted_kboard
->kbd_queue
9437 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9439 /* If the side queue is non-empty, ensure it begins with a
9440 switch-frame, so we'll replay it in the right context. */
9441 if (CONSP (interrupted_kboard
->kbd_queue
)
9442 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9443 !(EVENT_HAS_PARAMETERS (key
)
9444 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9448 XSETFRAME (frame
, interrupted_frame
);
9449 interrupted_kboard
->kbd_queue
9450 = Fcons (make_lispy_switch_frame (frame
),
9451 interrupted_kboard
->kbd_queue
);
9454 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9455 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9456 goto replay_sequence
;
9461 /* read_char returns t when it shows a menu and the user rejects it.
9465 unbind_to (count
, Qnil
);
9470 /* read_char returns -1 at the end of a macro.
9471 Emacs 18 handles this by returning immediately with a
9472 zero, so that's what we'll do. */
9473 if (INTEGERP (key
) && XINT (key
) == -1)
9476 /* The Microsoft C compiler can't handle the goto that
9482 /* If the current buffer has been changed from under us, the
9483 keymap may have changed, so replay the sequence. */
9486 timer_resume_idle ();
9489 /* Reset the current buffer from the selected window
9490 in case something changed the former and not the latter.
9491 This is to be more consistent with the behavior
9492 of the command_loop_1. */
9493 if (fix_current_buffer
)
9495 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9497 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9498 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9501 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9502 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9503 goto replay_sequence
;
9506 /* If we have a quit that was typed in another frame, and
9507 quit_throw_to_read_char switched buffers,
9508 replay to get the right keymap. */
9510 && XINT (key
) == quit_char
9511 && current_buffer
!= starting_buffer
)
9514 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9518 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9519 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9520 goto replay_sequence
;
9525 if (EVENT_HAS_PARAMETERS (key
)
9526 /* Either a `switch-frame' or a `select-window' event. */
9527 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9529 /* If we're at the beginning of a key sequence, and the caller
9530 says it's okay, go ahead and return this event. If we're
9531 in the midst of a key sequence, delay it until the end. */
9532 if (t
> 0 || !can_return_switch_frame
)
9534 delayed_switch_frame
= key
;
9540 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9544 /* Clicks in non-text areas get prefixed by the symbol
9545 in their CHAR-ADDRESS field. For example, a click on
9546 the mode line is prefixed by the symbol `mode-line'.
9548 Furthermore, key sequences beginning with mouse clicks
9549 are read using the keymaps of the buffer clicked on, not
9550 the current buffer. So we may have to switch the buffer
9553 When we turn one event into two events, we must make sure
9554 that neither of the two looks like the original--so that,
9555 if we replay the events, they won't be expanded again.
9556 If not for this, such reexpansion could happen either here
9557 or when user programs play with this-command-keys. */
9558 if (EVENT_HAS_PARAMETERS (key
))
9563 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9564 if (EQ (kind
, Qmouse_click
))
9566 Lisp_Object window
, posn
;
9568 window
= POSN_WINDOW (EVENT_START (key
));
9569 posn
= POSN_POSN (EVENT_START (key
));
9572 || (!NILP (fake_prefixed_keys
)
9573 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9575 /* We're looking a second time at an event for which
9576 we generated a fake prefix key. Set
9577 last_real_key_start appropriately. */
9579 last_real_key_start
= t
- 1;
9582 /* Key sequences beginning with mouse clicks are
9583 read using the keymaps in the buffer clicked on,
9584 not the current buffer. If we're at the
9585 beginning of a key sequence, switch buffers. */
9586 if (last_real_key_start
== 0
9588 && BUFFERP (XWINDOW (window
)->buffer
)
9589 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9591 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9595 /* Arrange to go back to the original buffer once we're
9596 done reading the key sequence. Note that we can't
9597 use save_excursion_{save,restore} here, because they
9598 save point as well as the current buffer; we don't
9599 want to save point, because redisplay may change it,
9600 to accommodate a Fset_window_start or something. We
9601 don't want to do this at the top of the function,
9602 because we may get input from a subprocess which
9603 wants to change the selected window and stuff (say,
9605 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9607 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9609 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9610 orig_local_map
= get_local_map (PT
, current_buffer
,
9612 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9613 goto replay_sequence
;
9616 /* For a mouse click, get the local text-property keymap
9617 of the place clicked on, rather than point. */
9618 if (last_real_key_start
== 0
9619 && CONSP (XCDR (key
))
9620 && ! localized_local_map
)
9622 Lisp_Object map_here
, start
, pos
;
9624 localized_local_map
= 1;
9625 start
= EVENT_START (key
);
9627 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9629 pos
= POSN_BUFFER_POSN (start
);
9631 && XINT (pos
) >= BEGV
9632 && XINT (pos
) <= ZV
)
9634 map_here
= get_local_map (XINT (pos
),
9635 current_buffer
, Qlocal_map
);
9636 if (!EQ (map_here
, orig_local_map
))
9638 orig_local_map
= map_here
;
9639 ++localized_local_map
;
9642 map_here
= get_local_map (XINT (pos
),
9643 current_buffer
, Qkeymap
);
9644 if (!EQ (map_here
, orig_keymap
))
9646 orig_keymap
= map_here
;
9647 ++localized_local_map
;
9650 if (localized_local_map
> 1)
9655 goto replay_sequence
;
9661 /* Expand mode-line and scroll-bar events into two events:
9662 use posn as a fake prefix key. */
9664 && (NILP (fake_prefixed_keys
)
9665 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9667 if (t
+ 1 >= bufsize
)
9668 error ("Key sequence too long");
9671 keybuf
[t
+ 1] = key
;
9674 /* Record that a fake prefix key has been generated
9675 for KEY. Don't modify the event; this would
9676 prevent proper action when the event is pushed
9677 back into unread-command-events. */
9678 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9680 /* If on a mode line string with a local keymap,
9681 reconsider the key sequence with that keymap. */
9682 if (string
= POSN_STRING (EVENT_START (key
)),
9683 (CONSP (string
) && STRINGP (XCAR (string
))))
9685 Lisp_Object pos
, map
, map2
;
9687 pos
= XCDR (string
);
9688 string
= XCAR (string
);
9690 && XINT (pos
) < SCHARS (string
))
9692 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9694 orig_local_map
= map
;
9695 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9698 if (!NILP (map
) || !NILP (map2
))
9699 goto replay_sequence
;
9705 else if (NILP (from_string
)
9706 && (string
= POSN_STRING (EVENT_START (key
)),
9707 (CONSP (string
) && STRINGP (XCAR (string
)))))
9709 /* For a click on a string, i.e. overlay string or a
9710 string displayed via the `display' property,
9711 consider `local-map' and `keymap' properties of
9713 Lisp_Object pos
, map
, map2
;
9715 pos
= XCDR (string
);
9716 string
= XCAR (string
);
9718 && XINT (pos
) < SCHARS (string
))
9720 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9722 orig_local_map
= map
;
9723 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9727 if (!NILP (map
) || !NILP (map2
))
9729 from_string
= string
;
9732 goto replay_sequence
;
9737 else if (CONSP (XCDR (key
))
9738 && CONSP (EVENT_START (key
))
9739 && CONSP (XCDR (EVENT_START (key
))))
9743 posn
= POSN_POSN (EVENT_START (key
));
9744 /* Handle menu-bar events:
9745 insert the dummy prefix event `menu-bar'. */
9746 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9748 if (t
+ 1 >= bufsize
)
9749 error ("Key sequence too long");
9753 /* Zap the position in key, so we know that we've
9754 expanded it, and don't try to do so again. */
9755 POSN_SET_POSN (EVENT_START (key
),
9756 Fcons (posn
, Qnil
));
9759 goto replay_sequence
;
9761 else if (CONSP (posn
))
9763 /* We're looking at the second event of a
9764 sequence which we expanded before. Set
9765 last_real_key_start appropriately. */
9766 if (last_real_key_start
== t
&& t
> 0)
9767 last_real_key_start
= t
- 1;
9772 /* We have finally decided that KEY is something we might want
9774 first_binding
= (follow_key (key
,
9775 nmaps
- first_binding
,
9776 submaps
+ first_binding
,
9777 defs
+ first_binding
,
9778 submaps
+ first_binding
)
9781 /* If KEY wasn't bound, we'll try some fallbacks. */
9782 if (first_binding
< nmaps
)
9783 /* This is needed for the following scenario:
9784 event 0: a down-event that gets dropped by calling replay_key.
9785 event 1: some normal prefix like C-h.
9786 After event 0, first_unbound is 0, after event 1 indec.start,
9787 fkey.start, and keytran.start are all 1, so when we see that
9788 C-h is bound, we need to update first_unbound. */
9789 first_unbound
= max (t
+ 1, first_unbound
);
9794 /* Remember the position to put an upper bound on indec.start. */
9795 first_unbound
= min (t
, first_unbound
);
9797 head
= EVENT_HEAD (key
);
9798 if (help_char_p (head
) && t
> 0)
9800 read_key_sequence_cmd
= Vprefix_help_command
;
9802 last_nonmenu_event
= key
;
9803 /* The Microsoft C compiler can't handle the goto that
9811 Lisp_Object breakdown
;
9814 breakdown
= parse_modifiers (head
);
9815 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9816 /* Attempt to reduce an unbound mouse event to a simpler
9817 event that is bound:
9818 Drags reduce to clicks.
9819 Double-clicks reduce to clicks.
9820 Triple-clicks reduce to double-clicks, then to clicks.
9821 Down-clicks are eliminated.
9822 Double-downs reduce to downs, then are eliminated.
9823 Triple-downs reduce to double-downs, then to downs,
9824 then are eliminated. */
9825 if (modifiers
& (down_modifier
| drag_modifier
9826 | double_modifier
| triple_modifier
))
9828 while (modifiers
& (down_modifier
| drag_modifier
9829 | double_modifier
| triple_modifier
))
9831 Lisp_Object new_head
, new_click
;
9832 if (modifiers
& triple_modifier
)
9833 modifiers
^= (double_modifier
| triple_modifier
);
9834 else if (modifiers
& double_modifier
)
9835 modifiers
&= ~double_modifier
;
9836 else if (modifiers
& drag_modifier
)
9837 modifiers
&= ~drag_modifier
;
9840 /* Dispose of this `down' event by simply jumping
9841 back to replay_key, to get another event.
9843 Note that if this event came from mock input,
9844 then just jumping back to replay_key will just
9845 hand it to us again. So we have to wipe out any
9848 We could delete keybuf[t] and shift everything
9849 after that to the left by one spot, but we'd also
9850 have to fix up any variable that points into
9851 keybuf, and shifting isn't really necessary
9854 Adding prefixes for non-textual mouse clicks
9855 creates two characters of mock input, and both
9856 must be thrown away. If we're only looking at
9857 the prefix now, we can just jump back to
9858 replay_key. On the other hand, if we've already
9859 processed the prefix, and now the actual click
9860 itself is giving us trouble, then we've lost the
9861 state of the keymaps we want to backtrack to, and
9862 we need to replay the whole sequence to rebuild
9865 Beyond that, only function key expansion could
9866 create more than two keys, but that should never
9867 generate mouse events, so it's okay to zero
9868 mock_input in that case too.
9870 FIXME: The above paragraph seems just plain
9871 wrong, if you consider things like
9872 xterm-mouse-mode. -stef
9874 Isn't this just the most wonderful code ever? */
9876 /* If mock_input > t + 1, the above simplification
9877 will actually end up dropping keys on the floor.
9878 This is probably OK for now, but even
9879 if mock_input <= t + 1, we need to adjust indec,
9881 Typical case [header-line down-mouse-N]:
9882 mock_input = 2, t = 1, fkey.end = 1,
9883 last_real_key_start = 0. */
9884 if (indec
.end
> last_real_key_start
)
9886 indec
.end
= indec
.start
9887 = min (last_real_key_start
, indec
.start
);
9888 indec
.map
= indec
.parent
;
9889 if (fkey
.end
> last_real_key_start
)
9891 fkey
.end
= fkey
.start
9892 = min (last_real_key_start
, fkey
.start
);
9893 fkey
.map
= fkey
.parent
;
9894 if (keytran
.end
> last_real_key_start
)
9896 keytran
.end
= keytran
.start
9897 = min (last_real_key_start
, keytran
.start
);
9898 keytran
.map
= keytran
.parent
;
9902 if (t
== last_real_key_start
)
9909 mock_input
= last_real_key_start
;
9910 goto replay_sequence
;
9915 = apply_modifiers (modifiers
, XCAR (breakdown
));
9917 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9919 /* Look for a binding for this new key. follow_key
9920 promises that it didn't munge submaps the
9921 last time we called it, since key was unbound. */
9923 = (follow_key (new_click
,
9924 nmaps
- local_first_binding
,
9925 submaps
+ local_first_binding
,
9926 defs
+ local_first_binding
,
9927 submaps
+ local_first_binding
)
9928 + local_first_binding
);
9930 /* If that click is bound, go for it. */
9931 if (first_binding
< nmaps
)
9936 /* Otherwise, we'll leave key set to the drag event. */
9943 /* Normally, last_nonmenu_event gets the previous key we read.
9944 But when a mouse popup menu is being used,
9945 we don't update last_nonmenu_event; it continues to hold the mouse
9946 event that preceded the first level of menu. */
9947 if (!used_mouse_menu
)
9948 last_nonmenu_event
= key
;
9950 /* Record what part of this_command_keys is the current key sequence. */
9951 this_single_command_key_start
= this_command_key_count
- t
;
9953 /* Look for this sequence in input-decode-map.
9954 Scan from indec.end until we find a bound suffix. */
9955 while (indec
.end
< t
)
9957 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9960 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9961 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9966 mock_input
= diff
+ max (t
, mock_input
);
9967 goto replay_sequence
;
9971 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9972 && indec
.start
>= t
)
9973 /* There is a binding and it's not a prefix.
9974 (and it doesn't have any input-decode-map translation pending).
9975 There is thus no function-key in this sequence.
9976 Moving fkey.start is important in this case to allow keytran.start
9977 to go over the sequence before we return (since we keep the
9978 invariant that keytran.end <= fkey.start). */
9981 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9984 /* If the sequence is unbound, see if we can hang a function key
9985 off the end of it. */
9986 /* Continue scan from fkey.end until we find a bound suffix. */
9987 while (fkey
.end
< indec
.start
)
9989 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9992 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9993 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9994 max (t
, mock_input
),
9995 /* If there's a binding (i.e.
9996 first_binding >= nmaps) we don't want
9997 to apply this function-key-mapping. */
9998 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
10003 mock_input
= diff
+ max (t
, mock_input
);
10004 /* Adjust the input-decode-map counters. */
10006 indec
.start
+= diff
;
10008 goto replay_sequence
;
10012 /* Look for this sequence in key-translation-map.
10013 Scan from keytran.end until we find a bound suffix. */
10014 while (keytran
.end
< fkey
.start
)
10016 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10019 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
10020 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
10025 mock_input
= diff
+ max (t
, mock_input
);
10026 /* Adjust the function-key-map and input-decode-map counters. */
10028 indec
.start
+= diff
;
10030 fkey
.start
+= diff
;
10032 goto replay_sequence
;
10036 /* If KEY is not defined in any of the keymaps,
10037 and cannot be part of a function key or translation,
10038 and is an upper case letter
10039 use the corresponding lower-case letter instead. */
10040 if (first_binding
>= nmaps
10041 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10043 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10044 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10045 || (XINT (key
) & shift_modifier
)))
10047 Lisp_Object new_key
;
10049 original_uppercase
= key
;
10050 original_uppercase_position
= t
- 1;
10052 if (XINT (key
) & shift_modifier
)
10053 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10055 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10056 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10058 /* We have to do this unconditionally, regardless of whether
10059 the lower-case char is defined in the keymaps, because they
10060 might get translated through function-key-map. */
10061 keybuf
[t
- 1] = new_key
;
10062 mock_input
= max (t
, mock_input
);
10063 shift_translated
= 1;
10065 goto replay_sequence
;
10067 /* If KEY is not defined in any of the keymaps,
10068 and cannot be part of a function key or translation,
10069 and is a shifted function key,
10070 use the corresponding unshifted function key instead. */
10071 if (first_binding
>= nmaps
10072 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10074 Lisp_Object breakdown
= parse_modifiers (key
);
10076 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10078 if (modifiers
& shift_modifier
10079 /* Treat uppercase keys as shifted. */
10081 && (KEY_TO_CHAR (key
)
10082 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10083 && UPPERCASEP (KEY_TO_CHAR (key
))))
10085 Lisp_Object new_key
10086 = (modifiers
& shift_modifier
10087 ? apply_modifiers (modifiers
& ~shift_modifier
,
10089 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10091 original_uppercase
= key
;
10092 original_uppercase_position
= t
- 1;
10094 /* We have to do this unconditionally, regardless of whether
10095 the lower-case char is defined in the keymaps, because they
10096 might get translated through function-key-map. */
10097 keybuf
[t
- 1] = new_key
;
10098 mock_input
= max (t
, mock_input
);
10099 /* Reset fkey (and consequently keytran) to apply
10100 function-key-map on the result, so that S-backspace is
10101 correctly mapped to DEL (via backspace). OTOH,
10102 input-decode-map doesn't need to go through it again. */
10103 fkey
.start
= fkey
.end
= 0;
10104 keytran
.start
= keytran
.end
= 0;
10105 shift_translated
= 1;
10107 goto replay_sequence
;
10112 read_key_sequence_cmd
= (first_binding
< nmaps
10113 ? defs
[first_binding
]
10116 unread_switch_frame
= delayed_switch_frame
;
10117 unbind_to (count
, Qnil
);
10119 /* Don't downcase the last character if the caller says don't.
10120 Don't downcase it if the result is undefined, either. */
10121 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10123 && t
- 1 == original_uppercase_position
)
10125 keybuf
[t
- 1] = original_uppercase
;
10126 shift_translated
= 0;
10129 if (shift_translated
)
10130 Vthis_command_keys_shift_translated
= Qt
;
10132 /* Occasionally we fabricate events, perhaps by expanding something
10133 according to function-key-map, or by adding a prefix symbol to a
10134 mouse click in the scroll bar or modeline. In this cases, return
10135 the entire generated key sequence, even if we hit an unbound
10136 prefix or a definition before the end. This means that you will
10137 be able to push back the event properly, and also means that
10138 read-key-sequence will always return a logical unit.
10141 for (; t
< mock_input
; t
++)
10143 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10144 && NILP (Fzerop (Vecho_keystrokes
)))
10145 echo_char (keybuf
[t
]);
10146 add_command_key (keybuf
[t
]);
10153 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10154 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10155 The sequence is sufficient to specify a non-prefix command in the
10156 current local and global maps.
10158 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10159 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10160 as a continuation of the previous key.
10162 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10163 convert the last event to lower case. (Normally any upper case event
10164 is converted to lower case if the original event is undefined and the lower
10165 case equivalent is defined.) A non-nil value is appropriate for reading
10166 a key sequence to be defined.
10168 A C-g typed while in this function is treated like any other character,
10169 and `quit-flag' is not set.
10171 If the key sequence starts with a mouse click, then the sequence is read
10172 using the keymaps of the buffer of the window clicked in, not the buffer
10173 of the selected window as normal.
10175 `read-key-sequence' drops unbound button-down events, since you normally
10176 only care about the click or drag events which follow them. If a drag
10177 or multi-click event is unbound, but the corresponding click event would
10178 be bound, `read-key-sequence' turns the event into a click event at the
10179 drag's starting position. This means that you don't have to distinguish
10180 between click and drag, double, or triple events unless you want to.
10182 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10183 lines separating windows, and scroll bars with imaginary keys
10184 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10186 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10187 function will process a switch-frame event if the user switches frames
10188 before typing anything. If the user switches frames in the middle of a
10189 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10190 is nil, then the event will be put off until after the current key sequence.
10192 `read-key-sequence' checks `function-key-map' for function key
10193 sequences, where they wouldn't conflict with ordinary bindings. See
10194 `function-key-map' for more details.
10196 The optional fifth argument COMMAND-LOOP, if non-nil, means
10197 that this key sequence is being read by something that will
10198 read commands one after another. It should be nil if the caller
10199 will read just one key sequence. */)
10200 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10202 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10203 Lisp_Object can_return_switch_frame
, command_loop
;
10205 Lisp_Object keybuf
[30];
10207 struct gcpro gcpro1
;
10208 int count
= SPECPDL_INDEX ();
10210 if (!NILP (prompt
))
10211 CHECK_STRING (prompt
);
10214 specbind (Qinput_method_exit_on_first_char
,
10215 (NILP (command_loop
) ? Qt
: Qnil
));
10216 specbind (Qinput_method_use_echo_area
,
10217 (NILP (command_loop
) ? Qt
: Qnil
));
10219 bzero (keybuf
, sizeof keybuf
);
10220 GCPRO1 (keybuf
[0]);
10221 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10223 if (NILP (continue_echo
))
10225 this_command_key_count
= 0;
10226 this_command_key_count_reset
= 0;
10227 this_single_command_key_start
= 0;
10230 #ifdef HAVE_WINDOW_SYSTEM
10231 if (display_hourglass_p
)
10232 cancel_hourglass ();
10235 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10236 prompt
, ! NILP (dont_downcase_last
),
10237 ! NILP (can_return_switch_frame
), 0);
10239 #if 0 /* The following is fine for code reading a key sequence and
10240 then proceeding with a lenghty computation, but it's not good
10241 for code reading keys in a loop, like an input method. */
10242 #ifdef HAVE_WINDOW_SYSTEM
10243 if (display_hourglass_p
)
10244 start_hourglass ();
10254 return unbind_to (count
, make_event_array (i
, keybuf
));
10257 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10258 Sread_key_sequence_vector
, 1, 5, 0,
10259 doc
: /* Like `read-key-sequence' but always return a vector. */)
10260 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10262 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10263 Lisp_Object can_return_switch_frame
, command_loop
;
10265 Lisp_Object keybuf
[30];
10267 struct gcpro gcpro1
;
10268 int count
= SPECPDL_INDEX ();
10270 if (!NILP (prompt
))
10271 CHECK_STRING (prompt
);
10274 specbind (Qinput_method_exit_on_first_char
,
10275 (NILP (command_loop
) ? Qt
: Qnil
));
10276 specbind (Qinput_method_use_echo_area
,
10277 (NILP (command_loop
) ? Qt
: Qnil
));
10279 bzero (keybuf
, sizeof keybuf
);
10280 GCPRO1 (keybuf
[0]);
10281 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10283 if (NILP (continue_echo
))
10285 this_command_key_count
= 0;
10286 this_command_key_count_reset
= 0;
10287 this_single_command_key_start
= 0;
10290 #ifdef HAVE_WINDOW_SYSTEM
10291 if (display_hourglass_p
)
10292 cancel_hourglass ();
10295 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10296 prompt
, ! NILP (dont_downcase_last
),
10297 ! NILP (can_return_switch_frame
), 0);
10299 #ifdef HAVE_WINDOW_SYSTEM
10300 if (display_hourglass_p
)
10301 start_hourglass ();
10310 return unbind_to (count
, Fvector (i
, keybuf
));
10313 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10314 doc
: /* Execute CMD as an editor command.
10315 CMD must be a symbol that satisfies the `commandp' predicate.
10316 Optional second arg RECORD-FLAG non-nil
10317 means unconditionally put this command in `command-history'.
10318 Otherwise, that is done only if an arg is read using the minibuffer.
10319 The argument KEYS specifies the value to use instead of (this-command-keys)
10320 when reading the arguments; if it is nil, (this-command-keys) is used.
10321 The argument SPECIAL, if non-nil, means that this command is executing
10322 a special event, so ignore the prefix argument and don't clear it. */)
10323 (cmd
, record_flag
, keys
, special
)
10324 Lisp_Object cmd
, record_flag
, keys
, special
;
10326 register Lisp_Object final
;
10327 register Lisp_Object tem
;
10328 Lisp_Object prefixarg
;
10329 extern int debug_on_next_call
;
10331 debug_on_next_call
= 0;
10333 if (NILP (special
))
10335 prefixarg
= current_kboard
->Vprefix_arg
;
10336 Vcurrent_prefix_arg
= prefixarg
;
10337 current_kboard
->Vprefix_arg
= Qnil
;
10344 tem
= Fget (cmd
, Qdisabled
);
10345 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10347 tem
= Fsymbol_value (Qdisabled_command_function
);
10349 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10355 final
= Findirect_function (cmd
, Qnil
);
10357 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10359 struct gcpro gcpro1
, gcpro2
;
10361 GCPRO2 (cmd
, prefixarg
);
10362 do_autoload (final
, cmd
);
10369 if (STRINGP (final
) || VECTORP (final
))
10371 /* If requested, place the macro in the command history. For
10372 other sorts of commands, call-interactively takes care of
10374 if (!NILP (record_flag
))
10377 = Fcons (Fcons (Qexecute_kbd_macro
,
10378 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10381 /* Don't keep command history around forever. */
10382 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10384 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10386 XSETCDR (tem
, Qnil
);
10390 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10393 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10394 /* Don't call Fcall_interactively directly because we want to make
10395 sure the backtrace has an entry for `call-interactively'.
10396 For the same reason, pass `cmd' rather than `final'. */
10397 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10404 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10406 doc
: /* Read function name, then read its arguments and call it.
10408 To pass a numeric argument to the command you are invoking with, specify
10409 the numeric argument to this command.
10411 Noninteractively, the argument PREFIXARG is the prefix argument to
10412 give to the command you invoke, if it asks for an argument. */)
10414 Lisp_Object prefixarg
;
10416 Lisp_Object function
;
10418 int saved_last_point_position
;
10419 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10420 Lisp_Object bindings
, value
;
10421 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10422 #ifdef HAVE_WINDOW_SYSTEM
10423 /* The call to Fcompleting_read wil start and cancel the hourglass,
10424 but if the hourglass was already scheduled, this means that no
10425 hourglass will be shown for the actual M-x command itself.
10426 So we restart it if it is already scheduled. Note that checking
10427 hourglass_shown_p is not enough, normally the hourglass is not shown,
10428 just scheduled to be shown. */
10429 int hstarted
= hourglass_started ();
10432 saved_keys
= Fvector (this_command_key_count
,
10433 XVECTOR (this_command_keys
)->contents
);
10434 saved_last_point_position_buffer
= last_point_position_buffer
;
10435 saved_last_point_position
= last_point_position
;
10437 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10439 if (EQ (prefixarg
, Qminus
))
10440 strcpy (buf
, "- ");
10441 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10442 strcpy (buf
, "C-u ");
10443 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10444 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10445 else if (INTEGERP (prefixarg
))
10446 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10448 /* This isn't strictly correct if execute-extended-command
10449 is bound to anything else. Perhaps it should use
10450 this_command_keys? */
10451 strcat (buf
, "M-x ");
10453 /* Prompt with buf, and then read a string, completing from and
10454 restricting to the set of all defined commands. Don't provide
10455 any initial input. Save the command read on the extended-command
10457 function
= Fcompleting_read (build_string (buf
),
10458 Vobarray
, Qcommandp
,
10459 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10462 #ifdef HAVE_WINDOW_SYSTEM
10463 if (hstarted
) start_hourglass ();
10466 if (STRINGP (function
) && SCHARS (function
) == 0)
10467 error ("No command name given");
10469 /* Set this_command_keys to the concatenation of saved_keys and
10470 function, followed by a RET. */
10475 this_command_key_count
= 0;
10476 this_command_key_count_reset
= 0;
10477 this_single_command_key_start
= 0;
10479 keys
= XVECTOR (saved_keys
)->contents
;
10480 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10481 add_command_key (keys
[i
]);
10483 for (i
= 0; i
< SCHARS (function
); i
++)
10484 add_command_key (Faref (function
, make_number (i
)));
10486 add_command_key (make_number ('\015'));
10489 last_point_position
= saved_last_point_position
;
10490 last_point_position_buffer
= saved_last_point_position_buffer
;
10494 function
= Fintern (function
, Qnil
);
10495 current_kboard
->Vprefix_arg
= prefixarg
;
10496 Vthis_command
= function
;
10497 real_this_command
= function
;
10499 /* If enabled, show which key runs this command. */
10500 if (!NILP (Vsuggest_key_bindings
)
10501 && NILP (Vexecuting_kbd_macro
)
10502 && SYMBOLP (function
))
10503 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10509 GCPRO3 (bindings
, value
, function
);
10510 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10512 /* If the command has a key binding, print it now. */
10513 if (!NILP (bindings
)
10514 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10517 /* But first wait, and skip the message if there is input. */
10518 Lisp_Object waited
;
10520 /* If this command displayed something in the echo area;
10521 wait a few seconds, then display our suggestion message. */
10522 if (NILP (echo_area_buffer
[0]))
10523 waited
= sit_for (make_number (0), 0, 2);
10524 else if (NUMBERP (Vsuggest_key_bindings
))
10525 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10527 waited
= sit_for (make_number (2), 0, 2);
10529 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10531 Lisp_Object binding
;
10533 int message_p
= push_message ();
10534 int count
= SPECPDL_INDEX ();
10536 record_unwind_protect (pop_message_unwind
, Qnil
);
10537 binding
= Fkey_description (bindings
, Qnil
);
10540 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10543 sprintf (newmessage
, "You can run the command `%s' with %s",
10544 SDATA (SYMBOL_NAME (function
)),
10546 message2_nolog (newmessage
,
10547 strlen (newmessage
),
10548 STRING_MULTIBYTE (binding
));
10549 if (NUMBERP (Vsuggest_key_bindings
))
10550 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10552 waited
= sit_for (make_number (2), 0, 2);
10554 if (!NILP (waited
) && message_p
)
10555 restore_message ();
10557 unbind_to (count
, Qnil
);
10561 RETURN_UNGCPRO (value
);
10565 /* Return nonzero if input events are pending. */
10568 detect_input_pending ()
10570 if (!input_pending
)
10571 get_input_pending (&input_pending
, 0);
10573 return input_pending
;
10576 /* Return nonzero if input events other than mouse movements are
10580 detect_input_pending_ignore_squeezables ()
10582 if (!input_pending
)
10583 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10585 return input_pending
;
10588 /* Return nonzero if input events are pending, and run any pending timers. */
10591 detect_input_pending_run_timers (do_display
)
10594 int old_timers_run
= timers_run
;
10596 if (!input_pending
)
10597 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10599 if (old_timers_run
!= timers_run
&& do_display
)
10601 redisplay_preserve_echo_area (8);
10602 /* The following fixes a bug when using lazy-lock with
10603 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10604 from an idle timer function. The symptom of the bug is that
10605 the cursor sometimes doesn't become visible until the next X
10606 event is processed. --gerd. */
10608 Lisp_Object tail
, frame
;
10609 FOR_EACH_FRAME (tail
, frame
)
10610 if (FRAME_RIF (XFRAME (frame
)))
10611 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10615 return input_pending
;
10618 /* This is called in some cases before a possible quit.
10619 It cases the next call to detect_input_pending to recompute input_pending.
10620 So calling this function unnecessarily can't do any harm. */
10623 clear_input_pending ()
10628 /* Return nonzero if there are pending requeued events.
10629 This isn't used yet. The hope is to make wait_reading_process_output
10630 call it, and return if it runs Lisp code that unreads something.
10631 The problem is, kbd_buffer_get_event needs to be fixed to know what
10632 to do in that case. It isn't trivial. */
10635 requeued_events_pending_p ()
10637 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10641 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10642 doc
: /* Return t if command input is currently available with no wait.
10643 Actually, the value is nil only if we can be sure that no input is available;
10644 if there is a doubt, the value is t. */)
10647 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10648 || !NILP (Vunread_post_input_method_events
)
10649 || !NILP (Vunread_input_method_events
))
10652 get_input_pending (&input_pending
,
10653 READABLE_EVENTS_DO_TIMERS_NOW
10654 | READABLE_EVENTS_FILTER_EVENTS
);
10655 return input_pending
> 0 ? Qt
: Qnil
;
10658 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10659 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10662 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10665 if (total_keys
< NUM_RECENT_KEYS
)
10666 return Fvector (total_keys
, keys
);
10669 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10670 bcopy (keys
+ recent_keys_index
,
10671 XVECTOR (val
)->contents
,
10672 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10674 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10675 recent_keys_index
* sizeof (Lisp_Object
));
10680 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10681 doc
: /* Return the key sequence that invoked this command.
10682 However, if the command has called `read-key-sequence', it returns
10683 the last key sequence that has been read.
10684 The value is a string or a vector.
10686 See also `this-command-keys-vector'. */)
10689 return make_event_array (this_command_key_count
,
10690 XVECTOR (this_command_keys
)->contents
);
10693 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10694 doc
: /* Return the key sequence that invoked this command, as a vector.
10695 However, if the command has called `read-key-sequence', it returns
10696 the last key sequence that has been read.
10698 See also `this-command-keys'. */)
10701 return Fvector (this_command_key_count
,
10702 XVECTOR (this_command_keys
)->contents
);
10705 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10706 Sthis_single_command_keys
, 0, 0, 0,
10707 doc
: /* Return the key sequence that invoked this command.
10708 More generally, it returns the last key sequence read, either by
10709 the command loop or by `read-key-sequence'.
10710 Unlike `this-command-keys', this function's value
10711 does not include prefix arguments.
10712 The value is always a vector. */)
10715 return Fvector (this_command_key_count
10716 - this_single_command_key_start
,
10717 (XVECTOR (this_command_keys
)->contents
10718 + this_single_command_key_start
));
10721 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10722 Sthis_single_command_raw_keys
, 0, 0, 0,
10723 doc
: /* Return the raw events that were read for this command.
10724 More generally, it returns the last key sequence read, either by
10725 the command loop or by `read-key-sequence'.
10726 Unlike `this-single-command-keys', this function's value
10727 shows the events before all translations (except for input methods).
10728 The value is always a vector. */)
10731 return Fvector (raw_keybuf_count
,
10732 (XVECTOR (raw_keybuf
)->contents
));
10735 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10736 Sreset_this_command_lengths
, 0, 0, 0,
10737 doc
: /* Make the unread events replace the last command and echo.
10738 Used in `universal-argument-other-key'.
10740 `universal-argument-other-key' rereads the event just typed.
10741 It then gets translated through `function-key-map'.
10742 The translated event has to replace the real events,
10743 both in the value of (this-command-keys) and in echoing.
10744 To achieve this, `universal-argument-other-key' calls
10745 `reset-this-command-lengths', which discards the record of reading
10746 these events the first time. */)
10749 this_command_key_count
= before_command_key_count
;
10750 if (this_command_key_count
< this_single_command_key_start
)
10751 this_single_command_key_start
= this_command_key_count
;
10753 echo_truncate (before_command_echo_length
);
10755 /* Cause whatever we put into unread-command-events
10756 to echo as if it were being freshly read from the keyboard. */
10757 this_command_key_count_reset
= 1;
10762 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10763 Sclear_this_command_keys
, 0, 1, 0,
10764 doc
: /* Clear out the vector that `this-command-keys' returns.
10765 Also clear the record of the last 100 events, unless optional arg
10766 KEEP-RECORD is non-nil. */)
10768 Lisp_Object keep_record
;
10772 this_command_key_count
= 0;
10773 this_command_key_count_reset
= 0;
10775 if (NILP (keep_record
))
10777 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10778 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10780 recent_keys_index
= 0;
10785 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10786 doc
: /* Return the current depth in recursive edits. */)
10790 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10794 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10795 "FOpen dribble file: ",
10796 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10797 If FILE is nil, close any open dribble file. */)
10810 file
= Fexpand_file_name (file
, Qnil
);
10811 dribble
= fopen (SDATA (file
), "w");
10813 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10818 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10819 doc
: /* Discard the contents of the terminal input buffer.
10820 Also end any kbd macro being defined. */)
10823 if (!NILP (current_kboard
->defining_kbd_macro
))
10825 /* Discard the last command from the macro. */
10826 Fcancel_kbd_macro_events ();
10830 update_mode_lines
++;
10832 Vunread_command_events
= Qnil
;
10833 unread_command_char
= -1;
10835 discard_tty_input ();
10837 kbd_fetch_ptr
= kbd_store_ptr
;
10843 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10844 doc
: /* Stop Emacs and return to superior process. You can resume later.
10845 If `cannot-suspend' is non-nil, or if the system doesn't support job
10846 control, run a subshell instead.
10848 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10849 to be read as terminal input by Emacs's parent, after suspension.
10851 Before suspending, run the normal hook `suspend-hook'.
10852 After resumption run the normal hook `suspend-resume-hook'.
10854 Some operating systems cannot stop the Emacs process and resume it later.
10855 On such systems, Emacs starts a subshell instead of suspending. */)
10857 Lisp_Object stuffstring
;
10859 int count
= SPECPDL_INDEX ();
10860 int old_height
, old_width
;
10862 struct gcpro gcpro1
;
10864 if (tty_list
&& tty_list
->next
)
10865 error ("There are other tty frames open; close them before suspending Emacs");
10867 if (!NILP (stuffstring
))
10868 CHECK_STRING (stuffstring
);
10870 /* Run the functions in suspend-hook. */
10871 if (!NILP (Vrun_hooks
))
10872 call1 (Vrun_hooks
, intern ("suspend-hook"));
10874 GCPRO1 (stuffstring
);
10875 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10876 reset_all_sys_modes ();
10877 /* sys_suspend can get an error if it tries to fork a subshell
10878 and the system resources aren't available for that. */
10879 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10881 stuff_buffered_input (stuffstring
);
10882 if (cannot_suspend
)
10886 unbind_to (count
, Qnil
);
10888 /* Check if terminal/window size has changed.
10889 Note that this is not useful when we are running directly
10890 with a window system; but suspend should be disabled in that case. */
10891 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10892 if (width
!= old_width
|| height
!= old_height
)
10893 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10895 /* Run suspend-resume-hook. */
10896 if (!NILP (Vrun_hooks
))
10897 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10903 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10904 Then in any case stuff anything Emacs has read ahead and not used. */
10907 stuff_buffered_input (stuffstring
)
10908 Lisp_Object stuffstring
;
10910 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10911 register unsigned char *p
;
10913 if (STRINGP (stuffstring
))
10915 register int count
;
10917 p
= SDATA (stuffstring
);
10918 count
= SBYTES (stuffstring
);
10919 while (count
-- > 0)
10924 /* Anything we have read ahead, put back for the shell to read. */
10925 /* ?? What should this do when we have multiple keyboards??
10926 Should we ignore anything that was typed in at the "wrong" kboard?
10928 rms: we should stuff everything back into the kboard
10930 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10933 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10934 kbd_fetch_ptr
= kbd_buffer
;
10935 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10936 stuff_char (kbd_fetch_ptr
->code
);
10938 clear_event (kbd_fetch_ptr
);
10942 #endif /* SIGTSTP */
10946 set_waiting_for_input (time_to_clear
)
10947 EMACS_TIME
*time_to_clear
;
10949 input_available_clear_time
= time_to_clear
;
10951 /* Tell handle_interrupt to throw back to read_char, */
10952 waiting_for_input
= 1;
10954 /* If handle_interrupt was called before and buffered a C-g,
10955 make it run again now, to avoid timing error. */
10956 if (!NILP (Vquit_flag
))
10957 quit_throw_to_read_char ();
10961 clear_waiting_for_input ()
10963 /* Tell handle_interrupt not to throw back to read_char, */
10964 waiting_for_input
= 0;
10965 input_available_clear_time
= 0;
10968 /* The SIGINT handler.
10970 If we have a frame on the controlling tty, we assume that the
10971 SIGINT was generated by C-g, so we call handle_interrupt.
10972 Otherwise, the handler kills Emacs. */
10975 interrupt_signal (signalnum
) /* If we don't have an argument, */
10976 int signalnum
; /* some compilers complain in signal calls. */
10978 /* Must preserve main program's value of errno. */
10979 int old_errno
= errno
;
10980 struct terminal
*terminal
;
10982 #if defined (USG) && !defined (POSIX_SIGNALS)
10983 /* USG systems forget handlers when they are used;
10984 must reestablish each time */
10985 signal (SIGINT
, interrupt_signal
);
10986 signal (SIGQUIT
, interrupt_signal
);
10989 SIGNAL_THREAD_CHECK (signalnum
);
10991 /* See if we have an active terminal on our controlling tty. */
10992 terminal
= get_named_tty ("/dev/tty");
10995 /* If there are no frames there, let's pretend that we are a
10996 well-behaving UN*X program and quit. */
10997 Fkill_emacs (Qnil
);
11001 /* Otherwise, the SIGINT was probably generated by C-g. */
11003 /* Set internal_last_event_frame to the top frame of the
11004 controlling tty, if we have a frame there. We disable the
11005 interrupt key on secondary ttys, so the SIGINT must have come
11006 from the controlling tty. */
11007 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
11009 handle_interrupt ();
11015 /* This routine is called at interrupt level in response to C-g.
11017 It is called from the SIGINT handler or kbd_buffer_store_event.
11019 If `waiting_for_input' is non zero, then unless `echoing' is
11020 nonzero, immediately throw back to read_char.
11022 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
11023 eval to throw, when it gets a chance. If quit-flag is already
11024 non-nil, it stops the job right away. */
11027 handle_interrupt ()
11033 /* XXX This code needs to be revised for multi-tty support. */
11034 if (!NILP (Vquit_flag
)
11036 && get_named_tty ("/dev/tty")
11040 /* If SIGINT isn't blocked, don't let us be interrupted by
11041 another SIGINT, it might be harmful due to non-reentrancy
11042 in I/O functions. */
11043 sigblock (sigmask (SIGINT
));
11046 reset_all_sys_modes ();
11048 #ifdef SIGTSTP /* Support possible in later USG versions */
11050 * On systems which can suspend the current process and return to the original
11051 * shell, this command causes the user to end up back at the shell.
11052 * The "Auto-save" and "Abort" questions are not asked until
11053 * the user elects to return to emacs, at which point he can save the current
11054 * job and either dump core or continue.
11059 if (sys_suspend () == -1)
11061 printf ("Not running as a subprocess;\n");
11062 printf ("you can continue or abort.\n");
11064 #else /* not VMS */
11065 /* Perhaps should really fork an inferior shell?
11066 But that would not provide any way to get back
11067 to the original shell, ever. */
11068 printf ("No support for stopping a process on this operating system;\n");
11069 printf ("you can continue or abort.\n");
11070 #endif /* not VMS */
11071 #endif /* not SIGTSTP */
11073 /* We must remain inside the screen area when the internal terminal
11074 is used. Note that [Enter] is not echoed by dos. */
11077 /* It doesn't work to autosave while GC is in progress;
11078 the code used for auto-saving doesn't cope with the mark bit. */
11079 if (!gc_in_progress
)
11081 printf ("Auto-save? (y or n) ");
11083 if (((c
= getchar ()) & ~040) == 'Y')
11085 Fdo_auto_save (Qt
, Qnil
);
11087 printf ("\r\nAuto-save done");
11088 #else /* not MSDOS */
11089 printf ("Auto-save done\n");
11090 #endif /* not MSDOS */
11092 while (c
!= '\n') c
= getchar ();
11096 /* During GC, it must be safe to reenable quitting again. */
11097 Vinhibit_quit
= Qnil
;
11100 #endif /* not MSDOS */
11101 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11102 printf ("but will instead do a real quit after garbage collection ends\r\n");
11107 printf ("\r\nAbort? (y or n) ");
11108 #else /* not MSDOS */
11110 printf ("Abort (and enter debugger)? (y or n) ");
11111 #else /* not VMS */
11112 printf ("Abort (and dump core)? (y or n) ");
11113 #endif /* not VMS */
11114 #endif /* not MSDOS */
11116 if (((c
= getchar ()) & ~040) == 'Y')
11118 while (c
!= '\n') c
= getchar ();
11120 printf ("\r\nContinuing...\r\n");
11121 #else /* not MSDOS */
11122 printf ("Continuing...\n");
11123 #endif /* not MSDOS */
11125 init_all_sys_modes ();
11130 /* If executing a function that wants to be interrupted out of
11131 and the user has not deferred quitting by binding `inhibit-quit'
11132 then quit right away. */
11133 if (immediate_quit
&& NILP (Vinhibit_quit
))
11135 struct gl_state_s saved
;
11136 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11138 immediate_quit
= 0;
11141 GCPRO4 (saved
.object
, saved
.global_code
,
11142 saved
.current_syntax_table
, saved
.old_prop
);
11143 Fsignal (Qquit
, Qnil
);
11148 /* Else request quit when it's safe */
11152 if (waiting_for_input
&& !echoing
)
11153 quit_throw_to_read_char ();
11156 /* Handle a C-g by making read_char return C-g. */
11159 quit_throw_to_read_char ()
11162 /* Prevent another signal from doing this before we finish. */
11163 clear_waiting_for_input ();
11166 Vunread_command_events
= Qnil
;
11167 unread_command_char
= -1;
11169 #if 0 /* Currently, sit_for is called from read_char without turning
11170 off polling. And that can call set_waiting_for_input.
11171 It seems to be harmless. */
11172 #ifdef POLL_FOR_INPUT
11173 /* May be > 1 if in recursive minibuffer. */
11174 if (poll_suppress_count
== 0)
11178 if (FRAMEP (internal_last_event_frame
)
11179 && !EQ (internal_last_event_frame
, selected_frame
))
11180 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11183 _longjmp (getcjmp
, 1);
11186 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11187 doc
: /* Set interrupt mode of reading keyboard input.
11188 If INTERRUPT is non-nil, Emacs will use input interrupts;
11189 otherwise Emacs uses CBREAK mode.
11191 See also `current-input-mode'. */)
11193 Lisp_Object interrupt
;
11195 int new_interrupt_input
;
11197 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11198 #ifdef HAVE_X_WINDOWS
11199 if (x_display_list
!= NULL
)
11201 /* When using X, don't give the user a real choice,
11202 because we haven't implemented the mechanisms to support it. */
11203 #ifdef NO_SOCK_SIGIO
11204 new_interrupt_input
= 0;
11205 #else /* not NO_SOCK_SIGIO */
11206 new_interrupt_input
= 1;
11207 #endif /* NO_SOCK_SIGIO */
11211 new_interrupt_input
= !NILP (interrupt
);
11212 #else /* not SIGIO */
11213 new_interrupt_input
= 0;
11214 #endif /* not SIGIO */
11216 /* Our VMS input only works by interrupts, as of now. */
11218 new_interrupt_input
= 1;
11221 if (new_interrupt_input
!= interrupt_input
)
11223 #ifdef POLL_FOR_INPUT
11227 /* this causes startup screen to be restored and messes with the mouse */
11228 reset_all_sys_modes ();
11230 interrupt_input
= new_interrupt_input
;
11232 init_all_sys_modes ();
11235 #ifdef POLL_FOR_INPUT
11236 poll_suppress_count
= 1;
11243 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11244 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11245 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11246 C-q in key sequences.
11248 This setting only has an effect on tty terminals and only when
11249 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11251 See also `current-input-mode'. */)
11253 Lisp_Object flow
, terminal
;
11255 struct terminal
*t
= get_terminal (terminal
, 1);
11256 struct tty_display_info
*tty
;
11257 if (t
== NULL
|| t
->type
!= output_termcap
)
11259 tty
= t
->display_info
.tty
;
11261 if (tty
->flow_control
!= !NILP (flow
))
11264 /* this causes startup screen to be restored and messes with the mouse */
11265 reset_sys_modes (tty
);
11268 tty
->flow_control
= !NILP (flow
);
11271 init_sys_modes (tty
);
11277 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11278 doc
: /* Enable or disable 8-bit input on TERMINAL.
11279 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11280 bit as the Meta modifier.
11282 If META is nil, Emacs will ignore the top bit, on the assumption it is
11285 Otherwise, Emacs will accept and pass through 8-bit input without
11286 specially interpreting the top bit.
11288 This setting only has an effect on tty terminal devices.
11290 Optional parameter TERMINAL specifies the tty terminal device to use.
11291 It may be a terminal id, a frame, or nil for the terminal used by the
11292 currently selected frame.
11294 See also `current-input-mode'. */)
11296 Lisp_Object meta
, terminal
;
11298 struct terminal
*t
= get_terminal (terminal
, 1);
11299 struct tty_display_info
*tty
;
11302 if (t
== NULL
|| t
->type
!= output_termcap
)
11304 tty
= t
->display_info
.tty
;
11308 else if (EQ (meta
, Qt
))
11313 if (tty
->meta_key
!= new_meta
)
11316 /* this causes startup screen to be restored and messes with the mouse */
11317 reset_sys_modes (tty
);
11320 tty
->meta_key
= new_meta
;
11323 init_sys_modes (tty
);
11329 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11330 doc
: /* Specify character used for quitting.
11331 QUIT must be an ASCII character.
11333 This function only has an effect on the controlling tty of the Emacs
11336 See also `current-input-mode'. */)
11340 struct terminal
*t
= get_named_tty ("/dev/tty");
11341 struct tty_display_info
*tty
;
11342 if (t
== NULL
|| t
->type
!= output_termcap
)
11344 tty
= t
->display_info
.tty
;
11346 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11347 error ("QUIT must be an ASCII character");
11350 /* this causes startup screen to be restored and messes with the mouse */
11351 reset_sys_modes (tty
);
11354 /* Don't let this value be out of range. */
11355 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11358 init_sys_modes (tty
);
11364 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11365 doc
: /* Set mode of reading keyboard input.
11366 First arg INTERRUPT non-nil means use input interrupts;
11367 nil means use CBREAK mode.
11368 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11369 (no effect except in CBREAK mode).
11370 Third arg META t means accept 8-bit input (for a Meta key).
11371 META nil means ignore the top bit, on the assumption it is parity.
11372 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11373 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11374 See also `current-input-mode'. */)
11375 (interrupt
, flow
, meta
, quit
)
11376 Lisp_Object interrupt
, flow
, meta
, quit
;
11378 Fset_input_interrupt_mode (interrupt
);
11379 Fset_output_flow_control (flow
, Qnil
);
11380 Fset_input_meta_mode (meta
, Qnil
);
11382 Fset_quit_char (quit
);
11386 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11387 doc
: /* Return information about the way Emacs currently reads keyboard input.
11388 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11389 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11390 nil, Emacs is using CBREAK mode.
11391 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11392 terminal; this does not apply if Emacs uses interrupt-driven input.
11393 META is t if accepting 8-bit input with 8th bit as Meta flag.
11394 META nil means ignoring the top bit, on the assumption it is parity.
11395 META is neither t nor nil if accepting 8-bit input and using
11396 all 8 bits as the character code.
11397 QUIT is the character Emacs currently uses to quit.
11398 The elements of this list correspond to the arguments of
11399 `set-input-mode'. */)
11402 Lisp_Object val
[4];
11403 struct frame
*sf
= XFRAME (selected_frame
);
11405 val
[0] = interrupt_input
? Qt
: Qnil
;
11406 if (FRAME_TERMCAP_P (sf
))
11408 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11409 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11411 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11418 XSETFASTINT (val
[3], quit_char
);
11420 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11423 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11424 doc
: /* Return position information for pixel coordinates X and Y.
11425 By default, X and Y are relative to text area of the selected window.
11426 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11427 If optional fourth arg WHOLE is non-nil, X is relative to the left
11428 edge of the window.
11430 The return value is similar to a mouse click position:
11431 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11432 IMAGE (DX . DY) (WIDTH . HEIGHT))
11433 The `posn-' functions access elements of such lists. */)
11434 (x
, y
, frame_or_window
, whole
)
11435 Lisp_Object x
, y
, frame_or_window
, whole
;
11440 if (NILP (frame_or_window
))
11441 frame_or_window
= selected_window
;
11443 if (WINDOWP (frame_or_window
))
11447 CHECK_LIVE_WINDOW (frame_or_window
);
11449 w
= XWINDOW (frame_or_window
);
11450 XSETINT (x
, (XINT (x
)
11451 + WINDOW_LEFT_EDGE_X (w
)
11453 ? window_box_left_offset (w
, TEXT_AREA
)
11455 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11456 frame_or_window
= w
->frame
;
11459 CHECK_LIVE_FRAME (frame_or_window
);
11461 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11464 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11465 doc
: /* Return position information for buffer POS in WINDOW.
11466 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11468 Return nil if position is not visible in window. Otherwise,
11469 the return value is similar to that returned by `event-start' for
11470 a mouse click at the upper left corner of the glyph corresponding
11471 to the given buffer position:
11472 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11473 IMAGE (DX . DY) (WIDTH . HEIGHT))
11474 The `posn-' functions access elements of such lists. */)
11476 Lisp_Object pos
, window
;
11481 window
= selected_window
;
11483 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11486 Lisp_Object x
= XCAR (tem
);
11487 Lisp_Object y
= XCAR (XCDR (tem
));
11489 /* Point invisible due to hscrolling? */
11492 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11500 * Set up a new kboard object with reasonable initial values.
11506 kb
->Voverriding_terminal_local_map
= Qnil
;
11507 kb
->Vlast_command
= Qnil
;
11508 kb
->Vreal_last_command
= Qnil
;
11509 kb
->Vkeyboard_translate_table
= Qnil
;
11510 kb
->Vlast_repeatable_command
= Qnil
;
11511 kb
->Vprefix_arg
= Qnil
;
11512 kb
->Vlast_prefix_arg
= Qnil
;
11513 kb
->kbd_queue
= Qnil
;
11514 kb
->kbd_queue_has_data
= 0;
11515 kb
->immediate_echo
= 0;
11516 kb
->echo_string
= Qnil
;
11517 kb
->echo_after_prompt
= -1;
11518 kb
->kbd_macro_buffer
= 0;
11519 kb
->kbd_macro_bufsize
= 0;
11520 kb
->defining_kbd_macro
= Qnil
;
11521 kb
->Vlast_kbd_macro
= Qnil
;
11522 kb
->reference_count
= 0;
11523 kb
->Vsystem_key_alist
= Qnil
;
11524 kb
->system_key_syms
= Qnil
;
11525 kb
->Vwindow_system
= Qt
; /* Unset. */
11526 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11527 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11528 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11529 kb
->Vdefault_minibuffer_frame
= Qnil
;
11533 * Destroy the contents of a kboard object, but not the object itself.
11534 * We use this just before deleting it, or if we're going to initialize
11535 * it a second time.
11541 xfree (kb
->kbd_macro_buffer
);
11544 #ifdef MULTI_KBOARD
11546 /* Free KB and memory referenced from it. */
11554 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11557 *kbp
= kb
->next_kboard
;
11559 /* Prevent a dangling reference to KB. */
11560 if (kb
== current_kboard
11561 && FRAMEP (selected_frame
)
11562 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11564 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11566 if (current_kboard
== kb
)
11574 #endif /* MULTI_KBOARD */
11579 /* This is correct before outermost invocation of the editor loop */
11580 command_loop_level
= -1;
11581 immediate_quit
= 0;
11582 quit_char
= Ctl ('g');
11583 Vunread_command_events
= Qnil
;
11584 unread_command_char
= -1;
11585 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11587 recent_keys_index
= 0;
11588 kbd_fetch_ptr
= kbd_buffer
;
11589 kbd_store_ptr
= kbd_buffer
;
11590 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11591 do_mouse_tracking
= Qnil
;
11594 interrupt_input_blocked
= 0;
11595 interrupt_input_pending
= 0;
11597 /* This means that command_loop_1 won't try to select anything the first
11599 internal_last_event_frame
= Qnil
;
11600 Vlast_event_frame
= internal_last_event_frame
;
11602 #ifdef MULTI_KBOARD
11603 current_kboard
= initial_kboard
;
11605 /* Re-initialize the keyboard again. */
11606 wipe_kboard (current_kboard
);
11607 init_kboard (current_kboard
);
11608 /* A value of nil for Vwindow_system normally means a tty, but we also use
11609 it for the initial terminal since there is no window system there. */
11610 current_kboard
->Vwindow_system
= Qnil
;
11612 if (!noninteractive
)
11614 /* Before multi-tty support, these handlers used to be installed
11615 only if the current session was a tty session. Now an Emacs
11616 session may have multiple display types, so we always handle
11617 SIGINT. There is special code in interrupt_signal to exit
11618 Emacs on SIGINT when there are no termcap frames on the
11619 controlling terminal. */
11620 signal (SIGINT
, interrupt_signal
);
11621 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11622 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11623 SIGQUIT and we can't tell which one it will give us. */
11624 signal (SIGQUIT
, interrupt_signal
);
11625 #endif /* HAVE_TERMIO */
11627 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11629 if (!noninteractive
)
11630 signal (SIGIO
, input_available_signal
);
11633 /* Use interrupt input by default, if it works and noninterrupt input
11634 has deficiencies. */
11636 #ifdef INTERRUPT_INPUT
11637 interrupt_input
= 1;
11639 interrupt_input
= 0;
11642 /* Our VMS input only works by interrupts, as of now. */
11644 interrupt_input
= 1;
11650 if (keyboard_init_hook
)
11651 (*keyboard_init_hook
) ();
11653 #ifdef POLL_FOR_INPUT
11654 poll_suppress_count
= 1;
11659 /* This type's only use is in syms_of_keyboard, to initialize the
11660 event header symbols and put properties on them. */
11661 struct event_head
{
11667 struct event_head head_table
[] = {
11668 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11669 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11670 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11671 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11672 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11673 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11674 /* `select-window' should be handled just like `switch-frame'
11675 in read_key_sequence. */
11676 {&Qselect_window
, "select-window", &Qswitch_frame
}
11680 syms_of_keyboard ()
11682 pending_funcalls
= Qnil
;
11684 Vlispy_mouse_stem
= build_string ("mouse");
11685 staticpro (&Vlispy_mouse_stem
);
11688 QCimage
= intern (":image");
11689 staticpro (&QCimage
);
11691 staticpro (&Qhelp_echo
);
11692 Qhelp_echo
= intern ("help-echo");
11695 Qrtl
= intern (":rtl");
11697 staticpro (&item_properties
);
11698 item_properties
= Qnil
;
11700 staticpro (&tool_bar_item_properties
);
11701 tool_bar_item_properties
= Qnil
;
11702 staticpro (&tool_bar_items_vector
);
11703 tool_bar_items_vector
= Qnil
;
11705 staticpro (&real_this_command
);
11706 real_this_command
= Qnil
;
11708 Qtimer_event_handler
= intern ("timer-event-handler");
11709 staticpro (&Qtimer_event_handler
);
11711 Qdisabled_command_function
= intern ("disabled-command-function");
11712 staticpro (&Qdisabled_command_function
);
11714 Qself_insert_command
= intern ("self-insert-command");
11715 staticpro (&Qself_insert_command
);
11717 Qforward_char
= intern ("forward-char");
11718 staticpro (&Qforward_char
);
11720 Qbackward_char
= intern ("backward-char");
11721 staticpro (&Qbackward_char
);
11723 Qdisabled
= intern ("disabled");
11724 staticpro (&Qdisabled
);
11726 Qundefined
= intern ("undefined");
11727 staticpro (&Qundefined
);
11729 Qpre_command_hook
= intern ("pre-command-hook");
11730 staticpro (&Qpre_command_hook
);
11732 Qpost_command_hook
= intern ("post-command-hook");
11733 staticpro (&Qpost_command_hook
);
11735 Qdeferred_action_function
= intern ("deferred-action-function");
11736 staticpro (&Qdeferred_action_function
);
11738 Qcommand_hook_internal
= intern ("command-hook-internal");
11739 staticpro (&Qcommand_hook_internal
);
11741 Qfunction_key
= intern ("function-key");
11742 staticpro (&Qfunction_key
);
11743 Qmouse_click
= intern ("mouse-click");
11744 staticpro (&Qmouse_click
);
11745 #if defined (WINDOWSNT)
11746 Qlanguage_change
= intern ("language-change");
11747 staticpro (&Qlanguage_change
);
11749 Qdrag_n_drop
= intern ("drag-n-drop");
11750 staticpro (&Qdrag_n_drop
);
11752 Qsave_session
= intern ("save-session");
11753 staticpro (&Qsave_session
);
11756 Qdbus_event
= intern ("dbus-event");
11757 staticpro (&Qdbus_event
);
11760 Qmenu_enable
= intern ("menu-enable");
11761 staticpro (&Qmenu_enable
);
11762 Qmenu_alias
= intern ("menu-alias");
11763 staticpro (&Qmenu_alias
);
11764 QCenable
= intern (":enable");
11765 staticpro (&QCenable
);
11766 QCvisible
= intern (":visible");
11767 staticpro (&QCvisible
);
11768 QChelp
= intern (":help");
11769 staticpro (&QChelp
);
11770 QCfilter
= intern (":filter");
11771 staticpro (&QCfilter
);
11772 QCbutton
= intern (":button");
11773 staticpro (&QCbutton
);
11774 QCkeys
= intern (":keys");
11775 staticpro (&QCkeys
);
11776 QCkey_sequence
= intern (":key-sequence");
11777 staticpro (&QCkey_sequence
);
11778 QCtoggle
= intern (":toggle");
11779 staticpro (&QCtoggle
);
11780 QCradio
= intern (":radio");
11781 staticpro (&QCradio
);
11783 Qmode_line
= intern ("mode-line");
11784 staticpro (&Qmode_line
);
11785 Qvertical_line
= intern ("vertical-line");
11786 staticpro (&Qvertical_line
);
11787 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11788 staticpro (&Qvertical_scroll_bar
);
11789 Qmenu_bar
= intern ("menu-bar");
11790 staticpro (&Qmenu_bar
);
11792 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11793 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11794 staticpro (&Qmouse_fixup_help_message
);
11797 Qabove_handle
= intern ("above-handle");
11798 staticpro (&Qabove_handle
);
11799 Qhandle
= intern ("handle");
11800 staticpro (&Qhandle
);
11801 Qbelow_handle
= intern ("below-handle");
11802 staticpro (&Qbelow_handle
);
11803 Qup
= intern ("up");
11805 Qdown
= intern ("down");
11806 staticpro (&Qdown
);
11807 Qtop
= intern ("top");
11809 Qbottom
= intern ("bottom");
11810 staticpro (&Qbottom
);
11811 Qend_scroll
= intern ("end-scroll");
11812 staticpro (&Qend_scroll
);
11813 Qratio
= intern ("ratio");
11814 staticpro (&Qratio
);
11816 Qevent_kind
= intern ("event-kind");
11817 staticpro (&Qevent_kind
);
11818 Qevent_symbol_elements
= intern ("event-symbol-elements");
11819 staticpro (&Qevent_symbol_elements
);
11820 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11821 staticpro (&Qevent_symbol_element_mask
);
11822 Qmodifier_cache
= intern ("modifier-cache");
11823 staticpro (&Qmodifier_cache
);
11825 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11826 staticpro (&Qrecompute_lucid_menubar
);
11827 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11828 staticpro (&Qactivate_menubar_hook
);
11830 Qpolling_period
= intern ("polling-period");
11831 staticpro (&Qpolling_period
);
11833 Qinput_method_function
= intern ("input-method-function");
11834 staticpro (&Qinput_method_function
);
11836 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11837 staticpro (&Qinput_method_exit_on_first_char
);
11838 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11839 staticpro (&Qinput_method_use_echo_area
);
11841 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11842 Fset (Qinput_method_use_echo_area
, Qnil
);
11844 last_point_position_buffer
= Qnil
;
11845 last_point_position_window
= Qnil
;
11848 struct event_head
*p
;
11850 for (p
= head_table
;
11851 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11854 *p
->var
= intern (p
->name
);
11855 staticpro (p
->var
);
11856 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11857 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11861 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11862 staticpro (&button_down_location
);
11863 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11864 staticpro (&mouse_syms
);
11865 wheel_syms
= Fmake_vector (make_number (4), Qnil
);
11866 staticpro (&wheel_syms
);
11870 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11872 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11873 for (i
= 0; i
< len
; i
++)
11874 if (modifier_names
[i
])
11875 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11876 staticpro (&modifier_symbols
);
11879 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11880 staticpro (&recent_keys
);
11882 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11883 staticpro (&this_command_keys
);
11885 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11886 staticpro (&raw_keybuf
);
11888 Qextended_command_history
= intern ("extended-command-history");
11889 Fset (Qextended_command_history
, Qnil
);
11890 staticpro (&Qextended_command_history
);
11892 accent_key_syms
= Qnil
;
11893 staticpro (&accent_key_syms
);
11895 func_key_syms
= Qnil
;
11896 staticpro (&func_key_syms
);
11898 drag_n_drop_syms
= Qnil
;
11899 staticpro (&drag_n_drop_syms
);
11901 unread_switch_frame
= Qnil
;
11902 staticpro (&unread_switch_frame
);
11904 internal_last_event_frame
= Qnil
;
11905 staticpro (&internal_last_event_frame
);
11907 read_key_sequence_cmd
= Qnil
;
11908 staticpro (&read_key_sequence_cmd
);
11910 menu_bar_one_keymap_changed_items
= Qnil
;
11911 staticpro (&menu_bar_one_keymap_changed_items
);
11913 menu_bar_items_vector
= Qnil
;
11914 staticpro (&menu_bar_items_vector
);
11916 help_form_saved_window_configs
= Qnil
;
11917 staticpro (&help_form_saved_window_configs
);
11919 defsubr (&Scurrent_idle_time
);
11920 defsubr (&Sevent_symbol_parse_modifiers
);
11921 defsubr (&Sevent_convert_list
);
11922 defsubr (&Sread_key_sequence
);
11923 defsubr (&Sread_key_sequence_vector
);
11924 defsubr (&Srecursive_edit
);
11925 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11926 defsubr (&Strack_mouse
);
11928 defsubr (&Sinput_pending_p
);
11929 defsubr (&Scommand_execute
);
11930 defsubr (&Srecent_keys
);
11931 defsubr (&Sthis_command_keys
);
11932 defsubr (&Sthis_command_keys_vector
);
11933 defsubr (&Sthis_single_command_keys
);
11934 defsubr (&Sthis_single_command_raw_keys
);
11935 defsubr (&Sreset_this_command_lengths
);
11936 defsubr (&Sclear_this_command_keys
);
11937 defsubr (&Ssuspend_emacs
);
11938 defsubr (&Sabort_recursive_edit
);
11939 defsubr (&Sexit_recursive_edit
);
11940 defsubr (&Srecursion_depth
);
11941 defsubr (&Stop_level
);
11942 defsubr (&Sdiscard_input
);
11943 defsubr (&Sopen_dribble_file
);
11944 defsubr (&Sset_input_interrupt_mode
);
11945 defsubr (&Sset_output_flow_control
);
11946 defsubr (&Sset_input_meta_mode
);
11947 defsubr (&Sset_quit_char
);
11948 defsubr (&Sset_input_mode
);
11949 defsubr (&Scurrent_input_mode
);
11950 defsubr (&Sexecute_extended_command
);
11951 defsubr (&Sposn_at_point
);
11952 defsubr (&Sposn_at_x_y
);
11954 DEFVAR_LISP ("last-command-char", &last_command_char
,
11955 doc
: /* Last input event that was part of a command. */);
11957 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11958 doc
: /* Last input event that was part of a command. */);
11960 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11961 doc
: /* Last input event in a command, except for mouse menu events.
11962 Mouse menus give back keys that don't look like mouse events;
11963 this variable holds the actual mouse event that led to the menu,
11964 so that you can determine whether the command was run by mouse or not. */);
11966 DEFVAR_LISP ("last-input-char", &last_input_char
,
11967 doc
: /* Last input event. */);
11969 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11970 doc
: /* Last input event. */);
11972 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11973 doc
: /* List of events to be read as the command input.
11974 These events are processed first, before actual keyboard input.
11975 Events read from this list are not normally added to `this-command-keys',
11976 as they will already have been added once as they were read for the first time.
11977 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11978 Vunread_command_events
= Qnil
;
11980 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11981 doc
: /* If not -1, an object to be read as next command input event. */);
11983 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11984 doc
: /* List of events to be processed as input by input methods.
11985 These events are processed before `unread-command-events'
11986 and actual keyboard input, but are not given to `input-method-function'. */);
11987 Vunread_post_input_method_events
= Qnil
;
11989 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11990 doc
: /* List of events to be processed as input by input methods.
11991 These events are processed after `unread-command-events', but
11992 before actual keyboard input.
11993 If there's an active input method, the events are given to
11994 `input-method-function'. */);
11995 Vunread_input_method_events
= Qnil
;
11997 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11998 doc
: /* Meta-prefix character code.
11999 Meta-foo as command input turns into this character followed by foo. */);
12000 XSETINT (meta_prefix_char
, 033);
12002 DEFVAR_KBOARD ("last-command", Vlast_command
,
12003 doc
: /* The last command executed.
12004 Normally a symbol with a function definition, but can be whatever was found
12005 in the keymap, or whatever the variable `this-command' was set to by that
12008 The value `mode-exit' is special; it means that the previous command
12009 read an event that told it to exit, and it did so and unread that event.
12010 In other words, the present command is the event that made the previous
12013 The value `kill-region' is special; it means that the previous command
12014 was a kill command.
12016 `last-command' has a separate binding for each terminal device.
12017 See Info node `(elisp)Multiple displays'. */);
12019 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
12020 doc
: /* Same as `last-command', but never altered by Lisp code. */);
12022 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
12023 doc
: /* Last command that may be repeated.
12024 The last command executed that was not bound to an input event.
12025 This is the command `repeat' will try to repeat. */);
12027 DEFVAR_LISP ("this-command", &Vthis_command
,
12028 doc
: /* The command now being executed.
12029 The command can set this variable; whatever is put here
12030 will be in `last-command' during the following command. */);
12031 Vthis_command
= Qnil
;
12033 DEFVAR_LISP ("this-command-keys-shift-translated",
12034 &Vthis_command_keys_shift_translated
,
12035 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
12036 Shift-translation occurs when there is no binding for the key sequence
12037 as entered, but a binding was found by changing an upper-case letter
12038 to lower-case, or a shifted function key to an unshifted one. */);
12039 Vthis_command_keys_shift_translated
= Qnil
;
12041 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
12042 doc
: /* The command bound to the current key sequence before remapping.
12043 It equals `this-command' if the original command was not remapped through
12044 any of the active keymaps. Otherwise, the value of `this-command' is the
12045 result of looking up the original command in the active keymaps. */);
12046 Vthis_original_command
= Qnil
;
12048 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
12049 doc
: /* *Number of input events between auto-saves.
12050 Zero means disable autosaving due to number of characters typed. */);
12051 auto_save_interval
= 300;
12053 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
12054 doc
: /* *Number of seconds idle time before auto-save.
12055 Zero or nil means disable auto-saving due to idleness.
12056 After auto-saving due to this many seconds of idle time,
12057 Emacs also does a garbage collection if that seems to be warranted. */);
12058 XSETFASTINT (Vauto_save_timeout
, 30);
12060 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
12061 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
12062 The value may be integer or floating point. */);
12063 Vecho_keystrokes
= make_number (1);
12065 DEFVAR_INT ("polling-period", &polling_period
,
12066 doc
: /* *Interval between polling for input during Lisp execution.
12067 The reason for polling is to make C-g work to stop a running program.
12068 Polling is needed only when using X windows and SIGIO does not work.
12069 Polling is automatically disabled in all other cases. */);
12070 polling_period
= 2;
12072 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
12073 doc
: /* *Maximum time between mouse clicks to make a double-click.
12074 Measured in milliseconds. The value nil means disable double-click
12075 recognition; t means double-clicks have no time limit and are detected
12076 by position only. */);
12077 Vdouble_click_time
= make_number (500);
12079 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
12080 doc
: /* *Maximum mouse movement between clicks to make a double-click.
12081 On window-system frames, value is the number of pixels the mouse may have
12082 moved horizontally or vertically between two clicks to make a double-click.
12083 On non window-system frames, value is interpreted in units of 1/8 characters
12086 This variable is also the threshold for motion of the mouse
12087 to count as a drag. */);
12088 double_click_fuzz
= 3;
12090 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
12091 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
12092 inhibit_local_menu_bar_menus
= 0;
12094 DEFVAR_INT ("num-input-keys", &num_input_keys
,
12095 doc
: /* Number of complete key sequences read as input so far.
12096 This includes key sequences read from keyboard macros.
12097 The number is effectively the number of interactive command invocations. */);
12098 num_input_keys
= 0;
12100 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
12101 doc
: /* Number of input events read from the keyboard so far.
12102 This does not include events generated by keyboard macros. */);
12103 num_nonmacro_input_events
= 0;
12105 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
12106 doc
: /* The frame in which the most recently read event occurred.
12107 If the last event came from a keyboard macro, this is set to `macro'. */);
12108 Vlast_event_frame
= Qnil
;
12110 /* This variable is set up in sysdep.c. */
12111 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12112 doc
: /* The ERASE character as set by the user with stty. */);
12114 DEFVAR_LISP ("help-char", &Vhelp_char
,
12115 doc
: /* Character to recognize as meaning Help.
12116 When it is read, do `(eval help-form)', and display result if it's a string.
12117 If the value of `help-form' is nil, this char can be read normally. */);
12118 XSETINT (Vhelp_char
, Ctl ('H'));
12120 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12121 doc
: /* List of input events to recognize as meaning Help.
12122 These work just like the value of `help-char' (see that). */);
12123 Vhelp_event_list
= Qnil
;
12125 DEFVAR_LISP ("help-form", &Vhelp_form
,
12126 doc
: /* Form to execute when character `help-char' is read.
12127 If the form returns a string, that string is displayed.
12128 If `help-form' is nil, the help char is not recognized. */);
12131 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12132 doc
: /* Command to run when `help-char' character follows a prefix key.
12133 This command is used only when there is no actual binding
12134 for that character after that prefix key. */);
12135 Vprefix_help_command
= Qnil
;
12137 DEFVAR_LISP ("top-level", &Vtop_level
,
12138 doc
: /* Form to evaluate when Emacs starts up.
12139 Useful to set before you dump a modified Emacs. */);
12142 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12143 doc
: /* Translate table for local keyboard input, or nil.
12144 If non-nil, the value should be a char-table. Each character read
12145 from the keyboard is looked up in this char-table. If the value found
12146 there is non-nil, then it is used instead of the actual input character.
12148 The value can also be a string or vector, but this is considered obsolete.
12149 If it is a string or vector of length N, character codes N and up are left
12150 untranslated. In a vector, an element which is nil means "no translation".
12152 This is applied to the characters supplied to input methods, not their
12153 output. See also `translation-table-for-input'.
12155 This variable has a separate binding for each terminal. See Info node
12156 `(elisp)Multiple displays'. */);
12158 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12159 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12160 \(Even if the operating system has support for stopping a process.\) */);
12161 cannot_suspend
= 0;
12163 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12164 doc
: /* Non-nil means prompt with menus when appropriate.
12165 This is done when reading from a keymap that has a prompt string,
12166 for elements that have prompt strings.
12167 The menu is displayed on the screen
12168 if X menus were enabled at configuration
12169 time and the previous event was a mouse click prefix key.
12170 Otherwise, menu prompting uses the echo area. */);
12171 menu_prompting
= 1;
12173 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12174 doc
: /* Character to see next line of menu prompt.
12175 Type this character while in a menu prompt to rotate around the lines of it. */);
12176 XSETINT (menu_prompt_more_char
, ' ');
12178 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12179 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12180 Emacs applies the modifiers of the character stored here to each keyboard
12181 character it reads. For example, after evaluating the expression
12182 (setq extra-keyboard-modifiers ?\\C-x)
12183 all input characters will have the control modifier applied to them.
12185 Note that the character ?\\C-@, equivalent to the integer zero, does
12186 not count as a control character; rather, it counts as a character
12187 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12188 cancels any modification. */);
12189 extra_keyboard_modifiers
= 0;
12191 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12192 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12193 The command loop sets this to nil before each command,
12194 and tests the value when the command returns.
12195 Buffer modification stores t in this variable. */);
12196 Vdeactivate_mark
= Qnil
;
12197 Qdeactivate_mark
= intern ("deactivate-mark");
12198 staticpro (&Qdeactivate_mark
);
12200 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12201 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
12202 Vcommand_hook_internal
= Qnil
;
12204 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12205 doc
: /* Normal hook run before each command is executed.
12206 If an unhandled error happens in running this hook,
12207 the hook value is set to nil, since otherwise the error
12208 might happen repeatedly and make Emacs nonfunctional. */);
12209 Vpre_command_hook
= Qnil
;
12211 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12212 doc
: /* Normal hook run after each command is executed.
12213 If an unhandled error happens in running this hook,
12214 the hook value is set to nil, since otherwise the error
12215 might happen repeatedly and make Emacs nonfunctional. */);
12216 Vpost_command_hook
= Qnil
;
12219 DEFVAR_LISP ("echo-area-clear-hook", ...,
12220 doc
: /* Normal hook run when clearing the echo area. */);
12222 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
12223 staticpro (&Qecho_area_clear_hook
);
12224 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
12226 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12227 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12228 Vlucid_menu_bar_dirty_flag
= Qnil
;
12230 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12231 doc
: /* List of menu bar items to move to the end of the menu bar.
12232 The elements of the list are event types that may have menu bar bindings. */);
12233 Vmenu_bar_final_items
= Qnil
;
12235 DEFVAR_KBOARD ("overriding-terminal-local-map",
12236 Voverriding_terminal_local_map
,
12237 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12238 If this variable is non-nil, it is used as a keymap instead of the
12239 buffer's local map, and the minor mode keymaps and text property keymaps.
12240 It also replaces `overriding-local-map'.
12242 This variable is intended to let commands such as `universal-argument'
12243 set up a different keymap for reading the next command.
12245 `overriding-terminal-local-map' has a separate binding for each
12247 See Info node `(elisp)Multiple displays'. */);
12249 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12250 doc
: /* Keymap that overrides all other local keymaps.
12251 If this variable is non-nil, it is used as a keymap--replacing the
12252 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12253 Voverriding_local_map
= Qnil
;
12255 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12256 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12257 Otherwise, the menu bar continues to reflect the buffer's local map
12258 and the minor mode maps regardless of `overriding-local-map'. */);
12259 Voverriding_local_map_menu_flag
= Qnil
;
12261 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12262 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12263 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
12265 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12266 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12268 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12269 doc
: /* Alist of system-specific X windows key symbols.
12270 Each element should have the form (N . SYMBOL) where N is the
12271 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12272 and SYMBOL is its name.
12274 `system-key-alist' has a separate binding for each terminal device.
12275 See Info node `(elisp)Multiple displays'. */);
12277 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12278 doc
: /* Keymap that translates key sequences to key sequences during input.
12279 This is used mainly for mapping key sequences into some preferred
12280 key events (symbols).
12282 The `read-key-sequence' function replaces any subsequence bound by
12283 `local-function-key-map' with its binding. More precisely, when the
12284 active keymaps have no binding for the current key sequence but
12285 `local-function-key-map' binds a suffix of the sequence to a vector or
12286 string, `read-key-sequence' replaces the matching suffix with its
12287 binding, and continues with the new sequence.
12289 If the binding is a function, it is called with one argument (the prompt)
12290 and its return value (a key sequence) is used.
12292 The events that come from bindings in `local-function-key-map' are not
12293 themselves looked up in `local-function-key-map'.
12295 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12296 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12297 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12298 typing `ESC O P x' would return [f1 x].
12300 `local-function-key-map' has a separate binding for each terminal
12301 device. See Info node `(elisp)Multiple displays'. If you need to
12302 define a binding on all terminals, change `function-key-map'
12303 instead. Initially, `local-function-key-map' is an empty keymap that
12304 has `function-key-map' as its parent on all terminal devices. */);
12306 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12307 doc
: /* Keymap that decodes input escape sequences.
12308 This is used mainly for mapping ASCII function key sequences into
12309 real Emacs function key events (symbols).
12311 The `read-key-sequence' function replaces any subsequence bound by
12312 `local-function-key-map' with its binding. Contrary to `function-key-map',
12313 this map applies its rebinding regardless of the presence of an ordinary
12314 binding. So it is more like `key-translation-map' except that it applies
12315 before `function-key-map' rather than after.
12317 If the binding is a function, it is called with one argument (the prompt)
12318 and its return value (a key sequence) is used.
12320 The events that come from bindings in `input-decode-map' are not
12321 themselves looked up in `input-decode-map'.
12323 This variable is keyboard-local. */);
12325 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12326 doc
: /* The parent keymap of all `local-function-key-map' instances.
12327 Function key definitions that apply to all terminal devices should go
12328 here. If a mapping is defined in both the current
12329 `local-function-key-map' binding and this variable, then the local
12330 definition will take precendence. */);
12331 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12333 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12334 doc
: /* Keymap of key translations that can override keymaps.
12335 This keymap works like `function-key-map', but comes after that,
12336 and its non-prefix bindings override ordinary bindings.
12337 Another difference is that it is global rather than keyboard-local. */);
12338 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12340 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12341 doc
: /* List of deferred actions to be performed at a later time.
12342 The precise format isn't relevant here; we just check whether it is nil. */);
12343 Vdeferred_action_list
= Qnil
;
12345 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12346 doc
: /* Function to call to handle deferred actions, after each command.
12347 This function is called with no arguments after each command
12348 whenever `deferred-action-list' is non-nil. */);
12349 Vdeferred_action_function
= Qnil
;
12351 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12352 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12353 The value can be a length of time to show the message for.
12354 If the value is non-nil and not a number, we wait 2 seconds. */);
12355 Vsuggest_key_bindings
= Qt
;
12357 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12358 doc
: /* List of active absolute time timers in order of increasing time. */);
12359 Vtimer_list
= Qnil
;
12361 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12362 doc
: /* List of active idle-time timers in order of increasing time. */);
12363 Vtimer_idle_list
= Qnil
;
12365 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12366 doc
: /* If non-nil, the function that implements the current input method.
12367 It's called with one argument, a printing character that was just read.
12368 \(That means a character with code 040...0176.)
12369 Typically this function uses `read-event' to read additional events.
12370 When it does so, it should first bind `input-method-function' to nil
12371 so it will not be called recursively.
12373 The function should return a list of zero or more events
12374 to be used as input. If it wants to put back some events
12375 to be reconsidered, separately, by the input method,
12376 it can add them to the beginning of `unread-command-events'.
12378 The input method function can find in `input-method-previous-method'
12379 the previous echo area message.
12381 The input method function should refer to the variables
12382 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12383 for guidance on what to do. */);
12384 Vinput_method_function
= Qnil
;
12386 DEFVAR_LISP ("input-method-previous-message",
12387 &Vinput_method_previous_message
,
12388 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12389 This variable exists because `read-event' clears the echo area
12390 before running the input method. It is nil if there was no message. */);
12391 Vinput_method_previous_message
= Qnil
;
12393 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12394 doc
: /* If non-nil, the function that implements the display of help.
12395 It's called with one argument, the help string to display. */);
12396 Vshow_help_function
= Qnil
;
12398 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12399 doc
: /* If non-nil, suppress point adjustment after executing a command.
12401 After a command is executed, if point is moved into a region that has
12402 special properties (e.g. composition, display), we adjust point to
12403 the boundary of the region. But, when a command sets this variable to
12404 non-nil, we suppress the point adjustment.
12406 This variable is set to nil before reading a command, and is checked
12407 just after executing the command. */);
12408 Vdisable_point_adjustment
= Qnil
;
12410 DEFVAR_LISP ("global-disable-point-adjustment",
12411 &Vglobal_disable_point_adjustment
,
12412 doc
: /* *If non-nil, always suppress point adjustment.
12414 The default value is nil, in which case, point adjustment are
12415 suppressed only after special commands that set
12416 `disable-point-adjustment' (which see) to non-nil. */);
12417 Vglobal_disable_point_adjustment
= Qnil
;
12419 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12420 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12421 If the value is not a number, such messages don't time out. */);
12422 Vminibuffer_message_timeout
= make_number (2);
12424 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12425 doc
: /* If non-nil, any keyboard input throws to this symbol.
12426 The value of that variable is passed to `quit-flag' and later causes a
12427 peculiar kind of quitting. */);
12428 Vthrow_on_input
= Qnil
;
12430 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12431 doc
: /* If non-nil, function to output error messages.
12432 The arguments are the error data, a list of the form
12433 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12434 such as just as `condition-case' would bind its variable to,
12435 the context (a string which normally goes at the start of the message),
12436 and the Lisp function within which the error was signaled. */);
12437 Vcommand_error_function
= Qnil
;
12439 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12440 &Venable_disabled_menus_and_buttons
,
12441 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12443 Help functions bind this to allow help on disabled menu items
12444 and tool-bar buttons. */);
12445 Venable_disabled_menus_and_buttons
= Qnil
;
12447 #ifdef MULTI_KBOARD
12448 /* Create the initial keyboard. */
12449 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12450 init_kboard (initial_kboard
);
12451 /* Vwindow_system is left at t for now. */
12452 initial_kboard
->next_kboard
= all_kboards
;
12453 all_kboards
= initial_kboard
;
12458 keys_of_keyboard ()
12460 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12461 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12462 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12463 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12464 initial_define_key (meta_map
, 'x', "execute-extended-command");
12466 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12467 "handle-delete-frame");
12468 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12469 current-prefix-arg, as is done in `handle-switch-frame'.
12470 But `handle-switch-frame is not run from the special-map.
12471 Commands from that map are run in a special way that automatically
12472 preserves the prefix-arg. Restoring the prefix arg here is not just
12473 redundant but harmful:
12475 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12476 - after the first prompt, the exit-minibuffer-hook is run which may
12477 iconify a frame and thus push a `iconify-frame' event.
12478 - after running exit-minibuffer-hook, current-prefix-arg is
12479 restored to the non-nil value it had before the prompt.
12480 - we enter the second prompt.
12481 current-prefix-arg is non-nil, prefix-arg is nil.
12482 - before running the first real event, we run the special iconify-frame
12483 event, but we pass the `special' arg to execute-command so
12484 current-prefix-arg and prefix-arg are left untouched.
12485 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12486 - the next key event will have a spuriously non-nil current-prefix-arg. */
12487 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12489 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12491 /* Handling it at such a low-level causes read_key_sequence to get
12492 * confused because it doesn't realize that the current_buffer was
12493 * changed by read_char.
12495 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12496 * "handle-select-window"); */
12497 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12498 "handle-save-session");
12501 /* Define a special event which is raised for dbus callback
12503 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12504 "dbus-handle-event");
12508 /* Mark the pointers in the kboard objects.
12509 Called by the Fgarbage_collector. */
12515 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12517 if (kb
->kbd_macro_buffer
)
12518 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12520 mark_object (kb
->Voverriding_terminal_local_map
);
12521 mark_object (kb
->Vlast_command
);
12522 mark_object (kb
->Vreal_last_command
);
12523 mark_object (kb
->Vkeyboard_translate_table
);
12524 mark_object (kb
->Vlast_repeatable_command
);
12525 mark_object (kb
->Vprefix_arg
);
12526 mark_object (kb
->Vlast_prefix_arg
);
12527 mark_object (kb
->kbd_queue
);
12528 mark_object (kb
->defining_kbd_macro
);
12529 mark_object (kb
->Vlast_kbd_macro
);
12530 mark_object (kb
->Vsystem_key_alist
);
12531 mark_object (kb
->system_key_syms
);
12532 mark_object (kb
->Vwindow_system
);
12533 mark_object (kb
->Vinput_decode_map
);
12534 mark_object (kb
->Vlocal_function_key_map
);
12535 mark_object (kb
->Vdefault_minibuffer_frame
);
12536 mark_object (kb
->echo_string
);
12539 struct input_event
*event
;
12540 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12542 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12543 event
= kbd_buffer
;
12544 if (event
->kind
!= SELECTION_REQUEST_EVENT
12545 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12547 mark_object (event
->x
);
12548 mark_object (event
->y
);
12550 mark_object (event
->frame_or_window
);
12551 mark_object (event
->arg
);
12556 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12557 (do not change this comment) */