1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009, 2010 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/>. */
29 #include "termhooks.h"
35 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
48 #ifdef HAVE_GTK_AND_PTHREAD
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #include "syssignal.h"
60 #include <sys/types.h>
69 /* This is to get the definitions of the XK_ symbols. */
76 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 volatile int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
91 /* This var should be (interrupt_input_pending || pending_atimers).
92 The QUIT macro checks this instead of interrupt_input_pending and
93 pending_atimers separately, to reduce code size. So, any code that
94 changes interrupt_input_pending or pending_atimers should update
100 #define KBD_BUFFER_SIZE 4096
102 KBOARD
*initial_kboard
;
103 KBOARD
*current_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 /* If non-nil, this is a map that overrides all other local maps. */
250 Lisp_Object Voverriding_local_map
;
252 /* If non-nil, Voverriding_local_map applies to the menu bar. */
253 Lisp_Object Voverriding_local_map_menu_flag
;
255 /* Keymap that defines special misc events that should
256 be processed immediately at a low level. */
257 Lisp_Object Vspecial_event_map
;
259 /* Current depth in recursive edits. */
260 int command_loop_level
;
262 /* Total number of times command_loop has read a key sequence. */
263 EMACS_INT num_input_keys
;
265 /* Last input event read as a command. */
266 Lisp_Object last_command_event
;
268 /* Last input character read as a command, not counting menus
269 reached by the mouse. */
270 Lisp_Object last_nonmenu_event
;
272 /* Last input event read for any purpose. */
273 Lisp_Object last_input_event
;
275 /* If not Qnil, a list of objects to be read as subsequent command input. */
276 Lisp_Object Vunread_command_events
;
278 /* If not Qnil, a list of objects to be read as subsequent command input
279 including input method processing. */
280 Lisp_Object Vunread_input_method_events
;
282 /* If not Qnil, a list of objects to be read as subsequent command input
283 but NOT including input method processing. */
284 Lisp_Object Vunread_post_input_method_events
;
286 /* If not -1, an event to be read as subsequent command input. */
287 EMACS_INT unread_command_char
;
289 /* If not Qnil, this is a switch-frame event which we decided to put
290 off until the end of a key sequence. This should be read as the
291 next command input, after any unread_command_events.
293 read_key_sequence uses this to delay switch-frame events until the
294 end of the key sequence; Fread_char uses it to put off switch-frame
295 events until a non-ASCII event is acceptable as input. */
296 Lisp_Object unread_switch_frame
;
298 /* A mask of extra modifier bits to put into every keyboard char. */
299 EMACS_INT extra_keyboard_modifiers
;
301 /* Char to use as prefix when a meta character is typed in.
302 This is bound on entry to minibuffer in case ESC is changed there. */
304 Lisp_Object meta_prefix_char
;
306 /* Last size recorded for a current buffer which is not a minibuffer. */
307 static int last_non_minibuf_size
;
309 /* Number of idle seconds before an auto-save and garbage collection. */
310 static Lisp_Object Vauto_save_timeout
;
312 /* Total number of times read_char has returned. */
313 int num_input_events
;
315 /* Total number of times read_char has returned, outside of macros. */
316 EMACS_INT num_nonmacro_input_events
;
318 /* Auto-save automatically when this many characters have been typed
319 since the last time. */
321 static EMACS_INT auto_save_interval
;
323 /* Value of num_nonmacro_input_events as of last auto save. */
327 /* The command being executed by the command loop.
328 Commands may set this, and the value set will be copied into
329 current_kboard->Vlast_command instead of the actual command. */
330 Lisp_Object Vthis_command
;
332 /* This is like Vthis_command, except that commands never set it. */
333 Lisp_Object real_this_command
;
335 /* If the lookup of the command returns a binding, the original
336 command is stored in this-original-command. It is nil otherwise. */
337 Lisp_Object Vthis_original_command
;
339 /* The value of point when the last command was started. */
340 int last_point_position
;
342 /* The buffer that was current when the last command was started. */
343 Lisp_Object last_point_position_buffer
;
345 /* The window that was selected when the last command was started. */
346 Lisp_Object last_point_position_window
;
348 /* The frame in which the last input event occurred, or Qmacro if the
349 last event came from a macro. We use this to determine when to
350 generate switch-frame events. This may be cleared by functions
351 like Fselect_frame, to make sure that a switch-frame event is
352 generated by the next character. */
353 Lisp_Object internal_last_event_frame
;
355 /* A user-visible version of the above, intended to allow users to
356 figure out where the last event came from, if the event doesn't
357 carry that information itself (i.e. if it was a character). */
358 Lisp_Object Vlast_event_frame
;
360 /* The timestamp of the last input event we received from the X server.
361 X Windows wants this for selection ownership. */
362 unsigned long last_event_timestamp
;
364 /* If non-nil, active regions automatically become the window selection. */
365 Lisp_Object Vselect_active_regions
;
367 /* The text in the active region prior to modifying the buffer.
368 Used by the `select-active-regions' feature. */
369 Lisp_Object Vsaved_region_selection
;
371 Lisp_Object Qx_set_selection
, QPRIMARY
, Qhandle_switch_frame
;
373 Lisp_Object Qself_insert_command
;
374 Lisp_Object Qforward_char
;
375 Lisp_Object Qbackward_char
;
376 Lisp_Object Qundefined
;
377 Lisp_Object Qtimer_event_handler
;
379 /* read_key_sequence stores here the command definition of the
380 key sequence that it reads. */
381 Lisp_Object read_key_sequence_cmd
;
383 /* Echo unfinished commands after this many seconds of pause. */
384 Lisp_Object Vecho_keystrokes
;
386 /* Form to evaluate (if non-nil) when Emacs is started. */
387 Lisp_Object Vtop_level
;
389 /* If non-nil, this implements the current input method. */
390 Lisp_Object Vinput_method_function
;
391 Lisp_Object Qinput_method_function
;
393 /* When we call Vinput_method_function,
394 this holds the echo area message that was just erased. */
395 Lisp_Object Vinput_method_previous_message
;
397 /* Non-nil means deactivate the mark at end of this command. */
398 Lisp_Object Vdeactivate_mark
;
399 Lisp_Object Qdeactivate_mark
;
401 /* Menu bar specified in Lucid Emacs fashion. */
403 Lisp_Object Vlucid_menu_bar_dirty_flag
;
404 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
406 Lisp_Object Qecho_area_clear_hook
;
408 /* Hooks to run before and after each command. */
409 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
410 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
411 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
413 /* Parent keymap of terminal-local function-key-map instances. */
414 Lisp_Object Vfunction_key_map
;
416 /* Keymap of key translations that can override keymaps. */
417 Lisp_Object Vkey_translation_map
;
419 /* List of deferred actions to be performed at a later time.
420 The precise format isn't relevant here; we just check whether it is nil. */
421 Lisp_Object Vdeferred_action_list
;
423 /* Function to call to handle deferred actions, when there are any. */
424 Lisp_Object Vdeferred_action_function
;
425 Lisp_Object Qdeferred_action_function
;
427 Lisp_Object Qinput_method_exit_on_first_char
;
428 Lisp_Object Qinput_method_use_echo_area
;
430 /* File in which we write all commands we read. */
433 /* Nonzero if input is available. */
436 extern char *pending_malloc_warning
;
438 /* Circular buffer for pre-read keyboard input. */
440 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
442 /* Pointer to next available character in kbd_buffer.
443 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
444 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
445 next available char is in kbd_buffer[0]. */
446 static struct input_event
*kbd_fetch_ptr
;
448 /* Pointer to next place to store character in kbd_buffer. This
449 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
450 character should go in kbd_buffer[0]. */
451 static struct input_event
* volatile kbd_store_ptr
;
453 /* The above pair of variables forms a "queue empty" flag. When we
454 enqueue a non-hook event, we increment kbd_store_ptr. When we
455 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
456 there is input available if the two pointers are not equal.
458 Why not just have a flag set and cleared by the enqueuing and
459 dequeuing functions? Such a flag could be screwed up by interrupts
460 at inopportune times. */
462 /* If this flag is non-nil, we check mouse_moved to see when the
463 mouse moves, and motion events will appear in the input stream.
464 Otherwise, mouse motion is ignored. */
465 Lisp_Object do_mouse_tracking
;
467 /* Symbols to head events. */
468 Lisp_Object Qmouse_movement
;
469 Lisp_Object Qscroll_bar_movement
;
470 Lisp_Object Qswitch_frame
;
471 Lisp_Object Qdelete_frame
;
472 Lisp_Object Qiconify_frame
;
473 Lisp_Object Qmake_frame_visible
;
474 Lisp_Object Qselect_window
;
475 Lisp_Object Qhelp_echo
;
477 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
478 Lisp_Object Qmouse_fixup_help_message
;
481 /* Symbols to denote kinds of events. */
482 Lisp_Object Qfunction_key
;
483 Lisp_Object Qmouse_click
;
484 #if defined (WINDOWSNT)
485 Lisp_Object Qlanguage_change
;
487 Lisp_Object Qdrag_n_drop
;
488 Lisp_Object Qsave_session
;
490 Lisp_Object Qdbus_event
;
492 Lisp_Object Qconfig_changed_event
;
494 /* Lisp_Object Qmouse_movement; - also an event header */
496 /* Properties of event headers. */
497 Lisp_Object Qevent_kind
;
498 Lisp_Object Qevent_symbol_elements
;
500 /* menu item parts */
501 Lisp_Object Qmenu_enable
;
502 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
503 Lisp_Object QCbutton
, QCtoggle
, QCradio
, QClabel
;
505 /* An event header symbol HEAD may have a property named
506 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
507 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
508 mask of modifiers applied to it. If present, this is used to help
509 speed up parse_modifiers. */
510 Lisp_Object Qevent_symbol_element_mask
;
512 /* An unmodified event header BASE may have a property named
513 Qmodifier_cache, which is an alist mapping modifier masks onto
514 modified versions of BASE. If present, this helps speed up
516 Lisp_Object Qmodifier_cache
;
518 /* Symbols to use for parts of windows. */
519 Lisp_Object Qmode_line
;
520 Lisp_Object Qvertical_line
;
521 Lisp_Object Qvertical_scroll_bar
;
522 Lisp_Object Qmenu_bar
;
524 Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
), command_loop (void);
525 Lisp_Object
Fthis_command_keys (void);
526 Lisp_Object Qextended_command_history
;
527 EMACS_TIME
timer_check (int do_it_now
);
529 static void record_menu_key (Lisp_Object c
);
530 static int echo_length (void);
532 Lisp_Object Qpolling_period
;
534 /* List of absolute timers. Appears in order of next scheduled event. */
535 Lisp_Object Vtimer_list
;
537 /* List of idle time timers. Appears in order of next scheduled event. */
538 Lisp_Object Vtimer_idle_list
;
540 /* Incremented whenever a timer is run. */
543 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
545 EMACS_TIME
*input_available_clear_time
;
547 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
548 Default is 1 if INTERRUPT_INPUT is defined. */
551 /* Nonzero while interrupts are temporarily deferred during redisplay. */
552 int interrupts_deferred
;
554 /* Allow m- file to inhibit use of FIONREAD. */
555 #ifdef BROKEN_FIONREAD
559 /* We are unable to use interrupts if FIONREAD is not available,
560 so flush SIGIO so we won't try. */
561 #if !defined (FIONREAD)
567 /* If we support a window system, turn on the code to poll periodically
568 to detect C-g. It isn't actually used when doing interrupt input. */
569 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
570 #define POLL_FOR_INPUT
573 /* After a command is executed, if point is moved into a region that
574 has specific properties (e.g. composition, display), we adjust
575 point to the boundary of the region. But, if a command sets this
576 variable to non-nil, we suppress this point adjustment. This
577 variable is set to nil before reading a command. */
579 Lisp_Object Vdisable_point_adjustment
;
581 /* If non-nil, always disable point adjustment. */
583 Lisp_Object Vglobal_disable_point_adjustment
;
585 /* The time when Emacs started being idle. */
587 static EMACS_TIME timer_idleness_start_time
;
589 /* After Emacs stops being idle, this saves the last value
590 of timer_idleness_start_time from when it was idle. */
592 static EMACS_TIME timer_last_idleness_start_time
;
594 /* If non-nil, events produced by disabled menu items and tool-bar
595 buttons are not ignored. Help functions bind this to allow help on
596 those items and buttons. */
597 Lisp_Object Venable_disabled_menus_and_buttons
;
600 /* Global variable declarations. */
602 /* Flags for readable_events. */
603 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
604 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
605 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
607 /* Function for init_keyboard to call with no args (if nonzero). */
608 void (*keyboard_init_hook
) (void);
610 static int read_avail_input (int);
611 static void get_input_pending (int *, int);
612 static int readable_events (int);
613 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
615 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
617 static Lisp_Object
make_lispy_event (struct input_event
*);
618 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
619 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
620 enum scroll_bar_part
,
621 Lisp_Object
, Lisp_Object
,
624 static Lisp_Object
modify_event_symbol (int, unsigned, Lisp_Object
,
625 Lisp_Object
, const char **,
626 Lisp_Object
*, unsigned);
627 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
628 static void save_getcjmp (jmp_buf);
629 static void restore_getcjmp (jmp_buf);
630 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
631 static void clear_event (struct input_event
*);
632 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
633 static SIGTYPE
interrupt_signal (int signalnum
);
635 static SIGTYPE
input_available_signal (int signo
);
637 static void handle_interrupt (void);
638 static void timer_start_idle (void);
639 static void timer_stop_idle (void);
640 static void timer_resume_idle (void);
641 static SIGTYPE
handle_user_signal (int);
642 static char *find_user_signal_name (int);
643 static int store_user_signal_events (void);
645 /* Nonzero means don't try to suspend even if the operating system seems
647 static int cannot_suspend
;
650 /* Install the string STR as the beginning of the string of echoing,
651 so that it serves as a prompt for the next character.
652 Also start echoing. */
655 echo_prompt (Lisp_Object str
)
657 current_kboard
->echo_string
= str
;
658 current_kboard
->echo_after_prompt
= SCHARS (str
);
662 /* Add C to the echo string, if echoing is going on.
663 C can be a character, which is printed prettily ("M-C-x" and all that
664 jazz), or a symbol, whose name is printed. */
667 echo_char (Lisp_Object c
)
669 if (current_kboard
->immediate_echo
)
671 int size
= KEY_DESCRIPTION_SIZE
+ 100;
672 char *buffer
= (char *) alloca (size
);
674 Lisp_Object echo_string
;
676 echo_string
= current_kboard
->echo_string
;
678 /* If someone has passed us a composite event, use its head symbol. */
683 ptr
= push_key_description (XINT (c
), ptr
, 1);
685 else if (SYMBOLP (c
))
687 Lisp_Object name
= SYMBOL_NAME (c
);
688 int nbytes
= SBYTES (name
);
690 if (size
- (ptr
- buffer
) < nbytes
)
692 int offset
= ptr
- buffer
;
693 size
= max (2 * size
, size
+ nbytes
);
694 buffer
= (char *) alloca (size
);
695 ptr
= buffer
+ offset
;
698 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
699 STRING_MULTIBYTE (name
), 1);
702 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
705 const char *text
= " (Type ? for further options)";
706 int len
= strlen (text
);
708 if (size
- (ptr
- buffer
) < len
)
710 int offset
= ptr
- buffer
;
712 buffer
= (char *) alloca (size
);
713 ptr
= buffer
+ offset
;
716 memcpy (ptr
, text
, len
);
720 /* Replace a dash from echo_dash with a space, otherwise
721 add a space at the end as a separator between keys. */
722 if (STRINGP (echo_string
)
723 && SCHARS (echo_string
) > 1)
725 Lisp_Object last_char
, prev_char
, idx
;
727 idx
= make_number (SCHARS (echo_string
) - 2);
728 prev_char
= Faref (echo_string
, idx
);
730 idx
= make_number (SCHARS (echo_string
) - 1);
731 last_char
= Faref (echo_string
, idx
);
733 /* We test PREV_CHAR to make sure this isn't the echoing
735 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
736 Faset (echo_string
, idx
, make_number (' '));
738 echo_string
= concat2 (echo_string
, build_string (" "));
740 else if (STRINGP (echo_string
))
741 echo_string
= concat2 (echo_string
, build_string (" "));
743 current_kboard
->echo_string
744 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
750 /* Temporarily add a dash to the end of the echo string if it's not
751 empty, so that it serves as a mini-prompt for the very next character. */
756 /* Do nothing if not echoing at all. */
757 if (NILP (current_kboard
->echo_string
))
760 if (!current_kboard
->immediate_echo
761 && SCHARS (current_kboard
->echo_string
) == 0)
764 /* Do nothing if we just printed a prompt. */
765 if (current_kboard
->echo_after_prompt
766 == SCHARS (current_kboard
->echo_string
))
769 /* Do nothing if we have already put a dash at the end. */
770 if (SCHARS (current_kboard
->echo_string
) > 1)
772 Lisp_Object last_char
, prev_char
, idx
;
774 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
775 prev_char
= Faref (current_kboard
->echo_string
, idx
);
777 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
778 last_char
= Faref (current_kboard
->echo_string
, idx
);
780 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
784 /* Put a dash at the end of the buffer temporarily,
785 but make it go away when the next character is added. */
786 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
791 /* Display the current echo string, and begin echoing if not already
797 if (!current_kboard
->immediate_echo
)
800 current_kboard
->immediate_echo
= 1;
802 for (i
= 0; i
< this_command_key_count
; i
++)
806 /* Set before_command_echo_length to the value that would
807 have been saved before the start of this subcommand in
808 command_loop_1, if we had already been echoing then. */
809 if (i
== this_single_command_key_start
)
810 before_command_echo_length
= echo_length ();
812 c
= XVECTOR (this_command_keys
)->contents
[i
];
813 if (! (EVENT_HAS_PARAMETERS (c
)
814 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
818 /* Set before_command_echo_length to the value that would
819 have been saved before the start of this subcommand in
820 command_loop_1, if we had already been echoing then. */
821 if (this_command_key_count
== this_single_command_key_start
)
822 before_command_echo_length
= echo_length ();
824 /* Put a dash at the end to invite the user to type more. */
829 message3_nolog (current_kboard
->echo_string
,
830 SBYTES (current_kboard
->echo_string
),
831 STRING_MULTIBYTE (current_kboard
->echo_string
));
834 /* Record in what buffer we echoed, and from which kboard. */
835 echo_message_buffer
= echo_area_buffer
[0];
836 echo_kboard
= current_kboard
;
838 if (waiting_for_input
&& !NILP (Vquit_flag
))
839 quit_throw_to_read_char ();
842 /* Turn off echoing, for the start of a new command. */
845 cancel_echoing (void)
847 current_kboard
->immediate_echo
= 0;
848 current_kboard
->echo_after_prompt
= -1;
849 current_kboard
->echo_string
= Qnil
;
850 ok_to_echo_at_next_pause
= NULL
;
852 echo_message_buffer
= Qnil
;
855 /* Return the length of the current echo string. */
860 return (STRINGP (current_kboard
->echo_string
)
861 ? SCHARS (current_kboard
->echo_string
)
865 /* Truncate the current echo message to its first LEN chars.
866 This and echo_char get used by read_key_sequence when the user
867 switches frames while entering a key sequence. */
870 echo_truncate (int nchars
)
872 if (STRINGP (current_kboard
->echo_string
))
873 current_kboard
->echo_string
874 = Fsubstring (current_kboard
->echo_string
,
875 make_number (0), make_number (nchars
));
876 truncate_echo_area (nchars
);
880 /* Functions for manipulating this_command_keys. */
882 add_command_key (Lisp_Object key
)
884 #if 0 /* Not needed after we made Freset_this_command_lengths
885 do the job immediately. */
886 /* If reset-this-command-length was called recently, obey it now.
887 See the doc string of that function for an explanation of why. */
888 if (before_command_restore_flag
)
890 this_command_key_count
= before_command_key_count_1
;
891 if (this_command_key_count
< this_single_command_key_start
)
892 this_single_command_key_start
= this_command_key_count
;
893 echo_truncate (before_command_echo_length_1
);
894 before_command_restore_flag
= 0;
898 if (this_command_key_count
>= ASIZE (this_command_keys
))
899 this_command_keys
= larger_vector (this_command_keys
,
900 2 * ASIZE (this_command_keys
),
903 ASET (this_command_keys
, this_command_key_count
, key
);
904 ++this_command_key_count
;
909 recursive_edit_1 (void)
911 int count
= SPECPDL_INDEX ();
914 if (command_loop_level
> 0)
916 specbind (Qstandard_output
, Qt
);
917 specbind (Qstandard_input
, Qt
);
920 #ifdef HAVE_WINDOW_SYSTEM
921 /* The command loop has started an hourglass timer, so we have to
922 cancel it here, otherwise it will fire because the recursive edit
923 can take some time. Do not check for display_hourglass_p here,
924 because it could already be nil. */
928 /* This function may have been called from a debugger called from
929 within redisplay, for instance by Edebugging a function called
930 from fontification-functions. We want to allow redisplay in
931 the debugging session.
933 The recursive edit is left with a `(throw exit ...)'. The `exit'
934 tag is not caught anywhere in redisplay, i.e. when we leave the
935 recursive edit, the original redisplay leading to the recursive
936 edit will be unwound. The outcome should therefore be safe. */
937 specbind (Qinhibit_redisplay
, Qnil
);
940 val
= command_loop ();
942 Fsignal (Qquit
, Qnil
);
943 /* Handle throw from read_minibuf when using minibuffer
944 while it's active but we're in another window. */
946 xsignal1 (Qerror
, val
);
948 return unbind_to (count
, Qnil
);
951 /* When an auto-save happens, record the "time", and don't do again soon. */
954 record_auto_save (void)
956 last_auto_save
= num_nonmacro_input_events
;
959 /* Make an auto save happen as soon as possible at command level. */
962 force_auto_save_soon (void)
964 last_auto_save
= - auto_save_interval
- 1;
966 record_asynch_buffer_change ();
969 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
970 doc
: /* Invoke the editor command loop recursively.
971 To get out of the recursive edit, a command can do `(throw 'exit nil)';
972 that tells this function to return.
973 Alternatively, `(throw 'exit t)' makes this function signal an error.
974 This function is called by the editor initialization to begin editing. */)
977 int count
= SPECPDL_INDEX ();
980 /* If we enter while input is blocked, don't lock up here.
981 This may happen through the debugger during redisplay. */
985 command_loop_level
++;
986 update_mode_lines
= 1;
988 if (command_loop_level
989 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
990 buffer
= Fcurrent_buffer ();
994 /* If we leave recursive_edit_1 below with a `throw' for instance,
995 like it is done in the splash screen display, we have to
996 make sure that we restore single_kboard as command_loop_1
997 would have done if it were left normally. */
998 if (command_loop_level
> 0)
999 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1000 record_unwind_protect (recursive_edit_unwind
, buffer
);
1002 recursive_edit_1 ();
1003 return unbind_to (count
, Qnil
);
1007 recursive_edit_unwind (Lisp_Object buffer
)
1009 if (BUFFERP (buffer
))
1010 Fset_buffer (buffer
);
1012 command_loop_level
--;
1013 update_mode_lines
= 1;
1018 #if 0 /* These two functions are now replaced with
1019 temporarily_switch_to_single_kboard. */
1023 #if 0 /* Theory: if there's anything in Vunread_command_events,
1024 it will right away be read by read_key_sequence,
1025 and then if we do switch KBOARDS, it will go into the side
1026 queue then. So we don't need to do anything special here -- rms. */
1027 if (CONSP (Vunread_command_events
))
1029 current_kboard
->kbd_queue
1030 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1031 current_kboard
->kbd_queue_has_data
= 1;
1033 Vunread_command_events
= Qnil
;
1038 /* Switch to the single-kboard state, making current_kboard
1039 the only KBOARD from which further input is accepted. */
1042 single_kboard_state ()
1048 /* If we're in single_kboard state for kboard KBOARD,
1052 not_single_kboard_state (KBOARD
*kboard
)
1054 if (kboard
== current_kboard
)
1058 /* Maintain a stack of kboards, so other parts of Emacs
1059 can switch temporarily to the kboard of a given frame
1060 and then revert to the previous status. */
1065 struct kboard_stack
*next
;
1068 static struct kboard_stack
*kboard_stack
;
1071 push_kboard (struct kboard
*k
)
1073 struct kboard_stack
*p
1074 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1076 p
->next
= kboard_stack
;
1077 p
->kboard
= current_kboard
;
1087 struct kboard_stack
*p
= kboard_stack
;
1089 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1091 if (t
->kboard
== p
->kboard
)
1093 current_kboard
= p
->kboard
;
1100 /* The terminal we remembered has been deleted. */
1101 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1104 kboard_stack
= p
->next
;
1108 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1109 from which further input is accepted. If F is non-nil, set its
1110 KBOARD as the current keyboard.
1112 This function uses record_unwind_protect to return to the previous
1115 If Emacs is already in single_kboard mode, and F's keyboard is
1116 locked, then this function will throw an errow. */
1119 temporarily_switch_to_single_kboard (struct frame
*f
)
1121 int was_locked
= single_kboard
;
1124 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1125 /* We can not switch keyboards while in single_kboard mode.
1126 In rare cases, Lisp code may call `recursive-edit' (or
1127 `read-minibuffer' or `y-or-n-p') after it switched to a
1128 locked frame. For example, this is likely to happen
1129 when server.el connects to a new terminal while Emacs is in
1130 single_kboard mode. It is best to throw an error instead
1131 of presenting the user with a frozen screen. */
1132 error ("Terminal %d is locked, cannot read from it",
1133 FRAME_TERMINAL (f
)->id
);
1135 /* This call is unnecessary, but helps
1136 `restore_kboard_configuration' discover if somebody changed
1137 `current_kboard' behind our back. */
1138 push_kboard (current_kboard
);
1141 current_kboard
= FRAME_KBOARD (f
);
1143 record_unwind_protect (restore_kboard_configuration
,
1144 (was_locked
? Qt
: Qnil
));
1147 #if 0 /* This function is not needed anymore. */
1149 record_single_kboard_state ()
1152 push_kboard (current_kboard
);
1153 record_unwind_protect (restore_kboard_configuration
,
1154 (single_kboard
? Qt
: Qnil
));
1159 restore_kboard_configuration (Lisp_Object was_locked
)
1161 if (NILP (was_locked
))
1165 struct kboard
*prev
= current_kboard
;
1168 /* The pop should not change the kboard. */
1169 if (single_kboard
&& current_kboard
!= prev
)
1176 /* Handle errors that are not handled at inner levels
1177 by printing an error message and returning to the editor command loop. */
1180 cmd_error (Lisp_Object data
)
1182 Lisp_Object old_level
, old_length
;
1183 char macroerror
[50];
1185 #ifdef HAVE_WINDOW_SYSTEM
1186 if (display_hourglass_p
)
1187 cancel_hourglass ();
1190 if (!NILP (executing_kbd_macro
))
1192 if (executing_kbd_macro_iterations
== 1)
1193 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1195 sprintf (macroerror
, "After %d kbd macro iterations: ",
1196 executing_kbd_macro_iterations
);
1201 Vstandard_output
= Qt
;
1202 Vstandard_input
= Qt
;
1203 Vexecuting_kbd_macro
= Qnil
;
1204 executing_kbd_macro
= Qnil
;
1205 current_kboard
->Vprefix_arg
= Qnil
;
1206 current_kboard
->Vlast_prefix_arg
= Qnil
;
1209 /* Avoid unquittable loop if data contains a circular list. */
1210 old_level
= Vprint_level
;
1211 old_length
= Vprint_length
;
1212 XSETFASTINT (Vprint_level
, 10);
1213 XSETFASTINT (Vprint_length
, 10);
1214 cmd_error_internal (data
, macroerror
);
1215 Vprint_level
= old_level
;
1216 Vprint_length
= old_length
;
1220 Vinhibit_quit
= Qnil
;
1221 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1222 if (command_loop_level
== 0 && minibuf_level
== 0)
1223 any_kboard_state ();
1226 return make_number (0);
1229 /* Take actions on handling an error. DATA is the data that describes
1232 CONTEXT is a C-string containing ASCII characters only which
1233 describes the context in which the error happened. If we need to
1234 generalize CONTEXT to allow multibyte characters, make it a Lisp
1238 cmd_error_internal (Lisp_Object data
, const char *context
)
1240 struct frame
*sf
= SELECTED_FRAME ();
1242 /* The immediate context is not interesting for Quits,
1243 since they are asyncronous. */
1244 if (EQ (XCAR (data
), Qquit
))
1245 Vsignaling_function
= Qnil
;
1250 /* Use user's specified output function if any. */
1251 if (!NILP (Vcommand_error_function
))
1252 call3 (Vcommand_error_function
, data
,
1253 context
? build_string (context
) : empty_unibyte_string
,
1254 Vsignaling_function
);
1255 /* If the window system or terminal frame hasn't been initialized
1256 yet, or we're not interactive, write the message to stderr and exit. */
1257 else if (!sf
->glyphs_initialized_p
1258 /* The initial frame is a special non-displaying frame. It
1259 will be current in daemon mode when there are no frames
1260 to display, and in non-daemon mode before the real frame
1261 has finished initializing. If an error is thrown in the
1262 latter case while creating the frame, then the frame
1263 will never be displayed, so the safest thing to do is
1264 write to stderr and quit. In daemon mode, there are
1265 many other potential errors that do not prevent frames
1266 from being created, so continuing as normal is better in
1268 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1271 print_error_message (data
, Qexternal_debugging_output
,
1272 context
, Vsignaling_function
);
1273 Fterpri (Qexternal_debugging_output
);
1274 Fkill_emacs (make_number (-1));
1278 clear_message (1, 0);
1280 message_log_maybe_newline ();
1283 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1286 Vsignaling_function
= Qnil
;
1289 Lisp_Object
command_loop_1 (void);
1290 Lisp_Object
command_loop_2 (Lisp_Object
);
1291 Lisp_Object
top_level_1 (Lisp_Object
);
1293 /* Entry to editor-command-loop.
1294 This level has the catches for exiting/returning to editor command loop.
1295 It returns nil to exit recursive edit, t to abort it. */
1300 if (command_loop_level
> 0 || minibuf_level
> 0)
1303 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1304 executing_kbd_macro
= Qnil
;
1310 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1311 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1312 /* Reset single_kboard in case top-level set it while
1313 evaluating an -f option, or we are stuck there for some
1315 any_kboard_state ();
1317 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1318 executing_kbd_macro
= Qnil
;
1320 /* End of file in -batch run causes exit here. */
1326 /* Here we catch errors in execution of commands within the
1327 editing loop, and reenter the editing loop.
1328 When there is an error, cmd_error runs and returns a non-nil
1329 value to us. A value of nil means that command_loop_1 itself
1330 returned due to end of file (or end of kbd macro). */
1333 command_loop_2 (Lisp_Object ignore
)
1335 register Lisp_Object val
;
1338 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1339 while (!NILP (val
));
1347 return Feval (Vtop_level
);
1351 top_level_1 (Lisp_Object ignore
)
1353 /* On entry to the outer level, run the startup file */
1354 if (!NILP (Vtop_level
))
1355 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1356 else if (!NILP (Vpurify_flag
))
1357 message ("Bare impure Emacs (standard Lisp code not loaded)");
1359 message ("Bare Emacs (standard Lisp code not loaded)");
1363 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1364 doc
: /* Exit all recursive editing levels.
1365 This also exits all active minibuffers. */)
1368 #ifdef HAVE_WINDOW_SYSTEM
1369 if (display_hourglass_p
)
1370 cancel_hourglass ();
1373 /* Unblock input if we enter with input blocked. This may happen if
1374 redisplay traps e.g. during tool-bar update with input blocked. */
1375 while (INPUT_BLOCKED_P
)
1378 Fthrow (Qtop_level
, Qnil
);
1381 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1382 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1385 if (command_loop_level
> 0 || minibuf_level
> 0)
1386 Fthrow (Qexit
, Qnil
);
1388 error ("No recursive edit is in progress");
1391 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1392 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1395 if (command_loop_level
> 0 || minibuf_level
> 0)
1398 error ("No recursive edit is in progress");
1401 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1403 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1404 of this function. */
1407 tracking_off (Lisp_Object old_value
)
1409 do_mouse_tracking
= old_value
;
1410 if (NILP (old_value
))
1412 /* Redisplay may have been preempted because there was input
1413 available, and it assumes it will be called again after the
1414 input has been processed. If the only input available was
1415 the sort that we have just disabled, then we need to call
1417 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1419 redisplay_preserve_echo_area (6);
1420 get_input_pending (&input_pending
,
1421 READABLE_EVENTS_DO_TIMERS_NOW
);
1427 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1428 doc
: /* Evaluate BODY with mouse movement events enabled.
1429 Within a `track-mouse' form, mouse motion generates input events that
1430 you can read with `read-event'.
1431 Normally, mouse motion is ignored.
1432 usage: (track-mouse BODY...) */)
1435 int count
= SPECPDL_INDEX ();
1438 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1440 do_mouse_tracking
= Qt
;
1442 val
= Fprogn (args
);
1443 return unbind_to (count
, val
);
1446 /* If mouse has moved on some frame, return one of those frames.
1450 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1451 after resizing the tool-bar window. */
1453 int ignore_mouse_drag_p
;
1456 some_mouse_moved (void)
1458 Lisp_Object tail
, frame
;
1460 if (ignore_mouse_drag_p
)
1462 /* ignore_mouse_drag_p = 0; */
1466 FOR_EACH_FRAME (tail
, frame
)
1468 if (XFRAME (frame
)->mouse_moved
)
1469 return XFRAME (frame
);
1475 #endif /* HAVE_MOUSE || HAVE_GPM */
1477 /* This is the actual command reading loop,
1478 sans error-handling encapsulation. */
1480 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1482 void safe_run_hooks (Lisp_Object
);
1483 static void adjust_point_for_property (int, int);
1485 /* Cancel hourglass from protect_unwind.
1487 #ifdef HAVE_WINDOW_SYSTEM
1489 cancel_hourglass_unwind (Lisp_Object arg
)
1491 cancel_hourglass ();
1497 command_loop_1 (void)
1500 Lisp_Object keybuf
[30];
1502 int prev_modiff
= 0;
1503 struct buffer
*prev_buffer
= NULL
;
1504 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1505 int was_locked
= single_kboard
;
1507 int already_adjusted
= 0;
1509 current_kboard
->Vprefix_arg
= Qnil
;
1510 current_kboard
->Vlast_prefix_arg
= Qnil
;
1511 Vdeactivate_mark
= Qnil
;
1512 waiting_for_input
= 0;
1515 this_command_key_count
= 0;
1516 this_command_key_count_reset
= 0;
1517 this_single_command_key_start
= 0;
1519 if (NILP (Vmemory_full
))
1521 /* Make sure this hook runs after commands that get errors and
1522 throw to top level. */
1523 /* Note that the value cell will never directly contain nil
1524 if the symbol is a local variable. */
1525 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1526 safe_run_hooks (Qpost_command_hook
);
1528 /* If displaying a message, resize the echo area window to fit
1529 that message's size exactly. */
1530 if (!NILP (echo_area_buffer
[0]))
1531 resize_echo_area_exactly ();
1533 if (!NILP (Vdeferred_action_list
))
1534 safe_run_hooks (Qdeferred_action_function
);
1537 /* Do this after running Vpost_command_hook, for consistency. */
1538 current_kboard
->Vlast_command
= Vthis_command
;
1539 current_kboard
->Vreal_last_command
= real_this_command
;
1540 if (!CONSP (last_command_event
))
1541 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1545 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1548 /* Make sure the current window's buffer is selected. */
1549 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1550 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1552 /* Display any malloc warning that just came out. Use while because
1553 displaying one warning can cause another. */
1555 while (pending_malloc_warning
)
1556 display_malloc_warning ();
1558 Vdeactivate_mark
= Qnil
;
1560 /* If minibuffer on and echo area in use,
1561 wait a short time and redraw minibuffer. */
1564 && !NILP (echo_area_buffer
[0])
1565 && EQ (minibuf_window
, echo_area_window
)
1566 && NUMBERP (Vminibuffer_message_timeout
))
1568 /* Bind inhibit-quit to t so that C-g gets read in
1569 rather than quitting back to the minibuffer. */
1570 int count
= SPECPDL_INDEX ();
1571 specbind (Qinhibit_quit
, Qt
);
1573 sit_for (Vminibuffer_message_timeout
, 0, 2);
1575 /* Clear the echo area. */
1577 safe_run_hooks (Qecho_area_clear_hook
);
1579 unbind_to (count
, Qnil
);
1581 /* If a C-g came in before, treat it as input now. */
1582 if (!NILP (Vquit_flag
))
1585 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1590 /* Select the frame that the last event came from. Usually,
1591 switch-frame events will take care of this, but if some lisp
1592 code swallows a switch-frame event, we'll fix things up here.
1593 Is this a good idea? */
1594 if (FRAMEP (internal_last_event_frame
)
1595 && !EQ (internal_last_event_frame
, selected_frame
))
1596 Fselect_frame (internal_last_event_frame
, Qnil
);
1598 /* If it has changed current-menubar from previous value,
1599 really recompute the menubar from the value. */
1600 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1601 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1602 call0 (Qrecompute_lucid_menubar
);
1604 before_command_key_count
= this_command_key_count
;
1605 before_command_echo_length
= echo_length ();
1607 Vthis_command
= Qnil
;
1608 real_this_command
= Qnil
;
1609 Vthis_original_command
= Qnil
;
1610 Vthis_command_keys_shift_translated
= Qnil
;
1612 /* Read next key sequence; i gets its length. */
1613 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1616 /* A filter may have run while we were reading the input. */
1617 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1619 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1620 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1624 /* Now we have read a key sequence of length I,
1625 or else I is 0 and we found end of file. */
1627 if (i
== 0) /* End of file -- happens only in */
1628 return Qnil
; /* a kbd macro, at the end. */
1629 /* -1 means read_key_sequence got a menu that was rejected.
1630 Just loop around and read another command. */
1634 this_command_key_count
= 0;
1635 this_command_key_count_reset
= 0;
1636 this_single_command_key_start
= 0;
1640 last_command_event
= keybuf
[i
- 1];
1642 /* If the previous command tried to force a specific window-start,
1643 forget about that, in case this command moves point far away
1644 from that position. But also throw away beg_unchanged and
1645 end_unchanged information in that case, so that redisplay will
1646 update the whole window properly. */
1647 if (!NILP (XWINDOW (selected_window
)->force_start
))
1650 XWINDOW (selected_window
)->force_start
= Qnil
;
1651 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1652 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1655 cmd
= read_key_sequence_cmd
;
1656 if (!NILP (Vexecuting_kbd_macro
))
1658 if (!NILP (Vquit_flag
))
1660 Vexecuting_kbd_macro
= Qt
;
1661 QUIT
; /* Make some noise. */
1662 /* Will return since macro now empty. */
1666 /* Do redisplay processing after this command except in special
1667 cases identified below. */
1668 prev_buffer
= current_buffer
;
1669 prev_modiff
= MODIFF
;
1670 last_point_position
= PT
;
1671 last_point_position_window
= selected_window
;
1672 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1674 /* By default, we adjust point to a boundary of a region that
1675 has such a property that should be treated intangible
1676 (e.g. composition, display). But, some commands will set
1677 this variable differently. */
1678 Vdisable_point_adjustment
= Qnil
;
1680 /* Process filters and timers may have messed with deactivate-mark.
1681 reset it before we execute the command. */
1682 Vdeactivate_mark
= Qnil
;
1684 /* Remap command through active keymaps */
1685 Vthis_original_command
= cmd
;
1689 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1693 /* Execute the command. */
1695 Vthis_command
= cmd
;
1696 real_this_command
= cmd
;
1697 /* Note that the value cell will never directly contain nil
1698 if the symbol is a local variable. */
1699 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1700 safe_run_hooks (Qpre_command_hook
);
1702 already_adjusted
= 0;
1704 if (NILP (Vthis_command
))
1706 /* nil means key is undefined. */
1707 Lisp_Object keys
= Fvector (i
, keybuf
);
1708 keys
= Fkey_description (keys
, Qnil
);
1710 message_with_string ("%s is undefined", keys
, 0);
1711 current_kboard
->defining_kbd_macro
= Qnil
;
1712 update_mode_lines
= 1;
1713 current_kboard
->Vprefix_arg
= Qnil
;
1717 /* Here for a command that isn't executed directly */
1719 #ifdef HAVE_WINDOW_SYSTEM
1720 int scount
= SPECPDL_INDEX ();
1722 if (display_hourglass_p
1723 && NILP (Vexecuting_kbd_macro
))
1725 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1730 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1732 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1734 #ifdef HAVE_WINDOW_SYSTEM
1735 /* Do not check display_hourglass_p here, because
1736 Fcommand_execute could change it, but we should cancel
1737 hourglass cursor anyway.
1738 But don't cancel the hourglass within a macro
1739 just because a command in the macro finishes. */
1740 if (NILP (Vexecuting_kbd_macro
))
1741 unbind_to (scount
, Qnil
);
1744 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1746 /* Note that the value cell will never directly contain nil
1747 if the symbol is a local variable. */
1748 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1749 safe_run_hooks (Qpost_command_hook
);
1751 /* If displaying a message, resize the echo area window to fit
1752 that message's size exactly. */
1753 if (!NILP (echo_area_buffer
[0]))
1754 resize_echo_area_exactly ();
1756 if (!NILP (Vdeferred_action_list
))
1757 safe_run_hooks (Qdeferred_action_function
);
1759 /* If there is a prefix argument,
1760 1) We don't want Vlast_command to be ``universal-argument''
1761 (that would be dumb), so don't set Vlast_command,
1762 2) we want to leave echoing on so that the prefix will be
1763 echoed as part of this key sequence, so don't call
1765 3) we want to leave this_command_key_count non-zero, so that
1766 read_char will realize that it is re-reading a character, and
1767 not echo it a second time.
1769 If the command didn't actually create a prefix arg,
1770 but is merely a frame event that is transparent to prefix args,
1771 then the above doesn't apply. */
1772 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1774 current_kboard
->Vlast_command
= Vthis_command
;
1775 current_kboard
->Vreal_last_command
= real_this_command
;
1776 if (!CONSP (last_command_event
))
1777 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1779 this_command_key_count
= 0;
1780 this_command_key_count_reset
= 0;
1781 this_single_command_key_start
= 0;
1784 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1786 /* In Emacs 22, setting transient-mark-mode to `only' was a
1787 way of turning it on for just one command. This usage is
1788 obsolete, but support it anyway. */
1789 if (EQ (Vtransient_mark_mode
, Qidentity
))
1790 Vtransient_mark_mode
= Qnil
;
1791 else if (EQ (Vtransient_mark_mode
, Qonly
))
1792 Vtransient_mark_mode
= Qidentity
;
1794 if (!NILP (Vdeactivate_mark
))
1795 /* If `select-active-regions' is non-nil, this call to
1796 `deactivate-mark' also sets the PRIMARY selection. */
1797 call0 (Qdeactivate_mark
);
1800 /* Even if not deactivating the mark, set PRIMARY if
1801 `select-active-regions' is non-nil. */
1802 if ((EQ (Vselect_active_regions
, Qonly
)
1803 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1804 : (!NILP (Vselect_active_regions
)
1805 && !NILP (Vtransient_mark_mode
)))
1806 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1808 int beg
= XINT (Fmarker_position (current_buffer
->mark
));
1809 int end
= XINT (make_number (PT
));
1811 call2 (Qx_set_selection
, QPRIMARY
,
1812 make_buffer_string (beg
, end
, 0));
1814 call2 (Qx_set_selection
, QPRIMARY
,
1815 make_buffer_string (end
, beg
, 0));
1816 /* Don't set empty selections. */
1819 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1820 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1823 Vsaved_region_selection
= Qnil
;
1828 if (current_buffer
== prev_buffer
1829 && last_point_position
!= PT
1830 && NILP (Vdisable_point_adjustment
)
1831 && NILP (Vglobal_disable_point_adjustment
))
1833 if (last_point_position
> BEGV
1834 && last_point_position
< ZV
1835 && (composition_adjust_point (last_point_position
,
1836 last_point_position
)
1837 != last_point_position
))
1838 /* The last point was temporarily set within a grapheme
1839 cluster to prevent automatic composition. To recover
1840 the automatic composition, we must update the
1842 windows_or_buffers_changed
++;
1843 if (!already_adjusted
)
1844 adjust_point_for_property (last_point_position
,
1845 MODIFF
!= prev_modiff
);
1848 /* Install chars successfully executed in kbd macro. */
1850 if (!NILP (current_kboard
->defining_kbd_macro
)
1851 && NILP (current_kboard
->Vprefix_arg
))
1852 finalize_kbd_macro_chars ();
1853 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1855 any_kboard_state ();
1860 /* Adjust point to a boundary of a region that has such a property
1861 that should be treated intangible. For the moment, we check
1862 `composition', `display' and `invisible' properties.
1863 LAST_PT is the last position of point. */
1866 adjust_point_for_property (int last_pt
, int modified
)
1869 Lisp_Object val
, overlay
, tmp
;
1870 /* When called after buffer modification, we should temporarily
1871 suppress the point adjustment for automatic composition so that a
1872 user can keep inserting another character at point or keep
1873 deleting characters around point. */
1874 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1877 /* FIXME: cycling is probably not necessary because these properties
1878 can't be usefully combined anyway. */
1879 while (check_composition
|| check_display
|| check_invisible
)
1881 /* FIXME: check `intangible'. */
1882 if (check_composition
1883 && PT
> BEGV
&& PT
< ZV
1884 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1887 check_display
= check_invisible
= 1;
1889 check_composition
= 0;
1891 && PT
> BEGV
&& PT
< ZV
1892 && !NILP (val
= get_char_property_and_overlay
1893 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1894 && display_prop_intangible_p (val
)
1895 && (!OVERLAYP (overlay
)
1896 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1897 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1898 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1899 && (beg
< PT
/* && end > PT <- It's always the case. */
1900 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1903 SET_PT (PT
< last_pt
1904 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1906 check_composition
= check_invisible
= 1;
1909 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1911 int inv
, ellipsis
= 0;
1914 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1917 /* FIXME: We should stop if we find a spot between
1918 two runs of `invisible' where inserted text would
1919 be visible. This is important when we have two
1920 invisible boundaries that enclose an area: if the
1921 area is empty, we need this test in order to make
1922 it possible to place point in the middle rather
1923 than skip both boundaries. However, this code
1924 also stops anywhere in a non-sticky text-property,
1925 which breaks (e.g.) Org mode. */
1926 && (val
= get_pos_property (make_number (end
),
1928 TEXT_PROP_MEANS_INVISIBLE (val
))
1930 && !NILP (val
= get_char_property_and_overlay
1931 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1932 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1934 ellipsis
= ellipsis
|| inv
> 1
1935 || (OVERLAYP (overlay
)
1936 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1937 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1938 tmp
= Fnext_single_char_property_change
1939 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1940 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1944 && (val
= get_pos_property (make_number (beg
),
1946 TEXT_PROP_MEANS_INVISIBLE (val
))
1948 && !NILP (val
= get_char_property_and_overlay
1949 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1950 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1952 ellipsis
= ellipsis
|| inv
> 1
1953 || (OVERLAYP (overlay
)
1954 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1955 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1956 tmp
= Fprevious_single_char_property_change
1957 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1958 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1961 /* Move away from the inside area. */
1962 if (beg
< PT
&& end
> PT
)
1964 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1965 /* We haven't moved yet (so we don't need to fear
1966 infinite-looping) and we were outside the range
1967 before (so either end of the range still corresponds
1968 to a move in the right direction): pretend we moved
1969 less than we actually did, so that we still have
1970 more freedom below in choosing which end of the range
1972 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1973 /* We either have moved already or the last point
1974 was already in the range: we don't get to choose
1975 which end of the range we have to go to. */
1976 : (PT
< last_pt
? beg
: end
));
1977 check_composition
= check_display
= 1;
1979 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1980 the point to something other than its argument, due to
1981 point-motion hooks, intangibility, etc. */
1982 xassert (PT
== beg
|| PT
== end
);
1985 /* Pretend the area doesn't exist if the buffer is not
1987 if (!modified
&& !ellipsis
&& beg
< end
)
1989 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1990 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1991 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1992 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1993 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1994 /* We've already moved as far as we can. Trying to go
1995 to the other end would mean moving backwards and thus
1996 could lead to an infinite loop. */
1998 else if (val
= get_pos_property (make_number (PT
),
2000 TEXT_PROP_MEANS_INVISIBLE (val
)
2001 && (val
= get_pos_property
2002 (make_number (PT
== beg
? end
: beg
),
2004 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2005 (check_composition
= check_display
= 1,
2006 SET_PT (PT
== beg
? end
: beg
));
2009 check_invisible
= 0;
2013 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2016 safe_run_hooks_1 (void)
2018 if (NILP (Vrun_hooks
))
2020 return call1 (Vrun_hooks
, Vinhibit_quit
);
2023 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2026 safe_run_hooks_error (Lisp_Object data
)
2028 Lisp_Object args
[3];
2029 args
[0] = build_string ("Error in %s: %s");
2030 args
[1] = Vinhibit_quit
;
2033 return Fset (Vinhibit_quit
, Qnil
);
2036 /* If we get an error while running the hook, cause the hook variable
2037 to be nil. Also inhibit quits, so that C-g won't cause the hook
2038 to mysteriously evaporate. */
2041 safe_run_hooks (Lisp_Object hook
)
2043 int count
= SPECPDL_INDEX ();
2044 specbind (Qinhibit_quit
, hook
);
2046 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2048 unbind_to (count
, Qnil
);
2052 /* Number of seconds between polling for input. This is a Lisp
2053 variable that can be bound. */
2055 EMACS_INT polling_period
;
2057 /* Nonzero means polling for input is temporarily suppressed. */
2059 int poll_suppress_count
;
2061 /* Asynchronous timer for polling. */
2063 struct atimer
*poll_timer
;
2066 #ifdef POLL_FOR_INPUT
2068 /* Poll for input, so that we catch a C-g if it comes in. This
2069 function is called from x_make_frame_visible, see comment
2073 poll_for_input_1 (void)
2075 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2076 doing anything dangerous. */
2080 if (interrupt_input_blocked
== 0
2081 && !waiting_for_input
)
2082 read_avail_input (0);
2088 /* Timer callback function for poll_timer. TIMER is equal to
2092 poll_for_input (struct atimer
*timer
)
2094 if (poll_suppress_count
== 0)
2097 interrupt_input_pending
= 1;
2098 pending_signals
= 1;
2100 poll_for_input_1 ();
2105 #endif /* POLL_FOR_INPUT */
2107 /* Begin signals to poll for input, if they are appropriate.
2108 This function is called unconditionally from various places. */
2111 start_polling (void)
2113 #ifdef POLL_FOR_INPUT
2114 /* XXX This condition was (read_socket_hook && !interrupt_input),
2115 but read_socket_hook is not global anymore. Let's pretend that
2117 if (!interrupt_input
)
2119 /* Turn alarm handling on unconditionally. It might have
2120 been turned off in process.c. */
2121 turn_on_atimers (1);
2123 /* If poll timer doesn't exist, are we need one with
2124 a different interval, start a new one. */
2125 if (poll_timer
== NULL
2126 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2128 EMACS_TIME interval
;
2131 cancel_atimer (poll_timer
);
2133 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2134 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2135 poll_for_input
, NULL
);
2138 /* Let the timer's callback function poll for input
2139 if this becomes zero. */
2140 --poll_suppress_count
;
2145 /* Nonzero if we are using polling to handle input asynchronously. */
2148 input_polling_used (void)
2150 #ifdef POLL_FOR_INPUT
2151 /* XXX This condition was (read_socket_hook && !interrupt_input),
2152 but read_socket_hook is not global anymore. Let's pretend that
2154 return !interrupt_input
;
2160 /* Turn off polling. */
2165 #ifdef POLL_FOR_INPUT
2166 /* XXX This condition was (read_socket_hook && !interrupt_input),
2167 but read_socket_hook is not global anymore. Let's pretend that
2169 if (!interrupt_input
)
2170 ++poll_suppress_count
;
2174 /* Set the value of poll_suppress_count to COUNT
2175 and start or stop polling accordingly. */
2178 set_poll_suppress_count (int count
)
2180 #ifdef POLL_FOR_INPUT
2181 if (count
== 0 && poll_suppress_count
!= 0)
2183 poll_suppress_count
= 1;
2186 else if (count
!= 0 && poll_suppress_count
== 0)
2190 poll_suppress_count
= count
;
2194 /* Bind polling_period to a value at least N.
2195 But don't decrease it. */
2198 bind_polling_period (int n
)
2200 #ifdef POLL_FOR_INPUT
2201 int new = polling_period
;
2206 stop_other_atimers (poll_timer
);
2208 specbind (Qpolling_period
, make_number (new));
2209 /* Start a new alarm with the new period. */
2214 /* Apply the control modifier to CHARACTER. */
2217 make_ctrl_char (int c
)
2219 /* Save the upper bits here. */
2220 int upper
= c
& ~0177;
2222 if (! ASCII_BYTE_P (c
))
2223 return c
|= ctrl_modifier
;
2227 /* Everything in the columns containing the upper-case letters
2228 denotes a control character. */
2229 if (c
>= 0100 && c
< 0140)
2233 /* Set the shift modifier for a control char
2234 made from a shifted letter. But only for letters! */
2235 if (oc
>= 'A' && oc
<= 'Z')
2236 c
|= shift_modifier
;
2239 /* The lower-case letters denote control characters too. */
2240 else if (c
>= 'a' && c
<= 'z')
2243 /* Include the bits for control and shift
2244 only if the basic ASCII code can't indicate them. */
2248 /* Replace the high bits. */
2249 c
|= (upper
& ~ctrl_modifier
);
2254 /* Display the help-echo property of the character after the mouse pointer.
2255 Either show it in the echo area, or call show-help-function to display
2256 it by other means (maybe in a tooltip).
2258 If HELP is nil, that means clear the previous help echo.
2260 If HELP is a string, display that string. If HELP is a function,
2261 call it with OBJECT and POS as arguments; the function should
2262 return a help string or nil for none. For all other types of HELP,
2263 evaluate it to obtain a string.
2265 WINDOW is the window in which the help was generated, if any.
2266 It is nil if not in a window.
2268 If OBJECT is a buffer, POS is the position in the buffer where the
2269 `help-echo' text property was found.
2271 If OBJECT is an overlay, that overlay has a `help-echo' property,
2272 and POS is the position in the overlay's buffer under the mouse.
2274 If OBJECT is a string (an overlay string or a string displayed with
2275 the `display' property). POS is the position in that string under
2278 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2279 echo overwrites a keystroke echo currently displayed in the echo
2282 Note: this function may only be called with HELP nil or a string
2283 from X code running asynchronously. */
2286 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2287 Lisp_Object pos
, int ok_to_overwrite_keystroke_echo
)
2289 if (!NILP (help
) && !STRINGP (help
))
2291 if (FUNCTIONP (help
))
2293 Lisp_Object args
[4];
2298 help
= safe_call (4, args
);
2301 help
= safe_eval (help
);
2303 if (!STRINGP (help
))
2307 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2308 if (!noninteractive
&& STRINGP (help
))
2310 /* The mouse-fixup-help-message Lisp function can call
2311 mouse_position_hook, which resets the mouse_moved flags.
2312 This causes trouble if we are trying to read a mouse motion
2313 event (i.e., if we are inside a `track-mouse' form), so we
2314 restore the mouse_moved flag. */
2315 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2316 help
= call1 (Qmouse_fixup_help_message
, help
);
2322 if (STRINGP (help
) || NILP (help
))
2324 if (!NILP (Vshow_help_function
))
2325 call1 (Vshow_help_function
, help
);
2326 help_echo_showing_p
= STRINGP (help
);
2332 /* Input of single characters from keyboard */
2334 Lisp_Object
print_help (Lisp_Object object
);
2335 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2336 struct timeval
*end_time
);
2337 static void record_char (Lisp_Object c
);
2339 static Lisp_Object help_form_saved_window_configs
;
2341 read_char_help_form_unwind (Lisp_Object arg
)
2343 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2344 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2345 if (!NILP (window_config
))
2346 Fset_window_configuration (window_config
);
2350 #define STOP_POLLING \
2351 do { if (! polling_stopped_here) stop_polling (); \
2352 polling_stopped_here = 1; } while (0)
2354 #define RESUME_POLLING \
2355 do { if (polling_stopped_here) start_polling (); \
2356 polling_stopped_here = 0; } while (0)
2358 /* read a character from the keyboard; call the redisplay if needed */
2359 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2360 -1 means do not do redisplay, but do do autosaving.
2363 /* The arguments MAPS and NMAPS are for menu prompting.
2364 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2366 PREV_EVENT is the previous input event, or nil if we are reading
2367 the first event of a key sequence (or not reading a key sequence).
2368 If PREV_EVENT is t, that is a "magic" value that says
2369 not to run input methods, but in other respects to act as if
2370 not reading a key sequence.
2372 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2373 if we used a mouse menu to read the input, or zero otherwise. If
2374 USED_MOUSE_MENU is null, we don't dereference it.
2376 Value is -2 when we find input on another keyboard. A second call
2377 to read_char will read it.
2379 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2380 specifying the maximum time to wait until. If no input arrives by
2381 that time, stop waiting and return nil.
2383 Value is t if we showed a menu and the user rejected it. */
2386 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2387 int *used_mouse_menu
, struct timeval
*end_time
)
2389 volatile Lisp_Object c
;
2390 int count
, jmpcount
;
2391 jmp_buf local_getcjmp
;
2393 volatile int key_already_recorded
= 0;
2394 Lisp_Object tem
, save
;
2395 volatile Lisp_Object previous_echo_area_message
;
2396 volatile Lisp_Object also_record
;
2397 volatile int reread
;
2398 struct gcpro gcpro1
, gcpro2
;
2399 int polling_stopped_here
= 0;
2400 struct kboard
*orig_kboard
= current_kboard
;
2404 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2405 before_command_key_count
= this_command_key_count
;
2406 before_command_echo_length
= echo_length ();
2409 previous_echo_area_message
= Qnil
;
2411 GCPRO2 (c
, previous_echo_area_message
);
2416 if (CONSP (Vunread_post_input_method_events
))
2418 c
= XCAR (Vunread_post_input_method_events
);
2419 Vunread_post_input_method_events
2420 = XCDR (Vunread_post_input_method_events
);
2422 /* Undo what read_char_x_menu_prompt did when it unread
2423 additional keys returned by Fx_popup_menu. */
2425 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2433 if (unread_command_char
!= -1)
2435 XSETINT (c
, unread_command_char
);
2436 unread_command_char
= -1;
2442 if (CONSP (Vunread_command_events
))
2444 int was_disabled
= 0;
2446 c
= XCAR (Vunread_command_events
);
2447 Vunread_command_events
= XCDR (Vunread_command_events
);
2451 /* Undo what sit-for did when it unread additional keys
2452 inside universal-argument. */
2455 && EQ (XCAR (c
), Qt
))
2461 /* Undo what read_char_x_menu_prompt did when it unread
2462 additional keys returned by Fx_popup_menu. */
2464 && EQ (XCDR (c
), Qdisabled
)
2465 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2471 /* If the queued event is something that used the mouse,
2472 set used_mouse_menu accordingly. */
2474 /* Also check was_disabled so last-nonmenu-event won't return
2475 a bad value when submenus are involved. (Bug#447) */
2476 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2477 *used_mouse_menu
= 1;
2479 goto reread_for_input_method
;
2482 if (CONSP (Vunread_input_method_events
))
2484 c
= XCAR (Vunread_input_method_events
);
2485 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2487 /* Undo what read_char_x_menu_prompt did when it unread
2488 additional keys returned by Fx_popup_menu. */
2490 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2494 goto reread_for_input_method
;
2497 this_command_key_count_reset
= 0;
2499 if (!NILP (Vexecuting_kbd_macro
))
2501 /* We set this to Qmacro; since that's not a frame, nobody will
2502 try to switch frames on us, and the selected window will
2505 Since this event came from a macro, it would be misleading to
2506 leave internal_last_event_frame set to wherever the last
2507 real event came from. Normally, a switch-frame event selects
2508 internal_last_event_frame after each command is read, but
2509 events read from a macro should never cause a new frame to be
2511 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2513 /* Exit the macro if we are at the end.
2514 Also, some things replace the macro with t
2515 to force an early exit. */
2516 if (EQ (Vexecuting_kbd_macro
, Qt
)
2517 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2523 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2524 if (STRINGP (Vexecuting_kbd_macro
)
2525 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2526 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2528 executing_kbd_macro_index
++;
2533 if (!NILP (unread_switch_frame
))
2535 c
= unread_switch_frame
;
2536 unread_switch_frame
= Qnil
;
2538 /* This event should make it into this_command_keys, and get echoed
2539 again, so we do not set `reread'. */
2543 /* if redisplay was requested */
2544 if (commandflag
>= 0)
2546 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2548 /* If there is pending input, process any events which are not
2549 user-visible, such as X selection_request events. */
2551 || detect_input_pending_run_timers (0))
2552 swallow_events (0); /* may clear input_pending */
2554 /* Redisplay if no pending input. */
2555 while (!input_pending
)
2557 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2558 redisplay_preserve_echo_area (5);
2563 /* Normal case: no input arrived during redisplay. */
2566 /* Input arrived and pre-empted redisplay.
2567 Process any events which are not user-visible. */
2569 /* If that cleared input_pending, try again to redisplay. */
2572 /* Prevent the redisplay we just did
2573 from messing up echoing of the input after the prompt. */
2574 if (commandflag
== 0 && echo_current
)
2575 echo_message_buffer
= echo_area_buffer
[0];
2579 /* Message turns off echoing unless more keystrokes turn it on again.
2581 The code in 20.x for the condition was
2583 1. echo_area_glyphs && *echo_area_glyphs
2584 2. && echo_area_glyphs != current_kboard->echobuf
2585 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2587 (1) means there's a current message displayed
2589 (2) means it's not the message from echoing from the current
2592 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2593 is set to a non-null value. This is done in read_char and it is
2594 set to echo_area_glyphs after a call to echo_char. That means
2595 ok_to_echo_at_next_pause is either null or
2596 current_kboard->echobuf with the appropriate current_kboard at
2599 So, condition (3) means in clear text ok_to_echo_at_next_pause
2600 must be either null, or the current message isn't from echoing at
2601 all, or it's from echoing from a different kboard than the
2604 if (/* There currently is something in the echo area. */
2605 !NILP (echo_area_buffer
[0])
2606 && (/* And it's either not from echoing. */
2607 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2608 /* Or it's an echo from a different kboard. */
2609 || echo_kboard
!= current_kboard
2610 /* Or we explicitly allow overwriting whatever there is. */
2611 || ok_to_echo_at_next_pause
== NULL
))
2616 /* Try reading a character via menu prompting in the minibuf.
2617 Try this before the sit-for, because the sit-for
2618 would do the wrong thing if we are supposed to do
2619 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2620 after a mouse event so don't try a minibuf menu. */
2622 if (nmaps
> 0 && INTERACTIVE
2623 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2624 /* Don't bring up a menu if we already have another event. */
2625 && NILP (Vunread_command_events
)
2626 && unread_command_char
< 0
2627 && !detect_input_pending_run_timers (0))
2629 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2631 if (INTEGERP (c
) && XINT (c
) == -2)
2632 return c
; /* wrong_kboard_jmpbuf */
2636 key_already_recorded
= 1;
2641 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2642 We will do that below, temporarily for short sections of code,
2643 when appropriate. local_getcjmp must be in effect
2644 around any call to sit_for or kbd_buffer_get_event;
2645 it *must not* be in effect when we call redisplay. */
2647 jmpcount
= SPECPDL_INDEX ();
2648 if (_setjmp (local_getcjmp
))
2650 /* Handle quits while reading the keyboard. */
2651 /* We must have saved the outer value of getcjmp here,
2652 so restore it now. */
2653 restore_getcjmp (save_jump
);
2654 unbind_to (jmpcount
, Qnil
);
2655 XSETINT (c
, quit_char
);
2656 internal_last_event_frame
= selected_frame
;
2657 Vlast_event_frame
= internal_last_event_frame
;
2658 /* If we report the quit char as an event,
2659 don't do so more than once. */
2660 if (!NILP (Vinhibit_quit
))
2664 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2665 if (kb
!= current_kboard
)
2667 Lisp_Object link
= kb
->kbd_queue
;
2668 /* We shouldn't get here if we were in single-kboard mode! */
2673 while (CONSP (XCDR (link
)))
2675 if (!NILP (XCDR (link
)))
2679 kb
->kbd_queue
= Fcons (c
, Qnil
);
2681 XSETCDR (link
, Fcons (c
, Qnil
));
2682 kb
->kbd_queue_has_data
= 1;
2683 current_kboard
= kb
;
2684 /* This is going to exit from read_char
2685 so we had better get rid of this frame's stuff. */
2687 return make_number (-2); /* wrong_kboard_jmpbuf */
2693 /* Start idle timers if no time limit is supplied. We don't do it
2694 if a time limit is supplied to avoid an infinite recursion in the
2695 situation where an idle timer calls `sit-for'. */
2698 timer_start_idle ();
2700 /* If in middle of key sequence and minibuffer not active,
2701 start echoing if enough time elapses. */
2703 if (minibuf_level
== 0
2705 && !current_kboard
->immediate_echo
2706 && this_command_key_count
> 0
2708 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2709 && NILP (Fzerop (Vecho_keystrokes
))
2710 && (/* No message. */
2711 NILP (echo_area_buffer
[0])
2712 /* Or empty message. */
2713 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2714 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2715 /* Or already echoing from same kboard. */
2716 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2717 /* Or not echoing before and echoing allowed. */
2718 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2720 /* After a mouse event, start echoing right away.
2721 This is because we are probably about to display a menu,
2722 and we don't want to delay before doing so. */
2723 if (EVENT_HAS_PARAMETERS (prev_event
))
2729 save_getcjmp (save_jump
);
2730 restore_getcjmp (local_getcjmp
);
2731 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2732 restore_getcjmp (save_jump
);
2734 && ! CONSP (Vunread_command_events
))
2739 /* Maybe auto save due to number of keystrokes. */
2741 if (commandflag
!= 0
2742 && auto_save_interval
> 0
2743 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2744 && !detect_input_pending_run_timers (0))
2746 Fdo_auto_save (Qnil
, Qnil
);
2747 /* Hooks can actually change some buffers in auto save. */
2751 /* Try reading using an X menu.
2752 This is never confused with reading using the minibuf
2753 because the recursive call of read_char in read_char_minibuf_menu_prompt
2754 does not pass on any keymaps. */
2756 if (nmaps
> 0 && INTERACTIVE
2757 && !NILP (prev_event
)
2758 && EVENT_HAS_PARAMETERS (prev_event
)
2759 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2760 && !EQ (XCAR (prev_event
), Qtool_bar
)
2761 /* Don't bring up a menu if we already have another event. */
2762 && NILP (Vunread_command_events
)
2763 && unread_command_char
< 0)
2765 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2767 /* Now that we have read an event, Emacs is not idle. */
2774 /* Maybe autosave and/or garbage collect due to idleness. */
2776 if (INTERACTIVE
&& NILP (c
))
2778 int delay_level
, buffer_size
;
2780 /* Slow down auto saves logarithmically in size of current buffer,
2781 and garbage collect while we're at it. */
2782 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2783 last_non_minibuf_size
= Z
- BEG
;
2784 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2786 while (buffer_size
> 64)
2787 delay_level
++, buffer_size
-= buffer_size
>> 2;
2788 if (delay_level
< 4) delay_level
= 4;
2789 /* delay_level is 4 for files under around 50k, 7 at 100k,
2790 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2792 /* Auto save if enough time goes by without input. */
2793 if (commandflag
!= 0
2794 && num_nonmacro_input_events
> last_auto_save
2795 && INTEGERP (Vauto_save_timeout
)
2796 && XINT (Vauto_save_timeout
) > 0)
2799 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2801 save_getcjmp (save_jump
);
2802 restore_getcjmp (local_getcjmp
);
2803 tem0
= sit_for (make_number (timeout
), 1, 1);
2804 restore_getcjmp (save_jump
);
2807 && ! CONSP (Vunread_command_events
))
2809 Fdo_auto_save (Qnil
, Qnil
);
2811 /* If we have auto-saved and there is still no input
2812 available, garbage collect if there has been enough
2813 consing going on to make it worthwhile. */
2814 if (!detect_input_pending_run_timers (0)
2815 && consing_since_gc
> gc_cons_threshold
/ 2)
2816 Fgarbage_collect ();
2823 /* Notify the caller if an autosave hook, or a timer, sentinel or
2824 filter in the sit_for calls above have changed the current
2825 kboard. This could happen if they use the minibuffer or start a
2826 recursive edit, like the fancy splash screen in server.el's
2827 filter. If this longjmp wasn't here, read_key_sequence would
2828 interpret the next key sequence using the wrong translation
2829 tables and function keymaps. */
2830 if (NILP (c
) && current_kboard
!= orig_kboard
)
2833 return make_number (-2); /* wrong_kboard_jmpbuf */
2836 /* If this has become non-nil here, it has been set by a timer
2837 or sentinel or filter. */
2838 if (CONSP (Vunread_command_events
))
2840 c
= XCAR (Vunread_command_events
);
2841 Vunread_command_events
= XCDR (Vunread_command_events
);
2844 /* Read something from current KBOARD's side queue, if possible. */
2848 if (current_kboard
->kbd_queue_has_data
)
2850 if (!CONSP (current_kboard
->kbd_queue
))
2852 c
= XCAR (current_kboard
->kbd_queue
);
2853 current_kboard
->kbd_queue
2854 = XCDR (current_kboard
->kbd_queue
);
2855 if (NILP (current_kboard
->kbd_queue
))
2856 current_kboard
->kbd_queue_has_data
= 0;
2857 input_pending
= readable_events (0);
2858 if (EVENT_HAS_PARAMETERS (c
)
2859 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2860 internal_last_event_frame
= XCAR (XCDR (c
));
2861 Vlast_event_frame
= internal_last_event_frame
;
2865 /* If current_kboard's side queue is empty check the other kboards.
2866 If one of them has data that we have not yet seen here,
2867 switch to it and process the data waiting for it.
2869 Note: if the events queued up for another kboard
2870 have already been seen here, and therefore are not a complete command,
2871 the kbd_queue_has_data field is 0, so we skip that kboard here.
2872 That's to avoid an infinite loop switching between kboards here. */
2873 if (NILP (c
) && !single_kboard
)
2876 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2877 if (kb
->kbd_queue_has_data
)
2879 current_kboard
= kb
;
2880 /* This is going to exit from read_char
2881 so we had better get rid of this frame's stuff. */
2883 return make_number (-2); /* wrong_kboard_jmpbuf */
2891 /* Finally, we read from the main queue,
2892 and if that gives us something we can't use yet, we put it on the
2893 appropriate side queue and try again. */
2902 EMACS_GET_TIME (now
);
2903 if (EMACS_TIME_GE (now
, *end_time
))
2907 /* Actually read a character, waiting if necessary. */
2908 save_getcjmp (save_jump
);
2909 restore_getcjmp (local_getcjmp
);
2911 timer_start_idle ();
2912 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2913 restore_getcjmp (save_jump
);
2915 if (! NILP (c
) && (kb
!= current_kboard
))
2917 Lisp_Object link
= kb
->kbd_queue
;
2920 while (CONSP (XCDR (link
)))
2922 if (!NILP (XCDR (link
)))
2926 kb
->kbd_queue
= Fcons (c
, Qnil
);
2928 XSETCDR (link
, Fcons (c
, Qnil
));
2929 kb
->kbd_queue_has_data
= 1;
2933 current_kboard
= kb
;
2934 /* This is going to exit from read_char
2935 so we had better get rid of this frame's stuff. */
2937 return make_number (-2);
2941 /* Terminate Emacs in batch mode if at eof. */
2942 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2943 Fkill_emacs (make_number (1));
2947 /* Add in any extra modifiers, where appropriate. */
2948 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2949 || ((extra_keyboard_modifiers
& 0177) < ' '
2950 && (extra_keyboard_modifiers
& 0177) != 0))
2951 XSETINT (c
, make_ctrl_char (XINT (c
)));
2953 /* Transfer any other modifier bits directly from
2954 extra_keyboard_modifiers to c. Ignore the actual character code
2955 in the low 16 bits of extra_keyboard_modifiers. */
2956 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2967 if (commandflag
>= 0
2968 && !input_pending
&& !detect_input_pending_run_timers (0))
2976 /* Buffer switch events are only for internal wakeups
2977 so don't show them to the user.
2978 Also, don't record a key if we already did. */
2979 if (BUFFERP (c
) || key_already_recorded
)
2982 /* Process special events within read_char
2983 and loop around to read another event. */
2986 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2991 struct buffer
*prev_buffer
= current_buffer
;
2992 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2993 int was_locked
= single_kboard
;
2994 int count
= SPECPDL_INDEX ();
2995 record_single_kboard_state ();
2998 last_input_event
= c
;
2999 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
3001 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3002 /* We stopped being idle for this event; undo that. This
3003 prevents automatic window selection (under
3004 mouse_autoselect_window from acting as a real input event, for
3005 example banishing the mouse under mouse-avoidance-mode. */
3006 timer_resume_idle ();
3008 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3009 /* Resume allowing input from any kboard, if that was true before. */
3011 any_kboard_state ();
3012 unbind_to (count
, Qnil
);
3015 if (current_buffer
!= prev_buffer
)
3017 /* The command may have changed the keymaps. Pretend there
3018 is input in another keyboard and return. This will
3019 recalculate keymaps. */
3020 c
= make_number (-2);
3027 /* Handle things that only apply to characters. */
3030 /* If kbd_buffer_get_event gave us an EOF, return that. */
3034 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3035 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3036 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3037 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3038 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3042 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3043 /* nil in keyboard-translate-table means no translation. */
3049 /* If this event is a mouse click in the menu bar,
3050 return just menu-bar for now. Modify the mouse click event
3051 so we won't do this twice, then queue it up. */
3052 if (EVENT_HAS_PARAMETERS (c
)
3054 && CONSP (EVENT_START (c
))
3055 && CONSP (XCDR (EVENT_START (c
))))
3059 posn
= POSN_POSN (EVENT_START (c
));
3060 /* Handle menu-bar events:
3061 insert the dummy prefix event `menu-bar'. */
3062 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3064 /* Change menu-bar to (menu-bar) as the event "position". */
3065 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3068 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3073 /* Store these characters into recent_keys, the dribble file if any,
3074 and the keyboard macro being defined, if any. */
3076 if (! NILP (also_record
))
3077 record_char (also_record
);
3079 /* Wipe the echo area.
3080 But first, if we are about to use an input method,
3081 save the echo area contents for it to refer to. */
3083 && ! NILP (Vinput_method_function
)
3084 && (unsigned) XINT (c
) >= ' '
3085 && (unsigned) XINT (c
) != 127
3086 && (unsigned) XINT (c
) < 256)
3088 previous_echo_area_message
= Fcurrent_message ();
3089 Vinput_method_previous_message
= previous_echo_area_message
;
3092 /* Now wipe the echo area, except for help events which do their
3093 own stuff with the echo area. */
3095 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3096 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3098 if (!NILP (echo_area_buffer
[0]))
3099 safe_run_hooks (Qecho_area_clear_hook
);
3100 clear_message (1, 0);
3103 reread_for_input_method
:
3105 /* Pass this to the input method, if appropriate. */
3107 && ! NILP (Vinput_method_function
)
3108 /* Don't run the input method within a key sequence,
3109 after the first event of the key sequence. */
3110 && NILP (prev_event
)
3111 && (unsigned) XINT (c
) >= ' '
3112 && (unsigned) XINT (c
) != 127
3113 && (unsigned) XINT (c
) < 256)
3116 int key_count
, key_count_reset
;
3117 struct gcpro gcpro1
;
3118 int count
= SPECPDL_INDEX ();
3120 /* Save the echo status. */
3121 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3122 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3123 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3124 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3127 if (before_command_restore_flag
)
3129 this_command_key_count
= before_command_key_count_1
;
3130 if (this_command_key_count
< this_single_command_key_start
)
3131 this_single_command_key_start
= this_command_key_count
;
3132 echo_truncate (before_command_echo_length_1
);
3133 before_command_restore_flag
= 0;
3137 /* Save the this_command_keys status. */
3138 key_count
= this_command_key_count
;
3139 key_count_reset
= this_command_key_count_reset
;
3142 keys
= Fcopy_sequence (this_command_keys
);
3147 /* Clear out this_command_keys. */
3148 this_command_key_count
= 0;
3149 this_command_key_count_reset
= 0;
3151 /* Now wipe the echo area. */
3152 if (!NILP (echo_area_buffer
[0]))
3153 safe_run_hooks (Qecho_area_clear_hook
);
3154 clear_message (1, 0);
3157 /* If we are not reading a key sequence,
3158 never use the echo area. */
3161 specbind (Qinput_method_use_echo_area
, Qt
);
3164 /* Call the input method. */
3165 tem
= call1 (Vinput_method_function
, c
);
3167 tem
= unbind_to (count
, tem
);
3169 /* Restore the saved echoing state
3170 and this_command_keys state. */
3171 this_command_key_count
= key_count
;
3172 this_command_key_count_reset
= key_count_reset
;
3174 this_command_keys
= keys
;
3177 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3178 current_kboard
->echo_string
= saved_echo_string
;
3179 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3180 if (saved_immediate_echo
)
3185 /* The input method can return no events. */
3188 /* Bring back the previous message, if any. */
3189 if (! NILP (previous_echo_area_message
))
3190 message_with_string ("%s", previous_echo_area_message
, 0);
3193 /* It returned one event or more. */
3195 Vunread_post_input_method_events
3196 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3201 /* Display help if not echoing. */
3202 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3204 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3205 Lisp_Object help
, object
, position
, window
, tem
;
3207 tem
= Fcdr (XCDR (c
));
3210 window
= Fcar (tem
);
3212 object
= Fcar (tem
);
3214 position
= Fcar (tem
);
3216 show_help_echo (help
, window
, object
, position
, 0);
3218 /* We stopped being idle for this event; undo that. */
3220 timer_resume_idle ();
3224 if ((! reread
|| this_command_key_count
== 0
3225 || this_command_key_count_reset
)
3229 /* Don't echo mouse motion events. */
3230 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3231 && NILP (Fzerop (Vecho_keystrokes
))
3232 && ! (EVENT_HAS_PARAMETERS (c
)
3233 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3236 if (! NILP (also_record
))
3237 echo_char (also_record
);
3238 /* Once we reread a character, echoing can happen
3239 the next time we pause to read a new one. */
3240 ok_to_echo_at_next_pause
= current_kboard
;
3243 /* Record this character as part of the current key. */
3244 add_command_key (c
);
3245 if (! NILP (also_record
))
3246 add_command_key (also_record
);
3249 last_input_event
= c
;
3252 /* Process the help character specially if enabled */
3253 if (!NILP (Vhelp_form
) && help_char_p (c
))
3256 count
= SPECPDL_INDEX ();
3258 help_form_saved_window_configs
3259 = Fcons (Fcurrent_window_configuration (Qnil
),
3260 help_form_saved_window_configs
);
3261 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3263 tem0
= Feval (Vhelp_form
);
3265 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3270 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3271 if (EVENT_HAS_PARAMETERS (c
)
3272 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3273 XSETCAR (help_form_saved_window_configs
, Qnil
);
3275 while (BUFFERP (c
));
3276 /* Remove the help from the frame */
3277 unbind_to (count
, Qnil
);
3280 if (EQ (c
, make_number (040)))
3284 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3285 while (BUFFERP (c
));
3294 /* Record a key that came from a mouse menu.
3295 Record it for echoing, for this-command-keys, and so on. */
3298 record_menu_key (Lisp_Object c
)
3300 /* Wipe the echo area. */
3301 clear_message (1, 0);
3306 before_command_key_count
= this_command_key_count
;
3307 before_command_echo_length
= echo_length ();
3310 /* Don't echo mouse motion events. */
3311 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3312 && NILP (Fzerop (Vecho_keystrokes
)))
3316 /* Once we reread a character, echoing can happen
3317 the next time we pause to read a new one. */
3318 ok_to_echo_at_next_pause
= 0;
3321 /* Record this character as part of the current key. */
3322 add_command_key (c
);
3324 /* Re-reading in the middle of a command */
3325 last_input_event
= c
;
3329 /* Return 1 if should recognize C as "the help character". */
3332 help_char_p (Lisp_Object c
)
3336 if (EQ (c
, Vhelp_char
))
3338 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3339 if (EQ (c
, XCAR (tail
)))
3344 /* Record the input event C in various ways. */
3347 record_char (Lisp_Object c
)
3351 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3353 /* To avoid filling recent_keys with help-echo and mouse-movement
3354 events, we filter out repeated help-echo events, only store the
3355 first and last in a series of mouse-movement events, and don't
3356 store repeated help-echo events which are only separated by
3357 mouse-movement events. */
3359 Lisp_Object ev1
, ev2
, ev3
;
3362 if ((ix1
= recent_keys_index
- 1) < 0)
3363 ix1
= NUM_RECENT_KEYS
- 1;
3364 ev1
= AREF (recent_keys
, ix1
);
3366 if ((ix2
= ix1
- 1) < 0)
3367 ix2
= NUM_RECENT_KEYS
- 1;
3368 ev2
= AREF (recent_keys
, ix2
);
3370 if ((ix3
= ix2
- 1) < 0)
3371 ix3
= NUM_RECENT_KEYS
- 1;
3372 ev3
= AREF (recent_keys
, ix3
);
3374 if (EQ (XCAR (c
), Qhelp_echo
))
3376 /* Don't record `help-echo' in recent_keys unless it shows some help
3377 message, and a different help than the previously recorded
3379 Lisp_Object help
, last_help
;
3381 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3382 if (!STRINGP (help
))
3384 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3385 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3387 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3388 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3389 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3391 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3392 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3393 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3394 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3397 else if (EQ (XCAR (c
), Qmouse_movement
))
3399 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3400 So additional mouse movement events replace the last element. */
3401 Lisp_Object last_window
, window
;
3403 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3404 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3405 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3406 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3407 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3409 ASET (recent_keys
, ix1
, c
);
3415 store_kbd_macro_char (c
);
3420 ASET (recent_keys
, recent_keys_index
, c
);
3421 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3422 recent_keys_index
= 0;
3424 else if (recorded
< 0)
3426 /* We need to remove one or two events from recent_keys.
3427 To do this, we simply put nil at those events and move the
3428 recent_keys_index backwards over those events. Usually,
3429 users will never see those nil events, as they will be
3430 overwritten by the command keys entered to see recent_keys
3433 while (recorded
++ < 0 && total_keys
> 0)
3435 if (total_keys
< NUM_RECENT_KEYS
)
3437 if (--recent_keys_index
< 0)
3438 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3439 ASET (recent_keys
, recent_keys_index
, Qnil
);
3443 num_nonmacro_input_events
++;
3445 /* Write c to the dribble file. If c is a lispy event, write
3446 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3447 If you, dear reader, have a better idea, you've got the source. :-) */
3453 if (XUINT (c
) < 0x100)
3454 putc (XINT (c
), dribble
);
3456 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3460 Lisp_Object dribblee
;
3462 /* If it's a structured event, take the event header. */
3463 dribblee
= EVENT_HEAD (c
);
3465 if (SYMBOLP (dribblee
))
3467 putc ('<', dribble
);
3468 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3469 SBYTES (SYMBOL_NAME (dribblee
)),
3471 putc ('>', dribble
);
3481 print_help (Lisp_Object object
)
3483 struct buffer
*old
= current_buffer
;
3484 Fprinc (object
, Qnil
);
3485 set_buffer_internal (XBUFFER (Vstandard_output
));
3486 call0 (intern ("help-mode"));
3487 set_buffer_internal (old
);
3491 /* Copy out or in the info on where C-g should throw to.
3492 This is used when running Lisp code from within get_char,
3493 in case get_char is called recursively.
3494 See read_process_output. */
3497 save_getcjmp (jmp_buf temp
)
3499 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3503 restore_getcjmp (jmp_buf temp
)
3505 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3508 /* Low level keyboard/mouse input.
3509 kbd_buffer_store_event places events in kbd_buffer, and
3510 kbd_buffer_get_event retrieves them. */
3512 /* Return true if there are any events in the queue that read-char
3513 would return. If this returns false, a read-char would block. */
3515 readable_events (int flags
)
3518 /* Check whether a D-Bus message has arrived. */
3519 if (xd_pending_messages () > 0)
3521 #endif /* HAVE_DBUS */
3523 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3526 /* If the buffer contains only FOCUS_IN_EVENT events, and
3527 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3528 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3530 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3531 #ifdef USE_TOOLKIT_SCROLL_BARS
3532 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3536 struct input_event
*event
;
3538 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3545 #ifdef USE_TOOLKIT_SCROLL_BARS
3546 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3548 event
->kind
== FOCUS_IN_EVENT
)
3549 #ifdef USE_TOOLKIT_SCROLL_BARS
3550 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3551 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3552 && event
->part
== scroll_bar_handle
3553 && event
->modifiers
== 0)
3558 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3561 while (event
!= kbd_store_ptr
);
3567 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3568 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3569 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3574 if (current_kboard
->kbd_queue_has_data
)
3580 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3581 if (kb
->kbd_queue_has_data
)
3587 /* Set this for debugging, to have a way to get out */
3591 event_to_kboard (struct input_event
*event
)
3594 frame
= event
->frame_or_window
;
3596 frame
= XCAR (frame
);
3597 else if (WINDOWP (frame
))
3598 frame
= WINDOW_FRAME (XWINDOW (frame
));
3600 /* There are still some events that don't set this field.
3601 For now, just ignore the problem.
3602 Also ignore dead frames here. */
3603 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3606 return FRAME_KBOARD (XFRAME (frame
));
3609 /* Return the number of slots occupied in kbd_buffer. */
3612 kbd_buffer_nr_stored (void)
3614 return kbd_fetch_ptr
== kbd_store_ptr
3616 : (kbd_fetch_ptr
< kbd_store_ptr
3617 ? kbd_store_ptr
- kbd_fetch_ptr
3618 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3619 + (kbd_store_ptr
- kbd_buffer
)));
3622 Lisp_Object Vthrow_on_input
;
3624 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3627 kbd_buffer_store_event (register struct input_event
*event
)
3629 kbd_buffer_store_event_hold (event
, 0);
3632 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3634 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3635 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3636 Else, if EVENT is a quit event, store the quit event
3637 in HOLD_QUIT, and return (thus ignoring further events).
3639 This is used in read_avail_input to postpone the processing
3640 of the quit event until all subsequent input events have been
3641 parsed (and discarded).
3645 kbd_buffer_store_event_hold (register struct input_event
*event
,
3646 struct input_event
*hold_quit
)
3648 if (event
->kind
== NO_EVENT
)
3651 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3654 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3656 register int c
= event
->code
& 0377;
3658 if (event
->modifiers
& ctrl_modifier
)
3659 c
= make_ctrl_char (c
);
3661 c
|= (event
->modifiers
3662 & (meta_modifier
| alt_modifier
3663 | hyper_modifier
| super_modifier
));
3667 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3668 struct input_event
*sp
;
3670 if (single_kboard
&& kb
!= current_kboard
)
3673 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3674 Fcons (make_number (c
), Qnil
));
3675 kb
->kbd_queue_has_data
= 1;
3676 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3678 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3681 if (event_to_kboard (sp
) == kb
)
3683 sp
->kind
= NO_EVENT
;
3684 sp
->frame_or_window
= Qnil
;
3693 memcpy (hold_quit
, event
, sizeof (*event
));
3697 /* If this results in a quit_char being returned to Emacs as
3698 input, set Vlast_event_frame properly. If this doesn't
3699 get returned to Emacs as an event, the next event read
3700 will set Vlast_event_frame again, so this is safe to do. */
3704 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3706 focus
= event
->frame_or_window
;
3707 internal_last_event_frame
= focus
;
3708 Vlast_event_frame
= focus
;
3711 last_event_timestamp
= event
->timestamp
;
3712 handle_interrupt ();
3716 if (c
&& c
== stop_character
)
3722 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3723 Just ignore the second one. */
3724 else if (event
->kind
== BUFFER_SWITCH_EVENT
3725 && kbd_fetch_ptr
!= kbd_store_ptr
3726 && ((kbd_store_ptr
== kbd_buffer
3727 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3728 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3731 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3732 kbd_store_ptr
= kbd_buffer
;
3734 /* Don't let the very last slot in the buffer become full,
3735 since that would make the two pointers equal,
3736 and that is indistinguishable from an empty buffer.
3737 Discard the event if it would fill the last slot. */
3738 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3740 *kbd_store_ptr
= *event
;
3742 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3744 /* Don't read keyboard input until we have processed kbd_buffer.
3745 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3746 hold_keyboard_input ();
3748 if (!noninteractive
)
3749 signal (SIGIO
, SIG_IGN
);
3755 /* If we're inside while-no-input, and this event qualifies
3756 as input, set quit-flag to cause an interrupt. */
3757 if (!NILP (Vthrow_on_input
)
3758 && event
->kind
!= FOCUS_IN_EVENT
3759 && event
->kind
!= HELP_EVENT
3760 && event
->kind
!= DEICONIFY_EVENT
)
3762 Vquit_flag
= Vthrow_on_input
;
3763 /* If we're inside a function that wants immediate quits,
3765 if (immediate_quit
&& NILP (Vinhibit_quit
))
3775 /* Put an input event back in the head of the event queue. */
3778 kbd_buffer_unget_event (register struct input_event
*event
)
3780 if (kbd_fetch_ptr
== kbd_buffer
)
3781 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3783 /* Don't let the very last slot in the buffer become full, */
3784 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3787 *kbd_fetch_ptr
= *event
;
3792 /* Generate HELP_EVENT input_events in BUFP which has room for
3793 SIZE events. If there's not enough room in BUFP, ignore this
3796 HELP is the help form.
3798 FRAME is the frame on which the help is generated. OBJECT is the
3799 Lisp object where the help was found (a buffer, a string, an
3800 overlay, or nil if neither from a string nor from a buffer. POS is
3801 the position within OBJECT where the help was found.
3803 Value is the number of input_events generated. */
3806 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3807 Lisp_Object object
, int pos
)
3809 struct input_event event
;
3813 event
.kind
= HELP_EVENT
;
3814 event
.frame_or_window
= frame
;
3816 event
.x
= WINDOWP (window
) ? window
: frame
;
3819 kbd_buffer_store_event (&event
);
3823 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3826 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3828 struct input_event event
;
3830 event
.kind
= HELP_EVENT
;
3831 event
.frame_or_window
= frame
;
3836 kbd_buffer_store_event (&event
);
3840 /* Discard any mouse events in the event buffer by setting them to
3843 discard_mouse_events (void)
3845 struct input_event
*sp
;
3846 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3848 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3851 if (sp
->kind
== MOUSE_CLICK_EVENT
3852 || sp
->kind
== WHEEL_EVENT
3853 || sp
->kind
== HORIZ_WHEEL_EVENT
3855 || sp
->kind
== GPM_CLICK_EVENT
3857 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3859 sp
->kind
= NO_EVENT
;
3865 /* Return non-zero if there are any real events waiting in the event
3866 buffer, not counting `NO_EVENT's.
3868 If DISCARD is non-zero, discard NO_EVENT events at the front of
3869 the input queue, possibly leaving the input queue empty if there
3870 are no real input events. */
3873 kbd_buffer_events_waiting (int discard
)
3875 struct input_event
*sp
;
3877 for (sp
= kbd_fetch_ptr
;
3878 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3881 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3888 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3892 /* Clear input event EVENT. */
3895 clear_event (struct input_event
*event
)
3897 event
->kind
= NO_EVENT
;
3901 /* Read one event from the event buffer, waiting if necessary.
3902 The value is a Lisp object representing the event.
3903 The value is nil for an event that should be ignored,
3904 or that was handled here.
3905 We always read and discard one event. */
3908 kbd_buffer_get_event (KBOARD
**kbp
,
3909 int *used_mouse_menu
,
3910 struct timeval
*end_time
)
3915 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3917 /* Start reading input again, we have processed enough so we can
3918 accept new events again. */
3919 unhold_keyboard_input ();
3921 if (!noninteractive
)
3922 signal (SIGIO
, input_available_signal
);
3928 /* In case we are running as a daemon, only do this before
3929 detaching from the terminal. */
3930 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3934 *kbp
= current_kboard
;
3938 /* Wait until there is input available. */
3941 /* Break loop if there's an unread command event. Needed in
3942 moused window autoselection which uses a timer to insert such
3944 if (CONSP (Vunread_command_events
))
3947 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3949 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3950 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3954 /* If the quit flag is set, then read_char will return
3955 quit_char, so that counts as "available input." */
3956 if (!NILP (Vquit_flag
))
3957 quit_throw_to_read_char ();
3959 /* One way or another, wait until input is available; then, if
3960 interrupt handlers have not read it, read it now. */
3962 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3966 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3968 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3969 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3974 EMACS_TIME duration
;
3975 EMACS_GET_TIME (duration
);
3976 if (EMACS_TIME_GE (duration
, *end_time
))
3977 return Qnil
; /* finished waiting */
3980 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3981 wait_reading_process_output (EMACS_SECS (duration
),
3982 EMACS_USECS (duration
),
3983 -1, 1, Qnil
, NULL
, 0);
3987 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3989 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3990 /* Pass 1 for EXPECT since we just waited to have input. */
3991 read_avail_input (1);
3994 if (CONSP (Vunread_command_events
))
3997 first
= XCAR (Vunread_command_events
);
3998 Vunread_command_events
= XCDR (Vunread_command_events
);
3999 *kbp
= current_kboard
;
4003 /* At this point, we know that there is a readable event available
4004 somewhere. If the event queue is empty, then there must be a
4005 mouse movement enabled and available. */
4006 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4008 struct input_event
*event
;
4010 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4014 last_event_timestamp
= event
->timestamp
;
4016 *kbp
= event_to_kboard (event
);
4018 *kbp
= current_kboard
; /* Better than returning null ptr? */
4022 /* These two kinds of events get special handling
4023 and don't actually appear to the command loop.
4024 We return nil for them. */
4025 if (event
->kind
== SELECTION_REQUEST_EVENT
4026 || event
->kind
== SELECTION_CLEAR_EVENT
)
4029 struct input_event copy
;
4031 /* Remove it from the buffer before processing it,
4032 since otherwise swallow_events will see it
4033 and process it again. */
4035 kbd_fetch_ptr
= event
+ 1;
4036 input_pending
= readable_events (0);
4037 x_handle_selection_event (©
);
4039 /* We're getting selection request events, but we don't have
4045 #if defined (HAVE_NS)
4046 else if (event
->kind
== NS_TEXT_EVENT
)
4048 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4049 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4051 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4052 kbd_fetch_ptr
= event
+ 1;
4053 if (used_mouse_menu
)
4054 *used_mouse_menu
= 1;
4058 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4059 || defined (HAVE_NS)
4060 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4062 /* Make an event (delete-frame (FRAME)). */
4063 obj
= Fcons (event
->frame_or_window
, Qnil
);
4064 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4065 kbd_fetch_ptr
= event
+ 1;
4068 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4069 || defined (HAVE_NS)
4070 else if (event
->kind
== ICONIFY_EVENT
)
4072 /* Make an event (iconify-frame (FRAME)). */
4073 obj
= Fcons (event
->frame_or_window
, Qnil
);
4074 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4075 kbd_fetch_ptr
= event
+ 1;
4077 else if (event
->kind
== DEICONIFY_EVENT
)
4079 /* Make an event (make-frame-visible (FRAME)). */
4080 obj
= Fcons (event
->frame_or_window
, Qnil
);
4081 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4082 kbd_fetch_ptr
= event
+ 1;
4085 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4087 /* The value doesn't matter here; only the type is tested. */
4088 XSETBUFFER (obj
, current_buffer
);
4089 kbd_fetch_ptr
= event
+ 1;
4091 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4092 || defined(HAVE_NS) || defined (USE_GTK)
4093 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4095 kbd_fetch_ptr
= event
+ 1;
4096 input_pending
= readable_events (0);
4097 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4098 x_activate_menubar (XFRAME (event
->frame_or_window
));
4101 #if defined (WINDOWSNT)
4102 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4104 /* Make an event (language-change (FRAME CHARSET LCID)). */
4105 obj
= Fcons (event
->frame_or_window
, Qnil
);
4106 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4107 kbd_fetch_ptr
= event
+ 1;
4110 else if (event
->kind
== SAVE_SESSION_EVENT
)
4112 obj
= Fcons (Qsave_session
, Qnil
);
4113 kbd_fetch_ptr
= event
+ 1;
4115 /* Just discard these, by returning nil.
4116 With MULTI_KBOARD, these events are used as placeholders
4117 when we need to randomly delete events from the queue.
4118 (They shouldn't otherwise be found in the buffer,
4119 but on some machines it appears they do show up
4120 even without MULTI_KBOARD.) */
4121 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4122 mouse events during a popup-menu call. */
4123 else if (event
->kind
== NO_EVENT
)
4124 kbd_fetch_ptr
= event
+ 1;
4125 else if (event
->kind
== HELP_EVENT
)
4127 Lisp_Object object
, position
, help
, frame
, window
;
4129 frame
= event
->frame_or_window
;
4130 object
= event
->arg
;
4131 position
= make_number (event
->code
);
4134 clear_event (event
);
4136 kbd_fetch_ptr
= event
+ 1;
4137 if (!WINDOWP (window
))
4139 obj
= Fcons (Qhelp_echo
,
4140 list5 (frame
, help
, window
, object
, position
));
4142 else if (event
->kind
== FOCUS_IN_EVENT
)
4144 /* Notification of a FocusIn event. The frame receiving the
4145 focus is in event->frame_or_window. Generate a
4146 switch-frame event if necessary. */
4147 Lisp_Object frame
, focus
;
4149 frame
= event
->frame_or_window
;
4150 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4154 if (!EQ (frame
, internal_last_event_frame
)
4155 && !EQ (frame
, selected_frame
))
4156 obj
= make_lispy_switch_frame (frame
);
4157 internal_last_event_frame
= frame
;
4158 kbd_fetch_ptr
= event
+ 1;
4161 else if (event
->kind
== DBUS_EVENT
)
4163 obj
= make_lispy_event (event
);
4164 kbd_fetch_ptr
= event
+ 1;
4167 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4169 obj
= make_lispy_event (event
);
4170 kbd_fetch_ptr
= event
+ 1;
4174 /* If this event is on a different frame, return a switch-frame this
4175 time, and leave the event in the queue for next time. */
4179 frame
= event
->frame_or_window
;
4181 frame
= XCAR (frame
);
4182 else if (WINDOWP (frame
))
4183 frame
= WINDOW_FRAME (XWINDOW (frame
));
4185 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4189 if (! EQ (frame
, internal_last_event_frame
)
4190 && !EQ (frame
, selected_frame
))
4191 obj
= make_lispy_switch_frame (frame
);
4192 internal_last_event_frame
= frame
;
4194 /* If we didn't decide to make a switch-frame event, go ahead
4195 and build a real event from the queue entry. */
4199 obj
= make_lispy_event (event
);
4201 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4202 || defined(HAVE_NS) || defined (USE_GTK)
4203 /* If this was a menu selection, then set the flag to inhibit
4204 writing to last_nonmenu_event. Don't do this if the event
4205 we're returning is (menu-bar), though; that indicates the
4206 beginning of the menu sequence, and we might as well leave
4207 that as the `event with parameters' for this selection. */
4209 && !EQ (event
->frame_or_window
, event
->arg
)
4210 && (event
->kind
== MENU_BAR_EVENT
4211 || event
->kind
== TOOL_BAR_EVENT
))
4212 *used_mouse_menu
= 1;
4215 /* certain system events are non-key events */
4217 && event
->kind
== NS_NONKEY_EVENT
)
4218 *used_mouse_menu
= 1;
4221 /* Wipe out this event, to catch bugs. */
4222 clear_event (event
);
4223 kbd_fetch_ptr
= event
+ 1;
4227 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4228 /* Try generating a mouse motion event. */
4229 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4231 FRAME_PTR f
= some_mouse_moved ();
4232 Lisp_Object bar_window
;
4233 enum scroll_bar_part part
;
4237 *kbp
= current_kboard
;
4238 /* Note that this uses F to determine which terminal to look at.
4239 If there is no valid info, it does not store anything
4240 so x remains nil. */
4243 /* XXX Can f or mouse_position_hook be NULL here? */
4244 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4245 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4246 &part
, &x
, &y
, &time
);
4250 /* Decide if we should generate a switch-frame event. Don't
4251 generate switch-frame events for motion outside of all Emacs
4257 frame
= FRAME_FOCUS_FRAME (f
);
4259 XSETFRAME (frame
, f
);
4261 if (! EQ (frame
, internal_last_event_frame
)
4262 && !EQ (frame
, selected_frame
))
4263 obj
= make_lispy_switch_frame (frame
);
4264 internal_last_event_frame
= frame
;
4267 /* If we didn't decide to make a switch-frame event, go ahead and
4268 return a mouse-motion event. */
4269 if (!NILP (x
) && NILP (obj
))
4270 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4272 #endif /* HAVE_MOUSE || HAVE GPM */
4274 /* We were promised by the above while loop that there was
4275 something for us to read! */
4278 input_pending
= readable_events (0);
4280 Vlast_event_frame
= internal_last_event_frame
;
4285 /* Process any events that are not user-visible,
4286 then return, without reading any user-visible events. */
4289 swallow_events (int do_display
)
4293 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4295 struct input_event
*event
;
4297 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4301 last_event_timestamp
= event
->timestamp
;
4303 /* These two kinds of events get special handling
4304 and don't actually appear to the command loop. */
4305 if (event
->kind
== SELECTION_REQUEST_EVENT
4306 || event
->kind
== SELECTION_CLEAR_EVENT
)
4309 struct input_event copy
;
4311 /* Remove it from the buffer before processing it,
4312 since otherwise swallow_events called recursively could see it
4313 and process it again. */
4315 kbd_fetch_ptr
= event
+ 1;
4316 input_pending
= readable_events (0);
4317 x_handle_selection_event (©
);
4319 /* We're getting selection request events, but we don't have
4328 old_timers_run
= timers_run
;
4329 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4331 if (timers_run
!= old_timers_run
&& do_display
)
4332 redisplay_preserve_echo_area (7);
4335 /* Record the start of when Emacs is idle,
4336 for the sake of running idle-time timers. */
4339 timer_start_idle (void)
4343 /* If we are already in the idle state, do nothing. */
4344 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4347 EMACS_GET_TIME (timer_idleness_start_time
);
4349 timer_last_idleness_start_time
= timer_idleness_start_time
;
4351 /* Mark all idle-time timers as once again candidates for running. */
4352 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4356 timer
= XCAR (timers
);
4358 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4360 XVECTOR (timer
)->contents
[0] = Qnil
;
4364 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4367 timer_stop_idle (void)
4369 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4372 /* Resume idle timer from last idle start time. */
4375 timer_resume_idle (void)
4377 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4380 timer_idleness_start_time
= timer_last_idleness_start_time
;
4383 /* This is only for debugging. */
4384 struct input_event last_timer_event
;
4386 /* List of elisp functions to call, delayed because they were generated in
4387 a context where Elisp could not be safely run (e.g. redisplay, signal,
4388 ...). Each element has the form (FUN . ARGS). */
4389 Lisp_Object pending_funcalls
;
4391 /* Check whether a timer has fired. To prevent larger problems we simply
4392 disregard elements that are not proper timers. Do not make a circular
4393 timer list for the time being.
4395 Returns the time to wait until the next timer fires. If a
4396 timer is triggering now, return zero.
4397 If no timer is active, return -1.
4399 If a timer is ripe, we run it, with quitting turned off.
4400 In that case we return 0 to indicate that a new timer_check_2 call
4404 timer_check_2 (void)
4406 EMACS_TIME nexttime
;
4407 EMACS_TIME now
, idleness_now
;
4408 Lisp_Object timers
, idle_timers
, chosen_timer
;
4409 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4411 EMACS_SET_SECS (nexttime
, -1);
4412 EMACS_SET_USECS (nexttime
, -1);
4414 /* Always consider the ordinary timers. */
4415 timers
= Vtimer_list
;
4416 /* Consider the idle timers only if Emacs is idle. */
4417 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4418 idle_timers
= Vtimer_idle_list
;
4421 chosen_timer
= Qnil
;
4422 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4424 /* First run the code that was delayed. */
4425 while (CONSP (pending_funcalls
))
4427 Lisp_Object funcall
= XCAR (pending_funcalls
);
4428 pending_funcalls
= XCDR (pending_funcalls
);
4429 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4432 if (CONSP (timers
) || CONSP (idle_timers
))
4434 EMACS_GET_TIME (now
);
4435 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4436 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4439 while (CONSP (timers
) || CONSP (idle_timers
))
4441 Lisp_Object
*vector
;
4442 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4443 EMACS_TIME timer_time
, idle_timer_time
;
4444 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4446 /* Skip past invalid timers and timers already handled. */
4449 timer
= XCAR (timers
);
4450 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4452 timers
= XCDR (timers
);
4455 vector
= XVECTOR (timer
)->contents
;
4457 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4458 || !INTEGERP (vector
[3])
4459 || ! NILP (vector
[0]))
4461 timers
= XCDR (timers
);
4465 if (!NILP (idle_timers
))
4467 timer
= XCAR (idle_timers
);
4468 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4470 idle_timers
= XCDR (idle_timers
);
4473 vector
= XVECTOR (timer
)->contents
;
4475 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4476 || !INTEGERP (vector
[3])
4477 || ! NILP (vector
[0]))
4479 idle_timers
= XCDR (idle_timers
);
4484 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4485 based on the next ordinary timer.
4486 TIMER_DIFFERENCE is the distance in time from NOW to when
4487 this timer becomes ripe (negative if it's already ripe). */
4490 timer
= XCAR (timers
);
4491 vector
= XVECTOR (timer
)->contents
;
4492 EMACS_SET_SECS (timer_time
,
4493 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4494 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4495 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4498 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4499 based on the next idle timer. */
4500 if (!NILP (idle_timers
))
4502 idle_timer
= XCAR (idle_timers
);
4503 vector
= XVECTOR (idle_timer
)->contents
;
4504 EMACS_SET_SECS (idle_timer_time
,
4505 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4506 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4507 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4510 /* Decide which timer is the next timer,
4511 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4512 Also step down the list where we found that timer. */
4514 if (! NILP (timers
) && ! NILP (idle_timers
))
4517 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4518 if (EMACS_TIME_NEG_P (temp
))
4520 chosen_timer
= timer
;
4521 timers
= XCDR (timers
);
4522 difference
= timer_difference
;
4526 chosen_timer
= idle_timer
;
4527 idle_timers
= XCDR (idle_timers
);
4528 difference
= idle_timer_difference
;
4531 else if (! NILP (timers
))
4533 chosen_timer
= timer
;
4534 timers
= XCDR (timers
);
4535 difference
= timer_difference
;
4539 chosen_timer
= idle_timer
;
4540 idle_timers
= XCDR (idle_timers
);
4541 difference
= idle_timer_difference
;
4543 vector
= XVECTOR (chosen_timer
)->contents
;
4545 /* If timer is ripe, run it if it hasn't been run. */
4546 if (EMACS_TIME_NEG_P (difference
)
4547 || (EMACS_SECS (difference
) == 0
4548 && EMACS_USECS (difference
) == 0))
4550 if (NILP (vector
[0]))
4552 int count
= SPECPDL_INDEX ();
4553 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4555 /* Mark the timer as triggered to prevent problems if the lisp
4556 code fails to reschedule it right. */
4559 specbind (Qinhibit_quit
, Qt
);
4561 call1 (Qtimer_event_handler
, chosen_timer
);
4562 Vdeactivate_mark
= old_deactivate_mark
;
4564 unbind_to (count
, Qnil
);
4566 /* Since we have handled the event,
4567 we don't need to tell the caller to wake up and do it. */
4568 /* But the caller must still wait for the next timer, so
4569 return 0 to indicate that. */
4572 EMACS_SET_SECS (nexttime
, 0);
4573 EMACS_SET_USECS (nexttime
, 0);
4576 /* When we encounter a timer that is still waiting,
4577 return the amount of time to wait before it is ripe. */
4584 /* No timers are pending in the future. */
4585 /* Return 0 if we generated an event, and -1 if not. */
4591 /* Check whether a timer has fired. To prevent larger problems we simply
4592 disregard elements that are not proper timers. Do not make a circular
4593 timer list for the time being.
4595 Returns the time to wait until the next timer fires.
4596 If no timer is active, return -1.
4598 As long as any timer is ripe, we run it.
4600 DO_IT_NOW is now ignored. It used to mean that we should
4601 run the timer directly instead of queueing a timer-event.
4602 Now we always run timers directly. */
4605 timer_check (int do_it_now
)
4607 EMACS_TIME nexttime
;
4611 nexttime
= timer_check_2 ();
4613 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4618 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4619 doc
: /* Return the current length of Emacs idleness, or nil.
4620 The value when Emacs is idle is a list of three integers. The first has
4621 the most significant 16 bits of the seconds, while the second has the least
4622 significant 16 bits. The third integer gives the microsecond count.
4624 The value when Emacs is not idle is nil.
4626 The microsecond count is zero on systems that do not provide
4627 resolution finer than a second. */)
4630 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4632 EMACS_TIME now
, idleness_now
;
4634 EMACS_GET_TIME (now
);
4635 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4637 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4638 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4639 make_number (EMACS_USECS (idleness_now
)));
4645 /* Caches for modify_event_symbol. */
4646 static Lisp_Object accent_key_syms
;
4647 static Lisp_Object func_key_syms
;
4648 static Lisp_Object mouse_syms
;
4649 static Lisp_Object wheel_syms
;
4650 static Lisp_Object drag_n_drop_syms
;
4652 /* This is a list of keysym codes for special "accent" characters.
4653 It parallels lispy_accent_keys. */
4655 static const int lispy_accent_codes
[] =
4657 #ifdef XK_dead_circumflex
4662 #ifdef XK_dead_grave
4667 #ifdef XK_dead_tilde
4672 #ifdef XK_dead_diaeresis
4677 #ifdef XK_dead_macron
4682 #ifdef XK_dead_degree
4687 #ifdef XK_dead_acute
4692 #ifdef XK_dead_cedilla
4697 #ifdef XK_dead_breve
4702 #ifdef XK_dead_ogonek
4707 #ifdef XK_dead_caron
4712 #ifdef XK_dead_doubleacute
4713 XK_dead_doubleacute
,
4717 #ifdef XK_dead_abovedot
4722 #ifdef XK_dead_abovering
4732 #ifdef XK_dead_belowdot
4737 #ifdef XK_dead_voiced_sound
4738 XK_dead_voiced_sound
,
4742 #ifdef XK_dead_semivoiced_sound
4743 XK_dead_semivoiced_sound
,
4759 /* This is a list of Lisp names for special "accent" characters.
4760 It parallels lispy_accent_codes. */
4762 static const char *lispy_accent_keys
[] =
4780 "dead-voiced-sound",
4781 "dead-semivoiced-sound",
4787 #define FUNCTION_KEY_OFFSET 0x0
4789 char const *lispy_function_keys
[] =
4793 0, /* VK_LBUTTON 0x01 */
4794 0, /* VK_RBUTTON 0x02 */
4795 "cancel", /* VK_CANCEL 0x03 */
4796 0, /* VK_MBUTTON 0x04 */
4798 0, 0, 0, /* 0x05 .. 0x07 */
4800 "backspace", /* VK_BACK 0x08 */
4801 "tab", /* VK_TAB 0x09 */
4803 0, 0, /* 0x0A .. 0x0B */
4805 "clear", /* VK_CLEAR 0x0C */
4806 "return", /* VK_RETURN 0x0D */
4808 0, 0, /* 0x0E .. 0x0F */
4810 0, /* VK_SHIFT 0x10 */
4811 0, /* VK_CONTROL 0x11 */
4812 0, /* VK_MENU 0x12 */
4813 "pause", /* VK_PAUSE 0x13 */
4814 "capslock", /* VK_CAPITAL 0x14 */
4815 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4817 "junja", /* VK_JUNJA 0x17 */
4818 "final", /* VK_FINAL 0x18 */
4819 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4821 "escape", /* VK_ESCAPE 0x1B */
4822 "convert", /* VK_CONVERT 0x1C */
4823 "non-convert", /* VK_NONCONVERT 0x1D */
4824 "accept", /* VK_ACCEPT 0x1E */
4825 "mode-change", /* VK_MODECHANGE 0x1F */
4826 0, /* VK_SPACE 0x20 */
4827 "prior", /* VK_PRIOR 0x21 */
4828 "next", /* VK_NEXT 0x22 */
4829 "end", /* VK_END 0x23 */
4830 "home", /* VK_HOME 0x24 */
4831 "left", /* VK_LEFT 0x25 */
4832 "up", /* VK_UP 0x26 */
4833 "right", /* VK_RIGHT 0x27 */
4834 "down", /* VK_DOWN 0x28 */
4835 "select", /* VK_SELECT 0x29 */
4836 "print", /* VK_PRINT 0x2A */
4837 "execute", /* VK_EXECUTE 0x2B */
4838 "snapshot", /* VK_SNAPSHOT 0x2C */
4839 "insert", /* VK_INSERT 0x2D */
4840 "delete", /* VK_DELETE 0x2E */
4841 "help", /* VK_HELP 0x2F */
4843 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4845 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4847 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4849 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4851 0, 0, 0, 0, 0, 0, 0, 0, 0,
4852 0, 0, 0, 0, 0, 0, 0, 0, 0,
4853 0, 0, 0, 0, 0, 0, 0, 0,
4855 "lwindow", /* VK_LWIN 0x5B */
4856 "rwindow", /* VK_RWIN 0x5C */
4857 "apps", /* VK_APPS 0x5D */
4860 "kp-0", /* VK_NUMPAD0 0x60 */
4861 "kp-1", /* VK_NUMPAD1 0x61 */
4862 "kp-2", /* VK_NUMPAD2 0x62 */
4863 "kp-3", /* VK_NUMPAD3 0x63 */
4864 "kp-4", /* VK_NUMPAD4 0x64 */
4865 "kp-5", /* VK_NUMPAD5 0x65 */
4866 "kp-6", /* VK_NUMPAD6 0x66 */
4867 "kp-7", /* VK_NUMPAD7 0x67 */
4868 "kp-8", /* VK_NUMPAD8 0x68 */
4869 "kp-9", /* VK_NUMPAD9 0x69 */
4870 "kp-multiply", /* VK_MULTIPLY 0x6A */
4871 "kp-add", /* VK_ADD 0x6B */
4872 "kp-separator", /* VK_SEPARATOR 0x6C */
4873 "kp-subtract", /* VK_SUBTRACT 0x6D */
4874 "kp-decimal", /* VK_DECIMAL 0x6E */
4875 "kp-divide", /* VK_DIVIDE 0x6F */
4876 "f1", /* VK_F1 0x70 */
4877 "f2", /* VK_F2 0x71 */
4878 "f3", /* VK_F3 0x72 */
4879 "f4", /* VK_F4 0x73 */
4880 "f5", /* VK_F5 0x74 */
4881 "f6", /* VK_F6 0x75 */
4882 "f7", /* VK_F7 0x76 */
4883 "f8", /* VK_F8 0x77 */
4884 "f9", /* VK_F9 0x78 */
4885 "f10", /* VK_F10 0x79 */
4886 "f11", /* VK_F11 0x7A */
4887 "f12", /* VK_F12 0x7B */
4888 "f13", /* VK_F13 0x7C */
4889 "f14", /* VK_F14 0x7D */
4890 "f15", /* VK_F15 0x7E */
4891 "f16", /* VK_F16 0x7F */
4892 "f17", /* VK_F17 0x80 */
4893 "f18", /* VK_F18 0x81 */
4894 "f19", /* VK_F19 0x82 */
4895 "f20", /* VK_F20 0x83 */
4896 "f21", /* VK_F21 0x84 */
4897 "f22", /* VK_F22 0x85 */
4898 "f23", /* VK_F23 0x86 */
4899 "f24", /* VK_F24 0x87 */
4901 0, 0, 0, 0, /* 0x88 .. 0x8B */
4902 0, 0, 0, 0, /* 0x8C .. 0x8F */
4904 "kp-numlock", /* VK_NUMLOCK 0x90 */
4905 "scroll", /* VK_SCROLL 0x91 */
4906 /* Not sure where the following block comes from.
4907 Windows headers have NEC and Fujitsu specific keys in
4908 this block, but nothing generic. */
4909 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4910 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4911 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4912 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4913 "kp-end", /* VK_NUMPAD_END 0x96 */
4914 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4915 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4916 "kp-up", /* VK_NUMPAD_UP 0x99 */
4917 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4918 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4919 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4920 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4922 0, 0, /* 0x9E .. 0x9F */
4925 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4926 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4927 * No other API or message will distinguish left and right keys this way.
4932 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4933 to enable them selectively, and gives access to a few more functions.
4934 See lispy_multimedia_keys below. */
4935 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4936 0, 0, 0, /* 0xAD .. 0xAF Volume */
4937 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4938 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4940 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4941 0, 0, 0, 0, 0, 0, 0, 0, 0,
4943 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4944 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4945 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4948 "ax", /* VK_OEM_AX 0xE1 */
4949 0, /* VK_OEM_102 0xE2 */
4950 "ico-help", /* VK_ICO_HELP 0xE3 */
4951 "ico-00", /* VK_ICO_00 0xE4 */
4952 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4953 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4954 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4956 "reset", /* VK_OEM_RESET 0xE9 */
4957 "jump", /* VK_OEM_JUMP 0xEA */
4958 "oem-pa1", /* VK_OEM_PA1 0xEB */
4959 "oem-pa2", /* VK_OEM_PA2 0xEC */
4960 "oem-pa3", /* VK_OEM_PA3 0xED */
4961 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4962 "cusel", /* VK_OEM_CUSEL 0xEF */
4963 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4964 "finish", /* VK_OEM_FINISH 0xF1 */
4965 "copy", /* VK_OEM_COPY 0xF2 */
4966 "auto", /* VK_OEM_AUTO 0xF3 */
4967 "enlw", /* VK_OEM_ENLW 0xF4 */
4968 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4969 "attn", /* VK_ATTN 0xF6 */
4970 "crsel", /* VK_CRSEL 0xF7 */
4971 "exsel", /* VK_EXSEL 0xF8 */
4972 "ereof", /* VK_EREOF 0xF9 */
4973 "play", /* VK_PLAY 0xFA */
4974 "zoom", /* VK_ZOOM 0xFB */
4975 "noname", /* VK_NONAME 0xFC */
4976 "pa1", /* VK_PA1 0xFD */
4977 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4981 /* Some of these duplicate the "Media keys" on newer keyboards,
4982 but they are delivered to the application in a different way. */
4983 static const char *lispy_multimedia_keys
[] =
4991 "browser-favorites",
5028 "toggle-dictate-command",
5034 "media-fast-forward",
5037 "media-channel-down"
5040 #else /* not HAVE_NTGUI */
5042 /* This should be dealt with in XTread_socket now, and that doesn't
5043 depend on the client system having the Kana syms defined. See also
5044 the XK_kana_A case below. */
5047 static const char *lispy_kana_keys
[] =
5049 /* X Keysym value */
5050 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5051 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5052 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5053 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5054 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5055 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5056 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5057 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5058 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5059 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5060 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5061 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5062 "kana-i", "kana-u", "kana-e", "kana-o",
5063 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5064 "prolongedsound", "kana-A", "kana-I", "kana-U",
5065 "kana-E", "kana-O", "kana-KA", "kana-KI",
5066 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5067 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5068 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5069 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5070 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5071 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5072 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5073 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5074 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5075 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5076 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5077 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5079 #endif /* XK_kana_A */
5082 #define FUNCTION_KEY_OFFSET 0xff00
5084 /* You'll notice that this table is arranged to be conveniently
5085 indexed by X Windows keysym values. */
5086 static const char *lispy_function_keys
[] =
5088 /* X Keysym value */
5090 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5091 "backspace", "tab", "linefeed", "clear",
5093 0, 0, 0, "pause", /* 0xff10...1f */
5094 0, 0, 0, 0, 0, 0, 0, "escape",
5096 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5097 "romaji", "hiragana", "katakana", "hiragana-katakana",
5098 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5099 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5100 "eisu-toggle", /* 0xff30...3f */
5101 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5102 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5104 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5105 "down", "prior", "next", "end",
5106 "begin", 0, 0, 0, 0, 0, 0, 0,
5107 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5118 "break", /* 0xff6b */
5121 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5122 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5123 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5124 0, 0, 0, 0, 0, 0, 0, 0,
5125 "kp-tab", /* 0xff89 */
5127 "kp-enter", /* 0xff8d */
5129 "kp-f1", /* 0xff91 */
5133 "kp-home", /* 0xff95 */
5138 "kp-prior", /* kp-page-up */
5139 "kp-next", /* kp-page-down */
5145 0, 0, 0, 0, 0, 0, 0, 0, 0,
5146 "kp-multiply", /* 0xffaa */
5151 "kp-divide", /* 0xffaf */
5152 "kp-0", /* 0xffb0 */
5153 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5156 "kp-equal", /* 0xffbd */
5157 "f1", /* 0xffbe */ /* IsFunctionKey */
5159 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5160 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5161 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5162 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5163 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5164 0, 0, 0, 0, 0, 0, 0, 0,
5165 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5166 0, 0, 0, 0, 0, 0, 0, "delete"
5169 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5170 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5172 static const char *iso_lispy_function_keys
[] =
5174 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5175 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5176 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5177 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5178 "iso-lefttab", /* 0xfe20 */
5179 "iso-move-line-up", "iso-move-line-down",
5180 "iso-partial-line-up", "iso-partial-line-down",
5181 "iso-partial-space-left", "iso-partial-space-right",
5182 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5183 "iso-release-margin-left", "iso-release-margin-right",
5184 "iso-release-both-margins",
5185 "iso-fast-cursor-left", "iso-fast-cursor-right",
5186 "iso-fast-cursor-up", "iso-fast-cursor-down",
5187 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5188 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5191 #endif /* not HAVE_NTGUI */
5193 Lisp_Object Vlispy_mouse_stem
;
5195 static const char *lispy_wheel_names
[] =
5197 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5200 /* drag-n-drop events are generated when a set of selected files are
5201 dragged from another application and dropped onto an Emacs window. */
5202 static const char *lispy_drag_n_drop_names
[] =
5207 /* Scroll bar parts. */
5208 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5209 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5210 Lisp_Object Qtop
, Qratio
;
5212 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5213 const Lisp_Object
*scroll_bar_parts
[] = {
5214 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5215 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5218 /* A vector, indexed by button number, giving the down-going location
5219 of currently depressed buttons, both scroll bar and non-scroll bar.
5221 The elements have the form
5222 (BUTTON-NUMBER MODIFIER-MASK . REST)
5223 where REST is the cdr of a position as it would be reported in the event.
5225 The make_lispy_event function stores positions here to tell the
5226 difference between click and drag events, and to store the starting
5227 location to be included in drag events. */
5229 static Lisp_Object button_down_location
;
5231 /* Information about the most recent up-going button event: Which
5232 button, what location, and what time. */
5234 static int last_mouse_button
;
5235 static int last_mouse_x
;
5236 static int last_mouse_y
;
5237 static unsigned long button_down_time
;
5239 /* The maximum time between clicks to make a double-click, or Qnil to
5240 disable double-click detection, or Qt for no time limit. */
5242 Lisp_Object Vdouble_click_time
;
5244 /* Maximum number of pixels the mouse may be moved between clicks
5245 to make a double-click. */
5247 EMACS_INT double_click_fuzz
;
5249 /* The number of clicks in this multiple-click. */
5251 int double_click_count
;
5253 /* Return position of a mouse click or wheel event */
5256 make_lispy_position (struct frame
*f
, Lisp_Object
*x
, Lisp_Object
*y
,
5260 enum window_part part
;
5261 Lisp_Object posn
= Qnil
;
5262 Lisp_Object extra_info
= Qnil
;
5265 /* Set `window' to the window under frame pixel coordinates (x,y) */
5267 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5268 &part
, &wx
, &wy
, 0);
5272 if (WINDOWP (window
))
5274 /* It's a click in window window at frame coordinates (x,y) */
5275 struct window
*w
= XWINDOW (window
);
5276 Lisp_Object string_info
= Qnil
;
5277 int textpos
= -1, rx
= -1, ry
= -1;
5278 int dx
= -1, dy
= -1;
5279 int width
= -1, height
= -1;
5280 Lisp_Object object
= Qnil
;
5282 /* Set event coordinates to window-relative coordinates
5283 for constructing the Lisp event below. */
5287 if (part
== ON_TEXT
)
5289 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5291 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5293 /* Mode line or header line. Look for a string under
5294 the mouse that may have a `local-map' property. */
5298 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5300 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5301 &object
, &dx
, &dy
, &width
, &height
);
5302 if (STRINGP (string
))
5303 string_info
= Fcons (string
, make_number (charpos
));
5304 if (w
== XWINDOW (selected_window
)
5305 && current_buffer
== XBUFFER (w
->buffer
))
5308 textpos
= XMARKER (w
->pointm
)->charpos
;
5310 else if (part
== ON_VERTICAL_BORDER
)
5312 posn
= Qvertical_line
;
5317 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5322 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5324 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5325 &object
, &dx
, &dy
, &width
, &height
);
5326 if (STRINGP (string
))
5327 string_info
= Fcons (string
, make_number (charpos
));
5328 if (part
== ON_LEFT_MARGIN
)
5331 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5333 else if (part
== ON_LEFT_FRINGE
)
5335 posn
= Qleft_fringe
;
5338 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5340 : window_box_width (w
, LEFT_MARGIN_AREA
));
5343 else if (part
== ON_RIGHT_FRINGE
)
5345 posn
= Qright_fringe
;
5348 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5349 + window_box_width (w
, TEXT_AREA
)
5350 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5351 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5357 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5358 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5363 Lisp_Object string2
, object2
= Qnil
;
5364 struct display_pos p
;
5366 int width2
, height2
;
5367 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5368 &object2
, &dx2
, &dy2
,
5370 textpos
= CHARPOS (p
.pos
);
5371 if (rx
< 0) rx
= wx
;
5372 if (ry
< 0) ry
= wy
;
5373 if (dx
< 0) dx
= dx2
;
5374 if (dy
< 0) dy
= dy2
;
5375 if (width
< 0) width
= width2
;
5376 if (height
< 0) height
= height2
;
5380 posn
= make_number (textpos
);
5381 if (STRINGP (string2
))
5382 string_info
= Fcons (string2
,
5383 make_number (CHARPOS (p
.string_pos
)));
5389 #ifdef HAVE_WINDOW_SYSTEM
5390 if (IMAGEP (object
))
5392 Lisp_Object image_map
, hotspot
;
5393 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5395 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5397 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5398 posn
= XCAR (hotspot
);
5403 extra_info
= Fcons (object
,
5404 Fcons (Fcons (make_number (dx
),
5406 Fcons (Fcons (make_number (width
),
5407 make_number (height
)),
5411 extra_info
= Fcons (string_info
,
5412 Fcons (make_number (textpos
),
5413 Fcons (Fcons (make_number (rx
),
5419 XSETFRAME (window
, f
);
5424 XSETFASTINT (*x
, 0);
5425 XSETFASTINT (*y
, 0);
5428 return Fcons (window
,
5430 Fcons (Fcons (*x
, *y
),
5431 Fcons (make_number (time
),
5435 /* Given a struct input_event, build the lisp event which represents
5436 it. If EVENT is 0, build a mouse movement event from the mouse
5437 movement buffer, which should have a movement event in it.
5439 Note that events must be passed to this function in the order they
5440 are received; this function stores the location of button presses
5441 in order to build drag events when the button is released. */
5444 make_lispy_event (struct input_event
*event
)
5448 switch (SWITCH_ENUM_CAST (event
->kind
))
5450 /* A simple keystroke. */
5451 case ASCII_KEYSTROKE_EVENT
:
5452 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5454 Lisp_Object lispy_c
;
5455 int c
= event
->code
;
5456 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5459 eassert (c
== event
->code
);
5460 /* Turn ASCII characters into control characters
5462 if (event
->modifiers
& ctrl_modifier
)
5464 c
= make_ctrl_char (c
);
5465 event
->modifiers
&= ~ctrl_modifier
;
5469 /* Add in the other modifier bits. The shift key was taken care
5470 of by the X code. */
5471 c
|= (event
->modifiers
5472 & (meta_modifier
| alt_modifier
5473 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5474 /* Distinguish Shift-SPC from SPC. */
5475 if ((event
->code
) == 040
5476 && event
->modifiers
& shift_modifier
)
5477 c
|= shift_modifier
;
5478 button_down_time
= 0;
5479 XSETFASTINT (lispy_c
, c
);
5484 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5485 except that they are non-key events (last-nonmenu-event is nil). */
5486 case NS_NONKEY_EVENT
:
5489 /* A function key. The symbol may need to have modifier prefixes
5491 case NON_ASCII_KEYSTROKE_EVENT
:
5492 button_down_time
= 0;
5494 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5495 if (event
->code
== lispy_accent_codes
[i
])
5496 return modify_event_symbol (i
,
5498 Qfunction_key
, Qnil
,
5499 lispy_accent_keys
, &accent_key_syms
,
5500 (sizeof (lispy_accent_keys
)
5501 / sizeof (lispy_accent_keys
[0])));
5505 if (event
->code
>= 0x400 && event
->code
< 0x500)
5506 return modify_event_symbol (event
->code
- 0x400,
5507 event
->modifiers
& ~shift_modifier
,
5508 Qfunction_key
, Qnil
,
5509 lispy_kana_keys
, &func_key_syms
,
5510 (sizeof (lispy_kana_keys
)
5511 / sizeof (lispy_kana_keys
[0])));
5512 #endif /* XK_kana_A */
5515 #ifdef ISO_FUNCTION_KEY_OFFSET
5516 if (event
->code
< FUNCTION_KEY_OFFSET
5517 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5518 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5520 Qfunction_key
, Qnil
,
5521 iso_lispy_function_keys
, &func_key_syms
,
5522 (sizeof (iso_lispy_function_keys
)
5523 / sizeof (iso_lispy_function_keys
[0])));
5526 /* Handle system-specific or unknown keysyms. */
5527 if (event
->code
& (1 << 28)
5528 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5529 || (event
->code
- FUNCTION_KEY_OFFSET
5530 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5531 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5533 /* We need to use an alist rather than a vector as the cache
5534 since we can't make a vector long enuf. */
5535 if (NILP (current_kboard
->system_key_syms
))
5536 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5537 return modify_event_symbol (event
->code
,
5540 current_kboard
->Vsystem_key_alist
,
5541 0, ¤t_kboard
->system_key_syms
,
5545 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5547 Qfunction_key
, Qnil
,
5548 lispy_function_keys
, &func_key_syms
,
5549 (sizeof (lispy_function_keys
)
5550 / sizeof (lispy_function_keys
[0])));
5553 case MULTIMEDIA_KEY_EVENT
:
5554 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5555 / sizeof (lispy_multimedia_keys
[0]))
5556 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5558 return modify_event_symbol (event
->code
, event
->modifiers
,
5559 Qfunction_key
, Qnil
,
5560 lispy_multimedia_keys
, &func_key_syms
,
5561 (sizeof (lispy_multimedia_keys
)
5562 / sizeof (lispy_multimedia_keys
[0])));
5568 /* A mouse click. Figure out where it is, decide whether it's
5569 a press, click or drag, and build the appropriate structure. */
5570 case MOUSE_CLICK_EVENT
:
5571 #ifndef USE_TOOLKIT_SCROLL_BARS
5572 case SCROLL_BAR_CLICK_EVENT
:
5575 int button
= event
->code
;
5577 Lisp_Object position
;
5578 Lisp_Object
*start_pos_ptr
;
5579 Lisp_Object start_pos
;
5583 /* Build the position as appropriate for this mouse click. */
5584 if (event
->kind
== MOUSE_CLICK_EVENT
)
5586 struct frame
*f
= XFRAME (event
->frame_or_window
);
5587 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5591 /* Ignore mouse events that were made on frame that
5592 have been deleted. */
5593 if (! FRAME_LIVE_P (f
))
5596 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5597 /* EVENT->x and EVENT->y are frame-relative pixel
5598 coordinates at this place. Under old redisplay, COLUMN
5599 and ROW are set to frame relative glyph coordinates
5600 which are then used to determine whether this click is
5601 in a menu (non-toolkit version). */
5602 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5603 &column
, &row
, NULL
, 1);
5605 /* In the non-toolkit version, clicks on the menu bar
5606 are ordinary button events in the event buffer.
5607 Distinguish them, and invoke the menu.
5609 (In the toolkit version, the toolkit handles the menu bar
5610 and Emacs doesn't know about it until after the user
5611 makes a selection.) */
5612 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5613 && (event
->modifiers
& down_modifier
))
5615 Lisp_Object items
, item
;
5620 /* Activate the menu bar on the down event. If the
5621 up event comes in before the menu code can deal with it,
5623 if (! (event
->modifiers
& down_modifier
))
5627 /* Find the menu bar item under `column'. */
5629 items
= FRAME_MENU_BAR_ITEMS (f
);
5630 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5632 Lisp_Object pos
, string
;
5633 string
= AREF (items
, i
+ 1);
5634 pos
= AREF (items
, i
+ 3);
5637 if (column
>= XINT (pos
)
5638 && column
< XINT (pos
) + SCHARS (string
))
5640 item
= AREF (items
, i
);
5645 /* ELisp manual 2.4b says (x y) are window relative but
5646 code says they are frame-relative. */
5648 = Fcons (event
->frame_or_window
,
5650 Fcons (Fcons (event
->x
, event
->y
),
5651 Fcons (make_number (event
->timestamp
),
5654 return Fcons (item
, Fcons (position
, Qnil
));
5656 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5658 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5661 #ifndef USE_TOOLKIT_SCROLL_BARS
5664 /* It's a scrollbar click. */
5666 Lisp_Object portion_whole
;
5669 window
= event
->frame_or_window
;
5670 portion_whole
= Fcons (event
->x
, event
->y
);
5671 part
= *scroll_bar_parts
[(int) event
->part
];
5675 Fcons (Qvertical_scroll_bar
,
5676 Fcons (portion_whole
,
5677 Fcons (make_number (event
->timestamp
),
5678 Fcons (part
, Qnil
)))));
5680 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5682 if (button
>= ASIZE (button_down_location
))
5684 button_down_location
= larger_vector (button_down_location
,
5686 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5689 start_pos_ptr
= &AREF (button_down_location
, button
);
5690 start_pos
= *start_pos_ptr
;
5691 *start_pos_ptr
= Qnil
;
5694 /* On window-system frames, use the value of
5695 double-click-fuzz as is. On other frames, interpret it
5696 as a multiple of 1/8 characters. */
5700 if (WINDOWP (event
->frame_or_window
))
5701 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5702 else if (FRAMEP (event
->frame_or_window
))
5703 f
= XFRAME (event
->frame_or_window
);
5707 if (FRAME_WINDOW_P (f
))
5708 fuzz
= double_click_fuzz
;
5710 fuzz
= double_click_fuzz
/ 8;
5712 is_double
= (button
== last_mouse_button
5713 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5714 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5715 && button_down_time
!= 0
5716 && (EQ (Vdouble_click_time
, Qt
)
5717 || (INTEGERP (Vdouble_click_time
)
5718 && ((int)(event
->timestamp
- button_down_time
)
5719 < XINT (Vdouble_click_time
)))));
5722 last_mouse_button
= button
;
5723 last_mouse_x
= XINT (event
->x
);
5724 last_mouse_y
= XINT (event
->y
);
5726 /* If this is a button press, squirrel away the location, so
5727 we can decide later whether it was a click or a drag. */
5728 if (event
->modifiers
& down_modifier
)
5732 double_click_count
++;
5733 event
->modifiers
|= ((double_click_count
> 2)
5738 double_click_count
= 1;
5739 button_down_time
= event
->timestamp
;
5740 *start_pos_ptr
= Fcopy_alist (position
);
5741 ignore_mouse_drag_p
= 0;
5744 /* Now we're releasing a button - check the co-ordinates to
5745 see if this was a click or a drag. */
5746 else if (event
->modifiers
& up_modifier
)
5748 /* If we did not see a down before this up, ignore the up.
5749 Probably this happened because the down event chose a
5750 menu item. It would be an annoyance to treat the
5751 release of the button that chose the menu item as a
5754 if (!CONSP (start_pos
))
5757 event
->modifiers
&= ~up_modifier
;
5758 #if 0 /* Formerly we treated an up with no down as a click event. */
5759 if (!CONSP (start_pos
))
5760 event
->modifiers
|= click_modifier
;
5765 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5767 /* The third element of every position
5768 should be the (x,y) pair. */
5769 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5771 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5773 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5774 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5777 if (ignore_mouse_drag_p
)
5779 event
->modifiers
|= click_modifier
;
5780 ignore_mouse_drag_p
= 0;
5782 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5783 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5784 /* Maybe the mouse has moved a lot, caused scrolling, and
5785 eventually ended up at the same screen position (but
5786 not buffer position) in which case it is a drag, not
5788 /* FIXME: OTOH if the buffer position has changed
5789 because of a timer or process filter rather than
5790 because of mouse movement, it should be considered as
5791 a click. But mouse-drag-region completely ignores
5792 this case and it hasn't caused any real problem, so
5793 it's probably OK to ignore it as well. */
5794 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5795 /* Mouse hasn't moved (much). */
5796 event
->modifiers
|= click_modifier
;
5799 button_down_time
= 0;
5800 event
->modifiers
|= drag_modifier
;
5803 /* Don't check is_double; treat this as multiple
5804 if the down-event was multiple. */
5805 if (double_click_count
> 1)
5806 event
->modifiers
|= ((double_click_count
> 2)
5812 /* Every mouse event should either have the down_modifier or
5813 the up_modifier set. */
5817 /* Get the symbol we should use for the mouse click. */
5820 head
= modify_event_symbol (button
,
5822 Qmouse_click
, Vlispy_mouse_stem
,
5825 XVECTOR (mouse_syms
)->size
);
5826 if (event
->modifiers
& drag_modifier
)
5831 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5834 Fcons (make_number (double_click_count
),
5844 case HORIZ_WHEEL_EVENT
:
5846 Lisp_Object position
;
5849 /* Build the position as appropriate for this mouse click. */
5850 struct frame
*f
= XFRAME (event
->frame_or_window
);
5852 /* Ignore wheel events that were made on frame that have been
5854 if (! FRAME_LIVE_P (f
))
5857 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5860 /* Set double or triple modifiers to indicate the wheel speed. */
5862 /* On window-system frames, use the value of
5863 double-click-fuzz as is. On other frames, interpret it
5864 as a multiple of 1/8 characters. */
5870 if (WINDOWP (event
->frame_or_window
))
5871 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5872 else if (FRAMEP (event
->frame_or_window
))
5873 f
= XFRAME (event
->frame_or_window
);
5877 if (FRAME_WINDOW_P (f
))
5878 fuzz
= double_click_fuzz
;
5880 fuzz
= double_click_fuzz
/ 8;
5882 if (event
->modifiers
& up_modifier
)
5884 /* Emit a wheel-up event. */
5885 event
->modifiers
&= ~up_modifier
;
5888 else if (event
->modifiers
& down_modifier
)
5890 /* Emit a wheel-down event. */
5891 event
->modifiers
&= ~down_modifier
;
5895 /* Every wheel event should either have the down_modifier or
5896 the up_modifier set. */
5899 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5902 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5903 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5904 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5905 && button_down_time
!= 0
5906 && (EQ (Vdouble_click_time
, Qt
)
5907 || (INTEGERP (Vdouble_click_time
)
5908 && ((int)(event
->timestamp
- button_down_time
)
5909 < XINT (Vdouble_click_time
)))));
5912 double_click_count
++;
5913 event
->modifiers
|= ((double_click_count
> 2)
5919 double_click_count
= 1;
5920 event
->modifiers
|= click_modifier
;
5923 button_down_time
= event
->timestamp
;
5924 /* Use a negative value to distinguish wheel from mouse button. */
5925 last_mouse_button
= - (1 + symbol_num
);
5926 last_mouse_x
= XINT (event
->x
);
5927 last_mouse_y
= XINT (event
->y
);
5929 /* Get the symbol we should use for the wheel event. */
5930 head
= modify_event_symbol (symbol_num
,
5936 ASIZE (wheel_syms
));
5939 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5942 Fcons (make_number (double_click_count
),
5951 #ifdef USE_TOOLKIT_SCROLL_BARS
5953 /* We don't have down and up events if using toolkit scroll bars,
5954 so make this always a click event. Store in the `part' of
5955 the Lisp event a symbol which maps to the following actions:
5957 `above_handle' page up
5958 `below_handle' page down
5962 `bottom' bottom of buffer
5963 `handle' thumb has been dragged.
5964 `end-scroll' end of interaction with scroll bar
5966 The incoming input_event contains in its `part' member an
5967 index of type `enum scroll_bar_part' which we can use as an
5968 index in scroll_bar_parts to get the appropriate symbol. */
5970 case SCROLL_BAR_CLICK_EVENT
:
5972 Lisp_Object position
, head
, window
, portion_whole
, part
;
5974 window
= event
->frame_or_window
;
5975 portion_whole
= Fcons (event
->x
, event
->y
);
5976 part
= *scroll_bar_parts
[(int) event
->part
];
5980 Fcons (Qvertical_scroll_bar
,
5981 Fcons (portion_whole
,
5982 Fcons (make_number (event
->timestamp
),
5983 Fcons (part
, Qnil
)))));
5985 /* Always treat scroll bar events as clicks. */
5986 event
->modifiers
|= click_modifier
;
5987 event
->modifiers
&= ~up_modifier
;
5989 if (event
->code
>= ASIZE (mouse_syms
))
5990 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5992 /* Get the symbol we should use for the mouse click. */
5993 head
= modify_event_symbol (event
->code
,
5998 XVECTOR (mouse_syms
)->size
);
5999 return Fcons (head
, Fcons (position
, Qnil
));
6002 #endif /* USE_TOOLKIT_SCROLL_BARS */
6004 case DRAG_N_DROP_EVENT
:
6007 Lisp_Object head
, position
;
6010 f
= XFRAME (event
->frame_or_window
);
6013 /* Ignore mouse events that were made on frames that
6014 have been deleted. */
6015 if (! FRAME_LIVE_P (f
))
6018 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6021 head
= modify_event_symbol (0, event
->modifiers
,
6023 lispy_drag_n_drop_names
,
6024 &drag_n_drop_syms
, 1);
6030 #endif /* HAVE_MOUSE */
6032 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6033 || defined(HAVE_NS) || defined (USE_GTK)
6034 case MENU_BAR_EVENT
:
6035 if (EQ (event
->arg
, event
->frame_or_window
))
6036 /* This is the prefix key. We translate this to
6037 `(menu_bar)' because the code in keyboard.c for menu
6038 events, which we use, relies on this. */
6039 return Fcons (Qmenu_bar
, Qnil
);
6043 case SELECT_WINDOW_EVENT
:
6044 /* Make an event (select-window (WINDOW)). */
6045 return Fcons (Qselect_window
,
6046 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6049 case TOOL_BAR_EVENT
:
6050 if (EQ (event
->arg
, event
->frame_or_window
))
6051 /* This is the prefix key. We translate this to
6052 `(tool_bar)' because the code in keyboard.c for tool bar
6053 events, which we use, relies on this. */
6054 return Fcons (Qtool_bar
, Qnil
);
6055 else if (SYMBOLP (event
->arg
))
6056 return apply_modifiers (event
->modifiers
, event
->arg
);
6059 case USER_SIGNAL_EVENT
:
6060 /* A user signal. */
6062 char *name
= find_user_signal_name (event
->code
);
6065 return intern (name
);
6068 case SAVE_SESSION_EVENT
:
6069 return Qsave_session
;
6074 return Fcons (Qdbus_event
, event
->arg
);
6076 #endif /* HAVE_DBUS */
6078 case CONFIG_CHANGED_EVENT
:
6079 return Fcons (Qconfig_changed_event
,
6081 Fcons (event
->frame_or_window
, Qnil
)));
6083 case GPM_CLICK_EVENT
:
6085 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6086 Lisp_Object head
, position
;
6087 Lisp_Object
*start_pos_ptr
;
6088 Lisp_Object start_pos
;
6089 int button
= event
->code
;
6091 if (button
>= ASIZE (button_down_location
))
6093 button_down_location
= larger_vector (button_down_location
,
6095 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6098 start_pos_ptr
= &AREF (button_down_location
, button
);
6099 start_pos
= *start_pos_ptr
;
6101 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6104 if (event
->modifiers
& down_modifier
)
6105 *start_pos_ptr
= Fcopy_alist (position
);
6106 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6108 if (!CONSP (start_pos
))
6110 event
->modifiers
&= ~up_modifier
;
6113 head
= modify_event_symbol (button
,
6115 Qmouse_click
, Vlispy_mouse_stem
,
6118 XVECTOR (mouse_syms
)->size
);
6120 if (event
->modifiers
& drag_modifier
)
6125 else if (event
->modifiers
& double_modifier
)
6128 Fcons (make_number (2),
6130 else if (event
->modifiers
& triple_modifier
)
6133 Fcons (make_number (3),
6140 #endif /* HAVE_GPM */
6142 /* The 'kind' field of the event is something we don't recognize. */
6148 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6151 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6152 Lisp_Object x
, Lisp_Object y
, unsigned long time
)
6154 /* Is it a scroll bar movement? */
6155 if (frame
&& ! NILP (bar_window
))
6157 Lisp_Object part_sym
;
6159 part_sym
= *scroll_bar_parts
[(int) part
];
6160 return Fcons (Qscroll_bar_movement
,
6161 (Fcons (Fcons (bar_window
,
6162 Fcons (Qvertical_scroll_bar
,
6163 Fcons (Fcons (x
, y
),
6164 Fcons (make_number (time
),
6170 /* Or is it an ordinary mouse movement? */
6173 Lisp_Object position
;
6175 position
= make_lispy_position (frame
, &x
, &y
, time
);
6177 return Fcons (Qmouse_movement
,
6183 #endif /* HAVE_MOUSE || HAVE GPM */
6185 /* Construct a switch frame event. */
6187 make_lispy_switch_frame (Lisp_Object frame
)
6189 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6192 /* Manipulating modifiers. */
6194 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6196 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6197 SYMBOL's name of the end of the modifiers; the string from this
6198 position is the unmodified symbol name.
6200 This doesn't use any caches. */
6203 parse_modifiers_uncached (Lisp_Object symbol
, int *modifier_end
)
6209 CHECK_SYMBOL (symbol
);
6212 name
= SYMBOL_NAME (symbol
);
6214 for (i
= 0; i
+2 <= SBYTES (name
); )
6216 int this_mod_end
= 0;
6219 /* See if the name continues with a modifier word.
6220 Check that the word appears, but don't check what follows it.
6221 Set this_mod and this_mod_end to record what we find. */
6223 switch (SREF (name
, i
))
6225 #define SINGLE_LETTER_MOD(BIT) \
6226 (this_mod_end = i + 1, this_mod = BIT)
6229 SINGLE_LETTER_MOD (alt_modifier
);
6233 SINGLE_LETTER_MOD (ctrl_modifier
);
6237 SINGLE_LETTER_MOD (hyper_modifier
);
6241 SINGLE_LETTER_MOD (meta_modifier
);
6245 SINGLE_LETTER_MOD (shift_modifier
);
6249 SINGLE_LETTER_MOD (super_modifier
);
6252 #undef SINGLE_LETTER_MOD
6254 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6255 if (i + LEN + 1 <= SBYTES (name) \
6256 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6258 this_mod_end = i + LEN; \
6263 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6264 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6265 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6269 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6271 #undef MULTI_LETTER_MOD
6275 /* If we found no modifier, stop looking for them. */
6276 if (this_mod_end
== 0)
6279 /* Check there is a dash after the modifier, so that it
6280 really is a modifier. */
6281 if (this_mod_end
>= SBYTES (name
)
6282 || SREF (name
, this_mod_end
) != '-')
6285 /* This modifier is real; look for another. */
6286 modifiers
|= this_mod
;
6287 i
= this_mod_end
+ 1;
6290 /* Should we include the `click' modifier? */
6291 if (! (modifiers
& (down_modifier
| drag_modifier
6292 | double_modifier
| triple_modifier
))
6293 && i
+ 7 == SBYTES (name
)
6294 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6295 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6296 modifiers
|= click_modifier
;
6298 if (! (modifiers
& (double_modifier
| triple_modifier
))
6299 && i
+ 6 < SBYTES (name
)
6300 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6301 modifiers
|= click_modifier
;
6309 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6310 prepended to the string BASE[0..BASE_LEN-1].
6311 This doesn't use any caches. */
6313 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6315 /* Since BASE could contain nulls, we can't use intern here; we have
6316 to use Fintern, which expects a genuine Lisp_String, and keeps a
6319 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6325 /* Only the event queue may use the `up' modifier; it should always
6326 be turned into a click or drag event before presented to lisp code. */
6327 if (modifiers
& up_modifier
)
6330 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6331 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6332 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6333 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6334 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6335 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6336 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6337 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6338 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6339 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6340 /* The click modifier is denoted by the absence of other modifiers. */
6344 mod_len
= p
- new_mods
;
6348 Lisp_Object new_name
;
6350 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6351 mod_len
+ base_len_byte
);
6352 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6353 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6355 return Fintern (new_name
, Qnil
);
6360 static const char *modifier_names
[] =
6362 "up", "down", "drag", "click", "double", "triple", 0, 0,
6363 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6364 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6366 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6368 static Lisp_Object modifier_symbols
;
6370 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6372 lispy_modifier_list (int modifiers
)
6374 Lisp_Object modifier_list
;
6377 modifier_list
= Qnil
;
6378 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6379 if (modifiers
& (1<<i
))
6380 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6383 return modifier_list
;
6387 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6388 where UNMODIFIED is the unmodified form of SYMBOL,
6389 MASK is the set of modifiers present in SYMBOL's name.
6390 This is similar to parse_modifiers_uncached, but uses the cache in
6391 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6392 Qevent_symbol_elements property. */
6394 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6397 parse_modifiers (Lisp_Object symbol
)
6399 Lisp_Object elements
;
6401 if (INTEGERP (symbol
))
6402 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6403 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6405 else if (!SYMBOLP (symbol
))
6408 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6409 if (CONSP (elements
))
6414 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6415 Lisp_Object unmodified
;
6418 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6419 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6422 if (modifiers
& ~INTMASK
)
6424 XSETFASTINT (mask
, modifiers
);
6425 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6427 /* Cache the parsing results on SYMBOL. */
6428 Fput (symbol
, Qevent_symbol_element_mask
,
6430 Fput (symbol
, Qevent_symbol_elements
,
6431 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6433 /* Since we know that SYMBOL is modifiers applied to unmodified,
6434 it would be nice to put that in unmodified's cache.
6435 But we can't, since we're not sure that parse_modifiers is
6442 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6443 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6444 doc
: /* Parse the event symbol. For internal use. */)
6445 (Lisp_Object symbol
)
6447 /* Fill the cache if needed. */
6448 parse_modifiers (symbol
);
6449 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6450 and use the Lispier representation stored on Qevent_symbol_elements
6452 return Fget (symbol
, Qevent_symbol_elements
);
6455 /* Apply the modifiers MODIFIERS to the symbol BASE.
6456 BASE must be unmodified.
6458 This is like apply_modifiers_uncached, but uses BASE's
6459 Qmodifier_cache property, if present. It also builds
6460 Qevent_symbol_elements properties, since it has that info anyway.
6462 apply_modifiers copies the value of BASE's Qevent_kind property to
6463 the modified symbol. */
6465 apply_modifiers (int modifiers
, Lisp_Object base
)
6467 Lisp_Object cache
, index
, entry
, new_symbol
;
6469 /* Mask out upper bits. We don't know where this value's been. */
6470 modifiers
&= INTMASK
;
6472 if (INTEGERP (base
))
6473 return make_number (XINT (base
) | modifiers
);
6475 /* The click modifier never figures into cache indices. */
6476 cache
= Fget (base
, Qmodifier_cache
);
6477 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6478 entry
= assq_no_quit (index
, cache
);
6481 new_symbol
= XCDR (entry
);
6484 /* We have to create the symbol ourselves. */
6485 new_symbol
= apply_modifiers_uncached (modifiers
,
6486 SDATA (SYMBOL_NAME (base
)),
6487 SCHARS (SYMBOL_NAME (base
)),
6488 SBYTES (SYMBOL_NAME (base
)));
6490 /* Add the new symbol to the base's cache. */
6491 entry
= Fcons (index
, new_symbol
);
6492 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6494 /* We have the parsing info now for free, so we could add it to
6496 XSETFASTINT (index, modifiers);
6497 Fput (new_symbol, Qevent_symbol_element_mask,
6498 Fcons (base, Fcons (index, Qnil)));
6499 Fput (new_symbol, Qevent_symbol_elements,
6500 Fcons (base, lispy_modifier_list (modifiers)));
6501 Sadly, this is only correct if `base' is indeed a base event,
6502 which is not necessarily the case. -stef */
6505 /* Make sure this symbol is of the same kind as BASE.
6507 You'd think we could just set this once and for all when we
6508 intern the symbol above, but reorder_modifiers may call us when
6509 BASE's property isn't set right; we can't assume that just
6510 because it has a Qmodifier_cache property it must have its
6511 Qevent_kind set right as well. */
6512 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6516 kind
= Fget (base
, Qevent_kind
);
6518 Fput (new_symbol
, Qevent_kind
, kind
);
6525 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6526 return a symbol with the modifiers placed in the canonical order.
6527 Canonical order is alphabetical, except for down and drag, which
6528 always come last. The 'click' modifier is never written out.
6530 Fdefine_key calls this to make sure that (for example) C-M-foo
6531 and M-C-foo end up being equivalent in the keymap. */
6534 reorder_modifiers (Lisp_Object symbol
)
6536 /* It's hopefully okay to write the code this way, since everything
6537 will soon be in caches, and no consing will be done at all. */
6540 parsed
= parse_modifiers (symbol
);
6541 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6546 /* For handling events, we often want to produce a symbol whose name
6547 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6548 to some base, like the name of a function key or mouse button.
6549 modify_event_symbol produces symbols of this sort.
6551 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6552 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6555 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6556 into symbol names, or a string specifying a name stem used to
6557 construct a symbol name or the form `STEM-N', where N is the decimal
6558 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6559 non-nil; otherwise NAME_TABLE is used.
6561 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6562 persist between calls to modify_event_symbol that it can use to
6563 store a cache of the symbols it's generated for this NAME_TABLE
6564 before. The object stored there may be a vector or an alist.
6566 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6568 MODIFIERS is a set of modifier bits (as given in struct input_events)
6569 whose prefixes should be applied to the symbol name.
6571 SYMBOL_KIND is the value to be placed in the event_kind property of
6572 the returned symbol.
6574 The symbols we create are supposed to have an
6575 `event-symbol-elements' property, which lists the modifiers present
6576 in the symbol's name. */
6579 modify_event_symbol (int symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6580 Lisp_Object name_alist_or_stem
, const char **name_table
,
6581 Lisp_Object
*symbol_table
, unsigned int table_size
)
6584 Lisp_Object symbol_int
;
6586 /* Get rid of the "vendor-specific" bit here. */
6587 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6589 /* Is this a request for a valid symbol? */
6590 if (symbol_num
< 0 || symbol_num
>= table_size
)
6593 if (CONSP (*symbol_table
))
6594 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6596 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6597 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6598 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6599 we've never used that symbol before. */
6602 if (! VECTORP (*symbol_table
)
6603 || XVECTOR (*symbol_table
)->size
!= table_size
)
6607 XSETFASTINT (size
, table_size
);
6608 *symbol_table
= Fmake_vector (size
, Qnil
);
6611 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6614 /* Have we already used this symbol before? */
6617 /* No; let's create it. */
6618 if (CONSP (name_alist_or_stem
))
6619 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6620 else if (STRINGP (name_alist_or_stem
))
6622 int len
= SBYTES (name_alist_or_stem
);
6623 char *buf
= (char *) alloca (len
+ 50);
6624 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6625 (long) XINT (symbol_int
) + 1);
6626 value
= intern (buf
);
6628 else if (name_table
!= 0 && name_table
[symbol_num
])
6629 value
= intern (name_table
[symbol_num
]);
6631 #ifdef HAVE_WINDOW_SYSTEM
6634 char *name
= x_get_keysym_name (symbol_num
);
6636 value
= intern (name
);
6643 sprintf (buf
, "key-%d", symbol_num
);
6644 value
= intern (buf
);
6647 if (CONSP (*symbol_table
))
6648 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6650 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6652 /* Fill in the cache entries for this symbol; this also
6653 builds the Qevent_symbol_elements property, which the user
6655 apply_modifiers (modifiers
& click_modifier
, value
);
6656 Fput (value
, Qevent_kind
, symbol_kind
);
6659 /* Apply modifiers to that symbol. */
6660 return apply_modifiers (modifiers
, value
);
6663 /* Convert a list that represents an event type,
6664 such as (ctrl meta backspace), into the usual representation of that
6665 event type as a number or a symbol. */
6667 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6668 doc
: /* Convert the event description list EVENT-DESC to an event type.
6669 EVENT-DESC should contain one base event type (a character or symbol)
6670 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6671 drag, down, double or triple). The base must be last.
6672 The return value is an event type (a character or symbol) which
6673 has the same base event type and all the specified modifiers. */)
6674 (Lisp_Object event_desc
)
6682 while (CONSP (rest
))
6690 /* Given a symbol, see if it is a modifier name. */
6691 if (SYMBOLP (elt
) && CONSP (rest
))
6692 this = parse_solitary_modifier (elt
);
6696 else if (!NILP (base
))
6697 error ("Two bases given in one event");
6703 /* Let the symbol A refer to the character A. */
6704 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6705 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6707 if (INTEGERP (base
))
6709 /* Turn (shift a) into A. */
6710 if ((modifiers
& shift_modifier
) != 0
6711 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6713 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6714 modifiers
&= ~shift_modifier
;
6717 /* Turn (control a) into C-a. */
6718 if (modifiers
& ctrl_modifier
)
6719 return make_number ((modifiers
& ~ctrl_modifier
)
6720 | make_ctrl_char (XINT (base
)));
6722 return make_number (modifiers
| XINT (base
));
6724 else if (SYMBOLP (base
))
6725 return apply_modifiers (modifiers
, base
);
6728 error ("Invalid base event");
6733 /* Try to recognize SYMBOL as a modifier name.
6734 Return the modifier flag bit, or 0 if not recognized. */
6737 parse_solitary_modifier (Lisp_Object symbol
)
6739 Lisp_Object name
= SYMBOL_NAME (symbol
);
6741 switch (SREF (name
, 0))
6743 #define SINGLE_LETTER_MOD(BIT) \
6744 if (SBYTES (name) == 1) \
6747 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6748 if (LEN == SBYTES (name) \
6749 && ! strncmp (SDATA (name), NAME, LEN)) \
6753 SINGLE_LETTER_MOD (alt_modifier
);
6757 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6761 SINGLE_LETTER_MOD (ctrl_modifier
);
6765 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6766 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6770 SINGLE_LETTER_MOD (hyper_modifier
);
6774 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6778 SINGLE_LETTER_MOD (meta_modifier
);
6782 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6786 SINGLE_LETTER_MOD (shift_modifier
);
6790 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6791 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6792 SINGLE_LETTER_MOD (super_modifier
);
6796 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6797 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6798 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6802 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6805 #undef SINGLE_LETTER_MOD
6806 #undef MULTI_LETTER_MOD
6812 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6813 Such a list is not valid as an event,
6814 but it can be a Lucid-style event type list. */
6817 lucid_event_type_list_p (Lisp_Object object
)
6821 if (! CONSP (object
))
6824 if (EQ (XCAR (object
), Qhelp_echo
)
6825 || EQ (XCAR (object
), Qvertical_line
)
6826 || EQ (XCAR (object
), Qmode_line
)
6827 || EQ (XCAR (object
), Qheader_line
))
6830 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6834 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6841 /* Store into *addr a value nonzero if terminal input chars are available.
6842 Serves the purpose of ioctl (0, FIONREAD, addr)
6843 but works even if FIONREAD does not exist.
6844 (In fact, this may actually read some input.)
6846 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6847 timer events that are ripe.
6848 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6849 events (FOCUS_IN_EVENT).
6850 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6851 movements and toolkit scroll bar thumb drags. */
6854 get_input_pending (int *addr
, int flags
)
6856 /* First of all, have we already counted some input? */
6857 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6859 /* If input is being read as it arrives, and we have none, there is none. */
6860 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6863 /* Try to read some input and see how much we get. */
6865 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6868 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6871 gobble_input (int expected
)
6874 /* Read D-Bus messages. */
6875 xd_read_queued_messages ();
6876 #endif /* HAVE_DBUS */
6879 if (interrupt_input
)
6882 mask
= sigblock (sigmask (SIGIO
));
6883 read_avail_input (expected
);
6887 #ifdef POLL_FOR_INPUT
6888 /* XXX This condition was (read_socket_hook && !interrupt_input),
6889 but read_socket_hook is not global anymore. Let's pretend that
6891 if (!interrupt_input
&& poll_suppress_count
== 0)
6894 mask
= sigblock (sigmask (SIGALRM
));
6895 read_avail_input (expected
);
6901 read_avail_input (expected
);
6904 /* Put a BUFFER_SWITCH_EVENT in the buffer
6905 so that read_key_sequence will notice the new current buffer. */
6908 record_asynch_buffer_change (void)
6910 struct input_event event
;
6914 event
.kind
= BUFFER_SWITCH_EVENT
;
6915 event
.frame_or_window
= Qnil
;
6918 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6919 The purpose of the event is to make read_key_sequence look up the
6920 keymaps again. If we aren't in read_key_sequence, we don't need one,
6921 and the event could cause trouble by messing up (input-pending-p).
6922 Note: Fwaiting_for_user_input_p always returns nil when async
6923 subprocesses aren't supported. */
6924 tem
= Fwaiting_for_user_input_p ();
6928 /* Make sure no interrupt happens while storing the event. */
6930 if (interrupt_input
)
6933 mask
= sigblock (sigmask (SIGIO
));
6934 kbd_buffer_store_event (&event
);
6941 kbd_buffer_store_event (&event
);
6946 /* Read any terminal input already buffered up by the system
6947 into the kbd_buffer, but do not wait.
6949 EXPECTED should be nonzero if the caller knows there is some input.
6951 Returns the number of keyboard chars read, or -1 meaning
6952 this is a bad time to try to read input. */
6955 read_avail_input (int expected
)
6961 /* Store pending user signal events, if any. */
6962 if (store_user_signal_events ())
6965 /* Loop through the available terminals, and call their input hooks. */
6969 struct terminal
*next
= t
->next_terminal
;
6971 if (t
->read_socket_hook
)
6974 struct input_event hold_quit
;
6976 EVENT_INIT (hold_quit
);
6977 hold_quit
.kind
= NO_EVENT
;
6979 /* No need for FIONREAD or fcntl; just say don't wait. */
6980 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6986 if (nr
== -1) /* Not OK to read input now. */
6990 else if (nr
== -2) /* Non-transient error. */
6992 /* The terminal device terminated; it should be closed. */
6994 /* Kill Emacs if this was our last terminal. */
6995 if (!terminal_list
->next_terminal
)
6996 /* Formerly simply reported no input, but that
6997 sometimes led to a failure of Emacs to terminate.
6998 SIGHUP seems appropriate if we can't reach the
7000 /* ??? Is it really right to send the signal just to
7001 this process rather than to the whole process
7002 group? Perhaps on systems with FIONREAD Emacs is
7003 alone in its group. */
7004 kill (getpid (), SIGHUP
);
7006 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7009 XSETTERMINAL (tmp
, t
);
7010 Fdelete_terminal (tmp
, Qnoelisp
);
7014 if (hold_quit
.kind
!= NO_EVENT
)
7015 kbd_buffer_store_event (&hold_quit
);
7024 frame_make_pointer_visible ();
7030 decode_keyboard_code (struct tty_display_info
*tty
,
7031 struct coding_system
*coding
,
7032 unsigned char *buf
, int nbytes
)
7034 unsigned char *src
= buf
;
7035 const unsigned char *p
;
7040 if (tty
->meta_key
!= 2)
7041 for (i
= 0; i
< nbytes
; i
++)
7043 if (coding
->carryover_bytes
> 0)
7045 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7046 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7047 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7048 nbytes
+= coding
->carryover_bytes
;
7050 coding
->destination
= alloca (nbytes
* 4);
7051 coding
->dst_bytes
= nbytes
* 4;
7052 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7053 if (coding
->produced_char
== 0)
7055 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7057 struct input_event buf
;
7060 buf
.code
= STRING_CHAR_ADVANCE (p
);
7061 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7062 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7063 /* See the comment in tty_read_avail_input. */
7064 buf
.frame_or_window
= tty
->top_frame
;
7066 kbd_buffer_store_event (&buf
);
7070 /* This is the tty way of reading available input.
7072 Note that each terminal device has its own `struct terminal' object,
7073 and so this function is called once for each individual termcap
7074 terminal. The first parameter indicates which terminal to read from. */
7077 tty_read_avail_input (struct terminal
*terminal
,
7079 struct input_event
*hold_quit
)
7081 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7082 the kbd_buffer can really hold. That may prevent loss
7083 of characters on some systems when input is stuffed at us. */
7084 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7086 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7088 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
7090 if (kbd_on_hold_p () || buffer_free
<= 0)
7093 if (!terminal
->name
) /* Don't read from a dead terminal. */
7096 if (terminal
->type
!= output_termcap
7097 && terminal
->type
!= output_msdos_raw
)
7100 /* XXX I think the following code should be moved to separate hook
7101 functions in system-dependent files. */
7104 #else /* not WINDOWSNT */
7105 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7109 return 0; /* The terminal is suspended. */
7112 n_to_read
= dos_keysns ();
7116 cbuf
[0] = dos_keyread ();
7119 #else /* not MSDOS */
7124 struct input_event hold_quit
;
7125 int gpm
, fd
= gpm_fd
;
7127 EVENT_INIT (hold_quit
);
7128 hold_quit
.kind
= NO_EVENT
;
7130 /* gpm==1 if event received.
7131 gpm==0 if the GPM daemon has closed the connection, in which case
7132 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7133 we save it in `fd' so close_gpm can remove it from the
7135 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7136 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7137 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7140 /* Presumably the GPM daemon has closed the connection. */
7142 if (hold_quit
.kind
!= NO_EVENT
)
7143 kbd_buffer_store_event (&hold_quit
);
7147 #endif /* HAVE_GPM */
7149 /* Determine how many characters we should *try* to read. */
7151 /* Find out how much input is available. */
7152 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7154 if (! noninteractive
)
7155 return -2; /* Close this terminal. */
7161 if (n_to_read
> sizeof cbuf
)
7162 n_to_read
= sizeof cbuf
;
7163 #else /* no FIONREAD */
7164 #if defined (USG) || defined(CYGWIN)
7165 /* Read some input if available, but don't wait. */
7166 n_to_read
= sizeof cbuf
;
7167 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7173 /* Don't read more than we can store. */
7174 if (n_to_read
> buffer_free
)
7175 n_to_read
= buffer_free
;
7177 /* Now read; for one reason or another, this will not block.
7178 NREAD is set to the number of chars read. */
7181 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7182 /* POSIX infers that processes which are not in the session leader's
7183 process group won't get SIGHUP's at logout time. BSDI adheres to
7184 this part standard and returns -1 from read (0) with errno==EIO
7185 when the control tty is taken away.
7186 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7187 if (nread
== -1 && errno
== EIO
)
7188 return -2; /* Close this terminal. */
7189 #if defined (AIX) && defined (_BSD)
7190 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7191 This looks incorrect, but it isn't, because _BSD causes
7192 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7193 and that causes a value other than 0 when there is no input. */
7195 return -2; /* Close this terminal. */
7199 /* We used to retry the read if it was interrupted.
7200 But this does the wrong thing when O_NDELAY causes
7201 an EAGAIN error. Does anybody know of a situation
7202 where a retry is actually needed? */
7204 nread
< 0 && (errno
== EAGAIN
7218 #if defined (USG) || defined (CYGWIN)
7219 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7220 #endif /* USG or CYGWIN */
7221 #endif /* no FIONREAD */
7226 #endif /* not MSDOS */
7227 #endif /* not WINDOWSNT */
7229 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7230 & CODING_REQUIRE_DECODING_MASK
)
7232 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7235 /* Decode the key sequence except for those with meta
7237 for (i
= from
= 0; ; i
++)
7238 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7240 struct input_event buf
;
7242 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7247 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7248 buf
.modifiers
= meta_modifier
;
7249 buf
.code
= cbuf
[i
] & ~0x80;
7250 /* See the comment below. */
7251 buf
.frame_or_window
= tty
->top_frame
;
7253 kbd_buffer_store_event (&buf
);
7259 for (i
= 0; i
< nread
; i
++)
7261 struct input_event buf
;
7263 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7265 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7266 buf
.modifiers
= meta_modifier
;
7267 if (tty
->meta_key
!= 2)
7271 /* Set the frame corresponding to the active tty. Note that the
7272 value of selected_frame is not reliable here, redisplay tends
7273 to temporarily change it. */
7274 buf
.frame_or_window
= tty
->top_frame
;
7277 kbd_buffer_store_event (&buf
);
7278 /* Don't look at input that follows a C-g too closely.
7279 This reduces lossage due to autorepeat on C-g. */
7280 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7281 && buf
.code
== quit_char
)
7289 handle_async_input (void)
7291 interrupt_input_pending
= 0;
7293 pending_signals
= pending_atimers
;
7295 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7296 doing anything dangerous. */
7303 nread
= read_avail_input (1);
7304 /* -1 means it's not ok to read the input now.
7305 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7306 0 means there was no keyboard input available. */
7316 process_pending_signals (void)
7318 if (interrupt_input_pending
)
7319 handle_async_input ();
7320 do_pending_atimers ();
7323 #ifdef SIGIO /* for entire page */
7324 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7327 input_available_signal (int signo
)
7329 /* Must preserve main program's value of errno. */
7330 int old_errno
= errno
;
7331 SIGNAL_THREAD_CHECK (signo
);
7334 interrupt_input_pending
= 1;
7335 pending_signals
= 1;
7338 if (input_available_clear_time
)
7339 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7342 handle_async_input ();
7349 /* Send ourselves a SIGIO.
7351 This function exists so that the UNBLOCK_INPUT macro in
7352 blockinput.h can have some way to take care of input we put off
7353 dealing with, without assuming that every file which uses
7354 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7356 reinvoke_input_signal (void)
7359 handle_async_input ();
7365 /* User signal events. */
7367 struct user_signal_info
7369 /* Signal number. */
7372 /* Name of the signal. */
7375 /* Number of pending signals. */
7378 struct user_signal_info
*next
;
7381 /* List of user signals. */
7382 static struct user_signal_info
*user_signals
= NULL
;
7385 add_user_signal (int sig
, const char *name
)
7387 struct user_signal_info
*p
;
7389 for (p
= user_signals
; p
; p
= p
->next
)
7391 /* Already added. */
7394 p
= xmalloc (sizeof (struct user_signal_info
));
7396 p
->name
= xstrdup (name
);
7398 p
->next
= user_signals
;
7401 signal (sig
, handle_user_signal
);
7405 handle_user_signal (int sig
)
7407 int old_errno
= errno
;
7408 struct user_signal_info
*p
;
7410 SIGNAL_THREAD_CHECK (sig
);
7412 for (p
= user_signals
; p
; p
= p
->next
)
7417 if (interrupt_input
)
7418 kill (getpid (), SIGIO
);
7422 /* Tell wait_reading_process_output that it needs to wake
7423 up and look around. */
7424 if (input_available_clear_time
)
7425 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7434 find_user_signal_name (int sig
)
7436 struct user_signal_info
*p
;
7438 for (p
= user_signals
; p
; p
= p
->next
)
7446 store_user_signal_events (void)
7448 struct user_signal_info
*p
;
7449 struct input_event buf
;
7452 for (p
= user_signals
; p
; p
= p
->next
)
7453 if (p
->npending
> 0)
7459 memset (&buf
, 0, sizeof buf
);
7460 buf
.kind
= USER_SIGNAL_EVENT
;
7461 buf
.frame_or_window
= selected_frame
;
7463 nstored
+= p
->npending
;
7465 mask
= sigblock (sigmask (p
->sig
));
7469 kbd_buffer_store_event (&buf
);
7472 while (p
->npending
> 0);
7480 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7481 static Lisp_Object menu_bar_one_keymap_changed_items
;
7483 /* These variables hold the vector under construction within
7484 menu_bar_items and its subroutines, and the current index
7485 for storing into that vector. */
7486 static Lisp_Object menu_bar_items_vector
;
7487 static int menu_bar_items_index
;
7489 /* Return a vector of menu items for a menu bar, appropriate
7490 to the current buffer. Each item has three elements in the vector:
7493 OLD is an old vector we can optionally reuse, or nil. */
7496 menu_bar_items (Lisp_Object old
)
7498 /* The number of keymaps we're scanning right now, and the number of
7499 keymaps we have allocated space for. */
7502 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7503 in the current keymaps, or nil where it is not a prefix. */
7506 Lisp_Object def
, tail
;
7515 /* In order to build the menus, we need to call the keymap
7516 accessors. They all call QUIT. But this function is called
7517 during redisplay, during which a quit is fatal. So inhibit
7518 quitting while building the menus.
7519 We do this instead of specbind because (1) errors will clear it anyway
7520 and (2) this avoids risk of specpdl overflow. */
7521 oquit
= Vinhibit_quit
;
7525 menu_bar_items_vector
= old
;
7527 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7528 menu_bar_items_index
= 0;
7530 /* Build our list of keymaps.
7531 If we recognize a function key and replace its escape sequence in
7532 keybuf with its symbol, or if the sequence starts with a mouse
7533 click and we need to switch buffers, we jump back here to rebuild
7534 the initial keymaps from the current buffer. */
7538 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7539 if (!NILP (Voverriding_local_map_menu_flag
))
7541 /* Yes, use them (if non-nil) as well as the global map. */
7542 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7544 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7545 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7546 if (!NILP (Voverriding_local_map
))
7547 maps
[nmaps
++] = Voverriding_local_map
;
7551 /* No, so use major and minor mode keymaps and keymap property.
7552 Note that menu-bar bindings in the local-map and keymap
7553 properties may not work reliable, as they are only
7554 recognized when the menu-bar (or mode-line) is updated,
7555 which does not normally happen after every command. */
7558 nminor
= current_minor_maps (NULL
, &tmaps
);
7559 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7561 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7562 maps
[nmaps
++] = tem
;
7563 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7565 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7567 maps
[nmaps
++] = current_global_map
;
7570 /* Look up in each map the dummy prefix key `menu-bar'. */
7574 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7575 if (!NILP (maps
[mapno
]))
7577 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7581 menu_bar_one_keymap_changed_items
= Qnil
;
7582 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7586 /* Move to the end those items that should be at the end. */
7588 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7591 int end
= menu_bar_items_index
;
7593 for (i
= 0; i
< end
; i
+= 4)
7594 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7596 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7597 /* Move the item at index I to the end,
7598 shifting all the others forward. */
7599 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7600 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7601 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7602 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7604 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7605 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7606 (end
- i
- 4) * sizeof (Lisp_Object
));
7607 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7608 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7609 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7610 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7615 /* Add nil, nil, nil, nil at the end. */
7616 i
= menu_bar_items_index
;
7617 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7618 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7619 /* Add this item. */
7620 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7621 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7622 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7623 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7624 menu_bar_items_index
= i
;
7626 Vinhibit_quit
= oquit
;
7627 return menu_bar_items_vector
;
7630 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7631 If there's already an item for KEY, add this DEF to it. */
7633 Lisp_Object item_properties
;
7636 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7638 struct gcpro gcpro1
;
7642 if (EQ (item
, Qundefined
))
7644 /* If a map has an explicit `undefined' as definition,
7645 discard any previously made menu bar item. */
7647 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7648 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7650 if (menu_bar_items_index
> i
+ 4)
7651 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7652 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7653 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7654 menu_bar_items_index
-= 4;
7658 /* If this keymap has already contributed to this KEY,
7659 don't contribute to it a second time. */
7660 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7661 if (!NILP (tem
) || NILP (item
))
7664 menu_bar_one_keymap_changed_items
7665 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7667 /* We add to menu_bar_one_keymap_changed_items before doing the
7668 parse_menu_item, so that if it turns out it wasn't a menu item,
7669 it still correctly hides any further menu item. */
7671 i
= parse_menu_item (item
, 1);
7676 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7678 /* Find any existing item for this KEY. */
7679 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7680 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7683 /* If we did not find this KEY, add it at the end. */
7684 if (i
== menu_bar_items_index
)
7686 /* If vector is too small, get a bigger one. */
7687 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7688 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7689 /* Add this item. */
7690 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7691 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7692 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7693 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7694 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7695 menu_bar_items_index
= i
;
7697 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7701 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7702 /* If the new and the old items are not both keymaps,
7703 the lookup will only find `item'. */
7704 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7705 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7709 /* This is used as the handler when calling menu_item_eval_property. */
7711 menu_item_eval_property_1 (Lisp_Object arg
)
7713 /* If we got a quit from within the menu computation,
7714 quit all the way out of it. This takes care of C-] in the debugger. */
7715 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7716 Fsignal (Qquit
, Qnil
);
7721 /* Evaluate an expression and return the result (or nil if something
7722 went wrong). Used to evaluate dynamic parts of menu items. */
7724 menu_item_eval_property (Lisp_Object sexpr
)
7726 int count
= SPECPDL_INDEX ();
7728 specbind (Qinhibit_redisplay
, Qt
);
7729 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7730 menu_item_eval_property_1
);
7731 return unbind_to (count
, val
);
7734 /* This function parses a menu item and leaves the result in the
7735 vector item_properties.
7736 ITEM is a key binding, a possible 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 (Lisp_Object item
, int inmenubar
)
7746 Lisp_Object def
, tem
, item_string
, start
;
7748 Lisp_Object keyhint
;
7757 /* Create item_properties vector if necessary. */
7758 if (NILP (item_properties
))
7760 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7762 /* Initialize optional entries. */
7763 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7764 ASET (item_properties
, i
, Qnil
);
7765 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7767 /* Save the item here to protect it from GC. */
7768 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7770 item_string
= XCAR (item
);
7774 if (STRINGP (item_string
))
7776 /* Old format menu item. */
7777 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7779 /* Maybe help string. */
7780 if (CONSP (item
) && STRINGP (XCAR (item
)))
7782 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7787 /* Maybe an obsolete key binding cache. */
7788 if (CONSP (item
) && CONSP (XCAR (item
))
7789 && (NILP (XCAR (XCAR (item
)))
7790 || VECTORP (XCAR (XCAR (item
)))))
7793 /* This is the real definition--the function to run. */
7794 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7796 /* Get enable property, if any. */
7799 tem
= Fget (item
, Qmenu_enable
);
7800 if (!NILP (Venable_disabled_menus_and_buttons
))
7801 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7802 else if (!NILP (tem
))
7803 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7806 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7808 /* New format menu item. */
7809 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7810 start
= XCDR (item
);
7813 /* We have a real binding. */
7814 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7816 item
= XCDR (start
);
7817 /* Is there an obsolete cache list with key equivalences. */
7818 if (CONSP (item
) && CONSP (XCAR (item
)))
7821 /* Parse properties. */
7822 while (CONSP (item
) && CONSP (XCDR (item
)))
7827 if (EQ (tem
, QCenable
))
7829 if (!NILP (Venable_disabled_menus_and_buttons
))
7830 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7832 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7834 else if (EQ (tem
, QCvisible
))
7836 /* If got a visible property and that evaluates to nil
7837 then ignore this item. */
7838 tem
= menu_item_eval_property (XCAR (item
));
7842 else if (EQ (tem
, QChelp
))
7843 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7844 else if (EQ (tem
, QCfilter
))
7846 else if (EQ (tem
, QCkey_sequence
))
7849 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7850 /* Be GC protected. Set keyhint to item instead of tem. */
7853 else if (EQ (tem
, QCkeys
))
7856 if (CONSP (tem
) || STRINGP (tem
))
7857 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7859 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7864 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7866 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7868 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7874 else if (inmenubar
|| !NILP (start
))
7878 return 0; /* not a menu item */
7880 /* If item string is not a string, evaluate it to get string.
7881 If we don't get a string, skip this item. */
7882 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7883 if (!(STRINGP (item_string
)))
7885 item_string
= menu_item_eval_property (item_string
);
7886 if (!STRINGP (item_string
))
7888 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7891 /* If got a filter apply it on definition. */
7892 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7895 def
= menu_item_eval_property (list2 (XCAR (filter
),
7896 list2 (Qquote
, def
)));
7898 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7901 /* Enable or disable selection of item. */
7902 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7905 tem
= menu_item_eval_property (tem
);
7906 if (inmenubar
&& NILP (tem
))
7907 return 0; /* Ignore disabled items in menu bar. */
7908 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7911 /* If we got no definition, this item is just unselectable text which
7912 is OK in a submenu but not in the menubar. */
7914 return (inmenubar
? 0 : 1);
7916 /* See if this is a separate pane or a submenu. */
7917 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7918 tem
= get_keymap (def
, 0, 1);
7919 /* For a subkeymap, just record its details and exit. */
7922 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7923 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7927 /* At the top level in the menu bar, do likewise for commands also.
7928 The menu bar does not display equivalent key bindings anyway.
7929 ITEM_PROPERTY_DEF is already set up properly. */
7933 { /* This is a command. See if there is an equivalent key binding. */
7934 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7936 /* The previous code preferred :key-sequence to :keys, so we
7937 preserve this behavior. */
7938 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7939 keyeq
= Fsubstitute_command_keys (keyeq
);
7942 Lisp_Object prefix
= keyeq
;
7943 Lisp_Object keys
= Qnil
;
7947 def
= XCAR (prefix
);
7948 prefix
= XCDR (prefix
);
7951 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7953 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7955 keys
= XCAR (keyhint
);
7956 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7958 /* We have a suggested key. Is it bound to the command? */
7961 /* If the command is an alias for another
7962 (such as lmenu.el set it up), check if the
7963 original command matches the cached command. */
7964 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7969 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7973 tem
= Fkey_description (keys
, Qnil
);
7976 if (STRINGP (XCAR (prefix
)))
7977 tem
= concat2 (XCAR (prefix
), tem
);
7978 if (STRINGP (XCDR (prefix
)))
7979 tem
= concat2 (tem
, XCDR (prefix
));
7981 keyeq
= concat2 (build_string (" "), tem
);
7982 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7988 /* If we have an equivalent key binding, use that. */
7989 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7992 /* Include this when menu help is implemented.
7993 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7994 if (!(NILP (tem) || STRINGP (tem)))
7996 tem = menu_item_eval_property (tem);
7999 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8003 /* Handle radio buttons or toggle boxes. */
8004 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8006 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8007 menu_item_eval_property (tem
));
8014 /***********************************************************************
8016 ***********************************************************************/
8018 /* A vector holding tool bar items while they are parsed in function
8019 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8022 static Lisp_Object tool_bar_items_vector
;
8024 /* A vector holding the result of parse_tool_bar_item. Layout is like
8025 the one for a single item in tool_bar_items_vector. */
8027 static Lisp_Object tool_bar_item_properties
;
8029 /* Next free index in tool_bar_items_vector. */
8031 static int ntool_bar_items
;
8033 /* The symbols `:image' and `:rtl'. */
8035 Lisp_Object QCimage
;
8038 /* Function prototypes. */
8040 static void init_tool_bar_items (Lisp_Object
);
8041 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8042 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8043 static void append_tool_bar_item (void);
8046 /* Return a vector of tool bar items for keymaps currently in effect.
8047 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8048 tool bar items found. */
8051 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8060 /* In order to build the menus, we need to call the keymap
8061 accessors. They all call QUIT. But this function is called
8062 during redisplay, during which a quit is fatal. So inhibit
8063 quitting while building the menus. We do this instead of
8064 specbind because (1) errors will clear it anyway and (2) this
8065 avoids risk of specpdl overflow. */
8066 oquit
= Vinhibit_quit
;
8069 /* Initialize tool_bar_items_vector and protect it from GC. */
8070 init_tool_bar_items (reuse
);
8072 /* Build list of keymaps in maps. Set nmaps to the number of maps
8075 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8076 if (!NILP (Voverriding_local_map_menu_flag
))
8078 /* Yes, use them (if non-nil) as well as the global map. */
8079 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8081 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8082 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8083 if (!NILP (Voverriding_local_map
))
8084 maps
[nmaps
++] = Voverriding_local_map
;
8088 /* No, so use major and minor mode keymaps and keymap property.
8089 Note that tool-bar bindings in the local-map and keymap
8090 properties may not work reliable, as they are only
8091 recognized when the tool-bar (or mode-line) is updated,
8092 which does not normally happen after every command. */
8095 nminor
= current_minor_maps (NULL
, &tmaps
);
8096 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8098 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8099 maps
[nmaps
++] = tem
;
8100 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8102 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8105 /* Add global keymap at the end. */
8106 maps
[nmaps
++] = current_global_map
;
8108 /* Process maps in reverse order and look up in each map the prefix
8110 for (i
= nmaps
- 1; i
>= 0; --i
)
8111 if (!NILP (maps
[i
]))
8115 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8117 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8120 Vinhibit_quit
= oquit
;
8121 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8122 return tool_bar_items_vector
;
8126 /* Process the definition of KEY which is DEF. */
8129 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8132 struct gcpro gcpro1
, gcpro2
;
8134 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8138 if (EQ (def
, Qundefined
))
8140 /* If a map has an explicit `undefined' as definition,
8141 discard any previously made item. */
8142 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8144 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8146 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8148 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8149 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8150 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8151 * sizeof (Lisp_Object
)));
8152 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8157 else if (parse_tool_bar_item (key
, def
))
8158 /* Append a new tool bar item to tool_bar_items_vector. Accept
8159 more than one definition for the same key. */
8160 append_tool_bar_item ();
8166 /* Parse a tool bar item specification ITEM for key KEY and return the
8167 result in tool_bar_item_properties. Value is zero if ITEM is
8170 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8172 CAPTION is the caption of the item, If it's not a string, it is
8173 evaluated to get a string.
8175 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8176 as binding are currently ignored.
8178 The following properties are recognized:
8182 FORM is evaluated and specifies whether the tool bar item is
8183 enabled or disabled.
8187 FORM is evaluated and specifies whether the tool bar item is visible.
8189 - `:filter FUNCTION'
8191 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8192 result is stored as the new binding.
8194 - `:button (TYPE SELECTED)'
8196 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8197 and specifies whether the button is selected (pressed) or not.
8201 IMAGES is either a single image specification or a vector of four
8202 image specifications. See enum tool_bar_item_images.
8204 - `:help HELP-STRING'.
8206 Gives a help string to display for the tool bar item.
8208 - `:label LABEL-STRING'.
8210 A text label to show with the tool bar button if labels are enabled. */
8213 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8215 /* Access slot with index IDX of vector tool_bar_item_properties. */
8216 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8218 Lisp_Object filter
= Qnil
;
8219 Lisp_Object caption
;
8220 int i
, have_label
= 0;
8222 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8223 Rule out items that aren't lists, don't start with
8224 `menu-item' or whose rest following `tool-bar-item' is not a
8227 || !EQ (XCAR (item
), Qmenu_item
)
8228 || (item
= XCDR (item
),
8232 /* Create tool_bar_item_properties vector if necessary. Reset it to
8234 if (VECTORP (tool_bar_item_properties
))
8236 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8240 tool_bar_item_properties
8241 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8244 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8245 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8247 /* Get the caption of the item. If the caption is not a string,
8248 evaluate it to get a string. If we don't get a string, skip this
8250 caption
= XCAR (item
);
8251 if (!STRINGP (caption
))
8253 caption
= menu_item_eval_property (caption
);
8254 if (!STRINGP (caption
))
8257 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8259 /* Give up if rest following the caption is not a list. */
8264 /* Store the binding. */
8265 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8268 /* Ignore cached key binding, if any. */
8269 if (CONSP (item
) && CONSP (XCAR (item
)))
8272 /* Process the rest of the properties. */
8273 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8275 Lisp_Object key
, value
;
8278 value
= XCAR (XCDR (item
));
8280 if (EQ (key
, QCenable
))
8282 /* `:enable FORM'. */
8283 if (!NILP (Venable_disabled_menus_and_buttons
))
8284 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8286 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8288 else if (EQ (key
, QCvisible
))
8290 /* `:visible FORM'. If got a visible property and that
8291 evaluates to nil then ignore this item. */
8292 if (NILP (menu_item_eval_property (value
)))
8295 else if (EQ (key
, QChelp
))
8296 /* `:help HELP-STRING'. */
8297 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8298 else if (EQ (key
, QClabel
))
8300 const char *bad_label
= "!!?GARBLED ITEM?!!";
8301 /* `:label LABEL-STRING'. */
8302 PROP (TOOL_BAR_ITEM_HELP
) = STRINGP (value
)
8304 : make_string (bad_label
, strlen (bad_label
));
8307 else if (EQ (key
, QCfilter
))
8308 /* ':filter FORM'. */
8310 else if (EQ (key
, QCbutton
) && CONSP (value
))
8312 /* `:button (TYPE . SELECTED)'. */
8313 Lisp_Object type
, selected
;
8315 type
= XCAR (value
);
8316 selected
= XCDR (value
);
8317 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8319 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8320 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8323 else if (EQ (key
, QCimage
)
8325 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8326 /* Value is either a single image specification or a vector
8327 of 4 such specifications for the different button states. */
8328 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8329 else if (EQ (key
, Qrtl
))
8331 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8337 /* Try to make one from caption and key. */
8338 Lisp_Object key
= PROP (TOOL_BAR_ITEM_KEY
);
8339 Lisp_Object capt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8340 const char *label
= SYMBOLP (key
) ? (char *) SDATA (SYMBOL_NAME (key
)) : "";
8341 const char *caption
= STRINGP (capt
) ? (char *) SDATA (capt
) : "";
8342 EMACS_INT max_lbl
= 2 * tool_bar_max_label_size
;
8343 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8344 Lisp_Object new_lbl
;
8345 size_t caption_len
= strlen (caption
);
8347 if (caption_len
<= max_lbl
&& caption
[0] != '\0')
8349 strcpy (buf
, caption
);
8350 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8352 buf
[caption_len
] = '\0';
8353 label
= caption
= buf
;
8356 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8360 strcpy (buf
, label
);
8362 for (i
= 0; buf
[i
] != '\0'; ++i
)
8371 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8372 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8373 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8375 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8379 /* If got a filter apply it on binding. */
8381 PROP (TOOL_BAR_ITEM_BINDING
)
8382 = menu_item_eval_property (list2 (filter
,
8384 PROP (TOOL_BAR_ITEM_BINDING
))));
8386 /* See if the binding is a keymap. Give up if it is. */
8387 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8390 /* Enable or disable selection of item. */
8391 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8392 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8393 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8395 /* Handle radio buttons or toggle boxes. */
8396 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8397 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8398 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8406 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8407 that can be reused. */
8410 init_tool_bar_items (Lisp_Object reuse
)
8412 if (VECTORP (reuse
))
8413 tool_bar_items_vector
= reuse
;
8415 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8416 ntool_bar_items
= 0;
8420 /* Append parsed tool bar item properties from
8421 tool_bar_item_properties */
8424 append_tool_bar_item (void)
8426 Lisp_Object
*to
, *from
;
8428 /* Enlarge tool_bar_items_vector if necessary. */
8429 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8430 >= XVECTOR (tool_bar_items_vector
)->size
)
8431 tool_bar_items_vector
8432 = larger_vector (tool_bar_items_vector
,
8433 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8435 /* Append entries from tool_bar_item_properties to the end of
8436 tool_bar_items_vector. */
8437 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8438 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8439 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8440 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8447 /* Read a character using menus based on maps in the array MAPS.
8448 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8449 Return t if we displayed a menu but the user rejected it.
8451 PREV_EVENT is the previous input event, or nil if we are reading
8452 the first event of a key sequence.
8454 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8455 if we used a mouse menu to read the input, or zero otherwise. If
8456 USED_MOUSE_MENU is null, we don't dereference it.
8458 The prompting is done based on the prompt-string of the map
8459 and the strings associated with various map elements.
8461 This can be done with X menus or with menus put in the minibuf.
8462 These are done in different ways, depending on how the input will be read.
8463 Menus using X are done after auto-saving in read-char, getting the input
8464 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8465 and do auto-saving in the inner call of read_char. */
8468 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8469 int *used_mouse_menu
)
8473 if (used_mouse_menu
)
8474 *used_mouse_menu
= 0;
8476 /* Use local over global Menu maps */
8478 if (! menu_prompting
)
8481 /* Optionally disregard all but the global map. */
8482 if (inhibit_local_menu_bar_menus
)
8484 maps
+= (nmaps
- 1);
8489 /* If we got to this point via a mouse click,
8490 use a real menu for mouse selection. */
8491 if (EVENT_HAS_PARAMETERS (prev_event
)
8492 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8493 && !EQ (XCAR (prev_event
), Qtool_bar
))
8495 /* Display the menu and get the selection. */
8496 Lisp_Object
*realmaps
8497 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8501 /* Use the maps that are not nil. */
8502 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8503 if (!NILP (maps
[mapno
]))
8504 realmaps
[nmaps1
++] = maps
[mapno
];
8506 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8511 record_menu_key (XCAR (value
));
8513 /* If we got multiple events, unread all but
8515 There is no way to prevent those unread events
8516 from showing up later in last_nonmenu_event.
8517 So turn symbol and integer events into lists,
8518 to indicate that they came from a mouse menu,
8519 so that when present in last_nonmenu_event
8520 they won't confuse things. */
8521 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8523 record_menu_key (XCAR (tem
));
8524 if (SYMBOLP (XCAR (tem
))
8525 || INTEGERP (XCAR (tem
)))
8526 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8529 /* If we got more than one event, put all but the first
8530 onto this list to be read later.
8531 Return just the first event now. */
8532 Vunread_command_events
8533 = nconc2 (XCDR (value
), Vunread_command_events
);
8534 value
= XCAR (value
);
8536 else if (NILP (value
))
8538 if (used_mouse_menu
)
8539 *used_mouse_menu
= 1;
8542 #endif /* HAVE_MENUS */
8546 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8547 We make this bigger when necessary, and never free it. */
8548 static char *read_char_minibuf_menu_text
;
8549 /* Size of that buffer. */
8550 static int read_char_minibuf_menu_width
;
8553 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8556 register Lisp_Object name
;
8558 /* FIXME: Use the minibuffer's frame width. */
8559 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8562 Lisp_Object rest
, vector
;
8568 if (! menu_prompting
)
8571 /* Get the menu name from the first map that has one (a prompt string). */
8572 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8574 name
= Fkeymap_prompt (maps
[mapno
]);
8579 /* If we don't have any menus, just read a character normally. */
8580 if (!STRINGP (name
))
8583 /* Make sure we have a big enough buffer for the menu text. */
8584 width
= max (width
, SBYTES (name
));
8585 if (read_char_minibuf_menu_text
== 0)
8587 read_char_minibuf_menu_width
= width
+ 4;
8588 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8590 else if (width
+ 4 > read_char_minibuf_menu_width
)
8592 read_char_minibuf_menu_width
= width
+ 4;
8593 read_char_minibuf_menu_text
8594 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8596 menu
= read_char_minibuf_menu_text
;
8598 /* Prompt string always starts with map's prompt, and a space. */
8599 strcpy (menu
, SDATA (name
));
8600 nlength
= SBYTES (name
);
8601 menu
[nlength
++] = ':';
8602 menu
[nlength
++] = ' ';
8605 /* Start prompting at start of first map. */
8609 /* Present the documented bindings, a line at a time. */
8616 Lisp_Object orig_defn_macro
;
8618 /* Loop over elements of map. */
8623 /* If reached end of map, start at beginning of next map. */
8627 /* At end of last map, wrap around to first map if just starting,
8628 or end this line if already have something on it. */
8632 if (notfirst
|| nobindings
) break;
8637 /* Look at the next element of the map. */
8639 elt
= XVECTOR (vector
)->contents
[idx
];
8641 elt
= Fcar_safe (rest
);
8643 if (idx
< 0 && VECTORP (elt
))
8645 /* If we found a dense table in the keymap,
8646 advanced past it, but start scanning its contents. */
8647 rest
= Fcdr_safe (rest
);
8653 /* An ordinary element. */
8654 Lisp_Object event
, tem
;
8658 event
= Fcar_safe (elt
); /* alist */
8659 elt
= Fcdr_safe (elt
);
8663 XSETINT (event
, idx
); /* vector */
8666 /* Ignore the element if it has no prompt string. */
8667 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8669 /* 1 if the char to type matches the string. */
8671 Lisp_Object upcased_event
, downcased_event
;
8672 Lisp_Object desc
= Qnil
;
8674 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8676 upcased_event
= Fupcase (event
);
8677 downcased_event
= Fdowncase (event
);
8678 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8679 || XINT (downcased_event
) == SREF (s
, 0));
8681 desc
= Fsingle_key_description (event
, Qnil
);
8683 #if 0 /* It is redundant to list the equivalent key bindings because
8684 the prefix is what the user has already typed. */
8686 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8688 /* Insert equivalent keybinding. */
8689 s
= concat2 (s
, tem
);
8692 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8693 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8695 /* Insert button prefix. */
8696 Lisp_Object selected
8697 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8698 if (EQ (tem
, QCradio
))
8699 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8701 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8702 s
= concat2 (tem
, s
);
8706 /* If we have room for the prompt string, add it to this line.
8707 If this is the first on the line, always add it. */
8708 if ((SCHARS (s
) + i
+ 2
8709 + (char_matches
? 0 : SCHARS (desc
) + 3))
8715 /* Punctuate between strings. */
8718 strcpy (menu
+ i
, ", ");
8724 /* If the char to type doesn't match the string's
8725 first char, explicitly show what char to type. */
8728 /* Add as much of string as fits. */
8729 thiswidth
= SCHARS (desc
);
8730 if (thiswidth
+ i
> width
)
8731 thiswidth
= width
- i
;
8732 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8734 strcpy (menu
+ i
, " = ");
8738 /* Add as much of string as fits. */
8739 thiswidth
= SCHARS (s
);
8740 if (thiswidth
+ i
> width
)
8741 thiswidth
= width
- i
;
8742 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8748 /* If this element does not fit, end the line now,
8749 and save the element for the next line. */
8750 strcpy (menu
+ i
, "...");
8755 /* Move past this element. */
8756 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8757 /* Handle reaching end of dense table. */
8762 rest
= Fcdr_safe (rest
);
8766 /* Prompt with that and read response. */
8767 message2_nolog (menu
, strlen (menu
),
8768 ! NILP (current_buffer
->enable_multibyte_characters
));
8770 /* Make believe its not a keyboard macro in case the help char
8771 is pressed. Help characters are not recorded because menu prompting
8772 is not used on replay.
8774 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8775 current_kboard
->defining_kbd_macro
= Qnil
;
8777 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8778 while (BUFFERP (obj
));
8779 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8781 if (!INTEGERP (obj
))
8783 else if (XINT (obj
) == -2)
8788 if (! EQ (obj
, menu_prompt_more_char
)
8789 && (!INTEGERP (menu_prompt_more_char
)
8790 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8792 if (!NILP (current_kboard
->defining_kbd_macro
))
8793 store_kbd_macro_char (obj
);
8796 /* Help char - go round again */
8800 /* Reading key sequences. */
8802 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8803 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8804 keymap, or nil otherwise. Return the index of the first keymap in
8805 which KEY has any binding, or NMAPS if no map has a binding.
8807 If KEY is a meta ASCII character, treat it like meta-prefix-char
8808 followed by the corresponding non-meta character. Keymaps in
8809 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8812 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8815 NEXT may be the same array as CURRENT. */
8818 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8821 int i
, first_binding
;
8823 first_binding
= nmaps
;
8824 for (i
= nmaps
- 1; i
>= 0; i
--)
8826 if (! NILP (current
[i
]))
8828 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8829 if (! NILP (defs
[i
]))
8836 /* Given the set of bindings we've found, produce the next set of maps. */
8837 if (first_binding
< nmaps
)
8838 for (i
= 0; i
< nmaps
; i
++)
8839 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8841 return first_binding
;
8844 /* Structure used to keep track of partial application of key remapping
8845 such as Vfunction_key_map and Vkey_translation_map. */
8846 typedef struct keyremap
8848 /* This is the map originally specified for this use. */
8850 /* This is a submap reached by looking up, in PARENT,
8851 the events from START to END. */
8853 /* Positions [START, END) in the key sequence buffer
8854 are the key that we have scanned so far.
8855 Those events are the ones that we will replace
8856 if PAREHT maps them into a key sequence. */
8860 /* Lookup KEY in MAP.
8861 MAP is a keymap mapping keys to key vectors or functions.
8862 If the mapping is a function and DO_FUNCTION is non-zero, then
8863 the function is called with PROMPT as parameter and its return
8864 value is used as the return value of this function (after checking
8865 that it is indeed a vector). */
8868 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8873 next
= access_keymap (map
, key
, 1, 0, 1);
8875 /* Handle symbol with autoload definition. */
8876 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8877 && CONSP (XSYMBOL (next
)->function
)
8878 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8879 do_autoload (XSYMBOL (next
)->function
, next
);
8881 /* Handle a symbol whose function definition is a keymap
8883 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8884 && (ARRAYP (XSYMBOL (next
)->function
)
8885 || KEYMAPP (XSYMBOL (next
)->function
)))
8886 next
= XSYMBOL (next
)->function
;
8888 /* If the keymap gives a function, not an
8889 array, then call the function with one arg and use
8890 its value instead. */
8891 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8896 next
= call1 (next
, prompt
);
8897 /* If the function returned something invalid,
8898 barf--don't ignore it.
8899 (To ignore it safely, we would need to gcpro a bunch of
8900 other variables.) */
8901 if (! (VECTORP (next
) || STRINGP (next
)))
8902 error ("Function %s returns invalid key sequence", tem
);
8907 /* Do one step of the key remapping used for function-key-map and
8908 key-translation-map:
8909 KEYBUF is the buffer holding the input events.
8910 BUFSIZE is its maximum size.
8911 FKEY is a pointer to the keyremap structure to use.
8912 INPUT is the index of the last element in KEYBUF.
8913 DOIT if non-zero says that the remapping can actually take place.
8914 DIFF is used to return the number of keys added/removed by the remapping.
8915 PARENT is the root of the keymap.
8916 PROMPT is the prompt to use if the remapping happens through a function.
8917 The return value is non-zero if the remapping actually took place. */
8920 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8921 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8923 Lisp_Object next
, key
;
8925 key
= keybuf
[fkey
->end
++];
8927 if (KEYMAPP (fkey
->parent
))
8928 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8932 /* If keybuf[fkey->start..fkey->end] is bound in the
8933 map and we're in a position to do the key remapping, replace it with
8934 the binding and restart with fkey->start at the end. */
8935 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8937 int len
= XFASTINT (Flength (next
));
8940 *diff
= len
- (fkey
->end
- fkey
->start
);
8942 if (input
+ *diff
>= bufsize
)
8943 error ("Key sequence too long");
8945 /* Shift the keys that follow fkey->end. */
8947 for (i
= fkey
->end
; i
< input
; i
++)
8948 keybuf
[i
+ *diff
] = keybuf
[i
];
8950 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8951 keybuf
[i
+ *diff
] = keybuf
[i
];
8952 /* Overwrite the old keys with the new ones. */
8953 for (i
= 0; i
< len
; i
++)
8954 keybuf
[fkey
->start
+ i
]
8955 = Faref (next
, make_number (i
));
8957 fkey
->start
= fkey
->end
+= *diff
;
8958 fkey
->map
= fkey
->parent
;
8963 fkey
->map
= get_keymap (next
, 0, 1);
8965 /* If we no longer have a bound suffix, try a new position for
8967 if (!CONSP (fkey
->map
))
8969 fkey
->end
= ++fkey
->start
;
8970 fkey
->map
= fkey
->parent
;
8975 /* Read a sequence of keys that ends with a non prefix character,
8976 storing it in KEYBUF, a buffer of size BUFSIZE.
8978 Return the length of the key sequence stored.
8979 Return -1 if the user rejected a command menu.
8981 Echo starting immediately unless `prompt' is 0.
8983 Where a key sequence ends depends on the currently active keymaps.
8984 These include any minor mode keymaps active in the current buffer,
8985 the current buffer's local map, and the global map.
8987 If a key sequence has no other bindings, we check Vfunction_key_map
8988 to see if some trailing subsequence might be the beginning of a
8989 function key's sequence. If so, we try to read the whole function
8990 key, and substitute its symbolic name into the key sequence.
8992 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8993 `double-' events into similar click events, if that would make them
8994 bound. We try to turn `triple-' events first into `double-' events,
8997 If we get a mouse click in a mode line, vertical divider, or other
8998 non-text area, we treat the click as if it were prefixed by the
8999 symbol denoting that area - `mode-line', `vertical-line', or
9002 If the sequence starts with a mouse click, we read the key sequence
9003 with respect to the buffer clicked on, not the current buffer.
9005 If the user switches frames in the midst of a key sequence, we put
9006 off the switch-frame event until later; the next call to
9007 read_char will return it.
9009 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9010 from the selected window's buffer. */
9013 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
9014 int dont_downcase_last
, int can_return_switch_frame
,
9015 int fix_current_buffer
)
9017 Lisp_Object from_string
;
9018 int count
= SPECPDL_INDEX ();
9020 /* How many keys there are in the current key sequence. */
9023 /* The length of the echo buffer when we started reading, and
9024 the length of this_command_keys when we started reading. */
9028 /* The number of keymaps we're scanning right now, and the number of
9029 keymaps we have allocated space for. */
9031 int nmaps_allocated
= 0;
9033 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9034 the current keymaps. */
9035 Lisp_Object
*defs
= NULL
;
9037 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9038 in the current keymaps, or nil where it is not a prefix. */
9039 Lisp_Object
*submaps
= NULL
;
9041 /* The local map to start out with at start of key sequence. */
9042 Lisp_Object orig_local_map
;
9044 /* The map from the `keymap' property to start out with at start of
9046 Lisp_Object orig_keymap
;
9048 /* 1 if we have already considered switching to the local-map property
9049 of the place where a mouse click occurred. */
9050 int localized_local_map
= 0;
9052 /* The index in submaps[] of the first keymap that has a binding for
9053 this key sequence. In other words, the lowest i such that
9054 submaps[i] is non-nil. */
9056 /* Index of the first key that has no binding.
9057 It is useless to try fkey.start larger than that. */
9060 /* If t < mock_input, then KEYBUF[t] should be read as the next
9063 We use this to recover after recognizing a function key. Once we
9064 realize that a suffix of the current key sequence is actually a
9065 function key's escape sequence, we replace the suffix with the
9066 function key's binding from Vfunction_key_map. Now keybuf
9067 contains a new and different key sequence, so the echo area,
9068 this_command_keys, and the submaps and defs arrays are wrong. In
9069 this situation, we set mock_input to t, set t to 0, and jump to
9070 restart_sequence; the loop will read keys from keybuf up until
9071 mock_input, thus rebuilding the state; and then it will resume
9072 reading characters from the keyboard. */
9075 /* If the sequence is unbound in submaps[], then
9076 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9077 and fkey.map is its binding.
9079 These might be > t, indicating that all function key scanning
9080 should hold off until t reaches them. We do this when we've just
9081 recognized a function key, to avoid searching for the function
9082 key's again in Vfunction_key_map. */
9085 /* Likewise, for key_translation_map and input-decode-map. */
9086 keyremap keytran
, indec
;
9088 /* Non-zero if we are trying to map a key by changing an upper-case
9089 letter to lower case, or a shifted function key to an unshifted
9091 int shift_translated
= 0;
9093 /* If we receive a `switch-frame' or `select-window' event in the middle of
9094 a key sequence, we put it off for later.
9095 While we're reading, we keep the event here. */
9096 Lisp_Object delayed_switch_frame
;
9098 /* See the comment below... */
9099 #if defined (GOBBLE_FIRST_EVENT)
9100 Lisp_Object first_event
;
9103 Lisp_Object original_uppercase
;
9104 int original_uppercase_position
= -1;
9106 /* Gets around Microsoft compiler limitations. */
9109 struct buffer
*starting_buffer
;
9111 /* List of events for which a fake prefix key has been generated. */
9112 Lisp_Object fake_prefixed_keys
= Qnil
;
9114 #if defined (GOBBLE_FIRST_EVENT)
9118 struct gcpro gcpro1
;
9120 GCPRO1 (fake_prefixed_keys
);
9121 raw_keybuf_count
= 0;
9123 last_nonmenu_event
= Qnil
;
9125 delayed_switch_frame
= Qnil
;
9130 echo_prompt (prompt
);
9131 else if (cursor_in_echo_area
9132 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9133 && NILP (Fzerop (Vecho_keystrokes
)))
9134 /* This doesn't put in a dash if the echo buffer is empty, so
9135 you don't always see a dash hanging out in the minibuffer. */
9139 /* Record the initial state of the echo area and this_command_keys;
9140 we will need to restore them if we replay a key sequence. */
9142 echo_start
= echo_length ();
9143 keys_start
= this_command_key_count
;
9144 this_single_command_key_start
= keys_start
;
9146 #if defined (GOBBLE_FIRST_EVENT)
9147 /* This doesn't quite work, because some of the things that read_char
9148 does cannot safely be bypassed. It seems too risky to try to make
9151 /* Read the first char of the sequence specially, before setting
9152 up any keymaps, in case a filter runs and switches buffers on us. */
9153 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9155 #endif /* GOBBLE_FIRST_EVENT */
9157 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9158 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9161 /* We jump here when we need to reinitialize fkey and keytran; this
9162 happens if we switch keyboards between rescans. */
9163 replay_entire_sequence
:
9165 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9166 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9167 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9168 indec
.start
= indec
.end
= 0;
9169 fkey
.start
= fkey
.end
= 0;
9170 keytran
.start
= keytran
.end
= 0;
9172 /* We jump here when the key sequence has been thoroughly changed, and
9173 we need to rescan it starting from the beginning. When we jump here,
9174 keybuf[0..mock_input] holds the sequence we should reread. */
9177 starting_buffer
= current_buffer
;
9178 first_unbound
= bufsize
+ 1;
9180 /* Build our list of keymaps.
9181 If we recognize a function key and replace its escape sequence in
9182 keybuf with its symbol, or if the sequence starts with a mouse
9183 click and we need to switch buffers, we jump back here to rebuild
9184 the initial keymaps from the current buffer. */
9187 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9189 if (2 > nmaps_allocated
)
9191 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9192 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9193 nmaps_allocated
= 2;
9195 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9197 else if (!NILP (Voverriding_local_map
))
9199 if (2 > nmaps_allocated
)
9201 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9202 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9203 nmaps_allocated
= 2;
9205 submaps
[nmaps
++] = Voverriding_local_map
;
9213 nminor
= current_minor_maps (0, &maps
);
9214 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9216 if (total
> nmaps_allocated
)
9218 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9219 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9220 nmaps_allocated
= total
;
9223 if (!NILP (orig_keymap
))
9224 submaps
[nmaps
++] = orig_keymap
;
9226 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9230 submaps
[nmaps
++] = orig_local_map
;
9232 submaps
[nmaps
++] = current_global_map
;
9234 /* Find an accurate initial value for first_binding. */
9235 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9236 if (! NILP (submaps
[first_binding
]))
9239 /* Start from the beginning in keybuf. */
9242 /* These are no-ops the first time through, but if we restart, they
9243 revert the echo area and this_command_keys to their original state. */
9244 this_command_key_count
= keys_start
;
9245 if (INTERACTIVE
&& t
< mock_input
)
9246 echo_truncate (echo_start
);
9248 /* If the best binding for the current key sequence is a keymap, or
9249 we may be looking at a function key's escape sequence, keep on
9251 while (first_binding
< nmaps
9252 /* Keep reading as long as there's a prefix binding. */
9253 ? !NILP (submaps
[first_binding
])
9254 /* Don't return in the middle of a possible function key sequence,
9255 if the only bindings we found were via case conversion.
9256 Thus, if ESC O a has a function-key-map translation
9257 and ESC o has a binding, don't return after ESC O,
9258 so that we can translate ESC O plus the next character. */
9259 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9262 int used_mouse_menu
= 0;
9264 /* Where the last real key started. If we need to throw away a
9265 key that has expanded into more than one element of keybuf
9266 (say, a mouse click on the mode line which is being treated
9267 as [mode-line (mouse-...)], then we backtrack to this point
9269 int last_real_key_start
;
9271 /* These variables are analogous to echo_start and keys_start;
9272 while those allow us to restart the entire key sequence,
9273 echo_local_start and keys_local_start allow us to throw away
9275 int echo_local_start
, keys_local_start
, local_first_binding
;
9277 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9278 eassert (indec
.start
<= indec
.end
);
9279 eassert (fkey
.start
<= fkey
.end
);
9280 eassert (keytran
.start
<= keytran
.end
);
9281 /* key-translation-map is applied *after* function-key-map
9282 which is itself applied *after* input-decode-map. */
9283 eassert (fkey
.end
<= indec
.start
);
9284 eassert (keytran
.end
<= fkey
.start
);
9286 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9287 first_unbound
< keytran
.start
)
9288 { /* The prefix upto first_unbound has no binding and has
9289 no translation left to do either, so we know it's unbound.
9290 If we don't stop now, we risk staying here indefinitely
9291 (if the user keeps entering fkey or keytran prefixes
9292 like C-c ESC ESC ESC ESC ...) */
9294 for (i
= first_unbound
+ 1; i
< t
; i
++)
9295 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9296 mock_input
= t
- first_unbound
- 1;
9297 indec
.end
= indec
.start
-= first_unbound
+ 1;
9298 indec
.map
= indec
.parent
;
9299 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9300 fkey
.map
= fkey
.parent
;
9301 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9302 keytran
.map
= keytran
.parent
;
9303 goto replay_sequence
;
9307 error ("Key sequence too long");
9310 echo_local_start
= echo_length ();
9311 keys_local_start
= this_command_key_count
;
9312 local_first_binding
= first_binding
;
9315 /* These are no-ops, unless we throw away a keystroke below and
9316 jumped back up to replay_key; in that case, these restore the
9317 variables to their original state, allowing us to replay the
9319 if (INTERACTIVE
&& t
< mock_input
)
9320 echo_truncate (echo_local_start
);
9321 this_command_key_count
= keys_local_start
;
9322 first_binding
= local_first_binding
;
9324 /* By default, assume each event is "real". */
9325 last_real_key_start
= t
;
9327 /* Does mock_input indicate that we are re-reading a key sequence? */
9331 add_command_key (key
);
9332 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9333 && NILP (Fzerop (Vecho_keystrokes
)))
9337 /* If not, we should actually read a character. */
9341 KBOARD
*interrupted_kboard
= current_kboard
;
9342 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9343 key
= read_char (NILP (prompt
), nmaps
,
9344 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9345 &used_mouse_menu
, NULL
);
9346 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9347 /* When switching to a new tty (with a new keyboard),
9348 read_char returns the new buffer, rather than -2
9349 (Bug#5095). This is because `terminal-init-xterm'
9350 calls read-char, which eats the wrong_kboard_jmpbuf
9351 return. Any better way to fix this? -- cyd */
9352 || (interrupted_kboard
!= current_kboard
))
9357 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9358 if (k
== interrupted_kboard
)
9363 /* Don't touch interrupted_kboard when it's been
9365 delayed_switch_frame
= Qnil
;
9366 goto replay_entire_sequence
;
9369 if (!NILP (delayed_switch_frame
))
9371 interrupted_kboard
->kbd_queue
9372 = Fcons (delayed_switch_frame
,
9373 interrupted_kboard
->kbd_queue
);
9374 delayed_switch_frame
= Qnil
;
9378 interrupted_kboard
->kbd_queue
9379 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9381 /* If the side queue is non-empty, ensure it begins with a
9382 switch-frame, so we'll replay it in the right context. */
9383 if (CONSP (interrupted_kboard
->kbd_queue
)
9384 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9385 !(EVENT_HAS_PARAMETERS (key
)
9386 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9390 XSETFRAME (frame
, interrupted_frame
);
9391 interrupted_kboard
->kbd_queue
9392 = Fcons (make_lispy_switch_frame (frame
),
9393 interrupted_kboard
->kbd_queue
);
9396 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9397 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9398 goto replay_entire_sequence
;
9402 /* read_char returns t when it shows a menu and the user rejects it.
9406 unbind_to (count
, Qnil
);
9411 /* read_char returns -1 at the end of a macro.
9412 Emacs 18 handles this by returning immediately with a
9413 zero, so that's what we'll do. */
9414 if (INTEGERP (key
) && XINT (key
) == -1)
9417 /* The Microsoft C compiler can't handle the goto that
9423 /* If the current buffer has been changed from under us, the
9424 keymap may have changed, so replay the sequence. */
9427 timer_resume_idle ();
9430 /* Reset the current buffer from the selected window
9431 in case something changed the former and not the latter.
9432 This is to be more consistent with the behavior
9433 of the command_loop_1. */
9434 if (fix_current_buffer
)
9436 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9438 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9439 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9442 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9443 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9444 goto replay_sequence
;
9447 /* If we have a quit that was typed in another frame, and
9448 quit_throw_to_read_char switched buffers,
9449 replay to get the right keymap. */
9451 && XINT (key
) == quit_char
9452 && current_buffer
!= starting_buffer
)
9455 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9459 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9460 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9461 goto replay_sequence
;
9466 if (EVENT_HAS_PARAMETERS (key
)
9467 /* Either a `switch-frame' or a `select-window' event. */
9468 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9470 /* If we're at the beginning of a key sequence, and the caller
9471 says it's okay, go ahead and return this event. If we're
9472 in the midst of a key sequence, delay it until the end. */
9473 if (t
> 0 || !can_return_switch_frame
)
9475 delayed_switch_frame
= key
;
9481 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9485 /* Clicks in non-text areas get prefixed by the symbol
9486 in their CHAR-ADDRESS field. For example, a click on
9487 the mode line is prefixed by the symbol `mode-line'.
9489 Furthermore, key sequences beginning with mouse clicks
9490 are read using the keymaps of the buffer clicked on, not
9491 the current buffer. So we may have to switch the buffer
9494 When we turn one event into two events, we must make sure
9495 that neither of the two looks like the original--so that,
9496 if we replay the events, they won't be expanded again.
9497 If not for this, such reexpansion could happen either here
9498 or when user programs play with this-command-keys. */
9499 if (EVENT_HAS_PARAMETERS (key
))
9504 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9505 if (EQ (kind
, Qmouse_click
))
9507 Lisp_Object window
, posn
;
9509 window
= POSN_WINDOW (EVENT_START (key
));
9510 posn
= POSN_POSN (EVENT_START (key
));
9513 || (!NILP (fake_prefixed_keys
)
9514 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9516 /* We're looking a second time at an event for which
9517 we generated a fake prefix key. Set
9518 last_real_key_start appropriately. */
9520 last_real_key_start
= t
- 1;
9523 /* Key sequences beginning with mouse clicks are
9524 read using the keymaps in the buffer clicked on,
9525 not the current buffer. If we're at the
9526 beginning of a key sequence, switch buffers. */
9527 if (last_real_key_start
== 0
9529 && BUFFERP (XWINDOW (window
)->buffer
)
9530 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9532 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9536 /* Arrange to go back to the original buffer once we're
9537 done reading the key sequence. Note that we can't
9538 use save_excursion_{save,restore} here, because they
9539 save point as well as the current buffer; we don't
9540 want to save point, because redisplay may change it,
9541 to accommodate a Fset_window_start or something. We
9542 don't want to do this at the top of the function,
9543 because we may get input from a subprocess which
9544 wants to change the selected window and stuff (say,
9546 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9548 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9550 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9551 orig_local_map
= get_local_map (PT
, current_buffer
,
9553 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9554 goto replay_sequence
;
9557 /* For a mouse click, get the local text-property keymap
9558 of the place clicked on, rather than point. */
9559 if (last_real_key_start
== 0
9560 && CONSP (XCDR (key
))
9561 && ! localized_local_map
)
9563 Lisp_Object map_here
, start
, pos
;
9565 localized_local_map
= 1;
9566 start
= EVENT_START (key
);
9568 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9570 pos
= POSN_BUFFER_POSN (start
);
9572 && XINT (pos
) >= BEGV
9573 && XINT (pos
) <= ZV
)
9575 map_here
= get_local_map (XINT (pos
),
9576 current_buffer
, Qlocal_map
);
9577 if (!EQ (map_here
, orig_local_map
))
9579 orig_local_map
= map_here
;
9580 ++localized_local_map
;
9583 map_here
= get_local_map (XINT (pos
),
9584 current_buffer
, Qkeymap
);
9585 if (!EQ (map_here
, orig_keymap
))
9587 orig_keymap
= map_here
;
9588 ++localized_local_map
;
9591 if (localized_local_map
> 1)
9596 goto replay_sequence
;
9602 /* Expand mode-line and scroll-bar events into two events:
9603 use posn as a fake prefix key. */
9605 && (NILP (fake_prefixed_keys
)
9606 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9608 if (t
+ 1 >= bufsize
)
9609 error ("Key sequence too long");
9612 keybuf
[t
+ 1] = key
;
9615 /* Record that a fake prefix key has been generated
9616 for KEY. Don't modify the event; this would
9617 prevent proper action when the event is pushed
9618 back into unread-command-events. */
9619 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9621 /* If on a mode line string with a local keymap,
9622 reconsider the key sequence with that keymap. */
9623 if (string
= POSN_STRING (EVENT_START (key
)),
9624 (CONSP (string
) && STRINGP (XCAR (string
))))
9626 Lisp_Object pos
, map
, map2
;
9628 pos
= XCDR (string
);
9629 string
= XCAR (string
);
9631 && XINT (pos
) < SCHARS (string
))
9633 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9635 orig_local_map
= map
;
9636 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9639 if (!NILP (map
) || !NILP (map2
))
9640 goto replay_sequence
;
9646 else if (NILP (from_string
)
9647 && (string
= POSN_STRING (EVENT_START (key
)),
9648 (CONSP (string
) && STRINGP (XCAR (string
)))))
9650 /* For a click on a string, i.e. overlay string or a
9651 string displayed via the `display' property,
9652 consider `local-map' and `keymap' properties of
9654 Lisp_Object pos
, map
, map2
;
9656 pos
= XCDR (string
);
9657 string
= XCAR (string
);
9659 && XINT (pos
) < SCHARS (string
))
9661 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9663 orig_local_map
= map
;
9664 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9668 if (!NILP (map
) || !NILP (map2
))
9670 from_string
= string
;
9673 goto replay_sequence
;
9678 else if (CONSP (XCDR (key
))
9679 && CONSP (EVENT_START (key
))
9680 && CONSP (XCDR (EVENT_START (key
))))
9684 posn
= POSN_POSN (EVENT_START (key
));
9685 /* Handle menu-bar events:
9686 insert the dummy prefix event `menu-bar'. */
9687 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9689 if (t
+ 1 >= bufsize
)
9690 error ("Key sequence too long");
9694 /* Zap the position in key, so we know that we've
9695 expanded it, and don't try to do so again. */
9696 POSN_SET_POSN (EVENT_START (key
),
9697 Fcons (posn
, Qnil
));
9700 goto replay_sequence
;
9702 else if (CONSP (posn
))
9704 /* We're looking at the second event of a
9705 sequence which we expanded before. Set
9706 last_real_key_start appropriately. */
9707 if (last_real_key_start
== t
&& t
> 0)
9708 last_real_key_start
= t
- 1;
9713 /* We have finally decided that KEY is something we might want
9715 first_binding
= (follow_key (key
,
9716 nmaps
- first_binding
,
9717 submaps
+ first_binding
,
9718 defs
+ first_binding
,
9719 submaps
+ first_binding
)
9722 /* If KEY wasn't bound, we'll try some fallbacks. */
9723 if (first_binding
< nmaps
)
9724 /* This is needed for the following scenario:
9725 event 0: a down-event that gets dropped by calling replay_key.
9726 event 1: some normal prefix like C-h.
9727 After event 0, first_unbound is 0, after event 1 indec.start,
9728 fkey.start, and keytran.start are all 1, so when we see that
9729 C-h is bound, we need to update first_unbound. */
9730 first_unbound
= max (t
+ 1, first_unbound
);
9735 /* Remember the position to put an upper bound on indec.start. */
9736 first_unbound
= min (t
, first_unbound
);
9738 head
= EVENT_HEAD (key
);
9739 if (help_char_p (head
) && t
> 0)
9741 read_key_sequence_cmd
= Vprefix_help_command
;
9743 last_nonmenu_event
= key
;
9744 /* The Microsoft C compiler can't handle the goto that
9752 Lisp_Object breakdown
;
9755 breakdown
= parse_modifiers (head
);
9756 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9757 /* Attempt to reduce an unbound mouse event to a simpler
9758 event that is bound:
9759 Drags reduce to clicks.
9760 Double-clicks reduce to clicks.
9761 Triple-clicks reduce to double-clicks, then to clicks.
9762 Down-clicks are eliminated.
9763 Double-downs reduce to downs, then are eliminated.
9764 Triple-downs reduce to double-downs, then to downs,
9765 then are eliminated. */
9766 if (modifiers
& (down_modifier
| drag_modifier
9767 | double_modifier
| triple_modifier
))
9769 while (modifiers
& (down_modifier
| drag_modifier
9770 | double_modifier
| triple_modifier
))
9772 Lisp_Object new_head
, new_click
;
9773 if (modifiers
& triple_modifier
)
9774 modifiers
^= (double_modifier
| triple_modifier
);
9775 else if (modifiers
& double_modifier
)
9776 modifiers
&= ~double_modifier
;
9777 else if (modifiers
& drag_modifier
)
9778 modifiers
&= ~drag_modifier
;
9781 /* Dispose of this `down' event by simply jumping
9782 back to replay_key, to get another event.
9784 Note that if this event came from mock input,
9785 then just jumping back to replay_key will just
9786 hand it to us again. So we have to wipe out any
9789 We could delete keybuf[t] and shift everything
9790 after that to the left by one spot, but we'd also
9791 have to fix up any variable that points into
9792 keybuf, and shifting isn't really necessary
9795 Adding prefixes for non-textual mouse clicks
9796 creates two characters of mock input, and both
9797 must be thrown away. If we're only looking at
9798 the prefix now, we can just jump back to
9799 replay_key. On the other hand, if we've already
9800 processed the prefix, and now the actual click
9801 itself is giving us trouble, then we've lost the
9802 state of the keymaps we want to backtrack to, and
9803 we need to replay the whole sequence to rebuild
9806 Beyond that, only function key expansion could
9807 create more than two keys, but that should never
9808 generate mouse events, so it's okay to zero
9809 mock_input in that case too.
9811 FIXME: The above paragraph seems just plain
9812 wrong, if you consider things like
9813 xterm-mouse-mode. -stef
9815 Isn't this just the most wonderful code ever? */
9817 /* If mock_input > t + 1, the above simplification
9818 will actually end up dropping keys on the floor.
9819 This is probably OK for now, but even
9820 if mock_input <= t + 1, we need to adjust indec,
9822 Typical case [header-line down-mouse-N]:
9823 mock_input = 2, t = 1, fkey.end = 1,
9824 last_real_key_start = 0. */
9825 if (indec
.end
> last_real_key_start
)
9827 indec
.end
= indec
.start
9828 = min (last_real_key_start
, indec
.start
);
9829 indec
.map
= indec
.parent
;
9830 if (fkey
.end
> last_real_key_start
)
9832 fkey
.end
= fkey
.start
9833 = min (last_real_key_start
, fkey
.start
);
9834 fkey
.map
= fkey
.parent
;
9835 if (keytran
.end
> last_real_key_start
)
9837 keytran
.end
= keytran
.start
9838 = min (last_real_key_start
, keytran
.start
);
9839 keytran
.map
= keytran
.parent
;
9843 if (t
== last_real_key_start
)
9850 mock_input
= last_real_key_start
;
9851 goto replay_sequence
;
9856 = apply_modifiers (modifiers
, XCAR (breakdown
));
9858 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9860 /* Look for a binding for this new key. follow_key
9861 promises that it didn't munge submaps the
9862 last time we called it, since key was unbound. */
9864 = (follow_key (new_click
,
9865 nmaps
- local_first_binding
,
9866 submaps
+ local_first_binding
,
9867 defs
+ local_first_binding
,
9868 submaps
+ local_first_binding
)
9869 + local_first_binding
);
9871 /* If that click is bound, go for it. */
9872 if (first_binding
< nmaps
)
9877 /* Otherwise, we'll leave key set to the drag event. */
9884 /* Normally, last_nonmenu_event gets the previous key we read.
9885 But when a mouse popup menu is being used,
9886 we don't update last_nonmenu_event; it continues to hold the mouse
9887 event that preceded the first level of menu. */
9888 if (!used_mouse_menu
)
9889 last_nonmenu_event
= key
;
9891 /* Record what part of this_command_keys is the current key sequence. */
9892 this_single_command_key_start
= this_command_key_count
- t
;
9894 /* Look for this sequence in input-decode-map.
9895 Scan from indec.end until we find a bound suffix. */
9896 while (indec
.end
< t
)
9898 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9901 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9902 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9907 mock_input
= diff
+ max (t
, mock_input
);
9908 goto replay_sequence
;
9912 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9913 && indec
.start
>= t
)
9914 /* There is a binding and it's not a prefix.
9915 (and it doesn't have any input-decode-map translation pending).
9916 There is thus no function-key in this sequence.
9917 Moving fkey.start is important in this case to allow keytran.start
9918 to go over the sequence before we return (since we keep the
9919 invariant that keytran.end <= fkey.start). */
9922 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9925 /* If the sequence is unbound, see if we can hang a function key
9926 off the end of it. */
9927 /* Continue scan from fkey.end until we find a bound suffix. */
9928 while (fkey
.end
< indec
.start
)
9930 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9933 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9934 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9935 max (t
, mock_input
),
9936 /* If there's a binding (i.e.
9937 first_binding >= nmaps) we don't want
9938 to apply this function-key-mapping. */
9939 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9944 mock_input
= diff
+ max (t
, mock_input
);
9945 /* Adjust the input-decode-map counters. */
9947 indec
.start
+= diff
;
9949 goto replay_sequence
;
9953 /* Look for this sequence in key-translation-map.
9954 Scan from keytran.end until we find a bound suffix. */
9955 while (keytran
.end
< fkey
.start
)
9957 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9960 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9961 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9966 mock_input
= diff
+ max (t
, mock_input
);
9967 /* Adjust the function-key-map and input-decode-map counters. */
9969 indec
.start
+= diff
;
9973 goto replay_sequence
;
9977 /* If KEY is not defined in any of the keymaps,
9978 and cannot be part of a function key or translation,
9979 and is an upper case letter
9980 use the corresponding lower-case letter instead. */
9981 if (first_binding
>= nmaps
9982 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9984 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9985 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9986 || (XINT (key
) & shift_modifier
)))
9988 Lisp_Object new_key
;
9990 original_uppercase
= key
;
9991 original_uppercase_position
= t
- 1;
9993 if (XINT (key
) & shift_modifier
)
9994 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9996 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9997 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9999 /* We have to do this unconditionally, regardless of whether
10000 the lower-case char is defined in the keymaps, because they
10001 might get translated through function-key-map. */
10002 keybuf
[t
- 1] = new_key
;
10003 mock_input
= max (t
, mock_input
);
10004 shift_translated
= 1;
10006 goto replay_sequence
;
10008 /* If KEY is not defined in any of the keymaps,
10009 and cannot be part of a function key or translation,
10010 and is a shifted function key,
10011 use the corresponding unshifted function key instead. */
10012 if (first_binding
>= nmaps
10013 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10015 Lisp_Object breakdown
= parse_modifiers (key
);
10017 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10019 if (modifiers
& shift_modifier
10020 /* Treat uppercase keys as shifted. */
10022 && (KEY_TO_CHAR (key
)
10023 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10024 && UPPERCASEP (KEY_TO_CHAR (key
))))
10026 Lisp_Object new_key
10027 = (modifiers
& shift_modifier
10028 ? apply_modifiers (modifiers
& ~shift_modifier
,
10030 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10032 original_uppercase
= key
;
10033 original_uppercase_position
= t
- 1;
10035 /* We have to do this unconditionally, regardless of whether
10036 the lower-case char is defined in the keymaps, because they
10037 might get translated through function-key-map. */
10038 keybuf
[t
- 1] = new_key
;
10039 mock_input
= max (t
, mock_input
);
10040 /* Reset fkey (and consequently keytran) to apply
10041 function-key-map on the result, so that S-backspace is
10042 correctly mapped to DEL (via backspace). OTOH,
10043 input-decode-map doesn't need to go through it again. */
10044 fkey
.start
= fkey
.end
= 0;
10045 keytran
.start
= keytran
.end
= 0;
10046 shift_translated
= 1;
10048 goto replay_sequence
;
10053 read_key_sequence_cmd
= (first_binding
< nmaps
10054 ? defs
[first_binding
]
10057 unread_switch_frame
= delayed_switch_frame
;
10058 unbind_to (count
, Qnil
);
10060 /* Don't downcase the last character if the caller says don't.
10061 Don't downcase it if the result is undefined, either. */
10062 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10064 && t
- 1 == original_uppercase_position
)
10066 keybuf
[t
- 1] = original_uppercase
;
10067 shift_translated
= 0;
10070 if (shift_translated
)
10071 Vthis_command_keys_shift_translated
= Qt
;
10073 /* Occasionally we fabricate events, perhaps by expanding something
10074 according to function-key-map, or by adding a prefix symbol to a
10075 mouse click in the scroll bar or modeline. In this cases, return
10076 the entire generated key sequence, even if we hit an unbound
10077 prefix or a definition before the end. This means that you will
10078 be able to push back the event properly, and also means that
10079 read-key-sequence will always return a logical unit.
10082 for (; t
< mock_input
; t
++)
10084 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10085 && NILP (Fzerop (Vecho_keystrokes
)))
10086 echo_char (keybuf
[t
]);
10087 add_command_key (keybuf
[t
]);
10094 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10095 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10096 The sequence is sufficient to specify a non-prefix command in the
10097 current local and global maps.
10099 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10100 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10101 as a continuation of the previous key.
10103 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10104 convert the last event to lower case. (Normally any upper case event
10105 is converted to lower case if the original event is undefined and the lower
10106 case equivalent is defined.) A non-nil value is appropriate for reading
10107 a key sequence to be defined.
10109 A C-g typed while in this function is treated like any other character,
10110 and `quit-flag' is not set.
10112 If the key sequence starts with a mouse click, then the sequence is read
10113 using the keymaps of the buffer of the window clicked in, not the buffer
10114 of the selected window as normal.
10116 `read-key-sequence' drops unbound button-down events, since you normally
10117 only care about the click or drag events which follow them. If a drag
10118 or multi-click event is unbound, but the corresponding click event would
10119 be bound, `read-key-sequence' turns the event into a click event at the
10120 drag's starting position. This means that you don't have to distinguish
10121 between click and drag, double, or triple events unless you want to.
10123 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10124 lines separating windows, and scroll bars with imaginary keys
10125 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10127 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10128 function will process a switch-frame event if the user switches frames
10129 before typing anything. If the user switches frames in the middle of a
10130 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10131 is nil, then the event will be put off until after the current key sequence.
10133 `read-key-sequence' checks `function-key-map' for function key
10134 sequences, where they wouldn't conflict with ordinary bindings. See
10135 `function-key-map' for more details.
10137 The optional fifth argument COMMAND-LOOP, if non-nil, means
10138 that this key sequence is being read by something that will
10139 read commands one after another. It should be nil if the caller
10140 will read just one key sequence. */)
10141 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10143 Lisp_Object keybuf
[30];
10145 struct gcpro gcpro1
;
10146 int count
= SPECPDL_INDEX ();
10148 if (!NILP (prompt
))
10149 CHECK_STRING (prompt
);
10152 specbind (Qinput_method_exit_on_first_char
,
10153 (NILP (command_loop
) ? Qt
: Qnil
));
10154 specbind (Qinput_method_use_echo_area
,
10155 (NILP (command_loop
) ? Qt
: Qnil
));
10157 memset (keybuf
, 0, sizeof keybuf
);
10158 GCPRO1 (keybuf
[0]);
10159 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10161 if (NILP (continue_echo
))
10163 this_command_key_count
= 0;
10164 this_command_key_count_reset
= 0;
10165 this_single_command_key_start
= 0;
10168 #ifdef HAVE_WINDOW_SYSTEM
10169 if (display_hourglass_p
)
10170 cancel_hourglass ();
10173 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10174 prompt
, ! NILP (dont_downcase_last
),
10175 ! NILP (can_return_switch_frame
), 0);
10177 #if 0 /* The following is fine for code reading a key sequence and
10178 then proceeding with a lenghty computation, but it's not good
10179 for code reading keys in a loop, like an input method. */
10180 #ifdef HAVE_WINDOW_SYSTEM
10181 if (display_hourglass_p
)
10182 start_hourglass ();
10192 return unbind_to (count
, make_event_array (i
, keybuf
));
10195 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10196 Sread_key_sequence_vector
, 1, 5, 0,
10197 doc
: /* Like `read-key-sequence' but always return a vector. */)
10198 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10200 Lisp_Object keybuf
[30];
10202 struct gcpro gcpro1
;
10203 int count
= SPECPDL_INDEX ();
10205 if (!NILP (prompt
))
10206 CHECK_STRING (prompt
);
10209 specbind (Qinput_method_exit_on_first_char
,
10210 (NILP (command_loop
) ? Qt
: Qnil
));
10211 specbind (Qinput_method_use_echo_area
,
10212 (NILP (command_loop
) ? Qt
: Qnil
));
10214 memset (keybuf
, 0, sizeof keybuf
);
10215 GCPRO1 (keybuf
[0]);
10216 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10218 if (NILP (continue_echo
))
10220 this_command_key_count
= 0;
10221 this_command_key_count_reset
= 0;
10222 this_single_command_key_start
= 0;
10225 #ifdef HAVE_WINDOW_SYSTEM
10226 if (display_hourglass_p
)
10227 cancel_hourglass ();
10230 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10231 prompt
, ! NILP (dont_downcase_last
),
10232 ! NILP (can_return_switch_frame
), 0);
10234 #ifdef HAVE_WINDOW_SYSTEM
10235 if (display_hourglass_p
)
10236 start_hourglass ();
10245 return unbind_to (count
, Fvector (i
, keybuf
));
10248 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10249 doc
: /* Execute CMD as an editor command.
10250 CMD must be a symbol that satisfies the `commandp' predicate.
10251 Optional second arg RECORD-FLAG non-nil
10252 means unconditionally put this command in `command-history'.
10253 Otherwise, that is done only if an arg is read using the minibuffer.
10254 The argument KEYS specifies the value to use instead of (this-command-keys)
10255 when reading the arguments; if it is nil, (this-command-keys) is used.
10256 The argument SPECIAL, if non-nil, means that this command is executing
10257 a special event, so ignore the prefix argument and don't clear it. */)
10258 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10260 register Lisp_Object final
;
10261 register Lisp_Object tem
;
10262 Lisp_Object prefixarg
;
10264 debug_on_next_call
= 0;
10266 if (NILP (special
))
10268 prefixarg
= current_kboard
->Vprefix_arg
;
10269 Vcurrent_prefix_arg
= prefixarg
;
10270 current_kboard
->Vprefix_arg
= Qnil
;
10277 tem
= Fget (cmd
, Qdisabled
);
10278 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10280 tem
= Fsymbol_value (Qdisabled_command_function
);
10282 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10288 final
= Findirect_function (cmd
, Qnil
);
10290 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10292 struct gcpro gcpro1
, gcpro2
;
10294 GCPRO2 (cmd
, prefixarg
);
10295 do_autoload (final
, cmd
);
10302 if (STRINGP (final
) || VECTORP (final
))
10304 /* If requested, place the macro in the command history. For
10305 other sorts of commands, call-interactively takes care of
10307 if (!NILP (record_flag
))
10310 = Fcons (Fcons (Qexecute_kbd_macro
,
10311 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10314 /* Don't keep command history around forever. */
10315 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10317 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10319 XSETCDR (tem
, Qnil
);
10323 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10326 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10327 /* Don't call Fcall_interactively directly because we want to make
10328 sure the backtrace has an entry for `call-interactively'.
10329 For the same reason, pass `cmd' rather than `final'. */
10330 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10337 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10339 doc
: /* Read function name, then read its arguments and call it.
10341 To pass a numeric argument to the command you are invoking with, specify
10342 the numeric argument to this command.
10344 Noninteractively, the argument PREFIXARG is the prefix argument to
10345 give to the command you invoke, if it asks for an argument. */)
10346 (Lisp_Object prefixarg
)
10348 Lisp_Object function
;
10349 int saved_last_point_position
;
10350 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10351 Lisp_Object bindings
, value
;
10352 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10353 #ifdef HAVE_WINDOW_SYSTEM
10354 /* The call to Fcompleting_read will start and cancel the hourglass,
10355 but if the hourglass was already scheduled, this means that no
10356 hourglass will be shown for the actual M-x command itself.
10357 So we restart it if it is already scheduled. Note that checking
10358 hourglass_shown_p is not enough, normally the hourglass is not shown,
10359 just scheduled to be shown. */
10360 int hstarted
= hourglass_started ();
10363 saved_keys
= Fvector (this_command_key_count
,
10364 XVECTOR (this_command_keys
)->contents
);
10365 saved_last_point_position_buffer
= last_point_position_buffer
;
10366 saved_last_point_position
= last_point_position
;
10367 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10369 function
= call0 (intern ("read-extended-command"));
10371 #ifdef HAVE_WINDOW_SYSTEM
10372 if (hstarted
) start_hourglass ();
10375 if (STRINGP (function
) && SCHARS (function
) == 0)
10376 error ("No command name given");
10378 /* Set this_command_keys to the concatenation of saved_keys and
10379 function, followed by a RET. */
10384 this_command_key_count
= 0;
10385 this_command_key_count_reset
= 0;
10386 this_single_command_key_start
= 0;
10388 keys
= XVECTOR (saved_keys
)->contents
;
10389 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10390 add_command_key (keys
[i
]);
10392 for (i
= 0; i
< SCHARS (function
); i
++)
10393 add_command_key (Faref (function
, make_number (i
)));
10395 add_command_key (make_number ('\015'));
10398 last_point_position
= saved_last_point_position
;
10399 last_point_position_buffer
= saved_last_point_position_buffer
;
10403 function
= Fintern (function
, Qnil
);
10404 current_kboard
->Vprefix_arg
= prefixarg
;
10405 Vthis_command
= function
;
10406 real_this_command
= function
;
10408 /* If enabled, show which key runs this command. */
10409 if (!NILP (Vsuggest_key_bindings
)
10410 && NILP (Vexecuting_kbd_macro
)
10411 && SYMBOLP (function
))
10412 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10418 GCPRO3 (bindings
, value
, function
);
10419 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10421 /* If the command has a key binding, print it now. */
10422 if (!NILP (bindings
)
10423 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10426 /* But first wait, and skip the message if there is input. */
10427 Lisp_Object waited
;
10429 /* If this command displayed something in the echo area;
10430 wait a few seconds, then display our suggestion message. */
10431 if (NILP (echo_area_buffer
[0]))
10432 waited
= sit_for (make_number (0), 0, 2);
10433 else if (NUMBERP (Vsuggest_key_bindings
))
10434 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10436 waited
= sit_for (make_number (2), 0, 2);
10438 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10440 Lisp_Object binding
;
10442 int message_p
= push_message ();
10443 int count
= SPECPDL_INDEX ();
10445 record_unwind_protect (pop_message_unwind
, Qnil
);
10446 binding
= Fkey_description (bindings
, Qnil
);
10449 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10452 sprintf (newmessage
, "You can run the command `%s' with %s",
10453 SDATA (SYMBOL_NAME (function
)),
10455 message2_nolog (newmessage
,
10456 strlen (newmessage
),
10457 STRING_MULTIBYTE (binding
));
10458 if (NUMBERP (Vsuggest_key_bindings
))
10459 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10461 waited
= sit_for (make_number (2), 0, 2);
10463 if (!NILP (waited
) && message_p
)
10464 restore_message ();
10466 unbind_to (count
, Qnil
);
10470 RETURN_UNGCPRO (value
);
10474 /* Return nonzero if input events are pending. */
10477 detect_input_pending (void)
10479 if (!input_pending
)
10480 get_input_pending (&input_pending
, 0);
10482 return input_pending
;
10485 /* Return nonzero if input events other than mouse movements are
10489 detect_input_pending_ignore_squeezables (void)
10491 if (!input_pending
)
10492 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10494 return input_pending
;
10497 /* Return nonzero if input events are pending, and run any pending timers. */
10500 detect_input_pending_run_timers (int do_display
)
10502 int old_timers_run
= timers_run
;
10504 if (!input_pending
)
10505 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10507 if (old_timers_run
!= timers_run
&& do_display
)
10509 redisplay_preserve_echo_area (8);
10510 /* The following fixes a bug when using lazy-lock with
10511 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10512 from an idle timer function. The symptom of the bug is that
10513 the cursor sometimes doesn't become visible until the next X
10514 event is processed. --gerd. */
10516 Lisp_Object tail
, frame
;
10517 FOR_EACH_FRAME (tail
, frame
)
10518 if (FRAME_RIF (XFRAME (frame
)))
10519 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10523 return input_pending
;
10526 /* This is called in some cases before a possible quit.
10527 It cases the next call to detect_input_pending to recompute input_pending.
10528 So calling this function unnecessarily can't do any harm. */
10531 clear_input_pending (void)
10536 /* Return nonzero if there are pending requeued events.
10537 This isn't used yet. The hope is to make wait_reading_process_output
10538 call it, and return if it runs Lisp code that unreads something.
10539 The problem is, kbd_buffer_get_event needs to be fixed to know what
10540 to do in that case. It isn't trivial. */
10543 requeued_events_pending_p (void)
10545 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10549 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10550 doc
: /* Return t if command input is currently available with no wait.
10551 Actually, the value is nil only if we can be sure that no input is available;
10552 if there is a doubt, the value is t. */)
10555 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10556 || !NILP (Vunread_post_input_method_events
)
10557 || !NILP (Vunread_input_method_events
))
10560 get_input_pending (&input_pending
,
10561 READABLE_EVENTS_DO_TIMERS_NOW
10562 | READABLE_EVENTS_FILTER_EVENTS
);
10563 return input_pending
> 0 ? Qt
: Qnil
;
10566 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10567 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10570 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10573 if (total_keys
< NUM_RECENT_KEYS
)
10574 return Fvector (total_keys
, keys
);
10577 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10578 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10579 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10580 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10581 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10586 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10587 doc
: /* Return the key sequence that invoked this command.
10588 However, if the command has called `read-key-sequence', it returns
10589 the last key sequence that has been read.
10590 The value is a string or a vector.
10592 See also `this-command-keys-vector'. */)
10595 return make_event_array (this_command_key_count
,
10596 XVECTOR (this_command_keys
)->contents
);
10599 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10600 doc
: /* Return the key sequence that invoked this command, as a vector.
10601 However, if the command has called `read-key-sequence', it returns
10602 the last key sequence that has been read.
10604 See also `this-command-keys'. */)
10607 return Fvector (this_command_key_count
,
10608 XVECTOR (this_command_keys
)->contents
);
10611 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10612 Sthis_single_command_keys
, 0, 0, 0,
10613 doc
: /* Return the key sequence that invoked this command.
10614 More generally, it returns the last key sequence read, either by
10615 the command loop or by `read-key-sequence'.
10616 Unlike `this-command-keys', this function's value
10617 does not include prefix arguments.
10618 The value is always a vector. */)
10621 return Fvector (this_command_key_count
10622 - this_single_command_key_start
,
10623 (XVECTOR (this_command_keys
)->contents
10624 + this_single_command_key_start
));
10627 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10628 Sthis_single_command_raw_keys
, 0, 0, 0,
10629 doc
: /* Return the raw events that were read for this command.
10630 More generally, it returns the last key sequence read, either by
10631 the command loop or by `read-key-sequence'.
10632 Unlike `this-single-command-keys', this function's value
10633 shows the events before all translations (except for input methods).
10634 The value is always a vector. */)
10637 return Fvector (raw_keybuf_count
,
10638 (XVECTOR (raw_keybuf
)->contents
));
10641 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10642 Sreset_this_command_lengths
, 0, 0, 0,
10643 doc
: /* Make the unread events replace the last command and echo.
10644 Used in `universal-argument-other-key'.
10646 `universal-argument-other-key' rereads the event just typed.
10647 It then gets translated through `function-key-map'.
10648 The translated event has to replace the real events,
10649 both in the value of (this-command-keys) and in echoing.
10650 To achieve this, `universal-argument-other-key' calls
10651 `reset-this-command-lengths', which discards the record of reading
10652 these events the first time. */)
10655 this_command_key_count
= before_command_key_count
;
10656 if (this_command_key_count
< this_single_command_key_start
)
10657 this_single_command_key_start
= this_command_key_count
;
10659 echo_truncate (before_command_echo_length
);
10661 /* Cause whatever we put into unread-command-events
10662 to echo as if it were being freshly read from the keyboard. */
10663 this_command_key_count_reset
= 1;
10668 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10669 Sclear_this_command_keys
, 0, 1, 0,
10670 doc
: /* Clear out the vector that `this-command-keys' returns.
10671 Also clear the record of the last 100 events, unless optional arg
10672 KEEP-RECORD is non-nil. */)
10673 (Lisp_Object keep_record
)
10677 this_command_key_count
= 0;
10678 this_command_key_count_reset
= 0;
10680 if (NILP (keep_record
))
10682 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10683 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10685 recent_keys_index
= 0;
10690 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10691 doc
: /* Return the current depth in recursive edits. */)
10695 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10699 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10700 "FOpen dribble file: ",
10701 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10702 If FILE is nil, close any open dribble file. */)
10714 file
= Fexpand_file_name (file
, Qnil
);
10715 dribble
= fopen (SDATA (file
), "w");
10717 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10722 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10723 doc
: /* Discard the contents of the terminal input buffer.
10724 Also end any kbd macro being defined. */)
10727 if (!NILP (current_kboard
->defining_kbd_macro
))
10729 /* Discard the last command from the macro. */
10730 Fcancel_kbd_macro_events ();
10734 update_mode_lines
++;
10736 Vunread_command_events
= Qnil
;
10737 unread_command_char
= -1;
10739 discard_tty_input ();
10741 kbd_fetch_ptr
= kbd_store_ptr
;
10747 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10748 doc
: /* Stop Emacs and return to superior process. You can resume later.
10749 If `cannot-suspend' is non-nil, or if the system doesn't support job
10750 control, run a subshell instead.
10752 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10753 to be read as terminal input by Emacs's parent, after suspension.
10755 Before suspending, run the normal hook `suspend-hook'.
10756 After resumption run the normal hook `suspend-resume-hook'.
10758 Some operating systems cannot stop the Emacs process and resume it later.
10759 On such systems, Emacs starts a subshell instead of suspending. */)
10760 (Lisp_Object stuffstring
)
10762 int count
= SPECPDL_INDEX ();
10763 int old_height
, old_width
;
10765 struct gcpro gcpro1
;
10767 if (tty_list
&& tty_list
->next
)
10768 error ("There are other tty frames open; close them before suspending Emacs");
10770 if (!NILP (stuffstring
))
10771 CHECK_STRING (stuffstring
);
10773 /* Run the functions in suspend-hook. */
10774 if (!NILP (Vrun_hooks
))
10775 call1 (Vrun_hooks
, intern ("suspend-hook"));
10777 GCPRO1 (stuffstring
);
10778 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10779 reset_all_sys_modes ();
10780 /* sys_suspend can get an error if it tries to fork a subshell
10781 and the system resources aren't available for that. */
10782 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10784 stuff_buffered_input (stuffstring
);
10785 if (cannot_suspend
)
10789 unbind_to (count
, Qnil
);
10791 /* Check if terminal/window size has changed.
10792 Note that this is not useful when we are running directly
10793 with a window system; but suspend should be disabled in that case. */
10794 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10795 if (width
!= old_width
|| height
!= old_height
)
10796 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10798 /* Run suspend-resume-hook. */
10799 if (!NILP (Vrun_hooks
))
10800 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10806 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10807 Then in any case stuff anything Emacs has read ahead and not used. */
10810 stuff_buffered_input (Lisp_Object stuffstring
)
10812 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10813 register unsigned char *p
;
10815 if (STRINGP (stuffstring
))
10817 register int count
;
10819 p
= SDATA (stuffstring
);
10820 count
= SBYTES (stuffstring
);
10821 while (count
-- > 0)
10826 /* Anything we have read ahead, put back for the shell to read. */
10827 /* ?? What should this do when we have multiple keyboards??
10828 Should we ignore anything that was typed in at the "wrong" kboard?
10830 rms: we should stuff everything back into the kboard
10832 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10835 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10836 kbd_fetch_ptr
= kbd_buffer
;
10837 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10838 stuff_char (kbd_fetch_ptr
->code
);
10840 clear_event (kbd_fetch_ptr
);
10844 #endif /* SIGTSTP */
10848 set_waiting_for_input (struct timeval
*time_to_clear
)
10850 input_available_clear_time
= time_to_clear
;
10852 /* Tell handle_interrupt to throw back to read_char, */
10853 waiting_for_input
= 1;
10855 /* If handle_interrupt was called before and buffered a C-g,
10856 make it run again now, to avoid timing error. */
10857 if (!NILP (Vquit_flag
))
10858 quit_throw_to_read_char ();
10862 clear_waiting_for_input (void)
10864 /* Tell handle_interrupt not to throw back to read_char, */
10865 waiting_for_input
= 0;
10866 input_available_clear_time
= 0;
10869 /* The SIGINT handler.
10871 If we have a frame on the controlling tty, we assume that the
10872 SIGINT was generated by C-g, so we call handle_interrupt.
10873 Otherwise, the handler kills Emacs. */
10876 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10877 /* compilers complain in signal calls. */
10879 /* Must preserve main program's value of errno. */
10880 int old_errno
= errno
;
10881 struct terminal
*terminal
;
10883 SIGNAL_THREAD_CHECK (signalnum
);
10885 /* See if we have an active terminal on our controlling tty. */
10886 terminal
= get_named_tty ("/dev/tty");
10889 /* If there are no frames there, let's pretend that we are a
10890 well-behaving UN*X program and quit. */
10891 Fkill_emacs (Qnil
);
10895 /* Otherwise, the SIGINT was probably generated by C-g. */
10897 /* Set internal_last_event_frame to the top frame of the
10898 controlling tty, if we have a frame there. We disable the
10899 interrupt key on secondary ttys, so the SIGINT must have come
10900 from the controlling tty. */
10901 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10903 handle_interrupt ();
10909 /* This routine is called at interrupt level in response to C-g.
10911 It is called from the SIGINT handler or kbd_buffer_store_event.
10913 If `waiting_for_input' is non zero, then unless `echoing' is
10914 nonzero, immediately throw back to read_char.
10916 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10917 eval to throw, when it gets a chance. If quit-flag is already
10918 non-nil, it stops the job right away. */
10921 handle_interrupt (void)
10927 /* XXX This code needs to be revised for multi-tty support. */
10928 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10930 /* If SIGINT isn't blocked, don't let us be interrupted by
10931 another SIGINT, it might be harmful due to non-reentrancy
10932 in I/O functions. */
10933 sigblock (sigmask (SIGINT
));
10936 reset_all_sys_modes ();
10938 #ifdef SIGTSTP /* Support possible in later USG versions */
10940 * On systems which can suspend the current process and return to the original
10941 * shell, this command causes the user to end up back at the shell.
10942 * The "Auto-save" and "Abort" questions are not asked until
10943 * the user elects to return to emacs, at which point he can save the current
10944 * job and either dump core or continue.
10948 /* Perhaps should really fork an inferior shell?
10949 But that would not provide any way to get back
10950 to the original shell, ever. */
10951 printf ("No support for stopping a process on this operating system;\n");
10952 printf ("you can continue or abort.\n");
10953 #endif /* not SIGTSTP */
10955 /* We must remain inside the screen area when the internal terminal
10956 is used. Note that [Enter] is not echoed by dos. */
10957 cursor_to (SELECTED_FRAME (), 0, 0);
10959 /* It doesn't work to autosave while GC is in progress;
10960 the code used for auto-saving doesn't cope with the mark bit. */
10961 if (!gc_in_progress
)
10963 printf ("Auto-save? (y or n) ");
10965 if (((c
= getchar ()) & ~040) == 'Y')
10967 Fdo_auto_save (Qt
, Qnil
);
10969 printf ("\r\nAuto-save done");
10970 #else /* not MSDOS */
10971 printf ("Auto-save done\n");
10972 #endif /* not MSDOS */
10974 while (c
!= '\n') c
= getchar ();
10978 /* During GC, it must be safe to reenable quitting again. */
10979 Vinhibit_quit
= Qnil
;
10982 #endif /* not MSDOS */
10983 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10984 printf ("but will instead do a real quit after garbage collection ends\r\n");
10989 printf ("\r\nAbort? (y or n) ");
10990 #else /* not MSDOS */
10991 printf ("Abort (and dump core)? (y or n) ");
10992 #endif /* not MSDOS */
10994 if (((c
= getchar ()) & ~040) == 'Y')
10996 while (c
!= '\n') c
= getchar ();
10998 printf ("\r\nContinuing...\r\n");
10999 #else /* not MSDOS */
11000 printf ("Continuing...\n");
11001 #endif /* not MSDOS */
11003 init_all_sys_modes ();
11008 /* If executing a function that wants to be interrupted out of
11009 and the user has not deferred quitting by binding `inhibit-quit'
11010 then quit right away. */
11011 if (immediate_quit
&& NILP (Vinhibit_quit
))
11013 struct gl_state_s saved
;
11014 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11016 immediate_quit
= 0;
11019 GCPRO4 (saved
.object
, saved
.global_code
,
11020 saved
.current_syntax_table
, saved
.old_prop
);
11021 Fsignal (Qquit
, Qnil
);
11022 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11027 /* Else request quit when it's safe */
11031 /* TODO: The longjmp in this call throws the NS event loop integration off,
11032 and it seems to do fine without this. Probably some attention
11033 needs to be paid to the setting of waiting_for_input in
11034 wait_reading_process_output() under HAVE_NS because of the call
11035 to ns_select there (needed because otherwise events aren't picked up
11036 outside of polling since we don't get SIGIO like X and we don't have a
11037 separate event loop thread like W32. */
11039 if (waiting_for_input
&& !echoing
)
11040 quit_throw_to_read_char ();
11044 /* Handle a C-g by making read_char return C-g. */
11047 quit_throw_to_read_char (void)
11050 /* Prevent another signal from doing this before we finish. */
11051 clear_waiting_for_input ();
11054 Vunread_command_events
= Qnil
;
11055 unread_command_char
= -1;
11057 #if 0 /* Currently, sit_for is called from read_char without turning
11058 off polling. And that can call set_waiting_for_input.
11059 It seems to be harmless. */
11060 #ifdef POLL_FOR_INPUT
11061 /* May be > 1 if in recursive minibuffer. */
11062 if (poll_suppress_count
== 0)
11066 if (FRAMEP (internal_last_event_frame
)
11067 && !EQ (internal_last_event_frame
, selected_frame
))
11068 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11071 _longjmp (getcjmp
, 1);
11074 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11075 doc
: /* Set interrupt mode of reading keyboard input.
11076 If INTERRUPT is non-nil, Emacs will use input interrupts;
11077 otherwise Emacs uses CBREAK mode.
11079 See also `current-input-mode'. */)
11080 (Lisp_Object interrupt
)
11082 int new_interrupt_input
;
11084 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11085 #ifdef HAVE_X_WINDOWS
11086 if (x_display_list
!= NULL
)
11088 /* When using X, don't give the user a real choice,
11089 because we haven't implemented the mechanisms to support it. */
11090 new_interrupt_input
= 1;
11093 #endif /* HAVE_X_WINDOWS */
11094 new_interrupt_input
= !NILP (interrupt
);
11095 #else /* not SIGIO */
11096 new_interrupt_input
= 0;
11097 #endif /* not SIGIO */
11099 if (new_interrupt_input
!= interrupt_input
)
11101 #ifdef POLL_FOR_INPUT
11105 /* this causes startup screen to be restored and messes with the mouse */
11106 reset_all_sys_modes ();
11108 interrupt_input
= new_interrupt_input
;
11110 init_all_sys_modes ();
11113 #ifdef POLL_FOR_INPUT
11114 poll_suppress_count
= 1;
11121 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11122 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11123 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11124 C-q in key sequences.
11126 This setting only has an effect on tty terminals and only when
11127 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11129 See also `current-input-mode'. */)
11130 (Lisp_Object flow
, Lisp_Object terminal
)
11132 struct terminal
*t
= get_terminal (terminal
, 1);
11133 struct tty_display_info
*tty
;
11134 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11136 tty
= t
->display_info
.tty
;
11138 if (tty
->flow_control
!= !NILP (flow
))
11141 /* this causes startup screen to be restored and messes with the mouse */
11142 reset_sys_modes (tty
);
11145 tty
->flow_control
= !NILP (flow
);
11148 init_sys_modes (tty
);
11154 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11155 doc
: /* Enable or disable 8-bit input on TERMINAL.
11156 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11157 bit as the Meta modifier.
11159 If META is nil, Emacs will ignore the top bit, on the assumption it is
11162 Otherwise, Emacs will accept and pass through 8-bit input without
11163 specially interpreting the top bit.
11165 This setting only has an effect on tty terminal devices.
11167 Optional parameter TERMINAL specifies the tty terminal device to use.
11168 It may be a terminal object, a frame, or nil for the terminal used by
11169 the currently selected frame.
11171 See also `current-input-mode'. */)
11172 (Lisp_Object meta
, Lisp_Object terminal
)
11174 struct terminal
*t
= get_terminal (terminal
, 1);
11175 struct tty_display_info
*tty
;
11178 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11180 tty
= t
->display_info
.tty
;
11184 else if (EQ (meta
, Qt
))
11189 if (tty
->meta_key
!= new_meta
)
11192 /* this causes startup screen to be restored and messes with the mouse */
11193 reset_sys_modes (tty
);
11196 tty
->meta_key
= new_meta
;
11199 init_sys_modes (tty
);
11205 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11206 doc
: /* Specify character used for quitting.
11207 QUIT must be an ASCII character.
11209 This function only has an effect on the controlling tty of the Emacs
11212 See also `current-input-mode'. */)
11215 struct terminal
*t
= get_named_tty ("/dev/tty");
11216 struct tty_display_info
*tty
;
11217 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11219 tty
= t
->display_info
.tty
;
11221 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11222 error ("QUIT must be an ASCII character");
11225 /* this causes startup screen to be restored and messes with the mouse */
11226 reset_sys_modes (tty
);
11229 /* Don't let this value be out of range. */
11230 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11233 init_sys_modes (tty
);
11239 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11240 doc
: /* Set mode of reading keyboard input.
11241 First arg INTERRUPT non-nil means use input interrupts;
11242 nil means use CBREAK mode.
11243 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11244 (no effect except in CBREAK mode).
11245 Third arg META t means accept 8-bit input (for a Meta key).
11246 META nil means ignore the top bit, on the assumption it is parity.
11247 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11248 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11249 See also `current-input-mode'. */)
11250 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11252 Fset_input_interrupt_mode (interrupt
);
11253 Fset_output_flow_control (flow
, Qnil
);
11254 Fset_input_meta_mode (meta
, Qnil
);
11256 Fset_quit_char (quit
);
11260 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11261 doc
: /* Return information about the way Emacs currently reads keyboard input.
11262 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11263 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11264 nil, Emacs is using CBREAK mode.
11265 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11266 terminal; this does not apply if Emacs uses interrupt-driven input.
11267 META is t if accepting 8-bit input with 8th bit as Meta flag.
11268 META nil means ignoring the top bit, on the assumption it is parity.
11269 META is neither t nor nil if accepting 8-bit input and using
11270 all 8 bits as the character code.
11271 QUIT is the character Emacs currently uses to quit.
11272 The elements of this list correspond to the arguments of
11273 `set-input-mode'. */)
11276 Lisp_Object val
[4];
11277 struct frame
*sf
= XFRAME (selected_frame
);
11279 val
[0] = interrupt_input
? Qt
: Qnil
;
11280 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11282 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11283 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11285 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11292 XSETFASTINT (val
[3], quit_char
);
11294 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11297 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11298 doc
: /* Return position information for pixel coordinates X and Y.
11299 By default, X and Y are relative to text area of the selected window.
11300 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11301 If optional fourth arg WHOLE is non-nil, X is relative to the left
11302 edge of the window.
11304 The return value is similar to a mouse click position:
11305 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11306 IMAGE (DX . DY) (WIDTH . HEIGHT))
11307 The `posn-' functions access elements of such lists. */)
11308 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11313 if (NILP (frame_or_window
))
11314 frame_or_window
= selected_window
;
11316 if (WINDOWP (frame_or_window
))
11320 CHECK_LIVE_WINDOW (frame_or_window
);
11322 w
= XWINDOW (frame_or_window
);
11323 XSETINT (x
, (XINT (x
)
11324 + WINDOW_LEFT_EDGE_X (w
)
11326 ? window_box_left_offset (w
, TEXT_AREA
)
11328 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11329 frame_or_window
= w
->frame
;
11332 CHECK_LIVE_FRAME (frame_or_window
);
11334 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11337 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11338 doc
: /* Return position information for buffer POS in WINDOW.
11339 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11341 Return nil if position is not visible in window. Otherwise,
11342 the return value is similar to that returned by `event-start' for
11343 a mouse click at the upper left corner of the glyph corresponding
11344 to the given buffer position:
11345 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11346 IMAGE (DX . DY) (WIDTH . HEIGHT))
11347 The `posn-' functions access elements of such lists. */)
11348 (Lisp_Object pos
, Lisp_Object window
)
11353 window
= selected_window
;
11355 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11358 Lisp_Object x
= XCAR (tem
);
11359 Lisp_Object y
= XCAR (XCDR (tem
));
11361 /* Point invisible due to hscrolling? */
11364 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11372 * Set up a new kboard object with reasonable initial values.
11375 init_kboard (KBOARD
*kb
)
11377 kb
->Voverriding_terminal_local_map
= Qnil
;
11378 kb
->Vlast_command
= Qnil
;
11379 kb
->Vreal_last_command
= Qnil
;
11380 kb
->Vkeyboard_translate_table
= Qnil
;
11381 kb
->Vlast_repeatable_command
= Qnil
;
11382 kb
->Vprefix_arg
= Qnil
;
11383 kb
->Vlast_prefix_arg
= Qnil
;
11384 kb
->kbd_queue
= Qnil
;
11385 kb
->kbd_queue_has_data
= 0;
11386 kb
->immediate_echo
= 0;
11387 kb
->echo_string
= Qnil
;
11388 kb
->echo_after_prompt
= -1;
11389 kb
->kbd_macro_buffer
= 0;
11390 kb
->kbd_macro_bufsize
= 0;
11391 kb
->defining_kbd_macro
= Qnil
;
11392 kb
->Vlast_kbd_macro
= Qnil
;
11393 kb
->reference_count
= 0;
11394 kb
->Vsystem_key_alist
= Qnil
;
11395 kb
->system_key_syms
= Qnil
;
11396 kb
->Vwindow_system
= Qt
; /* Unset. */
11397 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11398 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11399 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11400 kb
->Vdefault_minibuffer_frame
= Qnil
;
11404 * Destroy the contents of a kboard object, but not the object itself.
11405 * We use this just before deleting it, or if we're going to initialize
11406 * it a second time.
11409 wipe_kboard (KBOARD
*kb
)
11411 xfree (kb
->kbd_macro_buffer
);
11414 /* Free KB and memory referenced from it. */
11417 delete_kboard (KBOARD
*kb
)
11421 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11424 *kbp
= kb
->next_kboard
;
11426 /* Prevent a dangling reference to KB. */
11427 if (kb
== current_kboard
11428 && FRAMEP (selected_frame
)
11429 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11431 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11433 if (current_kboard
== kb
)
11442 init_keyboard (void)
11444 /* This is correct before outermost invocation of the editor loop */
11445 command_loop_level
= -1;
11446 immediate_quit
= 0;
11447 quit_char
= Ctl ('g');
11448 Vunread_command_events
= Qnil
;
11449 unread_command_char
= -1;
11450 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11452 recent_keys_index
= 0;
11453 kbd_fetch_ptr
= kbd_buffer
;
11454 kbd_store_ptr
= kbd_buffer
;
11455 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11456 do_mouse_tracking
= Qnil
;
11459 interrupt_input_blocked
= 0;
11460 interrupt_input_pending
= 0;
11462 pending_signals
= 0;
11465 /* This means that command_loop_1 won't try to select anything the first
11467 internal_last_event_frame
= Qnil
;
11468 Vlast_event_frame
= internal_last_event_frame
;
11470 current_kboard
= initial_kboard
;
11471 /* Re-initialize the keyboard again. */
11472 wipe_kboard (current_kboard
);
11473 init_kboard (current_kboard
);
11474 /* A value of nil for Vwindow_system normally means a tty, but we also use
11475 it for the initial terminal since there is no window system there. */
11476 current_kboard
->Vwindow_system
= Qnil
;
11478 if (!noninteractive
)
11480 /* Before multi-tty support, these handlers used to be installed
11481 only if the current session was a tty session. Now an Emacs
11482 session may have multiple display types, so we always handle
11483 SIGINT. There is special code in interrupt_signal to exit
11484 Emacs on SIGINT when there are no termcap frames on the
11485 controlling terminal. */
11486 signal (SIGINT
, interrupt_signal
);
11488 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11489 SIGQUIT and we can't tell which one it will give us. */
11490 signal (SIGQUIT
, interrupt_signal
);
11491 #endif /* not DOS_NT */
11493 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11495 if (!noninteractive
)
11496 signal (SIGIO
, input_available_signal
);
11499 /* Use interrupt input by default, if it works and noninterrupt input
11500 has deficiencies. */
11502 #ifdef INTERRUPT_INPUT
11503 interrupt_input
= 1;
11505 interrupt_input
= 0;
11511 if (keyboard_init_hook
)
11512 (*keyboard_init_hook
) ();
11514 #ifdef POLL_FOR_INPUT
11516 poll_suppress_count
= 1;
11521 /* This type's only use is in syms_of_keyboard, to initialize the
11522 event header symbols and put properties on them. */
11523 struct event_head
{
11529 static const struct event_head head_table
[] = {
11530 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11531 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11532 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11533 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11534 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11535 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11536 /* `select-window' should be handled just like `switch-frame'
11537 in read_key_sequence. */
11538 {&Qselect_window
, "select-window", &Qswitch_frame
}
11542 syms_of_keyboard (void)
11544 pending_funcalls
= Qnil
;
11545 staticpro (&pending_funcalls
);
11547 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11548 staticpro (&Vlispy_mouse_stem
);
11551 QCimage
= intern_c_string (":image");
11552 staticpro (&QCimage
);
11554 staticpro (&Qhelp_echo
);
11555 Qhelp_echo
= intern_c_string ("help-echo");
11558 Qrtl
= intern_c_string (":rtl");
11560 staticpro (&item_properties
);
11561 item_properties
= Qnil
;
11563 staticpro (&tool_bar_item_properties
);
11564 tool_bar_item_properties
= Qnil
;
11565 staticpro (&tool_bar_items_vector
);
11566 tool_bar_items_vector
= Qnil
;
11568 staticpro (&real_this_command
);
11569 real_this_command
= Qnil
;
11571 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11572 staticpro (&Qtimer_event_handler
);
11574 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11575 staticpro (&Qdisabled_command_function
);
11577 Qself_insert_command
= intern_c_string ("self-insert-command");
11578 staticpro (&Qself_insert_command
);
11580 Qforward_char
= intern_c_string ("forward-char");
11581 staticpro (&Qforward_char
);
11583 Qbackward_char
= intern_c_string ("backward-char");
11584 staticpro (&Qbackward_char
);
11586 Qdisabled
= intern_c_string ("disabled");
11587 staticpro (&Qdisabled
);
11589 Qundefined
= intern_c_string ("undefined");
11590 staticpro (&Qundefined
);
11592 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11593 staticpro (&Qpre_command_hook
);
11595 Qpost_command_hook
= intern_c_string ("post-command-hook");
11596 staticpro (&Qpost_command_hook
);
11598 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11599 staticpro (&Qdeferred_action_function
);
11601 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11602 staticpro (&Qcommand_hook_internal
);
11604 Qfunction_key
= intern_c_string ("function-key");
11605 staticpro (&Qfunction_key
);
11606 Qmouse_click
= intern_c_string ("mouse-click");
11607 staticpro (&Qmouse_click
);
11608 #if defined (WINDOWSNT)
11609 Qlanguage_change
= intern_c_string ("language-change");
11610 staticpro (&Qlanguage_change
);
11612 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11613 staticpro (&Qdrag_n_drop
);
11615 Qsave_session
= intern_c_string ("save-session");
11616 staticpro (&Qsave_session
);
11619 Qdbus_event
= intern_c_string ("dbus-event");
11620 staticpro (&Qdbus_event
);
11623 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11624 staticpro (&Qconfig_changed_event
);
11626 Qmenu_enable
= intern_c_string ("menu-enable");
11627 staticpro (&Qmenu_enable
);
11628 QCenable
= intern_c_string (":enable");
11629 staticpro (&QCenable
);
11630 QCvisible
= intern_c_string (":visible");
11631 staticpro (&QCvisible
);
11632 QChelp
= intern_c_string (":help");
11633 staticpro (&QChelp
);
11634 QCfilter
= intern_c_string (":filter");
11635 staticpro (&QCfilter
);
11636 QCbutton
= intern_c_string (":button");
11637 staticpro (&QCbutton
);
11638 QCkeys
= intern_c_string (":keys");
11639 staticpro (&QCkeys
);
11640 QCkey_sequence
= intern_c_string (":key-sequence");
11641 staticpro (&QCkey_sequence
);
11642 QCtoggle
= intern_c_string (":toggle");
11643 staticpro (&QCtoggle
);
11644 QCradio
= intern_c_string (":radio");
11645 staticpro (&QCradio
);
11646 QClabel
= intern_c_string (":label");
11647 staticpro (&QClabel
);
11649 Qmode_line
= intern_c_string ("mode-line");
11650 staticpro (&Qmode_line
);
11651 Qvertical_line
= intern_c_string ("vertical-line");
11652 staticpro (&Qvertical_line
);
11653 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11654 staticpro (&Qvertical_scroll_bar
);
11655 Qmenu_bar
= intern_c_string ("menu-bar");
11656 staticpro (&Qmenu_bar
);
11658 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11659 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11660 staticpro (&Qmouse_fixup_help_message
);
11663 Qabove_handle
= intern_c_string ("above-handle");
11664 staticpro (&Qabove_handle
);
11665 Qhandle
= intern_c_string ("handle");
11666 staticpro (&Qhandle
);
11667 Qbelow_handle
= intern_c_string ("below-handle");
11668 staticpro (&Qbelow_handle
);
11669 Qup
= intern_c_string ("up");
11671 Qdown
= intern_c_string ("down");
11672 staticpro (&Qdown
);
11673 Qtop
= intern_c_string ("top");
11675 Qbottom
= intern_c_string ("bottom");
11676 staticpro (&Qbottom
);
11677 Qend_scroll
= intern_c_string ("end-scroll");
11678 staticpro (&Qend_scroll
);
11679 Qratio
= intern_c_string ("ratio");
11680 staticpro (&Qratio
);
11682 Qevent_kind
= intern_c_string ("event-kind");
11683 staticpro (&Qevent_kind
);
11684 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11685 staticpro (&Qevent_symbol_elements
);
11686 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11687 staticpro (&Qevent_symbol_element_mask
);
11688 Qmodifier_cache
= intern_c_string ("modifier-cache");
11689 staticpro (&Qmodifier_cache
);
11691 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11692 staticpro (&Qrecompute_lucid_menubar
);
11693 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11694 staticpro (&Qactivate_menubar_hook
);
11696 Qpolling_period
= intern_c_string ("polling-period");
11697 staticpro (&Qpolling_period
);
11699 Qinput_method_function
= intern_c_string ("input-method-function");
11700 staticpro (&Qinput_method_function
);
11702 Qx_set_selection
= intern_c_string ("x-set-selection");
11703 staticpro (&Qx_set_selection
);
11704 QPRIMARY
= intern_c_string ("PRIMARY");
11705 staticpro (&QPRIMARY
);
11706 Qhandle_switch_frame
= intern_c_string ("handle-switch-frame");
11707 staticpro (&Qhandle_switch_frame
);
11709 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11710 staticpro (&Qinput_method_exit_on_first_char
);
11711 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11712 staticpro (&Qinput_method_use_echo_area
);
11714 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11715 Fset (Qinput_method_use_echo_area
, Qnil
);
11717 last_point_position_buffer
= Qnil
;
11718 last_point_position_window
= Qnil
;
11721 const struct event_head
*p
;
11723 for (p
= head_table
;
11724 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11727 *p
->var
= intern_c_string (p
->name
);
11728 staticpro (p
->var
);
11729 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11730 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11734 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11735 staticpro (&button_down_location
);
11736 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11737 staticpro (&mouse_syms
);
11738 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11739 / sizeof (lispy_wheel_names
[0])),
11741 staticpro (&wheel_syms
);
11745 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11747 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11748 for (i
= 0; i
< len
; i
++)
11749 if (modifier_names
[i
])
11750 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11751 staticpro (&modifier_symbols
);
11754 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11755 staticpro (&recent_keys
);
11757 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11758 staticpro (&this_command_keys
);
11760 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11761 staticpro (&raw_keybuf
);
11763 Qextended_command_history
= intern_c_string ("extended-command-history");
11764 Fset (Qextended_command_history
, Qnil
);
11765 staticpro (&Qextended_command_history
);
11767 accent_key_syms
= Qnil
;
11768 staticpro (&accent_key_syms
);
11770 func_key_syms
= Qnil
;
11771 staticpro (&func_key_syms
);
11773 drag_n_drop_syms
= Qnil
;
11774 staticpro (&drag_n_drop_syms
);
11776 unread_switch_frame
= Qnil
;
11777 staticpro (&unread_switch_frame
);
11779 internal_last_event_frame
= Qnil
;
11780 staticpro (&internal_last_event_frame
);
11782 read_key_sequence_cmd
= Qnil
;
11783 staticpro (&read_key_sequence_cmd
);
11785 menu_bar_one_keymap_changed_items
= Qnil
;
11786 staticpro (&menu_bar_one_keymap_changed_items
);
11788 menu_bar_items_vector
= Qnil
;
11789 staticpro (&menu_bar_items_vector
);
11791 help_form_saved_window_configs
= Qnil
;
11792 staticpro (&help_form_saved_window_configs
);
11794 defsubr (&Scurrent_idle_time
);
11795 defsubr (&Sevent_symbol_parse_modifiers
);
11796 defsubr (&Sevent_convert_list
);
11797 defsubr (&Sread_key_sequence
);
11798 defsubr (&Sread_key_sequence_vector
);
11799 defsubr (&Srecursive_edit
);
11800 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11801 defsubr (&Strack_mouse
);
11803 defsubr (&Sinput_pending_p
);
11804 defsubr (&Scommand_execute
);
11805 defsubr (&Srecent_keys
);
11806 defsubr (&Sthis_command_keys
);
11807 defsubr (&Sthis_command_keys_vector
);
11808 defsubr (&Sthis_single_command_keys
);
11809 defsubr (&Sthis_single_command_raw_keys
);
11810 defsubr (&Sreset_this_command_lengths
);
11811 defsubr (&Sclear_this_command_keys
);
11812 defsubr (&Ssuspend_emacs
);
11813 defsubr (&Sabort_recursive_edit
);
11814 defsubr (&Sexit_recursive_edit
);
11815 defsubr (&Srecursion_depth
);
11816 defsubr (&Stop_level
);
11817 defsubr (&Sdiscard_input
);
11818 defsubr (&Sopen_dribble_file
);
11819 defsubr (&Sset_input_interrupt_mode
);
11820 defsubr (&Sset_output_flow_control
);
11821 defsubr (&Sset_input_meta_mode
);
11822 defsubr (&Sset_quit_char
);
11823 defsubr (&Sset_input_mode
);
11824 defsubr (&Scurrent_input_mode
);
11825 defsubr (&Sexecute_extended_command
);
11826 defsubr (&Sposn_at_point
);
11827 defsubr (&Sposn_at_x_y
);
11829 DEFVAR_LISP ("last-command-event", &last_command_event
,
11830 doc
: /* Last input event that was part of a command. */);
11832 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11833 doc
: /* Last input event in a command, except for mouse menu events.
11834 Mouse menus give back keys that don't look like mouse events;
11835 this variable holds the actual mouse event that led to the menu,
11836 so that you can determine whether the command was run by mouse or not. */);
11838 DEFVAR_LISP ("last-input-event", &last_input_event
,
11839 doc
: /* Last input event. */);
11841 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11842 doc
: /* List of events to be read as the command input.
11843 These events are processed first, before actual keyboard input.
11844 Events read from this list are not normally added to `this-command-keys',
11845 as they will already have been added once as they were read for the first time.
11846 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11847 Vunread_command_events
= Qnil
;
11849 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11850 doc
: /* If not -1, an object to be read as next command input event. */);
11852 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11853 doc
: /* List of events to be processed as input by input methods.
11854 These events are processed before `unread-command-events'
11855 and actual keyboard input, but are not given to `input-method-function'. */);
11856 Vunread_post_input_method_events
= Qnil
;
11858 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11859 doc
: /* List of events to be processed as input by input methods.
11860 These events are processed after `unread-command-events', but
11861 before actual keyboard input.
11862 If there's an active input method, the events are given to
11863 `input-method-function'. */);
11864 Vunread_input_method_events
= Qnil
;
11866 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11867 doc
: /* Meta-prefix character code.
11868 Meta-foo as command input turns into this character followed by foo. */);
11869 XSETINT (meta_prefix_char
, 033);
11871 DEFVAR_KBOARD ("last-command", Vlast_command
,
11872 doc
: /* The last command executed.
11873 Normally a symbol with a function definition, but can be whatever was found
11874 in the keymap, or whatever the variable `this-command' was set to by that
11877 The value `mode-exit' is special; it means that the previous command
11878 read an event that told it to exit, and it did so and unread that event.
11879 In other words, the present command is the event that made the previous
11882 The value `kill-region' is special; it means that the previous command
11883 was a kill command.
11885 `last-command' has a separate binding for each terminal device.
11886 See Info node `(elisp)Multiple Terminals'. */);
11888 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11889 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11891 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11892 doc
: /* Last command that may be repeated.
11893 The last command executed that was not bound to an input event.
11894 This is the command `repeat' will try to repeat. */);
11896 DEFVAR_LISP ("this-command", &Vthis_command
,
11897 doc
: /* The command now being executed.
11898 The command can set this variable; whatever is put here
11899 will be in `last-command' during the following command. */);
11900 Vthis_command
= Qnil
;
11902 DEFVAR_LISP ("this-command-keys-shift-translated",
11903 &Vthis_command_keys_shift_translated
,
11904 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11905 Shift-translation occurs when there is no binding for the key sequence
11906 as entered, but a binding was found by changing an upper-case letter
11907 to lower-case, or a shifted function key to an unshifted one. */);
11908 Vthis_command_keys_shift_translated
= Qnil
;
11910 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11911 doc
: /* The command bound to the current key sequence before remapping.
11912 It equals `this-command' if the original command was not remapped through
11913 any of the active keymaps. Otherwise, the value of `this-command' is the
11914 result of looking up the original command in the active keymaps. */);
11915 Vthis_original_command
= Qnil
;
11917 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11918 doc
: /* *Number of input events between auto-saves.
11919 Zero means disable autosaving due to number of characters typed. */);
11920 auto_save_interval
= 300;
11922 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11923 doc
: /* *Number of seconds idle time before auto-save.
11924 Zero or nil means disable auto-saving due to idleness.
11925 After auto-saving due to this many seconds of idle time,
11926 Emacs also does a garbage collection if that seems to be warranted. */);
11927 XSETFASTINT (Vauto_save_timeout
, 30);
11929 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11930 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11931 The value may be integer or floating point. */);
11932 Vecho_keystrokes
= make_number (1);
11934 DEFVAR_INT ("polling-period", &polling_period
,
11935 doc
: /* *Interval between polling for input during Lisp execution.
11936 The reason for polling is to make C-g work to stop a running program.
11937 Polling is needed only when using X windows and SIGIO does not work.
11938 Polling is automatically disabled in all other cases. */);
11939 polling_period
= 2;
11941 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11942 doc
: /* *Maximum time between mouse clicks to make a double-click.
11943 Measured in milliseconds. The value nil means disable double-click
11944 recognition; t means double-clicks have no time limit and are detected
11945 by position only. */);
11946 Vdouble_click_time
= make_number (500);
11948 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11949 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11950 On window-system frames, value is the number of pixels the mouse may have
11951 moved horizontally or vertically between two clicks to make a double-click.
11952 On non window-system frames, value is interpreted in units of 1/8 characters
11955 This variable is also the threshold for motion of the mouse
11956 to count as a drag. */);
11957 double_click_fuzz
= 3;
11959 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11960 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11961 inhibit_local_menu_bar_menus
= 0;
11963 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11964 doc
: /* Number of complete key sequences read as input so far.
11965 This includes key sequences read from keyboard macros.
11966 The number is effectively the number of interactive command invocations. */);
11967 num_input_keys
= 0;
11969 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11970 doc
: /* Number of input events read from the keyboard so far.
11971 This does not include events generated by keyboard macros. */);
11972 num_nonmacro_input_events
= 0;
11974 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11975 doc
: /* The frame in which the most recently read event occurred.
11976 If the last event came from a keyboard macro, this is set to `macro'. */);
11977 Vlast_event_frame
= Qnil
;
11979 /* This variable is set up in sysdep.c. */
11980 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11981 doc
: /* The ERASE character as set by the user with stty. */);
11983 DEFVAR_LISP ("help-char", &Vhelp_char
,
11984 doc
: /* Character to recognize as meaning Help.
11985 When it is read, do `(eval help-form)', and display result if it's a string.
11986 If the value of `help-form' is nil, this char can be read normally. */);
11987 XSETINT (Vhelp_char
, Ctl ('H'));
11989 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11990 doc
: /* List of input events to recognize as meaning Help.
11991 These work just like the value of `help-char' (see that). */);
11992 Vhelp_event_list
= Qnil
;
11994 DEFVAR_LISP ("help-form", &Vhelp_form
,
11995 doc
: /* Form to execute when character `help-char' is read.
11996 If the form returns a string, that string is displayed.
11997 If `help-form' is nil, the help char is not recognized. */);
12000 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12001 doc
: /* Command to run when `help-char' character follows a prefix key.
12002 This command is used only when there is no actual binding
12003 for that character after that prefix key. */);
12004 Vprefix_help_command
= Qnil
;
12006 DEFVAR_LISP ("top-level", &Vtop_level
,
12007 doc
: /* Form to evaluate when Emacs starts up.
12008 Useful to set before you dump a modified Emacs. */);
12011 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12012 doc
: /* Translate table for local keyboard input, or nil.
12013 If non-nil, the value should be a char-table. Each character read
12014 from the keyboard is looked up in this char-table. If the value found
12015 there is non-nil, then it is used instead of the actual input character.
12017 The value can also be a string or vector, but this is considered obsolete.
12018 If it is a string or vector of length N, character codes N and up are left
12019 untranslated. In a vector, an element which is nil means "no translation".
12021 This is applied to the characters supplied to input methods, not their
12022 output. See also `translation-table-for-input'.
12024 This variable has a separate binding for each terminal.
12025 See Info node `(elisp)Multiple Terminals'. */);
12027 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12028 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12029 \(Even if the operating system has support for stopping a process.\) */);
12030 cannot_suspend
= 0;
12032 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12033 doc
: /* Non-nil means prompt with menus when appropriate.
12034 This is done when reading from a keymap that has a prompt string,
12035 for elements that have prompt strings.
12036 The menu is displayed on the screen
12037 if X menus were enabled at configuration
12038 time and the previous event was a mouse click prefix key.
12039 Otherwise, menu prompting uses the echo area. */);
12040 menu_prompting
= 1;
12042 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12043 doc
: /* Character to see next line of menu prompt.
12044 Type this character while in a menu prompt to rotate around the lines of it. */);
12045 XSETINT (menu_prompt_more_char
, ' ');
12047 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12048 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12049 Emacs applies the modifiers of the character stored here to each keyboard
12050 character it reads. For example, after evaluating the expression
12051 (setq extra-keyboard-modifiers ?\\C-x)
12052 all input characters will have the control modifier applied to them.
12054 Note that the character ?\\C-@, equivalent to the integer zero, does
12055 not count as a control character; rather, it counts as a character
12056 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12057 cancels any modification. */);
12058 extra_keyboard_modifiers
= 0;
12060 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12061 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12062 The command loop sets this to nil before each command,
12063 and tests the value when the command returns.
12064 Buffer modification stores t in this variable. */);
12065 Vdeactivate_mark
= Qnil
;
12066 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
12067 staticpro (&Qdeactivate_mark
);
12069 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12070 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12071 Vcommand_hook_internal
= Qnil
;
12073 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12074 doc
: /* Normal hook run before each command is executed.
12075 If an unhandled error happens in running this hook,
12076 the hook value is set to nil, since otherwise the error
12077 might happen repeatedly and make Emacs nonfunctional. */);
12078 Vpre_command_hook
= Qnil
;
12080 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12081 doc
: /* Normal hook run after each command is executed.
12082 If an unhandled error happens in running this hook,
12083 the hook value is set to nil, since otherwise the error
12084 might happen repeatedly and make Emacs nonfunctional. */);
12085 Vpost_command_hook
= Qnil
;
12088 DEFVAR_LISP ("echo-area-clear-hook", ...,
12089 doc
: /* Normal hook run when clearing the echo area. */);
12091 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
12092 staticpro (&Qecho_area_clear_hook
);
12093 Fset (Qecho_area_clear_hook
, Qnil
);
12095 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12096 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12097 Vlucid_menu_bar_dirty_flag
= Qnil
;
12099 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12100 doc
: /* List of menu bar items to move to the end of the menu bar.
12101 The elements of the list are event types that may have menu bar bindings. */);
12102 Vmenu_bar_final_items
= Qnil
;
12104 DEFVAR_KBOARD ("overriding-terminal-local-map",
12105 Voverriding_terminal_local_map
,
12106 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12107 If this variable is non-nil, it is used as a keymap instead of the
12108 buffer's local map, and the minor mode keymaps and text property keymaps.
12109 It also replaces `overriding-local-map'.
12111 This variable is intended to let commands such as `universal-argument'
12112 set up a different keymap for reading the next command.
12114 `overriding-terminal-local-map' has a separate binding for each
12116 See Info node `(elisp)Multiple Terminals'. */);
12118 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12119 doc
: /* Keymap that overrides all other local keymaps.
12120 If this variable is non-nil, it is used as a keymap--replacing the
12121 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12122 Voverriding_local_map
= Qnil
;
12124 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12125 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12126 Otherwise, the menu bar continues to reflect the buffer's local map
12127 and the minor mode maps regardless of `overriding-local-map'. */);
12128 Voverriding_local_map_menu_flag
= Qnil
;
12130 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12131 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12132 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12134 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12135 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12137 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12138 doc
: /* Alist of system-specific X windows key symbols.
12139 Each element should have the form (N . SYMBOL) where N is the
12140 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12141 and SYMBOL is its name.
12143 `system-key-alist' has a separate binding for each terminal device.
12144 See Info node `(elisp)Multiple Terminals'. */);
12146 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12147 doc
: /* Keymap that translates key sequences to key sequences during input.
12148 This is used mainly for mapping key sequences into some preferred
12149 key events (symbols).
12151 The `read-key-sequence' function replaces any subsequence bound by
12152 `local-function-key-map' with its binding. More precisely, when the
12153 active keymaps have no binding for the current key sequence but
12154 `local-function-key-map' binds a suffix of the sequence to a vector or
12155 string, `read-key-sequence' replaces the matching suffix with its
12156 binding, and continues with the new sequence.
12158 If the binding is a function, it is called with one argument (the prompt)
12159 and its return value (a key sequence) is used.
12161 The events that come from bindings in `local-function-key-map' are not
12162 themselves looked up in `local-function-key-map'.
12164 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12165 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12166 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12167 typing `ESC O P x' would return [f1 x].
12169 `local-function-key-map' has a separate binding for each terminal
12170 device. See Info node `(elisp)Multiple Terminals'. If you need to
12171 define a binding on all terminals, change `function-key-map'
12172 instead. Initially, `local-function-key-map' is an empty keymap that
12173 has `function-key-map' as its parent on all terminal devices. */);
12175 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12176 doc
: /* Keymap that decodes input escape sequences.
12177 This is used mainly for mapping ASCII function key sequences into
12178 real Emacs function key events (symbols).
12180 The `read-key-sequence' function replaces any subsequence bound by
12181 `input-decode-map' with its binding. Contrary to `function-key-map',
12182 this map applies its rebinding regardless of the presence of an ordinary
12183 binding. So it is more like `key-translation-map' except that it applies
12184 before `function-key-map' rather than after.
12186 If the binding is a function, it is called with one argument (the prompt)
12187 and its return value (a key sequence) is used.
12189 The events that come from bindings in `input-decode-map' are not
12190 themselves looked up in `input-decode-map'.
12192 This variable is keyboard-local. */);
12194 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12195 doc
: /* The parent keymap of all `local-function-key-map' instances.
12196 Function key definitions that apply to all terminal devices should go
12197 here. If a mapping is defined in both the current
12198 `local-function-key-map' binding and this variable, then the local
12199 definition will take precendence. */);
12200 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12202 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12203 doc
: /* Keymap of key translations that can override keymaps.
12204 This keymap works like `function-key-map', but comes after that,
12205 and its non-prefix bindings override ordinary bindings.
12206 Another difference is that it is global rather than keyboard-local. */);
12207 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12209 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12210 doc
: /* List of deferred actions to be performed at a later time.
12211 The precise format isn't relevant here; we just check whether it is nil. */);
12212 Vdeferred_action_list
= Qnil
;
12214 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12215 doc
: /* Function to call to handle deferred actions, after each command.
12216 This function is called with no arguments after each command
12217 whenever `deferred-action-list' is non-nil. */);
12218 Vdeferred_action_function
= Qnil
;
12220 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12221 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12222 The value can be a length of time to show the message for.
12223 If the value is non-nil and not a number, we wait 2 seconds. */);
12224 Vsuggest_key_bindings
= Qt
;
12226 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12227 doc
: /* List of active absolute time timers in order of increasing time. */);
12228 Vtimer_list
= Qnil
;
12230 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12231 doc
: /* List of active idle-time timers in order of increasing time. */);
12232 Vtimer_idle_list
= Qnil
;
12234 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12235 doc
: /* If non-nil, the function that implements the current input method.
12236 It's called with one argument, a printing character that was just read.
12237 \(That means a character with code 040...0176.)
12238 Typically this function uses `read-event' to read additional events.
12239 When it does so, it should first bind `input-method-function' to nil
12240 so it will not be called recursively.
12242 The function should return a list of zero or more events
12243 to be used as input. If it wants to put back some events
12244 to be reconsidered, separately, by the input method,
12245 it can add them to the beginning of `unread-command-events'.
12247 The input method function can find in `input-method-previous-message'
12248 the previous echo area message.
12250 The input method function should refer to the variables
12251 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12252 for guidance on what to do. */);
12253 Vinput_method_function
= Qnil
;
12255 DEFVAR_LISP ("input-method-previous-message",
12256 &Vinput_method_previous_message
,
12257 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12258 This variable exists because `read-event' clears the echo area
12259 before running the input method. It is nil if there was no message. */);
12260 Vinput_method_previous_message
= Qnil
;
12262 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12263 doc
: /* If non-nil, the function that implements the display of help.
12264 It's called with one argument, the help string to display. */);
12265 Vshow_help_function
= Qnil
;
12267 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12268 doc
: /* If non-nil, suppress point adjustment after executing a command.
12270 After a command is executed, if point is moved into a region that has
12271 special properties (e.g. composition, display), we adjust point to
12272 the boundary of the region. But, when a command sets this variable to
12273 non-nil, we suppress the point adjustment.
12275 This variable is set to nil before reading a command, and is checked
12276 just after executing the command. */);
12277 Vdisable_point_adjustment
= Qnil
;
12279 DEFVAR_LISP ("global-disable-point-adjustment",
12280 &Vglobal_disable_point_adjustment
,
12281 doc
: /* *If non-nil, always suppress point adjustment.
12283 The default value is nil, in which case, point adjustment are
12284 suppressed only after special commands that set
12285 `disable-point-adjustment' (which see) to non-nil. */);
12286 Vglobal_disable_point_adjustment
= Qnil
;
12288 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12289 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12290 If the value is not a number, such messages don't time out. */);
12291 Vminibuffer_message_timeout
= make_number (2);
12293 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12294 doc
: /* If non-nil, any keyboard input throws to this symbol.
12295 The value of that variable is passed to `quit-flag' and later causes a
12296 peculiar kind of quitting. */);
12297 Vthrow_on_input
= Qnil
;
12299 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12300 doc
: /* If non-nil, function to output error messages.
12301 The arguments are the error data, a list of the form
12302 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12303 such as just as `condition-case' would bind its variable to,
12304 the context (a string which normally goes at the start of the message),
12305 and the Lisp function within which the error was signaled. */);
12306 Vcommand_error_function
= Qnil
;
12308 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12309 &Venable_disabled_menus_and_buttons
,
12310 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12312 Help functions bind this to allow help on disabled menu items
12313 and tool-bar buttons. */);
12314 Venable_disabled_menus_and_buttons
= Qnil
;
12316 DEFVAR_LISP ("select-active-regions",
12317 &Vselect_active_regions
,
12318 doc
: /* If non-nil, an active region automatically becomes the window selection.
12319 If the value is `only', only temporarily active regions (usually made
12320 by mouse-dragging or shift-selection) set the window selection.
12322 This takes effect only when Transient Mark mode is enabled. */);
12323 Vselect_active_regions
= Qt
;
12325 DEFVAR_LISP ("saved-region-selection",
12326 &Vsaved_region_selection
,
12327 doc
: /* Contents of active region prior to buffer modification.
12328 If `select-active-regions' is non-nil, Emacs sets this to the
12329 text in the region before modifying the buffer. The next
12330 `deactivate-mark' call uses this to set the window selection. */);
12331 Vsaved_region_selection
= Qnil
;
12333 /* Create the initial keyboard. */
12334 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12335 init_kboard (initial_kboard
);
12336 /* Vwindow_system is left at t for now. */
12337 initial_kboard
->next_kboard
= all_kboards
;
12338 all_kboards
= initial_kboard
;
12342 keys_of_keyboard (void)
12344 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12345 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12346 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12347 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12348 initial_define_key (meta_map
, 'x', "execute-extended-command");
12350 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12351 "handle-delete-frame");
12352 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12353 "ns-put-working-text");
12354 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12355 "ns-unput-working-text");
12356 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12357 current-prefix-arg, as is done in `handle-switch-frame'.
12358 But `handle-switch-frame is not run from the special-map.
12359 Commands from that map are run in a special way that automatically
12360 preserves the prefix-arg. Restoring the prefix arg here is not just
12361 redundant but harmful:
12363 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12364 - after the first prompt, the exit-minibuffer-hook is run which may
12365 iconify a frame and thus push a `iconify-frame' event.
12366 - after running exit-minibuffer-hook, current-prefix-arg is
12367 restored to the non-nil value it had before the prompt.
12368 - we enter the second prompt.
12369 current-prefix-arg is non-nil, prefix-arg is nil.
12370 - before running the first real event, we run the special iconify-frame
12371 event, but we pass the `special' arg to execute-command so
12372 current-prefix-arg and prefix-arg are left untouched.
12373 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12374 - the next key event will have a spuriously non-nil current-prefix-arg. */
12375 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12377 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12379 /* Handling it at such a low-level causes read_key_sequence to get
12380 * confused because it doesn't realize that the current_buffer was
12381 * changed by read_char.
12383 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12384 * "handle-select-window"); */
12385 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12386 "handle-save-session");
12389 /* Define a special event which is raised for dbus callback
12391 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12392 "dbus-handle-event");
12395 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12399 /* Mark the pointers in the kboard objects.
12400 Called by the Fgarbage_collector. */
12402 mark_kboards (void)
12406 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12408 if (kb
->kbd_macro_buffer
)
12409 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12411 mark_object (kb
->Voverriding_terminal_local_map
);
12412 mark_object (kb
->Vlast_command
);
12413 mark_object (kb
->Vreal_last_command
);
12414 mark_object (kb
->Vkeyboard_translate_table
);
12415 mark_object (kb
->Vlast_repeatable_command
);
12416 mark_object (kb
->Vprefix_arg
);
12417 mark_object (kb
->Vlast_prefix_arg
);
12418 mark_object (kb
->kbd_queue
);
12419 mark_object (kb
->defining_kbd_macro
);
12420 mark_object (kb
->Vlast_kbd_macro
);
12421 mark_object (kb
->Vsystem_key_alist
);
12422 mark_object (kb
->system_key_syms
);
12423 mark_object (kb
->Vwindow_system
);
12424 mark_object (kb
->Vinput_decode_map
);
12425 mark_object (kb
->Vlocal_function_key_map
);
12426 mark_object (kb
->Vdefault_minibuffer_frame
);
12427 mark_object (kb
->echo_string
);
12430 struct input_event
*event
;
12431 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12433 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12434 event
= kbd_buffer
;
12435 if (event
->kind
!= SELECTION_REQUEST_EVENT
12436 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12438 mark_object (event
->x
);
12439 mark_object (event
->y
);
12441 mark_object (event
->frame_or_window
);
12442 mark_object (event
->arg
);
12447 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12448 (do not change this comment) */