1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
35 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
48 #ifdef HAVE_GTK_AND_PTHREAD
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #include "syssignal.h"
60 #include <sys/types.h>
69 /* This is to get the definitions of the XK_ symbols. */
76 #endif /* HAVE_NTGUI */
82 /* Variables for blockinput.h: */
84 /* Non-zero if interrupt input is blocked right now. */
85 volatile int interrupt_input_blocked
;
87 /* Nonzero means an input interrupt has arrived
88 during the current critical section. */
89 int interrupt_input_pending
;
91 /* This var should be (interrupt_input_pending || pending_atimers).
92 The QUIT macro checks this instead of interrupt_input_pending and
93 pending_atimers separately, to reduce code size. So, any code that
94 changes interrupt_input_pending or pending_atimers should update
100 #define KBD_BUFFER_SIZE 4096
102 KBOARD
*initial_kboard
;
103 KBOARD
*current_kboard
;
107 /* Non-nil disable property on a command means
108 do not execute it; call disabled-command-function's value instead. */
109 Lisp_Object Qdisabled
, Qdisabled_command_function
;
111 #define NUM_RECENT_KEYS (300)
112 int recent_keys_index
; /* Index for storing next element into recent_keys */
113 int total_keys
; /* Total number of elements stored into recent_keys */
114 Lisp_Object recent_keys
; /* Vector holds the last NUM_RECENT_KEYS keystrokes */
116 /* Vector holding the key sequence that invoked the current command.
117 It is reused for each command, and it may be longer than the current
118 sequence; this_command_key_count indicates how many elements
119 actually mean something.
120 It's easier to staticpro a single Lisp_Object than an array. */
121 Lisp_Object this_command_keys
;
122 int this_command_key_count
;
124 /* 1 after calling Freset_this_command_lengths.
126 int this_command_key_count_reset
;
128 /* This vector is used as a buffer to record the events that were actually read
129 by read_key_sequence. */
130 Lisp_Object raw_keybuf
;
131 int raw_keybuf_count
;
133 /* Non-nil if the present key sequence was obtained by shift translation. */
134 Lisp_Object Vthis_command_keys_shift_translated
;
136 #define GROW_RAW_KEYBUF \
137 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
138 raw_keybuf = larger_vector (raw_keybuf, raw_keybuf_count * 2, Qnil) \
140 /* Number of elements of this_command_keys
141 that precede this key sequence. */
142 int this_single_command_key_start
;
144 /* Record values of this_command_key_count and echo_length ()
145 before this command was read. */
146 static int before_command_key_count
;
147 static int before_command_echo_length
;
149 extern int minbuf_level
;
151 extern int message_enable_multibyte
;
153 /* If non-nil, the function that implements the display of help.
154 It's called with one argument, the help string to display. */
156 Lisp_Object Vshow_help_function
;
158 /* Nonzero means do menu prompting. */
160 static int menu_prompting
;
162 /* Character to see next line of menu prompt. */
164 static Lisp_Object menu_prompt_more_char
;
166 /* For longjmp to where kbd input is being done. */
168 static jmp_buf getcjmp
;
170 /* True while doing kbd input. */
171 int waiting_for_input
;
173 /* True while displaying for echoing. Delays C-g throwing. */
177 /* Non-null means we can start echoing at the next input pause even
178 though there is something in the echo area. */
180 static struct kboard
*ok_to_echo_at_next_pause
;
182 /* The kboard last echoing, or null for none. Reset to 0 in
183 cancel_echoing. If non-null, and a current echo area message
184 exists, and echo_message_buffer is eq to the current message
185 buffer, we know that the message comes from echo_kboard. */
187 struct kboard
*echo_kboard
;
189 /* The buffer used for echoing. Set in echo_now, reset in
192 Lisp_Object echo_message_buffer
;
194 /* Nonzero means disregard local maps for the menu bar. */
195 static int inhibit_local_menu_bar_menus
;
197 /* Nonzero means C-g should cause immediate error-signal. */
200 /* The user's hook function for outputting an error message. */
201 Lisp_Object Vcommand_error_function
;
203 /* The user's ERASE setting. */
204 Lisp_Object Vtty_erase_char
;
206 /* Character to recognize as the help char. */
207 Lisp_Object Vhelp_char
;
209 /* List of other event types to recognize as meaning "help". */
210 Lisp_Object Vhelp_event_list
;
212 /* Form to execute when help char is typed. */
213 Lisp_Object Vhelp_form
;
215 /* Command to run when the help character follows a prefix key. */
216 Lisp_Object Vprefix_help_command
;
218 /* List of items that should move to the end of the menu bar. */
219 Lisp_Object Vmenu_bar_final_items
;
221 /* Non-nil means show the equivalent key-binding for
222 any M-x command that has one.
223 The value can be a length of time to show the message for.
224 If the value is non-nil and not a number, we wait 2 seconds. */
225 Lisp_Object Vsuggest_key_bindings
;
227 /* How long to display an echo-area message when the minibuffer is active.
228 If the value is not a number, such messages don't time out. */
229 Lisp_Object Vminibuffer_message_timeout
;
231 /* Character that causes a quit. Normally C-g.
233 If we are running on an ordinary terminal, this must be an ordinary
234 ASCII char, since we want to make it our interrupt character.
236 If we are not running on an ordinary terminal, it still needs to be
237 an ordinary ASCII char. This character needs to be recognized in
238 the input interrupt handler. At this point, the keystroke is
239 represented as a struct input_event, while the desired quit
240 character is specified as a lispy event. The mapping from struct
241 input_events to lispy events cannot run in an interrupt handler,
242 and the reverse mapping is difficult for anything but ASCII
245 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
249 /* If non-nil, this is a map that overrides all other local maps. */
250 Lisp_Object Voverriding_local_map
;
252 /* If non-nil, Voverriding_local_map applies to the menu bar. */
253 Lisp_Object Voverriding_local_map_menu_flag
;
255 /* Keymap that defines special misc events that should
256 be processed immediately at a low level. */
257 Lisp_Object Vspecial_event_map
;
259 /* Current depth in recursive edits. */
260 int command_loop_level
;
262 /* Total number of times command_loop has read a key sequence. */
263 EMACS_INT num_input_keys
;
265 /* Last input event read as a command. */
266 Lisp_Object last_command_event
;
268 /* Last input character read as a command, not counting menus
269 reached by the mouse. */
270 Lisp_Object last_nonmenu_event
;
272 /* Last input event read for any purpose. */
273 Lisp_Object last_input_event
;
275 /* If not Qnil, a list of objects to be read as subsequent command input. */
276 Lisp_Object Vunread_command_events
;
278 /* If not Qnil, a list of objects to be read as subsequent command input
279 including input method processing. */
280 Lisp_Object Vunread_input_method_events
;
282 /* If not Qnil, a list of objects to be read as subsequent command input
283 but NOT including input method processing. */
284 Lisp_Object Vunread_post_input_method_events
;
286 /* If not -1, an event to be read as subsequent command input. */
287 EMACS_INT unread_command_char
;
289 /* If not Qnil, this is a switch-frame event which we decided to put
290 off until the end of a key sequence. This should be read as the
291 next command input, after any unread_command_events.
293 read_key_sequence uses this to delay switch-frame events until the
294 end of the key sequence; Fread_char uses it to put off switch-frame
295 events until a non-ASCII event is acceptable as input. */
296 Lisp_Object unread_switch_frame
;
298 /* A mask of extra modifier bits to put into every keyboard char. */
299 EMACS_INT extra_keyboard_modifiers
;
301 /* Char to use as prefix when a meta character is typed in.
302 This is bound on entry to minibuffer in case ESC is changed there. */
304 Lisp_Object meta_prefix_char
;
306 /* Last size recorded for a current buffer which is not a minibuffer. */
307 static int last_non_minibuf_size
;
309 /* Number of idle seconds before an auto-save and garbage collection. */
310 static Lisp_Object Vauto_save_timeout
;
312 /* Total number of times read_char has returned. */
313 int num_input_events
;
315 /* Total number of times read_char has returned, outside of macros. */
316 EMACS_INT num_nonmacro_input_events
;
318 /* Auto-save automatically when this many characters have been typed
319 since the last time. */
321 static EMACS_INT auto_save_interval
;
323 /* Value of num_nonmacro_input_events as of last auto save. */
327 /* The command being executed by the command loop.
328 Commands may set this, and the value set will be copied into
329 current_kboard->Vlast_command instead of the actual command. */
330 Lisp_Object Vthis_command
;
332 /* This is like Vthis_command, except that commands never set it. */
333 Lisp_Object real_this_command
;
335 /* If the lookup of the command returns a binding, the original
336 command is stored in this-original-command. It is nil otherwise. */
337 Lisp_Object Vthis_original_command
;
339 /* The value of point when the last command was started. */
340 int last_point_position
;
342 /* The buffer that was current when the last command was started. */
343 Lisp_Object last_point_position_buffer
;
345 /* The window that was selected when the last command was started. */
346 Lisp_Object last_point_position_window
;
348 /* The frame in which the last input event occurred, or Qmacro if the
349 last event came from a macro. We use this to determine when to
350 generate switch-frame events. This may be cleared by functions
351 like Fselect_frame, to make sure that a switch-frame event is
352 generated by the next character. */
353 Lisp_Object internal_last_event_frame
;
355 /* A user-visible version of the above, intended to allow users to
356 figure out where the last event came from, if the event doesn't
357 carry that information itself (i.e. if it was a character). */
358 Lisp_Object Vlast_event_frame
;
360 /* The timestamp of the last input event we received from the X server.
361 X Windows wants this for selection ownership. */
362 unsigned long last_event_timestamp
;
364 /* If non-nil, active regions automatically become the window selection. */
365 Lisp_Object Vselect_active_regions
;
367 /* The text in the active region prior to modifying the buffer.
368 Used by the `select-active-regions' feature. */
369 Lisp_Object Vsaved_region_selection
;
371 Lisp_Object Qx_set_selection
, QPRIMARY
;
373 Lisp_Object Qself_insert_command
;
374 Lisp_Object Qforward_char
;
375 Lisp_Object Qbackward_char
;
376 Lisp_Object Qundefined
;
377 Lisp_Object Qtimer_event_handler
;
379 /* read_key_sequence stores here the command definition of the
380 key sequence that it reads. */
381 Lisp_Object read_key_sequence_cmd
;
383 /* Echo unfinished commands after this many seconds of pause. */
384 Lisp_Object Vecho_keystrokes
;
386 /* Form to evaluate (if non-nil) when Emacs is started. */
387 Lisp_Object Vtop_level
;
389 /* If non-nil, this implements the current input method. */
390 Lisp_Object Vinput_method_function
;
391 Lisp_Object Qinput_method_function
;
393 /* When we call Vinput_method_function,
394 this holds the echo area message that was just erased. */
395 Lisp_Object Vinput_method_previous_message
;
397 /* Non-nil means deactivate the mark at end of this command. */
398 Lisp_Object Vdeactivate_mark
;
399 Lisp_Object Qdeactivate_mark
;
401 /* Menu bar specified in Lucid Emacs fashion. */
403 Lisp_Object Vlucid_menu_bar_dirty_flag
;
404 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
406 Lisp_Object Qecho_area_clear_hook
;
408 /* Hooks to run before and after each command. */
409 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
410 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
411 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
413 /* Parent keymap of terminal-local function-key-map instances. */
414 Lisp_Object Vfunction_key_map
;
416 /* Keymap of key translations that can override keymaps. */
417 Lisp_Object Vkey_translation_map
;
419 /* List of deferred actions to be performed at a later time.
420 The precise format isn't relevant here; we just check whether it is nil. */
421 Lisp_Object Vdeferred_action_list
;
423 /* Function to call to handle deferred actions, when there are any. */
424 Lisp_Object Vdeferred_action_function
;
425 Lisp_Object Qdeferred_action_function
;
427 Lisp_Object Qinput_method_exit_on_first_char
;
428 Lisp_Object Qinput_method_use_echo_area
;
430 /* File in which we write all commands we read. */
433 /* Nonzero if input is available. */
436 extern char *pending_malloc_warning
;
438 /* Circular buffer for pre-read keyboard input. */
440 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
442 /* Pointer to next available character in kbd_buffer.
443 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
444 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
445 next available char is in kbd_buffer[0]. */
446 static struct input_event
*kbd_fetch_ptr
;
448 /* Pointer to next place to store character in kbd_buffer. This
449 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
450 character should go in kbd_buffer[0]. */
451 static struct input_event
* volatile kbd_store_ptr
;
453 /* The above pair of variables forms a "queue empty" flag. When we
454 enqueue a non-hook event, we increment kbd_store_ptr. When we
455 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
456 there is input available if the two pointers are not equal.
458 Why not just have a flag set and cleared by the enqueuing and
459 dequeuing functions? Such a flag could be screwed up by interrupts
460 at inopportune times. */
462 /* If this flag is non-nil, we check mouse_moved to see when the
463 mouse moves, and motion events will appear in the input stream.
464 Otherwise, mouse motion is ignored. */
465 Lisp_Object do_mouse_tracking
;
467 /* Symbols to head events. */
468 Lisp_Object Qmouse_movement
;
469 Lisp_Object Qscroll_bar_movement
;
470 Lisp_Object Qswitch_frame
;
471 Lisp_Object Qdelete_frame
;
472 Lisp_Object Qiconify_frame
;
473 Lisp_Object Qmake_frame_visible
;
474 Lisp_Object Qselect_window
;
475 Lisp_Object Qhelp_echo
;
477 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
478 Lisp_Object Qmouse_fixup_help_message
;
481 /* Symbols to denote kinds of events. */
482 Lisp_Object Qfunction_key
;
483 Lisp_Object Qmouse_click
;
484 #if defined (WINDOWSNT)
485 Lisp_Object Qlanguage_change
;
487 Lisp_Object Qdrag_n_drop
;
488 Lisp_Object Qsave_session
;
490 Lisp_Object Qdbus_event
;
492 Lisp_Object Qconfig_changed_event
;
494 /* Lisp_Object Qmouse_movement; - also an event header */
496 /* Properties of event headers. */
497 Lisp_Object Qevent_kind
;
498 Lisp_Object Qevent_symbol_elements
;
500 /* menu item parts */
501 Lisp_Object Qmenu_enable
;
502 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
503 Lisp_Object QCbutton
, QCtoggle
, QCradio
, QClabel
;
505 /* An event header symbol HEAD may have a property named
506 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
507 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
508 mask of modifiers applied to it. If present, this is used to help
509 speed up parse_modifiers. */
510 Lisp_Object Qevent_symbol_element_mask
;
512 /* An unmodified event header BASE may have a property named
513 Qmodifier_cache, which is an alist mapping modifier masks onto
514 modified versions of BASE. If present, this helps speed up
516 Lisp_Object Qmodifier_cache
;
518 /* Symbols to use for parts of windows. */
519 Lisp_Object Qmode_line
;
520 Lisp_Object Qvertical_line
;
521 Lisp_Object Qvertical_scroll_bar
;
522 Lisp_Object Qmenu_bar
;
524 Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
), command_loop (void);
525 Lisp_Object
Fthis_command_keys (void);
526 Lisp_Object Qextended_command_history
;
527 EMACS_TIME
timer_check (int do_it_now
);
529 static void record_menu_key (Lisp_Object c
);
530 static int echo_length (void);
532 Lisp_Object Qpolling_period
;
534 /* List of absolute timers. Appears in order of next scheduled event. */
535 Lisp_Object Vtimer_list
;
537 /* List of idle time timers. Appears in order of next scheduled event. */
538 Lisp_Object Vtimer_idle_list
;
540 /* Incremented whenever a timer is run. */
543 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
545 EMACS_TIME
*input_available_clear_time
;
547 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
548 Default is 1 if INTERRUPT_INPUT is defined. */
551 /* Nonzero while interrupts are temporarily deferred during redisplay. */
552 int interrupts_deferred
;
554 /* Allow m- file to inhibit use of FIONREAD. */
555 #ifdef BROKEN_FIONREAD
559 /* We are unable to use interrupts if FIONREAD is not available,
560 so flush SIGIO so we won't try. */
561 #if !defined (FIONREAD)
567 /* If we support a window system, turn on the code to poll periodically
568 to detect C-g. It isn't actually used when doing interrupt input. */
569 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
570 #define POLL_FOR_INPUT
573 /* After a command is executed, if point is moved into a region that
574 has specific properties (e.g. composition, display), we adjust
575 point to the boundary of the region. But, if a command sets this
576 variable to non-nil, we suppress this point adjustment. This
577 variable is set to nil before reading a command. */
579 Lisp_Object Vdisable_point_adjustment
;
581 /* If non-nil, always disable point adjustment. */
583 Lisp_Object Vglobal_disable_point_adjustment
;
585 /* The time when Emacs started being idle. */
587 static EMACS_TIME timer_idleness_start_time
;
589 /* After Emacs stops being idle, this saves the last value
590 of timer_idleness_start_time from when it was idle. */
592 static EMACS_TIME timer_last_idleness_start_time
;
594 /* If non-nil, events produced by disabled menu items and tool-bar
595 buttons are not ignored. Help functions bind this to allow help on
596 those items and buttons. */
597 Lisp_Object Venable_disabled_menus_and_buttons
;
600 /* Global variable declarations. */
602 /* Flags for readable_events. */
603 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
604 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
605 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
607 /* Function for init_keyboard to call with no args (if nonzero). */
608 void (*keyboard_init_hook
) (void);
610 static int read_avail_input (int);
611 static void get_input_pending (int *, int);
612 static int readable_events (int);
613 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
615 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
617 static Lisp_Object
make_lispy_event (struct input_event
*);
618 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
619 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
620 enum scroll_bar_part
,
621 Lisp_Object
, Lisp_Object
,
624 static Lisp_Object
modify_event_symbol (int, unsigned, Lisp_Object
,
625 Lisp_Object
, const char **,
626 Lisp_Object
*, unsigned);
627 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
628 static void save_getcjmp (jmp_buf);
629 static void restore_getcjmp (jmp_buf);
630 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
631 static void clear_event (struct input_event
*);
632 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
633 static SIGTYPE
interrupt_signal (int signalnum
);
635 static SIGTYPE
input_available_signal (int signo
);
637 static void handle_interrupt (void);
638 static void timer_start_idle (void);
639 static void timer_stop_idle (void);
640 static void timer_resume_idle (void);
641 static SIGTYPE
handle_user_signal (int);
642 static char *find_user_signal_name (int);
643 static int store_user_signal_events (void);
645 /* Nonzero means don't try to suspend even if the operating system seems
647 static int cannot_suspend
;
650 /* Install the string STR as the beginning of the string of echoing,
651 so that it serves as a prompt for the next character.
652 Also start echoing. */
655 echo_prompt (Lisp_Object str
)
657 current_kboard
->echo_string
= str
;
658 current_kboard
->echo_after_prompt
= SCHARS (str
);
662 /* Add C to the echo string, if echoing is going on.
663 C can be a character, which is printed prettily ("M-C-x" and all that
664 jazz), or a symbol, whose name is printed. */
667 echo_char (Lisp_Object c
)
669 if (current_kboard
->immediate_echo
)
671 int size
= KEY_DESCRIPTION_SIZE
+ 100;
672 char *buffer
= (char *) alloca (size
);
674 Lisp_Object echo_string
;
676 echo_string
= current_kboard
->echo_string
;
678 /* If someone has passed us a composite event, use its head symbol. */
683 ptr
= push_key_description (XINT (c
), ptr
, 1);
685 else if (SYMBOLP (c
))
687 Lisp_Object name
= SYMBOL_NAME (c
);
688 int nbytes
= SBYTES (name
);
690 if (size
- (ptr
- buffer
) < nbytes
)
692 int offset
= ptr
- buffer
;
693 size
= max (2 * size
, size
+ nbytes
);
694 buffer
= (char *) alloca (size
);
695 ptr
= buffer
+ offset
;
698 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
699 STRING_MULTIBYTE (name
), 1);
702 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
705 const char *text
= " (Type ? for further options)";
706 int len
= strlen (text
);
708 if (size
- (ptr
- buffer
) < len
)
710 int offset
= ptr
- buffer
;
712 buffer
= (char *) alloca (size
);
713 ptr
= buffer
+ offset
;
716 memcpy (ptr
, text
, len
);
720 /* Replace a dash from echo_dash with a space, otherwise
721 add a space at the end as a separator between keys. */
722 if (STRINGP (echo_string
)
723 && SCHARS (echo_string
) > 1)
725 Lisp_Object last_char
, prev_char
, idx
;
727 idx
= make_number (SCHARS (echo_string
) - 2);
728 prev_char
= Faref (echo_string
, idx
);
730 idx
= make_number (SCHARS (echo_string
) - 1);
731 last_char
= Faref (echo_string
, idx
);
733 /* We test PREV_CHAR to make sure this isn't the echoing
735 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
736 Faset (echo_string
, idx
, make_number (' '));
738 echo_string
= concat2 (echo_string
, build_string (" "));
740 else if (STRINGP (echo_string
))
741 echo_string
= concat2 (echo_string
, build_string (" "));
743 current_kboard
->echo_string
744 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
750 /* Temporarily add a dash to the end of the echo string if it's not
751 empty, so that it serves as a mini-prompt for the very next character. */
756 /* Do nothing if not echoing at all. */
757 if (NILP (current_kboard
->echo_string
))
760 if (!current_kboard
->immediate_echo
761 && SCHARS (current_kboard
->echo_string
) == 0)
764 /* Do nothing if we just printed a prompt. */
765 if (current_kboard
->echo_after_prompt
766 == SCHARS (current_kboard
->echo_string
))
769 /* Do nothing if we have already put a dash at the end. */
770 if (SCHARS (current_kboard
->echo_string
) > 1)
772 Lisp_Object last_char
, prev_char
, idx
;
774 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
775 prev_char
= Faref (current_kboard
->echo_string
, idx
);
777 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
778 last_char
= Faref (current_kboard
->echo_string
, idx
);
780 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
784 /* Put a dash at the end of the buffer temporarily,
785 but make it go away when the next character is added. */
786 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
791 /* Display the current echo string, and begin echoing if not already
797 if (!current_kboard
->immediate_echo
)
800 current_kboard
->immediate_echo
= 1;
802 for (i
= 0; i
< this_command_key_count
; i
++)
806 /* Set before_command_echo_length to the value that would
807 have been saved before the start of this subcommand in
808 command_loop_1, if we had already been echoing then. */
809 if (i
== this_single_command_key_start
)
810 before_command_echo_length
= echo_length ();
812 c
= XVECTOR (this_command_keys
)->contents
[i
];
813 if (! (EVENT_HAS_PARAMETERS (c
)
814 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
818 /* Set before_command_echo_length to the value that would
819 have been saved before the start of this subcommand in
820 command_loop_1, if we had already been echoing then. */
821 if (this_command_key_count
== this_single_command_key_start
)
822 before_command_echo_length
= echo_length ();
824 /* Put a dash at the end to invite the user to type more. */
829 message3_nolog (current_kboard
->echo_string
,
830 SBYTES (current_kboard
->echo_string
),
831 STRING_MULTIBYTE (current_kboard
->echo_string
));
834 /* Record in what buffer we echoed, and from which kboard. */
835 echo_message_buffer
= echo_area_buffer
[0];
836 echo_kboard
= current_kboard
;
838 if (waiting_for_input
&& !NILP (Vquit_flag
))
839 quit_throw_to_read_char ();
842 /* Turn off echoing, for the start of a new command. */
845 cancel_echoing (void)
847 current_kboard
->immediate_echo
= 0;
848 current_kboard
->echo_after_prompt
= -1;
849 current_kboard
->echo_string
= Qnil
;
850 ok_to_echo_at_next_pause
= NULL
;
852 echo_message_buffer
= Qnil
;
855 /* Return the length of the current echo string. */
860 return (STRINGP (current_kboard
->echo_string
)
861 ? SCHARS (current_kboard
->echo_string
)
865 /* Truncate the current echo message to its first LEN chars.
866 This and echo_char get used by read_key_sequence when the user
867 switches frames while entering a key sequence. */
870 echo_truncate (int nchars
)
872 if (STRINGP (current_kboard
->echo_string
))
873 current_kboard
->echo_string
874 = Fsubstring (current_kboard
->echo_string
,
875 make_number (0), make_number (nchars
));
876 truncate_echo_area (nchars
);
880 /* Functions for manipulating this_command_keys. */
882 add_command_key (Lisp_Object key
)
884 #if 0 /* Not needed after we made Freset_this_command_lengths
885 do the job immediately. */
886 /* If reset-this-command-length was called recently, obey it now.
887 See the doc string of that function for an explanation of why. */
888 if (before_command_restore_flag
)
890 this_command_key_count
= before_command_key_count_1
;
891 if (this_command_key_count
< this_single_command_key_start
)
892 this_single_command_key_start
= this_command_key_count
;
893 echo_truncate (before_command_echo_length_1
);
894 before_command_restore_flag
= 0;
898 if (this_command_key_count
>= ASIZE (this_command_keys
))
899 this_command_keys
= larger_vector (this_command_keys
,
900 2 * ASIZE (this_command_keys
),
903 ASET (this_command_keys
, this_command_key_count
, key
);
904 ++this_command_key_count
;
909 recursive_edit_1 (void)
911 int count
= SPECPDL_INDEX ();
914 if (command_loop_level
> 0)
916 specbind (Qstandard_output
, Qt
);
917 specbind (Qstandard_input
, Qt
);
920 #ifdef HAVE_WINDOW_SYSTEM
921 /* The command loop has started an hourglass timer, so we have to
922 cancel it here, otherwise it will fire because the recursive edit
923 can take some time. Do not check for display_hourglass_p here,
924 because it could already be nil. */
928 /* This function may have been called from a debugger called from
929 within redisplay, for instance by Edebugging a function called
930 from fontification-functions. We want to allow redisplay in
931 the debugging session.
933 The recursive edit is left with a `(throw exit ...)'. The `exit'
934 tag is not caught anywhere in redisplay, i.e. when we leave the
935 recursive edit, the original redisplay leading to the recursive
936 edit will be unwound. The outcome should therefore be safe. */
937 specbind (Qinhibit_redisplay
, Qnil
);
940 val
= command_loop ();
942 Fsignal (Qquit
, Qnil
);
943 /* Handle throw from read_minibuf when using minibuffer
944 while it's active but we're in another window. */
946 xsignal1 (Qerror
, val
);
948 return unbind_to (count
, Qnil
);
951 /* When an auto-save happens, record the "time", and don't do again soon. */
954 record_auto_save (void)
956 last_auto_save
= num_nonmacro_input_events
;
959 /* Make an auto save happen as soon as possible at command level. */
962 force_auto_save_soon (void)
964 last_auto_save
= - auto_save_interval
- 1;
966 record_asynch_buffer_change ();
969 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
970 doc
: /* Invoke the editor command loop recursively.
971 To get out of the recursive edit, a command can do `(throw 'exit nil)';
972 that tells this function to return.
973 Alternatively, `(throw 'exit t)' makes this function signal an error.
974 This function is called by the editor initialization to begin editing. */)
977 int count
= SPECPDL_INDEX ();
980 /* If we enter while input is blocked, don't lock up here.
981 This may happen through the debugger during redisplay. */
985 command_loop_level
++;
986 update_mode_lines
= 1;
988 if (command_loop_level
989 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
990 buffer
= Fcurrent_buffer ();
994 /* If we leave recursive_edit_1 below with a `throw' for instance,
995 like it is done in the splash screen display, we have to
996 make sure that we restore single_kboard as command_loop_1
997 would have done if it were left normally. */
998 if (command_loop_level
> 0)
999 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1000 record_unwind_protect (recursive_edit_unwind
, buffer
);
1002 recursive_edit_1 ();
1003 return unbind_to (count
, Qnil
);
1007 recursive_edit_unwind (Lisp_Object buffer
)
1009 if (BUFFERP (buffer
))
1010 Fset_buffer (buffer
);
1012 command_loop_level
--;
1013 update_mode_lines
= 1;
1018 #if 0 /* These two functions are now replaced with
1019 temporarily_switch_to_single_kboard. */
1023 #if 0 /* Theory: if there's anything in Vunread_command_events,
1024 it will right away be read by read_key_sequence,
1025 and then if we do switch KBOARDS, it will go into the side
1026 queue then. So we don't need to do anything special here -- rms. */
1027 if (CONSP (Vunread_command_events
))
1029 current_kboard
->kbd_queue
1030 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1031 current_kboard
->kbd_queue_has_data
= 1;
1033 Vunread_command_events
= Qnil
;
1038 /* Switch to the single-kboard state, making current_kboard
1039 the only KBOARD from which further input is accepted. */
1042 single_kboard_state ()
1048 /* If we're in single_kboard state for kboard KBOARD,
1052 not_single_kboard_state (KBOARD
*kboard
)
1054 if (kboard
== current_kboard
)
1058 /* Maintain a stack of kboards, so other parts of Emacs
1059 can switch temporarily to the kboard of a given frame
1060 and then revert to the previous status. */
1065 struct kboard_stack
*next
;
1068 static struct kboard_stack
*kboard_stack
;
1071 push_kboard (struct kboard
*k
)
1073 struct kboard_stack
*p
1074 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1076 p
->next
= kboard_stack
;
1077 p
->kboard
= current_kboard
;
1087 struct kboard_stack
*p
= kboard_stack
;
1089 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1091 if (t
->kboard
== p
->kboard
)
1093 current_kboard
= p
->kboard
;
1100 /* The terminal we remembered has been deleted. */
1101 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1104 kboard_stack
= p
->next
;
1108 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1109 from which further input is accepted. If F is non-nil, set its
1110 KBOARD as the current keyboard.
1112 This function uses record_unwind_protect to return to the previous
1115 If Emacs is already in single_kboard mode, and F's keyboard is
1116 locked, then this function will throw an errow. */
1119 temporarily_switch_to_single_kboard (struct frame
*f
)
1121 int was_locked
= single_kboard
;
1124 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1125 /* We can not switch keyboards while in single_kboard mode.
1126 In rare cases, Lisp code may call `recursive-edit' (or
1127 `read-minibuffer' or `y-or-n-p') after it switched to a
1128 locked frame. For example, this is likely to happen
1129 when server.el connects to a new terminal while Emacs is in
1130 single_kboard mode. It is best to throw an error instead
1131 of presenting the user with a frozen screen. */
1132 error ("Terminal %d is locked, cannot read from it",
1133 FRAME_TERMINAL (f
)->id
);
1135 /* This call is unnecessary, but helps
1136 `restore_kboard_configuration' discover if somebody changed
1137 `current_kboard' behind our back. */
1138 push_kboard (current_kboard
);
1141 current_kboard
= FRAME_KBOARD (f
);
1143 record_unwind_protect (restore_kboard_configuration
,
1144 (was_locked
? Qt
: Qnil
));
1147 #if 0 /* This function is not needed anymore. */
1149 record_single_kboard_state ()
1152 push_kboard (current_kboard
);
1153 record_unwind_protect (restore_kboard_configuration
,
1154 (single_kboard
? Qt
: Qnil
));
1159 restore_kboard_configuration (Lisp_Object was_locked
)
1161 if (NILP (was_locked
))
1165 struct kboard
*prev
= current_kboard
;
1168 /* The pop should not change the kboard. */
1169 if (single_kboard
&& current_kboard
!= prev
)
1176 /* Handle errors that are not handled at inner levels
1177 by printing an error message and returning to the editor command loop. */
1180 cmd_error (Lisp_Object data
)
1182 Lisp_Object old_level
, old_length
;
1183 char macroerror
[50];
1185 #ifdef HAVE_WINDOW_SYSTEM
1186 if (display_hourglass_p
)
1187 cancel_hourglass ();
1190 if (!NILP (executing_kbd_macro
))
1192 if (executing_kbd_macro_iterations
== 1)
1193 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1195 sprintf (macroerror
, "After %d kbd macro iterations: ",
1196 executing_kbd_macro_iterations
);
1201 Vstandard_output
= Qt
;
1202 Vstandard_input
= Qt
;
1203 Vexecuting_kbd_macro
= Qnil
;
1204 executing_kbd_macro
= Qnil
;
1205 current_kboard
->Vprefix_arg
= Qnil
;
1206 current_kboard
->Vlast_prefix_arg
= Qnil
;
1209 /* Avoid unquittable loop if data contains a circular list. */
1210 old_level
= Vprint_level
;
1211 old_length
= Vprint_length
;
1212 XSETFASTINT (Vprint_level
, 10);
1213 XSETFASTINT (Vprint_length
, 10);
1214 cmd_error_internal (data
, macroerror
);
1215 Vprint_level
= old_level
;
1216 Vprint_length
= old_length
;
1220 Vinhibit_quit
= Qnil
;
1221 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1222 if (command_loop_level
== 0 && minibuf_level
== 0)
1223 any_kboard_state ();
1226 return make_number (0);
1229 /* Take actions on handling an error. DATA is the data that describes
1232 CONTEXT is a C-string containing ASCII characters only which
1233 describes the context in which the error happened. If we need to
1234 generalize CONTEXT to allow multibyte characters, make it a Lisp
1238 cmd_error_internal (Lisp_Object data
, const char *context
)
1240 struct frame
*sf
= SELECTED_FRAME ();
1242 /* The immediate context is not interesting for Quits,
1243 since they are asyncronous. */
1244 if (EQ (XCAR (data
), Qquit
))
1245 Vsignaling_function
= Qnil
;
1250 /* Use user's specified output function if any. */
1251 if (!NILP (Vcommand_error_function
))
1252 call3 (Vcommand_error_function
, data
,
1253 context
? build_string (context
) : empty_unibyte_string
,
1254 Vsignaling_function
);
1255 /* If the window system or terminal frame hasn't been initialized
1256 yet, or we're not interactive, write the message to stderr and exit. */
1257 else if (!sf
->glyphs_initialized_p
1258 /* The initial frame is a special non-displaying frame. It
1259 will be current in daemon mode when there are no frames
1260 to display, and in non-daemon mode before the real frame
1261 has finished initializing. If an error is thrown in the
1262 latter case while creating the frame, then the frame
1263 will never be displayed, so the safest thing to do is
1264 write to stderr and quit. In daemon mode, there are
1265 many other potential errors that do not prevent frames
1266 from being created, so continuing as normal is better in
1268 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1271 print_error_message (data
, Qexternal_debugging_output
,
1272 context
, Vsignaling_function
);
1273 Fterpri (Qexternal_debugging_output
);
1274 Fkill_emacs (make_number (-1));
1278 clear_message (1, 0);
1280 message_log_maybe_newline ();
1283 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1286 Vsignaling_function
= Qnil
;
1289 Lisp_Object
command_loop_1 (void);
1290 Lisp_Object
command_loop_2 (Lisp_Object
);
1291 Lisp_Object
top_level_1 (Lisp_Object
);
1293 /* Entry to editor-command-loop.
1294 This level has the catches for exiting/returning to editor command loop.
1295 It returns nil to exit recursive edit, t to abort it. */
1300 if (command_loop_level
> 0 || minibuf_level
> 0)
1303 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1304 executing_kbd_macro
= Qnil
;
1310 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1311 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1312 /* Reset single_kboard in case top-level set it while
1313 evaluating an -f option, or we are stuck there for some
1315 any_kboard_state ();
1317 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1318 executing_kbd_macro
= Qnil
;
1320 /* End of file in -batch run causes exit here. */
1326 /* Here we catch errors in execution of commands within the
1327 editing loop, and reenter the editing loop.
1328 When there is an error, cmd_error runs and returns a non-nil
1329 value to us. A value of nil means that command_loop_1 itself
1330 returned due to end of file (or end of kbd macro). */
1333 command_loop_2 (Lisp_Object ignore
)
1335 register Lisp_Object val
;
1338 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1339 while (!NILP (val
));
1347 return Feval (Vtop_level
);
1351 top_level_1 (Lisp_Object ignore
)
1353 /* On entry to the outer level, run the startup file */
1354 if (!NILP (Vtop_level
))
1355 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1356 else if (!NILP (Vpurify_flag
))
1357 message ("Bare impure Emacs (standard Lisp code not loaded)");
1359 message ("Bare Emacs (standard Lisp code not loaded)");
1363 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1364 doc
: /* Exit all recursive editing levels.
1365 This also exits all active minibuffers. */)
1368 #ifdef HAVE_WINDOW_SYSTEM
1369 if (display_hourglass_p
)
1370 cancel_hourglass ();
1373 /* Unblock input if we enter with input blocked. This may happen if
1374 redisplay traps e.g. during tool-bar update with input blocked. */
1375 while (INPUT_BLOCKED_P
)
1378 Fthrow (Qtop_level
, Qnil
);
1381 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1382 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1385 if (command_loop_level
> 0 || minibuf_level
> 0)
1386 Fthrow (Qexit
, Qnil
);
1388 error ("No recursive edit is in progress");
1391 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1392 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1395 if (command_loop_level
> 0 || minibuf_level
> 0)
1398 error ("No recursive edit is in progress");
1401 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1403 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1404 of this function. */
1407 tracking_off (Lisp_Object old_value
)
1409 do_mouse_tracking
= old_value
;
1410 if (NILP (old_value
))
1412 /* Redisplay may have been preempted because there was input
1413 available, and it assumes it will be called again after the
1414 input has been processed. If the only input available was
1415 the sort that we have just disabled, then we need to call
1417 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1419 redisplay_preserve_echo_area (6);
1420 get_input_pending (&input_pending
,
1421 READABLE_EVENTS_DO_TIMERS_NOW
);
1427 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1428 doc
: /* Evaluate BODY with mouse movement events enabled.
1429 Within a `track-mouse' form, mouse motion generates input events that
1430 you can read with `read-event'.
1431 Normally, mouse motion is ignored.
1432 usage: (track-mouse BODY...) */)
1435 int count
= SPECPDL_INDEX ();
1438 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1440 do_mouse_tracking
= Qt
;
1442 val
= Fprogn (args
);
1443 return unbind_to (count
, val
);
1446 /* If mouse has moved on some frame, return one of those frames.
1450 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1451 after resizing the tool-bar window. */
1453 int ignore_mouse_drag_p
;
1456 some_mouse_moved (void)
1458 Lisp_Object tail
, frame
;
1460 if (ignore_mouse_drag_p
)
1462 /* ignore_mouse_drag_p = 0; */
1466 FOR_EACH_FRAME (tail
, frame
)
1468 if (XFRAME (frame
)->mouse_moved
)
1469 return XFRAME (frame
);
1475 #endif /* HAVE_MOUSE || HAVE_GPM */
1477 /* This is the actual command reading loop,
1478 sans error-handling encapsulation. */
1480 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1482 void safe_run_hooks (Lisp_Object
);
1483 static void adjust_point_for_property (int, int);
1485 /* Cancel hourglass from protect_unwind.
1487 #ifdef HAVE_WINDOW_SYSTEM
1489 cancel_hourglass_unwind (Lisp_Object arg
)
1491 cancel_hourglass ();
1497 command_loop_1 (void)
1500 Lisp_Object keybuf
[30];
1502 int prev_modiff
= 0;
1503 struct buffer
*prev_buffer
= NULL
;
1504 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1505 int was_locked
= single_kboard
;
1507 int already_adjusted
= 0;
1509 current_kboard
->Vprefix_arg
= Qnil
;
1510 current_kboard
->Vlast_prefix_arg
= Qnil
;
1511 Vdeactivate_mark
= Qnil
;
1512 waiting_for_input
= 0;
1515 this_command_key_count
= 0;
1516 this_command_key_count_reset
= 0;
1517 this_single_command_key_start
= 0;
1519 if (NILP (Vmemory_full
))
1521 /* Make sure this hook runs after commands that get errors and
1522 throw to top level. */
1523 /* Note that the value cell will never directly contain nil
1524 if the symbol is a local variable. */
1525 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1526 safe_run_hooks (Qpost_command_hook
);
1528 /* If displaying a message, resize the echo area window to fit
1529 that message's size exactly. */
1530 if (!NILP (echo_area_buffer
[0]))
1531 resize_echo_area_exactly ();
1533 if (!NILP (Vdeferred_action_list
))
1534 safe_run_hooks (Qdeferred_action_function
);
1537 /* Do this after running Vpost_command_hook, for consistency. */
1538 current_kboard
->Vlast_command
= Vthis_command
;
1539 current_kboard
->Vreal_last_command
= real_this_command
;
1540 if (!CONSP (last_command_event
))
1541 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1545 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1548 /* Make sure the current window's buffer is selected. */
1549 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1550 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1552 /* Display any malloc warning that just came out. Use while because
1553 displaying one warning can cause another. */
1555 while (pending_malloc_warning
)
1556 display_malloc_warning ();
1558 Vdeactivate_mark
= Qnil
;
1560 /* If minibuffer on and echo area in use,
1561 wait a short time and redraw minibuffer. */
1564 && !NILP (echo_area_buffer
[0])
1565 && EQ (minibuf_window
, echo_area_window
)
1566 && NUMBERP (Vminibuffer_message_timeout
))
1568 /* Bind inhibit-quit to t so that C-g gets read in
1569 rather than quitting back to the minibuffer. */
1570 int count
= SPECPDL_INDEX ();
1571 specbind (Qinhibit_quit
, Qt
);
1573 sit_for (Vminibuffer_message_timeout
, 0, 2);
1575 /* Clear the echo area. */
1577 safe_run_hooks (Qecho_area_clear_hook
);
1579 unbind_to (count
, Qnil
);
1581 /* If a C-g came in before, treat it as input now. */
1582 if (!NILP (Vquit_flag
))
1585 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1590 /* Select the frame that the last event came from. Usually,
1591 switch-frame events will take care of this, but if some lisp
1592 code swallows a switch-frame event, we'll fix things up here.
1593 Is this a good idea? */
1594 if (FRAMEP (internal_last_event_frame
)
1595 && !EQ (internal_last_event_frame
, selected_frame
))
1596 Fselect_frame (internal_last_event_frame
, Qnil
);
1598 /* If it has changed current-menubar from previous value,
1599 really recompute the menubar from the value. */
1600 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1601 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1602 call0 (Qrecompute_lucid_menubar
);
1604 before_command_key_count
= this_command_key_count
;
1605 before_command_echo_length
= echo_length ();
1607 Vthis_command
= Qnil
;
1608 real_this_command
= Qnil
;
1609 Vthis_original_command
= Qnil
;
1610 Vthis_command_keys_shift_translated
= Qnil
;
1612 /* Read next key sequence; i gets its length. */
1613 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1616 /* A filter may have run while we were reading the input. */
1617 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1619 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1620 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1624 /* Now we have read a key sequence of length I,
1625 or else I is 0 and we found end of file. */
1627 if (i
== 0) /* End of file -- happens only in */
1628 return Qnil
; /* a kbd macro, at the end. */
1629 /* -1 means read_key_sequence got a menu that was rejected.
1630 Just loop around and read another command. */
1634 this_command_key_count
= 0;
1635 this_command_key_count_reset
= 0;
1636 this_single_command_key_start
= 0;
1640 last_command_event
= keybuf
[i
- 1];
1642 /* If the previous command tried to force a specific window-start,
1643 forget about that, in case this command moves point far away
1644 from that position. But also throw away beg_unchanged and
1645 end_unchanged information in that case, so that redisplay will
1646 update the whole window properly. */
1647 if (!NILP (XWINDOW (selected_window
)->force_start
))
1650 XWINDOW (selected_window
)->force_start
= Qnil
;
1651 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1652 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1655 cmd
= read_key_sequence_cmd
;
1656 if (!NILP (Vexecuting_kbd_macro
))
1658 if (!NILP (Vquit_flag
))
1660 Vexecuting_kbd_macro
= Qt
;
1661 QUIT
; /* Make some noise. */
1662 /* Will return since macro now empty. */
1666 /* Do redisplay processing after this command except in special
1667 cases identified below. */
1668 prev_buffer
= current_buffer
;
1669 prev_modiff
= MODIFF
;
1670 last_point_position
= PT
;
1671 last_point_position_window
= selected_window
;
1672 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1674 /* By default, we adjust point to a boundary of a region that
1675 has such a property that should be treated intangible
1676 (e.g. composition, display). But, some commands will set
1677 this variable differently. */
1678 Vdisable_point_adjustment
= Qnil
;
1680 /* Process filters and timers may have messed with deactivate-mark.
1681 reset it before we execute the command. */
1682 Vdeactivate_mark
= Qnil
;
1684 /* Remap command through active keymaps */
1685 Vthis_original_command
= cmd
;
1689 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1693 /* Execute the command. */
1695 Vthis_command
= cmd
;
1696 real_this_command
= cmd
;
1697 /* Note that the value cell will never directly contain nil
1698 if the symbol is a local variable. */
1699 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1700 safe_run_hooks (Qpre_command_hook
);
1702 already_adjusted
= 0;
1704 if (NILP (Vthis_command
))
1706 /* nil means key is undefined. */
1707 Lisp_Object keys
= Fvector (i
, keybuf
);
1708 keys
= Fkey_description (keys
, Qnil
);
1710 message_with_string ("%s is undefined", keys
, 0);
1711 current_kboard
->defining_kbd_macro
= Qnil
;
1712 update_mode_lines
= 1;
1713 current_kboard
->Vprefix_arg
= Qnil
;
1717 /* Here for a command that isn't executed directly */
1719 #ifdef HAVE_WINDOW_SYSTEM
1720 int scount
= SPECPDL_INDEX ();
1722 if (display_hourglass_p
1723 && NILP (Vexecuting_kbd_macro
))
1725 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1730 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1732 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1734 #ifdef HAVE_WINDOW_SYSTEM
1735 /* Do not check display_hourglass_p here, because
1736 Fcommand_execute could change it, but we should cancel
1737 hourglass cursor anyway.
1738 But don't cancel the hourglass within a macro
1739 just because a command in the macro finishes. */
1740 if (NILP (Vexecuting_kbd_macro
))
1741 unbind_to (scount
, Qnil
);
1744 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1746 /* Note that the value cell will never directly contain nil
1747 if the symbol is a local variable. */
1748 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1749 safe_run_hooks (Qpost_command_hook
);
1751 /* If displaying a message, resize the echo area window to fit
1752 that message's size exactly. */
1753 if (!NILP (echo_area_buffer
[0]))
1754 resize_echo_area_exactly ();
1756 if (!NILP (Vdeferred_action_list
))
1757 safe_run_hooks (Qdeferred_action_function
);
1759 /* If there is a prefix argument,
1760 1) We don't want Vlast_command to be ``universal-argument''
1761 (that would be dumb), so don't set Vlast_command,
1762 2) we want to leave echoing on so that the prefix will be
1763 echoed as part of this key sequence, so don't call
1765 3) we want to leave this_command_key_count non-zero, so that
1766 read_char will realize that it is re-reading a character, and
1767 not echo it a second time.
1769 If the command didn't actually create a prefix arg,
1770 but is merely a frame event that is transparent to prefix args,
1771 then the above doesn't apply. */
1772 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1774 current_kboard
->Vlast_command
= Vthis_command
;
1775 current_kboard
->Vreal_last_command
= real_this_command
;
1776 if (!CONSP (last_command_event
))
1777 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1779 this_command_key_count
= 0;
1780 this_command_key_count_reset
= 0;
1781 this_single_command_key_start
= 0;
1784 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1786 /* In Emacs 22, setting transient-mark-mode to `only' was a
1787 way of turning it on for just one command. This usage is
1788 obsolete, but support it anyway. */
1789 if (EQ (Vtransient_mark_mode
, Qidentity
))
1790 Vtransient_mark_mode
= Qnil
;
1791 else if (EQ (Vtransient_mark_mode
, Qonly
))
1792 Vtransient_mark_mode
= Qidentity
;
1794 if (!NILP (Vdeactivate_mark
))
1795 /* If `select-active-regions' is non-nil, this call to
1796 `deactivate-mark' also sets the PRIMARY selection. */
1797 call0 (Qdeactivate_mark
);
1800 /* Even if not deactivating the mark, set PRIMARY if
1801 `select-active-regions' is non-nil. */
1802 if (EQ (Vselect_active_regions
, Qonly
)
1803 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1804 : (!NILP (Vselect_active_regions
)
1805 && !NILP (Vtransient_mark_mode
)))
1807 int beg
= XINT (Fmarker_position (current_buffer
->mark
));
1808 int end
= XINT (make_number (PT
));
1810 call2 (Qx_set_selection
, QPRIMARY
,
1811 make_buffer_string (beg
, end
, 0));
1813 call2 (Qx_set_selection
, QPRIMARY
,
1814 make_buffer_string (end
, beg
, 0));
1815 /* Don't set empty selections. */
1818 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1819 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1822 Vsaved_region_selection
= Qnil
;
1827 if (current_buffer
== prev_buffer
1828 && last_point_position
!= PT
1829 && NILP (Vdisable_point_adjustment
)
1830 && NILP (Vglobal_disable_point_adjustment
))
1832 if (last_point_position
> BEGV
1833 && last_point_position
< ZV
1834 && (composition_adjust_point (last_point_position
,
1835 last_point_position
)
1836 != last_point_position
))
1837 /* The last point was temporarily set within a grapheme
1838 cluster to prevent automatic composition. To recover
1839 the automatic composition, we must update the
1841 windows_or_buffers_changed
++;
1842 if (!already_adjusted
)
1843 adjust_point_for_property (last_point_position
,
1844 MODIFF
!= prev_modiff
);
1847 /* Install chars successfully executed in kbd macro. */
1849 if (!NILP (current_kboard
->defining_kbd_macro
)
1850 && NILP (current_kboard
->Vprefix_arg
))
1851 finalize_kbd_macro_chars ();
1852 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1854 any_kboard_state ();
1859 /* Adjust point to a boundary of a region that has such a property
1860 that should be treated intangible. For the moment, we check
1861 `composition', `display' and `invisible' properties.
1862 LAST_PT is the last position of point. */
1865 adjust_point_for_property (int last_pt
, int modified
)
1868 Lisp_Object val
, overlay
, tmp
;
1869 /* When called after buffer modification, we should temporarily
1870 suppress the point adjustment for automatic composition so that a
1871 user can keep inserting another character at point or keep
1872 deleting characters around point. */
1873 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1876 /* FIXME: cycling is probably not necessary because these properties
1877 can't be usefully combined anyway. */
1878 while (check_composition
|| check_display
|| check_invisible
)
1880 /* FIXME: check `intangible'. */
1881 if (check_composition
1882 && PT
> BEGV
&& PT
< ZV
1883 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1886 check_display
= check_invisible
= 1;
1888 check_composition
= 0;
1890 && PT
> BEGV
&& PT
< ZV
1891 && !NILP (val
= get_char_property_and_overlay
1892 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1893 && display_prop_intangible_p (val
)
1894 && (!OVERLAYP (overlay
)
1895 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1896 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1897 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1898 && (beg
< PT
/* && end > PT <- It's always the case. */
1899 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1902 SET_PT (PT
< last_pt
1903 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1905 check_composition
= check_invisible
= 1;
1908 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1910 int inv
, ellipsis
= 0;
1913 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1916 /* FIXME: We should stop if we find a spot between
1917 two runs of `invisible' where inserted text would
1918 be visible. This is important when we have two
1919 invisible boundaries that enclose an area: if the
1920 area is empty, we need this test in order to make
1921 it possible to place point in the middle rather
1922 than skip both boundaries. However, this code
1923 also stops anywhere in a non-sticky text-property,
1924 which breaks (e.g.) Org mode. */
1925 && (val
= get_pos_property (make_number (end
),
1927 TEXT_PROP_MEANS_INVISIBLE (val
))
1929 && !NILP (val
= get_char_property_and_overlay
1930 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1931 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1933 ellipsis
= ellipsis
|| inv
> 1
1934 || (OVERLAYP (overlay
)
1935 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1936 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1937 tmp
= Fnext_single_char_property_change
1938 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1939 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1943 && (val
= get_pos_property (make_number (beg
),
1945 TEXT_PROP_MEANS_INVISIBLE (val
))
1947 && !NILP (val
= get_char_property_and_overlay
1948 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1949 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1951 ellipsis
= ellipsis
|| inv
> 1
1952 || (OVERLAYP (overlay
)
1953 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1954 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1955 tmp
= Fprevious_single_char_property_change
1956 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1957 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1960 /* Move away from the inside area. */
1961 if (beg
< PT
&& end
> PT
)
1963 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1964 /* We haven't moved yet (so we don't need to fear
1965 infinite-looping) and we were outside the range
1966 before (so either end of the range still corresponds
1967 to a move in the right direction): pretend we moved
1968 less than we actually did, so that we still have
1969 more freedom below in choosing which end of the range
1971 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1972 /* We either have moved already or the last point
1973 was already in the range: we don't get to choose
1974 which end of the range we have to go to. */
1975 : (PT
< last_pt
? beg
: end
));
1976 check_composition
= check_display
= 1;
1978 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1979 the point to something other than its argument, due to
1980 point-motion hooks, intangibility, etc. */
1981 xassert (PT
== beg
|| PT
== end
);
1984 /* Pretend the area doesn't exist if the buffer is not
1986 if (!modified
&& !ellipsis
&& beg
< end
)
1988 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1989 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1990 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1991 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1992 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1993 /* We've already moved as far as we can. Trying to go
1994 to the other end would mean moving backwards and thus
1995 could lead to an infinite loop. */
1997 else if (val
= get_pos_property (make_number (PT
),
1999 TEXT_PROP_MEANS_INVISIBLE (val
)
2000 && (val
= get_pos_property
2001 (make_number (PT
== beg
? end
: beg
),
2003 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2004 (check_composition
= check_display
= 1,
2005 SET_PT (PT
== beg
? end
: beg
));
2008 check_invisible
= 0;
2012 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2015 safe_run_hooks_1 (void)
2017 if (NILP (Vrun_hooks
))
2019 return call1 (Vrun_hooks
, Vinhibit_quit
);
2022 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2025 safe_run_hooks_error (Lisp_Object data
)
2027 Lisp_Object args
[3];
2028 args
[0] = build_string ("Error in %s: %s");
2029 args
[1] = Vinhibit_quit
;
2032 return Fset (Vinhibit_quit
, Qnil
);
2035 /* If we get an error while running the hook, cause the hook variable
2036 to be nil. Also inhibit quits, so that C-g won't cause the hook
2037 to mysteriously evaporate. */
2040 safe_run_hooks (Lisp_Object hook
)
2042 int count
= SPECPDL_INDEX ();
2043 specbind (Qinhibit_quit
, hook
);
2045 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2047 unbind_to (count
, Qnil
);
2051 /* Number of seconds between polling for input. This is a Lisp
2052 variable that can be bound. */
2054 EMACS_INT polling_period
;
2056 /* Nonzero means polling for input is temporarily suppressed. */
2058 int poll_suppress_count
;
2060 /* Asynchronous timer for polling. */
2062 struct atimer
*poll_timer
;
2065 #ifdef POLL_FOR_INPUT
2067 /* Poll for input, so that we catch a C-g if it comes in. This
2068 function is called from x_make_frame_visible, see comment
2072 poll_for_input_1 (void)
2074 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2075 doing anything dangerous. */
2079 if (interrupt_input_blocked
== 0
2080 && !waiting_for_input
)
2081 read_avail_input (0);
2087 /* Timer callback function for poll_timer. TIMER is equal to
2091 poll_for_input (struct atimer
*timer
)
2093 if (poll_suppress_count
== 0)
2096 interrupt_input_pending
= 1;
2097 pending_signals
= 1;
2099 poll_for_input_1 ();
2104 #endif /* POLL_FOR_INPUT */
2106 /* Begin signals to poll for input, if they are appropriate.
2107 This function is called unconditionally from various places. */
2110 start_polling (void)
2112 #ifdef POLL_FOR_INPUT
2113 /* XXX This condition was (read_socket_hook && !interrupt_input),
2114 but read_socket_hook is not global anymore. Let's pretend that
2116 if (!interrupt_input
)
2118 /* Turn alarm handling on unconditionally. It might have
2119 been turned off in process.c. */
2120 turn_on_atimers (1);
2122 /* If poll timer doesn't exist, are we need one with
2123 a different interval, start a new one. */
2124 if (poll_timer
== NULL
2125 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2127 EMACS_TIME interval
;
2130 cancel_atimer (poll_timer
);
2132 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2133 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2134 poll_for_input
, NULL
);
2137 /* Let the timer's callback function poll for input
2138 if this becomes zero. */
2139 --poll_suppress_count
;
2144 /* Nonzero if we are using polling to handle input asynchronously. */
2147 input_polling_used (void)
2149 #ifdef POLL_FOR_INPUT
2150 /* XXX This condition was (read_socket_hook && !interrupt_input),
2151 but read_socket_hook is not global anymore. Let's pretend that
2153 return !interrupt_input
;
2159 /* Turn off polling. */
2164 #ifdef POLL_FOR_INPUT
2165 /* XXX This condition was (read_socket_hook && !interrupt_input),
2166 but read_socket_hook is not global anymore. Let's pretend that
2168 if (!interrupt_input
)
2169 ++poll_suppress_count
;
2173 /* Set the value of poll_suppress_count to COUNT
2174 and start or stop polling accordingly. */
2177 set_poll_suppress_count (int count
)
2179 #ifdef POLL_FOR_INPUT
2180 if (count
== 0 && poll_suppress_count
!= 0)
2182 poll_suppress_count
= 1;
2185 else if (count
!= 0 && poll_suppress_count
== 0)
2189 poll_suppress_count
= count
;
2193 /* Bind polling_period to a value at least N.
2194 But don't decrease it. */
2197 bind_polling_period (int n
)
2199 #ifdef POLL_FOR_INPUT
2200 int new = polling_period
;
2205 stop_other_atimers (poll_timer
);
2207 specbind (Qpolling_period
, make_number (new));
2208 /* Start a new alarm with the new period. */
2213 /* Apply the control modifier to CHARACTER. */
2216 make_ctrl_char (int c
)
2218 /* Save the upper bits here. */
2219 int upper
= c
& ~0177;
2221 if (! ASCII_BYTE_P (c
))
2222 return c
|= ctrl_modifier
;
2226 /* Everything in the columns containing the upper-case letters
2227 denotes a control character. */
2228 if (c
>= 0100 && c
< 0140)
2232 /* Set the shift modifier for a control char
2233 made from a shifted letter. But only for letters! */
2234 if (oc
>= 'A' && oc
<= 'Z')
2235 c
|= shift_modifier
;
2238 /* The lower-case letters denote control characters too. */
2239 else if (c
>= 'a' && c
<= 'z')
2242 /* Include the bits for control and shift
2243 only if the basic ASCII code can't indicate them. */
2247 /* Replace the high bits. */
2248 c
|= (upper
& ~ctrl_modifier
);
2253 /* Display the help-echo property of the character after the mouse pointer.
2254 Either show it in the echo area, or call show-help-function to display
2255 it by other means (maybe in a tooltip).
2257 If HELP is nil, that means clear the previous help echo.
2259 If HELP is a string, display that string. If HELP is a function,
2260 call it with OBJECT and POS as arguments; the function should
2261 return a help string or nil for none. For all other types of HELP,
2262 evaluate it to obtain a string.
2264 WINDOW is the window in which the help was generated, if any.
2265 It is nil if not in a window.
2267 If OBJECT is a buffer, POS is the position in the buffer where the
2268 `help-echo' text property was found.
2270 If OBJECT is an overlay, that overlay has a `help-echo' property,
2271 and POS is the position in the overlay's buffer under the mouse.
2273 If OBJECT is a string (an overlay string or a string displayed with
2274 the `display' property). POS is the position in that string under
2277 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2278 echo overwrites a keystroke echo currently displayed in the echo
2281 Note: this function may only be called with HELP nil or a string
2282 from X code running asynchronously. */
2285 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2286 Lisp_Object pos
, int ok_to_overwrite_keystroke_echo
)
2288 if (!NILP (help
) && !STRINGP (help
))
2290 if (FUNCTIONP (help
))
2292 Lisp_Object args
[4];
2297 help
= safe_call (4, args
);
2300 help
= safe_eval (help
);
2302 if (!STRINGP (help
))
2306 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2307 if (!noninteractive
&& STRINGP (help
))
2309 /* The mouse-fixup-help-message Lisp function can call
2310 mouse_position_hook, which resets the mouse_moved flags.
2311 This causes trouble if we are trying to read a mouse motion
2312 event (i.e., if we are inside a `track-mouse' form), so we
2313 restore the mouse_moved flag. */
2314 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2315 help
= call1 (Qmouse_fixup_help_message
, help
);
2321 if (STRINGP (help
) || NILP (help
))
2323 if (!NILP (Vshow_help_function
))
2324 call1 (Vshow_help_function
, help
);
2325 help_echo_showing_p
= STRINGP (help
);
2331 /* Input of single characters from keyboard */
2333 Lisp_Object
print_help (Lisp_Object object
);
2334 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2335 struct timeval
*end_time
);
2336 static void record_char (Lisp_Object c
);
2338 static Lisp_Object help_form_saved_window_configs
;
2340 read_char_help_form_unwind (Lisp_Object arg
)
2342 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2343 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2344 if (!NILP (window_config
))
2345 Fset_window_configuration (window_config
);
2349 #define STOP_POLLING \
2350 do { if (! polling_stopped_here) stop_polling (); \
2351 polling_stopped_here = 1; } while (0)
2353 #define RESUME_POLLING \
2354 do { if (polling_stopped_here) start_polling (); \
2355 polling_stopped_here = 0; } while (0)
2357 /* read a character from the keyboard; call the redisplay if needed */
2358 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2359 -1 means do not do redisplay, but do do autosaving.
2362 /* The arguments MAPS and NMAPS are for menu prompting.
2363 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2365 PREV_EVENT is the previous input event, or nil if we are reading
2366 the first event of a key sequence (or not reading a key sequence).
2367 If PREV_EVENT is t, that is a "magic" value that says
2368 not to run input methods, but in other respects to act as if
2369 not reading a key sequence.
2371 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2372 if we used a mouse menu to read the input, or zero otherwise. If
2373 USED_MOUSE_MENU is null, we don't dereference it.
2375 Value is -2 when we find input on another keyboard. A second call
2376 to read_char will read it.
2378 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2379 specifying the maximum time to wait until. If no input arrives by
2380 that time, stop waiting and return nil.
2382 Value is t if we showed a menu and the user rejected it. */
2385 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2386 int *used_mouse_menu
, struct timeval
*end_time
)
2388 volatile Lisp_Object c
;
2389 int count
, jmpcount
;
2390 jmp_buf local_getcjmp
;
2392 volatile int key_already_recorded
= 0;
2393 Lisp_Object tem
, save
;
2394 volatile Lisp_Object previous_echo_area_message
;
2395 volatile Lisp_Object also_record
;
2396 volatile int reread
;
2397 struct gcpro gcpro1
, gcpro2
;
2398 int polling_stopped_here
= 0;
2399 struct kboard
*orig_kboard
= current_kboard
;
2403 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2404 before_command_key_count
= this_command_key_count
;
2405 before_command_echo_length
= echo_length ();
2408 previous_echo_area_message
= Qnil
;
2410 GCPRO2 (c
, previous_echo_area_message
);
2415 if (CONSP (Vunread_post_input_method_events
))
2417 c
= XCAR (Vunread_post_input_method_events
);
2418 Vunread_post_input_method_events
2419 = XCDR (Vunread_post_input_method_events
);
2421 /* Undo what read_char_x_menu_prompt did when it unread
2422 additional keys returned by Fx_popup_menu. */
2424 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2432 if (unread_command_char
!= -1)
2434 XSETINT (c
, unread_command_char
);
2435 unread_command_char
= -1;
2441 if (CONSP (Vunread_command_events
))
2443 int was_disabled
= 0;
2445 c
= XCAR (Vunread_command_events
);
2446 Vunread_command_events
= XCDR (Vunread_command_events
);
2450 /* Undo what sit-for did when it unread additional keys
2451 inside universal-argument. */
2454 && EQ (XCAR (c
), Qt
))
2460 /* Undo what read_char_x_menu_prompt did when it unread
2461 additional keys returned by Fx_popup_menu. */
2463 && EQ (XCDR (c
), Qdisabled
)
2464 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2470 /* If the queued event is something that used the mouse,
2471 set used_mouse_menu accordingly. */
2473 /* Also check was_disabled so last-nonmenu-event won't return
2474 a bad value when submenus are involved. (Bug#447) */
2475 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2476 *used_mouse_menu
= 1;
2478 goto reread_for_input_method
;
2481 if (CONSP (Vunread_input_method_events
))
2483 c
= XCAR (Vunread_input_method_events
);
2484 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2486 /* Undo what read_char_x_menu_prompt did when it unread
2487 additional keys returned by Fx_popup_menu. */
2489 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2493 goto reread_for_input_method
;
2496 this_command_key_count_reset
= 0;
2498 if (!NILP (Vexecuting_kbd_macro
))
2500 /* We set this to Qmacro; since that's not a frame, nobody will
2501 try to switch frames on us, and the selected window will
2504 Since this event came from a macro, it would be misleading to
2505 leave internal_last_event_frame set to wherever the last
2506 real event came from. Normally, a switch-frame event selects
2507 internal_last_event_frame after each command is read, but
2508 events read from a macro should never cause a new frame to be
2510 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2512 /* Exit the macro if we are at the end.
2513 Also, some things replace the macro with t
2514 to force an early exit. */
2515 if (EQ (Vexecuting_kbd_macro
, Qt
)
2516 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2522 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2523 if (STRINGP (Vexecuting_kbd_macro
)
2524 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2525 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2527 executing_kbd_macro_index
++;
2532 if (!NILP (unread_switch_frame
))
2534 c
= unread_switch_frame
;
2535 unread_switch_frame
= Qnil
;
2537 /* This event should make it into this_command_keys, and get echoed
2538 again, so we do not set `reread'. */
2542 /* if redisplay was requested */
2543 if (commandflag
>= 0)
2545 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2547 /* If there is pending input, process any events which are not
2548 user-visible, such as X selection_request events. */
2550 || detect_input_pending_run_timers (0))
2551 swallow_events (0); /* may clear input_pending */
2553 /* Redisplay if no pending input. */
2554 while (!input_pending
)
2556 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2557 redisplay_preserve_echo_area (5);
2562 /* Normal case: no input arrived during redisplay. */
2565 /* Input arrived and pre-empted redisplay.
2566 Process any events which are not user-visible. */
2568 /* If that cleared input_pending, try again to redisplay. */
2571 /* Prevent the redisplay we just did
2572 from messing up echoing of the input after the prompt. */
2573 if (commandflag
== 0 && echo_current
)
2574 echo_message_buffer
= echo_area_buffer
[0];
2578 /* Message turns off echoing unless more keystrokes turn it on again.
2580 The code in 20.x for the condition was
2582 1. echo_area_glyphs && *echo_area_glyphs
2583 2. && echo_area_glyphs != current_kboard->echobuf
2584 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2586 (1) means there's a current message displayed
2588 (2) means it's not the message from echoing from the current
2591 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2592 is set to a non-null value. This is done in read_char and it is
2593 set to echo_area_glyphs after a call to echo_char. That means
2594 ok_to_echo_at_next_pause is either null or
2595 current_kboard->echobuf with the appropriate current_kboard at
2598 So, condition (3) means in clear text ok_to_echo_at_next_pause
2599 must be either null, or the current message isn't from echoing at
2600 all, or it's from echoing from a different kboard than the
2603 if (/* There currently is something in the echo area. */
2604 !NILP (echo_area_buffer
[0])
2605 && (/* And it's either not from echoing. */
2606 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2607 /* Or it's an echo from a different kboard. */
2608 || echo_kboard
!= current_kboard
2609 /* Or we explicitly allow overwriting whatever there is. */
2610 || ok_to_echo_at_next_pause
== NULL
))
2615 /* Try reading a character via menu prompting in the minibuf.
2616 Try this before the sit-for, because the sit-for
2617 would do the wrong thing if we are supposed to do
2618 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2619 after a mouse event so don't try a minibuf menu. */
2621 if (nmaps
> 0 && INTERACTIVE
2622 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2623 /* Don't bring up a menu if we already have another event. */
2624 && NILP (Vunread_command_events
)
2625 && unread_command_char
< 0
2626 && !detect_input_pending_run_timers (0))
2628 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2630 if (INTEGERP (c
) && XINT (c
) == -2)
2631 return c
; /* wrong_kboard_jmpbuf */
2635 key_already_recorded
= 1;
2640 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2641 We will do that below, temporarily for short sections of code,
2642 when appropriate. local_getcjmp must be in effect
2643 around any call to sit_for or kbd_buffer_get_event;
2644 it *must not* be in effect when we call redisplay. */
2646 jmpcount
= SPECPDL_INDEX ();
2647 if (_setjmp (local_getcjmp
))
2649 /* Handle quits while reading the keyboard. */
2650 /* We must have saved the outer value of getcjmp here,
2651 so restore it now. */
2652 restore_getcjmp (save_jump
);
2653 unbind_to (jmpcount
, Qnil
);
2654 XSETINT (c
, quit_char
);
2655 internal_last_event_frame
= selected_frame
;
2656 Vlast_event_frame
= internal_last_event_frame
;
2657 /* If we report the quit char as an event,
2658 don't do so more than once. */
2659 if (!NILP (Vinhibit_quit
))
2663 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2664 if (kb
!= current_kboard
)
2666 Lisp_Object link
= kb
->kbd_queue
;
2667 /* We shouldn't get here if we were in single-kboard mode! */
2672 while (CONSP (XCDR (link
)))
2674 if (!NILP (XCDR (link
)))
2678 kb
->kbd_queue
= Fcons (c
, Qnil
);
2680 XSETCDR (link
, Fcons (c
, Qnil
));
2681 kb
->kbd_queue_has_data
= 1;
2682 current_kboard
= kb
;
2683 /* This is going to exit from read_char
2684 so we had better get rid of this frame's stuff. */
2686 return make_number (-2); /* wrong_kboard_jmpbuf */
2692 /* Start idle timers if no time limit is supplied. We don't do it
2693 if a time limit is supplied to avoid an infinite recursion in the
2694 situation where an idle timer calls `sit-for'. */
2697 timer_start_idle ();
2699 /* If in middle of key sequence and minibuffer not active,
2700 start echoing if enough time elapses. */
2702 if (minibuf_level
== 0
2704 && !current_kboard
->immediate_echo
2705 && this_command_key_count
> 0
2707 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2708 && NILP (Fzerop (Vecho_keystrokes
))
2709 && (/* No message. */
2710 NILP (echo_area_buffer
[0])
2711 /* Or empty message. */
2712 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2713 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2714 /* Or already echoing from same kboard. */
2715 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2716 /* Or not echoing before and echoing allowed. */
2717 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2719 /* After a mouse event, start echoing right away.
2720 This is because we are probably about to display a menu,
2721 and we don't want to delay before doing so. */
2722 if (EVENT_HAS_PARAMETERS (prev_event
))
2728 save_getcjmp (save_jump
);
2729 restore_getcjmp (local_getcjmp
);
2730 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2731 restore_getcjmp (save_jump
);
2733 && ! CONSP (Vunread_command_events
))
2738 /* Maybe auto save due to number of keystrokes. */
2740 if (commandflag
!= 0
2741 && auto_save_interval
> 0
2742 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2743 && !detect_input_pending_run_timers (0))
2745 Fdo_auto_save (Qnil
, Qnil
);
2746 /* Hooks can actually change some buffers in auto save. */
2750 /* Try reading using an X menu.
2751 This is never confused with reading using the minibuf
2752 because the recursive call of read_char in read_char_minibuf_menu_prompt
2753 does not pass on any keymaps. */
2755 if (nmaps
> 0 && INTERACTIVE
2756 && !NILP (prev_event
)
2757 && EVENT_HAS_PARAMETERS (prev_event
)
2758 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2759 && !EQ (XCAR (prev_event
), Qtool_bar
)
2760 /* Don't bring up a menu if we already have another event. */
2761 && NILP (Vunread_command_events
)
2762 && unread_command_char
< 0)
2764 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2766 /* Now that we have read an event, Emacs is not idle. */
2773 /* Maybe autosave and/or garbage collect due to idleness. */
2775 if (INTERACTIVE
&& NILP (c
))
2777 int delay_level
, buffer_size
;
2779 /* Slow down auto saves logarithmically in size of current buffer,
2780 and garbage collect while we're at it. */
2781 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2782 last_non_minibuf_size
= Z
- BEG
;
2783 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2785 while (buffer_size
> 64)
2786 delay_level
++, buffer_size
-= buffer_size
>> 2;
2787 if (delay_level
< 4) delay_level
= 4;
2788 /* delay_level is 4 for files under around 50k, 7 at 100k,
2789 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2791 /* Auto save if enough time goes by without input. */
2792 if (commandflag
!= 0
2793 && num_nonmacro_input_events
> last_auto_save
2794 && INTEGERP (Vauto_save_timeout
)
2795 && XINT (Vauto_save_timeout
) > 0)
2798 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2800 save_getcjmp (save_jump
);
2801 restore_getcjmp (local_getcjmp
);
2802 tem0
= sit_for (make_number (timeout
), 1, 1);
2803 restore_getcjmp (save_jump
);
2806 && ! CONSP (Vunread_command_events
))
2808 Fdo_auto_save (Qnil
, Qnil
);
2810 /* If we have auto-saved and there is still no input
2811 available, garbage collect if there has been enough
2812 consing going on to make it worthwhile. */
2813 if (!detect_input_pending_run_timers (0)
2814 && consing_since_gc
> gc_cons_threshold
/ 2)
2815 Fgarbage_collect ();
2822 /* Notify the caller if an autosave hook, or a timer, sentinel or
2823 filter in the sit_for calls above have changed the current
2824 kboard. This could happen if they use the minibuffer or start a
2825 recursive edit, like the fancy splash screen in server.el's
2826 filter. If this longjmp wasn't here, read_key_sequence would
2827 interpret the next key sequence using the wrong translation
2828 tables and function keymaps. */
2829 if (NILP (c
) && current_kboard
!= orig_kboard
)
2832 return make_number (-2); /* wrong_kboard_jmpbuf */
2835 /* If this has become non-nil here, it has been set by a timer
2836 or sentinel or filter. */
2837 if (CONSP (Vunread_command_events
))
2839 c
= XCAR (Vunread_command_events
);
2840 Vunread_command_events
= XCDR (Vunread_command_events
);
2843 /* Read something from current KBOARD's side queue, if possible. */
2847 if (current_kboard
->kbd_queue_has_data
)
2849 if (!CONSP (current_kboard
->kbd_queue
))
2851 c
= XCAR (current_kboard
->kbd_queue
);
2852 current_kboard
->kbd_queue
2853 = XCDR (current_kboard
->kbd_queue
);
2854 if (NILP (current_kboard
->kbd_queue
))
2855 current_kboard
->kbd_queue_has_data
= 0;
2856 input_pending
= readable_events (0);
2857 if (EVENT_HAS_PARAMETERS (c
)
2858 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2859 internal_last_event_frame
= XCAR (XCDR (c
));
2860 Vlast_event_frame
= internal_last_event_frame
;
2864 /* If current_kboard's side queue is empty check the other kboards.
2865 If one of them has data that we have not yet seen here,
2866 switch to it and process the data waiting for it.
2868 Note: if the events queued up for another kboard
2869 have already been seen here, and therefore are not a complete command,
2870 the kbd_queue_has_data field is 0, so we skip that kboard here.
2871 That's to avoid an infinite loop switching between kboards here. */
2872 if (NILP (c
) && !single_kboard
)
2875 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2876 if (kb
->kbd_queue_has_data
)
2878 current_kboard
= kb
;
2879 /* This is going to exit from read_char
2880 so we had better get rid of this frame's stuff. */
2882 return make_number (-2); /* wrong_kboard_jmpbuf */
2890 /* Finally, we read from the main queue,
2891 and if that gives us something we can't use yet, we put it on the
2892 appropriate side queue and try again. */
2901 EMACS_GET_TIME (now
);
2902 if (EMACS_TIME_GE (now
, *end_time
))
2906 /* Actually read a character, waiting if necessary. */
2907 save_getcjmp (save_jump
);
2908 restore_getcjmp (local_getcjmp
);
2910 timer_start_idle ();
2911 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2912 restore_getcjmp (save_jump
);
2914 if (! NILP (c
) && (kb
!= current_kboard
))
2916 Lisp_Object link
= kb
->kbd_queue
;
2919 while (CONSP (XCDR (link
)))
2921 if (!NILP (XCDR (link
)))
2925 kb
->kbd_queue
= Fcons (c
, Qnil
);
2927 XSETCDR (link
, Fcons (c
, Qnil
));
2928 kb
->kbd_queue_has_data
= 1;
2932 current_kboard
= kb
;
2933 /* This is going to exit from read_char
2934 so we had better get rid of this frame's stuff. */
2936 return make_number (-2);
2940 /* Terminate Emacs in batch mode if at eof. */
2941 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2942 Fkill_emacs (make_number (1));
2946 /* Add in any extra modifiers, where appropriate. */
2947 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2948 || ((extra_keyboard_modifiers
& 0177) < ' '
2949 && (extra_keyboard_modifiers
& 0177) != 0))
2950 XSETINT (c
, make_ctrl_char (XINT (c
)));
2952 /* Transfer any other modifier bits directly from
2953 extra_keyboard_modifiers to c. Ignore the actual character code
2954 in the low 16 bits of extra_keyboard_modifiers. */
2955 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2966 if (commandflag
>= 0
2967 && !input_pending
&& !detect_input_pending_run_timers (0))
2975 /* Buffer switch events are only for internal wakeups
2976 so don't show them to the user.
2977 Also, don't record a key if we already did. */
2978 if (BUFFERP (c
) || key_already_recorded
)
2981 /* Process special events within read_char
2982 and loop around to read another event. */
2985 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2990 struct buffer
*prev_buffer
= current_buffer
;
2991 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2992 int was_locked
= single_kboard
;
2993 int count
= SPECPDL_INDEX ();
2994 record_single_kboard_state ();
2997 last_input_event
= c
;
2998 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
3000 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
3001 /* We stopped being idle for this event; undo that. This
3002 prevents automatic window selection (under
3003 mouse_autoselect_window from acting as a real input event, for
3004 example banishing the mouse under mouse-avoidance-mode. */
3005 timer_resume_idle ();
3007 #if 0 /* This shouldn't be necessary anymore. --lorentey */
3008 /* Resume allowing input from any kboard, if that was true before. */
3010 any_kboard_state ();
3011 unbind_to (count
, Qnil
);
3014 if (current_buffer
!= prev_buffer
)
3016 /* The command may have changed the keymaps. Pretend there
3017 is input in another keyboard and return. This will
3018 recalculate keymaps. */
3019 c
= make_number (-2);
3026 /* Handle things that only apply to characters. */
3029 /* If kbd_buffer_get_event gave us an EOF, return that. */
3033 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3034 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3035 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3036 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3037 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3041 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3042 /* nil in keyboard-translate-table means no translation. */
3048 /* If this event is a mouse click in the menu bar,
3049 return just menu-bar for now. Modify the mouse click event
3050 so we won't do this twice, then queue it up. */
3051 if (EVENT_HAS_PARAMETERS (c
)
3053 && CONSP (EVENT_START (c
))
3054 && CONSP (XCDR (EVENT_START (c
))))
3058 posn
= POSN_POSN (EVENT_START (c
));
3059 /* Handle menu-bar events:
3060 insert the dummy prefix event `menu-bar'. */
3061 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3063 /* Change menu-bar to (menu-bar) as the event "position". */
3064 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3067 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3072 /* Store these characters into recent_keys, the dribble file if any,
3073 and the keyboard macro being defined, if any. */
3075 if (! NILP (also_record
))
3076 record_char (also_record
);
3078 /* Wipe the echo area.
3079 But first, if we are about to use an input method,
3080 save the echo area contents for it to refer to. */
3082 && ! NILP (Vinput_method_function
)
3083 && (unsigned) XINT (c
) >= ' '
3084 && (unsigned) XINT (c
) != 127
3085 && (unsigned) XINT (c
) < 256)
3087 previous_echo_area_message
= Fcurrent_message ();
3088 Vinput_method_previous_message
= previous_echo_area_message
;
3091 /* Now wipe the echo area, except for help events which do their
3092 own stuff with the echo area. */
3094 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3095 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3097 if (!NILP (echo_area_buffer
[0]))
3098 safe_run_hooks (Qecho_area_clear_hook
);
3099 clear_message (1, 0);
3102 reread_for_input_method
:
3104 /* Pass this to the input method, if appropriate. */
3106 && ! NILP (Vinput_method_function
)
3107 /* Don't run the input method within a key sequence,
3108 after the first event of the key sequence. */
3109 && NILP (prev_event
)
3110 && (unsigned) XINT (c
) >= ' '
3111 && (unsigned) XINT (c
) != 127
3112 && (unsigned) XINT (c
) < 256)
3115 int key_count
, key_count_reset
;
3116 struct gcpro gcpro1
;
3117 int count
= SPECPDL_INDEX ();
3119 /* Save the echo status. */
3120 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3121 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3122 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3123 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3126 if (before_command_restore_flag
)
3128 this_command_key_count
= before_command_key_count_1
;
3129 if (this_command_key_count
< this_single_command_key_start
)
3130 this_single_command_key_start
= this_command_key_count
;
3131 echo_truncate (before_command_echo_length_1
);
3132 before_command_restore_flag
= 0;
3136 /* Save the this_command_keys status. */
3137 key_count
= this_command_key_count
;
3138 key_count_reset
= this_command_key_count_reset
;
3141 keys
= Fcopy_sequence (this_command_keys
);
3146 /* Clear out this_command_keys. */
3147 this_command_key_count
= 0;
3148 this_command_key_count_reset
= 0;
3150 /* Now wipe the echo area. */
3151 if (!NILP (echo_area_buffer
[0]))
3152 safe_run_hooks (Qecho_area_clear_hook
);
3153 clear_message (1, 0);
3156 /* If we are not reading a key sequence,
3157 never use the echo area. */
3160 specbind (Qinput_method_use_echo_area
, Qt
);
3163 /* Call the input method. */
3164 tem
= call1 (Vinput_method_function
, c
);
3166 tem
= unbind_to (count
, tem
);
3168 /* Restore the saved echoing state
3169 and this_command_keys state. */
3170 this_command_key_count
= key_count
;
3171 this_command_key_count_reset
= key_count_reset
;
3173 this_command_keys
= keys
;
3176 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3177 current_kboard
->echo_string
= saved_echo_string
;
3178 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3179 if (saved_immediate_echo
)
3184 /* The input method can return no events. */
3187 /* Bring back the previous message, if any. */
3188 if (! NILP (previous_echo_area_message
))
3189 message_with_string ("%s", previous_echo_area_message
, 0);
3192 /* It returned one event or more. */
3194 Vunread_post_input_method_events
3195 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3200 /* Display help if not echoing. */
3201 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3203 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3204 Lisp_Object help
, object
, position
, window
, tem
;
3206 tem
= Fcdr (XCDR (c
));
3209 window
= Fcar (tem
);
3211 object
= Fcar (tem
);
3213 position
= Fcar (tem
);
3215 show_help_echo (help
, window
, object
, position
, 0);
3217 /* We stopped being idle for this event; undo that. */
3219 timer_resume_idle ();
3223 if ((! reread
|| this_command_key_count
== 0
3224 || this_command_key_count_reset
)
3228 /* Don't echo mouse motion events. */
3229 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3230 && NILP (Fzerop (Vecho_keystrokes
))
3231 && ! (EVENT_HAS_PARAMETERS (c
)
3232 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3235 if (! NILP (also_record
))
3236 echo_char (also_record
);
3237 /* Once we reread a character, echoing can happen
3238 the next time we pause to read a new one. */
3239 ok_to_echo_at_next_pause
= current_kboard
;
3242 /* Record this character as part of the current key. */
3243 add_command_key (c
);
3244 if (! NILP (also_record
))
3245 add_command_key (also_record
);
3248 last_input_event
= c
;
3251 /* Process the help character specially if enabled */
3252 if (!NILP (Vhelp_form
) && help_char_p (c
))
3255 count
= SPECPDL_INDEX ();
3257 help_form_saved_window_configs
3258 = Fcons (Fcurrent_window_configuration (Qnil
),
3259 help_form_saved_window_configs
);
3260 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3262 tem0
= Feval (Vhelp_form
);
3264 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3269 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3270 if (EVENT_HAS_PARAMETERS (c
)
3271 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3272 XSETCAR (help_form_saved_window_configs
, Qnil
);
3274 while (BUFFERP (c
));
3275 /* Remove the help from the frame */
3276 unbind_to (count
, Qnil
);
3279 if (EQ (c
, make_number (040)))
3283 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3284 while (BUFFERP (c
));
3293 /* Record a key that came from a mouse menu.
3294 Record it for echoing, for this-command-keys, and so on. */
3297 record_menu_key (Lisp_Object c
)
3299 /* Wipe the echo area. */
3300 clear_message (1, 0);
3305 before_command_key_count
= this_command_key_count
;
3306 before_command_echo_length
= echo_length ();
3309 /* Don't echo mouse motion events. */
3310 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3311 && NILP (Fzerop (Vecho_keystrokes
)))
3315 /* Once we reread a character, echoing can happen
3316 the next time we pause to read a new one. */
3317 ok_to_echo_at_next_pause
= 0;
3320 /* Record this character as part of the current key. */
3321 add_command_key (c
);
3323 /* Re-reading in the middle of a command */
3324 last_input_event
= c
;
3328 /* Return 1 if should recognize C as "the help character". */
3331 help_char_p (Lisp_Object c
)
3335 if (EQ (c
, Vhelp_char
))
3337 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3338 if (EQ (c
, XCAR (tail
)))
3343 /* Record the input event C in various ways. */
3346 record_char (Lisp_Object c
)
3350 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3352 /* To avoid filling recent_keys with help-echo and mouse-movement
3353 events, we filter out repeated help-echo events, only store the
3354 first and last in a series of mouse-movement events, and don't
3355 store repeated help-echo events which are only separated by
3356 mouse-movement events. */
3358 Lisp_Object ev1
, ev2
, ev3
;
3361 if ((ix1
= recent_keys_index
- 1) < 0)
3362 ix1
= NUM_RECENT_KEYS
- 1;
3363 ev1
= AREF (recent_keys
, ix1
);
3365 if ((ix2
= ix1
- 1) < 0)
3366 ix2
= NUM_RECENT_KEYS
- 1;
3367 ev2
= AREF (recent_keys
, ix2
);
3369 if ((ix3
= ix2
- 1) < 0)
3370 ix3
= NUM_RECENT_KEYS
- 1;
3371 ev3
= AREF (recent_keys
, ix3
);
3373 if (EQ (XCAR (c
), Qhelp_echo
))
3375 /* Don't record `help-echo' in recent_keys unless it shows some help
3376 message, and a different help than the previously recorded
3378 Lisp_Object help
, last_help
;
3380 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3381 if (!STRINGP (help
))
3383 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3384 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3386 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3387 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3388 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3390 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3391 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3392 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3393 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3396 else if (EQ (XCAR (c
), Qmouse_movement
))
3398 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3399 So additional mouse movement events replace the last element. */
3400 Lisp_Object last_window
, window
;
3402 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3403 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3404 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3405 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3406 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3408 ASET (recent_keys
, ix1
, c
);
3414 store_kbd_macro_char (c
);
3419 ASET (recent_keys
, recent_keys_index
, c
);
3420 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3421 recent_keys_index
= 0;
3423 else if (recorded
< 0)
3425 /* We need to remove one or two events from recent_keys.
3426 To do this, we simply put nil at those events and move the
3427 recent_keys_index backwards over those events. Usually,
3428 users will never see those nil events, as they will be
3429 overwritten by the command keys entered to see recent_keys
3432 while (recorded
++ < 0 && total_keys
> 0)
3434 if (total_keys
< NUM_RECENT_KEYS
)
3436 if (--recent_keys_index
< 0)
3437 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3438 ASET (recent_keys
, recent_keys_index
, Qnil
);
3442 num_nonmacro_input_events
++;
3444 /* Write c to the dribble file. If c is a lispy event, write
3445 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3446 If you, dear reader, have a better idea, you've got the source. :-) */
3452 if (XUINT (c
) < 0x100)
3453 putc (XINT (c
), dribble
);
3455 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3459 Lisp_Object dribblee
;
3461 /* If it's a structured event, take the event header. */
3462 dribblee
= EVENT_HEAD (c
);
3464 if (SYMBOLP (dribblee
))
3466 putc ('<', dribble
);
3467 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3468 SBYTES (SYMBOL_NAME (dribblee
)),
3470 putc ('>', dribble
);
3480 print_help (Lisp_Object object
)
3482 struct buffer
*old
= current_buffer
;
3483 Fprinc (object
, Qnil
);
3484 set_buffer_internal (XBUFFER (Vstandard_output
));
3485 call0 (intern ("help-mode"));
3486 set_buffer_internal (old
);
3490 /* Copy out or in the info on where C-g should throw to.
3491 This is used when running Lisp code from within get_char,
3492 in case get_char is called recursively.
3493 See read_process_output. */
3496 save_getcjmp (jmp_buf temp
)
3498 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3502 restore_getcjmp (jmp_buf temp
)
3504 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3507 /* Low level keyboard/mouse input.
3508 kbd_buffer_store_event places events in kbd_buffer, and
3509 kbd_buffer_get_event retrieves them. */
3511 /* Return true if there are any events in the queue that read-char
3512 would return. If this returns false, a read-char would block. */
3514 readable_events (int flags
)
3517 /* Check whether a D-Bus message has arrived. */
3518 if (xd_pending_messages () > 0)
3520 #endif /* HAVE_DBUS */
3522 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3525 /* If the buffer contains only FOCUS_IN_EVENT events, and
3526 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3527 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3529 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3530 #ifdef USE_TOOLKIT_SCROLL_BARS
3531 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3535 struct input_event
*event
;
3537 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3544 #ifdef USE_TOOLKIT_SCROLL_BARS
3545 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3547 event
->kind
== FOCUS_IN_EVENT
)
3548 #ifdef USE_TOOLKIT_SCROLL_BARS
3549 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3550 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3551 && event
->part
== scroll_bar_handle
3552 && event
->modifiers
== 0)
3557 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3560 while (event
!= kbd_store_ptr
);
3566 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3567 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3568 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3573 if (current_kboard
->kbd_queue_has_data
)
3579 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3580 if (kb
->kbd_queue_has_data
)
3586 /* Set this for debugging, to have a way to get out */
3590 event_to_kboard (struct input_event
*event
)
3593 frame
= event
->frame_or_window
;
3595 frame
= XCAR (frame
);
3596 else if (WINDOWP (frame
))
3597 frame
= WINDOW_FRAME (XWINDOW (frame
));
3599 /* There are still some events that don't set this field.
3600 For now, just ignore the problem.
3601 Also ignore dead frames here. */
3602 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3605 return FRAME_KBOARD (XFRAME (frame
));
3608 /* Return the number of slots occupied in kbd_buffer. */
3611 kbd_buffer_nr_stored (void)
3613 return kbd_fetch_ptr
== kbd_store_ptr
3615 : (kbd_fetch_ptr
< kbd_store_ptr
3616 ? kbd_store_ptr
- kbd_fetch_ptr
3617 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3618 + (kbd_store_ptr
- kbd_buffer
)));
3621 Lisp_Object Vthrow_on_input
;
3623 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3626 kbd_buffer_store_event (register struct input_event
*event
)
3628 kbd_buffer_store_event_hold (event
, 0);
3631 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3633 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3634 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3635 Else, if EVENT is a quit event, store the quit event
3636 in HOLD_QUIT, and return (thus ignoring further events).
3638 This is used in read_avail_input to postpone the processing
3639 of the quit event until all subsequent input events have been
3640 parsed (and discarded).
3644 kbd_buffer_store_event_hold (register struct input_event
*event
,
3645 struct input_event
*hold_quit
)
3647 if (event
->kind
== NO_EVENT
)
3650 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3653 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3655 register int c
= event
->code
& 0377;
3657 if (event
->modifiers
& ctrl_modifier
)
3658 c
= make_ctrl_char (c
);
3660 c
|= (event
->modifiers
3661 & (meta_modifier
| alt_modifier
3662 | hyper_modifier
| super_modifier
));
3666 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3667 struct input_event
*sp
;
3669 if (single_kboard
&& kb
!= current_kboard
)
3672 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3673 Fcons (make_number (c
), Qnil
));
3674 kb
->kbd_queue_has_data
= 1;
3675 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3677 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3680 if (event_to_kboard (sp
) == kb
)
3682 sp
->kind
= NO_EVENT
;
3683 sp
->frame_or_window
= Qnil
;
3692 memcpy (hold_quit
, event
, sizeof (*event
));
3696 /* If this results in a quit_char being returned to Emacs as
3697 input, set Vlast_event_frame properly. If this doesn't
3698 get returned to Emacs as an event, the next event read
3699 will set Vlast_event_frame again, so this is safe to do. */
3703 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3705 focus
= event
->frame_or_window
;
3706 internal_last_event_frame
= focus
;
3707 Vlast_event_frame
= focus
;
3710 last_event_timestamp
= event
->timestamp
;
3711 handle_interrupt ();
3715 if (c
&& c
== stop_character
)
3721 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3722 Just ignore the second one. */
3723 else if (event
->kind
== BUFFER_SWITCH_EVENT
3724 && kbd_fetch_ptr
!= kbd_store_ptr
3725 && ((kbd_store_ptr
== kbd_buffer
3726 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3727 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3730 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3731 kbd_store_ptr
= kbd_buffer
;
3733 /* Don't let the very last slot in the buffer become full,
3734 since that would make the two pointers equal,
3735 and that is indistinguishable from an empty buffer.
3736 Discard the event if it would fill the last slot. */
3737 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3739 *kbd_store_ptr
= *event
;
3741 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3743 /* Don't read keyboard input until we have processed kbd_buffer.
3744 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3745 hold_keyboard_input ();
3747 if (!noninteractive
)
3748 signal (SIGIO
, SIG_IGN
);
3754 /* If we're inside while-no-input, and this event qualifies
3755 as input, set quit-flag to cause an interrupt. */
3756 if (!NILP (Vthrow_on_input
)
3757 && event
->kind
!= FOCUS_IN_EVENT
3758 && event
->kind
!= HELP_EVENT
3759 && event
->kind
!= DEICONIFY_EVENT
)
3761 Vquit_flag
= Vthrow_on_input
;
3762 /* If we're inside a function that wants immediate quits,
3764 if (immediate_quit
&& NILP (Vinhibit_quit
))
3774 /* Put an input event back in the head of the event queue. */
3777 kbd_buffer_unget_event (register struct input_event
*event
)
3779 if (kbd_fetch_ptr
== kbd_buffer
)
3780 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3782 /* Don't let the very last slot in the buffer become full, */
3783 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3786 *kbd_fetch_ptr
= *event
;
3791 /* Generate HELP_EVENT input_events in BUFP which has room for
3792 SIZE events. If there's not enough room in BUFP, ignore this
3795 HELP is the help form.
3797 FRAME is the frame on which the help is generated. OBJECT is the
3798 Lisp object where the help was found (a buffer, a string, an
3799 overlay, or nil if neither from a string nor from a buffer. POS is
3800 the position within OBJECT where the help was found.
3802 Value is the number of input_events generated. */
3805 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3806 Lisp_Object object
, int pos
)
3808 struct input_event event
;
3812 event
.kind
= HELP_EVENT
;
3813 event
.frame_or_window
= frame
;
3815 event
.x
= WINDOWP (window
) ? window
: frame
;
3818 kbd_buffer_store_event (&event
);
3822 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3825 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3827 struct input_event event
;
3829 event
.kind
= HELP_EVENT
;
3830 event
.frame_or_window
= frame
;
3835 kbd_buffer_store_event (&event
);
3839 /* Discard any mouse events in the event buffer by setting them to
3842 discard_mouse_events (void)
3844 struct input_event
*sp
;
3845 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3847 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3850 if (sp
->kind
== MOUSE_CLICK_EVENT
3851 || sp
->kind
== WHEEL_EVENT
3852 || sp
->kind
== HORIZ_WHEEL_EVENT
3854 || sp
->kind
== GPM_CLICK_EVENT
3856 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3858 sp
->kind
= NO_EVENT
;
3864 /* Return non-zero if there are any real events waiting in the event
3865 buffer, not counting `NO_EVENT's.
3867 If DISCARD is non-zero, discard NO_EVENT events at the front of
3868 the input queue, possibly leaving the input queue empty if there
3869 are no real input events. */
3872 kbd_buffer_events_waiting (int discard
)
3874 struct input_event
*sp
;
3876 for (sp
= kbd_fetch_ptr
;
3877 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3880 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3887 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3891 /* Clear input event EVENT. */
3894 clear_event (struct input_event
*event
)
3896 event
->kind
= NO_EVENT
;
3900 /* Read one event from the event buffer, waiting if necessary.
3901 The value is a Lisp object representing the event.
3902 The value is nil for an event that should be ignored,
3903 or that was handled here.
3904 We always read and discard one event. */
3907 kbd_buffer_get_event (KBOARD
**kbp
,
3908 int *used_mouse_menu
,
3909 struct timeval
*end_time
)
3914 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3916 /* Start reading input again, we have processed enough so we can
3917 accept new events again. */
3918 unhold_keyboard_input ();
3920 if (!noninteractive
)
3921 signal (SIGIO
, input_available_signal
);
3927 /* In case we are running as a daemon, only do this before
3928 detaching from the terminal. */
3929 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3933 *kbp
= current_kboard
;
3937 /* Wait until there is input available. */
3940 /* Break loop if there's an unread command event. Needed in
3941 moused window autoselection which uses a timer to insert such
3943 if (CONSP (Vunread_command_events
))
3946 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3948 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3949 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3953 /* If the quit flag is set, then read_char will return
3954 quit_char, so that counts as "available input." */
3955 if (!NILP (Vquit_flag
))
3956 quit_throw_to_read_char ();
3958 /* One way or another, wait until input is available; then, if
3959 interrupt handlers have not read it, read it now. */
3961 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3965 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3967 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3968 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3973 EMACS_TIME duration
;
3974 EMACS_GET_TIME (duration
);
3975 if (EMACS_TIME_GE (duration
, *end_time
))
3976 return Qnil
; /* finished waiting */
3979 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3980 wait_reading_process_output (EMACS_SECS (duration
),
3981 EMACS_USECS (duration
),
3982 -1, 1, Qnil
, NULL
, 0);
3986 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3988 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3989 /* Pass 1 for EXPECT since we just waited to have input. */
3990 read_avail_input (1);
3993 if (CONSP (Vunread_command_events
))
3996 first
= XCAR (Vunread_command_events
);
3997 Vunread_command_events
= XCDR (Vunread_command_events
);
3998 *kbp
= current_kboard
;
4002 /* At this point, we know that there is a readable event available
4003 somewhere. If the event queue is empty, then there must be a
4004 mouse movement enabled and available. */
4005 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4007 struct input_event
*event
;
4009 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4013 last_event_timestamp
= event
->timestamp
;
4015 *kbp
= event_to_kboard (event
);
4017 *kbp
= current_kboard
; /* Better than returning null ptr? */
4021 /* These two kinds of events get special handling
4022 and don't actually appear to the command loop.
4023 We return nil for them. */
4024 if (event
->kind
== SELECTION_REQUEST_EVENT
4025 || event
->kind
== SELECTION_CLEAR_EVENT
)
4028 struct input_event copy
;
4030 /* Remove it from the buffer before processing it,
4031 since otherwise swallow_events will see it
4032 and process it again. */
4034 kbd_fetch_ptr
= event
+ 1;
4035 input_pending
= readable_events (0);
4036 x_handle_selection_event (©
);
4038 /* We're getting selection request events, but we don't have
4044 #if defined (HAVE_NS)
4045 else if (event
->kind
== NS_TEXT_EVENT
)
4047 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4048 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4050 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4051 kbd_fetch_ptr
= event
+ 1;
4052 if (used_mouse_menu
)
4053 *used_mouse_menu
= 1;
4057 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4058 || defined (HAVE_NS)
4059 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4061 /* Make an event (delete-frame (FRAME)). */
4062 obj
= Fcons (event
->frame_or_window
, Qnil
);
4063 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4064 kbd_fetch_ptr
= event
+ 1;
4067 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4068 || defined (HAVE_NS)
4069 else if (event
->kind
== ICONIFY_EVENT
)
4071 /* Make an event (iconify-frame (FRAME)). */
4072 obj
= Fcons (event
->frame_or_window
, Qnil
);
4073 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4074 kbd_fetch_ptr
= event
+ 1;
4076 else if (event
->kind
== DEICONIFY_EVENT
)
4078 /* Make an event (make-frame-visible (FRAME)). */
4079 obj
= Fcons (event
->frame_or_window
, Qnil
);
4080 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4081 kbd_fetch_ptr
= event
+ 1;
4084 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4086 /* The value doesn't matter here; only the type is tested. */
4087 XSETBUFFER (obj
, current_buffer
);
4088 kbd_fetch_ptr
= event
+ 1;
4090 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4091 || defined(HAVE_NS) || defined (USE_GTK)
4092 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4094 kbd_fetch_ptr
= event
+ 1;
4095 input_pending
= readable_events (0);
4096 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4097 x_activate_menubar (XFRAME (event
->frame_or_window
));
4100 #if defined (WINDOWSNT)
4101 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4103 /* Make an event (language-change (FRAME CHARSET LCID)). */
4104 obj
= Fcons (event
->frame_or_window
, Qnil
);
4105 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4106 kbd_fetch_ptr
= event
+ 1;
4109 else if (event
->kind
== SAVE_SESSION_EVENT
)
4111 obj
= Fcons (Qsave_session
, Qnil
);
4112 kbd_fetch_ptr
= event
+ 1;
4114 /* Just discard these, by returning nil.
4115 With MULTI_KBOARD, these events are used as placeholders
4116 when we need to randomly delete events from the queue.
4117 (They shouldn't otherwise be found in the buffer,
4118 but on some machines it appears they do show up
4119 even without MULTI_KBOARD.) */
4120 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4121 mouse events during a popup-menu call. */
4122 else if (event
->kind
== NO_EVENT
)
4123 kbd_fetch_ptr
= event
+ 1;
4124 else if (event
->kind
== HELP_EVENT
)
4126 Lisp_Object object
, position
, help
, frame
, window
;
4128 frame
= event
->frame_or_window
;
4129 object
= event
->arg
;
4130 position
= make_number (event
->code
);
4133 clear_event (event
);
4135 kbd_fetch_ptr
= event
+ 1;
4136 if (!WINDOWP (window
))
4138 obj
= Fcons (Qhelp_echo
,
4139 list5 (frame
, help
, window
, object
, position
));
4141 else if (event
->kind
== FOCUS_IN_EVENT
)
4143 /* Notification of a FocusIn event. The frame receiving the
4144 focus is in event->frame_or_window. Generate a
4145 switch-frame event if necessary. */
4146 Lisp_Object frame
, focus
;
4148 frame
= event
->frame_or_window
;
4149 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4153 if (!EQ (frame
, internal_last_event_frame
)
4154 && !EQ (frame
, selected_frame
))
4155 obj
= make_lispy_switch_frame (frame
);
4156 internal_last_event_frame
= frame
;
4157 kbd_fetch_ptr
= event
+ 1;
4160 else if (event
->kind
== DBUS_EVENT
)
4162 obj
= make_lispy_event (event
);
4163 kbd_fetch_ptr
= event
+ 1;
4166 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4168 obj
= make_lispy_event (event
);
4169 kbd_fetch_ptr
= event
+ 1;
4173 /* If this event is on a different frame, return a switch-frame this
4174 time, and leave the event in the queue for next time. */
4178 frame
= event
->frame_or_window
;
4180 frame
= XCAR (frame
);
4181 else if (WINDOWP (frame
))
4182 frame
= WINDOW_FRAME (XWINDOW (frame
));
4184 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4188 if (! EQ (frame
, internal_last_event_frame
)
4189 && !EQ (frame
, selected_frame
))
4190 obj
= make_lispy_switch_frame (frame
);
4191 internal_last_event_frame
= frame
;
4193 /* If we didn't decide to make a switch-frame event, go ahead
4194 and build a real event from the queue entry. */
4198 obj
= make_lispy_event (event
);
4200 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4201 || defined(HAVE_NS) || defined (USE_GTK)
4202 /* If this was a menu selection, then set the flag to inhibit
4203 writing to last_nonmenu_event. Don't do this if the event
4204 we're returning is (menu-bar), though; that indicates the
4205 beginning of the menu sequence, and we might as well leave
4206 that as the `event with parameters' for this selection. */
4208 && !EQ (event
->frame_or_window
, event
->arg
)
4209 && (event
->kind
== MENU_BAR_EVENT
4210 || event
->kind
== TOOL_BAR_EVENT
))
4211 *used_mouse_menu
= 1;
4214 /* certain system events are non-key events */
4216 && event
->kind
== NS_NONKEY_EVENT
)
4217 *used_mouse_menu
= 1;
4220 /* Wipe out this event, to catch bugs. */
4221 clear_event (event
);
4222 kbd_fetch_ptr
= event
+ 1;
4226 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4227 /* Try generating a mouse motion event. */
4228 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4230 FRAME_PTR f
= some_mouse_moved ();
4231 Lisp_Object bar_window
;
4232 enum scroll_bar_part part
;
4236 *kbp
= current_kboard
;
4237 /* Note that this uses F to determine which terminal to look at.
4238 If there is no valid info, it does not store anything
4239 so x remains nil. */
4242 /* XXX Can f or mouse_position_hook be NULL here? */
4243 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4244 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4245 &part
, &x
, &y
, &time
);
4249 /* Decide if we should generate a switch-frame event. Don't
4250 generate switch-frame events for motion outside of all Emacs
4256 frame
= FRAME_FOCUS_FRAME (f
);
4258 XSETFRAME (frame
, f
);
4260 if (! EQ (frame
, internal_last_event_frame
)
4261 && !EQ (frame
, selected_frame
))
4262 obj
= make_lispy_switch_frame (frame
);
4263 internal_last_event_frame
= frame
;
4266 /* If we didn't decide to make a switch-frame event, go ahead and
4267 return a mouse-motion event. */
4268 if (!NILP (x
) && NILP (obj
))
4269 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4271 #endif /* HAVE_MOUSE || HAVE GPM */
4273 /* We were promised by the above while loop that there was
4274 something for us to read! */
4277 input_pending
= readable_events (0);
4279 Vlast_event_frame
= internal_last_event_frame
;
4284 /* Process any events that are not user-visible,
4285 then return, without reading any user-visible events. */
4288 swallow_events (int do_display
)
4292 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4294 struct input_event
*event
;
4296 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4300 last_event_timestamp
= event
->timestamp
;
4302 /* These two kinds of events get special handling
4303 and don't actually appear to the command loop. */
4304 if (event
->kind
== SELECTION_REQUEST_EVENT
4305 || event
->kind
== SELECTION_CLEAR_EVENT
)
4308 struct input_event copy
;
4310 /* Remove it from the buffer before processing it,
4311 since otherwise swallow_events called recursively could see it
4312 and process it again. */
4314 kbd_fetch_ptr
= event
+ 1;
4315 input_pending
= readable_events (0);
4316 x_handle_selection_event (©
);
4318 /* We're getting selection request events, but we don't have
4327 old_timers_run
= timers_run
;
4328 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4330 if (timers_run
!= old_timers_run
&& do_display
)
4331 redisplay_preserve_echo_area (7);
4334 /* Record the start of when Emacs is idle,
4335 for the sake of running idle-time timers. */
4338 timer_start_idle (void)
4342 /* If we are already in the idle state, do nothing. */
4343 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4346 EMACS_GET_TIME (timer_idleness_start_time
);
4348 timer_last_idleness_start_time
= timer_idleness_start_time
;
4350 /* Mark all idle-time timers as once again candidates for running. */
4351 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4355 timer
= XCAR (timers
);
4357 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4359 XVECTOR (timer
)->contents
[0] = Qnil
;
4363 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4366 timer_stop_idle (void)
4368 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4371 /* Resume idle timer from last idle start time. */
4374 timer_resume_idle (void)
4376 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4379 timer_idleness_start_time
= timer_last_idleness_start_time
;
4382 /* This is only for debugging. */
4383 struct input_event last_timer_event
;
4385 /* List of elisp functions to call, delayed because they were generated in
4386 a context where Elisp could not be safely run (e.g. redisplay, signal,
4387 ...). Each element has the form (FUN . ARGS). */
4388 Lisp_Object pending_funcalls
;
4390 /* Check whether a timer has fired. To prevent larger problems we simply
4391 disregard elements that are not proper timers. Do not make a circular
4392 timer list for the time being.
4394 Returns the time to wait until the next timer fires. If a
4395 timer is triggering now, return zero.
4396 If no timer is active, return -1.
4398 If a timer is ripe, we run it, with quitting turned off.
4399 In that case we return 0 to indicate that a new timer_check_2 call
4403 timer_check_2 (void)
4405 EMACS_TIME nexttime
;
4406 EMACS_TIME now
, idleness_now
;
4407 Lisp_Object timers
, idle_timers
, chosen_timer
;
4408 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4410 EMACS_SET_SECS (nexttime
, -1);
4411 EMACS_SET_USECS (nexttime
, -1);
4413 /* Always consider the ordinary timers. */
4414 timers
= Vtimer_list
;
4415 /* Consider the idle timers only if Emacs is idle. */
4416 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4417 idle_timers
= Vtimer_idle_list
;
4420 chosen_timer
= Qnil
;
4421 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4423 /* First run the code that was delayed. */
4424 while (CONSP (pending_funcalls
))
4426 Lisp_Object funcall
= XCAR (pending_funcalls
);
4427 pending_funcalls
= XCDR (pending_funcalls
);
4428 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4431 if (CONSP (timers
) || CONSP (idle_timers
))
4433 EMACS_GET_TIME (now
);
4434 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4435 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4438 while (CONSP (timers
) || CONSP (idle_timers
))
4440 Lisp_Object
*vector
;
4441 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4442 EMACS_TIME timer_time
, idle_timer_time
;
4443 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4445 /* Skip past invalid timers and timers already handled. */
4448 timer
= XCAR (timers
);
4449 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4451 timers
= XCDR (timers
);
4454 vector
= XVECTOR (timer
)->contents
;
4456 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4457 || !INTEGERP (vector
[3])
4458 || ! NILP (vector
[0]))
4460 timers
= XCDR (timers
);
4464 if (!NILP (idle_timers
))
4466 timer
= XCAR (idle_timers
);
4467 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4469 idle_timers
= XCDR (idle_timers
);
4472 vector
= XVECTOR (timer
)->contents
;
4474 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4475 || !INTEGERP (vector
[3])
4476 || ! NILP (vector
[0]))
4478 idle_timers
= XCDR (idle_timers
);
4483 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4484 based on the next ordinary timer.
4485 TIMER_DIFFERENCE is the distance in time from NOW to when
4486 this timer becomes ripe (negative if it's already ripe). */
4489 timer
= XCAR (timers
);
4490 vector
= XVECTOR (timer
)->contents
;
4491 EMACS_SET_SECS (timer_time
,
4492 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4493 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4494 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4497 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4498 based on the next idle timer. */
4499 if (!NILP (idle_timers
))
4501 idle_timer
= XCAR (idle_timers
);
4502 vector
= XVECTOR (idle_timer
)->contents
;
4503 EMACS_SET_SECS (idle_timer_time
,
4504 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4505 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4506 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4509 /* Decide which timer is the next timer,
4510 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4511 Also step down the list where we found that timer. */
4513 if (! NILP (timers
) && ! NILP (idle_timers
))
4516 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4517 if (EMACS_TIME_NEG_P (temp
))
4519 chosen_timer
= timer
;
4520 timers
= XCDR (timers
);
4521 difference
= timer_difference
;
4525 chosen_timer
= idle_timer
;
4526 idle_timers
= XCDR (idle_timers
);
4527 difference
= idle_timer_difference
;
4530 else if (! NILP (timers
))
4532 chosen_timer
= timer
;
4533 timers
= XCDR (timers
);
4534 difference
= timer_difference
;
4538 chosen_timer
= idle_timer
;
4539 idle_timers
= XCDR (idle_timers
);
4540 difference
= idle_timer_difference
;
4542 vector
= XVECTOR (chosen_timer
)->contents
;
4544 /* If timer is ripe, run it if it hasn't been run. */
4545 if (EMACS_TIME_NEG_P (difference
)
4546 || (EMACS_SECS (difference
) == 0
4547 && EMACS_USECS (difference
) == 0))
4549 if (NILP (vector
[0]))
4551 int count
= SPECPDL_INDEX ();
4552 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4554 /* Mark the timer as triggered to prevent problems if the lisp
4555 code fails to reschedule it right. */
4558 specbind (Qinhibit_quit
, Qt
);
4560 call1 (Qtimer_event_handler
, chosen_timer
);
4561 Vdeactivate_mark
= old_deactivate_mark
;
4563 unbind_to (count
, Qnil
);
4565 /* Since we have handled the event,
4566 we don't need to tell the caller to wake up and do it. */
4567 /* But the caller must still wait for the next timer, so
4568 return 0 to indicate that. */
4571 EMACS_SET_SECS (nexttime
, 0);
4572 EMACS_SET_USECS (nexttime
, 0);
4575 /* When we encounter a timer that is still waiting,
4576 return the amount of time to wait before it is ripe. */
4583 /* No timers are pending in the future. */
4584 /* Return 0 if we generated an event, and -1 if not. */
4590 /* Check whether a timer has fired. To prevent larger problems we simply
4591 disregard elements that are not proper timers. Do not make a circular
4592 timer list for the time being.
4594 Returns the time to wait until the next timer fires.
4595 If no timer is active, return -1.
4597 As long as any timer is ripe, we run it.
4599 DO_IT_NOW is now ignored. It used to mean that we should
4600 run the timer directly instead of queueing a timer-event.
4601 Now we always run timers directly. */
4604 timer_check (int do_it_now
)
4606 EMACS_TIME nexttime
;
4610 nexttime
= timer_check_2 ();
4612 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4617 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4618 doc
: /* Return the current length of Emacs idleness, or nil.
4619 The value when Emacs is idle is a list of three integers. The first has
4620 the most significant 16 bits of the seconds, while the second has the least
4621 significant 16 bits. The third integer gives the microsecond count.
4623 The value when Emacs is not idle is nil.
4625 The microsecond count is zero on systems that do not provide
4626 resolution finer than a second. */)
4629 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4631 EMACS_TIME now
, idleness_now
;
4633 EMACS_GET_TIME (now
);
4634 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4636 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4637 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4638 make_number (EMACS_USECS (idleness_now
)));
4644 /* Caches for modify_event_symbol. */
4645 static Lisp_Object accent_key_syms
;
4646 static Lisp_Object func_key_syms
;
4647 static Lisp_Object mouse_syms
;
4648 static Lisp_Object wheel_syms
;
4649 static Lisp_Object drag_n_drop_syms
;
4651 /* This is a list of keysym codes for special "accent" characters.
4652 It parallels lispy_accent_keys. */
4654 static const int lispy_accent_codes
[] =
4656 #ifdef XK_dead_circumflex
4661 #ifdef XK_dead_grave
4666 #ifdef XK_dead_tilde
4671 #ifdef XK_dead_diaeresis
4676 #ifdef XK_dead_macron
4681 #ifdef XK_dead_degree
4686 #ifdef XK_dead_acute
4691 #ifdef XK_dead_cedilla
4696 #ifdef XK_dead_breve
4701 #ifdef XK_dead_ogonek
4706 #ifdef XK_dead_caron
4711 #ifdef XK_dead_doubleacute
4712 XK_dead_doubleacute
,
4716 #ifdef XK_dead_abovedot
4721 #ifdef XK_dead_abovering
4731 #ifdef XK_dead_belowdot
4736 #ifdef XK_dead_voiced_sound
4737 XK_dead_voiced_sound
,
4741 #ifdef XK_dead_semivoiced_sound
4742 XK_dead_semivoiced_sound
,
4758 /* This is a list of Lisp names for special "accent" characters.
4759 It parallels lispy_accent_codes. */
4761 static const char *lispy_accent_keys
[] =
4779 "dead-voiced-sound",
4780 "dead-semivoiced-sound",
4786 #define FUNCTION_KEY_OFFSET 0x0
4788 char const *lispy_function_keys
[] =
4792 0, /* VK_LBUTTON 0x01 */
4793 0, /* VK_RBUTTON 0x02 */
4794 "cancel", /* VK_CANCEL 0x03 */
4795 0, /* VK_MBUTTON 0x04 */
4797 0, 0, 0, /* 0x05 .. 0x07 */
4799 "backspace", /* VK_BACK 0x08 */
4800 "tab", /* VK_TAB 0x09 */
4802 0, 0, /* 0x0A .. 0x0B */
4804 "clear", /* VK_CLEAR 0x0C */
4805 "return", /* VK_RETURN 0x0D */
4807 0, 0, /* 0x0E .. 0x0F */
4809 0, /* VK_SHIFT 0x10 */
4810 0, /* VK_CONTROL 0x11 */
4811 0, /* VK_MENU 0x12 */
4812 "pause", /* VK_PAUSE 0x13 */
4813 "capslock", /* VK_CAPITAL 0x14 */
4814 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4816 "junja", /* VK_JUNJA 0x17 */
4817 "final", /* VK_FINAL 0x18 */
4818 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4820 "escape", /* VK_ESCAPE 0x1B */
4821 "convert", /* VK_CONVERT 0x1C */
4822 "non-convert", /* VK_NONCONVERT 0x1D */
4823 "accept", /* VK_ACCEPT 0x1E */
4824 "mode-change", /* VK_MODECHANGE 0x1F */
4825 0, /* VK_SPACE 0x20 */
4826 "prior", /* VK_PRIOR 0x21 */
4827 "next", /* VK_NEXT 0x22 */
4828 "end", /* VK_END 0x23 */
4829 "home", /* VK_HOME 0x24 */
4830 "left", /* VK_LEFT 0x25 */
4831 "up", /* VK_UP 0x26 */
4832 "right", /* VK_RIGHT 0x27 */
4833 "down", /* VK_DOWN 0x28 */
4834 "select", /* VK_SELECT 0x29 */
4835 "print", /* VK_PRINT 0x2A */
4836 "execute", /* VK_EXECUTE 0x2B */
4837 "snapshot", /* VK_SNAPSHOT 0x2C */
4838 "insert", /* VK_INSERT 0x2D */
4839 "delete", /* VK_DELETE 0x2E */
4840 "help", /* VK_HELP 0x2F */
4842 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4844 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4846 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4848 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4850 0, 0, 0, 0, 0, 0, 0, 0, 0,
4851 0, 0, 0, 0, 0, 0, 0, 0, 0,
4852 0, 0, 0, 0, 0, 0, 0, 0,
4854 "lwindow", /* VK_LWIN 0x5B */
4855 "rwindow", /* VK_RWIN 0x5C */
4856 "apps", /* VK_APPS 0x5D */
4859 "kp-0", /* VK_NUMPAD0 0x60 */
4860 "kp-1", /* VK_NUMPAD1 0x61 */
4861 "kp-2", /* VK_NUMPAD2 0x62 */
4862 "kp-3", /* VK_NUMPAD3 0x63 */
4863 "kp-4", /* VK_NUMPAD4 0x64 */
4864 "kp-5", /* VK_NUMPAD5 0x65 */
4865 "kp-6", /* VK_NUMPAD6 0x66 */
4866 "kp-7", /* VK_NUMPAD7 0x67 */
4867 "kp-8", /* VK_NUMPAD8 0x68 */
4868 "kp-9", /* VK_NUMPAD9 0x69 */
4869 "kp-multiply", /* VK_MULTIPLY 0x6A */
4870 "kp-add", /* VK_ADD 0x6B */
4871 "kp-separator", /* VK_SEPARATOR 0x6C */
4872 "kp-subtract", /* VK_SUBTRACT 0x6D */
4873 "kp-decimal", /* VK_DECIMAL 0x6E */
4874 "kp-divide", /* VK_DIVIDE 0x6F */
4875 "f1", /* VK_F1 0x70 */
4876 "f2", /* VK_F2 0x71 */
4877 "f3", /* VK_F3 0x72 */
4878 "f4", /* VK_F4 0x73 */
4879 "f5", /* VK_F5 0x74 */
4880 "f6", /* VK_F6 0x75 */
4881 "f7", /* VK_F7 0x76 */
4882 "f8", /* VK_F8 0x77 */
4883 "f9", /* VK_F9 0x78 */
4884 "f10", /* VK_F10 0x79 */
4885 "f11", /* VK_F11 0x7A */
4886 "f12", /* VK_F12 0x7B */
4887 "f13", /* VK_F13 0x7C */
4888 "f14", /* VK_F14 0x7D */
4889 "f15", /* VK_F15 0x7E */
4890 "f16", /* VK_F16 0x7F */
4891 "f17", /* VK_F17 0x80 */
4892 "f18", /* VK_F18 0x81 */
4893 "f19", /* VK_F19 0x82 */
4894 "f20", /* VK_F20 0x83 */
4895 "f21", /* VK_F21 0x84 */
4896 "f22", /* VK_F22 0x85 */
4897 "f23", /* VK_F23 0x86 */
4898 "f24", /* VK_F24 0x87 */
4900 0, 0, 0, 0, /* 0x88 .. 0x8B */
4901 0, 0, 0, 0, /* 0x8C .. 0x8F */
4903 "kp-numlock", /* VK_NUMLOCK 0x90 */
4904 "scroll", /* VK_SCROLL 0x91 */
4905 /* Not sure where the following block comes from.
4906 Windows headers have NEC and Fujitsu specific keys in
4907 this block, but nothing generic. */
4908 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4909 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4910 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4911 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4912 "kp-end", /* VK_NUMPAD_END 0x96 */
4913 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4914 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4915 "kp-up", /* VK_NUMPAD_UP 0x99 */
4916 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4917 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4918 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4919 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4921 0, 0, /* 0x9E .. 0x9F */
4924 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4925 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4926 * No other API or message will distinguish left and right keys this way.
4931 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4932 to enable them selectively, and gives access to a few more functions.
4933 See lispy_multimedia_keys below. */
4934 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4935 0, 0, 0, /* 0xAD .. 0xAF Volume */
4936 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4937 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4939 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4940 0, 0, 0, 0, 0, 0, 0, 0, 0,
4942 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4943 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4944 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4947 "ax", /* VK_OEM_AX 0xE1 */
4948 0, /* VK_OEM_102 0xE2 */
4949 "ico-help", /* VK_ICO_HELP 0xE3 */
4950 "ico-00", /* VK_ICO_00 0xE4 */
4951 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4952 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4953 0, /* VK_PACKET 0xE7 - used to pass unicode chars */
4955 "reset", /* VK_OEM_RESET 0xE9 */
4956 "jump", /* VK_OEM_JUMP 0xEA */
4957 "oem-pa1", /* VK_OEM_PA1 0xEB */
4958 "oem-pa2", /* VK_OEM_PA2 0xEC */
4959 "oem-pa3", /* VK_OEM_PA3 0xED */
4960 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4961 "cusel", /* VK_OEM_CUSEL 0xEF */
4962 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4963 "finish", /* VK_OEM_FINISH 0xF1 */
4964 "copy", /* VK_OEM_COPY 0xF2 */
4965 "auto", /* VK_OEM_AUTO 0xF3 */
4966 "enlw", /* VK_OEM_ENLW 0xF4 */
4967 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4968 "attn", /* VK_ATTN 0xF6 */
4969 "crsel", /* VK_CRSEL 0xF7 */
4970 "exsel", /* VK_EXSEL 0xF8 */
4971 "ereof", /* VK_EREOF 0xF9 */
4972 "play", /* VK_PLAY 0xFA */
4973 "zoom", /* VK_ZOOM 0xFB */
4974 "noname", /* VK_NONAME 0xFC */
4975 "pa1", /* VK_PA1 0xFD */
4976 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4980 /* Some of these duplicate the "Media keys" on newer keyboards,
4981 but they are delivered to the application in a different way. */
4982 static const char *lispy_multimedia_keys
[] =
4990 "browser-favorites",
5027 "toggle-dictate-command",
5033 "media-fast-forward",
5036 "media-channel-down"
5039 #else /* not HAVE_NTGUI */
5041 /* This should be dealt with in XTread_socket now, and that doesn't
5042 depend on the client system having the Kana syms defined. See also
5043 the XK_kana_A case below. */
5046 static const char *lispy_kana_keys
[] =
5048 /* X Keysym value */
5049 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5050 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5051 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5052 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5053 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5054 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5055 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5056 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5057 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5058 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5059 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5060 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5061 "kana-i", "kana-u", "kana-e", "kana-o",
5062 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5063 "prolongedsound", "kana-A", "kana-I", "kana-U",
5064 "kana-E", "kana-O", "kana-KA", "kana-KI",
5065 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5066 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5067 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5068 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5069 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5070 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5071 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5072 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5073 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5074 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5075 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5076 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5078 #endif /* XK_kana_A */
5081 #define FUNCTION_KEY_OFFSET 0xff00
5083 /* You'll notice that this table is arranged to be conveniently
5084 indexed by X Windows keysym values. */
5085 static const char *lispy_function_keys
[] =
5087 /* X Keysym value */
5089 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5090 "backspace", "tab", "linefeed", "clear",
5092 0, 0, 0, "pause", /* 0xff10...1f */
5093 0, 0, 0, 0, 0, 0, 0, "escape",
5095 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5096 "romaji", "hiragana", "katakana", "hiragana-katakana",
5097 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5098 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5099 "eisu-toggle", /* 0xff30...3f */
5100 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5101 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5103 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5104 "down", "prior", "next", "end",
5105 "begin", 0, 0, 0, 0, 0, 0, 0,
5106 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5117 "break", /* 0xff6b */
5120 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5121 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5122 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5123 0, 0, 0, 0, 0, 0, 0, 0,
5124 "kp-tab", /* 0xff89 */
5126 "kp-enter", /* 0xff8d */
5128 "kp-f1", /* 0xff91 */
5132 "kp-home", /* 0xff95 */
5137 "kp-prior", /* kp-page-up */
5138 "kp-next", /* kp-page-down */
5144 0, 0, 0, 0, 0, 0, 0, 0, 0,
5145 "kp-multiply", /* 0xffaa */
5150 "kp-divide", /* 0xffaf */
5151 "kp-0", /* 0xffb0 */
5152 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5155 "kp-equal", /* 0xffbd */
5156 "f1", /* 0xffbe */ /* IsFunctionKey */
5158 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5159 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5160 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5161 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5162 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5163 0, 0, 0, 0, 0, 0, 0, 0,
5164 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5165 0, 0, 0, 0, 0, 0, 0, "delete"
5168 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5169 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5171 static const char *iso_lispy_function_keys
[] =
5173 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5174 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5175 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5176 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5177 "iso-lefttab", /* 0xfe20 */
5178 "iso-move-line-up", "iso-move-line-down",
5179 "iso-partial-line-up", "iso-partial-line-down",
5180 "iso-partial-space-left", "iso-partial-space-right",
5181 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5182 "iso-release-margin-left", "iso-release-margin-right",
5183 "iso-release-both-margins",
5184 "iso-fast-cursor-left", "iso-fast-cursor-right",
5185 "iso-fast-cursor-up", "iso-fast-cursor-down",
5186 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5187 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5190 #endif /* not HAVE_NTGUI */
5192 Lisp_Object Vlispy_mouse_stem
;
5194 static const char *lispy_wheel_names
[] =
5196 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5199 /* drag-n-drop events are generated when a set of selected files are
5200 dragged from another application and dropped onto an Emacs window. */
5201 static const char *lispy_drag_n_drop_names
[] =
5206 /* Scroll bar parts. */
5207 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5208 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5209 Lisp_Object Qtop
, Qratio
;
5211 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5212 const Lisp_Object
*scroll_bar_parts
[] = {
5213 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5214 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5217 /* A vector, indexed by button number, giving the down-going location
5218 of currently depressed buttons, both scroll bar and non-scroll bar.
5220 The elements have the form
5221 (BUTTON-NUMBER MODIFIER-MASK . REST)
5222 where REST is the cdr of a position as it would be reported in the event.
5224 The make_lispy_event function stores positions here to tell the
5225 difference between click and drag events, and to store the starting
5226 location to be included in drag events. */
5228 static Lisp_Object button_down_location
;
5230 /* Information about the most recent up-going button event: Which
5231 button, what location, and what time. */
5233 static int last_mouse_button
;
5234 static int last_mouse_x
;
5235 static int last_mouse_y
;
5236 static unsigned long button_down_time
;
5238 /* The maximum time between clicks to make a double-click, or Qnil to
5239 disable double-click detection, or Qt for no time limit. */
5241 Lisp_Object Vdouble_click_time
;
5243 /* Maximum number of pixels the mouse may be moved between clicks
5244 to make a double-click. */
5246 EMACS_INT double_click_fuzz
;
5248 /* The number of clicks in this multiple-click. */
5250 int double_click_count
;
5252 /* Return position of a mouse click or wheel event */
5255 make_lispy_position (struct frame
*f
, Lisp_Object
*x
, Lisp_Object
*y
,
5259 enum window_part part
;
5260 Lisp_Object posn
= Qnil
;
5261 Lisp_Object extra_info
= Qnil
;
5264 /* Set `window' to the window under frame pixel coordinates (x,y) */
5266 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5267 &part
, &wx
, &wy
, 0);
5271 if (WINDOWP (window
))
5273 /* It's a click in window window at frame coordinates (x,y) */
5274 struct window
*w
= XWINDOW (window
);
5275 Lisp_Object string_info
= Qnil
;
5276 int textpos
= -1, 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 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 (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-%d", 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 /* Read D-Bus messages. */
6874 xd_read_queued_messages ();
6875 #endif /* HAVE_DBUS */
6878 if (interrupt_input
)
6881 mask
= sigblock (sigmask (SIGIO
));
6882 read_avail_input (expected
);
6886 #ifdef POLL_FOR_INPUT
6887 /* XXX This condition was (read_socket_hook && !interrupt_input),
6888 but read_socket_hook is not global anymore. Let's pretend that
6890 if (!interrupt_input
&& poll_suppress_count
== 0)
6893 mask
= sigblock (sigmask (SIGALRM
));
6894 read_avail_input (expected
);
6900 read_avail_input (expected
);
6903 /* Put a BUFFER_SWITCH_EVENT in the buffer
6904 so that read_key_sequence will notice the new current buffer. */
6907 record_asynch_buffer_change (void)
6909 struct input_event event
;
6913 event
.kind
= BUFFER_SWITCH_EVENT
;
6914 event
.frame_or_window
= Qnil
;
6917 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6918 The purpose of the event is to make read_key_sequence look up the
6919 keymaps again. If we aren't in read_key_sequence, we don't need one,
6920 and the event could cause trouble by messing up (input-pending-p).
6921 Note: Fwaiting_for_user_input_p always returns nil when async
6922 subprocesses aren't supported. */
6923 tem
= Fwaiting_for_user_input_p ();
6927 /* Make sure no interrupt happens while storing the event. */
6929 if (interrupt_input
)
6932 mask
= sigblock (sigmask (SIGIO
));
6933 kbd_buffer_store_event (&event
);
6940 kbd_buffer_store_event (&event
);
6945 /* Read any terminal input already buffered up by the system
6946 into the kbd_buffer, but do not wait.
6948 EXPECTED should be nonzero if the caller knows there is some input.
6950 Returns the number of keyboard chars read, or -1 meaning
6951 this is a bad time to try to read input. */
6954 read_avail_input (int expected
)
6960 /* Store pending user signal events, if any. */
6961 if (store_user_signal_events ())
6964 /* Loop through the available terminals, and call their input hooks. */
6968 struct terminal
*next
= t
->next_terminal
;
6970 if (t
->read_socket_hook
)
6973 struct input_event hold_quit
;
6975 EVENT_INIT (hold_quit
);
6976 hold_quit
.kind
= NO_EVENT
;
6978 /* No need for FIONREAD or fcntl; just say don't wait. */
6979 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6985 if (nr
== -1) /* Not OK to read input now. */
6989 else if (nr
== -2) /* Non-transient error. */
6991 /* The terminal device terminated; it should be closed. */
6993 /* Kill Emacs if this was our last terminal. */
6994 if (!terminal_list
->next_terminal
)
6995 /* Formerly simply reported no input, but that
6996 sometimes led to a failure of Emacs to terminate.
6997 SIGHUP seems appropriate if we can't reach the
6999 /* ??? Is it really right to send the signal just to
7000 this process rather than to the whole process
7001 group? Perhaps on systems with FIONREAD Emacs is
7002 alone in its group. */
7003 kill (getpid (), SIGHUP
);
7005 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7008 XSETTERMINAL (tmp
, t
);
7009 Fdelete_terminal (tmp
, Qnoelisp
);
7013 if (hold_quit
.kind
!= NO_EVENT
)
7014 kbd_buffer_store_event (&hold_quit
);
7023 frame_make_pointer_visible ();
7029 decode_keyboard_code (struct tty_display_info
*tty
,
7030 struct coding_system
*coding
,
7031 unsigned char *buf
, int nbytes
)
7033 unsigned char *src
= buf
;
7034 const unsigned char *p
;
7039 if (tty
->meta_key
!= 2)
7040 for (i
= 0; i
< nbytes
; i
++)
7042 if (coding
->carryover_bytes
> 0)
7044 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7045 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7046 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7047 nbytes
+= coding
->carryover_bytes
;
7049 coding
->destination
= alloca (nbytes
* 4);
7050 coding
->dst_bytes
= nbytes
* 4;
7051 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7052 if (coding
->produced_char
== 0)
7054 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7056 struct input_event buf
;
7059 buf
.code
= STRING_CHAR_ADVANCE (p
);
7060 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7061 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7062 /* See the comment in tty_read_avail_input. */
7063 buf
.frame_or_window
= tty
->top_frame
;
7065 kbd_buffer_store_event (&buf
);
7069 /* This is the tty way of reading available input.
7071 Note that each terminal device has its own `struct terminal' object,
7072 and so this function is called once for each individual termcap
7073 terminal. The first parameter indicates which terminal to read from. */
7076 tty_read_avail_input (struct terminal
*terminal
,
7078 struct input_event
*hold_quit
)
7080 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7081 the kbd_buffer can really hold. That may prevent loss
7082 of characters on some systems when input is stuffed at us. */
7083 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7085 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7087 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
7089 if (kbd_on_hold_p () || buffer_free
<= 0)
7092 if (!terminal
->name
) /* Don't read from a dead terminal. */
7095 if (terminal
->type
!= output_termcap
7096 && terminal
->type
!= output_msdos_raw
)
7099 /* XXX I think the following code should be moved to separate hook
7100 functions in system-dependent files. */
7103 #else /* not WINDOWSNT */
7104 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7108 return 0; /* The terminal is suspended. */
7111 n_to_read
= dos_keysns ();
7115 cbuf
[0] = dos_keyread ();
7118 #else /* not MSDOS */
7123 struct input_event hold_quit
;
7124 int gpm
, fd
= gpm_fd
;
7126 EVENT_INIT (hold_quit
);
7127 hold_quit
.kind
= NO_EVENT
;
7129 /* gpm==1 if event received.
7130 gpm==0 if the GPM daemon has closed the connection, in which case
7131 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7132 we save it in `fd' so close_gpm can remove it from the
7134 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7135 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7136 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7139 /* Presumably the GPM daemon has closed the connection. */
7141 if (hold_quit
.kind
!= NO_EVENT
)
7142 kbd_buffer_store_event (&hold_quit
);
7146 #endif /* HAVE_GPM */
7148 /* Determine how many characters we should *try* to read. */
7150 /* Find out how much input is available. */
7151 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7153 if (! noninteractive
)
7154 return -2; /* Close this terminal. */
7160 if (n_to_read
> sizeof cbuf
)
7161 n_to_read
= sizeof cbuf
;
7162 #else /* no FIONREAD */
7163 #if defined (USG) || defined(CYGWIN)
7164 /* Read some input if available, but don't wait. */
7165 n_to_read
= sizeof cbuf
;
7166 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7172 /* Don't read more than we can store. */
7173 if (n_to_read
> buffer_free
)
7174 n_to_read
= buffer_free
;
7176 /* Now read; for one reason or another, this will not block.
7177 NREAD is set to the number of chars read. */
7180 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7181 /* POSIX infers that processes which are not in the session leader's
7182 process group won't get SIGHUP's at logout time. BSDI adheres to
7183 this part standard and returns -1 from read (0) with errno==EIO
7184 when the control tty is taken away.
7185 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7186 if (nread
== -1 && errno
== EIO
)
7187 return -2; /* Close this terminal. */
7188 #if defined (AIX) && defined (_BSD)
7189 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7190 This looks incorrect, but it isn't, because _BSD causes
7191 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7192 and that causes a value other than 0 when there is no input. */
7194 return -2; /* Close this terminal. */
7198 /* We used to retry the read if it was interrupted.
7199 But this does the wrong thing when O_NDELAY causes
7200 an EAGAIN error. Does anybody know of a situation
7201 where a retry is actually needed? */
7203 nread
< 0 && (errno
== EAGAIN
7217 #if defined (USG) || defined (CYGWIN)
7218 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7219 #endif /* USG or CYGWIN */
7220 #endif /* no FIONREAD */
7225 #endif /* not MSDOS */
7226 #endif /* not WINDOWSNT */
7228 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7229 & CODING_REQUIRE_DECODING_MASK
)
7231 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7234 /* Decode the key sequence except for those with meta
7236 for (i
= from
= 0; ; i
++)
7237 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7239 struct input_event buf
;
7241 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7246 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7247 buf
.modifiers
= meta_modifier
;
7248 buf
.code
= cbuf
[i
] & ~0x80;
7249 /* See the comment below. */
7250 buf
.frame_or_window
= tty
->top_frame
;
7252 kbd_buffer_store_event (&buf
);
7258 for (i
= 0; i
< nread
; i
++)
7260 struct input_event buf
;
7262 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7264 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7265 buf
.modifiers
= meta_modifier
;
7266 if (tty
->meta_key
!= 2)
7270 /* Set the frame corresponding to the active tty. Note that the
7271 value of selected_frame is not reliable here, redisplay tends
7272 to temporarily change it. */
7273 buf
.frame_or_window
= tty
->top_frame
;
7276 kbd_buffer_store_event (&buf
);
7277 /* Don't look at input that follows a C-g too closely.
7278 This reduces lossage due to autorepeat on C-g. */
7279 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7280 && buf
.code
== quit_char
)
7288 handle_async_input (void)
7290 interrupt_input_pending
= 0;
7292 pending_signals
= pending_atimers
;
7294 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7295 doing anything dangerous. */
7302 nread
= read_avail_input (1);
7303 /* -1 means it's not ok to read the input now.
7304 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7305 0 means there was no keyboard input available. */
7315 process_pending_signals (void)
7317 if (interrupt_input_pending
)
7318 handle_async_input ();
7319 do_pending_atimers ();
7322 #ifdef SIGIO /* for entire page */
7323 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7326 input_available_signal (int signo
)
7328 /* Must preserve main program's value of errno. */
7329 int old_errno
= errno
;
7330 SIGNAL_THREAD_CHECK (signo
);
7333 interrupt_input_pending
= 1;
7334 pending_signals
= 1;
7337 if (input_available_clear_time
)
7338 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7341 handle_async_input ();
7348 /* Send ourselves a SIGIO.
7350 This function exists so that the UNBLOCK_INPUT macro in
7351 blockinput.h can have some way to take care of input we put off
7352 dealing with, without assuming that every file which uses
7353 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7355 reinvoke_input_signal (void)
7358 handle_async_input ();
7364 /* User signal events. */
7366 struct user_signal_info
7368 /* Signal number. */
7371 /* Name of the signal. */
7374 /* Number of pending signals. */
7377 struct user_signal_info
*next
;
7380 /* List of user signals. */
7381 static struct user_signal_info
*user_signals
= NULL
;
7384 add_user_signal (int sig
, const char *name
)
7386 struct user_signal_info
*p
;
7388 for (p
= user_signals
; p
; p
= p
->next
)
7390 /* Already added. */
7393 p
= xmalloc (sizeof (struct user_signal_info
));
7395 p
->name
= xstrdup (name
);
7397 p
->next
= user_signals
;
7400 signal (sig
, handle_user_signal
);
7404 handle_user_signal (int sig
)
7406 int old_errno
= errno
;
7407 struct user_signal_info
*p
;
7409 SIGNAL_THREAD_CHECK (sig
);
7411 for (p
= user_signals
; p
; p
= p
->next
)
7416 if (interrupt_input
)
7417 kill (getpid (), SIGIO
);
7421 /* Tell wait_reading_process_output that it needs to wake
7422 up and look around. */
7423 if (input_available_clear_time
)
7424 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7433 find_user_signal_name (int sig
)
7435 struct user_signal_info
*p
;
7437 for (p
= user_signals
; p
; p
= p
->next
)
7445 store_user_signal_events (void)
7447 struct user_signal_info
*p
;
7448 struct input_event buf
;
7451 for (p
= user_signals
; p
; p
= p
->next
)
7452 if (p
->npending
> 0)
7458 memset (&buf
, 0, sizeof buf
);
7459 buf
.kind
= USER_SIGNAL_EVENT
;
7460 buf
.frame_or_window
= selected_frame
;
7462 nstored
+= p
->npending
;
7464 mask
= sigblock (sigmask (p
->sig
));
7468 kbd_buffer_store_event (&buf
);
7471 while (p
->npending
> 0);
7479 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7480 static Lisp_Object menu_bar_one_keymap_changed_items
;
7482 /* These variables hold the vector under construction within
7483 menu_bar_items and its subroutines, and the current index
7484 for storing into that vector. */
7485 static Lisp_Object menu_bar_items_vector
;
7486 static int menu_bar_items_index
;
7488 /* Return a vector of menu items for a menu bar, appropriate
7489 to the current buffer. Each item has three elements in the vector:
7492 OLD is an old vector we can optionally reuse, or nil. */
7495 menu_bar_items (Lisp_Object old
)
7497 /* The number of keymaps we're scanning right now, and the number of
7498 keymaps we have allocated space for. */
7501 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7502 in the current keymaps, or nil where it is not a prefix. */
7505 Lisp_Object def
, tail
;
7514 /* In order to build the menus, we need to call the keymap
7515 accessors. They all call QUIT. But this function is called
7516 during redisplay, during which a quit is fatal. So inhibit
7517 quitting while building the menus.
7518 We do this instead of specbind because (1) errors will clear it anyway
7519 and (2) this avoids risk of specpdl overflow. */
7520 oquit
= Vinhibit_quit
;
7524 menu_bar_items_vector
= old
;
7526 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7527 menu_bar_items_index
= 0;
7529 /* Build our list of keymaps.
7530 If we recognize a function key and replace its escape sequence in
7531 keybuf with its symbol, or if the sequence starts with a mouse
7532 click and we need to switch buffers, we jump back here to rebuild
7533 the initial keymaps from the current buffer. */
7537 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7538 if (!NILP (Voverriding_local_map_menu_flag
))
7540 /* Yes, use them (if non-nil) as well as the global map. */
7541 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7543 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7544 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7545 if (!NILP (Voverriding_local_map
))
7546 maps
[nmaps
++] = Voverriding_local_map
;
7550 /* No, so use major and minor mode keymaps and keymap property.
7551 Note that menu-bar bindings in the local-map and keymap
7552 properties may not work reliable, as they are only
7553 recognized when the menu-bar (or mode-line) is updated,
7554 which does not normally happen after every command. */
7557 nminor
= current_minor_maps (NULL
, &tmaps
);
7558 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7560 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7561 maps
[nmaps
++] = tem
;
7562 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7564 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7566 maps
[nmaps
++] = current_global_map
;
7569 /* Look up in each map the dummy prefix key `menu-bar'. */
7573 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7574 if (!NILP (maps
[mapno
]))
7576 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7580 menu_bar_one_keymap_changed_items
= Qnil
;
7581 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7585 /* Move to the end those items that should be at the end. */
7587 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7590 int end
= menu_bar_items_index
;
7592 for (i
= 0; i
< end
; i
+= 4)
7593 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7595 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7596 /* Move the item at index I to the end,
7597 shifting all the others forward. */
7598 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7599 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7600 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7601 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7603 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7604 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7605 (end
- i
- 4) * sizeof (Lisp_Object
));
7606 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7607 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7608 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7609 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7614 /* Add nil, nil, nil, nil at the end. */
7615 i
= menu_bar_items_index
;
7616 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7617 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7618 /* Add this item. */
7619 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7620 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7621 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7622 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7623 menu_bar_items_index
= i
;
7625 Vinhibit_quit
= oquit
;
7626 return menu_bar_items_vector
;
7629 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7630 If there's already an item for KEY, add this DEF to it. */
7632 Lisp_Object item_properties
;
7635 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7637 struct gcpro gcpro1
;
7641 if (EQ (item
, Qundefined
))
7643 /* If a map has an explicit `undefined' as definition,
7644 discard any previously made menu bar item. */
7646 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7647 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7649 if (menu_bar_items_index
> i
+ 4)
7650 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7651 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7652 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7653 menu_bar_items_index
-= 4;
7657 /* If this keymap has already contributed to this KEY,
7658 don't contribute to it a second time. */
7659 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7660 if (!NILP (tem
) || NILP (item
))
7663 menu_bar_one_keymap_changed_items
7664 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7666 /* We add to menu_bar_one_keymap_changed_items before doing the
7667 parse_menu_item, so that if it turns out it wasn't a menu item,
7668 it still correctly hides any further menu item. */
7670 i
= parse_menu_item (item
, 1);
7675 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7677 /* Find any existing item for this KEY. */
7678 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7679 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7682 /* If we did not find this KEY, add it at the end. */
7683 if (i
== menu_bar_items_index
)
7685 /* If vector is too small, get a bigger one. */
7686 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7687 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7688 /* Add this item. */
7689 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7690 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7691 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7692 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7693 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7694 menu_bar_items_index
= i
;
7696 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7700 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7701 /* If the new and the old items are not both keymaps,
7702 the lookup will only find `item'. */
7703 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7704 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7708 /* This is used as the handler when calling menu_item_eval_property. */
7710 menu_item_eval_property_1 (Lisp_Object arg
)
7712 /* If we got a quit from within the menu computation,
7713 quit all the way out of it. This takes care of C-] in the debugger. */
7714 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7715 Fsignal (Qquit
, Qnil
);
7720 /* Evaluate an expression and return the result (or nil if something
7721 went wrong). Used to evaluate dynamic parts of menu items. */
7723 menu_item_eval_property (Lisp_Object sexpr
)
7725 int count
= SPECPDL_INDEX ();
7727 specbind (Qinhibit_redisplay
, Qt
);
7728 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7729 menu_item_eval_property_1
);
7730 return unbind_to (count
, val
);
7733 /* This function parses a menu item and leaves the result in the
7734 vector item_properties.
7735 ITEM is a key binding, a possible menu item.
7736 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7738 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7739 parse_menu_item returns true if the item is a menu item and false
7743 parse_menu_item (Lisp_Object item
, int inmenubar
)
7745 Lisp_Object def
, tem
, item_string
, start
;
7747 Lisp_Object keyhint
;
7756 /* Create item_properties vector if necessary. */
7757 if (NILP (item_properties
))
7759 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7761 /* Initialize optional entries. */
7762 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7763 ASET (item_properties
, i
, Qnil
);
7764 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7766 /* Save the item here to protect it from GC. */
7767 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7769 item_string
= XCAR (item
);
7773 if (STRINGP (item_string
))
7775 /* Old format menu item. */
7776 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7778 /* Maybe help string. */
7779 if (CONSP (item
) && STRINGP (XCAR (item
)))
7781 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7786 /* Maybe an obsolete key binding cache. */
7787 if (CONSP (item
) && CONSP (XCAR (item
))
7788 && (NILP (XCAR (XCAR (item
)))
7789 || VECTORP (XCAR (XCAR (item
)))))
7792 /* This is the real definition--the function to run. */
7793 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7795 /* Get enable property, if any. */
7798 tem
= Fget (item
, Qmenu_enable
);
7799 if (!NILP (Venable_disabled_menus_and_buttons
))
7800 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7801 else if (!NILP (tem
))
7802 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7805 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7807 /* New format menu item. */
7808 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7809 start
= XCDR (item
);
7812 /* We have a real binding. */
7813 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7815 item
= XCDR (start
);
7816 /* Is there an obsolete cache list with key equivalences. */
7817 if (CONSP (item
) && CONSP (XCAR (item
)))
7820 /* Parse properties. */
7821 while (CONSP (item
) && CONSP (XCDR (item
)))
7826 if (EQ (tem
, QCenable
))
7828 if (!NILP (Venable_disabled_menus_and_buttons
))
7829 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7831 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7833 else if (EQ (tem
, QCvisible
))
7835 /* If got a visible property and that evaluates to nil
7836 then ignore this item. */
7837 tem
= menu_item_eval_property (XCAR (item
));
7841 else if (EQ (tem
, QChelp
))
7842 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7843 else if (EQ (tem
, QCfilter
))
7845 else if (EQ (tem
, QCkey_sequence
))
7848 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7849 /* Be GC protected. Set keyhint to item instead of tem. */
7852 else if (EQ (tem
, QCkeys
))
7855 if (CONSP (tem
) || STRINGP (tem
))
7856 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7858 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7863 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7865 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7867 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7873 else if (inmenubar
|| !NILP (start
))
7877 return 0; /* not a menu item */
7879 /* If item string is not a string, evaluate it to get string.
7880 If we don't get a string, skip this item. */
7881 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7882 if (!(STRINGP (item_string
)))
7884 item_string
= menu_item_eval_property (item_string
);
7885 if (!STRINGP (item_string
))
7887 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7890 /* If got a filter apply it on definition. */
7891 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7894 def
= menu_item_eval_property (list2 (XCAR (filter
),
7895 list2 (Qquote
, def
)));
7897 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7900 /* Enable or disable selection of item. */
7901 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7904 tem
= menu_item_eval_property (tem
);
7905 if (inmenubar
&& NILP (tem
))
7906 return 0; /* Ignore disabled items in menu bar. */
7907 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7910 /* If we got no definition, this item is just unselectable text which
7911 is OK in a submenu but not in the menubar. */
7913 return (inmenubar
? 0 : 1);
7915 /* See if this is a separate pane or a submenu. */
7916 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7917 tem
= get_keymap (def
, 0, 1);
7918 /* For a subkeymap, just record its details and exit. */
7921 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7922 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7926 /* At the top level in the menu bar, do likewise for commands also.
7927 The menu bar does not display equivalent key bindings anyway.
7928 ITEM_PROPERTY_DEF is already set up properly. */
7932 { /* This is a command. See if there is an equivalent key binding. */
7933 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7935 /* The previous code preferred :key-sequence to :keys, so we
7936 preserve this behavior. */
7937 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7938 keyeq
= Fsubstitute_command_keys (keyeq
);
7941 Lisp_Object prefix
= keyeq
;
7942 Lisp_Object keys
= Qnil
;
7946 def
= XCAR (prefix
);
7947 prefix
= XCDR (prefix
);
7950 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7952 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7954 keys
= XCAR (keyhint
);
7955 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7957 /* We have a suggested key. Is it bound to the command? */
7960 /* If the command is an alias for another
7961 (such as lmenu.el set it up), check if the
7962 original command matches the cached command. */
7963 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7968 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7972 tem
= Fkey_description (keys
, Qnil
);
7975 if (STRINGP (XCAR (prefix
)))
7976 tem
= concat2 (XCAR (prefix
), tem
);
7977 if (STRINGP (XCDR (prefix
)))
7978 tem
= concat2 (tem
, XCDR (prefix
));
7980 keyeq
= concat2 (build_string (" "), tem
);
7981 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7987 /* If we have an equivalent key binding, use that. */
7988 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7991 /* Include this when menu help is implemented.
7992 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7993 if (!(NILP (tem) || STRINGP (tem)))
7995 tem = menu_item_eval_property (tem);
7998 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
8002 /* Handle radio buttons or toggle boxes. */
8003 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8005 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
8006 menu_item_eval_property (tem
));
8013 /***********************************************************************
8015 ***********************************************************************/
8017 /* A vector holding tool bar items while they are parsed in function
8018 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8021 static Lisp_Object tool_bar_items_vector
;
8023 /* A vector holding the result of parse_tool_bar_item. Layout is like
8024 the one for a single item in tool_bar_items_vector. */
8026 static Lisp_Object tool_bar_item_properties
;
8028 /* Next free index in tool_bar_items_vector. */
8030 static int ntool_bar_items
;
8032 /* The symbols `:image' and `:rtl'. */
8034 Lisp_Object QCimage
;
8037 /* Function prototypes. */
8039 static void init_tool_bar_items (Lisp_Object
);
8040 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8041 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8042 static void append_tool_bar_item (void);
8045 /* Return a vector of tool bar items for keymaps currently in effect.
8046 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8047 tool bar items found. */
8050 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8059 /* In order to build the menus, we need to call the keymap
8060 accessors. They all call QUIT. But this function is called
8061 during redisplay, during which a quit is fatal. So inhibit
8062 quitting while building the menus. We do this instead of
8063 specbind because (1) errors will clear it anyway and (2) this
8064 avoids risk of specpdl overflow. */
8065 oquit
= Vinhibit_quit
;
8068 /* Initialize tool_bar_items_vector and protect it from GC. */
8069 init_tool_bar_items (reuse
);
8071 /* Build list of keymaps in maps. Set nmaps to the number of maps
8074 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8075 if (!NILP (Voverriding_local_map_menu_flag
))
8077 /* Yes, use them (if non-nil) as well as the global map. */
8078 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8080 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8081 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8082 if (!NILP (Voverriding_local_map
))
8083 maps
[nmaps
++] = Voverriding_local_map
;
8087 /* No, so use major and minor mode keymaps and keymap property.
8088 Note that tool-bar bindings in the local-map and keymap
8089 properties may not work reliable, as they are only
8090 recognized when the tool-bar (or mode-line) is updated,
8091 which does not normally happen after every command. */
8094 nminor
= current_minor_maps (NULL
, &tmaps
);
8095 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8097 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8098 maps
[nmaps
++] = tem
;
8099 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8101 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8104 /* Add global keymap at the end. */
8105 maps
[nmaps
++] = current_global_map
;
8107 /* Process maps in reverse order and look up in each map the prefix
8109 for (i
= nmaps
- 1; i
>= 0; --i
)
8110 if (!NILP (maps
[i
]))
8114 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8116 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8119 Vinhibit_quit
= oquit
;
8120 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8121 return tool_bar_items_vector
;
8125 /* Process the definition of KEY which is DEF. */
8128 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8131 struct gcpro gcpro1
, gcpro2
;
8133 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8137 if (EQ (def
, Qundefined
))
8139 /* If a map has an explicit `undefined' as definition,
8140 discard any previously made item. */
8141 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8143 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8145 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8147 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8148 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8149 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8150 * sizeof (Lisp_Object
)));
8151 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8156 else if (parse_tool_bar_item (key
, def
))
8157 /* Append a new tool bar item to tool_bar_items_vector. Accept
8158 more than one definition for the same key. */
8159 append_tool_bar_item ();
8165 /* Parse a tool bar item specification ITEM for key KEY and return the
8166 result in tool_bar_item_properties. Value is zero if ITEM is
8169 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8171 CAPTION is the caption of the item, If it's not a string, it is
8172 evaluated to get a string.
8174 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8175 as binding are currently ignored.
8177 The following properties are recognized:
8181 FORM is evaluated and specifies whether the tool bar item is
8182 enabled or disabled.
8186 FORM is evaluated and specifies whether the tool bar item is visible.
8188 - `:filter FUNCTION'
8190 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8191 result is stored as the new binding.
8193 - `:button (TYPE SELECTED)'
8195 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8196 and specifies whether the button is selected (pressed) or not.
8200 IMAGES is either a single image specification or a vector of four
8201 image specifications. See enum tool_bar_item_images.
8203 - `:help HELP-STRING'.
8205 Gives a help string to display for the tool bar item.
8207 - `:label LABEL-STRING'.
8209 A text label to show with the tool bar button if labels are enabled. */
8212 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8214 /* Access slot with index IDX of vector tool_bar_item_properties. */
8215 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8217 Lisp_Object filter
= Qnil
;
8218 Lisp_Object caption
;
8219 int i
, have_label
= 0;
8221 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8222 Rule out items that aren't lists, don't start with
8223 `menu-item' or whose rest following `tool-bar-item' is not a
8226 || !EQ (XCAR (item
), Qmenu_item
)
8227 || (item
= XCDR (item
),
8231 /* Create tool_bar_item_properties vector if necessary. Reset it to
8233 if (VECTORP (tool_bar_item_properties
))
8235 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8239 tool_bar_item_properties
8240 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8243 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8244 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8246 /* Get the caption of the item. If the caption is not a string,
8247 evaluate it to get a string. If we don't get a string, skip this
8249 caption
= XCAR (item
);
8250 if (!STRINGP (caption
))
8252 caption
= menu_item_eval_property (caption
);
8253 if (!STRINGP (caption
))
8256 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8258 /* Give up if rest following the caption is not a list. */
8263 /* Store the binding. */
8264 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8267 /* Ignore cached key binding, if any. */
8268 if (CONSP (item
) && CONSP (XCAR (item
)))
8271 /* Process the rest of the properties. */
8272 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8274 Lisp_Object key
, value
;
8277 value
= XCAR (XCDR (item
));
8279 if (EQ (key
, QCenable
))
8281 /* `:enable FORM'. */
8282 if (!NILP (Venable_disabled_menus_and_buttons
))
8283 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8285 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8287 else if (EQ (key
, QCvisible
))
8289 /* `:visible FORM'. If got a visible property and that
8290 evaluates to nil then ignore this item. */
8291 if (NILP (menu_item_eval_property (value
)))
8294 else if (EQ (key
, QChelp
))
8295 /* `:help HELP-STRING'. */
8296 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8297 else if (EQ (key
, QClabel
))
8299 const char *bad_label
= "!!?GARBLED ITEM?!!";
8300 /* `:label LABEL-STRING'. */
8301 PROP (TOOL_BAR_ITEM_HELP
) = STRINGP (value
)
8303 : make_string (bad_label
, strlen (bad_label
));
8306 else if (EQ (key
, QCfilter
))
8307 /* ':filter FORM'. */
8309 else if (EQ (key
, QCbutton
) && CONSP (value
))
8311 /* `:button (TYPE . SELECTED)'. */
8312 Lisp_Object type
, selected
;
8314 type
= XCAR (value
);
8315 selected
= XCDR (value
);
8316 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8318 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8319 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8322 else if (EQ (key
, QCimage
)
8324 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8325 /* Value is either a single image specification or a vector
8326 of 4 such specifications for the different button states. */
8327 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8328 else if (EQ (key
, Qrtl
))
8330 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8336 /* Try to make one from caption and key. */
8337 Lisp_Object key
= PROP (TOOL_BAR_ITEM_KEY
);
8338 Lisp_Object capt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8339 const char *label
= SYMBOLP (key
) ? (char *) SDATA (SYMBOL_NAME (key
)) : "";
8340 const char *caption
= STRINGP (capt
) ? (char *) SDATA (capt
) : "";
8341 EMACS_INT max_lbl
= 2 * tool_bar_max_label_size
;
8342 char *buf
= (char *) xmalloc (max_lbl
+ 1);
8343 Lisp_Object new_lbl
;
8344 size_t caption_len
= strlen (caption
);
8346 if (caption_len
<= max_lbl
&& caption
[0] != '\0')
8348 strcpy (buf
, caption
);
8349 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8351 buf
[caption_len
] = '\0';
8352 label
= caption
= buf
;
8355 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8359 strcpy (buf
, label
);
8361 for (i
= 0; buf
[i
] != '\0'; ++i
)
8370 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8371 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8372 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8374 PROP (TOOL_BAR_ITEM_LABEL
) = make_string ("", 0);
8378 /* If got a filter apply it on binding. */
8380 PROP (TOOL_BAR_ITEM_BINDING
)
8381 = menu_item_eval_property (list2 (filter
,
8383 PROP (TOOL_BAR_ITEM_BINDING
))));
8385 /* See if the binding is a keymap. Give up if it is. */
8386 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8389 /* Enable or disable selection of item. */
8390 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8391 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8392 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8394 /* Handle radio buttons or toggle boxes. */
8395 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8396 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8397 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8405 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8406 that can be reused. */
8409 init_tool_bar_items (Lisp_Object reuse
)
8411 if (VECTORP (reuse
))
8412 tool_bar_items_vector
= reuse
;
8414 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8415 ntool_bar_items
= 0;
8419 /* Append parsed tool bar item properties from
8420 tool_bar_item_properties */
8423 append_tool_bar_item (void)
8425 Lisp_Object
*to
, *from
;
8427 /* Enlarge tool_bar_items_vector if necessary. */
8428 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8429 >= XVECTOR (tool_bar_items_vector
)->size
)
8430 tool_bar_items_vector
8431 = larger_vector (tool_bar_items_vector
,
8432 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8434 /* Append entries from tool_bar_item_properties to the end of
8435 tool_bar_items_vector. */
8436 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8437 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8438 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8439 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8446 /* Read a character using menus based on maps in the array MAPS.
8447 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8448 Return t if we displayed a menu but the user rejected it.
8450 PREV_EVENT is the previous input event, or nil if we are reading
8451 the first event of a key sequence.
8453 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8454 if we used a mouse menu to read the input, or zero otherwise. If
8455 USED_MOUSE_MENU is null, we don't dereference it.
8457 The prompting is done based on the prompt-string of the map
8458 and the strings associated with various map elements.
8460 This can be done with X menus or with menus put in the minibuf.
8461 These are done in different ways, depending on how the input will be read.
8462 Menus using X are done after auto-saving in read-char, getting the input
8463 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8464 and do auto-saving in the inner call of read_char. */
8467 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8468 int *used_mouse_menu
)
8472 if (used_mouse_menu
)
8473 *used_mouse_menu
= 0;
8475 /* Use local over global Menu maps */
8477 if (! menu_prompting
)
8480 /* Optionally disregard all but the global map. */
8481 if (inhibit_local_menu_bar_menus
)
8483 maps
+= (nmaps
- 1);
8488 /* If we got to this point via a mouse click,
8489 use a real menu for mouse selection. */
8490 if (EVENT_HAS_PARAMETERS (prev_event
)
8491 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8492 && !EQ (XCAR (prev_event
), Qtool_bar
))
8494 /* Display the menu and get the selection. */
8495 Lisp_Object
*realmaps
8496 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8500 /* Use the maps that are not nil. */
8501 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8502 if (!NILP (maps
[mapno
]))
8503 realmaps
[nmaps1
++] = maps
[mapno
];
8505 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8510 record_menu_key (XCAR (value
));
8512 /* If we got multiple events, unread all but
8514 There is no way to prevent those unread events
8515 from showing up later in last_nonmenu_event.
8516 So turn symbol and integer events into lists,
8517 to indicate that they came from a mouse menu,
8518 so that when present in last_nonmenu_event
8519 they won't confuse things. */
8520 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8522 record_menu_key (XCAR (tem
));
8523 if (SYMBOLP (XCAR (tem
))
8524 || INTEGERP (XCAR (tem
)))
8525 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8528 /* If we got more than one event, put all but the first
8529 onto this list to be read later.
8530 Return just the first event now. */
8531 Vunread_command_events
8532 = nconc2 (XCDR (value
), Vunread_command_events
);
8533 value
= XCAR (value
);
8535 else if (NILP (value
))
8537 if (used_mouse_menu
)
8538 *used_mouse_menu
= 1;
8541 #endif /* HAVE_MENUS */
8545 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8546 We make this bigger when necessary, and never free it. */
8547 static char *read_char_minibuf_menu_text
;
8548 /* Size of that buffer. */
8549 static int read_char_minibuf_menu_width
;
8552 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8555 register Lisp_Object name
;
8557 /* FIXME: Use the minibuffer's frame width. */
8558 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8561 Lisp_Object rest
, vector
;
8567 if (! menu_prompting
)
8570 /* Get the menu name from the first map that has one (a prompt string). */
8571 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8573 name
= Fkeymap_prompt (maps
[mapno
]);
8578 /* If we don't have any menus, just read a character normally. */
8579 if (!STRINGP (name
))
8582 /* Make sure we have a big enough buffer for the menu text. */
8583 width
= max (width
, SBYTES (name
));
8584 if (read_char_minibuf_menu_text
== 0)
8586 read_char_minibuf_menu_width
= width
+ 4;
8587 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8589 else if (width
+ 4 > read_char_minibuf_menu_width
)
8591 read_char_minibuf_menu_width
= width
+ 4;
8592 read_char_minibuf_menu_text
8593 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8595 menu
= read_char_minibuf_menu_text
;
8597 /* Prompt string always starts with map's prompt, and a space. */
8598 strcpy (menu
, SDATA (name
));
8599 nlength
= SBYTES (name
);
8600 menu
[nlength
++] = ':';
8601 menu
[nlength
++] = ' ';
8604 /* Start prompting at start of first map. */
8608 /* Present the documented bindings, a line at a time. */
8615 Lisp_Object orig_defn_macro
;
8617 /* Loop over elements of map. */
8622 /* If reached end of map, start at beginning of next map. */
8626 /* At end of last map, wrap around to first map if just starting,
8627 or end this line if already have something on it. */
8631 if (notfirst
|| nobindings
) break;
8636 /* Look at the next element of the map. */
8638 elt
= XVECTOR (vector
)->contents
[idx
];
8640 elt
= Fcar_safe (rest
);
8642 if (idx
< 0 && VECTORP (elt
))
8644 /* If we found a dense table in the keymap,
8645 advanced past it, but start scanning its contents. */
8646 rest
= Fcdr_safe (rest
);
8652 /* An ordinary element. */
8653 Lisp_Object event
, tem
;
8657 event
= Fcar_safe (elt
); /* alist */
8658 elt
= Fcdr_safe (elt
);
8662 XSETINT (event
, idx
); /* vector */
8665 /* Ignore the element if it has no prompt string. */
8666 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8668 /* 1 if the char to type matches the string. */
8670 Lisp_Object upcased_event
, downcased_event
;
8671 Lisp_Object desc
= Qnil
;
8673 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8675 upcased_event
= Fupcase (event
);
8676 downcased_event
= Fdowncase (event
);
8677 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8678 || XINT (downcased_event
) == SREF (s
, 0));
8680 desc
= Fsingle_key_description (event
, Qnil
);
8682 #if 0 /* It is redundant to list the equivalent key bindings because
8683 the prefix is what the user has already typed. */
8685 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8687 /* Insert equivalent keybinding. */
8688 s
= concat2 (s
, tem
);
8691 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8692 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8694 /* Insert button prefix. */
8695 Lisp_Object selected
8696 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8697 if (EQ (tem
, QCradio
))
8698 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8700 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8701 s
= concat2 (tem
, s
);
8705 /* If we have room for the prompt string, add it to this line.
8706 If this is the first on the line, always add it. */
8707 if ((SCHARS (s
) + i
+ 2
8708 + (char_matches
? 0 : SCHARS (desc
) + 3))
8714 /* Punctuate between strings. */
8717 strcpy (menu
+ i
, ", ");
8723 /* If the char to type doesn't match the string's
8724 first char, explicitly show what char to type. */
8727 /* Add as much of string as fits. */
8728 thiswidth
= SCHARS (desc
);
8729 if (thiswidth
+ i
> width
)
8730 thiswidth
= width
- i
;
8731 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8733 strcpy (menu
+ i
, " = ");
8737 /* Add as much of string as fits. */
8738 thiswidth
= SCHARS (s
);
8739 if (thiswidth
+ i
> width
)
8740 thiswidth
= width
- i
;
8741 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8747 /* If this element does not fit, end the line now,
8748 and save the element for the next line. */
8749 strcpy (menu
+ i
, "...");
8754 /* Move past this element. */
8755 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8756 /* Handle reaching end of dense table. */
8761 rest
= Fcdr_safe (rest
);
8765 /* Prompt with that and read response. */
8766 message2_nolog (menu
, strlen (menu
),
8767 ! NILP (current_buffer
->enable_multibyte_characters
));
8769 /* Make believe its not a keyboard macro in case the help char
8770 is pressed. Help characters are not recorded because menu prompting
8771 is not used on replay.
8773 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8774 current_kboard
->defining_kbd_macro
= Qnil
;
8776 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8777 while (BUFFERP (obj
));
8778 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8780 if (!INTEGERP (obj
))
8782 else if (XINT (obj
) == -2)
8787 if (! EQ (obj
, menu_prompt_more_char
)
8788 && (!INTEGERP (menu_prompt_more_char
)
8789 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8791 if (!NILP (current_kboard
->defining_kbd_macro
))
8792 store_kbd_macro_char (obj
);
8795 /* Help char - go round again */
8799 /* Reading key sequences. */
8801 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8802 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8803 keymap, or nil otherwise. Return the index of the first keymap in
8804 which KEY has any binding, or NMAPS if no map has a binding.
8806 If KEY is a meta ASCII character, treat it like meta-prefix-char
8807 followed by the corresponding non-meta character. Keymaps in
8808 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8811 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8814 NEXT may be the same array as CURRENT. */
8817 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8820 int i
, first_binding
;
8822 first_binding
= nmaps
;
8823 for (i
= nmaps
- 1; i
>= 0; i
--)
8825 if (! NILP (current
[i
]))
8827 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8828 if (! NILP (defs
[i
]))
8835 /* Given the set of bindings we've found, produce the next set of maps. */
8836 if (first_binding
< nmaps
)
8837 for (i
= 0; i
< nmaps
; i
++)
8838 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8840 return first_binding
;
8843 /* Structure used to keep track of partial application of key remapping
8844 such as Vfunction_key_map and Vkey_translation_map. */
8845 typedef struct keyremap
8847 /* This is the map originally specified for this use. */
8849 /* This is a submap reached by looking up, in PARENT,
8850 the events from START to END. */
8852 /* Positions [START, END) in the key sequence buffer
8853 are the key that we have scanned so far.
8854 Those events are the ones that we will replace
8855 if PAREHT maps them into a key sequence. */
8859 /* Lookup KEY in MAP.
8860 MAP is a keymap mapping keys to key vectors or functions.
8861 If the mapping is a function and DO_FUNCTION is non-zero, then
8862 the function is called with PROMPT as parameter and its return
8863 value is used as the return value of this function (after checking
8864 that it is indeed a vector). */
8867 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8872 next
= access_keymap (map
, key
, 1, 0, 1);
8874 /* Handle symbol with autoload definition. */
8875 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8876 && CONSP (XSYMBOL (next
)->function
)
8877 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8878 do_autoload (XSYMBOL (next
)->function
, next
);
8880 /* Handle a symbol whose function definition is a keymap
8882 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8883 && (ARRAYP (XSYMBOL (next
)->function
)
8884 || KEYMAPP (XSYMBOL (next
)->function
)))
8885 next
= XSYMBOL (next
)->function
;
8887 /* If the keymap gives a function, not an
8888 array, then call the function with one arg and use
8889 its value instead. */
8890 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8895 next
= call1 (next
, prompt
);
8896 /* If the function returned something invalid,
8897 barf--don't ignore it.
8898 (To ignore it safely, we would need to gcpro a bunch of
8899 other variables.) */
8900 if (! (VECTORP (next
) || STRINGP (next
)))
8901 error ("Function %s returns invalid key sequence", tem
);
8906 /* Do one step of the key remapping used for function-key-map and
8907 key-translation-map:
8908 KEYBUF is the buffer holding the input events.
8909 BUFSIZE is its maximum size.
8910 FKEY is a pointer to the keyremap structure to use.
8911 INPUT is the index of the last element in KEYBUF.
8912 DOIT if non-zero says that the remapping can actually take place.
8913 DIFF is used to return the number of keys added/removed by the remapping.
8914 PARENT is the root of the keymap.
8915 PROMPT is the prompt to use if the remapping happens through a function.
8916 The return value is non-zero if the remapping actually took place. */
8919 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8920 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8922 Lisp_Object next
, key
;
8924 key
= keybuf
[fkey
->end
++];
8926 if (KEYMAPP (fkey
->parent
))
8927 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8931 /* If keybuf[fkey->start..fkey->end] is bound in the
8932 map and we're in a position to do the key remapping, replace it with
8933 the binding and restart with fkey->start at the end. */
8934 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8936 int len
= XFASTINT (Flength (next
));
8939 *diff
= len
- (fkey
->end
- fkey
->start
);
8941 if (input
+ *diff
>= bufsize
)
8942 error ("Key sequence too long");
8944 /* Shift the keys that follow fkey->end. */
8946 for (i
= fkey
->end
; i
< input
; i
++)
8947 keybuf
[i
+ *diff
] = keybuf
[i
];
8949 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8950 keybuf
[i
+ *diff
] = keybuf
[i
];
8951 /* Overwrite the old keys with the new ones. */
8952 for (i
= 0; i
< len
; i
++)
8953 keybuf
[fkey
->start
+ i
]
8954 = Faref (next
, make_number (i
));
8956 fkey
->start
= fkey
->end
+= *diff
;
8957 fkey
->map
= fkey
->parent
;
8962 fkey
->map
= get_keymap (next
, 0, 1);
8964 /* If we no longer have a bound suffix, try a new position for
8966 if (!CONSP (fkey
->map
))
8968 fkey
->end
= ++fkey
->start
;
8969 fkey
->map
= fkey
->parent
;
8974 /* Read a sequence of keys that ends with a non prefix character,
8975 storing it in KEYBUF, a buffer of size BUFSIZE.
8977 Return the length of the key sequence stored.
8978 Return -1 if the user rejected a command menu.
8980 Echo starting immediately unless `prompt' is 0.
8982 Where a key sequence ends depends on the currently active keymaps.
8983 These include any minor mode keymaps active in the current buffer,
8984 the current buffer's local map, and the global map.
8986 If a key sequence has no other bindings, we check Vfunction_key_map
8987 to see if some trailing subsequence might be the beginning of a
8988 function key's sequence. If so, we try to read the whole function
8989 key, and substitute its symbolic name into the key sequence.
8991 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8992 `double-' events into similar click events, if that would make them
8993 bound. We try to turn `triple-' events first into `double-' events,
8996 If we get a mouse click in a mode line, vertical divider, or other
8997 non-text area, we treat the click as if it were prefixed by the
8998 symbol denoting that area - `mode-line', `vertical-line', or
9001 If the sequence starts with a mouse click, we read the key sequence
9002 with respect to the buffer clicked on, not the current buffer.
9004 If the user switches frames in the midst of a key sequence, we put
9005 off the switch-frame event until later; the next call to
9006 read_char will return it.
9008 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9009 from the selected window's buffer. */
9012 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
9013 int dont_downcase_last
, int can_return_switch_frame
,
9014 int fix_current_buffer
)
9016 Lisp_Object from_string
;
9017 int count
= SPECPDL_INDEX ();
9019 /* How many keys there are in the current key sequence. */
9022 /* The length of the echo buffer when we started reading, and
9023 the length of this_command_keys when we started reading. */
9027 /* The number of keymaps we're scanning right now, and the number of
9028 keymaps we have allocated space for. */
9030 int nmaps_allocated
= 0;
9032 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9033 the current keymaps. */
9034 Lisp_Object
*defs
= NULL
;
9036 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9037 in the current keymaps, or nil where it is not a prefix. */
9038 Lisp_Object
*submaps
= NULL
;
9040 /* The local map to start out with at start of key sequence. */
9041 Lisp_Object orig_local_map
;
9043 /* The map from the `keymap' property to start out with at start of
9045 Lisp_Object orig_keymap
;
9047 /* 1 if we have already considered switching to the local-map property
9048 of the place where a mouse click occurred. */
9049 int localized_local_map
= 0;
9051 /* The index in submaps[] of the first keymap that has a binding for
9052 this key sequence. In other words, the lowest i such that
9053 submaps[i] is non-nil. */
9055 /* Index of the first key that has no binding.
9056 It is useless to try fkey.start larger than that. */
9059 /* If t < mock_input, then KEYBUF[t] should be read as the next
9062 We use this to recover after recognizing a function key. Once we
9063 realize that a suffix of the current key sequence is actually a
9064 function key's escape sequence, we replace the suffix with the
9065 function key's binding from Vfunction_key_map. Now keybuf
9066 contains a new and different key sequence, so the echo area,
9067 this_command_keys, and the submaps and defs arrays are wrong. In
9068 this situation, we set mock_input to t, set t to 0, and jump to
9069 restart_sequence; the loop will read keys from keybuf up until
9070 mock_input, thus rebuilding the state; and then it will resume
9071 reading characters from the keyboard. */
9074 /* If the sequence is unbound in submaps[], then
9075 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9076 and fkey.map is its binding.
9078 These might be > t, indicating that all function key scanning
9079 should hold off until t reaches them. We do this when we've just
9080 recognized a function key, to avoid searching for the function
9081 key's again in Vfunction_key_map. */
9084 /* Likewise, for key_translation_map and input-decode-map. */
9085 keyremap keytran
, indec
;
9087 /* Non-zero if we are trying to map a key by changing an upper-case
9088 letter to lower case, or a shifted function key to an unshifted
9090 int shift_translated
= 0;
9092 /* If we receive a `switch-frame' or `select-window' event in the middle of
9093 a key sequence, we put it off for later.
9094 While we're reading, we keep the event here. */
9095 Lisp_Object delayed_switch_frame
;
9097 /* See the comment below... */
9098 #if defined (GOBBLE_FIRST_EVENT)
9099 Lisp_Object first_event
;
9102 Lisp_Object original_uppercase
;
9103 int original_uppercase_position
= -1;
9105 /* Gets around Microsoft compiler limitations. */
9108 struct buffer
*starting_buffer
;
9110 /* List of events for which a fake prefix key has been generated. */
9111 Lisp_Object fake_prefixed_keys
= Qnil
;
9113 #if defined (GOBBLE_FIRST_EVENT)
9117 struct gcpro gcpro1
;
9119 GCPRO1 (fake_prefixed_keys
);
9120 raw_keybuf_count
= 0;
9122 last_nonmenu_event
= Qnil
;
9124 delayed_switch_frame
= Qnil
;
9129 echo_prompt (prompt
);
9130 else if (cursor_in_echo_area
9131 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9132 && NILP (Fzerop (Vecho_keystrokes
)))
9133 /* This doesn't put in a dash if the echo buffer is empty, so
9134 you don't always see a dash hanging out in the minibuffer. */
9138 /* Record the initial state of the echo area and this_command_keys;
9139 we will need to restore them if we replay a key sequence. */
9141 echo_start
= echo_length ();
9142 keys_start
= this_command_key_count
;
9143 this_single_command_key_start
= keys_start
;
9145 #if defined (GOBBLE_FIRST_EVENT)
9146 /* This doesn't quite work, because some of the things that read_char
9147 does cannot safely be bypassed. It seems too risky to try to make
9150 /* Read the first char of the sequence specially, before setting
9151 up any keymaps, in case a filter runs and switches buffers on us. */
9152 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9154 #endif /* GOBBLE_FIRST_EVENT */
9156 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9157 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9160 /* We jump here when we need to reinitialize fkey and keytran; this
9161 happens if we switch keyboards between rescans. */
9162 replay_entire_sequence
:
9164 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9165 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9166 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9167 indec
.start
= indec
.end
= 0;
9168 fkey
.start
= fkey
.end
= 0;
9169 keytran
.start
= keytran
.end
= 0;
9171 /* We jump here when the key sequence has been thoroughly changed, and
9172 we need to rescan it starting from the beginning. When we jump here,
9173 keybuf[0..mock_input] holds the sequence we should reread. */
9176 starting_buffer
= current_buffer
;
9177 first_unbound
= bufsize
+ 1;
9179 /* Build our list of keymaps.
9180 If we recognize a function key and replace its escape sequence in
9181 keybuf with its symbol, or if the sequence starts with a mouse
9182 click and we need to switch buffers, we jump back here to rebuild
9183 the initial keymaps from the current buffer. */
9186 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9188 if (2 > nmaps_allocated
)
9190 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9191 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9192 nmaps_allocated
= 2;
9194 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9196 else if (!NILP (Voverriding_local_map
))
9198 if (2 > nmaps_allocated
)
9200 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9201 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9202 nmaps_allocated
= 2;
9204 submaps
[nmaps
++] = Voverriding_local_map
;
9212 nminor
= current_minor_maps (0, &maps
);
9213 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9215 if (total
> nmaps_allocated
)
9217 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9218 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9219 nmaps_allocated
= total
;
9222 if (!NILP (orig_keymap
))
9223 submaps
[nmaps
++] = orig_keymap
;
9225 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9229 submaps
[nmaps
++] = orig_local_map
;
9231 submaps
[nmaps
++] = current_global_map
;
9233 /* Find an accurate initial value for first_binding. */
9234 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9235 if (! NILP (submaps
[first_binding
]))
9238 /* Start from the beginning in keybuf. */
9241 /* These are no-ops the first time through, but if we restart, they
9242 revert the echo area and this_command_keys to their original state. */
9243 this_command_key_count
= keys_start
;
9244 if (INTERACTIVE
&& t
< mock_input
)
9245 echo_truncate (echo_start
);
9247 /* If the best binding for the current key sequence is a keymap, or
9248 we may be looking at a function key's escape sequence, keep on
9250 while (first_binding
< nmaps
9251 /* Keep reading as long as there's a prefix binding. */
9252 ? !NILP (submaps
[first_binding
])
9253 /* Don't return in the middle of a possible function key sequence,
9254 if the only bindings we found were via case conversion.
9255 Thus, if ESC O a has a function-key-map translation
9256 and ESC o has a binding, don't return after ESC O,
9257 so that we can translate ESC O plus the next character. */
9258 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9261 int used_mouse_menu
= 0;
9263 /* Where the last real key started. If we need to throw away a
9264 key that has expanded into more than one element of keybuf
9265 (say, a mouse click on the mode line which is being treated
9266 as [mode-line (mouse-...)], then we backtrack to this point
9268 int last_real_key_start
;
9270 /* These variables are analogous to echo_start and keys_start;
9271 while those allow us to restart the entire key sequence,
9272 echo_local_start and keys_local_start allow us to throw away
9274 int echo_local_start
, keys_local_start
, local_first_binding
;
9276 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9277 eassert (indec
.start
<= indec
.end
);
9278 eassert (fkey
.start
<= fkey
.end
);
9279 eassert (keytran
.start
<= keytran
.end
);
9280 /* key-translation-map is applied *after* function-key-map
9281 which is itself applied *after* input-decode-map. */
9282 eassert (fkey
.end
<= indec
.start
);
9283 eassert (keytran
.end
<= fkey
.start
);
9285 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9286 first_unbound
< keytran
.start
)
9287 { /* The prefix upto first_unbound has no binding and has
9288 no translation left to do either, so we know it's unbound.
9289 If we don't stop now, we risk staying here indefinitely
9290 (if the user keeps entering fkey or keytran prefixes
9291 like C-c ESC ESC ESC ESC ...) */
9293 for (i
= first_unbound
+ 1; i
< t
; i
++)
9294 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9295 mock_input
= t
- first_unbound
- 1;
9296 indec
.end
= indec
.start
-= first_unbound
+ 1;
9297 indec
.map
= indec
.parent
;
9298 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9299 fkey
.map
= fkey
.parent
;
9300 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9301 keytran
.map
= keytran
.parent
;
9302 goto replay_sequence
;
9306 error ("Key sequence too long");
9309 echo_local_start
= echo_length ();
9310 keys_local_start
= this_command_key_count
;
9311 local_first_binding
= first_binding
;
9314 /* These are no-ops, unless we throw away a keystroke below and
9315 jumped back up to replay_key; in that case, these restore the
9316 variables to their original state, allowing us to replay the
9318 if (INTERACTIVE
&& t
< mock_input
)
9319 echo_truncate (echo_local_start
);
9320 this_command_key_count
= keys_local_start
;
9321 first_binding
= local_first_binding
;
9323 /* By default, assume each event is "real". */
9324 last_real_key_start
= t
;
9326 /* Does mock_input indicate that we are re-reading a key sequence? */
9330 add_command_key (key
);
9331 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9332 && NILP (Fzerop (Vecho_keystrokes
)))
9336 /* If not, we should actually read a character. */
9340 KBOARD
*interrupted_kboard
= current_kboard
;
9341 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9342 key
= read_char (NILP (prompt
), nmaps
,
9343 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9344 &used_mouse_menu
, NULL
);
9345 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9346 /* When switching to a new tty (with a new keyboard),
9347 read_char returns the new buffer, rather than -2
9348 (Bug#5095). This is because `terminal-init-xterm'
9349 calls read-char, which eats the wrong_kboard_jmpbuf
9350 return. Any better way to fix this? -- cyd */
9351 || (interrupted_kboard
!= current_kboard
))
9356 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9357 if (k
== interrupted_kboard
)
9362 /* Don't touch interrupted_kboard when it's been
9364 delayed_switch_frame
= Qnil
;
9365 goto replay_entire_sequence
;
9368 if (!NILP (delayed_switch_frame
))
9370 interrupted_kboard
->kbd_queue
9371 = Fcons (delayed_switch_frame
,
9372 interrupted_kboard
->kbd_queue
);
9373 delayed_switch_frame
= Qnil
;
9377 interrupted_kboard
->kbd_queue
9378 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9380 /* If the side queue is non-empty, ensure it begins with a
9381 switch-frame, so we'll replay it in the right context. */
9382 if (CONSP (interrupted_kboard
->kbd_queue
)
9383 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9384 !(EVENT_HAS_PARAMETERS (key
)
9385 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9389 XSETFRAME (frame
, interrupted_frame
);
9390 interrupted_kboard
->kbd_queue
9391 = Fcons (make_lispy_switch_frame (frame
),
9392 interrupted_kboard
->kbd_queue
);
9395 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9396 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9397 goto replay_entire_sequence
;
9401 /* read_char returns t when it shows a menu and the user rejects it.
9405 unbind_to (count
, Qnil
);
9410 /* read_char returns -1 at the end of a macro.
9411 Emacs 18 handles this by returning immediately with a
9412 zero, so that's what we'll do. */
9413 if (INTEGERP (key
) && XINT (key
) == -1)
9416 /* The Microsoft C compiler can't handle the goto that
9422 /* If the current buffer has been changed from under us, the
9423 keymap may have changed, so replay the sequence. */
9426 timer_resume_idle ();
9429 /* Reset the current buffer from the selected window
9430 in case something changed the former and not the latter.
9431 This is to be more consistent with the behavior
9432 of the command_loop_1. */
9433 if (fix_current_buffer
)
9435 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9437 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9438 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9441 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9442 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9443 goto replay_sequence
;
9446 /* If we have a quit that was typed in another frame, and
9447 quit_throw_to_read_char switched buffers,
9448 replay to get the right keymap. */
9450 && XINT (key
) == quit_char
9451 && current_buffer
!= starting_buffer
)
9454 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9458 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9459 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9460 goto replay_sequence
;
9465 if (EVENT_HAS_PARAMETERS (key
)
9466 /* Either a `switch-frame' or a `select-window' event. */
9467 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9469 /* If we're at the beginning of a key sequence, and the caller
9470 says it's okay, go ahead and return this event. If we're
9471 in the midst of a key sequence, delay it until the end. */
9472 if (t
> 0 || !can_return_switch_frame
)
9474 delayed_switch_frame
= key
;
9480 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9484 /* Clicks in non-text areas get prefixed by the symbol
9485 in their CHAR-ADDRESS field. For example, a click on
9486 the mode line is prefixed by the symbol `mode-line'.
9488 Furthermore, key sequences beginning with mouse clicks
9489 are read using the keymaps of the buffer clicked on, not
9490 the current buffer. So we may have to switch the buffer
9493 When we turn one event into two events, we must make sure
9494 that neither of the two looks like the original--so that,
9495 if we replay the events, they won't be expanded again.
9496 If not for this, such reexpansion could happen either here
9497 or when user programs play with this-command-keys. */
9498 if (EVENT_HAS_PARAMETERS (key
))
9503 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9504 if (EQ (kind
, Qmouse_click
))
9506 Lisp_Object window
, posn
;
9508 window
= POSN_WINDOW (EVENT_START (key
));
9509 posn
= POSN_POSN (EVENT_START (key
));
9512 || (!NILP (fake_prefixed_keys
)
9513 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9515 /* We're looking a second time at an event for which
9516 we generated a fake prefix key. Set
9517 last_real_key_start appropriately. */
9519 last_real_key_start
= t
- 1;
9522 /* Key sequences beginning with mouse clicks are
9523 read using the keymaps in the buffer clicked on,
9524 not the current buffer. If we're at the
9525 beginning of a key sequence, switch buffers. */
9526 if (last_real_key_start
== 0
9528 && BUFFERP (XWINDOW (window
)->buffer
)
9529 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9531 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9535 /* Arrange to go back to the original buffer once we're
9536 done reading the key sequence. Note that we can't
9537 use save_excursion_{save,restore} here, because they
9538 save point as well as the current buffer; we don't
9539 want to save point, because redisplay may change it,
9540 to accommodate a Fset_window_start or something. We
9541 don't want to do this at the top of the function,
9542 because we may get input from a subprocess which
9543 wants to change the selected window and stuff (say,
9545 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9547 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9549 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9550 orig_local_map
= get_local_map (PT
, current_buffer
,
9552 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9553 goto replay_sequence
;
9556 /* For a mouse click, get the local text-property keymap
9557 of the place clicked on, rather than point. */
9558 if (last_real_key_start
== 0
9559 && CONSP (XCDR (key
))
9560 && ! localized_local_map
)
9562 Lisp_Object map_here
, start
, pos
;
9564 localized_local_map
= 1;
9565 start
= EVENT_START (key
);
9567 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9569 pos
= POSN_BUFFER_POSN (start
);
9571 && XINT (pos
) >= BEGV
9572 && XINT (pos
) <= ZV
)
9574 map_here
= get_local_map (XINT (pos
),
9575 current_buffer
, Qlocal_map
);
9576 if (!EQ (map_here
, orig_local_map
))
9578 orig_local_map
= map_here
;
9579 ++localized_local_map
;
9582 map_here
= get_local_map (XINT (pos
),
9583 current_buffer
, Qkeymap
);
9584 if (!EQ (map_here
, orig_keymap
))
9586 orig_keymap
= map_here
;
9587 ++localized_local_map
;
9590 if (localized_local_map
> 1)
9595 goto replay_sequence
;
9601 /* Expand mode-line and scroll-bar events into two events:
9602 use posn as a fake prefix key. */
9604 && (NILP (fake_prefixed_keys
)
9605 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9607 if (t
+ 1 >= bufsize
)
9608 error ("Key sequence too long");
9611 keybuf
[t
+ 1] = key
;
9614 /* Record that a fake prefix key has been generated
9615 for KEY. Don't modify the event; this would
9616 prevent proper action when the event is pushed
9617 back into unread-command-events. */
9618 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9620 /* If on a mode line string with a local keymap,
9621 reconsider the key sequence with that keymap. */
9622 if (string
= POSN_STRING (EVENT_START (key
)),
9623 (CONSP (string
) && STRINGP (XCAR (string
))))
9625 Lisp_Object pos
, map
, map2
;
9627 pos
= XCDR (string
);
9628 string
= XCAR (string
);
9630 && XINT (pos
) < SCHARS (string
))
9632 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9634 orig_local_map
= map
;
9635 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9638 if (!NILP (map
) || !NILP (map2
))
9639 goto replay_sequence
;
9645 else if (NILP (from_string
)
9646 && (string
= POSN_STRING (EVENT_START (key
)),
9647 (CONSP (string
) && STRINGP (XCAR (string
)))))
9649 /* For a click on a string, i.e. overlay string or a
9650 string displayed via the `display' property,
9651 consider `local-map' and `keymap' properties of
9653 Lisp_Object pos
, map
, map2
;
9655 pos
= XCDR (string
);
9656 string
= XCAR (string
);
9658 && XINT (pos
) < SCHARS (string
))
9660 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9662 orig_local_map
= map
;
9663 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9667 if (!NILP (map
) || !NILP (map2
))
9669 from_string
= string
;
9672 goto replay_sequence
;
9677 else if (CONSP (XCDR (key
))
9678 && CONSP (EVENT_START (key
))
9679 && CONSP (XCDR (EVENT_START (key
))))
9683 posn
= POSN_POSN (EVENT_START (key
));
9684 /* Handle menu-bar events:
9685 insert the dummy prefix event `menu-bar'. */
9686 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9688 if (t
+ 1 >= bufsize
)
9689 error ("Key sequence too long");
9693 /* Zap the position in key, so we know that we've
9694 expanded it, and don't try to do so again. */
9695 POSN_SET_POSN (EVENT_START (key
),
9696 Fcons (posn
, Qnil
));
9699 goto replay_sequence
;
9701 else if (CONSP (posn
))
9703 /* We're looking at the second event of a
9704 sequence which we expanded before. Set
9705 last_real_key_start appropriately. */
9706 if (last_real_key_start
== t
&& t
> 0)
9707 last_real_key_start
= t
- 1;
9712 /* We have finally decided that KEY is something we might want
9714 first_binding
= (follow_key (key
,
9715 nmaps
- first_binding
,
9716 submaps
+ first_binding
,
9717 defs
+ first_binding
,
9718 submaps
+ first_binding
)
9721 /* If KEY wasn't bound, we'll try some fallbacks. */
9722 if (first_binding
< nmaps
)
9723 /* This is needed for the following scenario:
9724 event 0: a down-event that gets dropped by calling replay_key.
9725 event 1: some normal prefix like C-h.
9726 After event 0, first_unbound is 0, after event 1 indec.start,
9727 fkey.start, and keytran.start are all 1, so when we see that
9728 C-h is bound, we need to update first_unbound. */
9729 first_unbound
= max (t
+ 1, first_unbound
);
9734 /* Remember the position to put an upper bound on indec.start. */
9735 first_unbound
= min (t
, first_unbound
);
9737 head
= EVENT_HEAD (key
);
9738 if (help_char_p (head
) && t
> 0)
9740 read_key_sequence_cmd
= Vprefix_help_command
;
9742 last_nonmenu_event
= key
;
9743 /* The Microsoft C compiler can't handle the goto that
9751 Lisp_Object breakdown
;
9754 breakdown
= parse_modifiers (head
);
9755 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9756 /* Attempt to reduce an unbound mouse event to a simpler
9757 event that is bound:
9758 Drags reduce to clicks.
9759 Double-clicks reduce to clicks.
9760 Triple-clicks reduce to double-clicks, then to clicks.
9761 Down-clicks are eliminated.
9762 Double-downs reduce to downs, then are eliminated.
9763 Triple-downs reduce to double-downs, then to downs,
9764 then are eliminated. */
9765 if (modifiers
& (down_modifier
| drag_modifier
9766 | double_modifier
| triple_modifier
))
9768 while (modifiers
& (down_modifier
| drag_modifier
9769 | double_modifier
| triple_modifier
))
9771 Lisp_Object new_head
, new_click
;
9772 if (modifiers
& triple_modifier
)
9773 modifiers
^= (double_modifier
| triple_modifier
);
9774 else if (modifiers
& double_modifier
)
9775 modifiers
&= ~double_modifier
;
9776 else if (modifiers
& drag_modifier
)
9777 modifiers
&= ~drag_modifier
;
9780 /* Dispose of this `down' event by simply jumping
9781 back to replay_key, to get another event.
9783 Note that if this event came from mock input,
9784 then just jumping back to replay_key will just
9785 hand it to us again. So we have to wipe out any
9788 We could delete keybuf[t] and shift everything
9789 after that to the left by one spot, but we'd also
9790 have to fix up any variable that points into
9791 keybuf, and shifting isn't really necessary
9794 Adding prefixes for non-textual mouse clicks
9795 creates two characters of mock input, and both
9796 must be thrown away. If we're only looking at
9797 the prefix now, we can just jump back to
9798 replay_key. On the other hand, if we've already
9799 processed the prefix, and now the actual click
9800 itself is giving us trouble, then we've lost the
9801 state of the keymaps we want to backtrack to, and
9802 we need to replay the whole sequence to rebuild
9805 Beyond that, only function key expansion could
9806 create more than two keys, but that should never
9807 generate mouse events, so it's okay to zero
9808 mock_input in that case too.
9810 FIXME: The above paragraph seems just plain
9811 wrong, if you consider things like
9812 xterm-mouse-mode. -stef
9814 Isn't this just the most wonderful code ever? */
9816 /* If mock_input > t + 1, the above simplification
9817 will actually end up dropping keys on the floor.
9818 This is probably OK for now, but even
9819 if mock_input <= t + 1, we need to adjust indec,
9821 Typical case [header-line down-mouse-N]:
9822 mock_input = 2, t = 1, fkey.end = 1,
9823 last_real_key_start = 0. */
9824 if (indec
.end
> last_real_key_start
)
9826 indec
.end
= indec
.start
9827 = min (last_real_key_start
, indec
.start
);
9828 indec
.map
= indec
.parent
;
9829 if (fkey
.end
> last_real_key_start
)
9831 fkey
.end
= fkey
.start
9832 = min (last_real_key_start
, fkey
.start
);
9833 fkey
.map
= fkey
.parent
;
9834 if (keytran
.end
> last_real_key_start
)
9836 keytran
.end
= keytran
.start
9837 = min (last_real_key_start
, keytran
.start
);
9838 keytran
.map
= keytran
.parent
;
9842 if (t
== last_real_key_start
)
9849 mock_input
= last_real_key_start
;
9850 goto replay_sequence
;
9855 = apply_modifiers (modifiers
, XCAR (breakdown
));
9857 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9859 /* Look for a binding for this new key. follow_key
9860 promises that it didn't munge submaps the
9861 last time we called it, since key was unbound. */
9863 = (follow_key (new_click
,
9864 nmaps
- local_first_binding
,
9865 submaps
+ local_first_binding
,
9866 defs
+ local_first_binding
,
9867 submaps
+ local_first_binding
)
9868 + local_first_binding
);
9870 /* If that click is bound, go for it. */
9871 if (first_binding
< nmaps
)
9876 /* Otherwise, we'll leave key set to the drag event. */
9883 /* Normally, last_nonmenu_event gets the previous key we read.
9884 But when a mouse popup menu is being used,
9885 we don't update last_nonmenu_event; it continues to hold the mouse
9886 event that preceded the first level of menu. */
9887 if (!used_mouse_menu
)
9888 last_nonmenu_event
= key
;
9890 /* Record what part of this_command_keys is the current key sequence. */
9891 this_single_command_key_start
= this_command_key_count
- t
;
9893 /* Look for this sequence in input-decode-map.
9894 Scan from indec.end until we find a bound suffix. */
9895 while (indec
.end
< t
)
9897 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9900 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9901 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9906 mock_input
= diff
+ max (t
, mock_input
);
9907 goto replay_sequence
;
9911 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9912 && indec
.start
>= t
)
9913 /* There is a binding and it's not a prefix.
9914 (and it doesn't have any input-decode-map translation pending).
9915 There is thus no function-key in this sequence.
9916 Moving fkey.start is important in this case to allow keytran.start
9917 to go over the sequence before we return (since we keep the
9918 invariant that keytran.end <= fkey.start). */
9921 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9924 /* If the sequence is unbound, see if we can hang a function key
9925 off the end of it. */
9926 /* Continue scan from fkey.end until we find a bound suffix. */
9927 while (fkey
.end
< indec
.start
)
9929 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9932 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9933 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9934 max (t
, mock_input
),
9935 /* If there's a binding (i.e.
9936 first_binding >= nmaps) we don't want
9937 to apply this function-key-mapping. */
9938 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9943 mock_input
= diff
+ max (t
, mock_input
);
9944 /* Adjust the input-decode-map counters. */
9946 indec
.start
+= diff
;
9948 goto replay_sequence
;
9952 /* Look for this sequence in key-translation-map.
9953 Scan from keytran.end until we find a bound suffix. */
9954 while (keytran
.end
< fkey
.start
)
9956 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9959 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9960 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9965 mock_input
= diff
+ max (t
, mock_input
);
9966 /* Adjust the function-key-map and input-decode-map counters. */
9968 indec
.start
+= diff
;
9972 goto replay_sequence
;
9976 /* If KEY is not defined in any of the keymaps,
9977 and cannot be part of a function key or translation,
9978 and is an upper case letter
9979 use the corresponding lower-case letter instead. */
9980 if (first_binding
>= nmaps
9981 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9983 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9984 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9985 || (XINT (key
) & shift_modifier
)))
9987 Lisp_Object new_key
;
9989 original_uppercase
= key
;
9990 original_uppercase_position
= t
- 1;
9992 if (XINT (key
) & shift_modifier
)
9993 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9995 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9996 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9998 /* We have to do this unconditionally, regardless of whether
9999 the lower-case char is defined in the keymaps, because they
10000 might get translated through function-key-map. */
10001 keybuf
[t
- 1] = new_key
;
10002 mock_input
= max (t
, mock_input
);
10003 shift_translated
= 1;
10005 goto replay_sequence
;
10007 /* If KEY is not defined in any of the keymaps,
10008 and cannot be part of a function key or translation,
10009 and is a shifted function key,
10010 use the corresponding unshifted function key instead. */
10011 if (first_binding
>= nmaps
10012 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10014 Lisp_Object breakdown
= parse_modifiers (key
);
10016 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10018 if (modifiers
& shift_modifier
10019 /* Treat uppercase keys as shifted. */
10021 && (KEY_TO_CHAR (key
)
10022 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10023 && UPPERCASEP (KEY_TO_CHAR (key
))))
10025 Lisp_Object new_key
10026 = (modifiers
& shift_modifier
10027 ? apply_modifiers (modifiers
& ~shift_modifier
,
10029 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10031 original_uppercase
= key
;
10032 original_uppercase_position
= t
- 1;
10034 /* We have to do this unconditionally, regardless of whether
10035 the lower-case char is defined in the keymaps, because they
10036 might get translated through function-key-map. */
10037 keybuf
[t
- 1] = new_key
;
10038 mock_input
= max (t
, mock_input
);
10039 /* Reset fkey (and consequently keytran) to apply
10040 function-key-map on the result, so that S-backspace is
10041 correctly mapped to DEL (via backspace). OTOH,
10042 input-decode-map doesn't need to go through it again. */
10043 fkey
.start
= fkey
.end
= 0;
10044 keytran
.start
= keytran
.end
= 0;
10045 shift_translated
= 1;
10047 goto replay_sequence
;
10052 read_key_sequence_cmd
= (first_binding
< nmaps
10053 ? defs
[first_binding
]
10056 unread_switch_frame
= delayed_switch_frame
;
10057 unbind_to (count
, Qnil
);
10059 /* Don't downcase the last character if the caller says don't.
10060 Don't downcase it if the result is undefined, either. */
10061 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10063 && t
- 1 == original_uppercase_position
)
10065 keybuf
[t
- 1] = original_uppercase
;
10066 shift_translated
= 0;
10069 if (shift_translated
)
10070 Vthis_command_keys_shift_translated
= Qt
;
10072 /* Occasionally we fabricate events, perhaps by expanding something
10073 according to function-key-map, or by adding a prefix symbol to a
10074 mouse click in the scroll bar or modeline. In this cases, return
10075 the entire generated key sequence, even if we hit an unbound
10076 prefix or a definition before the end. This means that you will
10077 be able to push back the event properly, and also means that
10078 read-key-sequence will always return a logical unit.
10081 for (; t
< mock_input
; t
++)
10083 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10084 && NILP (Fzerop (Vecho_keystrokes
)))
10085 echo_char (keybuf
[t
]);
10086 add_command_key (keybuf
[t
]);
10093 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10094 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10095 The sequence is sufficient to specify a non-prefix command in the
10096 current local and global maps.
10098 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10099 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10100 as a continuation of the previous key.
10102 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10103 convert the last event to lower case. (Normally any upper case event
10104 is converted to lower case if the original event is undefined and the lower
10105 case equivalent is defined.) A non-nil value is appropriate for reading
10106 a key sequence to be defined.
10108 A C-g typed while in this function is treated like any other character,
10109 and `quit-flag' is not set.
10111 If the key sequence starts with a mouse click, then the sequence is read
10112 using the keymaps of the buffer of the window clicked in, not the buffer
10113 of the selected window as normal.
10115 `read-key-sequence' drops unbound button-down events, since you normally
10116 only care about the click or drag events which follow them. If a drag
10117 or multi-click event is unbound, but the corresponding click event would
10118 be bound, `read-key-sequence' turns the event into a click event at the
10119 drag's starting position. This means that you don't have to distinguish
10120 between click and drag, double, or triple events unless you want to.
10122 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10123 lines separating windows, and scroll bars with imaginary keys
10124 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10126 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10127 function will process a switch-frame event if the user switches frames
10128 before typing anything. If the user switches frames in the middle of a
10129 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10130 is nil, then the event will be put off until after the current key sequence.
10132 `read-key-sequence' checks `function-key-map' for function key
10133 sequences, where they wouldn't conflict with ordinary bindings. See
10134 `function-key-map' for more details.
10136 The optional fifth argument COMMAND-LOOP, if non-nil, means
10137 that this key sequence is being read by something that will
10138 read commands one after another. It should be nil if the caller
10139 will read just one key sequence. */)
10140 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10142 Lisp_Object keybuf
[30];
10144 struct gcpro gcpro1
;
10145 int count
= SPECPDL_INDEX ();
10147 if (!NILP (prompt
))
10148 CHECK_STRING (prompt
);
10151 specbind (Qinput_method_exit_on_first_char
,
10152 (NILP (command_loop
) ? Qt
: Qnil
));
10153 specbind (Qinput_method_use_echo_area
,
10154 (NILP (command_loop
) ? Qt
: Qnil
));
10156 memset (keybuf
, 0, sizeof keybuf
);
10157 GCPRO1 (keybuf
[0]);
10158 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10160 if (NILP (continue_echo
))
10162 this_command_key_count
= 0;
10163 this_command_key_count_reset
= 0;
10164 this_single_command_key_start
= 0;
10167 #ifdef HAVE_WINDOW_SYSTEM
10168 if (display_hourglass_p
)
10169 cancel_hourglass ();
10172 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10173 prompt
, ! NILP (dont_downcase_last
),
10174 ! NILP (can_return_switch_frame
), 0);
10176 #if 0 /* The following is fine for code reading a key sequence and
10177 then proceeding with a lenghty computation, but it's not good
10178 for code reading keys in a loop, like an input method. */
10179 #ifdef HAVE_WINDOW_SYSTEM
10180 if (display_hourglass_p
)
10181 start_hourglass ();
10191 return unbind_to (count
, make_event_array (i
, keybuf
));
10194 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10195 Sread_key_sequence_vector
, 1, 5, 0,
10196 doc
: /* Like `read-key-sequence' but always return a vector. */)
10197 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object command_loop
)
10199 Lisp_Object keybuf
[30];
10201 struct gcpro gcpro1
;
10202 int count
= SPECPDL_INDEX ();
10204 if (!NILP (prompt
))
10205 CHECK_STRING (prompt
);
10208 specbind (Qinput_method_exit_on_first_char
,
10209 (NILP (command_loop
) ? Qt
: Qnil
));
10210 specbind (Qinput_method_use_echo_area
,
10211 (NILP (command_loop
) ? Qt
: Qnil
));
10213 memset (keybuf
, 0, sizeof keybuf
);
10214 GCPRO1 (keybuf
[0]);
10215 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10217 if (NILP (continue_echo
))
10219 this_command_key_count
= 0;
10220 this_command_key_count_reset
= 0;
10221 this_single_command_key_start
= 0;
10224 #ifdef HAVE_WINDOW_SYSTEM
10225 if (display_hourglass_p
)
10226 cancel_hourglass ();
10229 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10230 prompt
, ! NILP (dont_downcase_last
),
10231 ! NILP (can_return_switch_frame
), 0);
10233 #ifdef HAVE_WINDOW_SYSTEM
10234 if (display_hourglass_p
)
10235 start_hourglass ();
10244 return unbind_to (count
, Fvector (i
, keybuf
));
10247 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10248 doc
: /* Execute CMD as an editor command.
10249 CMD must be a symbol that satisfies the `commandp' predicate.
10250 Optional second arg RECORD-FLAG non-nil
10251 means unconditionally put this command in `command-history'.
10252 Otherwise, that is done only if an arg is read using the minibuffer.
10253 The argument KEYS specifies the value to use instead of (this-command-keys)
10254 when reading the arguments; if it is nil, (this-command-keys) is used.
10255 The argument SPECIAL, if non-nil, means that this command is executing
10256 a special event, so ignore the prefix argument and don't clear it. */)
10257 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10259 register Lisp_Object final
;
10260 register Lisp_Object tem
;
10261 Lisp_Object prefixarg
;
10263 debug_on_next_call
= 0;
10265 if (NILP (special
))
10267 prefixarg
= current_kboard
->Vprefix_arg
;
10268 Vcurrent_prefix_arg
= prefixarg
;
10269 current_kboard
->Vprefix_arg
= Qnil
;
10276 tem
= Fget (cmd
, Qdisabled
);
10277 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10279 tem
= Fsymbol_value (Qdisabled_command_function
);
10281 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10287 final
= Findirect_function (cmd
, Qnil
);
10289 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10291 struct gcpro gcpro1
, gcpro2
;
10293 GCPRO2 (cmd
, prefixarg
);
10294 do_autoload (final
, cmd
);
10301 if (STRINGP (final
) || VECTORP (final
))
10303 /* If requested, place the macro in the command history. For
10304 other sorts of commands, call-interactively takes care of
10306 if (!NILP (record_flag
))
10309 = Fcons (Fcons (Qexecute_kbd_macro
,
10310 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10313 /* Don't keep command history around forever. */
10314 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10316 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10318 XSETCDR (tem
, Qnil
);
10322 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10325 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10326 /* Don't call Fcall_interactively directly because we want to make
10327 sure the backtrace has an entry for `call-interactively'.
10328 For the same reason, pass `cmd' rather than `final'. */
10329 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10336 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10338 doc
: /* Read function name, then read its arguments and call it.
10340 To pass a numeric argument to the command you are invoking with, specify
10341 the numeric argument to this command.
10343 Noninteractively, the argument PREFIXARG is the prefix argument to
10344 give to the command you invoke, if it asks for an argument. */)
10345 (Lisp_Object prefixarg
)
10347 Lisp_Object function
;
10348 int saved_last_point_position
;
10349 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
10350 Lisp_Object bindings
, value
;
10351 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10352 #ifdef HAVE_WINDOW_SYSTEM
10353 /* The call to Fcompleting_read will start and cancel the hourglass,
10354 but if the hourglass was already scheduled, this means that no
10355 hourglass will be shown for the actual M-x command itself.
10356 So we restart it if it is already scheduled. Note that checking
10357 hourglass_shown_p is not enough, normally the hourglass is not shown,
10358 just scheduled to be shown. */
10359 int hstarted
= hourglass_started ();
10362 saved_keys
= Fvector (this_command_key_count
,
10363 XVECTOR (this_command_keys
)->contents
);
10364 saved_last_point_position_buffer
= last_point_position_buffer
;
10365 saved_last_point_position
= last_point_position
;
10366 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10368 function
= call0 (intern ("read-extended-command"));
10370 #ifdef HAVE_WINDOW_SYSTEM
10371 if (hstarted
) start_hourglass ();
10374 if (STRINGP (function
) && SCHARS (function
) == 0)
10375 error ("No command name given");
10377 /* Set this_command_keys to the concatenation of saved_keys and
10378 function, followed by a RET. */
10383 this_command_key_count
= 0;
10384 this_command_key_count_reset
= 0;
10385 this_single_command_key_start
= 0;
10387 keys
= XVECTOR (saved_keys
)->contents
;
10388 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10389 add_command_key (keys
[i
]);
10391 for (i
= 0; i
< SCHARS (function
); i
++)
10392 add_command_key (Faref (function
, make_number (i
)));
10394 add_command_key (make_number ('\015'));
10397 last_point_position
= saved_last_point_position
;
10398 last_point_position_buffer
= saved_last_point_position_buffer
;
10402 function
= Fintern (function
, Qnil
);
10403 current_kboard
->Vprefix_arg
= prefixarg
;
10404 Vthis_command
= function
;
10405 real_this_command
= function
;
10407 /* If enabled, show which key runs this command. */
10408 if (!NILP (Vsuggest_key_bindings
)
10409 && NILP (Vexecuting_kbd_macro
)
10410 && SYMBOLP (function
))
10411 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10417 GCPRO3 (bindings
, value
, function
);
10418 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10420 /* If the command has a key binding, print it now. */
10421 if (!NILP (bindings
)
10422 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10425 /* But first wait, and skip the message if there is input. */
10426 Lisp_Object waited
;
10428 /* If this command displayed something in the echo area;
10429 wait a few seconds, then display our suggestion message. */
10430 if (NILP (echo_area_buffer
[0]))
10431 waited
= sit_for (make_number (0), 0, 2);
10432 else if (NUMBERP (Vsuggest_key_bindings
))
10433 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10435 waited
= sit_for (make_number (2), 0, 2);
10437 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10439 Lisp_Object binding
;
10441 int message_p
= push_message ();
10442 int count
= SPECPDL_INDEX ();
10444 record_unwind_protect (pop_message_unwind
, Qnil
);
10445 binding
= Fkey_description (bindings
, Qnil
);
10448 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10451 sprintf (newmessage
, "You can run the command `%s' with %s",
10452 SDATA (SYMBOL_NAME (function
)),
10454 message2_nolog (newmessage
,
10455 strlen (newmessage
),
10456 STRING_MULTIBYTE (binding
));
10457 if (NUMBERP (Vsuggest_key_bindings
))
10458 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10460 waited
= sit_for (make_number (2), 0, 2);
10462 if (!NILP (waited
) && message_p
)
10463 restore_message ();
10465 unbind_to (count
, Qnil
);
10469 RETURN_UNGCPRO (value
);
10473 /* Return nonzero if input events are pending. */
10476 detect_input_pending (void)
10478 if (!input_pending
)
10479 get_input_pending (&input_pending
, 0);
10481 return input_pending
;
10484 /* Return nonzero if input events other than mouse movements are
10488 detect_input_pending_ignore_squeezables (void)
10490 if (!input_pending
)
10491 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10493 return input_pending
;
10496 /* Return nonzero if input events are pending, and run any pending timers. */
10499 detect_input_pending_run_timers (int do_display
)
10501 int old_timers_run
= timers_run
;
10503 if (!input_pending
)
10504 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10506 if (old_timers_run
!= timers_run
&& do_display
)
10508 redisplay_preserve_echo_area (8);
10509 /* The following fixes a bug when using lazy-lock with
10510 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10511 from an idle timer function. The symptom of the bug is that
10512 the cursor sometimes doesn't become visible until the next X
10513 event is processed. --gerd. */
10515 Lisp_Object tail
, frame
;
10516 FOR_EACH_FRAME (tail
, frame
)
10517 if (FRAME_RIF (XFRAME (frame
)))
10518 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10522 return input_pending
;
10525 /* This is called in some cases before a possible quit.
10526 It cases the next call to detect_input_pending to recompute input_pending.
10527 So calling this function unnecessarily can't do any harm. */
10530 clear_input_pending (void)
10535 /* Return nonzero if there are pending requeued events.
10536 This isn't used yet. The hope is to make wait_reading_process_output
10537 call it, and return if it runs Lisp code that unreads something.
10538 The problem is, kbd_buffer_get_event needs to be fixed to know what
10539 to do in that case. It isn't trivial. */
10542 requeued_events_pending_p (void)
10544 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10548 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10549 doc
: /* Return t if command input is currently available with no wait.
10550 Actually, the value is nil only if we can be sure that no input is available;
10551 if there is a doubt, the value is t. */)
10554 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10555 || !NILP (Vunread_post_input_method_events
)
10556 || !NILP (Vunread_input_method_events
))
10559 get_input_pending (&input_pending
,
10560 READABLE_EVENTS_DO_TIMERS_NOW
10561 | READABLE_EVENTS_FILTER_EVENTS
);
10562 return input_pending
> 0 ? Qt
: Qnil
;
10565 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10566 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10569 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10572 if (total_keys
< NUM_RECENT_KEYS
)
10573 return Fvector (total_keys
, keys
);
10576 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10577 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10578 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10579 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10580 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10585 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10586 doc
: /* Return the key sequence that invoked this command.
10587 However, if the command has called `read-key-sequence', it returns
10588 the last key sequence that has been read.
10589 The value is a string or a vector.
10591 See also `this-command-keys-vector'. */)
10594 return make_event_array (this_command_key_count
,
10595 XVECTOR (this_command_keys
)->contents
);
10598 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10599 doc
: /* Return the key sequence that invoked this command, as a vector.
10600 However, if the command has called `read-key-sequence', it returns
10601 the last key sequence that has been read.
10603 See also `this-command-keys'. */)
10606 return Fvector (this_command_key_count
,
10607 XVECTOR (this_command_keys
)->contents
);
10610 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10611 Sthis_single_command_keys
, 0, 0, 0,
10612 doc
: /* Return the key sequence that invoked this command.
10613 More generally, it returns the last key sequence read, either by
10614 the command loop or by `read-key-sequence'.
10615 Unlike `this-command-keys', this function's value
10616 does not include prefix arguments.
10617 The value is always a vector. */)
10620 return Fvector (this_command_key_count
10621 - this_single_command_key_start
,
10622 (XVECTOR (this_command_keys
)->contents
10623 + this_single_command_key_start
));
10626 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10627 Sthis_single_command_raw_keys
, 0, 0, 0,
10628 doc
: /* Return the raw events that were read for this command.
10629 More generally, it returns the last key sequence read, either by
10630 the command loop or by `read-key-sequence'.
10631 Unlike `this-single-command-keys', this function's value
10632 shows the events before all translations (except for input methods).
10633 The value is always a vector. */)
10636 return Fvector (raw_keybuf_count
,
10637 (XVECTOR (raw_keybuf
)->contents
));
10640 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10641 Sreset_this_command_lengths
, 0, 0, 0,
10642 doc
: /* Make the unread events replace the last command and echo.
10643 Used in `universal-argument-other-key'.
10645 `universal-argument-other-key' rereads the event just typed.
10646 It then gets translated through `function-key-map'.
10647 The translated event has to replace the real events,
10648 both in the value of (this-command-keys) and in echoing.
10649 To achieve this, `universal-argument-other-key' calls
10650 `reset-this-command-lengths', which discards the record of reading
10651 these events the first time. */)
10654 this_command_key_count
= before_command_key_count
;
10655 if (this_command_key_count
< this_single_command_key_start
)
10656 this_single_command_key_start
= this_command_key_count
;
10658 echo_truncate (before_command_echo_length
);
10660 /* Cause whatever we put into unread-command-events
10661 to echo as if it were being freshly read from the keyboard. */
10662 this_command_key_count_reset
= 1;
10667 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10668 Sclear_this_command_keys
, 0, 1, 0,
10669 doc
: /* Clear out the vector that `this-command-keys' returns.
10670 Also clear the record of the last 100 events, unless optional arg
10671 KEEP-RECORD is non-nil. */)
10672 (Lisp_Object keep_record
)
10676 this_command_key_count
= 0;
10677 this_command_key_count_reset
= 0;
10679 if (NILP (keep_record
))
10681 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10682 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10684 recent_keys_index
= 0;
10689 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10690 doc
: /* Return the current depth in recursive edits. */)
10694 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10698 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10699 "FOpen dribble file: ",
10700 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10701 If FILE is nil, close any open dribble file. */)
10713 file
= Fexpand_file_name (file
, Qnil
);
10714 dribble
= fopen (SDATA (file
), "w");
10716 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10721 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10722 doc
: /* Discard the contents of the terminal input buffer.
10723 Also end any kbd macro being defined. */)
10726 if (!NILP (current_kboard
->defining_kbd_macro
))
10728 /* Discard the last command from the macro. */
10729 Fcancel_kbd_macro_events ();
10733 update_mode_lines
++;
10735 Vunread_command_events
= Qnil
;
10736 unread_command_char
= -1;
10738 discard_tty_input ();
10740 kbd_fetch_ptr
= kbd_store_ptr
;
10746 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10747 doc
: /* Stop Emacs and return to superior process. You can resume later.
10748 If `cannot-suspend' is non-nil, or if the system doesn't support job
10749 control, run a subshell instead.
10751 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10752 to be read as terminal input by Emacs's parent, after suspension.
10754 Before suspending, run the normal hook `suspend-hook'.
10755 After resumption run the normal hook `suspend-resume-hook'.
10757 Some operating systems cannot stop the Emacs process and resume it later.
10758 On such systems, Emacs starts a subshell instead of suspending. */)
10759 (Lisp_Object stuffstring
)
10761 int count
= SPECPDL_INDEX ();
10762 int old_height
, old_width
;
10764 struct gcpro gcpro1
;
10766 if (tty_list
&& tty_list
->next
)
10767 error ("There are other tty frames open; close them before suspending Emacs");
10769 if (!NILP (stuffstring
))
10770 CHECK_STRING (stuffstring
);
10772 /* Run the functions in suspend-hook. */
10773 if (!NILP (Vrun_hooks
))
10774 call1 (Vrun_hooks
, intern ("suspend-hook"));
10776 GCPRO1 (stuffstring
);
10777 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10778 reset_all_sys_modes ();
10779 /* sys_suspend can get an error if it tries to fork a subshell
10780 and the system resources aren't available for that. */
10781 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10783 stuff_buffered_input (stuffstring
);
10784 if (cannot_suspend
)
10788 unbind_to (count
, Qnil
);
10790 /* Check if terminal/window size has changed.
10791 Note that this is not useful when we are running directly
10792 with a window system; but suspend should be disabled in that case. */
10793 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10794 if (width
!= old_width
|| height
!= old_height
)
10795 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10797 /* Run suspend-resume-hook. */
10798 if (!NILP (Vrun_hooks
))
10799 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10805 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10806 Then in any case stuff anything Emacs has read ahead and not used. */
10809 stuff_buffered_input (Lisp_Object stuffstring
)
10811 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10812 register unsigned char *p
;
10814 if (STRINGP (stuffstring
))
10816 register int count
;
10818 p
= SDATA (stuffstring
);
10819 count
= SBYTES (stuffstring
);
10820 while (count
-- > 0)
10825 /* Anything we have read ahead, put back for the shell to read. */
10826 /* ?? What should this do when we have multiple keyboards??
10827 Should we ignore anything that was typed in at the "wrong" kboard?
10829 rms: we should stuff everything back into the kboard
10831 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10834 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10835 kbd_fetch_ptr
= kbd_buffer
;
10836 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10837 stuff_char (kbd_fetch_ptr
->code
);
10839 clear_event (kbd_fetch_ptr
);
10843 #endif /* SIGTSTP */
10847 set_waiting_for_input (struct timeval
*time_to_clear
)
10849 input_available_clear_time
= time_to_clear
;
10851 /* Tell handle_interrupt to throw back to read_char, */
10852 waiting_for_input
= 1;
10854 /* If handle_interrupt was called before and buffered a C-g,
10855 make it run again now, to avoid timing error. */
10856 if (!NILP (Vquit_flag
))
10857 quit_throw_to_read_char ();
10861 clear_waiting_for_input (void)
10863 /* Tell handle_interrupt not to throw back to read_char, */
10864 waiting_for_input
= 0;
10865 input_available_clear_time
= 0;
10868 /* The SIGINT handler.
10870 If we have a frame on the controlling tty, we assume that the
10871 SIGINT was generated by C-g, so we call handle_interrupt.
10872 Otherwise, the handler kills Emacs. */
10875 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10876 /* compilers complain in signal calls. */
10878 /* Must preserve main program's value of errno. */
10879 int old_errno
= errno
;
10880 struct terminal
*terminal
;
10882 SIGNAL_THREAD_CHECK (signalnum
);
10884 /* See if we have an active terminal on our controlling tty. */
10885 terminal
= get_named_tty ("/dev/tty");
10888 /* If there are no frames there, let's pretend that we are a
10889 well-behaving UN*X program and quit. */
10890 Fkill_emacs (Qnil
);
10894 /* Otherwise, the SIGINT was probably generated by C-g. */
10896 /* Set internal_last_event_frame to the top frame of the
10897 controlling tty, if we have a frame there. We disable the
10898 interrupt key on secondary ttys, so the SIGINT must have come
10899 from the controlling tty. */
10900 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10902 handle_interrupt ();
10908 /* This routine is called at interrupt level in response to C-g.
10910 It is called from the SIGINT handler or kbd_buffer_store_event.
10912 If `waiting_for_input' is non zero, then unless `echoing' is
10913 nonzero, immediately throw back to read_char.
10915 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10916 eval to throw, when it gets a chance. If quit-flag is already
10917 non-nil, it stops the job right away. */
10920 handle_interrupt (void)
10926 /* XXX This code needs to be revised for multi-tty support. */
10927 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10929 /* If SIGINT isn't blocked, don't let us be interrupted by
10930 another SIGINT, it might be harmful due to non-reentrancy
10931 in I/O functions. */
10932 sigblock (sigmask (SIGINT
));
10935 reset_all_sys_modes ();
10937 #ifdef SIGTSTP /* Support possible in later USG versions */
10939 * On systems which can suspend the current process and return to the original
10940 * shell, this command causes the user to end up back at the shell.
10941 * The "Auto-save" and "Abort" questions are not asked until
10942 * the user elects to return to emacs, at which point he can save the current
10943 * job and either dump core or continue.
10947 /* Perhaps should really fork an inferior shell?
10948 But that would not provide any way to get back
10949 to the original shell, ever. */
10950 printf ("No support for stopping a process on this operating system;\n");
10951 printf ("you can continue or abort.\n");
10952 #endif /* not SIGTSTP */
10954 /* We must remain inside the screen area when the internal terminal
10955 is used. Note that [Enter] is not echoed by dos. */
10956 cursor_to (SELECTED_FRAME (), 0, 0);
10958 /* It doesn't work to autosave while GC is in progress;
10959 the code used for auto-saving doesn't cope with the mark bit. */
10960 if (!gc_in_progress
)
10962 printf ("Auto-save? (y or n) ");
10964 if (((c
= getchar ()) & ~040) == 'Y')
10966 Fdo_auto_save (Qt
, Qnil
);
10968 printf ("\r\nAuto-save done");
10969 #else /* not MSDOS */
10970 printf ("Auto-save done\n");
10971 #endif /* not MSDOS */
10973 while (c
!= '\n') c
= getchar ();
10977 /* During GC, it must be safe to reenable quitting again. */
10978 Vinhibit_quit
= Qnil
;
10981 #endif /* not MSDOS */
10982 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10983 printf ("but will instead do a real quit after garbage collection ends\r\n");
10988 printf ("\r\nAbort? (y or n) ");
10989 #else /* not MSDOS */
10990 printf ("Abort (and dump core)? (y or n) ");
10991 #endif /* not MSDOS */
10993 if (((c
= getchar ()) & ~040) == 'Y')
10995 while (c
!= '\n') c
= getchar ();
10997 printf ("\r\nContinuing...\r\n");
10998 #else /* not MSDOS */
10999 printf ("Continuing...\n");
11000 #endif /* not MSDOS */
11002 init_all_sys_modes ();
11007 /* If executing a function that wants to be interrupted out of
11008 and the user has not deferred quitting by binding `inhibit-quit'
11009 then quit right away. */
11010 if (immediate_quit
&& NILP (Vinhibit_quit
))
11012 struct gl_state_s saved
;
11013 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11015 immediate_quit
= 0;
11018 GCPRO4 (saved
.object
, saved
.global_code
,
11019 saved
.current_syntax_table
, saved
.old_prop
);
11020 Fsignal (Qquit
, Qnil
);
11021 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11026 /* Else request quit when it's safe */
11030 /* TODO: The longjmp in this call throws the NS event loop integration off,
11031 and it seems to do fine without this. Probably some attention
11032 needs to be paid to the setting of waiting_for_input in
11033 wait_reading_process_output() under HAVE_NS because of the call
11034 to ns_select there (needed because otherwise events aren't picked up
11035 outside of polling since we don't get SIGIO like X and we don't have a
11036 separate event loop thread like W32. */
11038 if (waiting_for_input
&& !echoing
)
11039 quit_throw_to_read_char ();
11043 /* Handle a C-g by making read_char return C-g. */
11046 quit_throw_to_read_char (void)
11049 /* Prevent another signal from doing this before we finish. */
11050 clear_waiting_for_input ();
11053 Vunread_command_events
= Qnil
;
11054 unread_command_char
= -1;
11056 #if 0 /* Currently, sit_for is called from read_char without turning
11057 off polling. And that can call set_waiting_for_input.
11058 It seems to be harmless. */
11059 #ifdef POLL_FOR_INPUT
11060 /* May be > 1 if in recursive minibuffer. */
11061 if (poll_suppress_count
== 0)
11065 if (FRAMEP (internal_last_event_frame
)
11066 && !EQ (internal_last_event_frame
, selected_frame
))
11067 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11070 _longjmp (getcjmp
, 1);
11073 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11074 doc
: /* Set interrupt mode of reading keyboard input.
11075 If INTERRUPT is non-nil, Emacs will use input interrupts;
11076 otherwise Emacs uses CBREAK mode.
11078 See also `current-input-mode'. */)
11079 (Lisp_Object interrupt
)
11081 int new_interrupt_input
;
11083 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11084 #ifdef HAVE_X_WINDOWS
11085 if (x_display_list
!= NULL
)
11087 /* When using X, don't give the user a real choice,
11088 because we haven't implemented the mechanisms to support it. */
11089 new_interrupt_input
= 1;
11092 #endif /* HAVE_X_WINDOWS */
11093 new_interrupt_input
= !NILP (interrupt
);
11094 #else /* not SIGIO */
11095 new_interrupt_input
= 0;
11096 #endif /* not SIGIO */
11098 if (new_interrupt_input
!= interrupt_input
)
11100 #ifdef POLL_FOR_INPUT
11104 /* this causes startup screen to be restored and messes with the mouse */
11105 reset_all_sys_modes ();
11107 interrupt_input
= new_interrupt_input
;
11109 init_all_sys_modes ();
11112 #ifdef POLL_FOR_INPUT
11113 poll_suppress_count
= 1;
11120 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11121 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11122 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11123 C-q in key sequences.
11125 This setting only has an effect on tty terminals and only when
11126 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11128 See also `current-input-mode'. */)
11129 (Lisp_Object flow
, Lisp_Object terminal
)
11131 struct terminal
*t
= get_terminal (terminal
, 1);
11132 struct tty_display_info
*tty
;
11133 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11135 tty
= t
->display_info
.tty
;
11137 if (tty
->flow_control
!= !NILP (flow
))
11140 /* this causes startup screen to be restored and messes with the mouse */
11141 reset_sys_modes (tty
);
11144 tty
->flow_control
= !NILP (flow
);
11147 init_sys_modes (tty
);
11153 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11154 doc
: /* Enable or disable 8-bit input on TERMINAL.
11155 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11156 bit as the Meta modifier.
11158 If META is nil, Emacs will ignore the top bit, on the assumption it is
11161 Otherwise, Emacs will accept and pass through 8-bit input without
11162 specially interpreting the top bit.
11164 This setting only has an effect on tty terminal devices.
11166 Optional parameter TERMINAL specifies the tty terminal device to use.
11167 It may be a terminal object, a frame, or nil for the terminal used by
11168 the currently selected frame.
11170 See also `current-input-mode'. */)
11171 (Lisp_Object meta
, Lisp_Object terminal
)
11173 struct terminal
*t
= get_terminal (terminal
, 1);
11174 struct tty_display_info
*tty
;
11177 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11179 tty
= t
->display_info
.tty
;
11183 else if (EQ (meta
, Qt
))
11188 if (tty
->meta_key
!= new_meta
)
11191 /* this causes startup screen to be restored and messes with the mouse */
11192 reset_sys_modes (tty
);
11195 tty
->meta_key
= new_meta
;
11198 init_sys_modes (tty
);
11204 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11205 doc
: /* Specify character used for quitting.
11206 QUIT must be an ASCII character.
11208 This function only has an effect on the controlling tty of the Emacs
11211 See also `current-input-mode'. */)
11214 struct terminal
*t
= get_named_tty ("/dev/tty");
11215 struct tty_display_info
*tty
;
11216 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11218 tty
= t
->display_info
.tty
;
11220 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11221 error ("QUIT must be an ASCII character");
11224 /* this causes startup screen to be restored and messes with the mouse */
11225 reset_sys_modes (tty
);
11228 /* Don't let this value be out of range. */
11229 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11232 init_sys_modes (tty
);
11238 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11239 doc
: /* Set mode of reading keyboard input.
11240 First arg INTERRUPT non-nil means use input interrupts;
11241 nil means use CBREAK mode.
11242 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11243 (no effect except in CBREAK mode).
11244 Third arg META t means accept 8-bit input (for a Meta key).
11245 META nil means ignore the top bit, on the assumption it is parity.
11246 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11247 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11248 See also `current-input-mode'. */)
11249 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11251 Fset_input_interrupt_mode (interrupt
);
11252 Fset_output_flow_control (flow
, Qnil
);
11253 Fset_input_meta_mode (meta
, Qnil
);
11255 Fset_quit_char (quit
);
11259 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11260 doc
: /* Return information about the way Emacs currently reads keyboard input.
11261 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11262 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11263 nil, Emacs is using CBREAK mode.
11264 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11265 terminal; this does not apply if Emacs uses interrupt-driven input.
11266 META is t if accepting 8-bit input with 8th bit as Meta flag.
11267 META nil means ignoring the top bit, on the assumption it is parity.
11268 META is neither t nor nil if accepting 8-bit input and using
11269 all 8 bits as the character code.
11270 QUIT is the character Emacs currently uses to quit.
11271 The elements of this list correspond to the arguments of
11272 `set-input-mode'. */)
11275 Lisp_Object val
[4];
11276 struct frame
*sf
= XFRAME (selected_frame
);
11278 val
[0] = interrupt_input
? Qt
: Qnil
;
11279 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11281 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11282 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11284 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11291 XSETFASTINT (val
[3], quit_char
);
11293 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11296 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11297 doc
: /* Return position information for pixel coordinates X and Y.
11298 By default, X and Y are relative to text area of the selected window.
11299 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11300 If optional fourth arg WHOLE is non-nil, X is relative to the left
11301 edge of the window.
11303 The return value is similar to a mouse click position:
11304 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11305 IMAGE (DX . DY) (WIDTH . HEIGHT))
11306 The `posn-' functions access elements of such lists. */)
11307 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11312 if (NILP (frame_or_window
))
11313 frame_or_window
= selected_window
;
11315 if (WINDOWP (frame_or_window
))
11319 CHECK_LIVE_WINDOW (frame_or_window
);
11321 w
= XWINDOW (frame_or_window
);
11322 XSETINT (x
, (XINT (x
)
11323 + WINDOW_LEFT_EDGE_X (w
)
11325 ? window_box_left_offset (w
, TEXT_AREA
)
11327 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11328 frame_or_window
= w
->frame
;
11331 CHECK_LIVE_FRAME (frame_or_window
);
11333 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11336 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11337 doc
: /* Return position information for buffer POS in WINDOW.
11338 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11340 Return nil if position is not visible in window. Otherwise,
11341 the return value is similar to that returned by `event-start' for
11342 a mouse click at the upper left corner of the glyph corresponding
11343 to the given buffer position:
11344 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11345 IMAGE (DX . DY) (WIDTH . HEIGHT))
11346 The `posn-' functions access elements of such lists. */)
11347 (Lisp_Object pos
, Lisp_Object window
)
11352 window
= selected_window
;
11354 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11357 Lisp_Object x
= XCAR (tem
);
11358 Lisp_Object y
= XCAR (XCDR (tem
));
11360 /* Point invisible due to hscrolling? */
11363 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11371 * Set up a new kboard object with reasonable initial values.
11374 init_kboard (KBOARD
*kb
)
11376 kb
->Voverriding_terminal_local_map
= Qnil
;
11377 kb
->Vlast_command
= Qnil
;
11378 kb
->Vreal_last_command
= Qnil
;
11379 kb
->Vkeyboard_translate_table
= Qnil
;
11380 kb
->Vlast_repeatable_command
= Qnil
;
11381 kb
->Vprefix_arg
= Qnil
;
11382 kb
->Vlast_prefix_arg
= Qnil
;
11383 kb
->kbd_queue
= Qnil
;
11384 kb
->kbd_queue_has_data
= 0;
11385 kb
->immediate_echo
= 0;
11386 kb
->echo_string
= Qnil
;
11387 kb
->echo_after_prompt
= -1;
11388 kb
->kbd_macro_buffer
= 0;
11389 kb
->kbd_macro_bufsize
= 0;
11390 kb
->defining_kbd_macro
= Qnil
;
11391 kb
->Vlast_kbd_macro
= Qnil
;
11392 kb
->reference_count
= 0;
11393 kb
->Vsystem_key_alist
= Qnil
;
11394 kb
->system_key_syms
= Qnil
;
11395 kb
->Vwindow_system
= Qt
; /* Unset. */
11396 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11397 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11398 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11399 kb
->Vdefault_minibuffer_frame
= Qnil
;
11403 * Destroy the contents of a kboard object, but not the object itself.
11404 * We use this just before deleting it, or if we're going to initialize
11405 * it a second time.
11408 wipe_kboard (KBOARD
*kb
)
11410 xfree (kb
->kbd_macro_buffer
);
11413 /* Free KB and memory referenced from it. */
11416 delete_kboard (KBOARD
*kb
)
11420 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11423 *kbp
= kb
->next_kboard
;
11425 /* Prevent a dangling reference to KB. */
11426 if (kb
== current_kboard
11427 && FRAMEP (selected_frame
)
11428 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11430 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11432 if (current_kboard
== kb
)
11441 init_keyboard (void)
11443 /* This is correct before outermost invocation of the editor loop */
11444 command_loop_level
= -1;
11445 immediate_quit
= 0;
11446 quit_char
= Ctl ('g');
11447 Vunread_command_events
= Qnil
;
11448 unread_command_char
= -1;
11449 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11451 recent_keys_index
= 0;
11452 kbd_fetch_ptr
= kbd_buffer
;
11453 kbd_store_ptr
= kbd_buffer
;
11454 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11455 do_mouse_tracking
= Qnil
;
11458 interrupt_input_blocked
= 0;
11459 interrupt_input_pending
= 0;
11461 pending_signals
= 0;
11464 /* This means that command_loop_1 won't try to select anything the first
11466 internal_last_event_frame
= Qnil
;
11467 Vlast_event_frame
= internal_last_event_frame
;
11469 current_kboard
= initial_kboard
;
11470 /* Re-initialize the keyboard again. */
11471 wipe_kboard (current_kboard
);
11472 init_kboard (current_kboard
);
11473 /* A value of nil for Vwindow_system normally means a tty, but we also use
11474 it for the initial terminal since there is no window system there. */
11475 current_kboard
->Vwindow_system
= Qnil
;
11477 if (!noninteractive
)
11479 /* Before multi-tty support, these handlers used to be installed
11480 only if the current session was a tty session. Now an Emacs
11481 session may have multiple display types, so we always handle
11482 SIGINT. There is special code in interrupt_signal to exit
11483 Emacs on SIGINT when there are no termcap frames on the
11484 controlling terminal. */
11485 signal (SIGINT
, interrupt_signal
);
11487 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11488 SIGQUIT and we can't tell which one it will give us. */
11489 signal (SIGQUIT
, interrupt_signal
);
11490 #endif /* not DOS_NT */
11492 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11494 if (!noninteractive
)
11495 signal (SIGIO
, input_available_signal
);
11498 /* Use interrupt input by default, if it works and noninterrupt input
11499 has deficiencies. */
11501 #ifdef INTERRUPT_INPUT
11502 interrupt_input
= 1;
11504 interrupt_input
= 0;
11510 if (keyboard_init_hook
)
11511 (*keyboard_init_hook
) ();
11513 #ifdef POLL_FOR_INPUT
11515 poll_suppress_count
= 1;
11520 /* This type's only use is in syms_of_keyboard, to initialize the
11521 event header symbols and put properties on them. */
11522 struct event_head
{
11528 static const struct event_head head_table
[] = {
11529 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11530 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11531 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11532 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11533 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11534 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11535 /* `select-window' should be handled just like `switch-frame'
11536 in read_key_sequence. */
11537 {&Qselect_window
, "select-window", &Qswitch_frame
}
11541 syms_of_keyboard (void)
11543 pending_funcalls
= Qnil
;
11544 staticpro (&pending_funcalls
);
11546 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11547 staticpro (&Vlispy_mouse_stem
);
11550 QCimage
= intern_c_string (":image");
11551 staticpro (&QCimage
);
11553 staticpro (&Qhelp_echo
);
11554 Qhelp_echo
= intern_c_string ("help-echo");
11557 Qrtl
= intern_c_string (":rtl");
11559 staticpro (&item_properties
);
11560 item_properties
= Qnil
;
11562 staticpro (&tool_bar_item_properties
);
11563 tool_bar_item_properties
= Qnil
;
11564 staticpro (&tool_bar_items_vector
);
11565 tool_bar_items_vector
= Qnil
;
11567 staticpro (&real_this_command
);
11568 real_this_command
= Qnil
;
11570 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11571 staticpro (&Qtimer_event_handler
);
11573 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11574 staticpro (&Qdisabled_command_function
);
11576 Qself_insert_command
= intern_c_string ("self-insert-command");
11577 staticpro (&Qself_insert_command
);
11579 Qforward_char
= intern_c_string ("forward-char");
11580 staticpro (&Qforward_char
);
11582 Qbackward_char
= intern_c_string ("backward-char");
11583 staticpro (&Qbackward_char
);
11585 Qdisabled
= intern_c_string ("disabled");
11586 staticpro (&Qdisabled
);
11588 Qundefined
= intern_c_string ("undefined");
11589 staticpro (&Qundefined
);
11591 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11592 staticpro (&Qpre_command_hook
);
11594 Qpost_command_hook
= intern_c_string ("post-command-hook");
11595 staticpro (&Qpost_command_hook
);
11597 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11598 staticpro (&Qdeferred_action_function
);
11600 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11601 staticpro (&Qcommand_hook_internal
);
11603 Qfunction_key
= intern_c_string ("function-key");
11604 staticpro (&Qfunction_key
);
11605 Qmouse_click
= intern_c_string ("mouse-click");
11606 staticpro (&Qmouse_click
);
11607 #if defined (WINDOWSNT)
11608 Qlanguage_change
= intern_c_string ("language-change");
11609 staticpro (&Qlanguage_change
);
11611 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11612 staticpro (&Qdrag_n_drop
);
11614 Qsave_session
= intern_c_string ("save-session");
11615 staticpro (&Qsave_session
);
11618 Qdbus_event
= intern_c_string ("dbus-event");
11619 staticpro (&Qdbus_event
);
11622 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11623 staticpro (&Qconfig_changed_event
);
11625 Qmenu_enable
= intern_c_string ("menu-enable");
11626 staticpro (&Qmenu_enable
);
11627 QCenable
= intern_c_string (":enable");
11628 staticpro (&QCenable
);
11629 QCvisible
= intern_c_string (":visible");
11630 staticpro (&QCvisible
);
11631 QChelp
= intern_c_string (":help");
11632 staticpro (&QChelp
);
11633 QCfilter
= intern_c_string (":filter");
11634 staticpro (&QCfilter
);
11635 QCbutton
= intern_c_string (":button");
11636 staticpro (&QCbutton
);
11637 QCkeys
= intern_c_string (":keys");
11638 staticpro (&QCkeys
);
11639 QCkey_sequence
= intern_c_string (":key-sequence");
11640 staticpro (&QCkey_sequence
);
11641 QCtoggle
= intern_c_string (":toggle");
11642 staticpro (&QCtoggle
);
11643 QCradio
= intern_c_string (":radio");
11644 staticpro (&QCradio
);
11645 QClabel
= intern_c_string (":label");
11646 staticpro (&QClabel
);
11648 Qmode_line
= intern_c_string ("mode-line");
11649 staticpro (&Qmode_line
);
11650 Qvertical_line
= intern_c_string ("vertical-line");
11651 staticpro (&Qvertical_line
);
11652 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11653 staticpro (&Qvertical_scroll_bar
);
11654 Qmenu_bar
= intern_c_string ("menu-bar");
11655 staticpro (&Qmenu_bar
);
11657 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11658 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11659 staticpro (&Qmouse_fixup_help_message
);
11662 Qabove_handle
= intern_c_string ("above-handle");
11663 staticpro (&Qabove_handle
);
11664 Qhandle
= intern_c_string ("handle");
11665 staticpro (&Qhandle
);
11666 Qbelow_handle
= intern_c_string ("below-handle");
11667 staticpro (&Qbelow_handle
);
11668 Qup
= intern_c_string ("up");
11670 Qdown
= intern_c_string ("down");
11671 staticpro (&Qdown
);
11672 Qtop
= intern_c_string ("top");
11674 Qbottom
= intern_c_string ("bottom");
11675 staticpro (&Qbottom
);
11676 Qend_scroll
= intern_c_string ("end-scroll");
11677 staticpro (&Qend_scroll
);
11678 Qratio
= intern_c_string ("ratio");
11679 staticpro (&Qratio
);
11681 Qevent_kind
= intern_c_string ("event-kind");
11682 staticpro (&Qevent_kind
);
11683 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11684 staticpro (&Qevent_symbol_elements
);
11685 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11686 staticpro (&Qevent_symbol_element_mask
);
11687 Qmodifier_cache
= intern_c_string ("modifier-cache");
11688 staticpro (&Qmodifier_cache
);
11690 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11691 staticpro (&Qrecompute_lucid_menubar
);
11692 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11693 staticpro (&Qactivate_menubar_hook
);
11695 Qpolling_period
= intern_c_string ("polling-period");
11696 staticpro (&Qpolling_period
);
11698 Qinput_method_function
= intern_c_string ("input-method-function");
11699 staticpro (&Qinput_method_function
);
11701 Qx_set_selection
= intern_c_string ("x-set-selection");
11702 staticpro (&Qx_set_selection
);
11703 QPRIMARY
= intern_c_string ("PRIMARY");
11704 staticpro (&QPRIMARY
);
11706 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11707 staticpro (&Qinput_method_exit_on_first_char
);
11708 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11709 staticpro (&Qinput_method_use_echo_area
);
11711 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11712 Fset (Qinput_method_use_echo_area
, Qnil
);
11714 last_point_position_buffer
= Qnil
;
11715 last_point_position_window
= Qnil
;
11718 const struct event_head
*p
;
11720 for (p
= head_table
;
11721 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11724 *p
->var
= intern_c_string (p
->name
);
11725 staticpro (p
->var
);
11726 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11727 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11731 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11732 staticpro (&button_down_location
);
11733 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11734 staticpro (&mouse_syms
);
11735 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11736 / sizeof (lispy_wheel_names
[0])),
11738 staticpro (&wheel_syms
);
11742 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11744 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11745 for (i
= 0; i
< len
; i
++)
11746 if (modifier_names
[i
])
11747 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11748 staticpro (&modifier_symbols
);
11751 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11752 staticpro (&recent_keys
);
11754 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11755 staticpro (&this_command_keys
);
11757 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11758 staticpro (&raw_keybuf
);
11760 Qextended_command_history
= intern_c_string ("extended-command-history");
11761 Fset (Qextended_command_history
, Qnil
);
11762 staticpro (&Qextended_command_history
);
11764 accent_key_syms
= Qnil
;
11765 staticpro (&accent_key_syms
);
11767 func_key_syms
= Qnil
;
11768 staticpro (&func_key_syms
);
11770 drag_n_drop_syms
= Qnil
;
11771 staticpro (&drag_n_drop_syms
);
11773 unread_switch_frame
= Qnil
;
11774 staticpro (&unread_switch_frame
);
11776 internal_last_event_frame
= Qnil
;
11777 staticpro (&internal_last_event_frame
);
11779 read_key_sequence_cmd
= Qnil
;
11780 staticpro (&read_key_sequence_cmd
);
11782 menu_bar_one_keymap_changed_items
= Qnil
;
11783 staticpro (&menu_bar_one_keymap_changed_items
);
11785 menu_bar_items_vector
= Qnil
;
11786 staticpro (&menu_bar_items_vector
);
11788 help_form_saved_window_configs
= Qnil
;
11789 staticpro (&help_form_saved_window_configs
);
11791 defsubr (&Scurrent_idle_time
);
11792 defsubr (&Sevent_symbol_parse_modifiers
);
11793 defsubr (&Sevent_convert_list
);
11794 defsubr (&Sread_key_sequence
);
11795 defsubr (&Sread_key_sequence_vector
);
11796 defsubr (&Srecursive_edit
);
11797 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11798 defsubr (&Strack_mouse
);
11800 defsubr (&Sinput_pending_p
);
11801 defsubr (&Scommand_execute
);
11802 defsubr (&Srecent_keys
);
11803 defsubr (&Sthis_command_keys
);
11804 defsubr (&Sthis_command_keys_vector
);
11805 defsubr (&Sthis_single_command_keys
);
11806 defsubr (&Sthis_single_command_raw_keys
);
11807 defsubr (&Sreset_this_command_lengths
);
11808 defsubr (&Sclear_this_command_keys
);
11809 defsubr (&Ssuspend_emacs
);
11810 defsubr (&Sabort_recursive_edit
);
11811 defsubr (&Sexit_recursive_edit
);
11812 defsubr (&Srecursion_depth
);
11813 defsubr (&Stop_level
);
11814 defsubr (&Sdiscard_input
);
11815 defsubr (&Sopen_dribble_file
);
11816 defsubr (&Sset_input_interrupt_mode
);
11817 defsubr (&Sset_output_flow_control
);
11818 defsubr (&Sset_input_meta_mode
);
11819 defsubr (&Sset_quit_char
);
11820 defsubr (&Sset_input_mode
);
11821 defsubr (&Scurrent_input_mode
);
11822 defsubr (&Sexecute_extended_command
);
11823 defsubr (&Sposn_at_point
);
11824 defsubr (&Sposn_at_x_y
);
11826 DEFVAR_LISP ("last-command-event", &last_command_event
,
11827 doc
: /* Last input event that was part of a command. */);
11829 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11830 doc
: /* Last input event in a command, except for mouse menu events.
11831 Mouse menus give back keys that don't look like mouse events;
11832 this variable holds the actual mouse event that led to the menu,
11833 so that you can determine whether the command was run by mouse or not. */);
11835 DEFVAR_LISP ("last-input-event", &last_input_event
,
11836 doc
: /* Last input event. */);
11838 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11839 doc
: /* List of events to be read as the command input.
11840 These events are processed first, before actual keyboard input.
11841 Events read from this list are not normally added to `this-command-keys',
11842 as they will already have been added once as they were read for the first time.
11843 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11844 Vunread_command_events
= Qnil
;
11846 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11847 doc
: /* If not -1, an object to be read as next command input event. */);
11849 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11850 doc
: /* List of events to be processed as input by input methods.
11851 These events are processed before `unread-command-events'
11852 and actual keyboard input, but are not given to `input-method-function'. */);
11853 Vunread_post_input_method_events
= Qnil
;
11855 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11856 doc
: /* List of events to be processed as input by input methods.
11857 These events are processed after `unread-command-events', but
11858 before actual keyboard input.
11859 If there's an active input method, the events are given to
11860 `input-method-function'. */);
11861 Vunread_input_method_events
= Qnil
;
11863 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11864 doc
: /* Meta-prefix character code.
11865 Meta-foo as command input turns into this character followed by foo. */);
11866 XSETINT (meta_prefix_char
, 033);
11868 DEFVAR_KBOARD ("last-command", Vlast_command
,
11869 doc
: /* The last command executed.
11870 Normally a symbol with a function definition, but can be whatever was found
11871 in the keymap, or whatever the variable `this-command' was set to by that
11874 The value `mode-exit' is special; it means that the previous command
11875 read an event that told it to exit, and it did so and unread that event.
11876 In other words, the present command is the event that made the previous
11879 The value `kill-region' is special; it means that the previous command
11880 was a kill command.
11882 `last-command' has a separate binding for each terminal device.
11883 See Info node `(elisp)Multiple Terminals'. */);
11885 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11886 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11888 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11889 doc
: /* Last command that may be repeated.
11890 The last command executed that was not bound to an input event.
11891 This is the command `repeat' will try to repeat. */);
11893 DEFVAR_LISP ("this-command", &Vthis_command
,
11894 doc
: /* The command now being executed.
11895 The command can set this variable; whatever is put here
11896 will be in `last-command' during the following command. */);
11897 Vthis_command
= Qnil
;
11899 DEFVAR_LISP ("this-command-keys-shift-translated",
11900 &Vthis_command_keys_shift_translated
,
11901 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11902 Shift-translation occurs when there is no binding for the key sequence
11903 as entered, but a binding was found by changing an upper-case letter
11904 to lower-case, or a shifted function key to an unshifted one. */);
11905 Vthis_command_keys_shift_translated
= Qnil
;
11907 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11908 doc
: /* The command bound to the current key sequence before remapping.
11909 It equals `this-command' if the original command was not remapped through
11910 any of the active keymaps. Otherwise, the value of `this-command' is the
11911 result of looking up the original command in the active keymaps. */);
11912 Vthis_original_command
= Qnil
;
11914 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11915 doc
: /* *Number of input events between auto-saves.
11916 Zero means disable autosaving due to number of characters typed. */);
11917 auto_save_interval
= 300;
11919 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11920 doc
: /* *Number of seconds idle time before auto-save.
11921 Zero or nil means disable auto-saving due to idleness.
11922 After auto-saving due to this many seconds of idle time,
11923 Emacs also does a garbage collection if that seems to be warranted. */);
11924 XSETFASTINT (Vauto_save_timeout
, 30);
11926 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11927 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11928 The value may be integer or floating point. */);
11929 Vecho_keystrokes
= make_number (1);
11931 DEFVAR_INT ("polling-period", &polling_period
,
11932 doc
: /* *Interval between polling for input during Lisp execution.
11933 The reason for polling is to make C-g work to stop a running program.
11934 Polling is needed only when using X windows and SIGIO does not work.
11935 Polling is automatically disabled in all other cases. */);
11936 polling_period
= 2;
11938 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11939 doc
: /* *Maximum time between mouse clicks to make a double-click.
11940 Measured in milliseconds. The value nil means disable double-click
11941 recognition; t means double-clicks have no time limit and are detected
11942 by position only. */);
11943 Vdouble_click_time
= make_number (500);
11945 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11946 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11947 On window-system frames, value is the number of pixels the mouse may have
11948 moved horizontally or vertically between two clicks to make a double-click.
11949 On non window-system frames, value is interpreted in units of 1/8 characters
11952 This variable is also the threshold for motion of the mouse
11953 to count as a drag. */);
11954 double_click_fuzz
= 3;
11956 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11957 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11958 inhibit_local_menu_bar_menus
= 0;
11960 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11961 doc
: /* Number of complete key sequences read as input so far.
11962 This includes key sequences read from keyboard macros.
11963 The number is effectively the number of interactive command invocations. */);
11964 num_input_keys
= 0;
11966 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11967 doc
: /* Number of input events read from the keyboard so far.
11968 This does not include events generated by keyboard macros. */);
11969 num_nonmacro_input_events
= 0;
11971 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11972 doc
: /* The frame in which the most recently read event occurred.
11973 If the last event came from a keyboard macro, this is set to `macro'. */);
11974 Vlast_event_frame
= Qnil
;
11976 /* This variable is set up in sysdep.c. */
11977 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11978 doc
: /* The ERASE character as set by the user with stty. */);
11980 DEFVAR_LISP ("help-char", &Vhelp_char
,
11981 doc
: /* Character to recognize as meaning Help.
11982 When it is read, do `(eval help-form)', and display result if it's a string.
11983 If the value of `help-form' is nil, this char can be read normally. */);
11984 XSETINT (Vhelp_char
, Ctl ('H'));
11986 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11987 doc
: /* List of input events to recognize as meaning Help.
11988 These work just like the value of `help-char' (see that). */);
11989 Vhelp_event_list
= Qnil
;
11991 DEFVAR_LISP ("help-form", &Vhelp_form
,
11992 doc
: /* Form to execute when character `help-char' is read.
11993 If the form returns a string, that string is displayed.
11994 If `help-form' is nil, the help char is not recognized. */);
11997 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11998 doc
: /* Command to run when `help-char' character follows a prefix key.
11999 This command is used only when there is no actual binding
12000 for that character after that prefix key. */);
12001 Vprefix_help_command
= Qnil
;
12003 DEFVAR_LISP ("top-level", &Vtop_level
,
12004 doc
: /* Form to evaluate when Emacs starts up.
12005 Useful to set before you dump a modified Emacs. */);
12008 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12009 doc
: /* Translate table for local keyboard input, or nil.
12010 If non-nil, the value should be a char-table. Each character read
12011 from the keyboard is looked up in this char-table. If the value found
12012 there is non-nil, then it is used instead of the actual input character.
12014 The value can also be a string or vector, but this is considered obsolete.
12015 If it is a string or vector of length N, character codes N and up are left
12016 untranslated. In a vector, an element which is nil means "no translation".
12018 This is applied to the characters supplied to input methods, not their
12019 output. See also `translation-table-for-input'.
12021 This variable has a separate binding for each terminal.
12022 See Info node `(elisp)Multiple Terminals'. */);
12024 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12025 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12026 \(Even if the operating system has support for stopping a process.\) */);
12027 cannot_suspend
= 0;
12029 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12030 doc
: /* Non-nil means prompt with menus when appropriate.
12031 This is done when reading from a keymap that has a prompt string,
12032 for elements that have prompt strings.
12033 The menu is displayed on the screen
12034 if X menus were enabled at configuration
12035 time and the previous event was a mouse click prefix key.
12036 Otherwise, menu prompting uses the echo area. */);
12037 menu_prompting
= 1;
12039 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12040 doc
: /* Character to see next line of menu prompt.
12041 Type this character while in a menu prompt to rotate around the lines of it. */);
12042 XSETINT (menu_prompt_more_char
, ' ');
12044 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12045 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12046 Emacs applies the modifiers of the character stored here to each keyboard
12047 character it reads. For example, after evaluating the expression
12048 (setq extra-keyboard-modifiers ?\\C-x)
12049 all input characters will have the control modifier applied to them.
12051 Note that the character ?\\C-@, equivalent to the integer zero, does
12052 not count as a control character; rather, it counts as a character
12053 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12054 cancels any modification. */);
12055 extra_keyboard_modifiers
= 0;
12057 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12058 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12059 The command loop sets this to nil before each command,
12060 and tests the value when the command returns.
12061 Buffer modification stores t in this variable. */);
12062 Vdeactivate_mark
= Qnil
;
12063 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
12064 staticpro (&Qdeactivate_mark
);
12066 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12067 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12068 Vcommand_hook_internal
= Qnil
;
12070 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12071 doc
: /* Normal hook run before each command is executed.
12072 If an unhandled error happens in running this hook,
12073 the hook value is set to nil, since otherwise the error
12074 might happen repeatedly and make Emacs nonfunctional. */);
12075 Vpre_command_hook
= Qnil
;
12077 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12078 doc
: /* Normal hook run after each command is executed.
12079 If an unhandled error happens in running this hook,
12080 the hook value is set to nil, since otherwise the error
12081 might happen repeatedly and make Emacs nonfunctional. */);
12082 Vpost_command_hook
= Qnil
;
12085 DEFVAR_LISP ("echo-area-clear-hook", ...,
12086 doc
: /* Normal hook run when clearing the echo area. */);
12088 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
12089 staticpro (&Qecho_area_clear_hook
);
12090 Fset (Qecho_area_clear_hook
, Qnil
);
12092 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12093 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12094 Vlucid_menu_bar_dirty_flag
= Qnil
;
12096 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12097 doc
: /* List of menu bar items to move to the end of the menu bar.
12098 The elements of the list are event types that may have menu bar bindings. */);
12099 Vmenu_bar_final_items
= Qnil
;
12101 DEFVAR_KBOARD ("overriding-terminal-local-map",
12102 Voverriding_terminal_local_map
,
12103 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12104 If this variable is non-nil, it is used as a keymap instead of the
12105 buffer's local map, and the minor mode keymaps and text property keymaps.
12106 It also replaces `overriding-local-map'.
12108 This variable is intended to let commands such as `universal-argument'
12109 set up a different keymap for reading the next command.
12111 `overriding-terminal-local-map' has a separate binding for each
12113 See Info node `(elisp)Multiple Terminals'. */);
12115 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12116 doc
: /* Keymap that overrides all other local keymaps.
12117 If this variable is non-nil, it is used as a keymap--replacing the
12118 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12119 Voverriding_local_map
= Qnil
;
12121 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12122 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12123 Otherwise, the menu bar continues to reflect the buffer's local map
12124 and the minor mode maps regardless of `overriding-local-map'. */);
12125 Voverriding_local_map_menu_flag
= Qnil
;
12127 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12128 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12129 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12131 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12132 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12134 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12135 doc
: /* Alist of system-specific X windows key symbols.
12136 Each element should have the form (N . SYMBOL) where N is the
12137 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12138 and SYMBOL is its name.
12140 `system-key-alist' has a separate binding for each terminal device.
12141 See Info node `(elisp)Multiple Terminals'. */);
12143 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12144 doc
: /* Keymap that translates key sequences to key sequences during input.
12145 This is used mainly for mapping key sequences into some preferred
12146 key events (symbols).
12148 The `read-key-sequence' function replaces any subsequence bound by
12149 `local-function-key-map' with its binding. More precisely, when the
12150 active keymaps have no binding for the current key sequence but
12151 `local-function-key-map' binds a suffix of the sequence to a vector or
12152 string, `read-key-sequence' replaces the matching suffix with its
12153 binding, and continues with the new sequence.
12155 If the binding is a function, it is called with one argument (the prompt)
12156 and its return value (a key sequence) is used.
12158 The events that come from bindings in `local-function-key-map' are not
12159 themselves looked up in `local-function-key-map'.
12161 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12162 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12163 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12164 typing `ESC O P x' would return [f1 x].
12166 `local-function-key-map' has a separate binding for each terminal
12167 device. See Info node `(elisp)Multiple Terminals'. If you need to
12168 define a binding on all terminals, change `function-key-map'
12169 instead. Initially, `local-function-key-map' is an empty keymap that
12170 has `function-key-map' as its parent on all terminal devices. */);
12172 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12173 doc
: /* Keymap that decodes input escape sequences.
12174 This is used mainly for mapping ASCII function key sequences into
12175 real Emacs function key events (symbols).
12177 The `read-key-sequence' function replaces any subsequence bound by
12178 `input-decode-map' with its binding. Contrary to `function-key-map',
12179 this map applies its rebinding regardless of the presence of an ordinary
12180 binding. So it is more like `key-translation-map' except that it applies
12181 before `function-key-map' rather than after.
12183 If the binding is a function, it is called with one argument (the prompt)
12184 and its return value (a key sequence) is used.
12186 The events that come from bindings in `input-decode-map' are not
12187 themselves looked up in `input-decode-map'.
12189 This variable is keyboard-local. */);
12191 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12192 doc
: /* The parent keymap of all `local-function-key-map' instances.
12193 Function key definitions that apply to all terminal devices should go
12194 here. If a mapping is defined in both the current
12195 `local-function-key-map' binding and this variable, then the local
12196 definition will take precendence. */);
12197 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12199 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12200 doc
: /* Keymap of key translations that can override keymaps.
12201 This keymap works like `function-key-map', but comes after that,
12202 and its non-prefix bindings override ordinary bindings.
12203 Another difference is that it is global rather than keyboard-local. */);
12204 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12206 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12207 doc
: /* List of deferred actions to be performed at a later time.
12208 The precise format isn't relevant here; we just check whether it is nil. */);
12209 Vdeferred_action_list
= Qnil
;
12211 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12212 doc
: /* Function to call to handle deferred actions, after each command.
12213 This function is called with no arguments after each command
12214 whenever `deferred-action-list' is non-nil. */);
12215 Vdeferred_action_function
= Qnil
;
12217 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12218 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12219 The value can be a length of time to show the message for.
12220 If the value is non-nil and not a number, we wait 2 seconds. */);
12221 Vsuggest_key_bindings
= Qt
;
12223 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12224 doc
: /* List of active absolute time timers in order of increasing time. */);
12225 Vtimer_list
= Qnil
;
12227 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12228 doc
: /* List of active idle-time timers in order of increasing time. */);
12229 Vtimer_idle_list
= Qnil
;
12231 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12232 doc
: /* If non-nil, the function that implements the current input method.
12233 It's called with one argument, a printing character that was just read.
12234 \(That means a character with code 040...0176.)
12235 Typically this function uses `read-event' to read additional events.
12236 When it does so, it should first bind `input-method-function' to nil
12237 so it will not be called recursively.
12239 The function should return a list of zero or more events
12240 to be used as input. If it wants to put back some events
12241 to be reconsidered, separately, by the input method,
12242 it can add them to the beginning of `unread-command-events'.
12244 The input method function can find in `input-method-previous-message'
12245 the previous echo area message.
12247 The input method function should refer to the variables
12248 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12249 for guidance on what to do. */);
12250 Vinput_method_function
= Qnil
;
12252 DEFVAR_LISP ("input-method-previous-message",
12253 &Vinput_method_previous_message
,
12254 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12255 This variable exists because `read-event' clears the echo area
12256 before running the input method. It is nil if there was no message. */);
12257 Vinput_method_previous_message
= Qnil
;
12259 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12260 doc
: /* If non-nil, the function that implements the display of help.
12261 It's called with one argument, the help string to display. */);
12262 Vshow_help_function
= Qnil
;
12264 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12265 doc
: /* If non-nil, suppress point adjustment after executing a command.
12267 After a command is executed, if point is moved into a region that has
12268 special properties (e.g. composition, display), we adjust point to
12269 the boundary of the region. But, when a command sets this variable to
12270 non-nil, we suppress the point adjustment.
12272 This variable is set to nil before reading a command, and is checked
12273 just after executing the command. */);
12274 Vdisable_point_adjustment
= Qnil
;
12276 DEFVAR_LISP ("global-disable-point-adjustment",
12277 &Vglobal_disable_point_adjustment
,
12278 doc
: /* *If non-nil, always suppress point adjustment.
12280 The default value is nil, in which case, point adjustment are
12281 suppressed only after special commands that set
12282 `disable-point-adjustment' (which see) to non-nil. */);
12283 Vglobal_disable_point_adjustment
= Qnil
;
12285 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12286 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12287 If the value is not a number, such messages don't time out. */);
12288 Vminibuffer_message_timeout
= make_number (2);
12290 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12291 doc
: /* If non-nil, any keyboard input throws to this symbol.
12292 The value of that variable is passed to `quit-flag' and later causes a
12293 peculiar kind of quitting. */);
12294 Vthrow_on_input
= Qnil
;
12296 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12297 doc
: /* If non-nil, function to output error messages.
12298 The arguments are the error data, a list of the form
12299 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12300 such as just as `condition-case' would bind its variable to,
12301 the context (a string which normally goes at the start of the message),
12302 and the Lisp function within which the error was signaled. */);
12303 Vcommand_error_function
= Qnil
;
12305 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12306 &Venable_disabled_menus_and_buttons
,
12307 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12309 Help functions bind this to allow help on disabled menu items
12310 and tool-bar buttons. */);
12311 Venable_disabled_menus_and_buttons
= Qnil
;
12313 DEFVAR_LISP ("select-active-regions",
12314 &Vselect_active_regions
,
12315 doc
: /* If non-nil, an active region automatically becomes the window selection.
12316 If the value is `only', only temporarily active regions (usually made
12317 by mouse-dragging or shift-selection) set the window selection.
12319 This takes effect only when Transient Mark mode is enabled. */);
12320 Vselect_active_regions
= Qt
;
12322 DEFVAR_LISP ("saved-region-selection",
12323 &Vsaved_region_selection
,
12324 doc
: /* Contents of active region prior to buffer modification.
12325 If `select-active-regions' is non-nil, Emacs sets this to the
12326 text in the region before modifying the buffer. The next
12327 `deactivate-mark' call uses this to set the window selection. */);
12328 Vsaved_region_selection
= Qnil
;
12330 /* Create the initial keyboard. */
12331 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12332 init_kboard (initial_kboard
);
12333 /* Vwindow_system is left at t for now. */
12334 initial_kboard
->next_kboard
= all_kboards
;
12335 all_kboards
= initial_kboard
;
12339 keys_of_keyboard (void)
12341 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12342 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12343 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12344 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12345 initial_define_key (meta_map
, 'x', "execute-extended-command");
12347 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12348 "handle-delete-frame");
12349 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12350 "ns-put-working-text");
12351 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12352 "ns-unput-working-text");
12353 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12354 current-prefix-arg, as is done in `handle-switch-frame'.
12355 But `handle-switch-frame is not run from the special-map.
12356 Commands from that map are run in a special way that automatically
12357 preserves the prefix-arg. Restoring the prefix arg here is not just
12358 redundant but harmful:
12360 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12361 - after the first prompt, the exit-minibuffer-hook is run which may
12362 iconify a frame and thus push a `iconify-frame' event.
12363 - after running exit-minibuffer-hook, current-prefix-arg is
12364 restored to the non-nil value it had before the prompt.
12365 - we enter the second prompt.
12366 current-prefix-arg is non-nil, prefix-arg is nil.
12367 - before running the first real event, we run the special iconify-frame
12368 event, but we pass the `special' arg to execute-command so
12369 current-prefix-arg and prefix-arg are left untouched.
12370 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12371 - the next key event will have a spuriously non-nil current-prefix-arg. */
12372 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12374 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12376 /* Handling it at such a low-level causes read_key_sequence to get
12377 * confused because it doesn't realize that the current_buffer was
12378 * changed by read_char.
12380 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12381 * "handle-select-window"); */
12382 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12383 "handle-save-session");
12386 /* Define a special event which is raised for dbus callback
12388 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12389 "dbus-handle-event");
12392 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12396 /* Mark the pointers in the kboard objects.
12397 Called by the Fgarbage_collector. */
12399 mark_kboards (void)
12403 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12405 if (kb
->kbd_macro_buffer
)
12406 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12408 mark_object (kb
->Voverriding_terminal_local_map
);
12409 mark_object (kb
->Vlast_command
);
12410 mark_object (kb
->Vreal_last_command
);
12411 mark_object (kb
->Vkeyboard_translate_table
);
12412 mark_object (kb
->Vlast_repeatable_command
);
12413 mark_object (kb
->Vprefix_arg
);
12414 mark_object (kb
->Vlast_prefix_arg
);
12415 mark_object (kb
->kbd_queue
);
12416 mark_object (kb
->defining_kbd_macro
);
12417 mark_object (kb
->Vlast_kbd_macro
);
12418 mark_object (kb
->Vsystem_key_alist
);
12419 mark_object (kb
->system_key_syms
);
12420 mark_object (kb
->Vwindow_system
);
12421 mark_object (kb
->Vinput_decode_map
);
12422 mark_object (kb
->Vlocal_function_key_map
);
12423 mark_object (kb
->Vdefault_minibuffer_frame
);
12424 mark_object (kb
->echo_string
);
12427 struct input_event
*event
;
12428 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12430 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12431 event
= kbd_buffer
;
12432 if (event
->kind
!= SELECTION_REQUEST_EVENT
12433 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12435 mark_object (event
->x
);
12436 mark_object (event
->y
);
12438 mark_object (event
->frame_or_window
);
12439 mark_object (event
->arg
);
12444 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12445 (do not change this comment) */