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>
67 /* This is to get the definitions of the XK_ symbols. */
74 #endif /* HAVE_NTGUI */
80 /* Variables for blockinput.h: */
82 /* Non-zero if interrupt input is blocked right now. */
83 volatile int interrupt_input_blocked
;
85 /* Nonzero means an input interrupt has arrived
86 during the current critical section. */
87 int interrupt_input_pending
;
89 /* This var should be (interrupt_input_pending || pending_atimers).
90 The QUIT macro checks this instead of interrupt_input_pending and
91 pending_atimers separately, to reduce code size. So, any code that
92 changes interrupt_input_pending or pending_atimers should update
98 #define KBD_BUFFER_SIZE 4096
100 KBOARD
*initial_kboard
;
101 KBOARD
*current_kboard
;
105 /* Non-nil disable property on a command means
106 do not execute it; call disabled-command-function's value instead. */
107 Lisp_Object Qdisabled
, Qdisabled_command_function
;
109 #define NUM_RECENT_KEYS (300)
110 int recent_keys_index
; /* Index for storing next element into recent_keys */
111 int total_keys
; /* Total number of elements stored into recent_keys */
112 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
114 /* Vector holding the key sequence that invoked the current command.
115 It is reused for each command, and it may be longer than the current
116 sequence; this_command_key_count indicates how many elements
117 actually mean something.
118 It's easier to staticpro a single Lisp_Object than an array. */
119 Lisp_Object this_command_keys
;
120 int this_command_key_count
;
122 /* 1 after calling Freset_this_command_lengths.
124 int this_command_key_count_reset
;
126 /* This vector is used as a buffer to record the events that were actually read
127 by read_key_sequence. */
128 Lisp_Object raw_keybuf
;
129 int raw_keybuf_count
;
131 /* Non-nil if the present key sequence was obtained by shift translation. */
132 Lisp_Object Vthis_command_keys_shift_translated
;
134 #define GROW_RAW_KEYBUF \
135 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
136 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
138 /* Number of elements of this_command_keys
139 that precede this key sequence. */
140 int this_single_command_key_start
;
142 /* Record values of this_command_key_count and echo_length ()
143 before this command was read. */
144 static int before_command_key_count
;
145 static int before_command_echo_length
;
147 extern int minbuf_level
;
149 extern int message_enable_multibyte
;
151 /* If non-nil, the function that implements the display of help.
152 It's called with one argument, the help string to display. */
154 Lisp_Object Vshow_help_function
;
156 /* Nonzero means do menu prompting. */
158 static int menu_prompting
;
160 /* Character to see next line of menu prompt. */
162 static Lisp_Object menu_prompt_more_char
;
164 /* For longjmp to where kbd input is being done. */
166 static jmp_buf getcjmp
;
168 /* True while doing kbd input. */
169 int waiting_for_input
;
171 /* True while displaying for echoing. Delays C-g throwing. */
175 /* Non-null means we can start echoing at the next input pause even
176 though there is something in the echo area. */
178 static struct kboard
*ok_to_echo_at_next_pause
;
180 /* The kboard last echoing, or null for none. Reset to 0 in
181 cancel_echoing. If non-null, and a current echo area message
182 exists, and echo_message_buffer is eq to the current message
183 buffer, we know that the message comes from echo_kboard. */
185 struct kboard
*echo_kboard
;
187 /* The buffer used for echoing. Set in echo_now, reset in
190 Lisp_Object echo_message_buffer
;
192 /* Nonzero means disregard local maps for the menu bar. */
193 static int inhibit_local_menu_bar_menus
;
195 /* Nonzero means C-g should cause immediate error-signal. */
198 /* The user's hook function for outputting an error message. */
199 Lisp_Object Vcommand_error_function
;
201 /* The user's ERASE setting. */
202 Lisp_Object Vtty_erase_char
;
204 /* Character to recognize as the help char. */
205 Lisp_Object Vhelp_char
;
207 /* List of other event types to recognize as meaning "help". */
208 Lisp_Object Vhelp_event_list
;
210 /* Form to execute when help char is typed. */
211 Lisp_Object Vhelp_form
;
213 /* Command to run when the help character follows a prefix key. */
214 Lisp_Object Vprefix_help_command
;
216 /* List of items that should move to the end of the menu bar. */
217 Lisp_Object Vmenu_bar_final_items
;
219 /* Non-nil means show the equivalent key-binding for
220 any M-x command that has one.
221 The value can be a length of time to show the message for.
222 If the value is non-nil and not a number, we wait 2 seconds. */
223 Lisp_Object Vsuggest_key_bindings
;
225 /* How long to display an echo-area message when the minibuffer is active.
226 If the value is not a number, such messages don't time out. */
227 Lisp_Object Vminibuffer_message_timeout
;
229 /* Character that causes a quit. Normally C-g.
231 If we are running on an ordinary terminal, this must be an ordinary
232 ASCII char, since we want to make it our interrupt character.
234 If we are not running on an ordinary terminal, it still needs to be
235 an ordinary ASCII char. This character needs to be recognized in
236 the input interrupt handler. At this point, the keystroke is
237 represented as a struct input_event, while the desired quit
238 character is specified as a lispy event. The mapping from struct
239 input_events to lispy events cannot run in an interrupt handler,
240 and the reverse mapping is difficult for anything but ASCII
243 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
247 /* If non-nil, this is a map that overrides all other local maps. */
248 Lisp_Object Voverriding_local_map
;
250 /* If non-nil, Voverriding_local_map applies to the menu bar. */
251 Lisp_Object Voverriding_local_map_menu_flag
;
253 /* Keymap that defines special misc events that should
254 be processed immediately at a low level. */
255 Lisp_Object Vspecial_event_map
;
257 /* Current depth in recursive edits. */
258 int command_loop_level
;
260 /* Total number of times command_loop has read a key sequence. */
261 EMACS_INT num_input_keys
;
263 /* Last input event read as a command. */
264 Lisp_Object last_command_event
;
266 /* Last input character read as a command, not counting menus
267 reached by the mouse. */
268 Lisp_Object last_nonmenu_event
;
270 /* Last input event read for any purpose. */
271 Lisp_Object last_input_event
;
273 /* If not Qnil, a list of objects to be read as subsequent command input. */
274 Lisp_Object Vunread_command_events
;
276 /* If not Qnil, a list of objects to be read as subsequent command input
277 including input method processing. */
278 Lisp_Object Vunread_input_method_events
;
280 /* If not Qnil, a list of objects to be read as subsequent command input
281 but NOT including input method processing. */
282 Lisp_Object Vunread_post_input_method_events
;
284 /* If not -1, an event to be read as subsequent command input. */
285 EMACS_INT unread_command_char
;
287 /* If not Qnil, this is a switch-frame event which we decided to put
288 off until the end of a key sequence. This should be read as the
289 next command input, after any unread_command_events.
291 read_key_sequence uses this to delay switch-frame events until the
292 end of the key sequence; Fread_char uses it to put off switch-frame
293 events until a non-ASCII event is acceptable as input. */
294 Lisp_Object unread_switch_frame
;
296 /* A mask of extra modifier bits to put into every keyboard char. */
297 EMACS_INT extra_keyboard_modifiers
;
299 /* Char to use as prefix when a meta character is typed in.
300 This is bound on entry to minibuffer in case ESC is changed there. */
302 Lisp_Object meta_prefix_char
;
304 /* Last size recorded for a current buffer which is not a minibuffer. */
305 static EMACS_INT last_non_minibuf_size
;
307 /* Number of idle seconds before an auto-save and garbage collection. */
308 static Lisp_Object Vauto_save_timeout
;
310 /* Total number of times read_char has returned. */
311 int num_input_events
;
313 /* Total number of times read_char has returned, outside of macros. */
314 EMACS_INT num_nonmacro_input_events
;
316 /* Auto-save automatically when this many characters have been typed
317 since the last time. */
319 static EMACS_INT auto_save_interval
;
321 /* Value of num_nonmacro_input_events as of last auto save. */
325 /* The command being executed by the command loop.
326 Commands may set this, and the value set will be copied into
327 current_kboard->Vlast_command instead of the actual command. */
328 Lisp_Object Vthis_command
;
330 /* This is like Vthis_command, except that commands never set it. */
331 Lisp_Object real_this_command
;
333 /* If the lookup of the command returns a binding, the original
334 command is stored in this-original-command. It is nil otherwise. */
335 Lisp_Object Vthis_original_command
;
337 /* The value of point when the last command was started. */
338 EMACS_INT last_point_position
;
340 /* The buffer that was current when the last command was started. */
341 Lisp_Object last_point_position_buffer
;
343 /* The window that was selected when the last command was started. */
344 Lisp_Object last_point_position_window
;
346 /* The frame in which the last input event occurred, or Qmacro if the
347 last event came from a macro. We use this to determine when to
348 generate switch-frame events. This may be cleared by functions
349 like Fselect_frame, to make sure that a switch-frame event is
350 generated by the next character. */
351 Lisp_Object internal_last_event_frame
;
353 /* A user-visible version of the above, intended to allow users to
354 figure out where the last event came from, if the event doesn't
355 carry that information itself (i.e. if it was a character). */
356 Lisp_Object Vlast_event_frame
;
358 /* The timestamp of the last input event we received from the X server.
359 X Windows wants this for selection ownership. */
360 unsigned long last_event_timestamp
;
362 /* If non-nil, active regions automatically become the window selection. */
363 Lisp_Object Vselect_active_regions
;
365 /* The text in the active region prior to modifying the buffer.
366 Used by the `select-active-regions' feature. */
367 Lisp_Object Vsaved_region_selection
;
369 Lisp_Object Qx_set_selection
, QPRIMARY
, Qhandle_switch_frame
;
371 Lisp_Object Qself_insert_command
;
372 Lisp_Object Qforward_char
;
373 Lisp_Object Qbackward_char
;
374 Lisp_Object Qundefined
;
375 Lisp_Object Qtimer_event_handler
;
377 /* read_key_sequence stores here the command definition of the
378 key sequence that it reads. */
379 Lisp_Object read_key_sequence_cmd
;
381 /* Echo unfinished commands after this many seconds of pause. */
382 Lisp_Object Vecho_keystrokes
;
384 /* Form to evaluate (if non-nil) when Emacs is started. */
385 Lisp_Object Vtop_level
;
387 /* If non-nil, this implements the current input method. */
388 Lisp_Object Vinput_method_function
;
389 Lisp_Object Qinput_method_function
;
391 /* When we call Vinput_method_function,
392 this holds the echo area message that was just erased. */
393 Lisp_Object Vinput_method_previous_message
;
395 /* Non-nil means deactivate the mark at end of this command. */
396 Lisp_Object Vdeactivate_mark
;
397 Lisp_Object Qdeactivate_mark
;
399 /* Menu bar specified in Lucid Emacs fashion. */
401 Lisp_Object Vlucid_menu_bar_dirty_flag
;
402 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
404 Lisp_Object Qecho_area_clear_hook
;
406 /* Hooks to run before and after each command. */
407 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
408 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
409 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
411 /* Parent keymap of terminal-local function-key-map instances. */
412 Lisp_Object Vfunction_key_map
;
414 /* Keymap of key translations that can override keymaps. */
415 Lisp_Object Vkey_translation_map
;
417 /* List of deferred actions to be performed at a later time.
418 The precise format isn't relevant here; we just check whether it is nil. */
419 Lisp_Object Vdeferred_action_list
;
421 /* Function to call to handle deferred actions, when there are any. */
422 Lisp_Object Vdeferred_action_function
;
423 Lisp_Object Qdeferred_action_function
;
425 Lisp_Object Qinput_method_exit_on_first_char
;
426 Lisp_Object Qinput_method_use_echo_area
;
428 /* File in which we write all commands we read. */
431 /* Nonzero if input is available. */
434 extern char *pending_malloc_warning
;
436 /* Circular buffer for pre-read keyboard input. */
438 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
440 /* Pointer to next available character in kbd_buffer.
441 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
442 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
443 next available char is in kbd_buffer[0]. */
444 static struct input_event
*kbd_fetch_ptr
;
446 /* Pointer to next place to store character in kbd_buffer. This
447 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
448 character should go in kbd_buffer[0]. */
449 static struct input_event
* volatile kbd_store_ptr
;
451 /* The above pair of variables forms a "queue empty" flag. When we
452 enqueue a non-hook event, we increment kbd_store_ptr. When we
453 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
454 there is input available if the two pointers are not equal.
456 Why not just have a flag set and cleared by the enqueuing and
457 dequeuing functions? Such a flag could be screwed up by interrupts
458 at inopportune times. */
460 /* If this flag is non-nil, we check mouse_moved to see when the
461 mouse moves, and motion events will appear in the input stream.
462 Otherwise, mouse motion is ignored. */
463 Lisp_Object do_mouse_tracking
;
465 /* Symbols to head events. */
466 Lisp_Object Qmouse_movement
;
467 Lisp_Object Qscroll_bar_movement
;
468 Lisp_Object Qswitch_frame
;
469 Lisp_Object Qdelete_frame
;
470 Lisp_Object Qiconify_frame
;
471 Lisp_Object Qmake_frame_visible
;
472 Lisp_Object Qselect_window
;
473 Lisp_Object Qhelp_echo
;
475 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
476 Lisp_Object Qmouse_fixup_help_message
;
479 /* Symbols to denote kinds of events. */
480 Lisp_Object Qfunction_key
;
481 Lisp_Object Qmouse_click
;
482 #if defined (WINDOWSNT)
483 Lisp_Object Qlanguage_change
;
485 Lisp_Object Qdrag_n_drop
;
486 Lisp_Object Qsave_session
;
488 Lisp_Object Qdbus_event
;
490 Lisp_Object Qconfig_changed_event
;
492 /* Lisp_Object Qmouse_movement; - also an event header */
494 /* Properties of event headers. */
495 Lisp_Object Qevent_kind
;
496 Lisp_Object Qevent_symbol_elements
;
498 /* menu item parts */
499 Lisp_Object Qmenu_enable
;
500 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
501 Lisp_Object QCbutton
, QCtoggle
, QCradio
, QClabel
;
503 /* An event header symbol HEAD may have a property named
504 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
505 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
506 mask of modifiers applied to it. If present, this is used to help
507 speed up parse_modifiers. */
508 Lisp_Object Qevent_symbol_element_mask
;
510 /* An unmodified event header BASE may have a property named
511 Qmodifier_cache, which is an alist mapping modifier masks onto
512 modified versions of BASE. If present, this helps speed up
514 Lisp_Object Qmodifier_cache
;
516 /* Symbols to use for parts of windows. */
517 Lisp_Object Qmode_line
;
518 Lisp_Object Qvertical_line
;
519 Lisp_Object Qvertical_scroll_bar
;
520 Lisp_Object Qmenu_bar
;
522 Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
), command_loop (void);
523 Lisp_Object
Fthis_command_keys (void);
524 Lisp_Object Qextended_command_history
;
525 EMACS_TIME
timer_check (int do_it_now
);
527 static void record_menu_key (Lisp_Object c
);
528 static int echo_length (void);
530 Lisp_Object Qpolling_period
;
532 /* List of absolute timers. Appears in order of next scheduled event. */
533 Lisp_Object Vtimer_list
;
535 /* List of idle time timers. Appears in order of next scheduled event. */
536 Lisp_Object Vtimer_idle_list
;
538 /* Incremented whenever a timer is run. */
541 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
543 EMACS_TIME
*input_available_clear_time
;
545 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
546 Default is 1 if INTERRUPT_INPUT is defined. */
549 /* Nonzero while interrupts are temporarily deferred during redisplay. */
550 int interrupts_deferred
;
552 /* Allow m- file to inhibit use of FIONREAD. */
553 #ifdef BROKEN_FIONREAD
557 /* We are unable to use interrupts if FIONREAD is not available,
558 so flush SIGIO so we won't try. */
559 #if !defined (FIONREAD)
565 /* If we support a window system, turn on the code to poll periodically
566 to detect C-g. It isn't actually used when doing interrupt input. */
567 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
568 #define POLL_FOR_INPUT
571 /* After a command is executed, if point is moved into a region that
572 has specific properties (e.g. composition, display), we adjust
573 point to the boundary of the region. But, if a command sets this
574 variable to non-nil, we suppress this point adjustment. This
575 variable is set to nil before reading a command. */
577 Lisp_Object Vdisable_point_adjustment
;
579 /* If non-nil, always disable point adjustment. */
581 Lisp_Object Vglobal_disable_point_adjustment
;
583 /* The time when Emacs started being idle. */
585 static EMACS_TIME timer_idleness_start_time
;
587 /* After Emacs stops being idle, this saves the last value
588 of timer_idleness_start_time from when it was idle. */
590 static EMACS_TIME timer_last_idleness_start_time
;
592 /* If non-nil, events produced by disabled menu items and tool-bar
593 buttons are not ignored. Help functions bind this to allow help on
594 those items and buttons. */
595 Lisp_Object Venable_disabled_menus_and_buttons
;
598 /* Global variable declarations. */
600 /* Flags for readable_events. */
601 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
602 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
603 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
605 /* Function for init_keyboard to call with no args (if nonzero). */
606 void (*keyboard_init_hook
) (void);
608 static int read_avail_input (int);
609 static void get_input_pending (int *, int);
610 static int readable_events (int);
611 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
613 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
615 static Lisp_Object
make_lispy_event (struct input_event
*);
616 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
617 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
618 enum scroll_bar_part
,
619 Lisp_Object
, Lisp_Object
,
622 static Lisp_Object
modify_event_symbol (EMACS_INT
, unsigned, Lisp_Object
,
623 Lisp_Object
, const char **,
624 Lisp_Object
*, unsigned);
625 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
626 static void save_getcjmp (jmp_buf);
627 static void restore_getcjmp (jmp_buf);
628 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
629 static void clear_event (struct input_event
*);
630 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
631 static SIGTYPE
interrupt_signal (int signalnum
);
633 static SIGTYPE
input_available_signal (int signo
);
635 static void handle_interrupt (void);
636 static void timer_start_idle (void);
637 static void timer_stop_idle (void);
638 static void timer_resume_idle (void);
639 static SIGTYPE
handle_user_signal (int);
640 static char *find_user_signal_name (int);
641 static int store_user_signal_events (void);
643 /* Nonzero means don't try to suspend even if the operating system seems
645 static int cannot_suspend
;
648 /* Add C to the echo string, if echoing is going on.
649 C can be a character, which is printed prettily ("M-C-x" and all that
650 jazz), or a symbol, whose name is printed. */
653 echo_char (Lisp_Object c
)
655 if (current_kboard
->immediate_echo
)
657 int size
= KEY_DESCRIPTION_SIZE
+ 100;
658 char *buffer
= (char *) alloca (size
);
660 Lisp_Object echo_string
;
662 echo_string
= current_kboard
->echo_string
;
664 /* If someone has passed us a composite event, use its head symbol. */
669 ptr
= push_key_description (XINT (c
), ptr
, 1);
671 else if (SYMBOLP (c
))
673 Lisp_Object name
= SYMBOL_NAME (c
);
674 int nbytes
= SBYTES (name
);
676 if (size
- (ptr
- buffer
) < nbytes
)
678 int offset
= ptr
- buffer
;
679 size
= max (2 * size
, size
+ nbytes
);
680 buffer
= (char *) alloca (size
);
681 ptr
= buffer
+ offset
;
684 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
685 STRING_MULTIBYTE (name
), 1);
688 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
691 const char *text
= " (Type ? for further options)";
692 int len
= strlen (text
);
694 if (size
- (ptr
- buffer
) < len
)
696 int offset
= ptr
- buffer
;
698 buffer
= (char *) alloca (size
);
699 ptr
= buffer
+ offset
;
702 memcpy (ptr
, text
, len
);
706 /* Replace a dash from echo_dash with a space, otherwise
707 add a space at the end as a separator between keys. */
708 if (STRINGP (echo_string
)
709 && SCHARS (echo_string
) > 1)
711 Lisp_Object last_char
, prev_char
, idx
;
713 idx
= make_number (SCHARS (echo_string
) - 2);
714 prev_char
= Faref (echo_string
, idx
);
716 idx
= make_number (SCHARS (echo_string
) - 1);
717 last_char
= Faref (echo_string
, idx
);
719 /* We test PREV_CHAR to make sure this isn't the echoing
721 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
722 Faset (echo_string
, idx
, make_number (' '));
724 echo_string
= concat2 (echo_string
, build_string (" "));
726 else if (STRINGP (echo_string
))
727 echo_string
= concat2 (echo_string
, build_string (" "));
729 current_kboard
->echo_string
730 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
736 /* Temporarily add a dash to the end of the echo string if it's not
737 empty, so that it serves as a mini-prompt for the very next character. */
742 /* Do nothing if not echoing at all. */
743 if (NILP (current_kboard
->echo_string
))
746 if (this_command_key_count
== 0)
749 if (!current_kboard
->immediate_echo
750 && SCHARS (current_kboard
->echo_string
) == 0)
753 /* Do nothing if we just printed a prompt. */
754 if (current_kboard
->echo_after_prompt
755 == SCHARS (current_kboard
->echo_string
))
758 /* Do nothing if we have already put a dash at the end. */
759 if (SCHARS (current_kboard
->echo_string
) > 1)
761 Lisp_Object last_char
, prev_char
, idx
;
763 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
764 prev_char
= Faref (current_kboard
->echo_string
, idx
);
766 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
767 last_char
= Faref (current_kboard
->echo_string
, idx
);
769 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
773 /* Put a dash at the end of the buffer temporarily,
774 but make it go away when the next character is added. */
775 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
780 /* Display the current echo string, and begin echoing if not already
786 if (!current_kboard
->immediate_echo
)
789 current_kboard
->immediate_echo
= 1;
791 for (i
= 0; i
< this_command_key_count
; i
++)
795 /* Set before_command_echo_length to the value that would
796 have been saved before the start of this subcommand in
797 command_loop_1, if we had already been echoing then. */
798 if (i
== this_single_command_key_start
)
799 before_command_echo_length
= echo_length ();
801 c
= XVECTOR (this_command_keys
)->contents
[i
];
802 if (! (EVENT_HAS_PARAMETERS (c
)
803 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
807 /* Set before_command_echo_length to the value that would
808 have been saved before the start of this subcommand in
809 command_loop_1, if we had already been echoing then. */
810 if (this_command_key_count
== this_single_command_key_start
)
811 before_command_echo_length
= echo_length ();
813 /* Put a dash at the end to invite the user to type more. */
818 message3_nolog (current_kboard
->echo_string
,
819 SBYTES (current_kboard
->echo_string
),
820 STRING_MULTIBYTE (current_kboard
->echo_string
));
823 /* Record in what buffer we echoed, and from which kboard. */
824 echo_message_buffer
= echo_area_buffer
[0];
825 echo_kboard
= current_kboard
;
827 if (waiting_for_input
&& !NILP (Vquit_flag
))
828 quit_throw_to_read_char ();
831 /* Turn off echoing, for the start of a new command. */
834 cancel_echoing (void)
836 current_kboard
->immediate_echo
= 0;
837 current_kboard
->echo_after_prompt
= -1;
838 current_kboard
->echo_string
= Qnil
;
839 ok_to_echo_at_next_pause
= NULL
;
841 echo_message_buffer
= Qnil
;
844 /* Return the length of the current echo string. */
849 return (STRINGP (current_kboard
->echo_string
)
850 ? SCHARS (current_kboard
->echo_string
)
854 /* Truncate the current echo message to its first LEN chars.
855 This and echo_char get used by read_key_sequence when the user
856 switches frames while entering a key sequence. */
859 echo_truncate (EMACS_INT nchars
)
861 if (STRINGP (current_kboard
->echo_string
))
862 current_kboard
->echo_string
863 = Fsubstring (current_kboard
->echo_string
,
864 make_number (0), make_number (nchars
));
865 truncate_echo_area (nchars
);
869 /* Functions for manipulating this_command_keys. */
871 add_command_key (Lisp_Object key
)
873 #if 0 /* Not needed after we made Freset_this_command_lengths
874 do the job immediately. */
875 /* If reset-this-command-length was called recently, obey it now.
876 See the doc string of that function for an explanation of why. */
877 if (before_command_restore_flag
)
879 this_command_key_count
= before_command_key_count_1
;
880 if (this_command_key_count
< this_single_command_key_start
)
881 this_single_command_key_start
= this_command_key_count
;
882 echo_truncate (before_command_echo_length_1
);
883 before_command_restore_flag
= 0;
887 if (this_command_key_count
>= ASIZE (this_command_keys
))
888 this_command_keys
= larger_vector (this_command_keys
,
889 2 * ASIZE (this_command_keys
),
892 ASET (this_command_keys
, this_command_key_count
, key
);
893 ++this_command_key_count
;
898 recursive_edit_1 (void)
900 int count
= SPECPDL_INDEX ();
903 if (command_loop_level
> 0)
905 specbind (Qstandard_output
, Qt
);
906 specbind (Qstandard_input
, Qt
);
909 #ifdef HAVE_WINDOW_SYSTEM
910 /* The command loop has started an hourglass timer, so we have to
911 cancel it here, otherwise it will fire because the recursive edit
912 can take some time. Do not check for display_hourglass_p here,
913 because it could already be nil. */
917 /* This function may have been called from a debugger called from
918 within redisplay, for instance by Edebugging a function called
919 from fontification-functions. We want to allow redisplay in
920 the debugging session.
922 The recursive edit is left with a `(throw exit ...)'. The `exit'
923 tag is not caught anywhere in redisplay, i.e. when we leave the
924 recursive edit, the original redisplay leading to the recursive
925 edit will be unwound. The outcome should therefore be safe. */
926 specbind (Qinhibit_redisplay
, Qnil
);
929 val
= command_loop ();
931 Fsignal (Qquit
, Qnil
);
932 /* Handle throw from read_minibuf when using minibuffer
933 while it's active but we're in another window. */
935 xsignal1 (Qerror
, val
);
937 return unbind_to (count
, Qnil
);
940 /* When an auto-save happens, record the "time", and don't do again soon. */
943 record_auto_save (void)
945 last_auto_save
= num_nonmacro_input_events
;
948 /* Make an auto save happen as soon as possible at command level. */
951 force_auto_save_soon (void)
953 last_auto_save
= - auto_save_interval
- 1;
955 record_asynch_buffer_change ();
958 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
959 doc
: /* Invoke the editor command loop recursively.
960 To get out of the recursive edit, a command can do `(throw 'exit nil)';
961 that tells this function to return.
962 Alternatively, `(throw 'exit t)' makes this function signal an error.
963 This function is called by the editor initialization to begin editing. */)
966 int count
= SPECPDL_INDEX ();
969 /* If we enter while input is blocked, don't lock up here.
970 This may happen through the debugger during redisplay. */
974 command_loop_level
++;
975 update_mode_lines
= 1;
977 if (command_loop_level
978 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
979 buffer
= Fcurrent_buffer ();
983 /* If we leave recursive_edit_1 below with a `throw' for instance,
984 like it is done in the splash screen display, we have to
985 make sure that we restore single_kboard as command_loop_1
986 would have done if it were left normally. */
987 if (command_loop_level
> 0)
988 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
989 record_unwind_protect (recursive_edit_unwind
, buffer
);
992 return unbind_to (count
, Qnil
);
996 recursive_edit_unwind (Lisp_Object buffer
)
998 if (BUFFERP (buffer
))
999 Fset_buffer (buffer
);
1001 command_loop_level
--;
1002 update_mode_lines
= 1;
1007 #if 0 /* These two functions are now replaced with
1008 temporarily_switch_to_single_kboard. */
1012 #if 0 /* Theory: if there's anything in Vunread_command_events,
1013 it will right away be read by read_key_sequence,
1014 and then if we do switch KBOARDS, it will go into the side
1015 queue then. So we don't need to do anything special here -- rms. */
1016 if (CONSP (Vunread_command_events
))
1018 current_kboard
->kbd_queue
1019 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1020 current_kboard
->kbd_queue_has_data
= 1;
1022 Vunread_command_events
= Qnil
;
1027 /* Switch to the single-kboard state, making current_kboard
1028 the only KBOARD from which further input is accepted. */
1031 single_kboard_state ()
1037 /* If we're in single_kboard state for kboard KBOARD,
1041 not_single_kboard_state (KBOARD
*kboard
)
1043 if (kboard
== current_kboard
)
1047 /* Maintain a stack of kboards, so other parts of Emacs
1048 can switch temporarily to the kboard of a given frame
1049 and then revert to the previous status. */
1054 struct kboard_stack
*next
;
1057 static struct kboard_stack
*kboard_stack
;
1060 push_kboard (struct kboard
*k
)
1062 struct kboard_stack
*p
1063 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1065 p
->next
= kboard_stack
;
1066 p
->kboard
= current_kboard
;
1076 struct kboard_stack
*p
= kboard_stack
;
1078 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1080 if (t
->kboard
== p
->kboard
)
1082 current_kboard
= p
->kboard
;
1089 /* The terminal we remembered has been deleted. */
1090 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1093 kboard_stack
= p
->next
;
1097 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1098 from which further input is accepted. If F is non-nil, set its
1099 KBOARD as the current keyboard.
1101 This function uses record_unwind_protect to return to the previous
1104 If Emacs is already in single_kboard mode, and F's keyboard is
1105 locked, then this function will throw an errow. */
1108 temporarily_switch_to_single_kboard (struct frame
*f
)
1110 int was_locked
= single_kboard
;
1113 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1114 /* We can not switch keyboards while in single_kboard mode.
1115 In rare cases, Lisp code may call `recursive-edit' (or
1116 `read-minibuffer' or `y-or-n-p') after it switched to a
1117 locked frame. For example, this is likely to happen
1118 when server.el connects to a new terminal while Emacs is in
1119 single_kboard mode. It is best to throw an error instead
1120 of presenting the user with a frozen screen. */
1121 error ("Terminal %d is locked, cannot read from it",
1122 FRAME_TERMINAL (f
)->id
);
1124 /* This call is unnecessary, but helps
1125 `restore_kboard_configuration' discover if somebody changed
1126 `current_kboard' behind our back. */
1127 push_kboard (current_kboard
);
1130 current_kboard
= FRAME_KBOARD (f
);
1132 record_unwind_protect (restore_kboard_configuration
,
1133 (was_locked
? Qt
: Qnil
));
1136 #if 0 /* This function is not needed anymore. */
1138 record_single_kboard_state ()
1141 push_kboard (current_kboard
);
1142 record_unwind_protect (restore_kboard_configuration
,
1143 (single_kboard
? Qt
: Qnil
));
1148 restore_kboard_configuration (Lisp_Object was_locked
)
1150 if (NILP (was_locked
))
1154 struct kboard
*prev
= current_kboard
;
1157 /* The pop should not change the kboard. */
1158 if (single_kboard
&& current_kboard
!= prev
)
1165 /* Handle errors that are not handled at inner levels
1166 by printing an error message and returning to the editor command loop. */
1169 cmd_error (Lisp_Object data
)
1171 Lisp_Object old_level
, old_length
;
1172 char macroerror
[50];
1174 #ifdef HAVE_WINDOW_SYSTEM
1175 if (display_hourglass_p
)
1176 cancel_hourglass ();
1179 if (!NILP (executing_kbd_macro
))
1181 if (executing_kbd_macro_iterations
== 1)
1182 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1184 sprintf (macroerror
, "After %d kbd macro iterations: ",
1185 executing_kbd_macro_iterations
);
1190 Vstandard_output
= Qt
;
1191 Vstandard_input
= Qt
;
1192 Vexecuting_kbd_macro
= Qnil
;
1193 executing_kbd_macro
= Qnil
;
1194 current_kboard
->Vprefix_arg
= Qnil
;
1195 current_kboard
->Vlast_prefix_arg
= Qnil
;
1198 /* Avoid unquittable loop if data contains a circular list. */
1199 old_level
= Vprint_level
;
1200 old_length
= Vprint_length
;
1201 XSETFASTINT (Vprint_level
, 10);
1202 XSETFASTINT (Vprint_length
, 10);
1203 cmd_error_internal (data
, macroerror
);
1204 Vprint_level
= old_level
;
1205 Vprint_length
= old_length
;
1209 Vinhibit_quit
= Qnil
;
1210 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1211 if (command_loop_level
== 0 && minibuf_level
== 0)
1212 any_kboard_state ();
1215 return make_number (0);
1218 /* Take actions on handling an error. DATA is the data that describes
1221 CONTEXT is a C-string containing ASCII characters only which
1222 describes the context in which the error happened. If we need to
1223 generalize CONTEXT to allow multibyte characters, make it a Lisp
1227 cmd_error_internal (Lisp_Object data
, const char *context
)
1229 struct frame
*sf
= SELECTED_FRAME ();
1231 /* The immediate context is not interesting for Quits,
1232 since they are asyncronous. */
1233 if (EQ (XCAR (data
), Qquit
))
1234 Vsignaling_function
= Qnil
;
1239 /* Use user's specified output function if any. */
1240 if (!NILP (Vcommand_error_function
))
1241 call3 (Vcommand_error_function
, data
,
1242 context
? build_string (context
) : empty_unibyte_string
,
1243 Vsignaling_function
);
1244 /* If the window system or terminal frame hasn't been initialized
1245 yet, or we're not interactive, write the message to stderr and exit. */
1246 else if (!sf
->glyphs_initialized_p
1247 /* The initial frame is a special non-displaying frame. It
1248 will be current in daemon mode when there are no frames
1249 to display, and in non-daemon mode before the real frame
1250 has finished initializing. If an error is thrown in the
1251 latter case while creating the frame, then the frame
1252 will never be displayed, so the safest thing to do is
1253 write to stderr and quit. In daemon mode, there are
1254 many other potential errors that do not prevent frames
1255 from being created, so continuing as normal is better in
1257 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1260 print_error_message (data
, Qexternal_debugging_output
,
1261 context
, Vsignaling_function
);
1262 Fterpri (Qexternal_debugging_output
);
1263 Fkill_emacs (make_number (-1));
1267 clear_message (1, 0);
1269 message_log_maybe_newline ();
1272 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1275 Vsignaling_function
= Qnil
;
1278 Lisp_Object
command_loop_1 (void);
1279 Lisp_Object
command_loop_2 (Lisp_Object
);
1280 Lisp_Object
top_level_1 (Lisp_Object
);
1282 /* Entry to editor-command-loop.
1283 This level has the catches for exiting/returning to editor command loop.
1284 It returns nil to exit recursive edit, t to abort it. */
1289 if (command_loop_level
> 0 || minibuf_level
> 0)
1292 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1293 executing_kbd_macro
= Qnil
;
1299 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1300 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1301 /* Reset single_kboard in case top-level set it while
1302 evaluating an -f option, or we are stuck there for some
1304 any_kboard_state ();
1306 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1307 executing_kbd_macro
= Qnil
;
1309 /* End of file in -batch run causes exit here. */
1315 /* Here we catch errors in execution of commands within the
1316 editing loop, and reenter the editing loop.
1317 When there is an error, cmd_error runs and returns a non-nil
1318 value to us. A value of nil means that command_loop_1 itself
1319 returned due to end of file (or end of kbd macro). */
1322 command_loop_2 (Lisp_Object ignore
)
1324 register Lisp_Object val
;
1327 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1328 while (!NILP (val
));
1336 return Feval (Vtop_level
);
1340 top_level_1 (Lisp_Object ignore
)
1342 /* On entry to the outer level, run the startup file */
1343 if (!NILP (Vtop_level
))
1344 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1345 else if (!NILP (Vpurify_flag
))
1346 message ("Bare impure Emacs (standard Lisp code not loaded)");
1348 message ("Bare Emacs (standard Lisp code not loaded)");
1352 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1353 doc
: /* Exit all recursive editing levels.
1354 This also exits all active minibuffers. */)
1357 #ifdef HAVE_WINDOW_SYSTEM
1358 if (display_hourglass_p
)
1359 cancel_hourglass ();
1362 /* Unblock input if we enter with input blocked. This may happen if
1363 redisplay traps e.g. during tool-bar update with input blocked. */
1364 while (INPUT_BLOCKED_P
)
1367 Fthrow (Qtop_level
, Qnil
);
1370 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1371 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1374 if (command_loop_level
> 0 || minibuf_level
> 0)
1375 Fthrow (Qexit
, Qnil
);
1377 error ("No recursive edit is in progress");
1380 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1381 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1384 if (command_loop_level
> 0 || minibuf_level
> 0)
1387 error ("No recursive edit is in progress");
1390 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1392 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1393 of this function. */
1396 tracking_off (Lisp_Object old_value
)
1398 do_mouse_tracking
= old_value
;
1399 if (NILP (old_value
))
1401 /* Redisplay may have been preempted because there was input
1402 available, and it assumes it will be called again after the
1403 input has been processed. If the only input available was
1404 the sort that we have just disabled, then we need to call
1406 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1408 redisplay_preserve_echo_area (6);
1409 get_input_pending (&input_pending
,
1410 READABLE_EVENTS_DO_TIMERS_NOW
);
1416 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1417 doc
: /* Evaluate BODY with mouse movement events enabled.
1418 Within a `track-mouse' form, mouse motion generates input events that
1419 you can read with `read-event'.
1420 Normally, mouse motion is ignored.
1421 usage: (track-mouse BODY...) */)
1424 int count
= SPECPDL_INDEX ();
1427 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1429 do_mouse_tracking
= Qt
;
1431 val
= Fprogn (args
);
1432 return unbind_to (count
, val
);
1435 /* If mouse has moved on some frame, return one of those frames.
1439 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1440 after resizing the tool-bar window. */
1442 int ignore_mouse_drag_p
;
1445 some_mouse_moved (void)
1447 Lisp_Object tail
, frame
;
1449 if (ignore_mouse_drag_p
)
1451 /* ignore_mouse_drag_p = 0; */
1455 FOR_EACH_FRAME (tail
, frame
)
1457 if (XFRAME (frame
)->mouse_moved
)
1458 return XFRAME (frame
);
1464 #endif /* HAVE_MOUSE || HAVE_GPM */
1466 /* This is the actual command reading loop,
1467 sans error-handling encapsulation. */
1469 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1471 void safe_run_hooks (Lisp_Object
);
1472 static void adjust_point_for_property (EMACS_INT
, int);
1474 /* Cancel hourglass from protect_unwind.
1476 #ifdef HAVE_WINDOW_SYSTEM
1478 cancel_hourglass_unwind (Lisp_Object arg
)
1480 cancel_hourglass ();
1485 /* FIXME: This is wrong rather than test window-system, we should call
1486 a new set-selection, which will then dispatch to x-set-selection, or
1487 tty-set-selection, or w32-set-selection, ... */
1488 EXFUN (Fwindow_system
, 1);
1491 command_loop_1 (void)
1494 Lisp_Object keybuf
[30];
1496 int prev_modiff
= 0;
1497 struct buffer
*prev_buffer
= NULL
;
1498 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1499 int was_locked
= single_kboard
;
1501 int already_adjusted
= 0;
1503 current_kboard
->Vprefix_arg
= Qnil
;
1504 current_kboard
->Vlast_prefix_arg
= Qnil
;
1505 Vdeactivate_mark
= Qnil
;
1506 waiting_for_input
= 0;
1509 this_command_key_count
= 0;
1510 this_command_key_count_reset
= 0;
1511 this_single_command_key_start
= 0;
1513 if (NILP (Vmemory_full
))
1515 /* Make sure this hook runs after commands that get errors and
1516 throw to top level. */
1517 /* Note that the value cell will never directly contain nil
1518 if the symbol is a local variable. */
1519 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1520 safe_run_hooks (Qpost_command_hook
);
1522 /* If displaying a message, resize the echo area window to fit
1523 that message's size exactly. */
1524 if (!NILP (echo_area_buffer
[0]))
1525 resize_echo_area_exactly ();
1527 if (!NILP (Vdeferred_action_list
))
1528 safe_run_hooks (Qdeferred_action_function
);
1531 /* Do this after running Vpost_command_hook, for consistency. */
1532 current_kboard
->Vlast_command
= Vthis_command
;
1533 current_kboard
->Vreal_last_command
= real_this_command
;
1534 if (!CONSP (last_command_event
))
1535 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1539 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1542 /* Make sure the current window's buffer is selected. */
1543 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1544 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1546 /* Display any malloc warning that just came out. Use while because
1547 displaying one warning can cause another. */
1549 while (pending_malloc_warning
)
1550 display_malloc_warning ();
1552 Vdeactivate_mark
= Qnil
;
1554 /* If minibuffer on and echo area in use,
1555 wait a short time and redraw minibuffer. */
1558 && !NILP (echo_area_buffer
[0])
1559 && EQ (minibuf_window
, echo_area_window
)
1560 && NUMBERP (Vminibuffer_message_timeout
))
1562 /* Bind inhibit-quit to t so that C-g gets read in
1563 rather than quitting back to the minibuffer. */
1564 int count
= SPECPDL_INDEX ();
1565 specbind (Qinhibit_quit
, Qt
);
1567 sit_for (Vminibuffer_message_timeout
, 0, 2);
1569 /* Clear the echo area. */
1571 safe_run_hooks (Qecho_area_clear_hook
);
1573 unbind_to (count
, Qnil
);
1575 /* If a C-g came in before, treat it as input now. */
1576 if (!NILP (Vquit_flag
))
1579 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1584 /* Select the frame that the last event came from. Usually,
1585 switch-frame events will take care of this, but if some lisp
1586 code swallows a switch-frame event, we'll fix things up here.
1587 Is this a good idea? */
1588 if (FRAMEP (internal_last_event_frame
)
1589 && !EQ (internal_last_event_frame
, selected_frame
))
1590 Fselect_frame (internal_last_event_frame
, Qnil
);
1592 /* If it has changed current-menubar from previous value,
1593 really recompute the menubar from the value. */
1594 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1595 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1596 call0 (Qrecompute_lucid_menubar
);
1598 before_command_key_count
= this_command_key_count
;
1599 before_command_echo_length
= echo_length ();
1601 Vthis_command
= Qnil
;
1602 real_this_command
= Qnil
;
1603 Vthis_original_command
= Qnil
;
1604 Vthis_command_keys_shift_translated
= Qnil
;
1606 /* Read next key sequence; i gets its length. */
1607 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1610 /* A filter may have run while we were reading the input. */
1611 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1613 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1614 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1618 /* Now we have read a key sequence of length I,
1619 or else I is 0 and we found end of file. */
1621 if (i
== 0) /* End of file -- happens only in */
1622 return Qnil
; /* a kbd macro, at the end. */
1623 /* -1 means read_key_sequence got a menu that was rejected.
1624 Just loop around and read another command. */
1628 this_command_key_count
= 0;
1629 this_command_key_count_reset
= 0;
1630 this_single_command_key_start
= 0;
1634 last_command_event
= keybuf
[i
- 1];
1636 /* If the previous command tried to force a specific window-start,
1637 forget about that, in case this command moves point far away
1638 from that position. But also throw away beg_unchanged and
1639 end_unchanged information in that case, so that redisplay will
1640 update the whole window properly. */
1641 if (!NILP (XWINDOW (selected_window
)->force_start
))
1644 XWINDOW (selected_window
)->force_start
= Qnil
;
1645 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1646 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1649 cmd
= read_key_sequence_cmd
;
1650 if (!NILP (Vexecuting_kbd_macro
))
1652 if (!NILP (Vquit_flag
))
1654 Vexecuting_kbd_macro
= Qt
;
1655 QUIT
; /* Make some noise. */
1656 /* Will return since macro now empty. */
1660 /* Do redisplay processing after this command except in special
1661 cases identified below. */
1662 prev_buffer
= current_buffer
;
1663 prev_modiff
= MODIFF
;
1664 last_point_position
= PT
;
1665 last_point_position_window
= selected_window
;
1666 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1668 /* By default, we adjust point to a boundary of a region that
1669 has such a property that should be treated intangible
1670 (e.g. composition, display). But, some commands will set
1671 this variable differently. */
1672 Vdisable_point_adjustment
= Qnil
;
1674 /* Process filters and timers may have messed with deactivate-mark.
1675 reset it before we execute the command. */
1676 Vdeactivate_mark
= Qnil
;
1678 /* Remap command through active keymaps */
1679 Vthis_original_command
= cmd
;
1683 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1687 /* Execute the command. */
1689 Vthis_command
= cmd
;
1690 real_this_command
= cmd
;
1691 /* Note that the value cell will never directly contain nil
1692 if the symbol is a local variable. */
1693 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1694 safe_run_hooks (Qpre_command_hook
);
1696 already_adjusted
= 0;
1698 if (NILP (Vthis_command
))
1700 /* nil means key is undefined. */
1701 Lisp_Object keys
= Fvector (i
, keybuf
);
1702 keys
= Fkey_description (keys
, Qnil
);
1704 message_with_string ("%s is undefined", keys
, 0);
1705 current_kboard
->defining_kbd_macro
= Qnil
;
1706 update_mode_lines
= 1;
1707 current_kboard
->Vprefix_arg
= Qnil
;
1711 /* Here for a command that isn't executed directly */
1713 #ifdef HAVE_WINDOW_SYSTEM
1714 int scount
= SPECPDL_INDEX ();
1716 if (display_hourglass_p
1717 && NILP (Vexecuting_kbd_macro
))
1719 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1724 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1726 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1728 #ifdef HAVE_WINDOW_SYSTEM
1729 /* Do not check display_hourglass_p here, because
1730 Fcommand_execute could change it, but we should cancel
1731 hourglass cursor anyway.
1732 But don't cancel the hourglass within a macro
1733 just because a command in the macro finishes. */
1734 if (NILP (Vexecuting_kbd_macro
))
1735 unbind_to (scount
, Qnil
);
1738 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1740 /* Note that the value cell will never directly contain nil
1741 if the symbol is a local variable. */
1742 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1743 safe_run_hooks (Qpost_command_hook
);
1745 /* If displaying a message, resize the echo area window to fit
1746 that message's size exactly. */
1747 if (!NILP (echo_area_buffer
[0]))
1748 resize_echo_area_exactly ();
1750 if (!NILP (Vdeferred_action_list
))
1751 safe_run_hooks (Qdeferred_action_function
);
1753 /* If there is a prefix argument,
1754 1) We don't want Vlast_command to be ``universal-argument''
1755 (that would be dumb), so don't set Vlast_command,
1756 2) we want to leave echoing on so that the prefix will be
1757 echoed as part of this key sequence, so don't call
1759 3) we want to leave this_command_key_count non-zero, so that
1760 read_char will realize that it is re-reading a character, and
1761 not echo it a second time.
1763 If the command didn't actually create a prefix arg,
1764 but is merely a frame event that is transparent to prefix args,
1765 then the above doesn't apply. */
1766 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1768 current_kboard
->Vlast_command
= Vthis_command
;
1769 current_kboard
->Vreal_last_command
= real_this_command
;
1770 if (!CONSP (last_command_event
))
1771 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1773 this_command_key_count
= 0;
1774 this_command_key_count_reset
= 0;
1775 this_single_command_key_start
= 0;
1778 if (!NILP (current_buffer
->mark_active
)
1779 && !NILP (Vrun_hooks
))
1781 /* In Emacs 22, setting transient-mark-mode to `only' was a
1782 way of turning it on for just one command. This usage is
1783 obsolete, but support it anyway. */
1784 if (EQ (Vtransient_mark_mode
, Qidentity
))
1785 Vtransient_mark_mode
= Qnil
;
1786 else if (EQ (Vtransient_mark_mode
, Qonly
))
1787 Vtransient_mark_mode
= Qidentity
;
1789 if (!NILP (Vdeactivate_mark
))
1790 /* If `select-active-regions' is non-nil, this call to
1791 `deactivate-mark' also sets the PRIMARY selection. */
1792 call0 (Qdeactivate_mark
);
1795 /* Even if not deactivating the mark, set PRIMARY if
1796 `select-active-regions' is non-nil. */
1797 if (!NILP (Fwindow_system (Qnil
))
1798 /* Even if mark_active is non-nil, the actual buffer
1799 marker may not have been set yet (Bug#7044). */
1800 && XMARKER (current_buffer
->mark
)->buffer
1801 && (EQ (Vselect_active_regions
, Qonly
)
1802 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1803 : (!NILP (Vselect_active_regions
)
1804 && !NILP (Vtransient_mark_mode
)))
1805 && !EQ (Vthis_command
, Qhandle_switch_frame
))
1808 XINT (Fmarker_position (current_buffer
->mark
));
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 (EMACS_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;
1875 EMACS_INT orig_pt
= PT
;
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
))
2779 EMACS_INT buffer_size
;
2781 /* Slow down auto saves logarithmically in size of current buffer,
2782 and garbage collect while we're at it. */
2783 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2784 last_non_minibuf_size
= Z
- BEG
;
2785 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2787 while (buffer_size
> 64)
2788 delay_level
++, buffer_size
-= buffer_size
>> 2;
2789 if (delay_level
< 4) delay_level
= 4;
2790 /* delay_level is 4 for files under around 50k, 7 at 100k,
2791 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2793 /* Auto save if enough time goes by without input. */
2794 if (commandflag
!= 0
2795 && num_nonmacro_input_events
> last_auto_save
2796 && INTEGERP (Vauto_save_timeout
)
2797 && XINT (Vauto_save_timeout
) > 0)
2800 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2802 save_getcjmp (save_jump
);
2803 restore_getcjmp (local_getcjmp
);
2804 tem0
= sit_for (make_number (timeout
), 1, 1);
2805 restore_getcjmp (save_jump
);
2808 && ! CONSP (Vunread_command_events
))
2810 Fdo_auto_save (Qnil
, Qnil
);
2812 /* If we have auto-saved and there is still no input
2813 available, garbage collect if there has been enough
2814 consing going on to make it worthwhile. */
2815 if (!detect_input_pending_run_timers (0)
2816 && consing_since_gc
> gc_cons_threshold
/ 2)
2817 Fgarbage_collect ();
2824 /* Notify the caller if an autosave hook, or a timer, sentinel or
2825 filter in the sit_for calls above have changed the current
2826 kboard. This could happen if they use the minibuffer or start a
2827 recursive edit, like the fancy splash screen in server.el's
2828 filter. If this longjmp wasn't here, read_key_sequence would
2829 interpret the next key sequence using the wrong translation
2830 tables and function keymaps. */
2831 if (NILP (c
) && current_kboard
!= orig_kboard
)
2834 return make_number (-2); /* wrong_kboard_jmpbuf */
2837 /* If this has become non-nil here, it has been set by a timer
2838 or sentinel or filter. */
2839 if (CONSP (Vunread_command_events
))
2841 c
= XCAR (Vunread_command_events
);
2842 Vunread_command_events
= XCDR (Vunread_command_events
);
2845 /* Read something from current KBOARD's side queue, if possible. */
2849 if (current_kboard
->kbd_queue_has_data
)
2851 if (!CONSP (current_kboard
->kbd_queue
))
2853 c
= XCAR (current_kboard
->kbd_queue
);
2854 current_kboard
->kbd_queue
2855 = XCDR (current_kboard
->kbd_queue
);
2856 if (NILP (current_kboard
->kbd_queue
))
2857 current_kboard
->kbd_queue_has_data
= 0;
2858 input_pending
= readable_events (0);
2859 if (EVENT_HAS_PARAMETERS (c
)
2860 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2861 internal_last_event_frame
= XCAR (XCDR (c
));
2862 Vlast_event_frame
= internal_last_event_frame
;
2866 /* If current_kboard's side queue is empty check the other kboards.
2867 If one of them has data that we have not yet seen here,
2868 switch to it and process the data waiting for it.
2870 Note: if the events queued up for another kboard
2871 have already been seen here, and therefore are not a complete command,
2872 the kbd_queue_has_data field is 0, so we skip that kboard here.
2873 That's to avoid an infinite loop switching between kboards here. */
2874 if (NILP (c
) && !single_kboard
)
2877 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2878 if (kb
->kbd_queue_has_data
)
2880 current_kboard
= kb
;
2881 /* This is going to exit from read_char
2882 so we had better get rid of this frame's stuff. */
2884 return make_number (-2); /* wrong_kboard_jmpbuf */
2892 /* Finally, we read from the main queue,
2893 and if that gives us something we can't use yet, we put it on the
2894 appropriate side queue and try again. */
2903 EMACS_GET_TIME (now
);
2904 if (EMACS_TIME_GE (now
, *end_time
))
2908 /* Actually read a character, waiting if necessary. */
2909 save_getcjmp (save_jump
);
2910 restore_getcjmp (local_getcjmp
);
2912 timer_start_idle ();
2913 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2914 restore_getcjmp (save_jump
);
2916 if (! NILP (c
) && (kb
!= current_kboard
))
2918 Lisp_Object link
= kb
->kbd_queue
;
2921 while (CONSP (XCDR (link
)))
2923 if (!NILP (XCDR (link
)))
2927 kb
->kbd_queue
= Fcons (c
, Qnil
);
2929 XSETCDR (link
, Fcons (c
, Qnil
));
2930 kb
->kbd_queue_has_data
= 1;
2934 current_kboard
= kb
;
2935 /* This is going to exit from read_char
2936 so we had better get rid of this frame's stuff. */
2938 return make_number (-2);
2942 /* Terminate Emacs in batch mode if at eof. */
2943 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2944 Fkill_emacs (make_number (1));
2948 /* Add in any extra modifiers, where appropriate. */
2949 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2950 || ((extra_keyboard_modifiers
& 0177) < ' '
2951 && (extra_keyboard_modifiers
& 0177) != 0))
2952 XSETINT (c
, make_ctrl_char (XINT (c
)));
2954 /* Transfer any other modifier bits directly from
2955 extra_keyboard_modifiers to c. Ignore the actual character code
2956 in the low 16 bits of extra_keyboard_modifiers. */
2957 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2968 if (commandflag
>= 0
2969 && !input_pending
&& !detect_input_pending_run_timers (0))
2977 /* Buffer switch events are only for internal wakeups
2978 so don't show them to the user.
2979 Also, don't record a key if we already did. */
2980 if (BUFFERP (c
) || key_already_recorded
)
2983 /* Process special events within read_char
2984 and loop around to read another event. */
2987 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2992 struct buffer
*prev_buffer
= current_buffer
;
2993 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2994 int was_locked
= single_kboard
;
2995 int count
= SPECPDL_INDEX ();
2996 record_single_kboard_state ();
2999 last_input_event
= c
;
3000 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
3002 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3003 /* We stopped being idle for this event; undo that. This
3004 prevents automatic window selection (under
3005 mouse_autoselect_window from acting as a real input event, for
3006 example banishing the mouse under mouse-avoidance-mode. */
3007 timer_resume_idle ();
3009 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3010 /* Resume allowing input from any kboard, if that was true before. */
3012 any_kboard_state ();
3013 unbind_to (count
, Qnil
);
3016 if (current_buffer
!= prev_buffer
)
3018 /* The command may have changed the keymaps. Pretend there
3019 is input in another keyboard and return. This will
3020 recalculate keymaps. */
3021 c
= make_number (-2);
3028 /* Handle things that only apply to characters. */
3031 /* If kbd_buffer_get_event gave us an EOF, return that. */
3035 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3036 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3037 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3038 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3039 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3043 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3044 /* nil in keyboard-translate-table means no translation. */
3050 /* If this event is a mouse click in the menu bar,
3051 return just menu-bar for now. Modify the mouse click event
3052 so we won't do this twice, then queue it up. */
3053 if (EVENT_HAS_PARAMETERS (c
)
3055 && CONSP (EVENT_START (c
))
3056 && CONSP (XCDR (EVENT_START (c
))))
3060 posn
= POSN_POSN (EVENT_START (c
));
3061 /* Handle menu-bar events:
3062 insert the dummy prefix event `menu-bar'. */
3063 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3065 /* Change menu-bar to (menu-bar) as the event "position". */
3066 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3069 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3074 /* Store these characters into recent_keys, the dribble file if any,
3075 and the keyboard macro being defined, if any. */
3077 if (! NILP (also_record
))
3078 record_char (also_record
);
3080 /* Wipe the echo area.
3081 But first, if we are about to use an input method,
3082 save the echo area contents for it to refer to. */
3084 && ! NILP (Vinput_method_function
)
3085 && (unsigned) XINT (c
) >= ' '
3086 && (unsigned) XINT (c
) != 127
3087 && (unsigned) XINT (c
) < 256)
3089 previous_echo_area_message
= Fcurrent_message ();
3090 Vinput_method_previous_message
= previous_echo_area_message
;
3093 /* Now wipe the echo area, except for help events which do their
3094 own stuff with the echo area. */
3096 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3097 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3099 if (!NILP (echo_area_buffer
[0]))
3100 safe_run_hooks (Qecho_area_clear_hook
);
3101 clear_message (1, 0);
3104 reread_for_input_method
:
3106 /* Pass this to the input method, if appropriate. */
3108 && ! NILP (Vinput_method_function
)
3109 /* Don't run the input method within a key sequence,
3110 after the first event of the key sequence. */
3111 && NILP (prev_event
)
3112 && (unsigned) XINT (c
) >= ' '
3113 && (unsigned) XINT (c
) != 127
3114 && (unsigned) XINT (c
) < 256)
3117 int key_count
, key_count_reset
;
3118 struct gcpro gcpro1
;
3119 int count
= SPECPDL_INDEX ();
3121 /* Save the echo status. */
3122 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3123 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3124 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3125 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3128 if (before_command_restore_flag
)
3130 this_command_key_count
= before_command_key_count_1
;
3131 if (this_command_key_count
< this_single_command_key_start
)
3132 this_single_command_key_start
= this_command_key_count
;
3133 echo_truncate (before_command_echo_length_1
);
3134 before_command_restore_flag
= 0;
3138 /* Save the this_command_keys status. */
3139 key_count
= this_command_key_count
;
3140 key_count_reset
= this_command_key_count_reset
;
3143 keys
= Fcopy_sequence (this_command_keys
);
3148 /* Clear out this_command_keys. */
3149 this_command_key_count
= 0;
3150 this_command_key_count_reset
= 0;
3152 /* Now wipe the echo area. */
3153 if (!NILP (echo_area_buffer
[0]))
3154 safe_run_hooks (Qecho_area_clear_hook
);
3155 clear_message (1, 0);
3158 /* If we are not reading a key sequence,
3159 never use the echo area. */
3162 specbind (Qinput_method_use_echo_area
, Qt
);
3165 /* Call the input method. */
3166 tem
= call1 (Vinput_method_function
, c
);
3168 tem
= unbind_to (count
, tem
);
3170 /* Restore the saved echoing state
3171 and this_command_keys state. */
3172 this_command_key_count
= key_count
;
3173 this_command_key_count_reset
= key_count_reset
;
3175 this_command_keys
= keys
;
3178 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3179 current_kboard
->echo_string
= saved_echo_string
;
3180 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3181 if (saved_immediate_echo
)
3186 /* The input method can return no events. */
3189 /* Bring back the previous message, if any. */
3190 if (! NILP (previous_echo_area_message
))
3191 message_with_string ("%s", previous_echo_area_message
, 0);
3194 /* It returned one event or more. */
3196 Vunread_post_input_method_events
3197 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3202 /* Display help if not echoing. */
3203 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3205 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3206 Lisp_Object help
, object
, position
, window
, tem
;
3208 tem
= Fcdr (XCDR (c
));
3211 window
= Fcar (tem
);
3213 object
= Fcar (tem
);
3215 position
= Fcar (tem
);
3217 show_help_echo (help
, window
, object
, position
, 0);
3219 /* We stopped being idle for this event; undo that. */
3221 timer_resume_idle ();
3225 if ((! reread
|| this_command_key_count
== 0
3226 || this_command_key_count_reset
)
3230 /* Don't echo mouse motion events. */
3231 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3232 && NILP (Fzerop (Vecho_keystrokes
))
3233 && ! (EVENT_HAS_PARAMETERS (c
)
3234 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3237 if (! NILP (also_record
))
3238 echo_char (also_record
);
3239 /* Once we reread a character, echoing can happen
3240 the next time we pause to read a new one. */
3241 ok_to_echo_at_next_pause
= current_kboard
;
3244 /* Record this character as part of the current key. */
3245 add_command_key (c
);
3246 if (! NILP (also_record
))
3247 add_command_key (also_record
);
3250 last_input_event
= c
;
3253 /* Process the help character specially if enabled */
3254 if (!NILP (Vhelp_form
) && help_char_p (c
))
3257 count
= SPECPDL_INDEX ();
3259 help_form_saved_window_configs
3260 = Fcons (Fcurrent_window_configuration (Qnil
),
3261 help_form_saved_window_configs
);
3262 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3264 tem0
= Feval (Vhelp_form
);
3266 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3271 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3272 if (EVENT_HAS_PARAMETERS (c
)
3273 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3274 XSETCAR (help_form_saved_window_configs
, Qnil
);
3276 while (BUFFERP (c
));
3277 /* Remove the help from the frame */
3278 unbind_to (count
, Qnil
);
3281 if (EQ (c
, make_number (040)))
3285 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3286 while (BUFFERP (c
));
3295 /* Record a key that came from a mouse menu.
3296 Record it for echoing, for this-command-keys, and so on. */
3299 record_menu_key (Lisp_Object c
)
3301 /* Wipe the echo area. */
3302 clear_message (1, 0);
3307 before_command_key_count
= this_command_key_count
;
3308 before_command_echo_length
= echo_length ();
3311 /* Don't echo mouse motion events. */
3312 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3313 && NILP (Fzerop (Vecho_keystrokes
)))
3317 /* Once we reread a character, echoing can happen
3318 the next time we pause to read a new one. */
3319 ok_to_echo_at_next_pause
= 0;
3322 /* Record this character as part of the current key. */
3323 add_command_key (c
);
3325 /* Re-reading in the middle of a command */
3326 last_input_event
= c
;
3330 /* Return 1 if should recognize C as "the help character". */
3333 help_char_p (Lisp_Object c
)
3337 if (EQ (c
, Vhelp_char
))
3339 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3340 if (EQ (c
, XCAR (tail
)))
3345 /* Record the input event C in various ways. */
3348 record_char (Lisp_Object c
)
3352 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3354 /* To avoid filling recent_keys with help-echo and mouse-movement
3355 events, we filter out repeated help-echo events, only store the
3356 first and last in a series of mouse-movement events, and don't
3357 store repeated help-echo events which are only separated by
3358 mouse-movement events. */
3360 Lisp_Object ev1
, ev2
, ev3
;
3363 if ((ix1
= recent_keys_index
- 1) < 0)
3364 ix1
= NUM_RECENT_KEYS
- 1;
3365 ev1
= AREF (recent_keys
, ix1
);
3367 if ((ix2
= ix1
- 1) < 0)
3368 ix2
= NUM_RECENT_KEYS
- 1;
3369 ev2
= AREF (recent_keys
, ix2
);
3371 if ((ix3
= ix2
- 1) < 0)
3372 ix3
= NUM_RECENT_KEYS
- 1;
3373 ev3
= AREF (recent_keys
, ix3
);
3375 if (EQ (XCAR (c
), Qhelp_echo
))
3377 /* Don't record `help-echo' in recent_keys unless it shows some help
3378 message, and a different help than the previously recorded
3380 Lisp_Object help
, last_help
;
3382 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3383 if (!STRINGP (help
))
3385 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3386 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3388 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3389 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3390 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3392 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3393 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3394 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3395 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3398 else if (EQ (XCAR (c
), Qmouse_movement
))
3400 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3401 So additional mouse movement events replace the last element. */
3402 Lisp_Object last_window
, window
;
3404 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3405 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3406 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3407 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3408 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3410 ASET (recent_keys
, ix1
, c
);
3416 store_kbd_macro_char (c
);
3421 ASET (recent_keys
, recent_keys_index
, c
);
3422 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3423 recent_keys_index
= 0;
3425 else if (recorded
< 0)
3427 /* We need to remove one or two events from recent_keys.
3428 To do this, we simply put nil at those events and move the
3429 recent_keys_index backwards over those events. Usually,
3430 users will never see those nil events, as they will be
3431 overwritten by the command keys entered to see recent_keys
3434 while (recorded
++ < 0 && total_keys
> 0)
3436 if (total_keys
< NUM_RECENT_KEYS
)
3438 if (--recent_keys_index
< 0)
3439 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3440 ASET (recent_keys
, recent_keys_index
, Qnil
);
3444 num_nonmacro_input_events
++;
3446 /* Write c to the dribble file. If c is a lispy event, write
3447 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3448 If you, dear reader, have a better idea, you've got the source. :-) */
3454 if (XUINT (c
) < 0x100)
3455 putc (XINT (c
), dribble
);
3457 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3461 Lisp_Object dribblee
;
3463 /* If it's a structured event, take the event header. */
3464 dribblee
= EVENT_HEAD (c
);
3466 if (SYMBOLP (dribblee
))
3468 putc ('<', dribble
);
3469 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3470 SBYTES (SYMBOL_NAME (dribblee
)),
3472 putc ('>', dribble
);
3482 print_help (Lisp_Object object
)
3484 struct buffer
*old
= current_buffer
;
3485 Fprinc (object
, Qnil
);
3486 set_buffer_internal (XBUFFER (Vstandard_output
));
3487 call0 (intern ("help-mode"));
3488 set_buffer_internal (old
);
3492 /* Copy out or in the info on where C-g should throw to.
3493 This is used when running Lisp code from within get_char,
3494 in case get_char is called recursively.
3495 See read_process_output. */
3498 save_getcjmp (jmp_buf temp
)
3500 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3504 restore_getcjmp (jmp_buf temp
)
3506 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3509 /* Low level keyboard/mouse input.
3510 kbd_buffer_store_event places events in kbd_buffer, and
3511 kbd_buffer_get_event retrieves them. */
3513 /* Return true if there are any events in the queue that read-char
3514 would return. If this returns false, a read-char would block. */
3516 readable_events (int flags
)
3518 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3521 /* If the buffer contains only FOCUS_IN_EVENT events, and
3522 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3523 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3525 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3526 #ifdef USE_TOOLKIT_SCROLL_BARS
3527 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3531 struct input_event
*event
;
3533 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3540 #ifdef USE_TOOLKIT_SCROLL_BARS
3541 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3543 event
->kind
== FOCUS_IN_EVENT
)
3544 #ifdef USE_TOOLKIT_SCROLL_BARS
3545 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3546 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3547 && event
->part
== scroll_bar_handle
3548 && event
->modifiers
== 0)
3553 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3556 while (event
!= kbd_store_ptr
);
3562 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3563 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3564 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3569 if (current_kboard
->kbd_queue_has_data
)
3575 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3576 if (kb
->kbd_queue_has_data
)
3582 /* Set this for debugging, to have a way to get out */
3586 event_to_kboard (struct input_event
*event
)
3589 frame
= event
->frame_or_window
;
3591 frame
= XCAR (frame
);
3592 else if (WINDOWP (frame
))
3593 frame
= WINDOW_FRAME (XWINDOW (frame
));
3595 /* There are still some events that don't set this field.
3596 For now, just ignore the problem.
3597 Also ignore dead frames here. */
3598 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3601 return FRAME_KBOARD (XFRAME (frame
));
3604 /* Return the number of slots occupied in kbd_buffer. */
3607 kbd_buffer_nr_stored (void)
3609 return kbd_fetch_ptr
== kbd_store_ptr
3611 : (kbd_fetch_ptr
< kbd_store_ptr
3612 ? kbd_store_ptr
- kbd_fetch_ptr
3613 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3614 + (kbd_store_ptr
- kbd_buffer
)));
3617 Lisp_Object Vthrow_on_input
;
3619 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3622 kbd_buffer_store_event (register struct input_event
*event
)
3624 kbd_buffer_store_event_hold (event
, 0);
3627 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3629 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3630 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3631 Else, if EVENT is a quit event, store the quit event
3632 in HOLD_QUIT, and return (thus ignoring further events).
3634 This is used in read_avail_input to postpone the processing
3635 of the quit event until all subsequent input events have been
3636 parsed (and discarded).
3640 kbd_buffer_store_event_hold (register struct input_event
*event
,
3641 struct input_event
*hold_quit
)
3643 if (event
->kind
== NO_EVENT
)
3646 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3649 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3651 register int c
= event
->code
& 0377;
3653 if (event
->modifiers
& ctrl_modifier
)
3654 c
= make_ctrl_char (c
);
3656 c
|= (event
->modifiers
3657 & (meta_modifier
| alt_modifier
3658 | hyper_modifier
| super_modifier
));
3662 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3663 struct input_event
*sp
;
3665 if (single_kboard
&& kb
!= current_kboard
)
3668 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3669 Fcons (make_number (c
), Qnil
));
3670 kb
->kbd_queue_has_data
= 1;
3671 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3673 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3676 if (event_to_kboard (sp
) == kb
)
3678 sp
->kind
= NO_EVENT
;
3679 sp
->frame_or_window
= Qnil
;
3688 memcpy (hold_quit
, event
, sizeof (*event
));
3692 /* If this results in a quit_char being returned to Emacs as
3693 input, set Vlast_event_frame properly. If this doesn't
3694 get returned to Emacs as an event, the next event read
3695 will set Vlast_event_frame again, so this is safe to do. */
3699 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3701 focus
= event
->frame_or_window
;
3702 internal_last_event_frame
= focus
;
3703 Vlast_event_frame
= focus
;
3706 last_event_timestamp
= event
->timestamp
;
3707 handle_interrupt ();
3711 if (c
&& c
== stop_character
)
3717 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3718 Just ignore the second one. */
3719 else if (event
->kind
== BUFFER_SWITCH_EVENT
3720 && kbd_fetch_ptr
!= kbd_store_ptr
3721 && ((kbd_store_ptr
== kbd_buffer
3722 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3723 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3726 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3727 kbd_store_ptr
= kbd_buffer
;
3729 /* Don't let the very last slot in the buffer become full,
3730 since that would make the two pointers equal,
3731 and that is indistinguishable from an empty buffer.
3732 Discard the event if it would fill the last slot. */
3733 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3735 *kbd_store_ptr
= *event
;
3737 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3739 /* Don't read keyboard input until we have processed kbd_buffer.
3740 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3741 hold_keyboard_input ();
3743 if (!noninteractive
)
3744 signal (SIGIO
, SIG_IGN
);
3750 /* If we're inside while-no-input, and this event qualifies
3751 as input, set quit-flag to cause an interrupt. */
3752 if (!NILP (Vthrow_on_input
)
3753 && event
->kind
!= FOCUS_IN_EVENT
3754 && event
->kind
!= HELP_EVENT
3755 && event
->kind
!= DEICONIFY_EVENT
)
3757 Vquit_flag
= Vthrow_on_input
;
3758 /* If we're inside a function that wants immediate quits,
3760 if (immediate_quit
&& NILP (Vinhibit_quit
))
3770 /* Put an input event back in the head of the event queue. */
3773 kbd_buffer_unget_event (register struct input_event
*event
)
3775 if (kbd_fetch_ptr
== kbd_buffer
)
3776 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3778 /* Don't let the very last slot in the buffer become full, */
3779 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3782 *kbd_fetch_ptr
= *event
;
3787 /* Generate a HELP_EVENT input_event and store it in the keyboard
3790 HELP is the help form.
3792 FRAME and WINDOW are the frame and window where the help is
3793 generated. OBJECT is the Lisp object where the help was found (a
3794 buffer, a string, an overlay, or nil if neither from a string nor
3795 from a buffer). POS is the position within OBJECT where the help
3799 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3800 Lisp_Object object
, EMACS_INT pos
)
3802 struct input_event event
;
3806 event
.kind
= HELP_EVENT
;
3807 event
.frame_or_window
= frame
;
3809 event
.x
= WINDOWP (window
) ? window
: frame
;
3812 kbd_buffer_store_event (&event
);
3816 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3819 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3821 struct input_event event
;
3823 event
.kind
= HELP_EVENT
;
3824 event
.frame_or_window
= frame
;
3829 kbd_buffer_store_event (&event
);
3833 /* Discard any mouse events in the event buffer by setting them to
3836 discard_mouse_events (void)
3838 struct input_event
*sp
;
3839 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3841 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3844 if (sp
->kind
== MOUSE_CLICK_EVENT
3845 || sp
->kind
== WHEEL_EVENT
3846 || sp
->kind
== HORIZ_WHEEL_EVENT
3848 || sp
->kind
== GPM_CLICK_EVENT
3850 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3852 sp
->kind
= NO_EVENT
;
3858 /* Return non-zero if there are any real events waiting in the event
3859 buffer, not counting `NO_EVENT's.
3861 If DISCARD is non-zero, discard NO_EVENT events at the front of
3862 the input queue, possibly leaving the input queue empty if there
3863 are no real input events. */
3866 kbd_buffer_events_waiting (int discard
)
3868 struct input_event
*sp
;
3870 for (sp
= kbd_fetch_ptr
;
3871 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3874 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3881 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3885 /* Clear input event EVENT. */
3888 clear_event (struct input_event
*event
)
3890 event
->kind
= NO_EVENT
;
3894 /* Read one event from the event buffer, waiting if necessary.
3895 The value is a Lisp object representing the event.
3896 The value is nil for an event that should be ignored,
3897 or that was handled here.
3898 We always read and discard one event. */
3901 kbd_buffer_get_event (KBOARD
**kbp
,
3902 int *used_mouse_menu
,
3903 struct timeval
*end_time
)
3908 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3910 /* Start reading input again, we have processed enough so we can
3911 accept new events again. */
3912 unhold_keyboard_input ();
3914 if (!noninteractive
)
3915 signal (SIGIO
, input_available_signal
);
3921 /* In case we are running as a daemon, only do this before
3922 detaching from the terminal. */
3923 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3927 *kbp
= current_kboard
;
3931 /* Wait until there is input available. */
3934 /* Break loop if there's an unread command event. Needed in
3935 moused window autoselection which uses a timer to insert such
3937 if (CONSP (Vunread_command_events
))
3940 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3942 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3943 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3947 /* If the quit flag is set, then read_char will return
3948 quit_char, so that counts as "available input." */
3949 if (!NILP (Vquit_flag
))
3950 quit_throw_to_read_char ();
3952 /* One way or another, wait until input is available; then, if
3953 interrupt handlers have not read it, read it now. */
3956 /* Read D-Bus messages. */
3957 xd_read_queued_messages ();
3958 #endif /* HAVE_DBUS */
3960 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3964 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3966 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3967 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3972 EMACS_TIME duration
;
3973 EMACS_GET_TIME (duration
);
3974 if (EMACS_TIME_GE (duration
, *end_time
))
3975 return Qnil
; /* finished waiting */
3978 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3979 wait_reading_process_output (EMACS_SECS (duration
),
3980 EMACS_USECS (duration
),
3981 -1, 1, Qnil
, NULL
, 0);
3985 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3987 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3988 /* Pass 1 for EXPECT since we just waited to have input. */
3989 read_avail_input (1);
3992 if (CONSP (Vunread_command_events
))
3995 first
= XCAR (Vunread_command_events
);
3996 Vunread_command_events
= XCDR (Vunread_command_events
);
3997 *kbp
= current_kboard
;
4001 /* At this point, we know that there is a readable event available
4002 somewhere. If the event queue is empty, then there must be a
4003 mouse movement enabled and available. */
4004 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4006 struct input_event
*event
;
4008 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4012 last_event_timestamp
= event
->timestamp
;
4014 *kbp
= event_to_kboard (event
);
4016 *kbp
= current_kboard
; /* Better than returning null ptr? */
4020 /* These two kinds of events get special handling
4021 and don't actually appear to the command loop.
4022 We return nil for them. */
4023 if (event
->kind
== SELECTION_REQUEST_EVENT
4024 || event
->kind
== SELECTION_CLEAR_EVENT
)
4027 struct input_event copy
;
4029 /* Remove it from the buffer before processing it,
4030 since otherwise swallow_events will see it
4031 and process it again. */
4033 kbd_fetch_ptr
= event
+ 1;
4034 input_pending
= readable_events (0);
4035 x_handle_selection_event (©
);
4037 /* We're getting selection request events, but we don't have
4043 #if defined (HAVE_NS)
4044 else if (event
->kind
== NS_TEXT_EVENT
)
4046 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4047 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4049 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4050 kbd_fetch_ptr
= event
+ 1;
4051 if (used_mouse_menu
)
4052 *used_mouse_menu
= 1;
4056 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4057 || defined (HAVE_NS)
4058 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4060 /* Make an event (delete-frame (FRAME)). */
4061 obj
= Fcons (event
->frame_or_window
, Qnil
);
4062 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4063 kbd_fetch_ptr
= event
+ 1;
4066 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4067 || defined (HAVE_NS)
4068 else if (event
->kind
== ICONIFY_EVENT
)
4070 /* Make an event (iconify-frame (FRAME)). */
4071 obj
= Fcons (event
->frame_or_window
, Qnil
);
4072 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4073 kbd_fetch_ptr
= event
+ 1;
4075 else if (event
->kind
== DEICONIFY_EVENT
)
4077 /* Make an event (make-frame-visible (FRAME)). */
4078 obj
= Fcons (event
->frame_or_window
, Qnil
);
4079 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4080 kbd_fetch_ptr
= event
+ 1;
4083 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4085 /* The value doesn't matter here; only the type is tested. */
4086 XSETBUFFER (obj
, current_buffer
);
4087 kbd_fetch_ptr
= event
+ 1;
4089 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4090 || defined(HAVE_NS) || defined (USE_GTK)
4091 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4093 kbd_fetch_ptr
= event
+ 1;
4094 input_pending
= readable_events (0);
4095 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4096 x_activate_menubar (XFRAME (event
->frame_or_window
));
4099 #if defined (WINDOWSNT)
4100 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4102 /* Make an event (language-change (FRAME CHARSET LCID)). */
4103 obj
= Fcons (event
->frame_or_window
, Qnil
);
4104 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4105 kbd_fetch_ptr
= event
+ 1;
4108 else if (event
->kind
== SAVE_SESSION_EVENT
)
4110 obj
= Fcons (Qsave_session
, Qnil
);
4111 kbd_fetch_ptr
= event
+ 1;
4113 /* Just discard these, by returning nil.
4114 With MULTI_KBOARD, these events are used as placeholders
4115 when we need to randomly delete events from the queue.
4116 (They shouldn't otherwise be found in the buffer,
4117 but on some machines it appears they do show up
4118 even without MULTI_KBOARD.) */
4119 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4120 mouse events during a popup-menu call. */
4121 else if (event
->kind
== NO_EVENT
)
4122 kbd_fetch_ptr
= event
+ 1;
4123 else if (event
->kind
== HELP_EVENT
)
4125 Lisp_Object object
, position
, help
, frame
, window
;
4127 frame
= event
->frame_or_window
;
4128 object
= event
->arg
;
4129 position
= make_number (event
->code
);
4132 clear_event (event
);
4134 kbd_fetch_ptr
= event
+ 1;
4135 if (!WINDOWP (window
))
4137 obj
= Fcons (Qhelp_echo
,
4138 list5 (frame
, help
, window
, object
, position
));
4140 else if (event
->kind
== FOCUS_IN_EVENT
)
4142 /* Notification of a FocusIn event. The frame receiving the
4143 focus is in event->frame_or_window. Generate a
4144 switch-frame event if necessary. */
4145 Lisp_Object frame
, focus
;
4147 frame
= event
->frame_or_window
;
4148 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4152 if (!EQ (frame
, internal_last_event_frame
)
4153 && !EQ (frame
, selected_frame
))
4154 obj
= make_lispy_switch_frame (frame
);
4155 internal_last_event_frame
= frame
;
4156 kbd_fetch_ptr
= event
+ 1;
4159 else if (event
->kind
== DBUS_EVENT
)
4161 obj
= make_lispy_event (event
);
4162 kbd_fetch_ptr
= event
+ 1;
4165 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4167 obj
= make_lispy_event (event
);
4168 kbd_fetch_ptr
= event
+ 1;
4172 /* If this event is on a different frame, return a switch-frame this
4173 time, and leave the event in the queue for next time. */
4177 frame
= event
->frame_or_window
;
4179 frame
= XCAR (frame
);
4180 else if (WINDOWP (frame
))
4181 frame
= WINDOW_FRAME (XWINDOW (frame
));
4183 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4187 if (! EQ (frame
, internal_last_event_frame
)
4188 && !EQ (frame
, selected_frame
))
4189 obj
= make_lispy_switch_frame (frame
);
4190 internal_last_event_frame
= frame
;
4192 /* If we didn't decide to make a switch-frame event, go ahead
4193 and build a real event from the queue entry. */
4197 obj
= make_lispy_event (event
);
4199 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4200 || defined(HAVE_NS) || defined (USE_GTK)
4201 /* If this was a menu selection, then set the flag to inhibit
4202 writing to last_nonmenu_event. Don't do this if the event
4203 we're returning is (menu-bar), though; that indicates the
4204 beginning of the menu sequence, and we might as well leave
4205 that as the `event with parameters' for this selection. */
4207 && !EQ (event
->frame_or_window
, event
->arg
)
4208 && (event
->kind
== MENU_BAR_EVENT
4209 || event
->kind
== TOOL_BAR_EVENT
))
4210 *used_mouse_menu
= 1;
4213 /* certain system events are non-key events */
4215 && event
->kind
== NS_NONKEY_EVENT
)
4216 *used_mouse_menu
= 1;
4219 /* Wipe out this event, to catch bugs. */
4220 clear_event (event
);
4221 kbd_fetch_ptr
= event
+ 1;
4225 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4226 /* Try generating a mouse motion event. */
4227 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4229 FRAME_PTR f
= some_mouse_moved ();
4230 Lisp_Object bar_window
;
4231 enum scroll_bar_part part
;
4235 *kbp
= current_kboard
;
4236 /* Note that this uses F to determine which terminal to look at.
4237 If there is no valid info, it does not store anything
4238 so x remains nil. */
4241 /* XXX Can f or mouse_position_hook be NULL here? */
4242 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4243 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4244 &part
, &x
, &y
, &time
);
4248 /* Decide if we should generate a switch-frame event. Don't
4249 generate switch-frame events for motion outside of all Emacs
4255 frame
= FRAME_FOCUS_FRAME (f
);
4257 XSETFRAME (frame
, f
);
4259 if (! EQ (frame
, internal_last_event_frame
)
4260 && !EQ (frame
, selected_frame
))
4261 obj
= make_lispy_switch_frame (frame
);
4262 internal_last_event_frame
= frame
;
4265 /* If we didn't decide to make a switch-frame event, go ahead and
4266 return a mouse-motion event. */
4267 if (!NILP (x
) && NILP (obj
))
4268 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4270 #endif /* HAVE_MOUSE || HAVE GPM */
4272 /* We were promised by the above while loop that there was
4273 something for us to read! */
4276 input_pending
= readable_events (0);
4278 Vlast_event_frame
= internal_last_event_frame
;
4283 /* Process any events that are not user-visible,
4284 then return, without reading any user-visible events. */
4287 swallow_events (int do_display
)
4291 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4293 struct input_event
*event
;
4295 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4299 last_event_timestamp
= event
->timestamp
;
4301 /* These two kinds of events get special handling
4302 and don't actually appear to the command loop. */
4303 if (event
->kind
== SELECTION_REQUEST_EVENT
4304 || event
->kind
== SELECTION_CLEAR_EVENT
)
4307 struct input_event copy
;
4309 /* Remove it from the buffer before processing it,
4310 since otherwise swallow_events called recursively could see it
4311 and process it again. */
4313 kbd_fetch_ptr
= event
+ 1;
4314 input_pending
= readable_events (0);
4315 x_handle_selection_event (©
);
4317 /* We're getting selection request events, but we don't have
4326 old_timers_run
= timers_run
;
4327 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4329 if (timers_run
!= old_timers_run
&& do_display
)
4330 redisplay_preserve_echo_area (7);
4333 /* Record the start of when Emacs is idle,
4334 for the sake of running idle-time timers. */
4337 timer_start_idle (void)
4341 /* If we are already in the idle state, do nothing. */
4342 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4345 EMACS_GET_TIME (timer_idleness_start_time
);
4347 timer_last_idleness_start_time
= timer_idleness_start_time
;
4349 /* Mark all idle-time timers as once again candidates for running. */
4350 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4354 timer
= XCAR (timers
);
4356 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4358 XVECTOR (timer
)->contents
[0] = Qnil
;
4362 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4365 timer_stop_idle (void)
4367 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4370 /* Resume idle timer from last idle start time. */
4373 timer_resume_idle (void)
4375 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4378 timer_idleness_start_time
= timer_last_idleness_start_time
;
4381 /* This is only for debugging. */
4382 struct input_event last_timer_event
;
4384 /* List of elisp functions to call, delayed because they were generated in
4385 a context where Elisp could not be safely run (e.g. redisplay, signal,
4386 ...). Each element has the form (FUN . ARGS). */
4387 Lisp_Object pending_funcalls
;
4389 /* Check whether a timer has fired. To prevent larger problems we simply
4390 disregard elements that are not proper timers. Do not make a circular
4391 timer list for the time being.
4393 Returns the time to wait until the next timer fires. If a
4394 timer is triggering now, return zero.
4395 If no timer is active, return -1.
4397 If a timer is ripe, we run it, with quitting turned off.
4398 In that case we return 0 to indicate that a new timer_check_2 call
4402 timer_check_2 (void)
4404 EMACS_TIME nexttime
;
4405 EMACS_TIME now
, idleness_now
;
4406 Lisp_Object timers
, idle_timers
, chosen_timer
;
4407 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4409 EMACS_SET_SECS (nexttime
, -1);
4410 EMACS_SET_USECS (nexttime
, -1);
4412 /* Always consider the ordinary timers. */
4413 timers
= Vtimer_list
;
4414 /* Consider the idle timers only if Emacs is idle. */
4415 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4416 idle_timers
= Vtimer_idle_list
;
4419 chosen_timer
= Qnil
;
4420 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4422 /* First run the code that was delayed. */
4423 while (CONSP (pending_funcalls
))
4425 Lisp_Object funcall
= XCAR (pending_funcalls
);
4426 pending_funcalls
= XCDR (pending_funcalls
);
4427 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4430 if (CONSP (timers
) || CONSP (idle_timers
))
4432 EMACS_GET_TIME (now
);
4433 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4434 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4437 while (CONSP (timers
) || CONSP (idle_timers
))
4439 Lisp_Object
*vector
;
4440 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4441 EMACS_TIME timer_time
, idle_timer_time
;
4442 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4444 /* Skip past invalid timers and timers already handled. */
4447 timer
= XCAR (timers
);
4448 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4450 timers
= XCDR (timers
);
4453 vector
= XVECTOR (timer
)->contents
;
4455 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4456 || !INTEGERP (vector
[3])
4457 || ! NILP (vector
[0]))
4459 timers
= XCDR (timers
);
4463 if (!NILP (idle_timers
))
4465 timer
= XCAR (idle_timers
);
4466 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4468 idle_timers
= XCDR (idle_timers
);
4471 vector
= XVECTOR (timer
)->contents
;
4473 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4474 || !INTEGERP (vector
[3])
4475 || ! NILP (vector
[0]))
4477 idle_timers
= XCDR (idle_timers
);
4482 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4483 based on the next ordinary timer.
4484 TIMER_DIFFERENCE is the distance in time from NOW to when
4485 this timer becomes ripe (negative if it's already ripe). */
4488 timer
= XCAR (timers
);
4489 vector
= XVECTOR (timer
)->contents
;
4490 EMACS_SET_SECS (timer_time
,
4491 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4492 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4493 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4496 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4497 based on the next idle timer. */
4498 if (!NILP (idle_timers
))
4500 idle_timer
= XCAR (idle_timers
);
4501 vector
= XVECTOR (idle_timer
)->contents
;
4502 EMACS_SET_SECS (idle_timer_time
,
4503 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4504 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4505 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4508 /* Decide which timer is the next timer,
4509 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4510 Also step down the list where we found that timer. */
4512 if (! NILP (timers
) && ! NILP (idle_timers
))
4515 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4516 if (EMACS_TIME_NEG_P (temp
))
4518 chosen_timer
= timer
;
4519 timers
= XCDR (timers
);
4520 difference
= timer_difference
;
4524 chosen_timer
= idle_timer
;
4525 idle_timers
= XCDR (idle_timers
);
4526 difference
= idle_timer_difference
;
4529 else if (! NILP (timers
))
4531 chosen_timer
= timer
;
4532 timers
= XCDR (timers
);
4533 difference
= timer_difference
;
4537 chosen_timer
= idle_timer
;
4538 idle_timers
= XCDR (idle_timers
);
4539 difference
= idle_timer_difference
;
4541 vector
= XVECTOR (chosen_timer
)->contents
;
4543 /* If timer is ripe, run it if it hasn't been run. */
4544 if (EMACS_TIME_NEG_P (difference
)
4545 || (EMACS_SECS (difference
) == 0
4546 && EMACS_USECS (difference
) == 0))
4548 if (NILP (vector
[0]))
4550 int count
= SPECPDL_INDEX ();
4551 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4553 /* Mark the timer as triggered to prevent problems if the lisp
4554 code fails to reschedule it right. */
4557 specbind (Qinhibit_quit
, Qt
);
4559 call1 (Qtimer_event_handler
, chosen_timer
);
4560 Vdeactivate_mark
= old_deactivate_mark
;
4562 unbind_to (count
, Qnil
);
4564 /* Since we have handled the event,
4565 we don't need to tell the caller to wake up and do it. */
4566 /* But the caller must still wait for the next timer, so
4567 return 0 to indicate that. */
4570 EMACS_SET_SECS (nexttime
, 0);
4571 EMACS_SET_USECS (nexttime
, 0);
4574 /* When we encounter a timer that is still waiting,
4575 return the amount of time to wait before it is ripe. */
4582 /* No timers are pending in the future. */
4583 /* Return 0 if we generated an event, and -1 if not. */
4589 /* Check whether a timer has fired. To prevent larger problems we simply
4590 disregard elements that are not proper timers. Do not make a circular
4591 timer list for the time being.
4593 Returns the time to wait until the next timer fires.
4594 If no timer is active, return -1.
4596 As long as any timer is ripe, we run it.
4598 DO_IT_NOW is now ignored. It used to mean that we should
4599 run the timer directly instead of queueing a timer-event.
4600 Now we always run timers directly. */
4603 timer_check (int do_it_now
)
4605 EMACS_TIME nexttime
;
4609 nexttime
= timer_check_2 ();
4611 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4616 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4617 doc
: /* Return the current length of Emacs idleness, or nil.
4618 The value when Emacs is idle is a list of three integers. The first has
4619 the most significant 16 bits of the seconds, while the second has the least
4620 significant 16 bits. The third integer gives the microsecond count.
4622 The value when Emacs is not idle is nil.
4624 The microsecond count is zero on systems that do not provide
4625 resolution finer than a second. */)
4628 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4630 EMACS_TIME now
, idleness_now
;
4632 EMACS_GET_TIME (now
);
4633 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4635 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4636 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4637 make_number (EMACS_USECS (idleness_now
)));
4643 /* Caches for modify_event_symbol. */
4644 static Lisp_Object accent_key_syms
;
4645 static Lisp_Object func_key_syms
;
4646 static Lisp_Object mouse_syms
;
4647 static Lisp_Object wheel_syms
;
4648 static Lisp_Object drag_n_drop_syms
;
4650 /* This is a list of keysym codes for special "accent" characters.
4651 It parallels lispy_accent_keys. */
4653 static const int lispy_accent_codes
[] =
4655 #ifdef XK_dead_circumflex
4660 #ifdef XK_dead_grave
4665 #ifdef XK_dead_tilde
4670 #ifdef XK_dead_diaeresis
4675 #ifdef XK_dead_macron
4680 #ifdef XK_dead_degree
4685 #ifdef XK_dead_acute
4690 #ifdef XK_dead_cedilla
4695 #ifdef XK_dead_breve
4700 #ifdef XK_dead_ogonek
4705 #ifdef XK_dead_caron
4710 #ifdef XK_dead_doubleacute
4711 XK_dead_doubleacute
,
4715 #ifdef XK_dead_abovedot
4720 #ifdef XK_dead_abovering
4730 #ifdef XK_dead_belowdot
4735 #ifdef XK_dead_voiced_sound
4736 XK_dead_voiced_sound
,
4740 #ifdef XK_dead_semivoiced_sound
4741 XK_dead_semivoiced_sound
,
4757 /* This is a list of Lisp names for special "accent" characters.
4758 It parallels lispy_accent_codes. */
4760 static const char *lispy_accent_keys
[] =
4778 "dead-voiced-sound",
4779 "dead-semivoiced-sound",
4785 #define FUNCTION_KEY_OFFSET 0x0
4787 char const *lispy_function_keys
[] =
4791 0, /* VK_LBUTTON 0x01 */
4792 0, /* VK_RBUTTON 0x02 */
4793 "cancel", /* VK_CANCEL 0x03 */
4794 0, /* VK_MBUTTON 0x04 */
4796 0, 0, 0, /* 0x05 .. 0x07 */
4798 "backspace", /* VK_BACK 0x08 */
4799 "tab", /* VK_TAB 0x09 */
4801 0, 0, /* 0x0A .. 0x0B */
4803 "clear", /* VK_CLEAR 0x0C */
4804 "return", /* VK_RETURN 0x0D */
4806 0, 0, /* 0x0E .. 0x0F */
4808 0, /* VK_SHIFT 0x10 */
4809 0, /* VK_CONTROL 0x11 */
4810 0, /* VK_MENU 0x12 */
4811 "pause", /* VK_PAUSE 0x13 */
4812 "capslock", /* VK_CAPITAL 0x14 */
4813 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4815 "junja", /* VK_JUNJA 0x17 */
4816 "final", /* VK_FINAL 0x18 */
4817 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4819 "escape", /* VK_ESCAPE 0x1B */
4820 "convert", /* VK_CONVERT 0x1C */
4821 "non-convert", /* VK_NONCONVERT 0x1D */
4822 "accept", /* VK_ACCEPT 0x1E */
4823 "mode-change", /* VK_MODECHANGE 0x1F */
4824 0, /* VK_SPACE 0x20 */
4825 "prior", /* VK_PRIOR 0x21 */
4826 "next", /* VK_NEXT 0x22 */
4827 "end", /* VK_END 0x23 */
4828 "home", /* VK_HOME 0x24 */
4829 "left", /* VK_LEFT 0x25 */
4830 "up", /* VK_UP 0x26 */
4831 "right", /* VK_RIGHT 0x27 */
4832 "down", /* VK_DOWN 0x28 */
4833 "select", /* VK_SELECT 0x29 */
4834 "print", /* VK_PRINT 0x2A */
4835 "execute", /* VK_EXECUTE 0x2B */
4836 "snapshot", /* VK_SNAPSHOT 0x2C */
4837 "insert", /* VK_INSERT 0x2D */
4838 "delete", /* VK_DELETE 0x2E */
4839 "help", /* VK_HELP 0x2F */
4841 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4843 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4845 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4847 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4849 0, 0, 0, 0, 0, 0, 0, 0, 0,
4850 0, 0, 0, 0, 0, 0, 0, 0, 0,
4851 0, 0, 0, 0, 0, 0, 0, 0,
4853 "lwindow", /* VK_LWIN 0x5B */
4854 "rwindow", /* VK_RWIN 0x5C */
4855 "apps", /* VK_APPS 0x5D */
4858 "kp-0", /* VK_NUMPAD0 0x60 */
4859 "kp-1", /* VK_NUMPAD1 0x61 */
4860 "kp-2", /* VK_NUMPAD2 0x62 */
4861 "kp-3", /* VK_NUMPAD3 0x63 */
4862 "kp-4", /* VK_NUMPAD4 0x64 */
4863 "kp-5", /* VK_NUMPAD5 0x65 */
4864 "kp-6", /* VK_NUMPAD6 0x66 */
4865 "kp-7", /* VK_NUMPAD7 0x67 */
4866 "kp-8", /* VK_NUMPAD8 0x68 */
4867 "kp-9", /* VK_NUMPAD9 0x69 */
4868 "kp-multiply", /* VK_MULTIPLY 0x6A */
4869 "kp-add", /* VK_ADD 0x6B */
4870 "kp-separator", /* VK_SEPARATOR 0x6C */
4871 "kp-subtract", /* VK_SUBTRACT 0x6D */
4872 "kp-decimal", /* VK_DECIMAL 0x6E */
4873 "kp-divide", /* VK_DIVIDE 0x6F */
4874 "f1", /* VK_F1 0x70 */
4875 "f2", /* VK_F2 0x71 */
4876 "f3", /* VK_F3 0x72 */
4877 "f4", /* VK_F4 0x73 */
4878 "f5", /* VK_F5 0x74 */
4879 "f6", /* VK_F6 0x75 */
4880 "f7", /* VK_F7 0x76 */
4881 "f8", /* VK_F8 0x77 */
4882 "f9", /* VK_F9 0x78 */
4883 "f10", /* VK_F10 0x79 */
4884 "f11", /* VK_F11 0x7A */
4885 "f12", /* VK_F12 0x7B */
4886 "f13", /* VK_F13 0x7C */
4887 "f14", /* VK_F14 0x7D */
4888 "f15", /* VK_F15 0x7E */
4889 "f16", /* VK_F16 0x7F */
4890 "f17", /* VK_F17 0x80 */
4891 "f18", /* VK_F18 0x81 */
4892 "f19", /* VK_F19 0x82 */
4893 "f20", /* VK_F20 0x83 */
4894 "f21", /* VK_F21 0x84 */
4895 "f22", /* VK_F22 0x85 */
4896 "f23", /* VK_F23 0x86 */
4897 "f24", /* VK_F24 0x87 */
4899 0, 0, 0, 0, /* 0x88 .. 0x8B */
4900 0, 0, 0, 0, /* 0x8C .. 0x8F */
4902 "kp-numlock", /* VK_NUMLOCK 0x90 */
4903 "scroll", /* VK_SCROLL 0x91 */
4904 /* Not sure where the following block comes from.
4905 Windows headers have NEC and Fujitsu specific keys in
4906 this block, but nothing generic. */
4907 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4908 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4909 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4910 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4911 "kp-end", /* VK_NUMPAD_END 0x96 */
4912 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4913 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4914 "kp-up", /* VK_NUMPAD_UP 0x99 */
4915 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4916 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4917 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4918 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4920 0, 0, /* 0x9E .. 0x9F */
4923 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4924 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4925 * No other API or message will distinguish left and right keys this way.
4930 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4931 to enable them selectively, and gives access to a few more functions.
4932 See lispy_multimedia_keys below. */
4933 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4934 0, 0, 0, /* 0xAD .. 0xAF Volume */
4935 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4936 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4938 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4939 0, 0, 0, 0, 0, 0, 0, 0, 0,
4941 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4942 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4943 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4946 "ax", /* VK_OEM_AX 0xE1 */
4947 0, /* VK_OEM_102 0xE2 */
4948 "ico-help", /* VK_ICO_HELP 0xE3 */
4949 "ico-00", /* VK_ICO_00 0xE4 */
4950 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4951 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4952 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4954 "reset", /* VK_OEM_RESET 0xE9 */
4955 "jump", /* VK_OEM_JUMP 0xEA */
4956 "oem-pa1", /* VK_OEM_PA1 0xEB */
4957 "oem-pa2", /* VK_OEM_PA2 0xEC */
4958 "oem-pa3", /* VK_OEM_PA3 0xED */
4959 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4960 "cusel", /* VK_OEM_CUSEL 0xEF */
4961 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4962 "finish", /* VK_OEM_FINISH 0xF1 */
4963 "copy", /* VK_OEM_COPY 0xF2 */
4964 "auto", /* VK_OEM_AUTO 0xF3 */
4965 "enlw", /* VK_OEM_ENLW 0xF4 */
4966 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4967 "attn", /* VK_ATTN 0xF6 */
4968 "crsel", /* VK_CRSEL 0xF7 */
4969 "exsel", /* VK_EXSEL 0xF8 */
4970 "ereof", /* VK_EREOF 0xF9 */
4971 "play", /* VK_PLAY 0xFA */
4972 "zoom", /* VK_ZOOM 0xFB */
4973 "noname", /* VK_NONAME 0xFC */
4974 "pa1", /* VK_PA1 0xFD */
4975 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4979 /* Some of these duplicate the "Media keys" on newer keyboards,
4980 but they are delivered to the application in a different way. */
4981 static const char *lispy_multimedia_keys
[] =
4989 "browser-favorites",
5026 "toggle-dictate-command",
5032 "media-fast-forward",
5035 "media-channel-down"
5038 #else /* not HAVE_NTGUI */
5040 /* This should be dealt with in XTread_socket now, and that doesn't
5041 depend on the client system having the Kana syms defined. See also
5042 the XK_kana_A case below. */
5045 static const char *lispy_kana_keys
[] =
5047 /* X Keysym value */
5048 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5049 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5050 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5051 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5052 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5053 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5054 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5055 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5056 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5057 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5058 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5059 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5060 "kana-i", "kana-u", "kana-e", "kana-o",
5061 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5062 "prolongedsound", "kana-A", "kana-I", "kana-U",
5063 "kana-E", "kana-O", "kana-KA", "kana-KI",
5064 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5065 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5066 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5067 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5068 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5069 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5070 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5071 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5072 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5073 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5074 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5075 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5077 #endif /* XK_kana_A */
5080 #define FUNCTION_KEY_OFFSET 0xff00
5082 /* You'll notice that this table is arranged to be conveniently
5083 indexed by X Windows keysym values. */
5084 static const char *lispy_function_keys
[] =
5086 /* X Keysym value */
5088 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5089 "backspace", "tab", "linefeed", "clear",
5091 0, 0, 0, "pause", /* 0xff10...1f */
5092 0, 0, 0, 0, 0, 0, 0, "escape",
5094 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5095 "romaji", "hiragana", "katakana", "hiragana-katakana",
5096 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5097 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5098 "eisu-toggle", /* 0xff30...3f */
5099 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5100 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5102 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5103 "down", "prior", "next", "end",
5104 "begin", 0, 0, 0, 0, 0, 0, 0,
5105 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5116 "break", /* 0xff6b */
5119 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5120 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5121 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5122 0, 0, 0, 0, 0, 0, 0, 0,
5123 "kp-tab", /* 0xff89 */
5125 "kp-enter", /* 0xff8d */
5127 "kp-f1", /* 0xff91 */
5131 "kp-home", /* 0xff95 */
5136 "kp-prior", /* kp-page-up */
5137 "kp-next", /* kp-page-down */
5143 0, 0, 0, 0, 0, 0, 0, 0, 0,
5144 "kp-multiply", /* 0xffaa */
5149 "kp-divide", /* 0xffaf */
5150 "kp-0", /* 0xffb0 */
5151 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5154 "kp-equal", /* 0xffbd */
5155 "f1", /* 0xffbe */ /* IsFunctionKey */
5157 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5158 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5159 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5160 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5161 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5162 0, 0, 0, 0, 0, 0, 0, 0,
5163 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5164 0, 0, 0, 0, 0, 0, 0, "delete"
5167 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5168 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5170 static const char *iso_lispy_function_keys
[] =
5172 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5173 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5174 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5175 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5176 "iso-lefttab", /* 0xfe20 */
5177 "iso-move-line-up", "iso-move-line-down",
5178 "iso-partial-line-up", "iso-partial-line-down",
5179 "iso-partial-space-left", "iso-partial-space-right",
5180 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5181 "iso-release-margin-left", "iso-release-margin-right",
5182 "iso-release-both-margins",
5183 "iso-fast-cursor-left", "iso-fast-cursor-right",
5184 "iso-fast-cursor-up", "iso-fast-cursor-down",
5185 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5186 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5189 #endif /* not HAVE_NTGUI */
5191 Lisp_Object Vlispy_mouse_stem
;
5193 static const char *lispy_wheel_names
[] =
5195 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5198 /* drag-n-drop events are generated when a set of selected files are
5199 dragged from another application and dropped onto an Emacs window. */
5200 static const char *lispy_drag_n_drop_names
[] =
5205 /* Scroll bar parts. */
5206 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5207 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5208 Lisp_Object Qtop
, Qratio
;
5210 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5211 const Lisp_Object
*scroll_bar_parts
[] = {
5212 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5213 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5216 /* A vector, indexed by button number, giving the down-going location
5217 of currently depressed buttons, both scroll bar and non-scroll bar.
5219 The elements have the form
5220 (BUTTON-NUMBER MODIFIER-MASK . REST)
5221 where REST is the cdr of a position as it would be reported in the event.
5223 The make_lispy_event function stores positions here to tell the
5224 difference between click and drag events, and to store the starting
5225 location to be included in drag events. */
5227 static Lisp_Object button_down_location
;
5229 /* Information about the most recent up-going button event: Which
5230 button, what location, and what time. */
5232 static int last_mouse_button
;
5233 static int last_mouse_x
;
5234 static int last_mouse_y
;
5235 static unsigned long button_down_time
;
5237 /* The maximum time between clicks to make a double-click, or Qnil to
5238 disable double-click detection, or Qt for no time limit. */
5240 Lisp_Object Vdouble_click_time
;
5242 /* Maximum number of pixels the mouse may be moved between clicks
5243 to make a double-click. */
5245 EMACS_INT double_click_fuzz
;
5247 /* The number of clicks in this multiple-click. */
5249 int double_click_count
;
5251 /* Return position of a mouse click or wheel event */
5254 make_lispy_position (struct frame
*f
, Lisp_Object
*x
, Lisp_Object
*y
,
5258 enum window_part part
;
5259 Lisp_Object posn
= Qnil
;
5260 Lisp_Object extra_info
= Qnil
;
5263 /* Set `window' to the window under frame pixel coordinates (x,y) */
5265 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5266 &part
, &wx
, &wy
, 0);
5270 if (WINDOWP (window
))
5272 /* It's a click in window window at frame coordinates (x,y) */
5273 struct window
*w
= XWINDOW (window
);
5274 Lisp_Object string_info
= Qnil
;
5275 EMACS_INT textpos
= -1;
5276 int rx
= -1, ry
= -1;
5277 int dx
= -1, dy
= -1;
5278 int width
= -1, height
= -1;
5279 Lisp_Object object
= Qnil
;
5281 /* Set event coordinates to window-relative coordinates
5282 for constructing the Lisp event below. */
5286 if (part
== ON_TEXT
)
5288 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5290 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5292 /* Mode line or header line. Look for a string under
5293 the mouse that may have a `local-map' property. */
5297 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5299 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5300 &object
, &dx
, &dy
, &width
, &height
);
5301 if (STRINGP (string
))
5302 string_info
= Fcons (string
, make_number (charpos
));
5303 if (w
== XWINDOW (selected_window
)
5304 && current_buffer
== XBUFFER (w
->buffer
))
5307 textpos
= XMARKER (w
->pointm
)->charpos
;
5309 else if (part
== ON_VERTICAL_BORDER
)
5311 posn
= Qvertical_line
;
5316 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5321 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5323 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5324 &object
, &dx
, &dy
, &width
, &height
);
5325 if (STRINGP (string
))
5326 string_info
= Fcons (string
, make_number (charpos
));
5327 if (part
== ON_LEFT_MARGIN
)
5330 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5332 else if (part
== ON_LEFT_FRINGE
)
5334 posn
= Qleft_fringe
;
5337 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5339 : window_box_width (w
, LEFT_MARGIN_AREA
));
5342 else if (part
== ON_RIGHT_FRINGE
)
5344 posn
= Qright_fringe
;
5347 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5348 + window_box_width (w
, TEXT_AREA
)
5349 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5350 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5356 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5357 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5362 Lisp_Object string2
, object2
= Qnil
;
5363 struct display_pos p
;
5365 int width2
, height2
;
5366 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5367 &object2
, &dx2
, &dy2
,
5369 textpos
= CHARPOS (p
.pos
);
5370 if (rx
< 0) rx
= wx
;
5371 if (ry
< 0) ry
= wy
;
5372 if (dx
< 0) dx
= dx2
;
5373 if (dy
< 0) dy
= dy2
;
5374 if (width
< 0) width
= width2
;
5375 if (height
< 0) height
= height2
;
5379 posn
= make_number (textpos
);
5380 if (STRINGP (string2
))
5381 string_info
= Fcons (string2
,
5382 make_number (CHARPOS (p
.string_pos
)));
5388 #ifdef HAVE_WINDOW_SYSTEM
5389 if (IMAGEP (object
))
5391 Lisp_Object image_map
, hotspot
;
5392 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5394 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5396 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5397 posn
= XCAR (hotspot
);
5402 extra_info
= Fcons (object
,
5403 Fcons (Fcons (make_number (dx
),
5405 Fcons (Fcons (make_number (width
),
5406 make_number (height
)),
5410 extra_info
= Fcons (string_info
,
5411 Fcons (make_number (textpos
),
5412 Fcons (Fcons (make_number (rx
),
5418 XSETFRAME (window
, f
);
5423 XSETFASTINT (*x
, 0);
5424 XSETFASTINT (*y
, 0);
5427 return Fcons (window
,
5429 Fcons (Fcons (*x
, *y
),
5430 Fcons (make_number (time
),
5434 /* Given a struct input_event, build the lisp event which represents
5435 it. If EVENT is 0, build a mouse movement event from the mouse
5436 movement buffer, which should have a movement event in it.
5438 Note that events must be passed to this function in the order they
5439 are received; this function stores the location of button presses
5440 in order to build drag events when the button is released. */
5443 make_lispy_event (struct input_event
*event
)
5447 switch (SWITCH_ENUM_CAST (event
->kind
))
5449 /* A simple keystroke. */
5450 case ASCII_KEYSTROKE_EVENT
:
5451 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5453 Lisp_Object lispy_c
;
5454 EMACS_INT c
= event
->code
;
5455 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5458 eassert (c
== event
->code
);
5459 /* Turn ASCII characters into control characters
5461 if (event
->modifiers
& ctrl_modifier
)
5463 c
= make_ctrl_char (c
);
5464 event
->modifiers
&= ~ctrl_modifier
;
5468 /* Add in the other modifier bits. The shift key was taken care
5469 of by the X code. */
5470 c
|= (event
->modifiers
5471 & (meta_modifier
| alt_modifier
5472 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5473 /* Distinguish Shift-SPC from SPC. */
5474 if ((event
->code
) == 040
5475 && event
->modifiers
& shift_modifier
)
5476 c
|= shift_modifier
;
5477 button_down_time
= 0;
5478 XSETFASTINT (lispy_c
, c
);
5483 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5484 except that they are non-key events (last-nonmenu-event is nil). */
5485 case NS_NONKEY_EVENT
:
5488 /* A function key. The symbol may need to have modifier prefixes
5490 case NON_ASCII_KEYSTROKE_EVENT
:
5491 button_down_time
= 0;
5493 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5494 if (event
->code
== lispy_accent_codes
[i
])
5495 return modify_event_symbol (i
,
5497 Qfunction_key
, Qnil
,
5498 lispy_accent_keys
, &accent_key_syms
,
5499 (sizeof (lispy_accent_keys
)
5500 / sizeof (lispy_accent_keys
[0])));
5504 if (event
->code
>= 0x400 && event
->code
< 0x500)
5505 return modify_event_symbol (event
->code
- 0x400,
5506 event
->modifiers
& ~shift_modifier
,
5507 Qfunction_key
, Qnil
,
5508 lispy_kana_keys
, &func_key_syms
,
5509 (sizeof (lispy_kana_keys
)
5510 / sizeof (lispy_kana_keys
[0])));
5511 #endif /* XK_kana_A */
5514 #ifdef ISO_FUNCTION_KEY_OFFSET
5515 if (event
->code
< FUNCTION_KEY_OFFSET
5516 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5517 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5519 Qfunction_key
, Qnil
,
5520 iso_lispy_function_keys
, &func_key_syms
,
5521 (sizeof (iso_lispy_function_keys
)
5522 / sizeof (iso_lispy_function_keys
[0])));
5525 /* Handle system-specific or unknown keysyms. */
5526 if (event
->code
& (1 << 28)
5527 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5528 || (event
->code
- FUNCTION_KEY_OFFSET
5529 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5530 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5532 /* We need to use an alist rather than a vector as the cache
5533 since we can't make a vector long enuf. */
5534 if (NILP (current_kboard
->system_key_syms
))
5535 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5536 return modify_event_symbol (event
->code
,
5539 current_kboard
->Vsystem_key_alist
,
5540 0, ¤t_kboard
->system_key_syms
,
5544 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5546 Qfunction_key
, Qnil
,
5547 lispy_function_keys
, &func_key_syms
,
5548 (sizeof (lispy_function_keys
)
5549 / sizeof (lispy_function_keys
[0])));
5552 case MULTIMEDIA_KEY_EVENT
:
5553 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5554 / sizeof (lispy_multimedia_keys
[0]))
5555 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5557 return modify_event_symbol (event
->code
, event
->modifiers
,
5558 Qfunction_key
, Qnil
,
5559 lispy_multimedia_keys
, &func_key_syms
,
5560 (sizeof (lispy_multimedia_keys
)
5561 / sizeof (lispy_multimedia_keys
[0])));
5567 /* A mouse click. Figure out where it is, decide whether it's
5568 a press, click or drag, and build the appropriate structure. */
5569 case MOUSE_CLICK_EVENT
:
5570 #ifndef USE_TOOLKIT_SCROLL_BARS
5571 case SCROLL_BAR_CLICK_EVENT
:
5574 int button
= event
->code
;
5576 Lisp_Object position
;
5577 Lisp_Object
*start_pos_ptr
;
5578 Lisp_Object start_pos
;
5582 /* Build the position as appropriate for this mouse click. */
5583 if (event
->kind
== MOUSE_CLICK_EVENT
)
5585 struct frame
*f
= XFRAME (event
->frame_or_window
);
5586 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5590 /* Ignore mouse events that were made on frame that
5591 have been deleted. */
5592 if (! FRAME_LIVE_P (f
))
5595 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5596 /* EVENT->x and EVENT->y are frame-relative pixel
5597 coordinates at this place. Under old redisplay, COLUMN
5598 and ROW are set to frame relative glyph coordinates
5599 which are then used to determine whether this click is
5600 in a menu (non-toolkit version). */
5601 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5602 &column
, &row
, NULL
, 1);
5604 /* In the non-toolkit version, clicks on the menu bar
5605 are ordinary button events in the event buffer.
5606 Distinguish them, and invoke the menu.
5608 (In the toolkit version, the toolkit handles the menu bar
5609 and Emacs doesn't know about it until after the user
5610 makes a selection.) */
5611 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5612 && (event
->modifiers
& down_modifier
))
5614 Lisp_Object items
, item
;
5619 /* Activate the menu bar on the down event. If the
5620 up event comes in before the menu code can deal with it,
5622 if (! (event
->modifiers
& down_modifier
))
5626 /* Find the menu bar item under `column'. */
5628 items
= FRAME_MENU_BAR_ITEMS (f
);
5629 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5631 Lisp_Object pos
, string
;
5632 string
= AREF (items
, i
+ 1);
5633 pos
= AREF (items
, i
+ 3);
5636 if (column
>= XINT (pos
)
5637 && column
< XINT (pos
) + SCHARS (string
))
5639 item
= AREF (items
, i
);
5644 /* ELisp manual 2.4b says (x y) are window relative but
5645 code says they are frame-relative. */
5647 = Fcons (event
->frame_or_window
,
5649 Fcons (Fcons (event
->x
, event
->y
),
5650 Fcons (make_number (event
->timestamp
),
5653 return Fcons (item
, Fcons (position
, Qnil
));
5655 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5657 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5660 #ifndef USE_TOOLKIT_SCROLL_BARS
5663 /* It's a scrollbar click. */
5665 Lisp_Object portion_whole
;
5668 window
= event
->frame_or_window
;
5669 portion_whole
= Fcons (event
->x
, event
->y
);
5670 part
= *scroll_bar_parts
[(int) event
->part
];
5674 Fcons (Qvertical_scroll_bar
,
5675 Fcons (portion_whole
,
5676 Fcons (make_number (event
->timestamp
),
5677 Fcons (part
, Qnil
)))));
5679 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5681 if (button
>= ASIZE (button_down_location
))
5683 button_down_location
= larger_vector (button_down_location
,
5685 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5688 start_pos_ptr
= &AREF (button_down_location
, button
);
5689 start_pos
= *start_pos_ptr
;
5690 *start_pos_ptr
= Qnil
;
5693 /* On window-system frames, use the value of
5694 double-click-fuzz as is. On other frames, interpret it
5695 as a multiple of 1/8 characters. */
5699 if (WINDOWP (event
->frame_or_window
))
5700 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5701 else if (FRAMEP (event
->frame_or_window
))
5702 f
= XFRAME (event
->frame_or_window
);
5706 if (FRAME_WINDOW_P (f
))
5707 fuzz
= double_click_fuzz
;
5709 fuzz
= double_click_fuzz
/ 8;
5711 is_double
= (button
== last_mouse_button
5712 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5713 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5714 && button_down_time
!= 0
5715 && (EQ (Vdouble_click_time
, Qt
)
5716 || (INTEGERP (Vdouble_click_time
)
5717 && ((int)(event
->timestamp
- button_down_time
)
5718 < XINT (Vdouble_click_time
)))));
5721 last_mouse_button
= button
;
5722 last_mouse_x
= XINT (event
->x
);
5723 last_mouse_y
= XINT (event
->y
);
5725 /* If this is a button press, squirrel away the location, so
5726 we can decide later whether it was a click or a drag. */
5727 if (event
->modifiers
& down_modifier
)
5731 double_click_count
++;
5732 event
->modifiers
|= ((double_click_count
> 2)
5737 double_click_count
= 1;
5738 button_down_time
= event
->timestamp
;
5739 *start_pos_ptr
= Fcopy_alist (position
);
5740 ignore_mouse_drag_p
= 0;
5743 /* Now we're releasing a button - check the co-ordinates to
5744 see if this was a click or a drag. */
5745 else if (event
->modifiers
& up_modifier
)
5747 /* If we did not see a down before this up, ignore the up.
5748 Probably this happened because the down event chose a
5749 menu item. It would be an annoyance to treat the
5750 release of the button that chose the menu item as a
5753 if (!CONSP (start_pos
))
5756 event
->modifiers
&= ~up_modifier
;
5757 #if 0 /* Formerly we treated an up with no down as a click event. */
5758 if (!CONSP (start_pos
))
5759 event
->modifiers
|= click_modifier
;
5764 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5766 /* The third element of every position
5767 should be the (x,y) pair. */
5768 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5770 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5772 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5773 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5776 if (ignore_mouse_drag_p
)
5778 event
->modifiers
|= click_modifier
;
5779 ignore_mouse_drag_p
= 0;
5781 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5782 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5783 /* Maybe the mouse has moved a lot, caused scrolling, and
5784 eventually ended up at the same screen position (but
5785 not buffer position) in which case it is a drag, not
5787 /* FIXME: OTOH if the buffer position has changed
5788 because of a timer or process filter rather than
5789 because of mouse movement, it should be considered as
5790 a click. But mouse-drag-region completely ignores
5791 this case and it hasn't caused any real problem, so
5792 it's probably OK to ignore it as well. */
5793 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5794 /* Mouse hasn't moved (much). */
5795 event
->modifiers
|= click_modifier
;
5798 button_down_time
= 0;
5799 event
->modifiers
|= drag_modifier
;
5802 /* Don't check is_double; treat this as multiple
5803 if the down-event was multiple. */
5804 if (double_click_count
> 1)
5805 event
->modifiers
|= ((double_click_count
> 2)
5811 /* Every mouse event should either have the down_modifier or
5812 the up_modifier set. */
5816 /* Get the symbol we should use for the mouse click. */
5819 head
= modify_event_symbol (button
,
5821 Qmouse_click
, Vlispy_mouse_stem
,
5824 XVECTOR (mouse_syms
)->size
);
5825 if (event
->modifiers
& drag_modifier
)
5830 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5833 Fcons (make_number (double_click_count
),
5843 case HORIZ_WHEEL_EVENT
:
5845 Lisp_Object position
;
5848 /* Build the position as appropriate for this mouse click. */
5849 struct frame
*f
= XFRAME (event
->frame_or_window
);
5851 /* Ignore wheel events that were made on frame that have been
5853 if (! FRAME_LIVE_P (f
))
5856 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5859 /* Set double or triple modifiers to indicate the wheel speed. */
5861 /* On window-system frames, use the value of
5862 double-click-fuzz as is. On other frames, interpret it
5863 as a multiple of 1/8 characters. */
5869 if (WINDOWP (event
->frame_or_window
))
5870 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5871 else if (FRAMEP (event
->frame_or_window
))
5872 f
= XFRAME (event
->frame_or_window
);
5876 if (FRAME_WINDOW_P (f
))
5877 fuzz
= double_click_fuzz
;
5879 fuzz
= double_click_fuzz
/ 8;
5881 if (event
->modifiers
& up_modifier
)
5883 /* Emit a wheel-up event. */
5884 event
->modifiers
&= ~up_modifier
;
5887 else if (event
->modifiers
& down_modifier
)
5889 /* Emit a wheel-down event. */
5890 event
->modifiers
&= ~down_modifier
;
5894 /* Every wheel event should either have the down_modifier or
5895 the up_modifier set. */
5898 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5901 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5902 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5903 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5904 && button_down_time
!= 0
5905 && (EQ (Vdouble_click_time
, Qt
)
5906 || (INTEGERP (Vdouble_click_time
)
5907 && ((int)(event
->timestamp
- button_down_time
)
5908 < XINT (Vdouble_click_time
)))));
5911 double_click_count
++;
5912 event
->modifiers
|= ((double_click_count
> 2)
5918 double_click_count
= 1;
5919 event
->modifiers
|= click_modifier
;
5922 button_down_time
= event
->timestamp
;
5923 /* Use a negative value to distinguish wheel from mouse button. */
5924 last_mouse_button
= - (1 + symbol_num
);
5925 last_mouse_x
= XINT (event
->x
);
5926 last_mouse_y
= XINT (event
->y
);
5928 /* Get the symbol we should use for the wheel event. */
5929 head
= modify_event_symbol (symbol_num
,
5935 ASIZE (wheel_syms
));
5938 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5941 Fcons (make_number (double_click_count
),
5950 #ifdef USE_TOOLKIT_SCROLL_BARS
5952 /* We don't have down and up events if using toolkit scroll bars,
5953 so make this always a click event. Store in the `part' of
5954 the Lisp event a symbol which maps to the following actions:
5956 `above_handle' page up
5957 `below_handle' page down
5961 `bottom' bottom of buffer
5962 `handle' thumb has been dragged.
5963 `end-scroll' end of interaction with scroll bar
5965 The incoming input_event contains in its `part' member an
5966 index of type `enum scroll_bar_part' which we can use as an
5967 index in scroll_bar_parts to get the appropriate symbol. */
5969 case SCROLL_BAR_CLICK_EVENT
:
5971 Lisp_Object position
, head
, window
, portion_whole
, part
;
5973 window
= event
->frame_or_window
;
5974 portion_whole
= Fcons (event
->x
, event
->y
);
5975 part
= *scroll_bar_parts
[(int) event
->part
];
5979 Fcons (Qvertical_scroll_bar
,
5980 Fcons (portion_whole
,
5981 Fcons (make_number (event
->timestamp
),
5982 Fcons (part
, Qnil
)))));
5984 /* Always treat scroll bar events as clicks. */
5985 event
->modifiers
|= click_modifier
;
5986 event
->modifiers
&= ~up_modifier
;
5988 if (event
->code
>= ASIZE (mouse_syms
))
5989 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5991 /* Get the symbol we should use for the mouse click. */
5992 head
= modify_event_symbol (event
->code
,
5997 XVECTOR (mouse_syms
)->size
);
5998 return Fcons (head
, Fcons (position
, Qnil
));
6001 #endif /* USE_TOOLKIT_SCROLL_BARS */
6003 case DRAG_N_DROP_EVENT
:
6006 Lisp_Object head
, position
;
6009 f
= XFRAME (event
->frame_or_window
);
6012 /* Ignore mouse events that were made on frames that
6013 have been deleted. */
6014 if (! FRAME_LIVE_P (f
))
6017 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6020 head
= modify_event_symbol (0, event
->modifiers
,
6022 lispy_drag_n_drop_names
,
6023 &drag_n_drop_syms
, 1);
6029 #endif /* HAVE_MOUSE */
6031 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6032 || defined(HAVE_NS) || defined (USE_GTK)
6033 case MENU_BAR_EVENT
:
6034 if (EQ (event
->arg
, event
->frame_or_window
))
6035 /* This is the prefix key. We translate this to
6036 `(menu_bar)' because the code in keyboard.c for menu
6037 events, which we use, relies on this. */
6038 return Fcons (Qmenu_bar
, Qnil
);
6042 case SELECT_WINDOW_EVENT
:
6043 /* Make an event (select-window (WINDOW)). */
6044 return Fcons (Qselect_window
,
6045 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6048 case TOOL_BAR_EVENT
:
6049 if (EQ (event
->arg
, event
->frame_or_window
))
6050 /* This is the prefix key. We translate this to
6051 `(tool_bar)' because the code in keyboard.c for tool bar
6052 events, which we use, relies on this. */
6053 return Fcons (Qtool_bar
, Qnil
);
6054 else if (SYMBOLP (event
->arg
))
6055 return apply_modifiers (event
->modifiers
, event
->arg
);
6058 case USER_SIGNAL_EVENT
:
6059 /* A user signal. */
6061 char *name
= find_user_signal_name (event
->code
);
6064 return intern (name
);
6067 case SAVE_SESSION_EVENT
:
6068 return Qsave_session
;
6073 return Fcons (Qdbus_event
, event
->arg
);
6075 #endif /* HAVE_DBUS */
6077 case CONFIG_CHANGED_EVENT
:
6078 return Fcons (Qconfig_changed_event
,
6080 Fcons (event
->frame_or_window
, Qnil
)));
6082 case GPM_CLICK_EVENT
:
6084 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6085 Lisp_Object head
, position
;
6086 Lisp_Object
*start_pos_ptr
;
6087 Lisp_Object start_pos
;
6088 int button
= event
->code
;
6090 if (button
>= ASIZE (button_down_location
))
6092 button_down_location
= larger_vector (button_down_location
,
6094 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6097 start_pos_ptr
= &AREF (button_down_location
, button
);
6098 start_pos
= *start_pos_ptr
;
6100 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6103 if (event
->modifiers
& down_modifier
)
6104 *start_pos_ptr
= Fcopy_alist (position
);
6105 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6107 if (!CONSP (start_pos
))
6109 event
->modifiers
&= ~up_modifier
;
6112 head
= modify_event_symbol (button
,
6114 Qmouse_click
, Vlispy_mouse_stem
,
6117 XVECTOR (mouse_syms
)->size
);
6119 if (event
->modifiers
& drag_modifier
)
6124 else if (event
->modifiers
& double_modifier
)
6127 Fcons (make_number (2),
6129 else if (event
->modifiers
& triple_modifier
)
6132 Fcons (make_number (3),
6139 #endif /* HAVE_GPM */
6141 /* The 'kind' field of the event is something we don't recognize. */
6147 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6150 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6151 Lisp_Object x
, Lisp_Object y
, unsigned long time
)
6153 /* Is it a scroll bar movement? */
6154 if (frame
&& ! NILP (bar_window
))
6156 Lisp_Object part_sym
;
6158 part_sym
= *scroll_bar_parts
[(int) part
];
6159 return Fcons (Qscroll_bar_movement
,
6160 (Fcons (Fcons (bar_window
,
6161 Fcons (Qvertical_scroll_bar
,
6162 Fcons (Fcons (x
, y
),
6163 Fcons (make_number (time
),
6169 /* Or is it an ordinary mouse movement? */
6172 Lisp_Object position
;
6174 position
= make_lispy_position (frame
, &x
, &y
, time
);
6176 return Fcons (Qmouse_movement
,
6182 #endif /* HAVE_MOUSE || HAVE GPM */
6184 /* Construct a switch frame event. */
6186 make_lispy_switch_frame (Lisp_Object frame
)
6188 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6191 /* Manipulating modifiers. */
6193 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6195 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6196 SYMBOL's name of the end of the modifiers; the string from this
6197 position is the unmodified symbol name.
6199 This doesn't use any caches. */
6202 parse_modifiers_uncached (Lisp_Object symbol
, int *modifier_end
)
6208 CHECK_SYMBOL (symbol
);
6211 name
= SYMBOL_NAME (symbol
);
6213 for (i
= 0; i
+2 <= SBYTES (name
); )
6215 int this_mod_end
= 0;
6218 /* See if the name continues with a modifier word.
6219 Check that the word appears, but don't check what follows it.
6220 Set this_mod and this_mod_end to record what we find. */
6222 switch (SREF (name
, i
))
6224 #define SINGLE_LETTER_MOD(BIT) \
6225 (this_mod_end = i + 1, this_mod = BIT)
6228 SINGLE_LETTER_MOD (alt_modifier
);
6232 SINGLE_LETTER_MOD (ctrl_modifier
);
6236 SINGLE_LETTER_MOD (hyper_modifier
);
6240 SINGLE_LETTER_MOD (meta_modifier
);
6244 SINGLE_LETTER_MOD (shift_modifier
);
6248 SINGLE_LETTER_MOD (super_modifier
);
6251 #undef SINGLE_LETTER_MOD
6253 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6254 if (i + LEN + 1 <= SBYTES (name) \
6255 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6257 this_mod_end = i + LEN; \
6262 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6263 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6264 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6268 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6270 #undef MULTI_LETTER_MOD
6274 /* If we found no modifier, stop looking for them. */
6275 if (this_mod_end
== 0)
6278 /* Check there is a dash after the modifier, so that it
6279 really is a modifier. */
6280 if (this_mod_end
>= SBYTES (name
)
6281 || SREF (name
, this_mod_end
) != '-')
6284 /* This modifier is real; look for another. */
6285 modifiers
|= this_mod
;
6286 i
= this_mod_end
+ 1;
6289 /* Should we include the `click' modifier? */
6290 if (! (modifiers
& (down_modifier
| drag_modifier
6291 | double_modifier
| triple_modifier
))
6292 && i
+ 7 == SBYTES (name
)
6293 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6294 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6295 modifiers
|= click_modifier
;
6297 if (! (modifiers
& (double_modifier
| triple_modifier
))
6298 && i
+ 6 < SBYTES (name
)
6299 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6300 modifiers
|= click_modifier
;
6308 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6309 prepended to the string BASE[0..BASE_LEN-1].
6310 This doesn't use any caches. */
6312 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6314 /* Since BASE could contain nulls, we can't use intern here; we have
6315 to use Fintern, which expects a genuine Lisp_String, and keeps a
6318 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6324 /* Only the event queue may use the `up' modifier; it should always
6325 be turned into a click or drag event before presented to lisp code. */
6326 if (modifiers
& up_modifier
)
6329 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6330 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6331 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6332 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6333 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6334 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6335 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6336 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6337 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6338 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6339 /* The click modifier is denoted by the absence of other modifiers. */
6343 mod_len
= p
- new_mods
;
6347 Lisp_Object new_name
;
6349 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6350 mod_len
+ base_len_byte
);
6351 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6352 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6354 return Fintern (new_name
, Qnil
);
6359 static const char *modifier_names
[] =
6361 "up", "down", "drag", "click", "double", "triple", 0, 0,
6362 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6363 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6365 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6367 static Lisp_Object modifier_symbols
;
6369 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6371 lispy_modifier_list (int modifiers
)
6373 Lisp_Object modifier_list
;
6376 modifier_list
= Qnil
;
6377 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6378 if (modifiers
& (1<<i
))
6379 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6382 return modifier_list
;
6386 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6387 where UNMODIFIED is the unmodified form of SYMBOL,
6388 MASK is the set of modifiers present in SYMBOL's name.
6389 This is similar to parse_modifiers_uncached, but uses the cache in
6390 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6391 Qevent_symbol_elements property. */
6393 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6396 parse_modifiers (Lisp_Object symbol
)
6398 Lisp_Object elements
;
6400 if (INTEGERP (symbol
))
6401 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6402 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6404 else if (!SYMBOLP (symbol
))
6407 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6408 if (CONSP (elements
))
6413 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6414 Lisp_Object unmodified
;
6417 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6418 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6421 if (modifiers
& ~INTMASK
)
6423 XSETFASTINT (mask
, modifiers
);
6424 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6426 /* Cache the parsing results on SYMBOL. */
6427 Fput (symbol
, Qevent_symbol_element_mask
,
6429 Fput (symbol
, Qevent_symbol_elements
,
6430 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6432 /* Since we know that SYMBOL is modifiers applied to unmodified,
6433 it would be nice to put that in unmodified's cache.
6434 But we can't, since we're not sure that parse_modifiers is
6441 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6442 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6443 doc
: /* Parse the event symbol. For internal use. */)
6444 (Lisp_Object symbol
)
6446 /* Fill the cache if needed. */
6447 parse_modifiers (symbol
);
6448 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6449 and use the Lispier representation stored on Qevent_symbol_elements
6451 return Fget (symbol
, Qevent_symbol_elements
);
6454 /* Apply the modifiers MODIFIERS to the symbol BASE.
6455 BASE must be unmodified.
6457 This is like apply_modifiers_uncached, but uses BASE's
6458 Qmodifier_cache property, if present. It also builds
6459 Qevent_symbol_elements properties, since it has that info anyway.
6461 apply_modifiers copies the value of BASE's Qevent_kind property to
6462 the modified symbol. */
6464 apply_modifiers (int modifiers
, Lisp_Object base
)
6466 Lisp_Object cache
, index
, entry
, new_symbol
;
6468 /* Mask out upper bits. We don't know where this value's been. */
6469 modifiers
&= INTMASK
;
6471 if (INTEGERP (base
))
6472 return make_number (XINT (base
) | modifiers
);
6474 /* The click modifier never figures into cache indices. */
6475 cache
= Fget (base
, Qmodifier_cache
);
6476 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6477 entry
= assq_no_quit (index
, cache
);
6480 new_symbol
= XCDR (entry
);
6483 /* We have to create the symbol ourselves. */
6484 new_symbol
= apply_modifiers_uncached (modifiers
,
6485 SDATA (SYMBOL_NAME (base
)),
6486 SCHARS (SYMBOL_NAME (base
)),
6487 SBYTES (SYMBOL_NAME (base
)));
6489 /* Add the new symbol to the base's cache. */
6490 entry
= Fcons (index
, new_symbol
);
6491 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6493 /* We have the parsing info now for free, so we could add it to
6495 XSETFASTINT (index, modifiers);
6496 Fput (new_symbol, Qevent_symbol_element_mask,
6497 Fcons (base, Fcons (index, Qnil)));
6498 Fput (new_symbol, Qevent_symbol_elements,
6499 Fcons (base, lispy_modifier_list (modifiers)));
6500 Sadly, this is only correct if `base' is indeed a base event,
6501 which is not necessarily the case. -stef */
6504 /* Make sure this symbol is of the same kind as BASE.
6506 You'd think we could just set this once and for all when we
6507 intern the symbol above, but reorder_modifiers may call us when
6508 BASE's property isn't set right; we can't assume that just
6509 because it has a Qmodifier_cache property it must have its
6510 Qevent_kind set right as well. */
6511 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6515 kind
= Fget (base
, Qevent_kind
);
6517 Fput (new_symbol
, Qevent_kind
, kind
);
6524 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6525 return a symbol with the modifiers placed in the canonical order.
6526 Canonical order is alphabetical, except for down and drag, which
6527 always come last. The 'click' modifier is never written out.
6529 Fdefine_key calls this to make sure that (for example) C-M-foo
6530 and M-C-foo end up being equivalent in the keymap. */
6533 reorder_modifiers (Lisp_Object symbol
)
6535 /* It's hopefully okay to write the code this way, since everything
6536 will soon be in caches, and no consing will be done at all. */
6539 parsed
= parse_modifiers (symbol
);
6540 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6545 /* For handling events, we often want to produce a symbol whose name
6546 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6547 to some base, like the name of a function key or mouse button.
6548 modify_event_symbol produces symbols of this sort.
6550 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6551 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6554 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6555 into symbol names, or a string specifying a name stem used to
6556 construct a symbol name or the form `STEM-N', where N is the decimal
6557 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6558 non-nil; otherwise NAME_TABLE is used.
6560 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6561 persist between calls to modify_event_symbol that it can use to
6562 store a cache of the symbols it's generated for this NAME_TABLE
6563 before. The object stored there may be a vector or an alist.
6565 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6567 MODIFIERS is a set of modifier bits (as given in struct input_events)
6568 whose prefixes should be applied to the symbol name.
6570 SYMBOL_KIND is the value to be placed in the event_kind property of
6571 the returned symbol.
6573 The symbols we create are supposed to have an
6574 `event-symbol-elements' property, which lists the modifiers present
6575 in the symbol's name. */
6578 modify_event_symbol (EMACS_INT symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6579 Lisp_Object name_alist_or_stem
, const char **name_table
,
6580 Lisp_Object
*symbol_table
, unsigned int table_size
)
6583 Lisp_Object symbol_int
;
6585 /* Get rid of the "vendor-specific" bit here. */
6586 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6588 /* Is this a request for a valid symbol? */
6589 if (symbol_num
< 0 || symbol_num
>= table_size
)
6592 if (CONSP (*symbol_table
))
6593 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6595 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6596 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6597 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6598 we've never used that symbol before. */
6601 if (! VECTORP (*symbol_table
)
6602 || XVECTOR (*symbol_table
)->size
!= table_size
)
6606 XSETFASTINT (size
, table_size
);
6607 *symbol_table
= Fmake_vector (size
, Qnil
);
6610 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6613 /* Have we already used this symbol before? */
6616 /* No; let's create it. */
6617 if (CONSP (name_alist_or_stem
))
6618 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6619 else if (STRINGP (name_alist_or_stem
))
6621 int len
= SBYTES (name_alist_or_stem
);
6622 char *buf
= (char *) alloca (len
+ 50);
6623 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6624 (long) XINT (symbol_int
) + 1);
6625 value
= intern (buf
);
6627 else if (name_table
!= 0 && name_table
[symbol_num
])
6628 value
= intern (name_table
[symbol_num
]);
6630 #ifdef HAVE_WINDOW_SYSTEM
6633 char *name
= x_get_keysym_name (symbol_num
);
6635 value
= intern (name
);
6642 sprintf (buf
, "key-%ld", (long)symbol_num
);
6643 value
= intern (buf
);
6646 if (CONSP (*symbol_table
))
6647 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6649 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6651 /* Fill in the cache entries for this symbol; this also
6652 builds the Qevent_symbol_elements property, which the user
6654 apply_modifiers (modifiers
& click_modifier
, value
);
6655 Fput (value
, Qevent_kind
, symbol_kind
);
6658 /* Apply modifiers to that symbol. */
6659 return apply_modifiers (modifiers
, value
);
6662 /* Convert a list that represents an event type,
6663 such as (ctrl meta backspace), into the usual representation of that
6664 event type as a number or a symbol. */
6666 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6667 doc
: /* Convert the event description list EVENT-DESC to an event type.
6668 EVENT-DESC should contain one base event type (a character or symbol)
6669 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6670 drag, down, double or triple). The base must be last.
6671 The return value is an event type (a character or symbol) which
6672 has the same base event type and all the specified modifiers. */)
6673 (Lisp_Object event_desc
)
6681 while (CONSP (rest
))
6689 /* Given a symbol, see if it is a modifier name. */
6690 if (SYMBOLP (elt
) && CONSP (rest
))
6691 this = parse_solitary_modifier (elt
);
6695 else if (!NILP (base
))
6696 error ("Two bases given in one event");
6702 /* Let the symbol A refer to the character A. */
6703 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6704 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6706 if (INTEGERP (base
))
6708 /* Turn (shift a) into A. */
6709 if ((modifiers
& shift_modifier
) != 0
6710 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6712 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6713 modifiers
&= ~shift_modifier
;
6716 /* Turn (control a) into C-a. */
6717 if (modifiers
& ctrl_modifier
)
6718 return make_number ((modifiers
& ~ctrl_modifier
)
6719 | make_ctrl_char (XINT (base
)));
6721 return make_number (modifiers
| XINT (base
));
6723 else if (SYMBOLP (base
))
6724 return apply_modifiers (modifiers
, base
);
6727 error ("Invalid base event");
6732 /* Try to recognize SYMBOL as a modifier name.
6733 Return the modifier flag bit, or 0 if not recognized. */
6736 parse_solitary_modifier (Lisp_Object symbol
)
6738 Lisp_Object name
= SYMBOL_NAME (symbol
);
6740 switch (SREF (name
, 0))
6742 #define SINGLE_LETTER_MOD(BIT) \
6743 if (SBYTES (name) == 1) \
6746 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6747 if (LEN == SBYTES (name) \
6748 && ! strncmp (SDATA (name), NAME, LEN)) \
6752 SINGLE_LETTER_MOD (alt_modifier
);
6756 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6760 SINGLE_LETTER_MOD (ctrl_modifier
);
6764 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6765 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6769 SINGLE_LETTER_MOD (hyper_modifier
);
6773 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6777 SINGLE_LETTER_MOD (meta_modifier
);
6781 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6785 SINGLE_LETTER_MOD (shift_modifier
);
6789 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6790 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6791 SINGLE_LETTER_MOD (super_modifier
);
6795 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6796 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6797 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6801 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6804 #undef SINGLE_LETTER_MOD
6805 #undef MULTI_LETTER_MOD
6811 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6812 Such a list is not valid as an event,
6813 but it can be a Lucid-style event type list. */
6816 lucid_event_type_list_p (Lisp_Object object
)
6820 if (! CONSP (object
))
6823 if (EQ (XCAR (object
), Qhelp_echo
)
6824 || EQ (XCAR (object
), Qvertical_line
)
6825 || EQ (XCAR (object
), Qmode_line
)
6826 || EQ (XCAR (object
), Qheader_line
))
6829 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6833 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6840 /* Store into *addr a value nonzero if terminal input chars are available.
6841 Serves the purpose of ioctl (0, FIONREAD, addr)
6842 but works even if FIONREAD does not exist.
6843 (In fact, this may actually read some input.)
6845 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6846 timer events that are ripe.
6847 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6848 events (FOCUS_IN_EVENT).
6849 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6850 movements and toolkit scroll bar thumb drags. */
6853 get_input_pending (int *addr
, int flags
)
6855 /* First of all, have we already counted some input? */
6856 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6858 /* If input is being read as it arrives, and we have none, there is none. */
6859 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6862 /* Try to read some input and see how much we get. */
6864 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6867 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6870 gobble_input (int expected
)
6873 if (interrupt_input
)
6876 mask
= sigblock (sigmask (SIGIO
));
6877 read_avail_input (expected
);
6881 #ifdef POLL_FOR_INPUT
6882 /* XXX This condition was (read_socket_hook && !interrupt_input),
6883 but read_socket_hook is not global anymore. Let's pretend that
6885 if (!interrupt_input
&& poll_suppress_count
== 0)
6888 mask
= sigblock (sigmask (SIGALRM
));
6889 read_avail_input (expected
);
6895 read_avail_input (expected
);
6898 /* Put a BUFFER_SWITCH_EVENT in the buffer
6899 so that read_key_sequence will notice the new current buffer. */
6902 record_asynch_buffer_change (void)
6904 struct input_event event
;
6908 event
.kind
= BUFFER_SWITCH_EVENT
;
6909 event
.frame_or_window
= Qnil
;
6912 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6913 The purpose of the event is to make read_key_sequence look up the
6914 keymaps again. If we aren't in read_key_sequence, we don't need one,
6915 and the event could cause trouble by messing up (input-pending-p).
6916 Note: Fwaiting_for_user_input_p always returns nil when async
6917 subprocesses aren't supported. */
6918 tem
= Fwaiting_for_user_input_p ();
6922 /* Make sure no interrupt happens while storing the event. */
6924 if (interrupt_input
)
6927 mask
= sigblock (sigmask (SIGIO
));
6928 kbd_buffer_store_event (&event
);
6935 kbd_buffer_store_event (&event
);
6940 /* Read any terminal input already buffered up by the system
6941 into the kbd_buffer, but do not wait.
6943 EXPECTED should be nonzero if the caller knows there is some input.
6945 Returns the number of keyboard chars read, or -1 meaning
6946 this is a bad time to try to read input. */
6949 read_avail_input (int expected
)
6955 /* Store pending user signal events, if any. */
6956 if (store_user_signal_events ())
6959 /* Loop through the available terminals, and call their input hooks. */
6963 struct terminal
*next
= t
->next_terminal
;
6965 if (t
->read_socket_hook
)
6968 struct input_event hold_quit
;
6970 EVENT_INIT (hold_quit
);
6971 hold_quit
.kind
= NO_EVENT
;
6973 /* No need for FIONREAD or fcntl; just say don't wait. */
6974 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6980 if (nr
== -1) /* Not OK to read input now. */
6984 else if (nr
== -2) /* Non-transient error. */
6986 /* The terminal device terminated; it should be closed. */
6988 /* Kill Emacs if this was our last terminal. */
6989 if (!terminal_list
->next_terminal
)
6990 /* Formerly simply reported no input, but that
6991 sometimes led to a failure of Emacs to terminate.
6992 SIGHUP seems appropriate if we can't reach the
6994 /* ??? Is it really right to send the signal just to
6995 this process rather than to the whole process
6996 group? Perhaps on systems with FIONREAD Emacs is
6997 alone in its group. */
6998 kill (getpid (), SIGHUP
);
7000 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7003 XSETTERMINAL (tmp
, t
);
7004 Fdelete_terminal (tmp
, Qnoelisp
);
7008 if (hold_quit
.kind
!= NO_EVENT
)
7009 kbd_buffer_store_event (&hold_quit
);
7018 frame_make_pointer_visible ();
7024 decode_keyboard_code (struct tty_display_info
*tty
,
7025 struct coding_system
*coding
,
7026 unsigned char *buf
, int nbytes
)
7028 unsigned char *src
= buf
;
7029 const unsigned char *p
;
7034 if (tty
->meta_key
!= 2)
7035 for (i
= 0; i
< nbytes
; i
++)
7037 if (coding
->carryover_bytes
> 0)
7039 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7040 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7041 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7042 nbytes
+= coding
->carryover_bytes
;
7044 coding
->destination
= alloca (nbytes
* 4);
7045 coding
->dst_bytes
= nbytes
* 4;
7046 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7047 if (coding
->produced_char
== 0)
7049 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7051 struct input_event buf
;
7054 buf
.code
= STRING_CHAR_ADVANCE (p
);
7055 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7056 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7057 /* See the comment in tty_read_avail_input. */
7058 buf
.frame_or_window
= tty
->top_frame
;
7060 kbd_buffer_store_event (&buf
);
7064 /* This is the tty way of reading available input.
7066 Note that each terminal device has its own `struct terminal' object,
7067 and so this function is called once for each individual termcap
7068 terminal. The first parameter indicates which terminal to read from. */
7071 tty_read_avail_input (struct terminal
*terminal
,
7073 struct input_event
*hold_quit
)
7075 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7076 the kbd_buffer can really hold. That may prevent loss
7077 of characters on some systems when input is stuffed at us. */
7078 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7080 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7082 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
7084 if (kbd_on_hold_p () || buffer_free
<= 0)
7087 if (!terminal
->name
) /* Don't read from a dead terminal. */
7090 if (terminal
->type
!= output_termcap
7091 && terminal
->type
!= output_msdos_raw
)
7094 /* XXX I think the following code should be moved to separate hook
7095 functions in system-dependent files. */
7098 #else /* not WINDOWSNT */
7099 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7103 return 0; /* The terminal is suspended. */
7106 n_to_read
= dos_keysns ();
7110 cbuf
[0] = dos_keyread ();
7113 #else /* not MSDOS */
7118 struct input_event hold_quit
;
7119 int gpm
, fd
= gpm_fd
;
7121 EVENT_INIT (hold_quit
);
7122 hold_quit
.kind
= NO_EVENT
;
7124 /* gpm==1 if event received.
7125 gpm==0 if the GPM daemon has closed the connection, in which case
7126 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7127 we save it in `fd' so close_gpm can remove it from the
7129 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7130 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7131 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7134 /* Presumably the GPM daemon has closed the connection. */
7136 if (hold_quit
.kind
!= NO_EVENT
)
7137 kbd_buffer_store_event (&hold_quit
);
7141 #endif /* HAVE_GPM */
7143 /* Determine how many characters we should *try* to read. */
7145 /* Find out how much input is available. */
7146 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7148 if (! noninteractive
)
7149 return -2; /* Close this terminal. */
7155 if (n_to_read
> sizeof cbuf
)
7156 n_to_read
= sizeof cbuf
;
7157 #else /* no FIONREAD */
7158 #if defined (USG) || defined(CYGWIN)
7159 /* Read some input if available, but don't wait. */
7160 n_to_read
= sizeof cbuf
;
7161 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7167 /* Don't read more than we can store. */
7168 if (n_to_read
> buffer_free
)
7169 n_to_read
= buffer_free
;
7171 /* Now read; for one reason or another, this will not block.
7172 NREAD is set to the number of chars read. */
7175 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7176 /* POSIX infers that processes which are not in the session leader's
7177 process group won't get SIGHUP's at logout time. BSDI adheres to
7178 this part standard and returns -1 from read (0) with errno==EIO
7179 when the control tty is taken away.
7180 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7181 if (nread
== -1 && errno
== EIO
)
7182 return -2; /* Close this terminal. */
7183 #if defined (AIX) && defined (_BSD)
7184 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7185 This looks incorrect, but it isn't, because _BSD causes
7186 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7187 and that causes a value other than 0 when there is no input. */
7189 return -2; /* Close this terminal. */
7193 /* We used to retry the read if it was interrupted.
7194 But this does the wrong thing when O_NDELAY causes
7195 an EAGAIN error. Does anybody know of a situation
7196 where a retry is actually needed? */
7198 nread
< 0 && (errno
== EAGAIN
7212 #if defined (USG) || defined (CYGWIN)
7213 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7214 #endif /* USG or CYGWIN */
7215 #endif /* no FIONREAD */
7220 #endif /* not MSDOS */
7221 #endif /* not WINDOWSNT */
7223 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7224 & CODING_REQUIRE_DECODING_MASK
)
7226 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7229 /* Decode the key sequence except for those with meta
7231 for (i
= from
= 0; ; i
++)
7232 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7234 struct input_event buf
;
7236 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7241 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7242 buf
.modifiers
= meta_modifier
;
7243 buf
.code
= cbuf
[i
] & ~0x80;
7244 /* See the comment below. */
7245 buf
.frame_or_window
= tty
->top_frame
;
7247 kbd_buffer_store_event (&buf
);
7253 for (i
= 0; i
< nread
; i
++)
7255 struct input_event buf
;
7257 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7259 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7260 buf
.modifiers
= meta_modifier
;
7261 if (tty
->meta_key
!= 2)
7265 /* Set the frame corresponding to the active tty. Note that the
7266 value of selected_frame is not reliable here, redisplay tends
7267 to temporarily change it. */
7268 buf
.frame_or_window
= tty
->top_frame
;
7271 kbd_buffer_store_event (&buf
);
7272 /* Don't look at input that follows a C-g too closely.
7273 This reduces lossage due to autorepeat on C-g. */
7274 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7275 && buf
.code
== quit_char
)
7283 handle_async_input (void)
7285 interrupt_input_pending
= 0;
7287 pending_signals
= pending_atimers
;
7289 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7290 doing anything dangerous. */
7297 nread
= read_avail_input (1);
7298 /* -1 means it's not ok to read the input now.
7299 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7300 0 means there was no keyboard input available. */
7310 process_pending_signals (void)
7312 if (interrupt_input_pending
)
7313 handle_async_input ();
7314 do_pending_atimers ();
7317 #ifdef SIGIO /* for entire page */
7318 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7321 input_available_signal (int signo
)
7323 /* Must preserve main program's value of errno. */
7324 int old_errno
= errno
;
7325 SIGNAL_THREAD_CHECK (signo
);
7328 interrupt_input_pending
= 1;
7329 pending_signals
= 1;
7332 if (input_available_clear_time
)
7333 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7336 handle_async_input ();
7343 /* Send ourselves a SIGIO.
7345 This function exists so that the UNBLOCK_INPUT macro in
7346 blockinput.h can have some way to take care of input we put off
7347 dealing with, without assuming that every file which uses
7348 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7350 reinvoke_input_signal (void)
7353 handle_async_input ();
7359 /* User signal events. */
7361 struct user_signal_info
7363 /* Signal number. */
7366 /* Name of the signal. */
7369 /* Number of pending signals. */
7372 struct user_signal_info
*next
;
7375 /* List of user signals. */
7376 static struct user_signal_info
*user_signals
= NULL
;
7379 add_user_signal (int sig
, const char *name
)
7381 struct user_signal_info
*p
;
7383 for (p
= user_signals
; p
; p
= p
->next
)
7385 /* Already added. */
7388 p
= xmalloc (sizeof (struct user_signal_info
));
7390 p
->name
= xstrdup (name
);
7392 p
->next
= user_signals
;
7395 signal (sig
, handle_user_signal
);
7399 handle_user_signal (int sig
)
7401 int old_errno
= errno
;
7402 struct user_signal_info
*p
;
7404 SIGNAL_THREAD_CHECK (sig
);
7406 for (p
= user_signals
; p
; p
= p
->next
)
7411 if (interrupt_input
)
7412 kill (getpid (), SIGIO
);
7416 /* Tell wait_reading_process_output that it needs to wake
7417 up and look around. */
7418 if (input_available_clear_time
)
7419 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7428 find_user_signal_name (int sig
)
7430 struct user_signal_info
*p
;
7432 for (p
= user_signals
; p
; p
= p
->next
)
7440 store_user_signal_events (void)
7442 struct user_signal_info
*p
;
7443 struct input_event buf
;
7446 for (p
= user_signals
; p
; p
= p
->next
)
7447 if (p
->npending
> 0)
7453 memset (&buf
, 0, sizeof buf
);
7454 buf
.kind
= USER_SIGNAL_EVENT
;
7455 buf
.frame_or_window
= selected_frame
;
7457 nstored
+= p
->npending
;
7459 mask
= sigblock (sigmask (p
->sig
));
7463 kbd_buffer_store_event (&buf
);
7466 while (p
->npending
> 0);
7474 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7475 static Lisp_Object menu_bar_one_keymap_changed_items
;
7477 /* These variables hold the vector under construction within
7478 menu_bar_items and its subroutines, and the current index
7479 for storing into that vector. */
7480 static Lisp_Object menu_bar_items_vector
;
7481 static int menu_bar_items_index
;
7483 /* Return a vector of menu items for a menu bar, appropriate
7484 to the current buffer. Each item has three elements in the vector:
7487 OLD is an old vector we can optionally reuse, or nil. */
7490 menu_bar_items (Lisp_Object old
)
7492 /* The number of keymaps we're scanning right now, and the number of
7493 keymaps we have allocated space for. */
7496 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7497 in the current keymaps, or nil where it is not a prefix. */
7500 Lisp_Object def
, tail
;
7509 /* In order to build the menus, we need to call the keymap
7510 accessors. They all call QUIT. But this function is called
7511 during redisplay, during which a quit is fatal. So inhibit
7512 quitting while building the menus.
7513 We do this instead of specbind because (1) errors will clear it anyway
7514 and (2) this avoids risk of specpdl overflow. */
7515 oquit
= Vinhibit_quit
;
7519 menu_bar_items_vector
= old
;
7521 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7522 menu_bar_items_index
= 0;
7524 /* Build our list of keymaps.
7525 If we recognize a function key and replace its escape sequence in
7526 keybuf with its symbol, or if the sequence starts with a mouse
7527 click and we need to switch buffers, we jump back here to rebuild
7528 the initial keymaps from the current buffer. */
7532 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7533 if (!NILP (Voverriding_local_map_menu_flag
))
7535 /* Yes, use them (if non-nil) as well as the global map. */
7536 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7538 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7539 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7540 if (!NILP (Voverriding_local_map
))
7541 maps
[nmaps
++] = Voverriding_local_map
;
7545 /* No, so use major and minor mode keymaps and keymap property.
7546 Note that menu-bar bindings in the local-map and keymap
7547 properties may not work reliable, as they are only
7548 recognized when the menu-bar (or mode-line) is updated,
7549 which does not normally happen after every command. */
7552 nminor
= current_minor_maps (NULL
, &tmaps
);
7553 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7555 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7556 maps
[nmaps
++] = tem
;
7557 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7559 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7561 maps
[nmaps
++] = current_global_map
;
7564 /* Look up in each map the dummy prefix key `menu-bar'. */
7568 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7569 if (!NILP (maps
[mapno
]))
7571 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7575 menu_bar_one_keymap_changed_items
= Qnil
;
7576 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7580 /* Move to the end those items that should be at the end. */
7582 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7585 int end
= menu_bar_items_index
;
7587 for (i
= 0; i
< end
; i
+= 4)
7588 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7590 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7591 /* Move the item at index I to the end,
7592 shifting all the others forward. */
7593 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7594 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7595 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7596 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7598 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7599 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7600 (end
- i
- 4) * sizeof (Lisp_Object
));
7601 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7602 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7603 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7604 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7609 /* Add nil, nil, nil, nil at the end. */
7610 i
= menu_bar_items_index
;
7611 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7612 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7613 /* Add this item. */
7614 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7615 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7616 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7617 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7618 menu_bar_items_index
= i
;
7620 Vinhibit_quit
= oquit
;
7621 return menu_bar_items_vector
;
7624 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7625 If there's already an item for KEY, add this DEF to it. */
7627 Lisp_Object item_properties
;
7630 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7632 struct gcpro gcpro1
;
7636 if (EQ (item
, Qundefined
))
7638 /* If a map has an explicit `undefined' as definition,
7639 discard any previously made menu bar item. */
7641 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7642 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7644 if (menu_bar_items_index
> i
+ 4)
7645 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7646 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7647 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7648 menu_bar_items_index
-= 4;
7652 /* If this keymap has already contributed to this KEY,
7653 don't contribute to it a second time. */
7654 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7655 if (!NILP (tem
) || NILP (item
))
7658 menu_bar_one_keymap_changed_items
7659 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7661 /* We add to menu_bar_one_keymap_changed_items before doing the
7662 parse_menu_item, so that if it turns out it wasn't a menu item,
7663 it still correctly hides any further menu item. */
7665 i
= parse_menu_item (item
, 1);
7670 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7672 /* Find any existing item for this KEY. */
7673 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7674 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7677 /* If we did not find this KEY, add it at the end. */
7678 if (i
== menu_bar_items_index
)
7680 /* If vector is too small, get a bigger one. */
7681 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7682 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7683 /* Add this item. */
7684 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7685 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7686 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7687 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7688 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7689 menu_bar_items_index
= i
;
7691 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7695 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7696 /* If the new and the old items are not both keymaps,
7697 the lookup will only find `item'. */
7698 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7699 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7703 /* This is used as the handler when calling menu_item_eval_property. */
7705 menu_item_eval_property_1 (Lisp_Object arg
)
7707 /* If we got a quit from within the menu computation,
7708 quit all the way out of it. This takes care of C-] in the debugger. */
7709 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7710 Fsignal (Qquit
, Qnil
);
7715 /* Evaluate an expression and return the result (or nil if something
7716 went wrong). Used to evaluate dynamic parts of menu items. */
7718 menu_item_eval_property (Lisp_Object sexpr
)
7720 int count
= SPECPDL_INDEX ();
7722 specbind (Qinhibit_redisplay
, Qt
);
7723 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7724 menu_item_eval_property_1
);
7725 return unbind_to (count
, val
);
7728 /* This function parses a menu item and leaves the result in the
7729 vector item_properties.
7730 ITEM is a key binding, a possible menu item.
7731 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7733 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7734 parse_menu_item returns true if the item is a menu item and false
7738 parse_menu_item (Lisp_Object item
, int inmenubar
)
7740 Lisp_Object def
, tem
, item_string
, start
;
7742 Lisp_Object keyhint
;
7751 /* Create item_properties vector if necessary. */
7752 if (NILP (item_properties
))
7754 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7756 /* Initialize optional entries. */
7757 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7758 ASET (item_properties
, i
, Qnil
);
7759 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7761 /* Save the item here to protect it from GC. */
7762 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7764 item_string
= XCAR (item
);
7768 if (STRINGP (item_string
))
7770 /* Old format menu item. */
7771 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7773 /* Maybe help string. */
7774 if (CONSP (item
) && STRINGP (XCAR (item
)))
7776 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7781 /* Maybe an obsolete key binding cache. */
7782 if (CONSP (item
) && CONSP (XCAR (item
))
7783 && (NILP (XCAR (XCAR (item
)))
7784 || VECTORP (XCAR (XCAR (item
)))))
7787 /* This is the real definition--the function to run. */
7788 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7790 /* Get enable property, if any. */
7793 tem
= Fget (item
, Qmenu_enable
);
7794 if (!NILP (Venable_disabled_menus_and_buttons
))
7795 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7796 else if (!NILP (tem
))
7797 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7800 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7802 /* New format menu item. */
7803 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7804 start
= XCDR (item
);
7807 /* We have a real binding. */
7808 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7810 item
= XCDR (start
);
7811 /* Is there an obsolete cache list with key equivalences. */
7812 if (CONSP (item
) && CONSP (XCAR (item
)))
7815 /* Parse properties. */
7816 while (CONSP (item
) && CONSP (XCDR (item
)))
7821 if (EQ (tem
, QCenable
))
7823 if (!NILP (Venable_disabled_menus_and_buttons
))
7824 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7826 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7828 else if (EQ (tem
, QCvisible
))
7830 /* If got a visible property and that evaluates to nil
7831 then ignore this item. */
7832 tem
= menu_item_eval_property (XCAR (item
));
7836 else if (EQ (tem
, QChelp
))
7837 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7838 else if (EQ (tem
, QCfilter
))
7840 else if (EQ (tem
, QCkey_sequence
))
7843 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7844 /* Be GC protected. Set keyhint to item instead of tem. */
7847 else if (EQ (tem
, QCkeys
))
7850 if (CONSP (tem
) || STRINGP (tem
))
7851 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7853 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7858 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7860 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7862 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7868 else if (inmenubar
|| !NILP (start
))
7872 return 0; /* not a menu item */
7874 /* If item string is not a string, evaluate it to get string.
7875 If we don't get a string, skip this item. */
7876 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7877 if (!(STRINGP (item_string
)))
7879 item_string
= menu_item_eval_property (item_string
);
7880 if (!STRINGP (item_string
))
7882 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7885 /* If got a filter apply it on definition. */
7886 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7889 def
= menu_item_eval_property (list2 (XCAR (filter
),
7890 list2 (Qquote
, def
)));
7892 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7895 /* Enable or disable selection of item. */
7896 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7899 tem
= menu_item_eval_property (tem
);
7900 if (inmenubar
&& NILP (tem
))
7901 return 0; /* Ignore disabled items in menu bar. */
7902 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7905 /* If we got no definition, this item is just unselectable text which
7906 is OK in a submenu but not in the menubar. */
7908 return (inmenubar
? 0 : 1);
7910 /* See if this is a separate pane or a submenu. */
7911 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7912 tem
= get_keymap (def
, 0, 1);
7913 /* For a subkeymap, just record its details and exit. */
7916 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7917 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7921 /* At the top level in the menu bar, do likewise for commands also.
7922 The menu bar does not display equivalent key bindings anyway.
7923 ITEM_PROPERTY_DEF is already set up properly. */
7927 { /* This is a command. See if there is an equivalent key binding. */
7928 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7930 /* The previous code preferred :key-sequence to :keys, so we
7931 preserve this behavior. */
7932 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7933 keyeq
= Fsubstitute_command_keys (keyeq
);
7936 Lisp_Object prefix
= keyeq
;
7937 Lisp_Object keys
= Qnil
;
7941 def
= XCAR (prefix
);
7942 prefix
= XCDR (prefix
);
7945 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7947 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7949 keys
= XCAR (keyhint
);
7950 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7952 /* We have a suggested key. Is it bound to the command? */
7955 /* If the command is an alias for another
7956 (such as lmenu.el set it up), check if the
7957 original command matches the cached command. */
7958 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7963 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7967 tem
= Fkey_description (keys
, Qnil
);
7970 if (STRINGP (XCAR (prefix
)))
7971 tem
= concat2 (XCAR (prefix
), tem
);
7972 if (STRINGP (XCDR (prefix
)))
7973 tem
= concat2 (tem
, XCDR (prefix
));
7975 keyeq
= concat2 (build_string (" "), tem
);
7976 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7982 /* If we have an equivalent key binding, use that. */
7983 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7986 /* Include this when menu help is implemented.
7987 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7988 if (!(NILP (tem) || STRINGP (tem)))
7990 tem = menu_item_eval_property (tem);
7993 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7997 /* Handle radio buttons or toggle boxes. */
7998 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8000 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8001 menu_item_eval_property (tem
));
8008 /***********************************************************************
8010 ***********************************************************************/
8012 /* A vector holding tool bar items while they are parsed in function
8013 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8016 static Lisp_Object tool_bar_items_vector
;
8018 /* A vector holding the result of parse_tool_bar_item. Layout is like
8019 the one for a single item in tool_bar_items_vector. */
8021 static Lisp_Object tool_bar_item_properties
;
8023 /* Next free index in tool_bar_items_vector. */
8025 static int ntool_bar_items
;
8027 /* The symbols `:image' and `:rtl'. */
8029 Lisp_Object QCimage
;
8032 /* Function prototypes. */
8034 static void init_tool_bar_items (Lisp_Object
);
8035 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8036 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8037 static void append_tool_bar_item (void);
8040 /* Return a vector of tool bar items for keymaps currently in effect.
8041 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8042 tool bar items found. */
8045 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8054 /* In order to build the menus, we need to call the keymap
8055 accessors. They all call QUIT. But this function is called
8056 during redisplay, during which a quit is fatal. So inhibit
8057 quitting while building the menus. We do this instead of
8058 specbind because (1) errors will clear it anyway and (2) this
8059 avoids risk of specpdl overflow. */
8060 oquit
= Vinhibit_quit
;
8063 /* Initialize tool_bar_items_vector and protect it from GC. */
8064 init_tool_bar_items (reuse
);
8066 /* Build list of keymaps in maps. Set nmaps to the number of maps
8069 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8070 if (!NILP (Voverriding_local_map_menu_flag
))
8072 /* Yes, use them (if non-nil) as well as the global map. */
8073 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8075 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8076 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8077 if (!NILP (Voverriding_local_map
))
8078 maps
[nmaps
++] = Voverriding_local_map
;
8082 /* No, so use major and minor mode keymaps and keymap property.
8083 Note that tool-bar bindings in the local-map and keymap
8084 properties may not work reliable, as they are only
8085 recognized when the tool-bar (or mode-line) is updated,
8086 which does not normally happen after every command. */
8089 nminor
= current_minor_maps (NULL
, &tmaps
);
8090 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8092 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8093 maps
[nmaps
++] = tem
;
8094 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8096 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8099 /* Add global keymap at the end. */
8100 maps
[nmaps
++] = current_global_map
;
8102 /* Process maps in reverse order and look up in each map the prefix
8104 for (i
= nmaps
- 1; i
>= 0; --i
)
8105 if (!NILP (maps
[i
]))
8109 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8111 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8114 Vinhibit_quit
= oquit
;
8115 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8116 return tool_bar_items_vector
;
8120 /* Process the definition of KEY which is DEF. */
8123 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8126 struct gcpro gcpro1
, gcpro2
;
8128 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8132 if (EQ (def
, Qundefined
))
8134 /* If a map has an explicit `undefined' as definition,
8135 discard any previously made item. */
8136 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8138 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8140 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8142 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8143 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8144 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8145 * sizeof (Lisp_Object
)));
8146 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8151 else if (parse_tool_bar_item (key
, def
))
8152 /* Append a new tool bar item to tool_bar_items_vector. Accept
8153 more than one definition for the same key. */
8154 append_tool_bar_item ();
8160 /* Parse a tool bar item specification ITEM for key KEY and return the
8161 result in tool_bar_item_properties. Value is zero if ITEM is
8164 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8166 CAPTION is the caption of the item, If it's not a string, it is
8167 evaluated to get a string.
8169 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8170 as binding are currently ignored.
8172 The following properties are recognized:
8176 FORM is evaluated and specifies whether the tool bar item is
8177 enabled or disabled.
8181 FORM is evaluated and specifies whether the tool bar item is visible.
8183 - `:filter FUNCTION'
8185 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8186 result is stored as the new binding.
8188 - `:button (TYPE SELECTED)'
8190 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8191 and specifies whether the button is selected (pressed) or not.
8195 IMAGES is either a single image specification or a vector of four
8196 image specifications. See enum tool_bar_item_images.
8198 - `:help HELP-STRING'.
8200 Gives a help string to display for the tool bar item.
8202 - `:label LABEL-STRING'.
8204 A text label to show with the tool bar button if labels are enabled. */
8207 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8209 /* Access slot with index IDX of vector tool_bar_item_properties. */
8210 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8212 Lisp_Object filter
= Qnil
;
8213 Lisp_Object caption
;
8214 int i
, have_label
= 0;
8216 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8217 Rule out items that aren't lists, don't start with
8218 `menu-item' or whose rest following `tool-bar-item' is not a
8221 || !EQ (XCAR (item
), Qmenu_item
)
8222 || (item
= XCDR (item
),
8226 /* Create tool_bar_item_properties vector if necessary. Reset it to
8228 if (VECTORP (tool_bar_item_properties
))
8230 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8234 tool_bar_item_properties
8235 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8238 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8239 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8241 /* Get the caption of the item. If the caption is not a string,
8242 evaluate it to get a string. If we don't get a string, skip this
8244 caption
= XCAR (item
);
8245 if (!STRINGP (caption
))
8247 caption
= menu_item_eval_property (caption
);
8248 if (!STRINGP (caption
))
8251 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8253 /* Give up if rest following the caption is not a list. */
8258 /* Store the binding. */
8259 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8262 /* Ignore cached key binding, if any. */
8263 if (CONSP (item
) && CONSP (XCAR (item
)))
8266 /* Process the rest of the properties. */
8267 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8269 Lisp_Object key
, value
;
8272 value
= XCAR (XCDR (item
));
8274 if (EQ (key
, QCenable
))
8276 /* `:enable FORM'. */
8277 if (!NILP (Venable_disabled_menus_and_buttons
))
8278 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8280 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8282 else if (EQ (key
, QCvisible
))
8284 /* `:visible FORM'. If got a visible property and that
8285 evaluates to nil then ignore this item. */
8286 if (NILP (menu_item_eval_property (value
)))
8289 else if (EQ (key
, QChelp
))
8290 /* `:help HELP-STRING'. */
8291 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8292 else if (EQ (key
, QClabel
))
8294 const char *bad_label
= "!!?GARBLED ITEM?!!";
8295 /* `:label LABEL-STRING'. */
8296 PROP (TOOL_BAR_ITEM_LABEL
) = STRINGP (value
)
8298 : make_string (bad_label
, strlen (bad_label
));
8301 else if (EQ (key
, QCfilter
))
8302 /* ':filter FORM'. */
8304 else if (EQ (key
, QCbutton
) && CONSP (value
))
8306 /* `:button (TYPE . SELECTED)'. */
8307 Lisp_Object type
, selected
;
8309 type
= XCAR (value
);
8310 selected
= XCDR (value
);
8311 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8313 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8314 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8317 else if (EQ (key
, QCimage
)
8319 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8320 /* Value is either a single image specification or a vector
8321 of 4 such specifications for the different button states. */
8322 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8323 else if (EQ (key
, Qrtl
))
8325 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8331 /* Try to make one from caption and key. */
8332 Lisp_Object key
= PROP (TOOL_BAR_ITEM_KEY
);
8333 Lisp_Object capt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8334 const char *label
= SYMBOLP (key
) ? (char *) SDATA (SYMBOL_NAME (key
)) : "";
8335 const char *caption
= STRINGP (capt
) ? (char *) SDATA (capt
) : "";
8336 EMACS_INT max_lbl
= 2 * tool_bar_max_label_size
;
8337 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8338 Lisp_Object new_lbl
;
8339 size_t caption_len
= strlen (caption
);
8341 if (caption_len
<= max_lbl
&& caption
[0] != '\0')
8343 strcpy (buf
, caption
);
8344 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8346 buf
[caption_len
] = '\0';
8347 label
= caption
= buf
;
8350 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8354 strcpy (buf
, label
);
8356 for (i
= 0; buf
[i
] != '\0'; ++i
)
8365 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8366 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8367 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8369 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8373 /* If got a filter apply it on binding. */
8375 PROP (TOOL_BAR_ITEM_BINDING
)
8376 = menu_item_eval_property (list2 (filter
,
8378 PROP (TOOL_BAR_ITEM_BINDING
))));
8380 /* See if the binding is a keymap. Give up if it is. */
8381 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8384 /* Enable or disable selection of item. */
8385 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8386 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8387 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8389 /* Handle radio buttons or toggle boxes. */
8390 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8391 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8392 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8400 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8401 that can be reused. */
8404 init_tool_bar_items (Lisp_Object reuse
)
8406 if (VECTORP (reuse
))
8407 tool_bar_items_vector
= reuse
;
8409 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8410 ntool_bar_items
= 0;
8414 /* Append parsed tool bar item properties from
8415 tool_bar_item_properties */
8418 append_tool_bar_item (void)
8420 Lisp_Object
*to
, *from
;
8422 /* Enlarge tool_bar_items_vector if necessary. */
8423 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8424 >= XVECTOR (tool_bar_items_vector
)->size
)
8425 tool_bar_items_vector
8426 = larger_vector (tool_bar_items_vector
,
8427 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8429 /* Append entries from tool_bar_item_properties to the end of
8430 tool_bar_items_vector. */
8431 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8432 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8433 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8434 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8441 /* Read a character using menus based on maps in the array MAPS.
8442 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8443 Return t if we displayed a menu but the user rejected it.
8445 PREV_EVENT is the previous input event, or nil if we are reading
8446 the first event of a key sequence.
8448 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8449 if we used a mouse menu to read the input, or zero otherwise. If
8450 USED_MOUSE_MENU is null, we don't dereference it.
8452 The prompting is done based on the prompt-string of the map
8453 and the strings associated with various map elements.
8455 This can be done with X menus or with menus put in the minibuf.
8456 These are done in different ways, depending on how the input will be read.
8457 Menus using X are done after auto-saving in read-char, getting the input
8458 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8459 and do auto-saving in the inner call of read_char. */
8462 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8463 int *used_mouse_menu
)
8467 if (used_mouse_menu
)
8468 *used_mouse_menu
= 0;
8470 /* Use local over global Menu maps */
8472 if (! menu_prompting
)
8475 /* Optionally disregard all but the global map. */
8476 if (inhibit_local_menu_bar_menus
)
8478 maps
+= (nmaps
- 1);
8483 /* If we got to this point via a mouse click,
8484 use a real menu for mouse selection. */
8485 if (EVENT_HAS_PARAMETERS (prev_event
)
8486 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8487 && !EQ (XCAR (prev_event
), Qtool_bar
))
8489 /* Display the menu and get the selection. */
8490 Lisp_Object
*realmaps
8491 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8495 /* Use the maps that are not nil. */
8496 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8497 if (!NILP (maps
[mapno
]))
8498 realmaps
[nmaps1
++] = maps
[mapno
];
8500 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8505 record_menu_key (XCAR (value
));
8507 /* If we got multiple events, unread all but
8509 There is no way to prevent those unread events
8510 from showing up later in last_nonmenu_event.
8511 So turn symbol and integer events into lists,
8512 to indicate that they came from a mouse menu,
8513 so that when present in last_nonmenu_event
8514 they won't confuse things. */
8515 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8517 record_menu_key (XCAR (tem
));
8518 if (SYMBOLP (XCAR (tem
))
8519 || INTEGERP (XCAR (tem
)))
8520 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8523 /* If we got more than one event, put all but the first
8524 onto this list to be read later.
8525 Return just the first event now. */
8526 Vunread_command_events
8527 = nconc2 (XCDR (value
), Vunread_command_events
);
8528 value
= XCAR (value
);
8530 else if (NILP (value
))
8532 if (used_mouse_menu
)
8533 *used_mouse_menu
= 1;
8536 #endif /* HAVE_MENUS */
8540 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8541 We make this bigger when necessary, and never free it. */
8542 static char *read_char_minibuf_menu_text
;
8543 /* Size of that buffer. */
8544 static int read_char_minibuf_menu_width
;
8547 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8550 register Lisp_Object name
;
8552 /* FIXME: Use the minibuffer's frame width. */
8553 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8556 Lisp_Object rest
, vector
;
8562 if (! menu_prompting
)
8565 /* Get the menu name from the first map that has one (a prompt string). */
8566 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8568 name
= Fkeymap_prompt (maps
[mapno
]);
8573 /* If we don't have any menus, just read a character normally. */
8574 if (!STRINGP (name
))
8577 /* Make sure we have a big enough buffer for the menu text. */
8578 width
= max (width
, SBYTES (name
));
8579 if (read_char_minibuf_menu_text
== 0)
8581 read_char_minibuf_menu_width
= width
+ 4;
8582 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8584 else if (width
+ 4 > read_char_minibuf_menu_width
)
8586 read_char_minibuf_menu_width
= width
+ 4;
8587 read_char_minibuf_menu_text
8588 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8590 menu
= read_char_minibuf_menu_text
;
8592 /* Prompt string always starts with map's prompt, and a space. */
8593 strcpy (menu
, SDATA (name
));
8594 nlength
= SBYTES (name
);
8595 menu
[nlength
++] = ':';
8596 menu
[nlength
++] = ' ';
8599 /* Start prompting at start of first map. */
8603 /* Present the documented bindings, a line at a time. */
8610 Lisp_Object orig_defn_macro
;
8612 /* Loop over elements of map. */
8617 /* If reached end of map, start at beginning of next map. */
8621 /* At end of last map, wrap around to first map if just starting,
8622 or end this line if already have something on it. */
8626 if (notfirst
|| nobindings
) break;
8631 /* Look at the next element of the map. */
8633 elt
= XVECTOR (vector
)->contents
[idx
];
8635 elt
= Fcar_safe (rest
);
8637 if (idx
< 0 && VECTORP (elt
))
8639 /* If we found a dense table in the keymap,
8640 advanced past it, but start scanning its contents. */
8641 rest
= Fcdr_safe (rest
);
8647 /* An ordinary element. */
8648 Lisp_Object event
, tem
;
8652 event
= Fcar_safe (elt
); /* alist */
8653 elt
= Fcdr_safe (elt
);
8657 XSETINT (event
, idx
); /* vector */
8660 /* Ignore the element if it has no prompt string. */
8661 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8663 /* 1 if the char to type matches the string. */
8665 Lisp_Object upcased_event
, downcased_event
;
8666 Lisp_Object desc
= Qnil
;
8668 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8670 upcased_event
= Fupcase (event
);
8671 downcased_event
= Fdowncase (event
);
8672 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8673 || XINT (downcased_event
) == SREF (s
, 0));
8675 desc
= Fsingle_key_description (event
, Qnil
);
8677 #if 0 /* It is redundant to list the equivalent key bindings because
8678 the prefix is what the user has already typed. */
8680 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8682 /* Insert equivalent keybinding. */
8683 s
= concat2 (s
, tem
);
8686 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8687 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8689 /* Insert button prefix. */
8690 Lisp_Object selected
8691 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8692 if (EQ (tem
, QCradio
))
8693 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8695 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8696 s
= concat2 (tem
, s
);
8700 /* If we have room for the prompt string, add it to this line.
8701 If this is the first on the line, always add it. */
8702 if ((SCHARS (s
) + i
+ 2
8703 + (char_matches
? 0 : SCHARS (desc
) + 3))
8709 /* Punctuate between strings. */
8712 strcpy (menu
+ i
, ", ");
8718 /* If the char to type doesn't match the string's
8719 first char, explicitly show what char to type. */
8722 /* Add as much of string as fits. */
8723 thiswidth
= SCHARS (desc
);
8724 if (thiswidth
+ i
> width
)
8725 thiswidth
= width
- i
;
8726 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8728 strcpy (menu
+ i
, " = ");
8732 /* Add as much of string as fits. */
8733 thiswidth
= SCHARS (s
);
8734 if (thiswidth
+ i
> width
)
8735 thiswidth
= width
- i
;
8736 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8742 /* If this element does not fit, end the line now,
8743 and save the element for the next line. */
8744 strcpy (menu
+ i
, "...");
8749 /* Move past this element. */
8750 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8751 /* Handle reaching end of dense table. */
8756 rest
= Fcdr_safe (rest
);
8760 /* Prompt with that and read response. */
8761 message2_nolog (menu
, strlen (menu
),
8762 ! NILP (current_buffer
->enable_multibyte_characters
));
8764 /* Make believe its not a keyboard macro in case the help char
8765 is pressed. Help characters are not recorded because menu prompting
8766 is not used on replay.
8768 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8769 current_kboard
->defining_kbd_macro
= Qnil
;
8771 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8772 while (BUFFERP (obj
));
8773 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8775 if (!INTEGERP (obj
))
8777 else if (XINT (obj
) == -2)
8782 if (! EQ (obj
, menu_prompt_more_char
)
8783 && (!INTEGERP (menu_prompt_more_char
)
8784 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8786 if (!NILP (current_kboard
->defining_kbd_macro
))
8787 store_kbd_macro_char (obj
);
8790 /* Help char - go round again */
8794 /* Reading key sequences. */
8796 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8797 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8798 keymap, or nil otherwise. Return the index of the first keymap in
8799 which KEY has any binding, or NMAPS if no map has a binding.
8801 If KEY is a meta ASCII character, treat it like meta-prefix-char
8802 followed by the corresponding non-meta character. Keymaps in
8803 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8806 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8809 NEXT may be the same array as CURRENT. */
8812 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8815 int i
, first_binding
;
8817 first_binding
= nmaps
;
8818 for (i
= nmaps
- 1; i
>= 0; i
--)
8820 if (! NILP (current
[i
]))
8822 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8823 if (! NILP (defs
[i
]))
8830 /* Given the set of bindings we've found, produce the next set of maps. */
8831 if (first_binding
< nmaps
)
8832 for (i
= 0; i
< nmaps
; i
++)
8833 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8835 return first_binding
;
8838 /* Structure used to keep track of partial application of key remapping
8839 such as Vfunction_key_map and Vkey_translation_map. */
8840 typedef struct keyremap
8842 /* This is the map originally specified for this use. */
8844 /* This is a submap reached by looking up, in PARENT,
8845 the events from START to END. */
8847 /* Positions [START, END) in the key sequence buffer
8848 are the key that we have scanned so far.
8849 Those events are the ones that we will replace
8850 if PAREHT maps them into a key sequence. */
8854 /* Lookup KEY in MAP.
8855 MAP is a keymap mapping keys to key vectors or functions.
8856 If the mapping is a function and DO_FUNCTION is non-zero, then
8857 the function is called with PROMPT as parameter and its return
8858 value is used as the return value of this function (after checking
8859 that it is indeed a vector). */
8862 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8867 next
= access_keymap (map
, key
, 1, 0, 1);
8869 /* Handle symbol with autoload definition. */
8870 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8871 && CONSP (XSYMBOL (next
)->function
)
8872 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8873 do_autoload (XSYMBOL (next
)->function
, next
);
8875 /* Handle a symbol whose function definition is a keymap
8877 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8878 && (ARRAYP (XSYMBOL (next
)->function
)
8879 || KEYMAPP (XSYMBOL (next
)->function
)))
8880 next
= XSYMBOL (next
)->function
;
8882 /* If the keymap gives a function, not an
8883 array, then call the function with one arg and use
8884 its value instead. */
8885 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8890 next
= call1 (next
, prompt
);
8891 /* If the function returned something invalid,
8892 barf--don't ignore it.
8893 (To ignore it safely, we would need to gcpro a bunch of
8894 other variables.) */
8895 if (! (VECTORP (next
) || STRINGP (next
)))
8896 error ("Function %s returns invalid key sequence", tem
);
8901 /* Do one step of the key remapping used for function-key-map and
8902 key-translation-map:
8903 KEYBUF is the buffer holding the input events.
8904 BUFSIZE is its maximum size.
8905 FKEY is a pointer to the keyremap structure to use.
8906 INPUT is the index of the last element in KEYBUF.
8907 DOIT if non-zero says that the remapping can actually take place.
8908 DIFF is used to return the number of keys added/removed by the remapping.
8909 PARENT is the root of the keymap.
8910 PROMPT is the prompt to use if the remapping happens through a function.
8911 The return value is non-zero if the remapping actually took place. */
8914 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8915 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8917 Lisp_Object next
, key
;
8919 key
= keybuf
[fkey
->end
++];
8921 if (KEYMAPP (fkey
->parent
))
8922 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8926 /* If keybuf[fkey->start..fkey->end] is bound in the
8927 map and we're in a position to do the key remapping, replace it with
8928 the binding and restart with fkey->start at the end. */
8929 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8931 int len
= XFASTINT (Flength (next
));
8934 *diff
= len
- (fkey
->end
- fkey
->start
);
8936 if (input
+ *diff
>= bufsize
)
8937 error ("Key sequence too long");
8939 /* Shift the keys that follow fkey->end. */
8941 for (i
= fkey
->end
; i
< input
; i
++)
8942 keybuf
[i
+ *diff
] = keybuf
[i
];
8944 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8945 keybuf
[i
+ *diff
] = keybuf
[i
];
8946 /* Overwrite the old keys with the new ones. */
8947 for (i
= 0; i
< len
; i
++)
8948 keybuf
[fkey
->start
+ i
]
8949 = Faref (next
, make_number (i
));
8951 fkey
->start
= fkey
->end
+= *diff
;
8952 fkey
->map
= fkey
->parent
;
8957 fkey
->map
= get_keymap (next
, 0, 1);
8959 /* If we no longer have a bound suffix, try a new position for
8961 if (!CONSP (fkey
->map
))
8963 fkey
->end
= ++fkey
->start
;
8964 fkey
->map
= fkey
->parent
;
8969 /* Read a sequence of keys that ends with a non prefix character,
8970 storing it in KEYBUF, a buffer of size BUFSIZE.
8972 Return the length of the key sequence stored.
8973 Return -1 if the user rejected a command menu.
8975 Echo starting immediately unless `prompt' is 0.
8977 Where a key sequence ends depends on the currently active keymaps.
8978 These include any minor mode keymaps active in the current buffer,
8979 the current buffer's local map, and the global map.
8981 If a key sequence has no other bindings, we check Vfunction_key_map
8982 to see if some trailing subsequence might be the beginning of a
8983 function key's sequence. If so, we try to read the whole function
8984 key, and substitute its symbolic name into the key sequence.
8986 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8987 `double-' events into similar click events, if that would make them
8988 bound. We try to turn `triple-' events first into `double-' events,
8991 If we get a mouse click in a mode line, vertical divider, or other
8992 non-text area, we treat the click as if it were prefixed by the
8993 symbol denoting that area - `mode-line', `vertical-line', or
8996 If the sequence starts with a mouse click, we read the key sequence
8997 with respect to the buffer clicked on, not the current buffer.
8999 If the user switches frames in the midst of a key sequence, we put
9000 off the switch-frame event until later; the next call to
9001 read_char will return it.
9003 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9004 from the selected window's buffer. */
9007 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
9008 int dont_downcase_last
, int can_return_switch_frame
,
9009 int fix_current_buffer
)
9011 Lisp_Object from_string
;
9012 int count
= SPECPDL_INDEX ();
9014 /* How many keys there are in the current key sequence. */
9017 /* The length of the echo buffer when we started reading, and
9018 the length of this_command_keys when we started reading. */
9022 /* The number of keymaps we're scanning right now, and the number of
9023 keymaps we have allocated space for. */
9025 int nmaps_allocated
= 0;
9027 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9028 the current keymaps. */
9029 Lisp_Object
*defs
= NULL
;
9031 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9032 in the current keymaps, or nil where it is not a prefix. */
9033 Lisp_Object
*submaps
= NULL
;
9035 /* The local map to start out with at start of key sequence. */
9036 Lisp_Object orig_local_map
;
9038 /* The map from the `keymap' property to start out with at start of
9040 Lisp_Object orig_keymap
;
9042 /* 1 if we have already considered switching to the local-map property
9043 of the place where a mouse click occurred. */
9044 int localized_local_map
= 0;
9046 /* The index in submaps[] of the first keymap that has a binding for
9047 this key sequence. In other words, the lowest i such that
9048 submaps[i] is non-nil. */
9050 /* Index of the first key that has no binding.
9051 It is useless to try fkey.start larger than that. */
9054 /* If t < mock_input, then KEYBUF[t] should be read as the next
9057 We use this to recover after recognizing a function key. Once we
9058 realize that a suffix of the current key sequence is actually a
9059 function key's escape sequence, we replace the suffix with the
9060 function key's binding from Vfunction_key_map. Now keybuf
9061 contains a new and different key sequence, so the echo area,
9062 this_command_keys, and the submaps and defs arrays are wrong. In
9063 this situation, we set mock_input to t, set t to 0, and jump to
9064 restart_sequence; the loop will read keys from keybuf up until
9065 mock_input, thus rebuilding the state; and then it will resume
9066 reading characters from the keyboard. */
9069 /* If the sequence is unbound in submaps[], then
9070 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9071 and fkey.map is its binding.
9073 These might be > t, indicating that all function key scanning
9074 should hold off until t reaches them. We do this when we've just
9075 recognized a function key, to avoid searching for the function
9076 key's again in Vfunction_key_map. */
9079 /* Likewise, for key_translation_map and input-decode-map. */
9080 keyremap keytran
, indec
;
9082 /* Non-zero if we are trying to map a key by changing an upper-case
9083 letter to lower case, or a shifted function key to an unshifted
9085 int shift_translated
= 0;
9087 /* If we receive a `switch-frame' or `select-window' event in the middle of
9088 a key sequence, we put it off for later.
9089 While we're reading, we keep the event here. */
9090 Lisp_Object delayed_switch_frame
;
9092 /* See the comment below... */
9093 #if defined (GOBBLE_FIRST_EVENT)
9094 Lisp_Object first_event
;
9097 Lisp_Object original_uppercase
;
9098 int original_uppercase_position
= -1;
9100 /* Gets around Microsoft compiler limitations. */
9103 struct buffer
*starting_buffer
;
9105 /* List of events for which a fake prefix key has been generated. */
9106 Lisp_Object fake_prefixed_keys
= Qnil
;
9108 #if defined (GOBBLE_FIRST_EVENT)
9112 struct gcpro gcpro1
;
9114 GCPRO1 (fake_prefixed_keys
);
9115 raw_keybuf_count
= 0;
9117 last_nonmenu_event
= Qnil
;
9119 delayed_switch_frame
= Qnil
;
9125 /* Install the string STR as the beginning of the string of
9126 echoing, so that it serves as a prompt for the next
9128 current_kboard
->echo_string
= prompt
;
9129 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9132 else if (cursor_in_echo_area
9133 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9134 && NILP (Fzerop (Vecho_keystrokes
)))
9135 /* This doesn't put in a dash if the echo buffer is empty, so
9136 you don't always see a dash hanging out in the minibuffer. */
9140 /* Record the initial state of the echo area and this_command_keys;
9141 we will need to restore them if we replay a key sequence. */
9143 echo_start
= echo_length ();
9144 keys_start
= this_command_key_count
;
9145 this_single_command_key_start
= keys_start
;
9147 #if defined (GOBBLE_FIRST_EVENT)
9148 /* This doesn't quite work, because some of the things that read_char
9149 does cannot safely be bypassed. It seems too risky to try to make
9152 /* Read the first char of the sequence specially, before setting
9153 up any keymaps, in case a filter runs and switches buffers on us. */
9154 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9156 #endif /* GOBBLE_FIRST_EVENT */
9158 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9159 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9162 /* We jump here when we need to reinitialize fkey and keytran; this
9163 happens if we switch keyboards between rescans. */
9164 replay_entire_sequence
:
9166 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9167 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9168 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9169 indec
.start
= indec
.end
= 0;
9170 fkey
.start
= fkey
.end
= 0;
9171 keytran
.start
= keytran
.end
= 0;
9173 /* We jump here when the key sequence has been thoroughly changed, and
9174 we need to rescan it starting from the beginning. When we jump here,
9175 keybuf[0..mock_input] holds the sequence we should reread. */
9178 starting_buffer
= current_buffer
;
9179 first_unbound
= bufsize
+ 1;
9181 /* Build our list of keymaps.
9182 If we recognize a function key and replace its escape sequence in
9183 keybuf with its symbol, or if the sequence starts with a mouse
9184 click and we need to switch buffers, we jump back here to rebuild
9185 the initial keymaps from the current buffer. */
9188 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9190 if (2 > nmaps_allocated
)
9192 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9193 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9194 nmaps_allocated
= 2;
9196 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9198 else if (!NILP (Voverriding_local_map
))
9200 if (2 > nmaps_allocated
)
9202 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9203 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9204 nmaps_allocated
= 2;
9206 submaps
[nmaps
++] = Voverriding_local_map
;
9214 nminor
= current_minor_maps (0, &maps
);
9215 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9217 if (total
> nmaps_allocated
)
9219 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9220 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9221 nmaps_allocated
= total
;
9224 if (!NILP (orig_keymap
))
9225 submaps
[nmaps
++] = orig_keymap
;
9227 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9231 submaps
[nmaps
++] = orig_local_map
;
9233 submaps
[nmaps
++] = current_global_map
;
9235 /* Find an accurate initial value for first_binding. */
9236 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9237 if (! NILP (submaps
[first_binding
]))
9240 /* Start from the beginning in keybuf. */
9243 /* These are no-ops the first time through, but if we restart, they
9244 revert the echo area and this_command_keys to their original state. */
9245 this_command_key_count
= keys_start
;
9246 if (INTERACTIVE
&& t
< mock_input
)
9247 echo_truncate (echo_start
);
9249 /* If the best binding for the current key sequence is a keymap, or
9250 we may be looking at a function key's escape sequence, keep on
9252 while (first_binding
< nmaps
9253 /* Keep reading as long as there's a prefix binding. */
9254 ? !NILP (submaps
[first_binding
])
9255 /* Don't return in the middle of a possible function key sequence,
9256 if the only bindings we found were via case conversion.
9257 Thus, if ESC O a has a function-key-map translation
9258 and ESC o has a binding, don't return after ESC O,
9259 so that we can translate ESC O plus the next character. */
9260 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9263 int used_mouse_menu
= 0;
9265 /* Where the last real key started. If we need to throw away a
9266 key that has expanded into more than one element of keybuf
9267 (say, a mouse click on the mode line which is being treated
9268 as [mode-line (mouse-...)], then we backtrack to this point
9270 int last_real_key_start
;
9272 /* These variables are analogous to echo_start and keys_start;
9273 while those allow us to restart the entire key sequence,
9274 echo_local_start and keys_local_start allow us to throw away
9276 int echo_local_start
, keys_local_start
, local_first_binding
;
9278 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9279 eassert (indec
.start
<= indec
.end
);
9280 eassert (fkey
.start
<= fkey
.end
);
9281 eassert (keytran
.start
<= keytran
.end
);
9282 /* key-translation-map is applied *after* function-key-map
9283 which is itself applied *after* input-decode-map. */
9284 eassert (fkey
.end
<= indec
.start
);
9285 eassert (keytran
.end
<= fkey
.start
);
9287 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9288 first_unbound
< keytran
.start
)
9289 { /* The prefix upto first_unbound has no binding and has
9290 no translation left to do either, so we know it's unbound.
9291 If we don't stop now, we risk staying here indefinitely
9292 (if the user keeps entering fkey or keytran prefixes
9293 like C-c ESC ESC ESC ESC ...) */
9295 for (i
= first_unbound
+ 1; i
< t
; i
++)
9296 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9297 mock_input
= t
- first_unbound
- 1;
9298 indec
.end
= indec
.start
-= first_unbound
+ 1;
9299 indec
.map
= indec
.parent
;
9300 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9301 fkey
.map
= fkey
.parent
;
9302 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9303 keytran
.map
= keytran
.parent
;
9304 goto replay_sequence
;
9308 error ("Key sequence too long");
9311 echo_local_start
= echo_length ();
9312 keys_local_start
= this_command_key_count
;
9313 local_first_binding
= first_binding
;
9316 /* These are no-ops, unless we throw away a keystroke below and
9317 jumped back up to replay_key; in that case, these restore the
9318 variables to their original state, allowing us to replay the
9320 if (INTERACTIVE
&& t
< mock_input
)
9321 echo_truncate (echo_local_start
);
9322 this_command_key_count
= keys_local_start
;
9323 first_binding
= local_first_binding
;
9325 /* By default, assume each event is "real". */
9326 last_real_key_start
= t
;
9328 /* Does mock_input indicate that we are re-reading a key sequence? */
9332 add_command_key (key
);
9333 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9334 && NILP (Fzerop (Vecho_keystrokes
)))
9338 /* If not, we should actually read a character. */
9342 KBOARD
*interrupted_kboard
= current_kboard
;
9343 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9344 key
= read_char (NILP (prompt
), nmaps
,
9345 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9346 &used_mouse_menu
, NULL
);
9347 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9348 /* When switching to a new tty (with a new keyboard),
9349 read_char returns the new buffer, rather than -2
9350 (Bug#5095). This is because `terminal-init-xterm'
9351 calls read-char, which eats the wrong_kboard_jmpbuf
9352 return. Any better way to fix this? -- cyd */
9353 || (interrupted_kboard
!= current_kboard
))
9358 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9359 if (k
== interrupted_kboard
)
9364 /* Don't touch interrupted_kboard when it's been
9366 delayed_switch_frame
= Qnil
;
9367 goto replay_entire_sequence
;
9370 if (!NILP (delayed_switch_frame
))
9372 interrupted_kboard
->kbd_queue
9373 = Fcons (delayed_switch_frame
,
9374 interrupted_kboard
->kbd_queue
);
9375 delayed_switch_frame
= Qnil
;
9379 interrupted_kboard
->kbd_queue
9380 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9382 /* If the side queue is non-empty, ensure it begins with a
9383 switch-frame, so we'll replay it in the right context. */
9384 if (CONSP (interrupted_kboard
->kbd_queue
)
9385 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9386 !(EVENT_HAS_PARAMETERS (key
)
9387 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9391 XSETFRAME (frame
, interrupted_frame
);
9392 interrupted_kboard
->kbd_queue
9393 = Fcons (make_lispy_switch_frame (frame
),
9394 interrupted_kboard
->kbd_queue
);
9397 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9398 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9399 goto replay_entire_sequence
;
9403 /* read_char returns t when it shows a menu and the user rejects it.
9407 unbind_to (count
, Qnil
);
9412 /* read_char returns -1 at the end of a macro.
9413 Emacs 18 handles this by returning immediately with a
9414 zero, so that's what we'll do. */
9415 if (INTEGERP (key
) && XINT (key
) == -1)
9418 /* The Microsoft C compiler can't handle the goto that
9424 /* If the current buffer has been changed from under us, the
9425 keymap may have changed, so replay the sequence. */
9428 timer_resume_idle ();
9431 /* Reset the current buffer from the selected window
9432 in case something changed the former and not the latter.
9433 This is to be more consistent with the behavior
9434 of the command_loop_1. */
9435 if (fix_current_buffer
)
9437 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9439 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9440 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9443 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9444 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9445 goto replay_sequence
;
9448 /* If we have a quit that was typed in another frame, and
9449 quit_throw_to_read_char switched buffers,
9450 replay to get the right keymap. */
9452 && XINT (key
) == quit_char
9453 && current_buffer
!= starting_buffer
)
9456 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9460 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9461 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9462 goto replay_sequence
;
9467 if (EVENT_HAS_PARAMETERS (key
)
9468 /* Either a `switch-frame' or a `select-window' event. */
9469 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9471 /* If we're at the beginning of a key sequence, and the caller
9472 says it's okay, go ahead and return this event. If we're
9473 in the midst of a key sequence, delay it until the end. */
9474 if (t
> 0 || !can_return_switch_frame
)
9476 delayed_switch_frame
= key
;
9482 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9486 /* Clicks in non-text areas get prefixed by the symbol
9487 in their CHAR-ADDRESS field. For example, a click on
9488 the mode line is prefixed by the symbol `mode-line'.
9490 Furthermore, key sequences beginning with mouse clicks
9491 are read using the keymaps of the buffer clicked on, not
9492 the current buffer. So we may have to switch the buffer
9495 When we turn one event into two events, we must make sure
9496 that neither of the two looks like the original--so that,
9497 if we replay the events, they won't be expanded again.
9498 If not for this, such reexpansion could happen either here
9499 or when user programs play with this-command-keys. */
9500 if (EVENT_HAS_PARAMETERS (key
))
9505 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9506 if (EQ (kind
, Qmouse_click
))
9508 Lisp_Object window
, posn
;
9510 window
= POSN_WINDOW (EVENT_START (key
));
9511 posn
= POSN_POSN (EVENT_START (key
));
9514 || (!NILP (fake_prefixed_keys
)
9515 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9517 /* We're looking a second time at an event for which
9518 we generated a fake prefix key. Set
9519 last_real_key_start appropriately. */
9521 last_real_key_start
= t
- 1;
9524 /* Key sequences beginning with mouse clicks are
9525 read using the keymaps in the buffer clicked on,
9526 not the current buffer. If we're at the
9527 beginning of a key sequence, switch buffers. */
9528 if (last_real_key_start
== 0
9530 && BUFFERP (XWINDOW (window
)->buffer
)
9531 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9533 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9537 /* Arrange to go back to the original buffer once we're
9538 done reading the key sequence. Note that we can't
9539 use save_excursion_{save,restore} here, because they
9540 save point as well as the current buffer; we don't
9541 want to save point, because redisplay may change it,
9542 to accommodate a Fset_window_start or something. We
9543 don't want to do this at the top of the function,
9544 because we may get input from a subprocess which
9545 wants to change the selected window and stuff (say,
9547 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9549 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9551 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9552 orig_local_map
= get_local_map (PT
, current_buffer
,
9554 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9555 goto replay_sequence
;
9558 /* For a mouse click, get the local text-property keymap
9559 of the place clicked on, rather than point. */
9560 if (last_real_key_start
== 0
9561 && CONSP (XCDR (key
))
9562 && ! localized_local_map
)
9564 Lisp_Object map_here
, start
, pos
;
9566 localized_local_map
= 1;
9567 start
= EVENT_START (key
);
9569 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9571 pos
= POSN_BUFFER_POSN (start
);
9573 && XINT (pos
) >= BEGV
9574 && XINT (pos
) <= ZV
)
9576 map_here
= get_local_map (XINT (pos
),
9577 current_buffer
, Qlocal_map
);
9578 if (!EQ (map_here
, orig_local_map
))
9580 orig_local_map
= map_here
;
9581 ++localized_local_map
;
9584 map_here
= get_local_map (XINT (pos
),
9585 current_buffer
, Qkeymap
);
9586 if (!EQ (map_here
, orig_keymap
))
9588 orig_keymap
= map_here
;
9589 ++localized_local_map
;
9592 if (localized_local_map
> 1)
9597 goto replay_sequence
;
9603 /* Expand mode-line and scroll-bar events into two events:
9604 use posn as a fake prefix key. */
9606 && (NILP (fake_prefixed_keys
)
9607 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9609 if (t
+ 1 >= bufsize
)
9610 error ("Key sequence too long");
9613 keybuf
[t
+ 1] = key
;
9616 /* Record that a fake prefix key has been generated
9617 for KEY. Don't modify the event; this would
9618 prevent proper action when the event is pushed
9619 back into unread-command-events. */
9620 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9622 /* If on a mode line string with a local keymap,
9623 reconsider the key sequence with that keymap. */
9624 if (string
= POSN_STRING (EVENT_START (key
)),
9625 (CONSP (string
) && STRINGP (XCAR (string
))))
9627 Lisp_Object pos
, map
, map2
;
9629 pos
= XCDR (string
);
9630 string
= XCAR (string
);
9632 && XINT (pos
) < SCHARS (string
))
9634 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9636 orig_local_map
= map
;
9637 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9640 if (!NILP (map
) || !NILP (map2
))
9641 goto replay_sequence
;
9647 else if (NILP (from_string
)
9648 && (string
= POSN_STRING (EVENT_START (key
)),
9649 (CONSP (string
) && STRINGP (XCAR (string
)))))
9651 /* For a click on a string, i.e. overlay string or a
9652 string displayed via the `display' property,
9653 consider `local-map' and `keymap' properties of
9655 Lisp_Object pos
, map
, map2
;
9657 pos
= XCDR (string
);
9658 string
= XCAR (string
);
9660 && XINT (pos
) < SCHARS (string
))
9662 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9664 orig_local_map
= map
;
9665 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9669 if (!NILP (map
) || !NILP (map2
))
9671 from_string
= string
;
9674 goto replay_sequence
;
9679 else if (CONSP (XCDR (key
))
9680 && CONSP (EVENT_START (key
))
9681 && CONSP (XCDR (EVENT_START (key
))))
9685 posn
= POSN_POSN (EVENT_START (key
));
9686 /* Handle menu-bar events:
9687 insert the dummy prefix event `menu-bar'. */
9688 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9690 if (t
+ 1 >= bufsize
)
9691 error ("Key sequence too long");
9695 /* Zap the position in key, so we know that we've
9696 expanded it, and don't try to do so again. */
9697 POSN_SET_POSN (EVENT_START (key
),
9698 Fcons (posn
, Qnil
));
9701 goto replay_sequence
;
9703 else if (CONSP (posn
))
9705 /* We're looking at the second event of a
9706 sequence which we expanded before. Set
9707 last_real_key_start appropriately. */
9708 if (last_real_key_start
== t
&& t
> 0)
9709 last_real_key_start
= t
- 1;
9714 /* We have finally decided that KEY is something we might want
9716 first_binding
= (follow_key (key
,
9717 nmaps
- first_binding
,
9718 submaps
+ first_binding
,
9719 defs
+ first_binding
,
9720 submaps
+ first_binding
)
9723 /* If KEY wasn't bound, we'll try some fallbacks. */
9724 if (first_binding
< nmaps
)
9725 /* This is needed for the following scenario:
9726 event 0: a down-event that gets dropped by calling replay_key.
9727 event 1: some normal prefix like C-h.
9728 After event 0, first_unbound is 0, after event 1 indec.start,
9729 fkey.start, and keytran.start are all 1, so when we see that
9730 C-h is bound, we need to update first_unbound. */
9731 first_unbound
= max (t
+ 1, first_unbound
);
9736 /* Remember the position to put an upper bound on indec.start. */
9737 first_unbound
= min (t
, first_unbound
);
9739 head
= EVENT_HEAD (key
);
9740 if (help_char_p (head
) && t
> 0)
9742 read_key_sequence_cmd
= Vprefix_help_command
;
9744 last_nonmenu_event
= key
;
9745 /* The Microsoft C compiler can't handle the goto that
9753 Lisp_Object breakdown
;
9756 breakdown
= parse_modifiers (head
);
9757 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9758 /* Attempt to reduce an unbound mouse event to a simpler
9759 event that is bound:
9760 Drags reduce to clicks.
9761 Double-clicks reduce to clicks.
9762 Triple-clicks reduce to double-clicks, then to clicks.
9763 Down-clicks are eliminated.
9764 Double-downs reduce to downs, then are eliminated.
9765 Triple-downs reduce to double-downs, then to downs,
9766 then are eliminated. */
9767 if (modifiers
& (down_modifier
| drag_modifier
9768 | double_modifier
| triple_modifier
))
9770 while (modifiers
& (down_modifier
| drag_modifier
9771 | double_modifier
| triple_modifier
))
9773 Lisp_Object new_head
, new_click
;
9774 if (modifiers
& triple_modifier
)
9775 modifiers
^= (double_modifier
| triple_modifier
);
9776 else if (modifiers
& double_modifier
)
9777 modifiers
&= ~double_modifier
;
9778 else if (modifiers
& drag_modifier
)
9779 modifiers
&= ~drag_modifier
;
9782 /* Dispose of this `down' event by simply jumping
9783 back to replay_key, to get another event.
9785 Note that if this event came from mock input,
9786 then just jumping back to replay_key will just
9787 hand it to us again. So we have to wipe out any
9790 We could delete keybuf[t] and shift everything
9791 after that to the left by one spot, but we'd also
9792 have to fix up any variable that points into
9793 keybuf, and shifting isn't really necessary
9796 Adding prefixes for non-textual mouse clicks
9797 creates two characters of mock input, and both
9798 must be thrown away. If we're only looking at
9799 the prefix now, we can just jump back to
9800 replay_key. On the other hand, if we've already
9801 processed the prefix, and now the actual click
9802 itself is giving us trouble, then we've lost the
9803 state of the keymaps we want to backtrack to, and
9804 we need to replay the whole sequence to rebuild
9807 Beyond that, only function key expansion could
9808 create more than two keys, but that should never
9809 generate mouse events, so it's okay to zero
9810 mock_input in that case too.
9812 FIXME: The above paragraph seems just plain
9813 wrong, if you consider things like
9814 xterm-mouse-mode. -stef
9816 Isn't this just the most wonderful code ever? */
9818 /* If mock_input > t + 1, the above simplification
9819 will actually end up dropping keys on the floor.
9820 This is probably OK for now, but even
9821 if mock_input <= t + 1, we need to adjust indec,
9823 Typical case [header-line down-mouse-N]:
9824 mock_input = 2, t = 1, fkey.end = 1,
9825 last_real_key_start = 0. */
9826 if (indec
.end
> last_real_key_start
)
9828 indec
.end
= indec
.start
9829 = min (last_real_key_start
, indec
.start
);
9830 indec
.map
= indec
.parent
;
9831 if (fkey
.end
> last_real_key_start
)
9833 fkey
.end
= fkey
.start
9834 = min (last_real_key_start
, fkey
.start
);
9835 fkey
.map
= fkey
.parent
;
9836 if (keytran
.end
> last_real_key_start
)
9838 keytran
.end
= keytran
.start
9839 = min (last_real_key_start
, keytran
.start
);
9840 keytran
.map
= keytran
.parent
;
9844 if (t
== last_real_key_start
)
9851 mock_input
= last_real_key_start
;
9852 goto replay_sequence
;
9857 = apply_modifiers (modifiers
, XCAR (breakdown
));
9859 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9861 /* Look for a binding for this new key. follow_key
9862 promises that it didn't munge submaps the
9863 last time we called it, since key was unbound. */
9865 = (follow_key (new_click
,
9866 nmaps
- local_first_binding
,
9867 submaps
+ local_first_binding
,
9868 defs
+ local_first_binding
,
9869 submaps
+ local_first_binding
)
9870 + local_first_binding
);
9872 /* If that click is bound, go for it. */
9873 if (first_binding
< nmaps
)
9878 /* Otherwise, we'll leave key set to the drag event. */
9885 /* Normally, last_nonmenu_event gets the previous key we read.
9886 But when a mouse popup menu is being used,
9887 we don't update last_nonmenu_event; it continues to hold the mouse
9888 event that preceded the first level of menu. */
9889 if (!used_mouse_menu
)
9890 last_nonmenu_event
= key
;
9892 /* Record what part of this_command_keys is the current key sequence. */
9893 this_single_command_key_start
= this_command_key_count
- t
;
9895 /* Look for this sequence in input-decode-map.
9896 Scan from indec.end until we find a bound suffix. */
9897 while (indec
.end
< t
)
9899 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9902 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9903 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9908 mock_input
= diff
+ max (t
, mock_input
);
9909 goto replay_sequence
;
9913 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9914 && indec
.start
>= t
)
9915 /* There is a binding and it's not a prefix.
9916 (and it doesn't have any input-decode-map translation pending).
9917 There is thus no function-key in this sequence.
9918 Moving fkey.start is important in this case to allow keytran.start
9919 to go over the sequence before we return (since we keep the
9920 invariant that keytran.end <= fkey.start). */
9923 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9926 /* If the sequence is unbound, see if we can hang a function key
9927 off the end of it. */
9928 /* Continue scan from fkey.end until we find a bound suffix. */
9929 while (fkey
.end
< indec
.start
)
9931 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9934 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9935 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9936 max (t
, mock_input
),
9937 /* If there's a binding (i.e.
9938 first_binding >= nmaps) we don't want
9939 to apply this function-key-mapping. */
9940 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9945 mock_input
= diff
+ max (t
, mock_input
);
9946 /* Adjust the input-decode-map counters. */
9948 indec
.start
+= diff
;
9950 goto replay_sequence
;
9954 /* Look for this sequence in key-translation-map.
9955 Scan from keytran.end until we find a bound suffix. */
9956 while (keytran
.end
< fkey
.start
)
9958 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9961 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9962 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9967 mock_input
= diff
+ max (t
, mock_input
);
9968 /* Adjust the function-key-map and input-decode-map counters. */
9970 indec
.start
+= diff
;
9974 goto replay_sequence
;
9978 /* If KEY is not defined in any of the keymaps,
9979 and cannot be part of a function key or translation,
9980 and is an upper case letter
9981 use the corresponding lower-case letter instead. */
9982 if (first_binding
>= nmaps
9983 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9985 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9986 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9987 || (XINT (key
) & shift_modifier
)))
9989 Lisp_Object new_key
;
9991 original_uppercase
= key
;
9992 original_uppercase_position
= t
- 1;
9994 if (XINT (key
) & shift_modifier
)
9995 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9997 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9998 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10000 /* We have to do this unconditionally, regardless of whether
10001 the lower-case char is defined in the keymaps, because they
10002 might get translated through function-key-map. */
10003 keybuf
[t
- 1] = new_key
;
10004 mock_input
= max (t
, mock_input
);
10005 shift_translated
= 1;
10007 goto replay_sequence
;
10009 /* If KEY is not defined in any of the keymaps,
10010 and cannot be part of a function key or translation,
10011 and is a shifted function key,
10012 use the corresponding unshifted function key instead. */
10013 if (first_binding
>= nmaps
10014 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10016 Lisp_Object breakdown
= parse_modifiers (key
);
10018 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10020 if (modifiers
& shift_modifier
10021 /* Treat uppercase keys as shifted. */
10023 && (KEY_TO_CHAR (key
)
10024 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10025 && UPPERCASEP (KEY_TO_CHAR (key
))))
10027 Lisp_Object new_key
10028 = (modifiers
& shift_modifier
10029 ? apply_modifiers (modifiers
& ~shift_modifier
,
10031 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10033 original_uppercase
= key
;
10034 original_uppercase_position
= t
- 1;
10036 /* We have to do this unconditionally, regardless of whether
10037 the lower-case char is defined in the keymaps, because they
10038 might get translated through function-key-map. */
10039 keybuf
[t
- 1] = new_key
;
10040 mock_input
= max (t
, mock_input
);
10041 /* Reset fkey (and consequently keytran) to apply
10042 function-key-map on the result, so that S-backspace is
10043 correctly mapped to DEL (via backspace). OTOH,
10044 input-decode-map doesn't need to go through it again. */
10045 fkey
.start
= fkey
.end
= 0;
10046 keytran
.start
= keytran
.end
= 0;
10047 shift_translated
= 1;
10049 goto replay_sequence
;
10054 read_key_sequence_cmd
= (first_binding
< nmaps
10055 ? defs
[first_binding
]
10058 unread_switch_frame
= delayed_switch_frame
;
10059 unbind_to (count
, Qnil
);
10061 /* Don't downcase the last character if the caller says don't.
10062 Don't downcase it if the result is undefined, either. */
10063 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10065 && t
- 1 == original_uppercase_position
)
10067 keybuf
[t
- 1] = original_uppercase
;
10068 shift_translated
= 0;
10071 if (shift_translated
)
10072 Vthis_command_keys_shift_translated
= Qt
;
10074 /* Occasionally we fabricate events, perhaps by expanding something
10075 according to function-key-map, or by adding a prefix symbol to a
10076 mouse click in the scroll bar or modeline. In this cases, return
10077 the entire generated key sequence, even if we hit an unbound
10078 prefix or a definition before the end. This means that you will
10079 be able to push back the event properly, and also means that
10080 read-key-sequence will always return a logical unit.
10083 for (; t
< mock_input
; t
++)
10085 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10086 && NILP (Fzerop (Vecho_keystrokes
)))
10087 echo_char (keybuf
[t
]);
10088 add_command_key (keybuf
[t
]);
10095 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10096 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10097 The sequence is sufficient to specify a non-prefix command in the
10098 current local and global maps.
10100 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10101 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10102 as a continuation of the previous key.
10104 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10105 convert the last event to lower case. (Normally any upper case event
10106 is converted to lower case if the original event is undefined and the lower
10107 case equivalent is defined.) A non-nil value is appropriate for reading
10108 a key sequence to be defined.
10110 A C-g typed while in this function is treated like any other character,
10111 and `quit-flag' is not set.
10113 If the key sequence starts with a mouse click, then the sequence is read
10114 using the keymaps of the buffer of the window clicked in, not the buffer
10115 of the selected window as normal.
10117 `read-key-sequence' drops unbound button-down events, since you normally
10118 only care about the click or drag events which follow them. If a drag
10119 or multi-click event is unbound, but the corresponding click event would
10120 be bound, `read-key-sequence' turns the event into a click event at the
10121 drag's starting position. This means that you don't have to distinguish
10122 between click and drag, double, or triple events unless you want to.
10124 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10125 lines separating windows, and scroll bars with imaginary keys
10126 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10128 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10129 function will process a switch-frame event if the user switches frames
10130 before typing anything. If the user switches frames in the middle of a
10131 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10132 is nil, then the event will be put off until after the current key sequence.
10134 `read-key-sequence' checks `function-key-map' for function key
10135 sequences, where they wouldn't conflict with ordinary bindings. See
10136 `function-key-map' for more details.
10138 The optional fifth argument COMMAND-LOOP, if non-nil, means
10139 that this key sequence is being read by something that will
10140 read commands one after another. It should be nil if the caller
10141 will read just one key sequence. */)
10142 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10144 Lisp_Object keybuf
[30];
10146 struct gcpro gcpro1
;
10147 int count
= SPECPDL_INDEX ();
10149 if (!NILP (prompt
))
10150 CHECK_STRING (prompt
);
10153 specbind (Qinput_method_exit_on_first_char
,
10154 (NILP (command_loop
) ? Qt
: Qnil
));
10155 specbind (Qinput_method_use_echo_area
,
10156 (NILP (command_loop
) ? Qt
: Qnil
));
10158 memset (keybuf
, 0, sizeof keybuf
);
10159 GCPRO1 (keybuf
[0]);
10160 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10162 if (NILP (continue_echo
))
10164 this_command_key_count
= 0;
10165 this_command_key_count_reset
= 0;
10166 this_single_command_key_start
= 0;
10169 #ifdef HAVE_WINDOW_SYSTEM
10170 if (display_hourglass_p
)
10171 cancel_hourglass ();
10174 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10175 prompt
, ! NILP (dont_downcase_last
),
10176 ! NILP (can_return_switch_frame
), 0);
10178 #if 0 /* The following is fine for code reading a key sequence and
10179 then proceeding with a lenghty computation, but it's not good
10180 for code reading keys in a loop, like an input method. */
10181 #ifdef HAVE_WINDOW_SYSTEM
10182 if (display_hourglass_p
)
10183 start_hourglass ();
10193 return unbind_to (count
, make_event_array (i
, keybuf
));
10196 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10197 Sread_key_sequence_vector
, 1, 5, 0,
10198 doc
: /* Like `read-key-sequence' but always return a vector. */)
10199 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10201 Lisp_Object keybuf
[30];
10203 struct gcpro gcpro1
;
10204 int count
= SPECPDL_INDEX ();
10206 if (!NILP (prompt
))
10207 CHECK_STRING (prompt
);
10210 specbind (Qinput_method_exit_on_first_char
,
10211 (NILP (command_loop
) ? Qt
: Qnil
));
10212 specbind (Qinput_method_use_echo_area
,
10213 (NILP (command_loop
) ? Qt
: Qnil
));
10215 memset (keybuf
, 0, sizeof keybuf
);
10216 GCPRO1 (keybuf
[0]);
10217 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10219 if (NILP (continue_echo
))
10221 this_command_key_count
= 0;
10222 this_command_key_count_reset
= 0;
10223 this_single_command_key_start
= 0;
10226 #ifdef HAVE_WINDOW_SYSTEM
10227 if (display_hourglass_p
)
10228 cancel_hourglass ();
10231 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10232 prompt
, ! NILP (dont_downcase_last
),
10233 ! NILP (can_return_switch_frame
), 0);
10235 #ifdef HAVE_WINDOW_SYSTEM
10236 if (display_hourglass_p
)
10237 start_hourglass ();
10246 return unbind_to (count
, Fvector (i
, keybuf
));
10249 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10250 doc
: /* Execute CMD as an editor command.
10251 CMD must be a symbol that satisfies the `commandp' predicate.
10252 Optional second arg RECORD-FLAG non-nil
10253 means unconditionally put this command in `command-history'.
10254 Otherwise, that is done only if an arg is read using the minibuffer.
10255 The argument KEYS specifies the value to use instead of (this-command-keys)
10256 when reading the arguments; if it is nil, (this-command-keys) is used.
10257 The argument SPECIAL, if non-nil, means that this command is executing
10258 a special event, so ignore the prefix argument and don't clear it. */)
10259 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10261 register Lisp_Object final
;
10262 register Lisp_Object tem
;
10263 Lisp_Object prefixarg
;
10265 debug_on_next_call
= 0;
10267 if (NILP (special
))
10269 prefixarg
= current_kboard
->Vprefix_arg
;
10270 Vcurrent_prefix_arg
= prefixarg
;
10271 current_kboard
->Vprefix_arg
= Qnil
;
10278 tem
= Fget (cmd
, Qdisabled
);
10279 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10281 tem
= Fsymbol_value (Qdisabled_command_function
);
10283 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10289 final
= Findirect_function (cmd
, Qnil
);
10291 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10293 struct gcpro gcpro1
, gcpro2
;
10295 GCPRO2 (cmd
, prefixarg
);
10296 do_autoload (final
, cmd
);
10303 if (STRINGP (final
) || VECTORP (final
))
10305 /* If requested, place the macro in the command history. For
10306 other sorts of commands, call-interactively takes care of
10308 if (!NILP (record_flag
))
10311 = Fcons (Fcons (Qexecute_kbd_macro
,
10312 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10315 /* Don't keep command history around forever. */
10316 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10318 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10320 XSETCDR (tem
, Qnil
);
10324 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10327 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10328 /* Don't call Fcall_interactively directly because we want to make
10329 sure the backtrace has an entry for `call-interactively'.
10330 For the same reason, pass `cmd' rather than `final'. */
10331 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10338 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10340 doc
: /* Read function name, then read its arguments and call it.
10342 To pass a numeric argument to the command you are invoking with, specify
10343 the numeric argument to this command.
10345 Noninteractively, the argument PREFIXARG is the prefix argument to
10346 give to the command you invoke, if it asks for an argument. */)
10347 (Lisp_Object prefixarg
)
10349 Lisp_Object function
;
10350 EMACS_INT saved_last_point_position
;
10351 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10352 Lisp_Object bindings
, value
;
10353 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10354 #ifdef HAVE_WINDOW_SYSTEM
10355 /* The call to Fcompleting_read will start and cancel the hourglass,
10356 but if the hourglass was already scheduled, this means that no
10357 hourglass will be shown for the actual M-x command itself.
10358 So we restart it if it is already scheduled. Note that checking
10359 hourglass_shown_p is not enough, normally the hourglass is not shown,
10360 just scheduled to be shown. */
10361 int hstarted
= hourglass_started ();
10364 saved_keys
= Fvector (this_command_key_count
,
10365 XVECTOR (this_command_keys
)->contents
);
10366 saved_last_point_position_buffer
= last_point_position_buffer
;
10367 saved_last_point_position
= last_point_position
;
10368 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10370 function
= call0 (intern ("read-extended-command"));
10372 #ifdef HAVE_WINDOW_SYSTEM
10373 if (hstarted
) start_hourglass ();
10376 if (STRINGP (function
) && SCHARS (function
) == 0)
10377 error ("No command name given");
10379 /* Set this_command_keys to the concatenation of saved_keys and
10380 function, followed by a RET. */
10385 this_command_key_count
= 0;
10386 this_command_key_count_reset
= 0;
10387 this_single_command_key_start
= 0;
10389 keys
= XVECTOR (saved_keys
)->contents
;
10390 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10391 add_command_key (keys
[i
]);
10393 for (i
= 0; i
< SCHARS (function
); i
++)
10394 add_command_key (Faref (function
, make_number (i
)));
10396 add_command_key (make_number ('\015'));
10399 last_point_position
= saved_last_point_position
;
10400 last_point_position_buffer
= saved_last_point_position_buffer
;
10404 function
= Fintern (function
, Qnil
);
10405 current_kboard
->Vprefix_arg
= prefixarg
;
10406 Vthis_command
= function
;
10407 real_this_command
= function
;
10409 /* If enabled, show which key runs this command. */
10410 if (!NILP (Vsuggest_key_bindings
)
10411 && NILP (Vexecuting_kbd_macro
)
10412 && SYMBOLP (function
))
10413 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10419 GCPRO3 (bindings
, value
, function
);
10420 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10422 /* If the command has a key binding, print it now. */
10423 if (!NILP (bindings
)
10424 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10427 /* But first wait, and skip the message if there is input. */
10428 Lisp_Object waited
;
10430 /* If this command displayed something in the echo area;
10431 wait a few seconds, then display our suggestion message. */
10432 if (NILP (echo_area_buffer
[0]))
10433 waited
= sit_for (make_number (0), 0, 2);
10434 else if (NUMBERP (Vsuggest_key_bindings
))
10435 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10437 waited
= sit_for (make_number (2), 0, 2);
10439 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10441 Lisp_Object binding
;
10443 int message_p
= push_message ();
10444 int count
= SPECPDL_INDEX ();
10446 record_unwind_protect (pop_message_unwind
, Qnil
);
10447 binding
= Fkey_description (bindings
, Qnil
);
10450 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10453 sprintf (newmessage
, "You can run the command `%s' with %s",
10454 SDATA (SYMBOL_NAME (function
)),
10456 message2_nolog (newmessage
,
10457 strlen (newmessage
),
10458 STRING_MULTIBYTE (binding
));
10459 if (NUMBERP (Vsuggest_key_bindings
))
10460 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10462 waited
= sit_for (make_number (2), 0, 2);
10464 if (!NILP (waited
) && message_p
)
10465 restore_message ();
10467 unbind_to (count
, Qnil
);
10471 RETURN_UNGCPRO (value
);
10475 /* Return nonzero if input events are pending. */
10478 detect_input_pending (void)
10480 if (!input_pending
)
10481 get_input_pending (&input_pending
, 0);
10483 return input_pending
;
10486 /* Return nonzero if input events other than mouse movements are
10490 detect_input_pending_ignore_squeezables (void)
10492 if (!input_pending
)
10493 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10495 return input_pending
;
10498 /* Return nonzero if input events are pending, and run any pending timers. */
10501 detect_input_pending_run_timers (int do_display
)
10503 int old_timers_run
= timers_run
;
10505 if (!input_pending
)
10506 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10508 if (old_timers_run
!= timers_run
&& do_display
)
10510 redisplay_preserve_echo_area (8);
10511 /* The following fixes a bug when using lazy-lock with
10512 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10513 from an idle timer function. The symptom of the bug is that
10514 the cursor sometimes doesn't become visible until the next X
10515 event is processed. --gerd. */
10517 Lisp_Object tail
, frame
;
10518 FOR_EACH_FRAME (tail
, frame
)
10519 if (FRAME_RIF (XFRAME (frame
)))
10520 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10524 return input_pending
;
10527 /* This is called in some cases before a possible quit.
10528 It cases the next call to detect_input_pending to recompute input_pending.
10529 So calling this function unnecessarily can't do any harm. */
10532 clear_input_pending (void)
10537 /* Return nonzero if there are pending requeued events.
10538 This isn't used yet. The hope is to make wait_reading_process_output
10539 call it, and return if it runs Lisp code that unreads something.
10540 The problem is, kbd_buffer_get_event needs to be fixed to know what
10541 to do in that case. It isn't trivial. */
10544 requeued_events_pending_p (void)
10546 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10550 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10551 doc
: /* Return t if command input is currently available with no wait.
10552 Actually, the value is nil only if we can be sure that no input is available;
10553 if there is a doubt, the value is t. */)
10556 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10557 || !NILP (Vunread_post_input_method_events
)
10558 || !NILP (Vunread_input_method_events
))
10561 get_input_pending (&input_pending
,
10562 READABLE_EVENTS_DO_TIMERS_NOW
10563 | READABLE_EVENTS_FILTER_EVENTS
);
10564 return input_pending
> 0 ? Qt
: Qnil
;
10567 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10568 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10571 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10574 if (total_keys
< NUM_RECENT_KEYS
)
10575 return Fvector (total_keys
, keys
);
10578 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10579 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10580 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10581 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10582 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10587 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10588 doc
: /* Return the key sequence that invoked this command.
10589 However, if the command has called `read-key-sequence', it returns
10590 the last key sequence that has been read.
10591 The value is a string or a vector.
10593 See also `this-command-keys-vector'. */)
10596 return make_event_array (this_command_key_count
,
10597 XVECTOR (this_command_keys
)->contents
);
10600 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10601 doc
: /* Return the key sequence that invoked this command, as a vector.
10602 However, if the command has called `read-key-sequence', it returns
10603 the last key sequence that has been read.
10605 See also `this-command-keys'. */)
10608 return Fvector (this_command_key_count
,
10609 XVECTOR (this_command_keys
)->contents
);
10612 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10613 Sthis_single_command_keys
, 0, 0, 0,
10614 doc
: /* Return the key sequence that invoked this command.
10615 More generally, it returns the last key sequence read, either by
10616 the command loop or by `read-key-sequence'.
10617 Unlike `this-command-keys', this function's value
10618 does not include prefix arguments.
10619 The value is always a vector. */)
10622 return Fvector (this_command_key_count
10623 - this_single_command_key_start
,
10624 (XVECTOR (this_command_keys
)->contents
10625 + this_single_command_key_start
));
10628 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10629 Sthis_single_command_raw_keys
, 0, 0, 0,
10630 doc
: /* Return the raw events that were read for this command.
10631 More generally, it returns the last key sequence read, either by
10632 the command loop or by `read-key-sequence'.
10633 Unlike `this-single-command-keys', this function's value
10634 shows the events before all translations (except for input methods).
10635 The value is always a vector. */)
10638 return Fvector (raw_keybuf_count
,
10639 (XVECTOR (raw_keybuf
)->contents
));
10642 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10643 Sreset_this_command_lengths
, 0, 0, 0,
10644 doc
: /* Make the unread events replace the last command and echo.
10645 Used in `universal-argument-other-key'.
10647 `universal-argument-other-key' rereads the event just typed.
10648 It then gets translated through `function-key-map'.
10649 The translated event has to replace the real events,
10650 both in the value of (this-command-keys) and in echoing.
10651 To achieve this, `universal-argument-other-key' calls
10652 `reset-this-command-lengths', which discards the record of reading
10653 these events the first time. */)
10656 this_command_key_count
= before_command_key_count
;
10657 if (this_command_key_count
< this_single_command_key_start
)
10658 this_single_command_key_start
= this_command_key_count
;
10660 echo_truncate (before_command_echo_length
);
10662 /* Cause whatever we put into unread-command-events
10663 to echo as if it were being freshly read from the keyboard. */
10664 this_command_key_count_reset
= 1;
10669 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10670 Sclear_this_command_keys
, 0, 1, 0,
10671 doc
: /* Clear out the vector that `this-command-keys' returns.
10672 Also clear the record of the last 100 events, unless optional arg
10673 KEEP-RECORD is non-nil. */)
10674 (Lisp_Object keep_record
)
10678 this_command_key_count
= 0;
10679 this_command_key_count_reset
= 0;
10681 if (NILP (keep_record
))
10683 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10684 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10686 recent_keys_index
= 0;
10691 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10692 doc
: /* Return the current depth in recursive edits. */)
10696 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10700 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10701 "FOpen dribble file: ",
10702 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10703 If FILE is nil, close any open dribble file. */)
10715 file
= Fexpand_file_name (file
, Qnil
);
10716 dribble
= fopen (SDATA (file
), "w");
10718 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10723 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10724 doc
: /* Discard the contents of the terminal input buffer.
10725 Also end any kbd macro being defined. */)
10728 if (!NILP (current_kboard
->defining_kbd_macro
))
10730 /* Discard the last command from the macro. */
10731 Fcancel_kbd_macro_events ();
10735 update_mode_lines
++;
10737 Vunread_command_events
= Qnil
;
10738 unread_command_char
= -1;
10740 discard_tty_input ();
10742 kbd_fetch_ptr
= kbd_store_ptr
;
10748 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10749 doc
: /* Stop Emacs and return to superior process. You can resume later.
10750 If `cannot-suspend' is non-nil, or if the system doesn't support job
10751 control, run a subshell instead.
10753 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10754 to be read as terminal input by Emacs's parent, after suspension.
10756 Before suspending, run the normal hook `suspend-hook'.
10757 After resumption run the normal hook `suspend-resume-hook'.
10759 Some operating systems cannot stop the Emacs process and resume it later.
10760 On such systems, Emacs starts a subshell instead of suspending. */)
10761 (Lisp_Object stuffstring
)
10763 int count
= SPECPDL_INDEX ();
10764 int old_height
, old_width
;
10766 struct gcpro gcpro1
;
10768 if (tty_list
&& tty_list
->next
)
10769 error ("There are other tty frames open; close them before suspending Emacs");
10771 if (!NILP (stuffstring
))
10772 CHECK_STRING (stuffstring
);
10774 /* Run the functions in suspend-hook. */
10775 if (!NILP (Vrun_hooks
))
10776 call1 (Vrun_hooks
, intern ("suspend-hook"));
10778 GCPRO1 (stuffstring
);
10779 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10780 reset_all_sys_modes ();
10781 /* sys_suspend can get an error if it tries to fork a subshell
10782 and the system resources aren't available for that. */
10783 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10785 stuff_buffered_input (stuffstring
);
10786 if (cannot_suspend
)
10790 unbind_to (count
, Qnil
);
10792 /* Check if terminal/window size has changed.
10793 Note that this is not useful when we are running directly
10794 with a window system; but suspend should be disabled in that case. */
10795 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10796 if (width
!= old_width
|| height
!= old_height
)
10797 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10799 /* Run suspend-resume-hook. */
10800 if (!NILP (Vrun_hooks
))
10801 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10807 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10808 Then in any case stuff anything Emacs has read ahead and not used. */
10811 stuff_buffered_input (Lisp_Object stuffstring
)
10813 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10814 register unsigned char *p
;
10816 if (STRINGP (stuffstring
))
10818 register EMACS_INT count
;
10820 p
= SDATA (stuffstring
);
10821 count
= SBYTES (stuffstring
);
10822 while (count
-- > 0)
10827 /* Anything we have read ahead, put back for the shell to read. */
10828 /* ?? What should this do when we have multiple keyboards??
10829 Should we ignore anything that was typed in at the "wrong" kboard?
10831 rms: we should stuff everything back into the kboard
10833 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10836 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10837 kbd_fetch_ptr
= kbd_buffer
;
10838 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10839 stuff_char (kbd_fetch_ptr
->code
);
10841 clear_event (kbd_fetch_ptr
);
10845 #endif /* SIGTSTP */
10849 set_waiting_for_input (struct timeval
*time_to_clear
)
10851 input_available_clear_time
= time_to_clear
;
10853 /* Tell handle_interrupt to throw back to read_char, */
10854 waiting_for_input
= 1;
10856 /* If handle_interrupt was called before and buffered a C-g,
10857 make it run again now, to avoid timing error. */
10858 if (!NILP (Vquit_flag
))
10859 quit_throw_to_read_char ();
10863 clear_waiting_for_input (void)
10865 /* Tell handle_interrupt not to throw back to read_char, */
10866 waiting_for_input
= 0;
10867 input_available_clear_time
= 0;
10870 /* The SIGINT handler.
10872 If we have a frame on the controlling tty, we assume that the
10873 SIGINT was generated by C-g, so we call handle_interrupt.
10874 Otherwise, the handler kills Emacs. */
10877 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10878 /* compilers complain in signal calls. */
10880 /* Must preserve main program's value of errno. */
10881 int old_errno
= errno
;
10882 struct terminal
*terminal
;
10884 SIGNAL_THREAD_CHECK (signalnum
);
10886 /* See if we have an active terminal on our controlling tty. */
10887 terminal
= get_named_tty ("/dev/tty");
10890 /* If there are no frames there, let's pretend that we are a
10891 well-behaving UN*X program and quit. */
10892 Fkill_emacs (Qnil
);
10896 /* Otherwise, the SIGINT was probably generated by C-g. */
10898 /* Set internal_last_event_frame to the top frame of the
10899 controlling tty, if we have a frame there. We disable the
10900 interrupt key on secondary ttys, so the SIGINT must have come
10901 from the controlling tty. */
10902 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10904 handle_interrupt ();
10910 /* This routine is called at interrupt level in response to C-g.
10912 It is called from the SIGINT handler or kbd_buffer_store_event.
10914 If `waiting_for_input' is non zero, then unless `echoing' is
10915 nonzero, immediately throw back to read_char.
10917 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10918 eval to throw, when it gets a chance. If quit-flag is already
10919 non-nil, it stops the job right away. */
10922 handle_interrupt (void)
10928 /* XXX This code needs to be revised for multi-tty support. */
10929 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10931 /* If SIGINT isn't blocked, don't let us be interrupted by
10932 another SIGINT, it might be harmful due to non-reentrancy
10933 in I/O functions. */
10934 sigblock (sigmask (SIGINT
));
10937 reset_all_sys_modes ();
10939 #ifdef SIGTSTP /* Support possible in later USG versions */
10941 * On systems which can suspend the current process and return to the original
10942 * shell, this command causes the user to end up back at the shell.
10943 * The "Auto-save" and "Abort" questions are not asked until
10944 * the user elects to return to emacs, at which point he can save the current
10945 * job and either dump core or continue.
10949 /* Perhaps should really fork an inferior shell?
10950 But that would not provide any way to get back
10951 to the original shell, ever. */
10952 printf ("No support for stopping a process on this operating system;\n");
10953 printf ("you can continue or abort.\n");
10954 #endif /* not SIGTSTP */
10956 /* We must remain inside the screen area when the internal terminal
10957 is used. Note that [Enter] is not echoed by dos. */
10958 cursor_to (SELECTED_FRAME (), 0, 0);
10960 /* It doesn't work to autosave while GC is in progress;
10961 the code used for auto-saving doesn't cope with the mark bit. */
10962 if (!gc_in_progress
)
10964 printf ("Auto-save? (y or n) ");
10966 if (((c
= getchar ()) & ~040) == 'Y')
10968 Fdo_auto_save (Qt
, Qnil
);
10970 printf ("\r\nAuto-save done");
10971 #else /* not MSDOS */
10972 printf ("Auto-save done\n");
10973 #endif /* not MSDOS */
10975 while (c
!= '\n') c
= getchar ();
10979 /* During GC, it must be safe to reenable quitting again. */
10980 Vinhibit_quit
= Qnil
;
10983 #endif /* not MSDOS */
10984 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10985 printf ("but will instead do a real quit after garbage collection ends\r\n");
10990 printf ("\r\nAbort? (y or n) ");
10991 #else /* not MSDOS */
10992 printf ("Abort (and dump core)? (y or n) ");
10993 #endif /* not MSDOS */
10995 if (((c
= getchar ()) & ~040) == 'Y')
10997 while (c
!= '\n') c
= getchar ();
10999 printf ("\r\nContinuing...\r\n");
11000 #else /* not MSDOS */
11001 printf ("Continuing...\n");
11002 #endif /* not MSDOS */
11004 init_all_sys_modes ();
11009 /* If executing a function that wants to be interrupted out of
11010 and the user has not deferred quitting by binding `inhibit-quit'
11011 then quit right away. */
11012 if (immediate_quit
&& NILP (Vinhibit_quit
))
11014 struct gl_state_s saved
;
11015 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11017 immediate_quit
= 0;
11020 GCPRO4 (saved
.object
, saved
.global_code
,
11021 saved
.current_syntax_table
, saved
.old_prop
);
11022 Fsignal (Qquit
, Qnil
);
11023 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11028 /* Else request quit when it's safe */
11032 /* TODO: The longjmp in this call throws the NS event loop integration off,
11033 and it seems to do fine without this. Probably some attention
11034 needs to be paid to the setting of waiting_for_input in
11035 wait_reading_process_output() under HAVE_NS because of the call
11036 to ns_select there (needed because otherwise events aren't picked up
11037 outside of polling since we don't get SIGIO like X and we don't have a
11038 separate event loop thread like W32. */
11040 if (waiting_for_input
&& !echoing
)
11041 quit_throw_to_read_char ();
11045 /* Handle a C-g by making read_char return C-g. */
11048 quit_throw_to_read_char (void)
11051 /* Prevent another signal from doing this before we finish. */
11052 clear_waiting_for_input ();
11055 Vunread_command_events
= Qnil
;
11056 unread_command_char
= -1;
11058 #if 0 /* Currently, sit_for is called from read_char without turning
11059 off polling. And that can call set_waiting_for_input.
11060 It seems to be harmless. */
11061 #ifdef POLL_FOR_INPUT
11062 /* May be > 1 if in recursive minibuffer. */
11063 if (poll_suppress_count
== 0)
11067 if (FRAMEP (internal_last_event_frame
)
11068 && !EQ (internal_last_event_frame
, selected_frame
))
11069 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11072 _longjmp (getcjmp
, 1);
11075 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11076 doc
: /* Set interrupt mode of reading keyboard input.
11077 If INTERRUPT is non-nil, Emacs will use input interrupts;
11078 otherwise Emacs uses CBREAK mode.
11080 See also `current-input-mode'. */)
11081 (Lisp_Object interrupt
)
11083 int new_interrupt_input
;
11085 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11086 #ifdef HAVE_X_WINDOWS
11087 if (x_display_list
!= NULL
)
11089 /* When using X, don't give the user a real choice,
11090 because we haven't implemented the mechanisms to support it. */
11091 new_interrupt_input
= 1;
11094 #endif /* HAVE_X_WINDOWS */
11095 new_interrupt_input
= !NILP (interrupt
);
11096 #else /* not SIGIO */
11097 new_interrupt_input
= 0;
11098 #endif /* not SIGIO */
11100 if (new_interrupt_input
!= interrupt_input
)
11102 #ifdef POLL_FOR_INPUT
11106 /* this causes startup screen to be restored and messes with the mouse */
11107 reset_all_sys_modes ();
11109 interrupt_input
= new_interrupt_input
;
11111 init_all_sys_modes ();
11114 #ifdef POLL_FOR_INPUT
11115 poll_suppress_count
= 1;
11122 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11123 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11124 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11125 C-q in key sequences.
11127 This setting only has an effect on tty terminals and only when
11128 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11130 See also `current-input-mode'. */)
11131 (Lisp_Object flow
, Lisp_Object terminal
)
11133 struct terminal
*t
= get_terminal (terminal
, 1);
11134 struct tty_display_info
*tty
;
11135 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11137 tty
= t
->display_info
.tty
;
11139 if (tty
->flow_control
!= !NILP (flow
))
11142 /* this causes startup screen to be restored and messes with the mouse */
11143 reset_sys_modes (tty
);
11146 tty
->flow_control
= !NILP (flow
);
11149 init_sys_modes (tty
);
11155 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11156 doc
: /* Enable or disable 8-bit input on TERMINAL.
11157 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11158 bit as the Meta modifier.
11160 If META is nil, Emacs will ignore the top bit, on the assumption it is
11163 Otherwise, Emacs will accept and pass through 8-bit input without
11164 specially interpreting the top bit.
11166 This setting only has an effect on tty terminal devices.
11168 Optional parameter TERMINAL specifies the tty terminal device to use.
11169 It may be a terminal object, a frame, or nil for the terminal used by
11170 the currently selected frame.
11172 See also `current-input-mode'. */)
11173 (Lisp_Object meta
, Lisp_Object terminal
)
11175 struct terminal
*t
= get_terminal (terminal
, 1);
11176 struct tty_display_info
*tty
;
11179 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11181 tty
= t
->display_info
.tty
;
11185 else if (EQ (meta
, Qt
))
11190 if (tty
->meta_key
!= new_meta
)
11193 /* this causes startup screen to be restored and messes with the mouse */
11194 reset_sys_modes (tty
);
11197 tty
->meta_key
= new_meta
;
11200 init_sys_modes (tty
);
11206 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11207 doc
: /* Specify character used for quitting.
11208 QUIT must be an ASCII character.
11210 This function only has an effect on the controlling tty of the Emacs
11213 See also `current-input-mode'. */)
11216 struct terminal
*t
= get_named_tty ("/dev/tty");
11217 struct tty_display_info
*tty
;
11218 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11220 tty
= t
->display_info
.tty
;
11222 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11223 error ("QUIT must be an ASCII character");
11226 /* this causes startup screen to be restored and messes with the mouse */
11227 reset_sys_modes (tty
);
11230 /* Don't let this value be out of range. */
11231 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11234 init_sys_modes (tty
);
11240 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11241 doc
: /* Set mode of reading keyboard input.
11242 First arg INTERRUPT non-nil means use input interrupts;
11243 nil means use CBREAK mode.
11244 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11245 (no effect except in CBREAK mode).
11246 Third arg META t means accept 8-bit input (for a Meta key).
11247 META nil means ignore the top bit, on the assumption it is parity.
11248 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11249 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11250 See also `current-input-mode'. */)
11251 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11253 Fset_input_interrupt_mode (interrupt
);
11254 Fset_output_flow_control (flow
, Qnil
);
11255 Fset_input_meta_mode (meta
, Qnil
);
11257 Fset_quit_char (quit
);
11261 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11262 doc
: /* Return information about the way Emacs currently reads keyboard input.
11263 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11264 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11265 nil, Emacs is using CBREAK mode.
11266 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11267 terminal; this does not apply if Emacs uses interrupt-driven input.
11268 META is t if accepting 8-bit input with 8th bit as Meta flag.
11269 META nil means ignoring the top bit, on the assumption it is parity.
11270 META is neither t nor nil if accepting 8-bit input and using
11271 all 8 bits as the character code.
11272 QUIT is the character Emacs currently uses to quit.
11273 The elements of this list correspond to the arguments of
11274 `set-input-mode'. */)
11277 Lisp_Object val
[4];
11278 struct frame
*sf
= XFRAME (selected_frame
);
11280 val
[0] = interrupt_input
? Qt
: Qnil
;
11281 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11283 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11284 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11286 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11293 XSETFASTINT (val
[3], quit_char
);
11295 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11298 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11299 doc
: /* Return position information for pixel coordinates X and Y.
11300 By default, X and Y are relative to text area of the selected window.
11301 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11302 If optional fourth arg WHOLE is non-nil, X is relative to the left
11303 edge of the window.
11305 The return value is similar to a mouse click position:
11306 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11307 IMAGE (DX . DY) (WIDTH . HEIGHT))
11308 The `posn-' functions access elements of such lists. */)
11309 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11314 if (NILP (frame_or_window
))
11315 frame_or_window
= selected_window
;
11317 if (WINDOWP (frame_or_window
))
11321 CHECK_LIVE_WINDOW (frame_or_window
);
11323 w
= XWINDOW (frame_or_window
);
11324 XSETINT (x
, (XINT (x
)
11325 + WINDOW_LEFT_EDGE_X (w
)
11327 ? window_box_left_offset (w
, TEXT_AREA
)
11329 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11330 frame_or_window
= w
->frame
;
11333 CHECK_LIVE_FRAME (frame_or_window
);
11335 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11338 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11339 doc
: /* Return position information for buffer POS in WINDOW.
11340 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11342 Return nil if position is not visible in window. Otherwise,
11343 the return value is similar to that returned by `event-start' for
11344 a mouse click at the upper left corner of the glyph corresponding
11345 to the given buffer position:
11346 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11347 IMAGE (DX . DY) (WIDTH . HEIGHT))
11348 The `posn-' functions access elements of such lists. */)
11349 (Lisp_Object pos
, Lisp_Object window
)
11354 window
= selected_window
;
11356 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11359 Lisp_Object x
= XCAR (tem
);
11360 Lisp_Object y
= XCAR (XCDR (tem
));
11362 /* Point invisible due to hscrolling? */
11365 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11373 * Set up a new kboard object with reasonable initial values.
11376 init_kboard (KBOARD
*kb
)
11378 kb
->Voverriding_terminal_local_map
= Qnil
;
11379 kb
->Vlast_command
= Qnil
;
11380 kb
->Vreal_last_command
= Qnil
;
11381 kb
->Vkeyboard_translate_table
= Qnil
;
11382 kb
->Vlast_repeatable_command
= Qnil
;
11383 kb
->Vprefix_arg
= Qnil
;
11384 kb
->Vlast_prefix_arg
= Qnil
;
11385 kb
->kbd_queue
= Qnil
;
11386 kb
->kbd_queue_has_data
= 0;
11387 kb
->immediate_echo
= 0;
11388 kb
->echo_string
= Qnil
;
11389 kb
->echo_after_prompt
= -1;
11390 kb
->kbd_macro_buffer
= 0;
11391 kb
->kbd_macro_bufsize
= 0;
11392 kb
->defining_kbd_macro
= Qnil
;
11393 kb
->Vlast_kbd_macro
= Qnil
;
11394 kb
->reference_count
= 0;
11395 kb
->Vsystem_key_alist
= Qnil
;
11396 kb
->system_key_syms
= Qnil
;
11397 kb
->Vwindow_system
= Qt
; /* Unset. */
11398 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11399 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11400 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11401 kb
->Vdefault_minibuffer_frame
= Qnil
;
11405 * Destroy the contents of a kboard object, but not the object itself.
11406 * We use this just before deleting it, or if we're going to initialize
11407 * it a second time.
11410 wipe_kboard (KBOARD
*kb
)
11412 xfree (kb
->kbd_macro_buffer
);
11415 /* Free KB and memory referenced from it. */
11418 delete_kboard (KBOARD
*kb
)
11422 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11425 *kbp
= kb
->next_kboard
;
11427 /* Prevent a dangling reference to KB. */
11428 if (kb
== current_kboard
11429 && FRAMEP (selected_frame
)
11430 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11432 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11434 if (current_kboard
== kb
)
11443 init_keyboard (void)
11445 /* This is correct before outermost invocation of the editor loop */
11446 command_loop_level
= -1;
11447 immediate_quit
= 0;
11448 quit_char
= Ctl ('g');
11449 Vunread_command_events
= Qnil
;
11450 unread_command_char
= -1;
11451 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11453 recent_keys_index
= 0;
11454 kbd_fetch_ptr
= kbd_buffer
;
11455 kbd_store_ptr
= kbd_buffer
;
11456 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11457 do_mouse_tracking
= Qnil
;
11460 interrupt_input_blocked
= 0;
11461 interrupt_input_pending
= 0;
11463 pending_signals
= 0;
11466 /* This means that command_loop_1 won't try to select anything the first
11468 internal_last_event_frame
= Qnil
;
11469 Vlast_event_frame
= internal_last_event_frame
;
11471 current_kboard
= initial_kboard
;
11472 /* Re-initialize the keyboard again. */
11473 wipe_kboard (current_kboard
);
11474 init_kboard (current_kboard
);
11475 /* A value of nil for Vwindow_system normally means a tty, but we also use
11476 it for the initial terminal since there is no window system there. */
11477 current_kboard
->Vwindow_system
= Qnil
;
11479 if (!noninteractive
)
11481 /* Before multi-tty support, these handlers used to be installed
11482 only if the current session was a tty session. Now an Emacs
11483 session may have multiple display types, so we always handle
11484 SIGINT. There is special code in interrupt_signal to exit
11485 Emacs on SIGINT when there are no termcap frames on the
11486 controlling terminal. */
11487 signal (SIGINT
, interrupt_signal
);
11489 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11490 SIGQUIT and we can't tell which one it will give us. */
11491 signal (SIGQUIT
, interrupt_signal
);
11492 #endif /* not DOS_NT */
11494 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11496 if (!noninteractive
)
11497 signal (SIGIO
, input_available_signal
);
11500 /* Use interrupt input by default, if it works and noninterrupt input
11501 has deficiencies. */
11503 #ifdef INTERRUPT_INPUT
11504 interrupt_input
= 1;
11506 interrupt_input
= 0;
11512 if (keyboard_init_hook
)
11513 (*keyboard_init_hook
) ();
11515 #ifdef POLL_FOR_INPUT
11517 poll_suppress_count
= 1;
11522 /* This type's only use is in syms_of_keyboard, to initialize the
11523 event header symbols and put properties on them. */
11524 struct event_head
{
11530 static const struct event_head head_table
[] = {
11531 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11532 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11533 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11534 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11535 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11536 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11537 /* `select-window' should be handled just like `switch-frame'
11538 in read_key_sequence. */
11539 {&Qselect_window
, "select-window", &Qswitch_frame
}
11543 syms_of_keyboard (void)
11545 pending_funcalls
= Qnil
;
11546 staticpro (&pending_funcalls
);
11548 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11549 staticpro (&Vlispy_mouse_stem
);
11552 QCimage
= intern_c_string (":image");
11553 staticpro (&QCimage
);
11555 staticpro (&Qhelp_echo
);
11556 Qhelp_echo
= intern_c_string ("help-echo");
11559 Qrtl
= intern_c_string (":rtl");
11561 staticpro (&item_properties
);
11562 item_properties
= Qnil
;
11564 staticpro (&tool_bar_item_properties
);
11565 tool_bar_item_properties
= Qnil
;
11566 staticpro (&tool_bar_items_vector
);
11567 tool_bar_items_vector
= Qnil
;
11569 staticpro (&real_this_command
);
11570 real_this_command
= Qnil
;
11572 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11573 staticpro (&Qtimer_event_handler
);
11575 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11576 staticpro (&Qdisabled_command_function
);
11578 Qself_insert_command
= intern_c_string ("self-insert-command");
11579 staticpro (&Qself_insert_command
);
11581 Qforward_char
= intern_c_string ("forward-char");
11582 staticpro (&Qforward_char
);
11584 Qbackward_char
= intern_c_string ("backward-char");
11585 staticpro (&Qbackward_char
);
11587 Qdisabled
= intern_c_string ("disabled");
11588 staticpro (&Qdisabled
);
11590 Qundefined
= intern_c_string ("undefined");
11591 staticpro (&Qundefined
);
11593 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11594 staticpro (&Qpre_command_hook
);
11596 Qpost_command_hook
= intern_c_string ("post-command-hook");
11597 staticpro (&Qpost_command_hook
);
11599 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11600 staticpro (&Qdeferred_action_function
);
11602 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11603 staticpro (&Qcommand_hook_internal
);
11605 Qfunction_key
= intern_c_string ("function-key");
11606 staticpro (&Qfunction_key
);
11607 Qmouse_click
= intern_c_string ("mouse-click");
11608 staticpro (&Qmouse_click
);
11609 #if defined (WINDOWSNT)
11610 Qlanguage_change
= intern_c_string ("language-change");
11611 staticpro (&Qlanguage_change
);
11613 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11614 staticpro (&Qdrag_n_drop
);
11616 Qsave_session
= intern_c_string ("save-session");
11617 staticpro (&Qsave_session
);
11620 Qdbus_event
= intern_c_string ("dbus-event");
11621 staticpro (&Qdbus_event
);
11624 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11625 staticpro (&Qconfig_changed_event
);
11627 Qmenu_enable
= intern_c_string ("menu-enable");
11628 staticpro (&Qmenu_enable
);
11629 QCenable
= intern_c_string (":enable");
11630 staticpro (&QCenable
);
11631 QCvisible
= intern_c_string (":visible");
11632 staticpro (&QCvisible
);
11633 QChelp
= intern_c_string (":help");
11634 staticpro (&QChelp
);
11635 QCfilter
= intern_c_string (":filter");
11636 staticpro (&QCfilter
);
11637 QCbutton
= intern_c_string (":button");
11638 staticpro (&QCbutton
);
11639 QCkeys
= intern_c_string (":keys");
11640 staticpro (&QCkeys
);
11641 QCkey_sequence
= intern_c_string (":key-sequence");
11642 staticpro (&QCkey_sequence
);
11643 QCtoggle
= intern_c_string (":toggle");
11644 staticpro (&QCtoggle
);
11645 QCradio
= intern_c_string (":radio");
11646 staticpro (&QCradio
);
11647 QClabel
= intern_c_string (":label");
11648 staticpro (&QClabel
);
11650 Qmode_line
= intern_c_string ("mode-line");
11651 staticpro (&Qmode_line
);
11652 Qvertical_line
= intern_c_string ("vertical-line");
11653 staticpro (&Qvertical_line
);
11654 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11655 staticpro (&Qvertical_scroll_bar
);
11656 Qmenu_bar
= intern_c_string ("menu-bar");
11657 staticpro (&Qmenu_bar
);
11659 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11660 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11661 staticpro (&Qmouse_fixup_help_message
);
11664 Qabove_handle
= intern_c_string ("above-handle");
11665 staticpro (&Qabove_handle
);
11666 Qhandle
= intern_c_string ("handle");
11667 staticpro (&Qhandle
);
11668 Qbelow_handle
= intern_c_string ("below-handle");
11669 staticpro (&Qbelow_handle
);
11670 Qup
= intern_c_string ("up");
11672 Qdown
= intern_c_string ("down");
11673 staticpro (&Qdown
);
11674 Qtop
= intern_c_string ("top");
11676 Qbottom
= intern_c_string ("bottom");
11677 staticpro (&Qbottom
);
11678 Qend_scroll
= intern_c_string ("end-scroll");
11679 staticpro (&Qend_scroll
);
11680 Qratio
= intern_c_string ("ratio");
11681 staticpro (&Qratio
);
11683 Qevent_kind
= intern_c_string ("event-kind");
11684 staticpro (&Qevent_kind
);
11685 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11686 staticpro (&Qevent_symbol_elements
);
11687 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11688 staticpro (&Qevent_symbol_element_mask
);
11689 Qmodifier_cache
= intern_c_string ("modifier-cache");
11690 staticpro (&Qmodifier_cache
);
11692 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11693 staticpro (&Qrecompute_lucid_menubar
);
11694 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11695 staticpro (&Qactivate_menubar_hook
);
11697 Qpolling_period
= intern_c_string ("polling-period");
11698 staticpro (&Qpolling_period
);
11700 Qinput_method_function
= intern_c_string ("input-method-function");
11701 staticpro (&Qinput_method_function
);
11703 Qx_set_selection
= intern_c_string ("x-set-selection");
11704 staticpro (&Qx_set_selection
);
11705 QPRIMARY
= intern_c_string ("PRIMARY");
11706 staticpro (&QPRIMARY
);
11707 Qhandle_switch_frame
= intern_c_string ("handle-switch-frame");
11708 staticpro (&Qhandle_switch_frame
);
11710 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11711 staticpro (&Qinput_method_exit_on_first_char
);
11712 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11713 staticpro (&Qinput_method_use_echo_area
);
11715 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11716 Fset (Qinput_method_use_echo_area
, Qnil
);
11718 last_point_position_buffer
= Qnil
;
11719 last_point_position_window
= Qnil
;
11722 const struct event_head
*p
;
11724 for (p
= head_table
;
11725 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11728 *p
->var
= intern_c_string (p
->name
);
11729 staticpro (p
->var
);
11730 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11731 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11735 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11736 staticpro (&button_down_location
);
11737 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11738 staticpro (&mouse_syms
);
11739 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11740 / sizeof (lispy_wheel_names
[0])),
11742 staticpro (&wheel_syms
);
11746 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11748 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11749 for (i
= 0; i
< len
; i
++)
11750 if (modifier_names
[i
])
11751 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11752 staticpro (&modifier_symbols
);
11755 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11756 staticpro (&recent_keys
);
11758 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11759 staticpro (&this_command_keys
);
11761 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11762 staticpro (&raw_keybuf
);
11764 Qextended_command_history
= intern_c_string ("extended-command-history");
11765 Fset (Qextended_command_history
, Qnil
);
11766 staticpro (&Qextended_command_history
);
11768 accent_key_syms
= Qnil
;
11769 staticpro (&accent_key_syms
);
11771 func_key_syms
= Qnil
;
11772 staticpro (&func_key_syms
);
11774 drag_n_drop_syms
= Qnil
;
11775 staticpro (&drag_n_drop_syms
);
11777 unread_switch_frame
= Qnil
;
11778 staticpro (&unread_switch_frame
);
11780 internal_last_event_frame
= Qnil
;
11781 staticpro (&internal_last_event_frame
);
11783 read_key_sequence_cmd
= Qnil
;
11784 staticpro (&read_key_sequence_cmd
);
11786 menu_bar_one_keymap_changed_items
= Qnil
;
11787 staticpro (&menu_bar_one_keymap_changed_items
);
11789 menu_bar_items_vector
= Qnil
;
11790 staticpro (&menu_bar_items_vector
);
11792 help_form_saved_window_configs
= Qnil
;
11793 staticpro (&help_form_saved_window_configs
);
11795 defsubr (&Scurrent_idle_time
);
11796 defsubr (&Sevent_symbol_parse_modifiers
);
11797 defsubr (&Sevent_convert_list
);
11798 defsubr (&Sread_key_sequence
);
11799 defsubr (&Sread_key_sequence_vector
);
11800 defsubr (&Srecursive_edit
);
11801 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11802 defsubr (&Strack_mouse
);
11804 defsubr (&Sinput_pending_p
);
11805 defsubr (&Scommand_execute
);
11806 defsubr (&Srecent_keys
);
11807 defsubr (&Sthis_command_keys
);
11808 defsubr (&Sthis_command_keys_vector
);
11809 defsubr (&Sthis_single_command_keys
);
11810 defsubr (&Sthis_single_command_raw_keys
);
11811 defsubr (&Sreset_this_command_lengths
);
11812 defsubr (&Sclear_this_command_keys
);
11813 defsubr (&Ssuspend_emacs
);
11814 defsubr (&Sabort_recursive_edit
);
11815 defsubr (&Sexit_recursive_edit
);
11816 defsubr (&Srecursion_depth
);
11817 defsubr (&Stop_level
);
11818 defsubr (&Sdiscard_input
);
11819 defsubr (&Sopen_dribble_file
);
11820 defsubr (&Sset_input_interrupt_mode
);
11821 defsubr (&Sset_output_flow_control
);
11822 defsubr (&Sset_input_meta_mode
);
11823 defsubr (&Sset_quit_char
);
11824 defsubr (&Sset_input_mode
);
11825 defsubr (&Scurrent_input_mode
);
11826 defsubr (&Sexecute_extended_command
);
11827 defsubr (&Sposn_at_point
);
11828 defsubr (&Sposn_at_x_y
);
11830 DEFVAR_LISP ("last-command-event", &last_command_event
,
11831 doc
: /* Last input event that was part of a command. */);
11833 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11834 doc
: /* Last input event in a command, except for mouse menu events.
11835 Mouse menus give back keys that don't look like mouse events;
11836 this variable holds the actual mouse event that led to the menu,
11837 so that you can determine whether the command was run by mouse or not. */);
11839 DEFVAR_LISP ("last-input-event", &last_input_event
,
11840 doc
: /* Last input event. */);
11842 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11843 doc
: /* List of events to be read as the command input.
11844 These events are processed first, before actual keyboard input.
11845 Events read from this list are not normally added to `this-command-keys',
11846 as they will already have been added once as they were read for the first time.
11847 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11848 Vunread_command_events
= Qnil
;
11850 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11851 doc
: /* If not -1, an object to be read as next command input event. */);
11853 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11854 doc
: /* List of events to be processed as input by input methods.
11855 These events are processed before `unread-command-events'
11856 and actual keyboard input, but are not given to `input-method-function'. */);
11857 Vunread_post_input_method_events
= Qnil
;
11859 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11860 doc
: /* List of events to be processed as input by input methods.
11861 These events are processed after `unread-command-events', but
11862 before actual keyboard input.
11863 If there's an active input method, the events are given to
11864 `input-method-function'. */);
11865 Vunread_input_method_events
= Qnil
;
11867 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11868 doc
: /* Meta-prefix character code.
11869 Meta-foo as command input turns into this character followed by foo. */);
11870 XSETINT (meta_prefix_char
, 033);
11872 DEFVAR_KBOARD ("last-command", Vlast_command
,
11873 doc
: /* The last command executed.
11874 Normally a symbol with a function definition, but can be whatever was found
11875 in the keymap, or whatever the variable `this-command' was set to by that
11878 The value `mode-exit' is special; it means that the previous command
11879 read an event that told it to exit, and it did so and unread that event.
11880 In other words, the present command is the event that made the previous
11883 The value `kill-region' is special; it means that the previous command
11884 was a kill command.
11886 `last-command' has a separate binding for each terminal device.
11887 See Info node `(elisp)Multiple Terminals'. */);
11889 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11890 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11892 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11893 doc
: /* Last command that may be repeated.
11894 The last command executed that was not bound to an input event.
11895 This is the command `repeat' will try to repeat. */);
11897 DEFVAR_LISP ("this-command", &Vthis_command
,
11898 doc
: /* The command now being executed.
11899 The command can set this variable; whatever is put here
11900 will be in `last-command' during the following command. */);
11901 Vthis_command
= Qnil
;
11903 DEFVAR_LISP ("this-command-keys-shift-translated",
11904 &Vthis_command_keys_shift_translated
,
11905 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11906 Shift-translation occurs when there is no binding for the key sequence
11907 as entered, but a binding was found by changing an upper-case letter
11908 to lower-case, or a shifted function key to an unshifted one. */);
11909 Vthis_command_keys_shift_translated
= Qnil
;
11911 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11912 doc
: /* The command bound to the current key sequence before remapping.
11913 It equals `this-command' if the original command was not remapped through
11914 any of the active keymaps. Otherwise, the value of `this-command' is the
11915 result of looking up the original command in the active keymaps. */);
11916 Vthis_original_command
= Qnil
;
11918 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11919 doc
: /* *Number of input events between auto-saves.
11920 Zero means disable autosaving due to number of characters typed. */);
11921 auto_save_interval
= 300;
11923 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11924 doc
: /* *Number of seconds idle time before auto-save.
11925 Zero or nil means disable auto-saving due to idleness.
11926 After auto-saving due to this many seconds of idle time,
11927 Emacs also does a garbage collection if that seems to be warranted. */);
11928 XSETFASTINT (Vauto_save_timeout
, 30);
11930 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11931 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11932 The value may be integer or floating point. */);
11933 Vecho_keystrokes
= make_number (1);
11935 DEFVAR_INT ("polling-period", &polling_period
,
11936 doc
: /* *Interval between polling for input during Lisp execution.
11937 The reason for polling is to make C-g work to stop a running program.
11938 Polling is needed only when using X windows and SIGIO does not work.
11939 Polling is automatically disabled in all other cases. */);
11940 polling_period
= 2;
11942 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11943 doc
: /* *Maximum time between mouse clicks to make a double-click.
11944 Measured in milliseconds. The value nil means disable double-click
11945 recognition; t means double-clicks have no time limit and are detected
11946 by position only. */);
11947 Vdouble_click_time
= make_number (500);
11949 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11950 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11951 On window-system frames, value is the number of pixels the mouse may have
11952 moved horizontally or vertically between two clicks to make a double-click.
11953 On non window-system frames, value is interpreted in units of 1/8 characters
11956 This variable is also the threshold for motion of the mouse
11957 to count as a drag. */);
11958 double_click_fuzz
= 3;
11960 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11961 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11962 inhibit_local_menu_bar_menus
= 0;
11964 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11965 doc
: /* Number of complete key sequences read as input so far.
11966 This includes key sequences read from keyboard macros.
11967 The number is effectively the number of interactive command invocations. */);
11968 num_input_keys
= 0;
11970 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11971 doc
: /* Number of input events read from the keyboard so far.
11972 This does not include events generated by keyboard macros. */);
11973 num_nonmacro_input_events
= 0;
11975 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11976 doc
: /* The frame in which the most recently read event occurred.
11977 If the last event came from a keyboard macro, this is set to `macro'. */);
11978 Vlast_event_frame
= Qnil
;
11980 /* This variable is set up in sysdep.c. */
11981 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11982 doc
: /* The ERASE character as set by the user with stty. */);
11984 DEFVAR_LISP ("help-char", &Vhelp_char
,
11985 doc
: /* Character to recognize as meaning Help.
11986 When it is read, do `(eval help-form)', and display result if it's a string.
11987 If the value of `help-form' is nil, this char can be read normally. */);
11988 XSETINT (Vhelp_char
, Ctl ('H'));
11990 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11991 doc
: /* List of input events to recognize as meaning Help.
11992 These work just like the value of `help-char' (see that). */);
11993 Vhelp_event_list
= Qnil
;
11995 DEFVAR_LISP ("help-form", &Vhelp_form
,
11996 doc
: /* Form to execute when character `help-char' is read.
11997 If the form returns a string, that string is displayed.
11998 If `help-form' is nil, the help char is not recognized. */);
12001 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12002 doc
: /* Command to run when `help-char' character follows a prefix key.
12003 This command is used only when there is no actual binding
12004 for that character after that prefix key. */);
12005 Vprefix_help_command
= Qnil
;
12007 DEFVAR_LISP ("top-level", &Vtop_level
,
12008 doc
: /* Form to evaluate when Emacs starts up.
12009 Useful to set before you dump a modified Emacs. */);
12012 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12013 doc
: /* Translate table for local keyboard input, or nil.
12014 If non-nil, the value should be a char-table. Each character read
12015 from the keyboard is looked up in this char-table. If the value found
12016 there is non-nil, then it is used instead of the actual input character.
12018 The value can also be a string or vector, but this is considered obsolete.
12019 If it is a string or vector of length N, character codes N and up are left
12020 untranslated. In a vector, an element which is nil means "no translation".
12022 This is applied to the characters supplied to input methods, not their
12023 output. See also `translation-table-for-input'.
12025 This variable has a separate binding for each terminal.
12026 See Info node `(elisp)Multiple Terminals'. */);
12028 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12029 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12030 \(Even if the operating system has support for stopping a process.\) */);
12031 cannot_suspend
= 0;
12033 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12034 doc
: /* Non-nil means prompt with menus when appropriate.
12035 This is done when reading from a keymap that has a prompt string,
12036 for elements that have prompt strings.
12037 The menu is displayed on the screen
12038 if X menus were enabled at configuration
12039 time and the previous event was a mouse click prefix key.
12040 Otherwise, menu prompting uses the echo area. */);
12041 menu_prompting
= 1;
12043 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12044 doc
: /* Character to see next line of menu prompt.
12045 Type this character while in a menu prompt to rotate around the lines of it. */);
12046 XSETINT (menu_prompt_more_char
, ' ');
12048 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12049 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12050 Emacs applies the modifiers of the character stored here to each keyboard
12051 character it reads. For example, after evaluating the expression
12052 (setq extra-keyboard-modifiers ?\\C-x)
12053 all input characters will have the control modifier applied to them.
12055 Note that the character ?\\C-@, equivalent to the integer zero, does
12056 not count as a control character; rather, it counts as a character
12057 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12058 cancels any modification. */);
12059 extra_keyboard_modifiers
= 0;
12061 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12062 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12063 The command loop sets this to nil before each command,
12064 and tests the value when the command returns.
12065 Buffer modification stores t in this variable. */);
12066 Vdeactivate_mark
= Qnil
;
12067 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
12068 staticpro (&Qdeactivate_mark
);
12070 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12071 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12072 Vcommand_hook_internal
= Qnil
;
12074 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12075 doc
: /* Normal hook run before each command is executed.
12076 If an unhandled error happens in running this hook,
12077 the hook value is set to nil, since otherwise the error
12078 might happen repeatedly and make Emacs nonfunctional. */);
12079 Vpre_command_hook
= Qnil
;
12081 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12082 doc
: /* Normal hook run after each command is executed.
12083 If an unhandled error happens in running this hook,
12084 the hook value is set to nil, since otherwise the error
12085 might happen repeatedly and make Emacs nonfunctional. */);
12086 Vpost_command_hook
= Qnil
;
12089 DEFVAR_LISP ("echo-area-clear-hook", ...,
12090 doc
: /* Normal hook run when clearing the echo area. */);
12092 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
12093 staticpro (&Qecho_area_clear_hook
);
12094 Fset (Qecho_area_clear_hook
, Qnil
);
12096 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12097 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12098 Vlucid_menu_bar_dirty_flag
= Qnil
;
12100 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12101 doc
: /* List of menu bar items to move to the end of the menu bar.
12102 The elements of the list are event types that may have menu bar bindings. */);
12103 Vmenu_bar_final_items
= Qnil
;
12105 DEFVAR_KBOARD ("overriding-terminal-local-map",
12106 Voverriding_terminal_local_map
,
12107 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12108 If this variable is non-nil, it is used as a keymap instead of the
12109 buffer's local map, and the minor mode keymaps and text property keymaps.
12110 It also replaces `overriding-local-map'.
12112 This variable is intended to let commands such as `universal-argument'
12113 set up a different keymap for reading the next command.
12115 `overriding-terminal-local-map' has a separate binding for each
12117 See Info node `(elisp)Multiple Terminals'. */);
12119 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12120 doc
: /* Keymap that overrides all other local keymaps.
12121 If this variable is non-nil, it is used as a keymap--replacing the
12122 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12123 Voverriding_local_map
= Qnil
;
12125 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12126 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12127 Otherwise, the menu bar continues to reflect the buffer's local map
12128 and the minor mode maps regardless of `overriding-local-map'. */);
12129 Voverriding_local_map_menu_flag
= Qnil
;
12131 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12132 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12133 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12135 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12136 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12138 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12139 doc
: /* Alist of system-specific X windows key symbols.
12140 Each element should have the form (N . SYMBOL) where N is the
12141 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12142 and SYMBOL is its name.
12144 `system-key-alist' has a separate binding for each terminal device.
12145 See Info node `(elisp)Multiple Terminals'. */);
12147 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12148 doc
: /* Keymap that translates key sequences to key sequences during input.
12149 This is used mainly for mapping key sequences into some preferred
12150 key events (symbols).
12152 The `read-key-sequence' function replaces any subsequence bound by
12153 `local-function-key-map' with its binding. More precisely, when the
12154 active keymaps have no binding for the current key sequence but
12155 `local-function-key-map' binds a suffix of the sequence to a vector or
12156 string, `read-key-sequence' replaces the matching suffix with its
12157 binding, and continues with the new sequence.
12159 If the binding is a function, it is called with one argument (the prompt)
12160 and its return value (a key sequence) is used.
12162 The events that come from bindings in `local-function-key-map' are not
12163 themselves looked up in `local-function-key-map'.
12165 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12166 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12167 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12168 typing `ESC O P x' would return [f1 x].
12170 `local-function-key-map' has a separate binding for each terminal
12171 device. See Info node `(elisp)Multiple Terminals'. If you need to
12172 define a binding on all terminals, change `function-key-map'
12173 instead. Initially, `local-function-key-map' is an empty keymap that
12174 has `function-key-map' as its parent on all terminal devices. */);
12176 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12177 doc
: /* Keymap that decodes input escape sequences.
12178 This is used mainly for mapping ASCII function key sequences into
12179 real Emacs function key events (symbols).
12181 The `read-key-sequence' function replaces any subsequence bound by
12182 `input-decode-map' with its binding. Contrary to `function-key-map',
12183 this map applies its rebinding regardless of the presence of an ordinary
12184 binding. So it is more like `key-translation-map' except that it applies
12185 before `function-key-map' rather than after.
12187 If the binding is a function, it is called with one argument (the prompt)
12188 and its return value (a key sequence) is used.
12190 The events that come from bindings in `input-decode-map' are not
12191 themselves looked up in `input-decode-map'.
12193 This variable is keyboard-local. */);
12195 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12196 doc
: /* The parent keymap of all `local-function-key-map' instances.
12197 Function key definitions that apply to all terminal devices should go
12198 here. If a mapping is defined in both the current
12199 `local-function-key-map' binding and this variable, then the local
12200 definition will take precendence. */);
12201 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12203 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12204 doc
: /* Keymap of key translations that can override keymaps.
12205 This keymap works like `function-key-map', but comes after that,
12206 and its non-prefix bindings override ordinary bindings.
12207 Another difference is that it is global rather than keyboard-local. */);
12208 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12210 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12211 doc
: /* List of deferred actions to be performed at a later time.
12212 The precise format isn't relevant here; we just check whether it is nil. */);
12213 Vdeferred_action_list
= Qnil
;
12215 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12216 doc
: /* Function to call to handle deferred actions, after each command.
12217 This function is called with no arguments after each command
12218 whenever `deferred-action-list' is non-nil. */);
12219 Vdeferred_action_function
= Qnil
;
12221 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12222 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12223 The value can be a length of time to show the message for.
12224 If the value is non-nil and not a number, we wait 2 seconds. */);
12225 Vsuggest_key_bindings
= Qt
;
12227 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12228 doc
: /* List of active absolute time timers in order of increasing time. */);
12229 Vtimer_list
= Qnil
;
12231 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12232 doc
: /* List of active idle-time timers in order of increasing time. */);
12233 Vtimer_idle_list
= Qnil
;
12235 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12236 doc
: /* If non-nil, the function that implements the current input method.
12237 It's called with one argument, a printing character that was just read.
12238 \(That means a character with code 040...0176.)
12239 Typically this function uses `read-event' to read additional events.
12240 When it does so, it should first bind `input-method-function' to nil
12241 so it will not be called recursively.
12243 The function should return a list of zero or more events
12244 to be used as input. If it wants to put back some events
12245 to be reconsidered, separately, by the input method,
12246 it can add them to the beginning of `unread-command-events'.
12248 The input method function can find in `input-method-previous-message'
12249 the previous echo area message.
12251 The input method function should refer to the variables
12252 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12253 for guidance on what to do. */);
12254 Vinput_method_function
= Qnil
;
12256 DEFVAR_LISP ("input-method-previous-message",
12257 &Vinput_method_previous_message
,
12258 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12259 This variable exists because `read-event' clears the echo area
12260 before running the input method. It is nil if there was no message. */);
12261 Vinput_method_previous_message
= Qnil
;
12263 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12264 doc
: /* If non-nil, the function that implements the display of help.
12265 It's called with one argument, the help string to display. */);
12266 Vshow_help_function
= Qnil
;
12268 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12269 doc
: /* If non-nil, suppress point adjustment after executing a command.
12271 After a command is executed, if point is moved into a region that has
12272 special properties (e.g. composition, display), we adjust point to
12273 the boundary of the region. But, when a command sets this variable to
12274 non-nil, we suppress the point adjustment.
12276 This variable is set to nil before reading a command, and is checked
12277 just after executing the command. */);
12278 Vdisable_point_adjustment
= Qnil
;
12280 DEFVAR_LISP ("global-disable-point-adjustment",
12281 &Vglobal_disable_point_adjustment
,
12282 doc
: /* *If non-nil, always suppress point adjustment.
12284 The default value is nil, in which case, point adjustment are
12285 suppressed only after special commands that set
12286 `disable-point-adjustment' (which see) to non-nil. */);
12287 Vglobal_disable_point_adjustment
= Qnil
;
12289 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12290 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12291 If the value is not a number, such messages don't time out. */);
12292 Vminibuffer_message_timeout
= make_number (2);
12294 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12295 doc
: /* If non-nil, any keyboard input throws to this symbol.
12296 The value of that variable is passed to `quit-flag' and later causes a
12297 peculiar kind of quitting. */);
12298 Vthrow_on_input
= Qnil
;
12300 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12301 doc
: /* If non-nil, function to output error messages.
12302 The arguments are the error data, a list of the form
12303 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12304 such as just as `condition-case' would bind its variable to,
12305 the context (a string which normally goes at the start of the message),
12306 and the Lisp function within which the error was signaled. */);
12307 Vcommand_error_function
= Qnil
;
12309 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12310 &Venable_disabled_menus_and_buttons
,
12311 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12313 Help functions bind this to allow help on disabled menu items
12314 and tool-bar buttons. */);
12315 Venable_disabled_menus_and_buttons
= Qnil
;
12317 DEFVAR_LISP ("select-active-regions",
12318 &Vselect_active_regions
,
12319 doc
: /* If non-nil, an active region automatically becomes the window selection.
12320 If the value is `only', only temporarily active regions (usually made
12321 by mouse-dragging or shift-selection) set the window selection.
12323 This takes effect only when Transient Mark mode is enabled. */);
12324 Vselect_active_regions
= Qt
;
12326 DEFVAR_LISP ("saved-region-selection",
12327 &Vsaved_region_selection
,
12328 doc
: /* Contents of active region prior to buffer modification.
12329 If `select-active-regions' is non-nil, Emacs sets this to the
12330 text in the region before modifying the buffer. The next
12331 `deactivate-mark' call uses this to set the window selection. */);
12332 Vsaved_region_selection
= Qnil
;
12334 /* Create the initial keyboard. */
12335 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12336 init_kboard (initial_kboard
);
12337 /* Vwindow_system is left at t for now. */
12338 initial_kboard
->next_kboard
= all_kboards
;
12339 all_kboards
= initial_kboard
;
12343 keys_of_keyboard (void)
12345 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12346 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12347 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12348 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12349 initial_define_key (meta_map
, 'x', "execute-extended-command");
12351 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12352 "handle-delete-frame");
12353 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12354 "ns-put-working-text");
12355 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12356 "ns-unput-working-text");
12357 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12358 current-prefix-arg, as is done in `handle-switch-frame'.
12359 But `handle-switch-frame is not run from the special-map.
12360 Commands from that map are run in a special way that automatically
12361 preserves the prefix-arg. Restoring the prefix arg here is not just
12362 redundant but harmful:
12364 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12365 - after the first prompt, the exit-minibuffer-hook is run which may
12366 iconify a frame and thus push a `iconify-frame' event.
12367 - after running exit-minibuffer-hook, current-prefix-arg is
12368 restored to the non-nil value it had before the prompt.
12369 - we enter the second prompt.
12370 current-prefix-arg is non-nil, prefix-arg is nil.
12371 - before running the first real event, we run the special iconify-frame
12372 event, but we pass the `special' arg to execute-command so
12373 current-prefix-arg and prefix-arg are left untouched.
12374 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12375 - the next key event will have a spuriously non-nil current-prefix-arg. */
12376 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12378 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12380 /* Handling it at such a low-level causes read_key_sequence to get
12381 * confused because it doesn't realize that the current_buffer was
12382 * changed by read_char.
12384 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12385 * "handle-select-window"); */
12386 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12387 "handle-save-session");
12390 /* Define a special event which is raised for dbus callback
12392 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12393 "dbus-handle-event");
12396 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12400 /* Mark the pointers in the kboard objects.
12401 Called by the Fgarbage_collector. */
12403 mark_kboards (void)
12407 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12409 if (kb
->kbd_macro_buffer
)
12410 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12412 mark_object (kb
->Voverriding_terminal_local_map
);
12413 mark_object (kb
->Vlast_command
);
12414 mark_object (kb
->Vreal_last_command
);
12415 mark_object (kb
->Vkeyboard_translate_table
);
12416 mark_object (kb
->Vlast_repeatable_command
);
12417 mark_object (kb
->Vprefix_arg
);
12418 mark_object (kb
->Vlast_prefix_arg
);
12419 mark_object (kb
->kbd_queue
);
12420 mark_object (kb
->defining_kbd_macro
);
12421 mark_object (kb
->Vlast_kbd_macro
);
12422 mark_object (kb
->Vsystem_key_alist
);
12423 mark_object (kb
->system_key_syms
);
12424 mark_object (kb
->Vwindow_system
);
12425 mark_object (kb
->Vinput_decode_map
);
12426 mark_object (kb
->Vlocal_function_key_map
);
12427 mark_object (kb
->Vdefault_minibuffer_frame
);
12428 mark_object (kb
->echo_string
);
12431 struct input_event
*event
;
12432 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12434 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12435 event
= kbd_buffer
;
12436 if (event
->kind
!= SELECTION_REQUEST_EVENT
12437 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12439 mark_object (event
->x
);
12440 mark_object (event
->y
);
12442 mark_object (event
->frame_or_window
);
12443 mark_object (event
->arg
);
12448 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12449 (do not change this comment) */