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 extern Lisp_Object current_global_map
;
250 extern int minibuf_level
;
252 /* If non-nil, this is a map that overrides all other local maps. */
253 Lisp_Object Voverriding_local_map
;
255 /* If non-nil, Voverriding_local_map applies to the menu bar. */
256 Lisp_Object Voverriding_local_map_menu_flag
;
258 /* Keymap that defines special misc events that should
259 be processed immediately at a low level. */
260 Lisp_Object Vspecial_event_map
;
262 /* Current depth in recursive edits. */
263 int command_loop_level
;
265 /* Total number of times command_loop has read a key sequence. */
266 EMACS_INT num_input_keys
;
268 /* Last input event read as a command. */
269 Lisp_Object last_command_event
;
271 /* Last input character read as a command, not counting menus
272 reached by the mouse. */
273 Lisp_Object last_nonmenu_event
;
275 /* Last input event read for any purpose. */
276 Lisp_Object last_input_event
;
278 /* If not Qnil, a list of objects to be read as subsequent command input. */
279 Lisp_Object Vunread_command_events
;
281 /* If not Qnil, a list of objects to be read as subsequent command input
282 including input method processing. */
283 Lisp_Object Vunread_input_method_events
;
285 /* If not Qnil, a list of objects to be read as subsequent command input
286 but NOT including input method processing. */
287 Lisp_Object Vunread_post_input_method_events
;
289 /* If not -1, an event to be read as subsequent command input. */
290 EMACS_INT unread_command_char
;
292 /* If not Qnil, this is a switch-frame event which we decided to put
293 off until the end of a key sequence. This should be read as the
294 next command input, after any unread_command_events.
296 read_key_sequence uses this to delay switch-frame events until the
297 end of the key sequence; Fread_char uses it to put off switch-frame
298 events until a non-ASCII event is acceptable as input. */
299 Lisp_Object unread_switch_frame
;
301 /* A mask of extra modifier bits to put into every keyboard char. */
302 EMACS_INT extra_keyboard_modifiers
;
304 /* Char to use as prefix when a meta character is typed in.
305 This is bound on entry to minibuffer in case ESC is changed there. */
307 Lisp_Object meta_prefix_char
;
309 /* Last size recorded for a current buffer which is not a minibuffer. */
310 static int last_non_minibuf_size
;
312 /* Number of idle seconds before an auto-save and garbage collection. */
313 static Lisp_Object Vauto_save_timeout
;
315 /* Total number of times read_char has returned. */
316 int num_input_events
;
318 /* Total number of times read_char has returned, outside of macros. */
319 EMACS_INT num_nonmacro_input_events
;
321 /* Auto-save automatically when this many characters have been typed
322 since the last time. */
324 static EMACS_INT auto_save_interval
;
326 /* Value of num_nonmacro_input_events as of last auto save. */
330 /* The command being executed by the command loop.
331 Commands may set this, and the value set will be copied into
332 current_kboard->Vlast_command instead of the actual command. */
333 Lisp_Object Vthis_command
;
335 /* This is like Vthis_command, except that commands never set it. */
336 Lisp_Object real_this_command
;
338 /* If the lookup of the command returns a binding, the original
339 command is stored in this-original-command. It is nil otherwise. */
340 Lisp_Object Vthis_original_command
;
342 /* The value of point when the last command was started. */
343 int last_point_position
;
345 /* The buffer that was current when the last command was started. */
346 Lisp_Object last_point_position_buffer
;
348 /* The window that was selected when the last command was started. */
349 Lisp_Object last_point_position_window
;
351 /* The frame in which the last input event occurred, or Qmacro if the
352 last event came from a macro. We use this to determine when to
353 generate switch-frame events. This may be cleared by functions
354 like Fselect_frame, to make sure that a switch-frame event is
355 generated by the next character. */
356 Lisp_Object internal_last_event_frame
;
358 /* A user-visible version of the above, intended to allow users to
359 figure out where the last event came from, if the event doesn't
360 carry that information itself (i.e. if it was a character). */
361 Lisp_Object Vlast_event_frame
;
363 /* The timestamp of the last input event we received from the X server.
364 X Windows wants this for selection ownership. */
365 unsigned long last_event_timestamp
;
367 Lisp_Object Qself_insert_command
;
368 Lisp_Object Qforward_char
;
369 Lisp_Object Qbackward_char
;
370 Lisp_Object Qundefined
;
371 Lisp_Object Qtimer_event_handler
;
373 /* read_key_sequence stores here the command definition of the
374 key sequence that it reads. */
375 Lisp_Object read_key_sequence_cmd
;
377 /* Echo unfinished commands after this many seconds of pause. */
378 Lisp_Object Vecho_keystrokes
;
380 /* Form to evaluate (if non-nil) when Emacs is started. */
381 Lisp_Object Vtop_level
;
383 /* If non-nil, this implements the current input method. */
384 Lisp_Object Vinput_method_function
;
385 Lisp_Object Qinput_method_function
;
387 /* When we call Vinput_method_function,
388 this holds the echo area message that was just erased. */
389 Lisp_Object Vinput_method_previous_message
;
391 /* Non-nil means deactivate the mark at end of this command. */
392 Lisp_Object Vdeactivate_mark
;
393 Lisp_Object Qdeactivate_mark
;
395 /* Menu bar specified in Lucid Emacs fashion. */
397 Lisp_Object Vlucid_menu_bar_dirty_flag
;
398 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
400 Lisp_Object Qecho_area_clear_hook
;
402 /* Hooks to run before and after each command. */
403 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
404 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
405 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
407 /* Parent keymap of terminal-local function-key-map instances. */
408 Lisp_Object Vfunction_key_map
;
410 /* Keymap of key translations that can override keymaps. */
411 Lisp_Object Vkey_translation_map
;
413 /* List of deferred actions to be performed at a later time.
414 The precise format isn't relevant here; we just check whether it is nil. */
415 Lisp_Object Vdeferred_action_list
;
417 /* Function to call to handle deferred actions, when there are any. */
418 Lisp_Object Vdeferred_action_function
;
419 Lisp_Object Qdeferred_action_function
;
421 Lisp_Object Qinput_method_exit_on_first_char
;
422 Lisp_Object Qinput_method_use_echo_area
;
424 /* File in which we write all commands we read. */
427 /* Nonzero if input is available. */
430 extern char *pending_malloc_warning
;
432 /* Circular buffer for pre-read keyboard input. */
434 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
436 /* Pointer to next available character in kbd_buffer.
437 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
438 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
439 next available char is in kbd_buffer[0]. */
440 static struct input_event
*kbd_fetch_ptr
;
442 /* Pointer to next place to store character in kbd_buffer. This
443 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
444 character should go in kbd_buffer[0]. */
445 static struct input_event
* volatile kbd_store_ptr
;
447 /* The above pair of variables forms a "queue empty" flag. When we
448 enqueue a non-hook event, we increment kbd_store_ptr. When we
449 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
450 there is input available if the two pointers are not equal.
452 Why not just have a flag set and cleared by the enqueuing and
453 dequeuing functions? Such a flag could be screwed up by interrupts
454 at inopportune times. */
456 /* If this flag is non-nil, we check mouse_moved to see when the
457 mouse moves, and motion events will appear in the input stream.
458 Otherwise, mouse motion is ignored. */
459 Lisp_Object do_mouse_tracking
;
461 /* Symbols to head events. */
462 Lisp_Object Qmouse_movement
;
463 Lisp_Object Qscroll_bar_movement
;
464 Lisp_Object Qswitch_frame
;
465 Lisp_Object Qdelete_frame
;
466 Lisp_Object Qiconify_frame
;
467 Lisp_Object Qmake_frame_visible
;
468 Lisp_Object Qselect_window
;
469 Lisp_Object Qhelp_echo
;
471 extern Lisp_Object Qremap
;
473 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
474 Lisp_Object Qmouse_fixup_help_message
;
477 /* Symbols to denote kinds of events. */
478 Lisp_Object Qfunction_key
;
479 Lisp_Object Qmouse_click
;
480 #if defined (WINDOWSNT)
481 Lisp_Object Qlanguage_change
;
483 Lisp_Object Qdrag_n_drop
;
484 Lisp_Object Qsave_session
;
486 Lisp_Object Qdbus_event
;
488 Lisp_Object Qconfig_changed_event
;
490 /* Lisp_Object Qmouse_movement; - also an event header */
492 /* Properties of event headers. */
493 Lisp_Object Qevent_kind
;
494 Lisp_Object Qevent_symbol_elements
;
496 /* menu item parts */
497 Lisp_Object Qmenu_enable
;
498 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
499 Lisp_Object QCbutton
, QCtoggle
, QCradio
, QClabel
;
500 extern Lisp_Object Qmenu_item
;
502 /* An event header symbol HEAD may have a property named
503 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
504 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
505 mask of modifiers applied to it. If present, this is used to help
506 speed up parse_modifiers. */
507 Lisp_Object Qevent_symbol_element_mask
;
509 /* An unmodified event header BASE may have a property named
510 Qmodifier_cache, which is an alist mapping modifier masks onto
511 modified versions of BASE. If present, this helps speed up
513 Lisp_Object Qmodifier_cache
;
515 /* Symbols to use for parts of windows. */
516 Lisp_Object Qmode_line
;
517 Lisp_Object Qvertical_line
;
518 Lisp_Object Qvertical_scroll_bar
;
519 Lisp_Object Qmenu_bar
;
520 extern Lisp_Object Qleft_margin
, Qright_margin
;
521 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
522 extern Lisp_Object QCmap
;
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 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
531 static void record_menu_key (Lisp_Object c
);
532 static int echo_length (void);
534 Lisp_Object Qpolling_period
;
536 /* List of absolute timers. Appears in order of next scheduled event. */
537 Lisp_Object Vtimer_list
;
539 /* List of idle time timers. Appears in order of next scheduled event. */
540 Lisp_Object Vtimer_idle_list
;
542 /* Incremented whenever a timer is run. */
545 extern Lisp_Object Vprint_level
, Vprint_length
;
547 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
549 EMACS_TIME
*input_available_clear_time
;
551 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
552 Default is 1 if INTERRUPT_INPUT is defined. */
555 /* Nonzero while interrupts are temporarily deferred during redisplay. */
556 int interrupts_deferred
;
558 /* Allow m- file to inhibit use of FIONREAD. */
559 #ifdef BROKEN_FIONREAD
563 /* We are unable to use interrupts if FIONREAD is not available,
564 so flush SIGIO so we won't try. */
565 #if !defined (FIONREAD)
571 /* If we support a window system, turn on the code to poll periodically
572 to detect C-g. It isn't actually used when doing interrupt input. */
573 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
574 #define POLL_FOR_INPUT
577 /* After a command is executed, if point is moved into a region that
578 has specific properties (e.g. composition, display), we adjust
579 point to the boundary of the region. But, if a command sets this
580 variable to non-nil, we suppress this point adjustment. This
581 variable is set to nil before reading a command. */
583 Lisp_Object Vdisable_point_adjustment
;
585 /* If non-nil, always disable point adjustment. */
587 Lisp_Object Vglobal_disable_point_adjustment
;
589 /* The time when Emacs started being idle. */
591 static EMACS_TIME timer_idleness_start_time
;
593 /* After Emacs stops being idle, this saves the last value
594 of timer_idleness_start_time from when it was idle. */
596 static EMACS_TIME timer_last_idleness_start_time
;
598 /* If non-nil, events produced by disabled menu items and tool-bar
599 buttons are not ignored. Help functions bind this to allow help on
600 those items and buttons. */
601 Lisp_Object Venable_disabled_menus_and_buttons
;
604 /* Global variable declarations. */
606 /* Flags for readable_events. */
607 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
608 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
609 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
611 /* Function for init_keyboard to call with no args (if nonzero). */
612 void (*keyboard_init_hook
) (void);
614 static int read_avail_input (int);
615 static void get_input_pending (int *, int);
616 static int readable_events (int);
617 static Lisp_Object
read_char_x_menu_prompt (int, Lisp_Object
*,
619 static Lisp_Object
read_char_minibuf_menu_prompt (int, int,
621 static Lisp_Object
make_lispy_event (struct input_event
*);
622 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
623 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
624 enum scroll_bar_part
,
625 Lisp_Object
, Lisp_Object
,
628 static Lisp_Object
modify_event_symbol (int, unsigned, Lisp_Object
,
629 Lisp_Object
, char **,
630 Lisp_Object
*, unsigned);
631 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
632 static void save_getcjmp (jmp_buf);
633 static void restore_getcjmp (jmp_buf);
634 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
635 static void clear_event (struct input_event
*);
636 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
637 static SIGTYPE
interrupt_signal (int signalnum
);
638 static SIGTYPE
input_available_signal (int signo
);
639 static void handle_interrupt (void);
640 static void timer_start_idle (void);
641 static void timer_stop_idle (void);
642 static void timer_resume_idle (void);
643 static SIGTYPE
handle_user_signal (int);
644 static char *find_user_signal_name (int);
645 static int store_user_signal_events (void);
647 /* Nonzero means don't try to suspend even if the operating system seems
649 static int cannot_suspend
;
651 extern Lisp_Object Qidentity
, Qonly
;
653 /* Install the string STR as the beginning of the string of echoing,
654 so that it serves as a prompt for the next character.
655 Also start echoing. */
658 echo_prompt (Lisp_Object str
)
660 current_kboard
->echo_string
= str
;
661 current_kboard
->echo_after_prompt
= SCHARS (str
);
665 /* Add C to the echo string, if echoing is going on.
666 C can be a character, which is printed prettily ("M-C-x" and all that
667 jazz), or a symbol, whose name is printed. */
670 echo_char (Lisp_Object c
)
672 if (current_kboard
->immediate_echo
)
674 int size
= KEY_DESCRIPTION_SIZE
+ 100;
675 char *buffer
= (char *) alloca (size
);
677 Lisp_Object echo_string
;
679 echo_string
= current_kboard
->echo_string
;
681 /* If someone has passed us a composite event, use its head symbol. */
686 ptr
= push_key_description (XINT (c
), ptr
, 1);
688 else if (SYMBOLP (c
))
690 Lisp_Object name
= SYMBOL_NAME (c
);
691 int nbytes
= SBYTES (name
);
693 if (size
- (ptr
- buffer
) < nbytes
)
695 int offset
= ptr
- buffer
;
696 size
= max (2 * size
, size
+ nbytes
);
697 buffer
= (char *) alloca (size
);
698 ptr
= buffer
+ offset
;
701 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
702 STRING_MULTIBYTE (name
), 1);
705 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
708 const char *text
= " (Type ? for further options)";
709 int len
= strlen (text
);
711 if (size
- (ptr
- buffer
) < len
)
713 int offset
= ptr
- buffer
;
715 buffer
= (char *) alloca (size
);
716 ptr
= buffer
+ offset
;
719 memcpy (ptr
, text
, len
);
723 /* Replace a dash from echo_dash with a space, otherwise
724 add a space at the end as a separator between keys. */
725 if (STRINGP (echo_string
)
726 && SCHARS (echo_string
) > 1)
728 Lisp_Object last_char
, prev_char
, idx
;
730 idx
= make_number (SCHARS (echo_string
) - 2);
731 prev_char
= Faref (echo_string
, idx
);
733 idx
= make_number (SCHARS (echo_string
) - 1);
734 last_char
= Faref (echo_string
, idx
);
736 /* We test PREV_CHAR to make sure this isn't the echoing
738 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
739 Faset (echo_string
, idx
, make_number (' '));
741 echo_string
= concat2 (echo_string
, build_string (" "));
743 else if (STRINGP (echo_string
))
744 echo_string
= concat2 (echo_string
, build_string (" "));
746 current_kboard
->echo_string
747 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
753 /* Temporarily add a dash to the end of the echo string if it's not
754 empty, so that it serves as a mini-prompt for the very next character. */
759 /* Do nothing if not echoing at all. */
760 if (NILP (current_kboard
->echo_string
))
763 if (!current_kboard
->immediate_echo
764 && SCHARS (current_kboard
->echo_string
) == 0)
767 /* Do nothing if we just printed a prompt. */
768 if (current_kboard
->echo_after_prompt
769 == SCHARS (current_kboard
->echo_string
))
772 /* Do nothing if we have already put a dash at the end. */
773 if (SCHARS (current_kboard
->echo_string
) > 1)
775 Lisp_Object last_char
, prev_char
, idx
;
777 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
778 prev_char
= Faref (current_kboard
->echo_string
, idx
);
780 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
781 last_char
= Faref (current_kboard
->echo_string
, idx
);
783 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
787 /* Put a dash at the end of the buffer temporarily,
788 but make it go away when the next character is added. */
789 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
794 /* Display the current echo string, and begin echoing if not already
800 if (!current_kboard
->immediate_echo
)
803 current_kboard
->immediate_echo
= 1;
805 for (i
= 0; i
< this_command_key_count
; i
++)
809 /* Set before_command_echo_length to the value that would
810 have been saved before the start of this subcommand in
811 command_loop_1, if we had already been echoing then. */
812 if (i
== this_single_command_key_start
)
813 before_command_echo_length
= echo_length ();
815 c
= XVECTOR (this_command_keys
)->contents
[i
];
816 if (! (EVENT_HAS_PARAMETERS (c
)
817 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
821 /* Set before_command_echo_length to the value that would
822 have been saved before the start of this subcommand in
823 command_loop_1, if we had already been echoing then. */
824 if (this_command_key_count
== this_single_command_key_start
)
825 before_command_echo_length
= echo_length ();
827 /* Put a dash at the end to invite the user to type more. */
832 message3_nolog (current_kboard
->echo_string
,
833 SBYTES (current_kboard
->echo_string
),
834 STRING_MULTIBYTE (current_kboard
->echo_string
));
837 /* Record in what buffer we echoed, and from which kboard. */
838 echo_message_buffer
= echo_area_buffer
[0];
839 echo_kboard
= current_kboard
;
841 if (waiting_for_input
&& !NILP (Vquit_flag
))
842 quit_throw_to_read_char ();
845 /* Turn off echoing, for the start of a new command. */
848 cancel_echoing (void)
850 current_kboard
->immediate_echo
= 0;
851 current_kboard
->echo_after_prompt
= -1;
852 current_kboard
->echo_string
= Qnil
;
853 ok_to_echo_at_next_pause
= NULL
;
855 echo_message_buffer
= Qnil
;
858 /* Return the length of the current echo string. */
863 return (STRINGP (current_kboard
->echo_string
)
864 ? SCHARS (current_kboard
->echo_string
)
868 /* Truncate the current echo message to its first LEN chars.
869 This and echo_char get used by read_key_sequence when the user
870 switches frames while entering a key sequence. */
873 echo_truncate (int nchars
)
875 if (STRINGP (current_kboard
->echo_string
))
876 current_kboard
->echo_string
877 = Fsubstring (current_kboard
->echo_string
,
878 make_number (0), make_number (nchars
));
879 truncate_echo_area (nchars
);
883 /* Functions for manipulating this_command_keys. */
885 add_command_key (Lisp_Object key
)
887 #if 0 /* Not needed after we made Freset_this_command_lengths
888 do the job immediately. */
889 /* If reset-this-command-length was called recently, obey it now.
890 See the doc string of that function for an explanation of why. */
891 if (before_command_restore_flag
)
893 this_command_key_count
= before_command_key_count_1
;
894 if (this_command_key_count
< this_single_command_key_start
)
895 this_single_command_key_start
= this_command_key_count
;
896 echo_truncate (before_command_echo_length_1
);
897 before_command_restore_flag
= 0;
901 if (this_command_key_count
>= ASIZE (this_command_keys
))
902 this_command_keys
= larger_vector (this_command_keys
,
903 2 * ASIZE (this_command_keys
),
906 ASET (this_command_keys
, this_command_key_count
, key
);
907 ++this_command_key_count
;
912 recursive_edit_1 (void)
914 int count
= SPECPDL_INDEX ();
917 if (command_loop_level
> 0)
919 specbind (Qstandard_output
, Qt
);
920 specbind (Qstandard_input
, Qt
);
923 #ifdef HAVE_WINDOW_SYSTEM
924 /* The command loop has started an hourglass timer, so we have to
925 cancel it here, otherwise it will fire because the recursive edit
926 can take some time. Do not check for display_hourglass_p here,
927 because it could already be nil. */
931 /* This function may have been called from a debugger called from
932 within redisplay, for instance by Edebugging a function called
933 from fontification-functions. We want to allow redisplay in
934 the debugging session.
936 The recursive edit is left with a `(throw exit ...)'. The `exit'
937 tag is not caught anywhere in redisplay, i.e. when we leave the
938 recursive edit, the original redisplay leading to the recursive
939 edit will be unwound. The outcome should therefore be safe. */
940 specbind (Qinhibit_redisplay
, Qnil
);
943 val
= command_loop ();
945 Fsignal (Qquit
, Qnil
);
946 /* Handle throw from read_minibuf when using minibuffer
947 while it's active but we're in another window. */
949 xsignal1 (Qerror
, val
);
951 return unbind_to (count
, Qnil
);
954 /* When an auto-save happens, record the "time", and don't do again soon. */
957 record_auto_save (void)
959 last_auto_save
= num_nonmacro_input_events
;
962 /* Make an auto save happen as soon as possible at command level. */
965 force_auto_save_soon (void)
967 last_auto_save
= - auto_save_interval
- 1;
969 record_asynch_buffer_change ();
972 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
973 doc
: /* Invoke the editor command loop recursively.
974 To get out of the recursive edit, a command can do `(throw 'exit nil)';
975 that tells this function to return.
976 Alternatively, `(throw 'exit t)' makes this function signal an error.
977 This function is called by the editor initialization to begin editing. */)
980 int count
= SPECPDL_INDEX ();
983 /* If we enter while input is blocked, don't lock up here.
984 This may happen through the debugger during redisplay. */
988 command_loop_level
++;
989 update_mode_lines
= 1;
991 if (command_loop_level
992 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
993 buffer
= Fcurrent_buffer ();
997 /* If we leave recursive_edit_1 below with a `throw' for instance,
998 like it is done in the splash screen display, we have to
999 make sure that we restore single_kboard as command_loop_1
1000 would have done if it were left normally. */
1001 if (command_loop_level
> 0)
1002 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
1003 record_unwind_protect (recursive_edit_unwind
, buffer
);
1005 recursive_edit_1 ();
1006 return unbind_to (count
, Qnil
);
1010 recursive_edit_unwind (Lisp_Object buffer
)
1012 if (BUFFERP (buffer
))
1013 Fset_buffer (buffer
);
1015 command_loop_level
--;
1016 update_mode_lines
= 1;
1021 #if 0 /* These two functions are now replaced with
1022 temporarily_switch_to_single_kboard. */
1026 #if 0 /* Theory: if there's anything in Vunread_command_events,
1027 it will right away be read by read_key_sequence,
1028 and then if we do switch KBOARDS, it will go into the side
1029 queue then. So we don't need to do anything special here -- rms. */
1030 if (CONSP (Vunread_command_events
))
1032 current_kboard
->kbd_queue
1033 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1034 current_kboard
->kbd_queue_has_data
= 1;
1036 Vunread_command_events
= Qnil
;
1041 /* Switch to the single-kboard state, making current_kboard
1042 the only KBOARD from which further input is accepted. */
1045 single_kboard_state ()
1051 /* If we're in single_kboard state for kboard KBOARD,
1055 not_single_kboard_state (KBOARD
*kboard
)
1057 if (kboard
== current_kboard
)
1061 /* Maintain a stack of kboards, so other parts of Emacs
1062 can switch temporarily to the kboard of a given frame
1063 and then revert to the previous status. */
1068 struct kboard_stack
*next
;
1071 static struct kboard_stack
*kboard_stack
;
1074 push_kboard (struct kboard
*k
)
1076 struct kboard_stack
*p
1077 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1079 p
->next
= kboard_stack
;
1080 p
->kboard
= current_kboard
;
1090 struct kboard_stack
*p
= kboard_stack
;
1092 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
1094 if (t
->kboard
== p
->kboard
)
1096 current_kboard
= p
->kboard
;
1103 /* The terminal we remembered has been deleted. */
1104 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1107 kboard_stack
= p
->next
;
1111 /* Switch to single_kboard mode, making current_kboard the only KBOARD
1112 from which further input is accepted. If F is non-nil, set its
1113 KBOARD as the current keyboard.
1115 This function uses record_unwind_protect to return to the previous
1118 If Emacs is already in single_kboard mode, and F's keyboard is
1119 locked, then this function will throw an errow. */
1122 temporarily_switch_to_single_kboard (struct frame
*f
)
1124 int was_locked
= single_kboard
;
1127 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
1128 /* We can not switch keyboards while in single_kboard mode.
1129 In rare cases, Lisp code may call `recursive-edit' (or
1130 `read-minibuffer' or `y-or-n-p') after it switched to a
1131 locked frame. For example, this is likely to happen
1132 when server.el connects to a new terminal while Emacs is in
1133 single_kboard mode. It is best to throw an error instead
1134 of presenting the user with a frozen screen. */
1135 error ("Terminal %d is locked, cannot read from it",
1136 FRAME_TERMINAL (f
)->id
);
1138 /* This call is unnecessary, but helps
1139 `restore_kboard_configuration' discover if somebody changed
1140 `current_kboard' behind our back. */
1141 push_kboard (current_kboard
);
1144 current_kboard
= FRAME_KBOARD (f
);
1146 record_unwind_protect (restore_kboard_configuration
,
1147 (was_locked
? Qt
: Qnil
));
1150 #if 0 /* This function is not needed anymore. */
1152 record_single_kboard_state ()
1155 push_kboard (current_kboard
);
1156 record_unwind_protect (restore_kboard_configuration
,
1157 (single_kboard
? Qt
: Qnil
));
1162 restore_kboard_configuration (Lisp_Object was_locked
)
1164 if (NILP (was_locked
))
1168 struct kboard
*prev
= current_kboard
;
1171 /* The pop should not change the kboard. */
1172 if (single_kboard
&& current_kboard
!= prev
)
1179 /* Handle errors that are not handled at inner levels
1180 by printing an error message and returning to the editor command loop. */
1183 cmd_error (Lisp_Object data
)
1185 Lisp_Object old_level
, old_length
;
1186 char macroerror
[50];
1188 #ifdef HAVE_WINDOW_SYSTEM
1189 if (display_hourglass_p
)
1190 cancel_hourglass ();
1193 if (!NILP (executing_kbd_macro
))
1195 if (executing_kbd_macro_iterations
== 1)
1196 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1198 sprintf (macroerror
, "After %d kbd macro iterations: ",
1199 executing_kbd_macro_iterations
);
1204 Vstandard_output
= Qt
;
1205 Vstandard_input
= Qt
;
1206 Vexecuting_kbd_macro
= Qnil
;
1207 executing_kbd_macro
= Qnil
;
1208 current_kboard
->Vprefix_arg
= Qnil
;
1209 current_kboard
->Vlast_prefix_arg
= Qnil
;
1212 /* Avoid unquittable loop if data contains a circular list. */
1213 old_level
= Vprint_level
;
1214 old_length
= Vprint_length
;
1215 XSETFASTINT (Vprint_level
, 10);
1216 XSETFASTINT (Vprint_length
, 10);
1217 cmd_error_internal (data
, macroerror
);
1218 Vprint_level
= old_level
;
1219 Vprint_length
= old_length
;
1223 Vinhibit_quit
= Qnil
;
1224 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1225 if (command_loop_level
== 0 && minibuf_level
== 0)
1226 any_kboard_state ();
1229 return make_number (0);
1232 /* Take actions on handling an error. DATA is the data that describes
1235 CONTEXT is a C-string containing ASCII characters only which
1236 describes the context in which the error happened. If we need to
1237 generalize CONTEXT to allow multibyte characters, make it a Lisp
1241 cmd_error_internal (Lisp_Object data
, char *context
)
1243 struct frame
*sf
= SELECTED_FRAME ();
1245 /* The immediate context is not interesting for Quits,
1246 since they are asyncronous. */
1247 if (EQ (XCAR (data
), Qquit
))
1248 Vsignaling_function
= Qnil
;
1253 /* Use user's specified output function if any. */
1254 if (!NILP (Vcommand_error_function
))
1255 call3 (Vcommand_error_function
, data
,
1256 context
? build_string (context
) : empty_unibyte_string
,
1257 Vsignaling_function
);
1258 /* If the window system or terminal frame hasn't been initialized
1259 yet, or we're not interactive, write the message to stderr and exit. */
1260 else if (!sf
->glyphs_initialized_p
1261 /* The initial frame is a special non-displaying frame. It
1262 will be current in daemon mode when there are no frames
1263 to display, and in non-daemon mode before the real frame
1264 has finished initializing. If an error is thrown in the
1265 latter case while creating the frame, then the frame
1266 will never be displayed, so the safest thing to do is
1267 write to stderr and quit. In daemon mode, there are
1268 many other potential errors that do not prevent frames
1269 from being created, so continuing as normal is better in
1271 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1274 print_error_message (data
, Qexternal_debugging_output
,
1275 context
, Vsignaling_function
);
1276 Fterpri (Qexternal_debugging_output
);
1277 Fkill_emacs (make_number (-1));
1281 clear_message (1, 0);
1283 message_log_maybe_newline ();
1286 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1289 Vsignaling_function
= Qnil
;
1292 Lisp_Object
command_loop_1 (void);
1293 Lisp_Object
command_loop_2 (Lisp_Object
);
1294 Lisp_Object
top_level_1 (Lisp_Object
);
1296 /* Entry to editor-command-loop.
1297 This level has the catches for exiting/returning to editor command loop.
1298 It returns nil to exit recursive edit, t to abort it. */
1303 if (command_loop_level
> 0 || minibuf_level
> 0)
1306 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1307 executing_kbd_macro
= Qnil
;
1313 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1314 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1315 /* Reset single_kboard in case top-level set it while
1316 evaluating an -f option, or we are stuck there for some
1318 any_kboard_state ();
1320 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1321 executing_kbd_macro
= Qnil
;
1323 /* End of file in -batch run causes exit here. */
1329 /* Here we catch errors in execution of commands within the
1330 editing loop, and reenter the editing loop.
1331 When there is an error, cmd_error runs and returns a non-nil
1332 value to us. A value of nil means that command_loop_1 itself
1333 returned due to end of file (or end of kbd macro). */
1336 command_loop_2 (Lisp_Object ignore
)
1338 register Lisp_Object val
;
1341 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1342 while (!NILP (val
));
1350 return Feval (Vtop_level
);
1354 top_level_1 (Lisp_Object ignore
)
1356 /* On entry to the outer level, run the startup file */
1357 if (!NILP (Vtop_level
))
1358 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1359 else if (!NILP (Vpurify_flag
))
1360 message ("Bare impure Emacs (standard Lisp code not loaded)");
1362 message ("Bare Emacs (standard Lisp code not loaded)");
1366 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1367 doc
: /* Exit all recursive editing levels.
1368 This also exits all active minibuffers. */)
1371 #ifdef HAVE_WINDOW_SYSTEM
1372 if (display_hourglass_p
)
1373 cancel_hourglass ();
1376 /* Unblock input if we enter with input blocked. This may happen if
1377 redisplay traps e.g. during tool-bar update with input blocked. */
1378 while (INPUT_BLOCKED_P
)
1381 return Fthrow (Qtop_level
, Qnil
);
1384 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1385 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1388 if (command_loop_level
> 0 || minibuf_level
> 0)
1389 Fthrow (Qexit
, Qnil
);
1391 error ("No recursive edit is in progress");
1395 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1396 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1399 if (command_loop_level
> 0 || minibuf_level
> 0)
1402 error ("No recursive edit is in progress");
1406 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1408 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1409 of this function. */
1412 tracking_off (Lisp_Object old_value
)
1414 do_mouse_tracking
= old_value
;
1415 if (NILP (old_value
))
1417 /* Redisplay may have been preempted because there was input
1418 available, and it assumes it will be called again after the
1419 input has been processed. If the only input available was
1420 the sort that we have just disabled, then we need to call
1422 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1424 redisplay_preserve_echo_area (6);
1425 get_input_pending (&input_pending
,
1426 READABLE_EVENTS_DO_TIMERS_NOW
);
1432 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1433 doc
: /* Evaluate BODY with mouse movement events enabled.
1434 Within a `track-mouse' form, mouse motion generates input events that
1435 you can read with `read-event'.
1436 Normally, mouse motion is ignored.
1437 usage: (track-mouse BODY...) */)
1441 int count
= SPECPDL_INDEX ();
1444 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1446 do_mouse_tracking
= Qt
;
1448 val
= Fprogn (args
);
1449 return unbind_to (count
, val
);
1452 /* If mouse has moved on some frame, return one of those frames.
1456 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1457 after resizing the tool-bar window. */
1459 int ignore_mouse_drag_p
;
1462 some_mouse_moved (void)
1464 Lisp_Object tail
, frame
;
1466 if (ignore_mouse_drag_p
)
1468 /* ignore_mouse_drag_p = 0; */
1472 FOR_EACH_FRAME (tail
, frame
)
1474 if (XFRAME (frame
)->mouse_moved
)
1475 return XFRAME (frame
);
1481 #endif /* HAVE_MOUSE || HAVE_GPM */
1483 /* This is the actual command reading loop,
1484 sans error-handling encapsulation. */
1486 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1488 void safe_run_hooks (Lisp_Object
);
1489 static void adjust_point_for_property (int, int);
1491 /* Cancel hourglass from protect_unwind.
1493 #ifdef HAVE_WINDOW_SYSTEM
1495 cancel_hourglass_unwind (Lisp_Object arg
)
1497 cancel_hourglass ();
1503 command_loop_1 (void)
1506 Lisp_Object keybuf
[30];
1508 int prev_modiff
= 0;
1509 struct buffer
*prev_buffer
= NULL
;
1510 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1511 int was_locked
= single_kboard
;
1513 int already_adjusted
= 0;
1515 current_kboard
->Vprefix_arg
= Qnil
;
1516 current_kboard
->Vlast_prefix_arg
= Qnil
;
1517 Vdeactivate_mark
= Qnil
;
1518 waiting_for_input
= 0;
1521 this_command_key_count
= 0;
1522 this_command_key_count_reset
= 0;
1523 this_single_command_key_start
= 0;
1525 if (NILP (Vmemory_full
))
1527 /* Make sure this hook runs after commands that get errors and
1528 throw to top level. */
1529 /* Note that the value cell will never directly contain nil
1530 if the symbol is a local variable. */
1531 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1532 safe_run_hooks (Qpost_command_hook
);
1534 /* If displaying a message, resize the echo area window to fit
1535 that message's size exactly. */
1536 if (!NILP (echo_area_buffer
[0]))
1537 resize_echo_area_exactly ();
1539 if (!NILP (Vdeferred_action_list
))
1540 safe_run_hooks (Qdeferred_action_function
);
1543 /* Do this after running Vpost_command_hook, for consistency. */
1544 current_kboard
->Vlast_command
= Vthis_command
;
1545 current_kboard
->Vreal_last_command
= real_this_command
;
1546 if (!CONSP (last_command_event
))
1547 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1551 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1554 /* Make sure the current window's buffer is selected. */
1555 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1556 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1558 /* Display any malloc warning that just came out. Use while because
1559 displaying one warning can cause another. */
1561 while (pending_malloc_warning
)
1562 display_malloc_warning ();
1564 Vdeactivate_mark
= Qnil
;
1566 /* If minibuffer on and echo area in use,
1567 wait a short time and redraw minibuffer. */
1570 && !NILP (echo_area_buffer
[0])
1571 && EQ (minibuf_window
, echo_area_window
)
1572 && NUMBERP (Vminibuffer_message_timeout
))
1574 /* Bind inhibit-quit to t so that C-g gets read in
1575 rather than quitting back to the minibuffer. */
1576 int count
= SPECPDL_INDEX ();
1577 specbind (Qinhibit_quit
, Qt
);
1579 sit_for (Vminibuffer_message_timeout
, 0, 2);
1581 /* Clear the echo area. */
1583 safe_run_hooks (Qecho_area_clear_hook
);
1585 unbind_to (count
, Qnil
);
1587 /* If a C-g came in before, treat it as input now. */
1588 if (!NILP (Vquit_flag
))
1591 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1596 /* Select the frame that the last event came from. Usually,
1597 switch-frame events will take care of this, but if some lisp
1598 code swallows a switch-frame event, we'll fix things up here.
1599 Is this a good idea? */
1600 if (FRAMEP (internal_last_event_frame
)
1601 && !EQ (internal_last_event_frame
, selected_frame
))
1602 Fselect_frame (internal_last_event_frame
, Qnil
);
1604 /* If it has changed current-menubar from previous value,
1605 really recompute the menubar from the value. */
1606 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1607 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1608 call0 (Qrecompute_lucid_menubar
);
1610 before_command_key_count
= this_command_key_count
;
1611 before_command_echo_length
= echo_length ();
1613 Vthis_command
= Qnil
;
1614 real_this_command
= Qnil
;
1615 Vthis_original_command
= Qnil
;
1616 Vthis_command_keys_shift_translated
= Qnil
;
1618 /* Read next key sequence; i gets its length. */
1619 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1622 /* A filter may have run while we were reading the input. */
1623 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1625 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1626 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1630 /* Now we have read a key sequence of length I,
1631 or else I is 0 and we found end of file. */
1633 if (i
== 0) /* End of file -- happens only in */
1634 return Qnil
; /* a kbd macro, at the end. */
1635 /* -1 means read_key_sequence got a menu that was rejected.
1636 Just loop around and read another command. */
1640 this_command_key_count
= 0;
1641 this_command_key_count_reset
= 0;
1642 this_single_command_key_start
= 0;
1646 last_command_event
= keybuf
[i
- 1];
1648 /* If the previous command tried to force a specific window-start,
1649 forget about that, in case this command moves point far away
1650 from that position. But also throw away beg_unchanged and
1651 end_unchanged information in that case, so that redisplay will
1652 update the whole window properly. */
1653 if (!NILP (XWINDOW (selected_window
)->force_start
))
1656 XWINDOW (selected_window
)->force_start
= Qnil
;
1657 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1658 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1661 cmd
= read_key_sequence_cmd
;
1662 if (!NILP (Vexecuting_kbd_macro
))
1664 if (!NILP (Vquit_flag
))
1666 Vexecuting_kbd_macro
= Qt
;
1667 QUIT
; /* Make some noise. */
1668 /* Will return since macro now empty. */
1672 /* Do redisplay processing after this command except in special
1673 cases identified below. */
1674 prev_buffer
= current_buffer
;
1675 prev_modiff
= MODIFF
;
1676 last_point_position
= PT
;
1677 last_point_position_window
= selected_window
;
1678 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1680 /* By default, we adjust point to a boundary of a region that
1681 has such a property that should be treated intangible
1682 (e.g. composition, display). But, some commands will set
1683 this variable differently. */
1684 Vdisable_point_adjustment
= Qnil
;
1686 /* Process filters and timers may have messed with deactivate-mark.
1687 reset it before we execute the command. */
1688 Vdeactivate_mark
= Qnil
;
1690 /* Remap command through active keymaps */
1691 Vthis_original_command
= cmd
;
1695 if (cmd1
= Fcommand_remapping (cmd
, Qnil
, Qnil
), !NILP (cmd1
))
1699 /* Execute the command. */
1701 Vthis_command
= cmd
;
1702 real_this_command
= cmd
;
1703 /* Note that the value cell will never directly contain nil
1704 if the symbol is a local variable. */
1705 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1706 safe_run_hooks (Qpre_command_hook
);
1708 already_adjusted
= 0;
1710 if (NILP (Vthis_command
))
1712 /* nil means key is undefined. */
1713 Lisp_Object keys
= Fvector (i
, keybuf
);
1714 keys
= Fkey_description (keys
, Qnil
);
1716 message_with_string ("%s is undefined", keys
, 0);
1717 current_kboard
->defining_kbd_macro
= Qnil
;
1718 update_mode_lines
= 1;
1719 current_kboard
->Vprefix_arg
= Qnil
;
1723 /* Here for a command that isn't executed directly */
1725 #ifdef HAVE_WINDOW_SYSTEM
1726 int scount
= SPECPDL_INDEX ();
1728 if (display_hourglass_p
1729 && NILP (Vexecuting_kbd_macro
))
1731 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1736 if (NILP (current_kboard
->Vprefix_arg
)) /* FIXME: Why? --Stef */
1738 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1740 #ifdef HAVE_WINDOW_SYSTEM
1741 /* Do not check display_hourglass_p here, because
1742 Fcommand_execute could change it, but we should cancel
1743 hourglass cursor anyway.
1744 But don't cancel the hourglass within a macro
1745 just because a command in the macro finishes. */
1746 if (NILP (Vexecuting_kbd_macro
))
1747 unbind_to (scount
, Qnil
);
1750 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1752 /* Note that the value cell will never directly contain nil
1753 if the symbol is a local variable. */
1754 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1755 safe_run_hooks (Qpost_command_hook
);
1757 /* If displaying a message, resize the echo area window to fit
1758 that message's size exactly. */
1759 if (!NILP (echo_area_buffer
[0]))
1760 resize_echo_area_exactly ();
1762 if (!NILP (Vdeferred_action_list
))
1763 safe_run_hooks (Qdeferred_action_function
);
1765 /* If there is a prefix argument,
1766 1) We don't want Vlast_command to be ``universal-argument''
1767 (that would be dumb), so don't set Vlast_command,
1768 2) we want to leave echoing on so that the prefix will be
1769 echoed as part of this key sequence, so don't call
1771 3) we want to leave this_command_key_count non-zero, so that
1772 read_char will realize that it is re-reading a character, and
1773 not echo it a second time.
1775 If the command didn't actually create a prefix arg,
1776 but is merely a frame event that is transparent to prefix args,
1777 then the above doesn't apply. */
1778 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_event
))
1780 current_kboard
->Vlast_command
= Vthis_command
;
1781 current_kboard
->Vreal_last_command
= real_this_command
;
1782 if (!CONSP (last_command_event
))
1783 current_kboard
->Vlast_repeatable_command
= real_this_command
;
1785 this_command_key_count
= 0;
1786 this_command_key_count_reset
= 0;
1787 this_single_command_key_start
= 0;
1790 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1792 /* In Emacs 22, setting transient-mark-mode to `only' was a
1793 way of turning it on for just one command. This usage is
1794 obsolete, but support it anyway. */
1795 if (EQ (Vtransient_mark_mode
, Qidentity
))
1796 Vtransient_mark_mode
= Qnil
;
1797 else if (EQ (Vtransient_mark_mode
, Qonly
))
1798 Vtransient_mark_mode
= Qidentity
;
1800 if (!NILP (Vdeactivate_mark
))
1801 call0 (Qdeactivate_mark
);
1802 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1803 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1808 if (current_buffer
== prev_buffer
1809 && last_point_position
!= PT
1810 && NILP (Vdisable_point_adjustment
)
1811 && NILP (Vglobal_disable_point_adjustment
))
1813 if (last_point_position
> BEGV
1814 && last_point_position
< ZV
1815 && (composition_adjust_point (last_point_position
,
1816 last_point_position
)
1817 != last_point_position
))
1818 /* The last point was temporarily set within a grapheme
1819 cluster to prevent automatic composition. To recover
1820 the automatic composition, we must update the
1822 windows_or_buffers_changed
++;
1823 if (!already_adjusted
)
1824 adjust_point_for_property (last_point_position
,
1825 MODIFF
!= prev_modiff
);
1828 /* Install chars successfully executed in kbd macro. */
1830 if (!NILP (current_kboard
->defining_kbd_macro
)
1831 && NILP (current_kboard
->Vprefix_arg
))
1832 finalize_kbd_macro_chars ();
1833 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1835 any_kboard_state ();
1840 extern Lisp_Object Qcomposition
, Qdisplay
;
1842 /* Adjust point to a boundary of a region that has such a property
1843 that should be treated intangible. For the moment, we check
1844 `composition', `display' and `invisible' properties.
1845 LAST_PT is the last position of point. */
1847 extern Lisp_Object Qafter_string
, Qbefore_string
;
1848 extern Lisp_Object
get_pos_property (Lisp_Object
, Lisp_Object
, Lisp_Object
);
1851 adjust_point_for_property (int last_pt
, int modified
)
1854 Lisp_Object val
, overlay
, tmp
;
1855 /* When called after buffer modification, we should temporarily
1856 suppress the point adjustment for automatic composition so that a
1857 user can keep inserting another character at point or keep
1858 deleting characters around point. */
1859 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1862 /* FIXME: cycling is probably not necessary because these properties
1863 can't be usefully combined anyway. */
1864 while (check_composition
|| check_display
|| check_invisible
)
1866 /* FIXME: check `intangible'. */
1867 if (check_composition
1868 && PT
> BEGV
&& PT
< ZV
1869 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1872 check_display
= check_invisible
= 1;
1874 check_composition
= 0;
1876 && PT
> BEGV
&& PT
< ZV
1877 && !NILP (val
= get_char_property_and_overlay
1878 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1879 && display_prop_intangible_p (val
)
1880 && (!OVERLAYP (overlay
)
1881 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1882 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1883 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1884 && (beg
< PT
/* && end > PT <- It's always the case. */
1885 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1888 SET_PT (PT
< last_pt
1889 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1891 check_composition
= check_invisible
= 1;
1894 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1896 int inv
, ellipsis
= 0;
1899 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1902 /* FIXME: We should stop if we find a spot between
1903 two runs of `invisible' where inserted text would
1904 be visible. This is important when we have two
1905 invisible boundaries that enclose an area: if the
1906 area is empty, we need this test in order to make
1907 it possible to place point in the middle rather
1908 than skip both boundaries. However, this code
1909 also stops anywhere in a non-sticky text-property,
1910 which breaks (e.g.) Org mode. */
1911 && (val
= get_pos_property (make_number (end
),
1913 TEXT_PROP_MEANS_INVISIBLE (val
))
1915 && !NILP (val
= get_char_property_and_overlay
1916 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1917 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1919 ellipsis
= ellipsis
|| inv
> 1
1920 || (OVERLAYP (overlay
)
1921 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1922 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1923 tmp
= Fnext_single_char_property_change
1924 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1925 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1929 && (val
= get_pos_property (make_number (beg
),
1931 TEXT_PROP_MEANS_INVISIBLE (val
))
1933 && !NILP (val
= get_char_property_and_overlay
1934 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1935 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1937 ellipsis
= ellipsis
|| inv
> 1
1938 || (OVERLAYP (overlay
)
1939 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1940 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1941 tmp
= Fprevious_single_char_property_change
1942 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1943 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1946 /* Move away from the inside area. */
1947 if (beg
< PT
&& end
> PT
)
1949 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1950 /* We haven't moved yet (so we don't need to fear
1951 infinite-looping) and we were outside the range
1952 before (so either end of the range still corresponds
1953 to a move in the right direction): pretend we moved
1954 less than we actually did, so that we still have
1955 more freedom below in choosing which end of the range
1957 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1958 /* We either have moved already or the last point
1959 was already in the range: we don't get to choose
1960 which end of the range we have to go to. */
1961 : (PT
< last_pt
? beg
: end
));
1962 check_composition
= check_display
= 1;
1964 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1965 the point to something other than its argument, due to
1966 point-motion hooks, intangibility, etc. */
1967 xassert (PT
== beg
|| PT
== end
);
1970 /* Pretend the area doesn't exist if the buffer is not
1972 if (!modified
&& !ellipsis
&& beg
< end
)
1974 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1975 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1976 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1977 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1978 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1979 /* We've already moved as far as we can. Trying to go
1980 to the other end would mean moving backwards and thus
1981 could lead to an infinite loop. */
1983 else if (val
= get_pos_property (make_number (PT
),
1985 TEXT_PROP_MEANS_INVISIBLE (val
)
1986 && (val
= get_pos_property
1987 (make_number (PT
== beg
? end
: beg
),
1989 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1990 (check_composition
= check_display
= 1,
1991 SET_PT (PT
== beg
? end
: beg
));
1994 check_invisible
= 0;
1998 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2001 safe_run_hooks_1 (void)
2003 if (NILP (Vrun_hooks
))
2005 return call1 (Vrun_hooks
, Vinhibit_quit
);
2008 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2011 safe_run_hooks_error (Lisp_Object data
)
2013 Lisp_Object args
[3];
2014 args
[0] = build_string ("Error in %s: %s");
2015 args
[1] = Vinhibit_quit
;
2018 return Fset (Vinhibit_quit
, Qnil
);
2021 /* If we get an error while running the hook, cause the hook variable
2022 to be nil. Also inhibit quits, so that C-g won't cause the hook
2023 to mysteriously evaporate. */
2026 safe_run_hooks (Lisp_Object hook
)
2028 int count
= SPECPDL_INDEX ();
2029 specbind (Qinhibit_quit
, hook
);
2031 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2033 unbind_to (count
, Qnil
);
2037 /* Number of seconds between polling for input. This is a Lisp
2038 variable that can be bound. */
2040 EMACS_INT polling_period
;
2042 /* Nonzero means polling for input is temporarily suppressed. */
2044 int poll_suppress_count
;
2046 /* Asynchronous timer for polling. */
2048 struct atimer
*poll_timer
;
2051 #ifdef POLL_FOR_INPUT
2053 /* Poll for input, so that we catch a C-g if it comes in. This
2054 function is called from x_make_frame_visible, see comment
2058 poll_for_input_1 (void)
2060 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2061 doing anything dangerous. */
2065 if (interrupt_input_blocked
== 0
2066 && !waiting_for_input
)
2067 read_avail_input (0);
2073 /* Timer callback function for poll_timer. TIMER is equal to
2077 poll_for_input (struct atimer
*timer
)
2079 if (poll_suppress_count
== 0)
2082 interrupt_input_pending
= 1;
2083 pending_signals
= 1;
2085 poll_for_input_1 ();
2090 #endif /* POLL_FOR_INPUT */
2092 /* Begin signals to poll for input, if they are appropriate.
2093 This function is called unconditionally from various places. */
2096 start_polling (void)
2098 #ifdef POLL_FOR_INPUT
2099 /* XXX This condition was (read_socket_hook && !interrupt_input),
2100 but read_socket_hook is not global anymore. Let's pretend that
2102 if (!interrupt_input
)
2104 /* Turn alarm handling on unconditionally. It might have
2105 been turned off in process.c. */
2106 turn_on_atimers (1);
2108 /* If poll timer doesn't exist, are we need one with
2109 a different interval, start a new one. */
2110 if (poll_timer
== NULL
2111 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2113 EMACS_TIME interval
;
2116 cancel_atimer (poll_timer
);
2118 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2119 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2120 poll_for_input
, NULL
);
2123 /* Let the timer's callback function poll for input
2124 if this becomes zero. */
2125 --poll_suppress_count
;
2130 /* Nonzero if we are using polling to handle input asynchronously. */
2133 input_polling_used (void)
2135 #ifdef POLL_FOR_INPUT
2136 /* XXX This condition was (read_socket_hook && !interrupt_input),
2137 but read_socket_hook is not global anymore. Let's pretend that
2139 return !interrupt_input
;
2145 /* Turn off polling. */
2150 #ifdef POLL_FOR_INPUT
2151 /* XXX This condition was (read_socket_hook && !interrupt_input),
2152 but read_socket_hook is not global anymore. Let's pretend that
2154 if (!interrupt_input
)
2155 ++poll_suppress_count
;
2159 /* Set the value of poll_suppress_count to COUNT
2160 and start or stop polling accordingly. */
2163 set_poll_suppress_count (int count
)
2165 #ifdef POLL_FOR_INPUT
2166 if (count
== 0 && poll_suppress_count
!= 0)
2168 poll_suppress_count
= 1;
2171 else if (count
!= 0 && poll_suppress_count
== 0)
2175 poll_suppress_count
= count
;
2179 /* Bind polling_period to a value at least N.
2180 But don't decrease it. */
2183 bind_polling_period (int n
)
2185 #ifdef POLL_FOR_INPUT
2186 int new = polling_period
;
2191 stop_other_atimers (poll_timer
);
2193 specbind (Qpolling_period
, make_number (new));
2194 /* Start a new alarm with the new period. */
2199 /* Apply the control modifier to CHARACTER. */
2202 make_ctrl_char (int c
)
2204 /* Save the upper bits here. */
2205 int upper
= c
& ~0177;
2207 if (! ASCII_BYTE_P (c
))
2208 return c
|= ctrl_modifier
;
2212 /* Everything in the columns containing the upper-case letters
2213 denotes a control character. */
2214 if (c
>= 0100 && c
< 0140)
2218 /* Set the shift modifier for a control char
2219 made from a shifted letter. But only for letters! */
2220 if (oc
>= 'A' && oc
<= 'Z')
2221 c
|= shift_modifier
;
2224 /* The lower-case letters denote control characters too. */
2225 else if (c
>= 'a' && c
<= 'z')
2228 /* Include the bits for control and shift
2229 only if the basic ASCII code can't indicate them. */
2233 /* Replace the high bits. */
2234 c
|= (upper
& ~ctrl_modifier
);
2239 /* Display the help-echo property of the character after the mouse pointer.
2240 Either show it in the echo area, or call show-help-function to display
2241 it by other means (maybe in a tooltip).
2243 If HELP is nil, that means clear the previous help echo.
2245 If HELP is a string, display that string. If HELP is a function,
2246 call it with OBJECT and POS as arguments; the function should
2247 return a help string or nil for none. For all other types of HELP,
2248 evaluate it to obtain a string.
2250 WINDOW is the window in which the help was generated, if any.
2251 It is nil if not in a window.
2253 If OBJECT is a buffer, POS is the position in the buffer where the
2254 `help-echo' text property was found.
2256 If OBJECT is an overlay, that overlay has a `help-echo' property,
2257 and POS is the position in the overlay's buffer under the mouse.
2259 If OBJECT is a string (an overlay string or a string displayed with
2260 the `display' property). POS is the position in that string under
2263 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2264 echo overwrites a keystroke echo currently displayed in the echo
2267 Note: this function may only be called with HELP nil or a string
2268 from X code running asynchronously. */
2271 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2272 Lisp_Object pos
, int ok_to_overwrite_keystroke_echo
)
2274 if (!NILP (help
) && !STRINGP (help
))
2276 if (FUNCTIONP (help
))
2278 Lisp_Object args
[4];
2283 help
= safe_call (4, args
);
2286 help
= safe_eval (help
);
2288 if (!STRINGP (help
))
2292 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2293 if (!noninteractive
&& STRINGP (help
))
2295 /* The mouse-fixup-help-message Lisp function can call
2296 mouse_position_hook, which resets the mouse_moved flags.
2297 This causes trouble if we are trying to read a mouse motion
2298 event (i.e., if we are inside a `track-mouse' form), so we
2299 restore the mouse_moved flag. */
2300 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2301 help
= call1 (Qmouse_fixup_help_message
, help
);
2307 if (STRINGP (help
) || NILP (help
))
2309 if (!NILP (Vshow_help_function
))
2310 call1 (Vshow_help_function
, help
);
2311 help_echo_showing_p
= STRINGP (help
);
2317 /* Input of single characters from keyboard */
2319 Lisp_Object
print_help (Lisp_Object object
);
2320 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2321 struct timeval
*end_time
);
2322 static void record_char (Lisp_Object c
);
2324 static Lisp_Object help_form_saved_window_configs
;
2326 read_char_help_form_unwind (Lisp_Object arg
)
2328 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2329 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2330 if (!NILP (window_config
))
2331 Fset_window_configuration (window_config
);
2335 #define STOP_POLLING \
2336 do { if (! polling_stopped_here) stop_polling (); \
2337 polling_stopped_here = 1; } while (0)
2339 #define RESUME_POLLING \
2340 do { if (polling_stopped_here) start_polling (); \
2341 polling_stopped_here = 0; } while (0)
2343 /* read a character from the keyboard; call the redisplay if needed */
2344 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2345 -1 means do not do redisplay, but do do autosaving.
2348 /* The arguments MAPS and NMAPS are for menu prompting.
2349 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2351 PREV_EVENT is the previous input event, or nil if we are reading
2352 the first event of a key sequence (or not reading a key sequence).
2353 If PREV_EVENT is t, that is a "magic" value that says
2354 not to run input methods, but in other respects to act as if
2355 not reading a key sequence.
2357 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2358 if we used a mouse menu to read the input, or zero otherwise. If
2359 USED_MOUSE_MENU is null, we don't dereference it.
2361 Value is -2 when we find input on another keyboard. A second call
2362 to read_char will read it.
2364 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2365 specifying the maximum time to wait until. If no input arrives by
2366 that time, stop waiting and return nil.
2368 Value is t if we showed a menu and the user rejected it. */
2371 read_char (int commandflag
, int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
2372 int *used_mouse_menu
, struct timeval
*end_time
)
2374 volatile Lisp_Object c
;
2375 int count
, jmpcount
;
2376 jmp_buf local_getcjmp
;
2378 volatile int key_already_recorded
= 0;
2379 Lisp_Object tem
, save
;
2380 volatile Lisp_Object previous_echo_area_message
;
2381 volatile Lisp_Object also_record
;
2382 volatile int reread
;
2383 struct gcpro gcpro1
, gcpro2
;
2384 int polling_stopped_here
= 0;
2385 struct kboard
*orig_kboard
= current_kboard
;
2389 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2390 before_command_key_count
= this_command_key_count
;
2391 before_command_echo_length
= echo_length ();
2394 previous_echo_area_message
= Qnil
;
2396 GCPRO2 (c
, previous_echo_area_message
);
2401 if (CONSP (Vunread_post_input_method_events
))
2403 c
= XCAR (Vunread_post_input_method_events
);
2404 Vunread_post_input_method_events
2405 = XCDR (Vunread_post_input_method_events
);
2407 /* Undo what read_char_x_menu_prompt did when it unread
2408 additional keys returned by Fx_popup_menu. */
2410 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2418 if (unread_command_char
!= -1)
2420 XSETINT (c
, unread_command_char
);
2421 unread_command_char
= -1;
2427 if (CONSP (Vunread_command_events
))
2429 int was_disabled
= 0;
2431 c
= XCAR (Vunread_command_events
);
2432 Vunread_command_events
= XCDR (Vunread_command_events
);
2436 /* Undo what sit-for did when it unread additional keys
2437 inside universal-argument. */
2440 && EQ (XCAR (c
), Qt
))
2446 /* Undo what read_char_x_menu_prompt did when it unread
2447 additional keys returned by Fx_popup_menu. */
2449 && EQ (XCDR (c
), Qdisabled
)
2450 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2456 /* If the queued event is something that used the mouse,
2457 set used_mouse_menu accordingly. */
2459 /* Also check was_disabled so last-nonmenu-event won't return
2460 a bad value when submenus are involved. (Bug#447) */
2461 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2462 *used_mouse_menu
= 1;
2464 goto reread_for_input_method
;
2467 if (CONSP (Vunread_input_method_events
))
2469 c
= XCAR (Vunread_input_method_events
);
2470 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2472 /* Undo what read_char_x_menu_prompt did when it unread
2473 additional keys returned by Fx_popup_menu. */
2475 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2479 goto reread_for_input_method
;
2482 this_command_key_count_reset
= 0;
2484 if (!NILP (Vexecuting_kbd_macro
))
2486 /* We set this to Qmacro; since that's not a frame, nobody will
2487 try to switch frames on us, and the selected window will
2490 Since this event came from a macro, it would be misleading to
2491 leave internal_last_event_frame set to wherever the last
2492 real event came from. Normally, a switch-frame event selects
2493 internal_last_event_frame after each command is read, but
2494 events read from a macro should never cause a new frame to be
2496 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2498 /* Exit the macro if we are at the end.
2499 Also, some things replace the macro with t
2500 to force an early exit. */
2501 if (EQ (Vexecuting_kbd_macro
, Qt
)
2502 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2508 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2509 if (STRINGP (Vexecuting_kbd_macro
)
2510 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2511 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2513 executing_kbd_macro_index
++;
2518 if (!NILP (unread_switch_frame
))
2520 c
= unread_switch_frame
;
2521 unread_switch_frame
= Qnil
;
2523 /* This event should make it into this_command_keys, and get echoed
2524 again, so we do not set `reread'. */
2528 /* if redisplay was requested */
2529 if (commandflag
>= 0)
2531 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2533 /* If there is pending input, process any events which are not
2534 user-visible, such as X selection_request events. */
2536 || detect_input_pending_run_timers (0))
2537 swallow_events (0); /* may clear input_pending */
2539 /* Redisplay if no pending input. */
2540 while (!input_pending
)
2542 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2543 redisplay_preserve_echo_area (5);
2548 /* Normal case: no input arrived during redisplay. */
2551 /* Input arrived and pre-empted redisplay.
2552 Process any events which are not user-visible. */
2554 /* If that cleared input_pending, try again to redisplay. */
2557 /* Prevent the redisplay we just did
2558 from messing up echoing of the input after the prompt. */
2559 if (commandflag
== 0 && echo_current
)
2560 echo_message_buffer
= echo_area_buffer
[0];
2564 /* Message turns off echoing unless more keystrokes turn it on again.
2566 The code in 20.x for the condition was
2568 1. echo_area_glyphs && *echo_area_glyphs
2569 2. && echo_area_glyphs != current_kboard->echobuf
2570 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2572 (1) means there's a current message displayed
2574 (2) means it's not the message from echoing from the current
2577 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2578 is set to a non-null value. This is done in read_char and it is
2579 set to echo_area_glyphs after a call to echo_char. That means
2580 ok_to_echo_at_next_pause is either null or
2581 current_kboard->echobuf with the appropriate current_kboard at
2584 So, condition (3) means in clear text ok_to_echo_at_next_pause
2585 must be either null, or the current message isn't from echoing at
2586 all, or it's from echoing from a different kboard than the
2589 if (/* There currently is something in the echo area. */
2590 !NILP (echo_area_buffer
[0])
2591 && (/* And it's either not from echoing. */
2592 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2593 /* Or it's an echo from a different kboard. */
2594 || echo_kboard
!= current_kboard
2595 /* Or we explicitly allow overwriting whatever there is. */
2596 || ok_to_echo_at_next_pause
== NULL
))
2601 /* Try reading a character via menu prompting in the minibuf.
2602 Try this before the sit-for, because the sit-for
2603 would do the wrong thing if we are supposed to do
2604 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2605 after a mouse event so don't try a minibuf menu. */
2607 if (nmaps
> 0 && INTERACTIVE
2608 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2609 /* Don't bring up a menu if we already have another event. */
2610 && NILP (Vunread_command_events
)
2611 && unread_command_char
< 0
2612 && !detect_input_pending_run_timers (0))
2614 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2616 if (INTEGERP (c
) && XINT (c
) == -2)
2617 return c
; /* wrong_kboard_jmpbuf */
2621 key_already_recorded
= 1;
2626 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2627 We will do that below, temporarily for short sections of code,
2628 when appropriate. local_getcjmp must be in effect
2629 around any call to sit_for or kbd_buffer_get_event;
2630 it *must not* be in effect when we call redisplay. */
2632 jmpcount
= SPECPDL_INDEX ();
2633 if (_setjmp (local_getcjmp
))
2635 /* Handle quits while reading the keyboard. */
2636 /* We must have saved the outer value of getcjmp here,
2637 so restore it now. */
2638 restore_getcjmp (save_jump
);
2639 unbind_to (jmpcount
, Qnil
);
2640 XSETINT (c
, quit_char
);
2641 internal_last_event_frame
= selected_frame
;
2642 Vlast_event_frame
= internal_last_event_frame
;
2643 /* If we report the quit char as an event,
2644 don't do so more than once. */
2645 if (!NILP (Vinhibit_quit
))
2649 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2650 if (kb
!= current_kboard
)
2652 Lisp_Object link
= kb
->kbd_queue
;
2653 /* We shouldn't get here if we were in single-kboard mode! */
2658 while (CONSP (XCDR (link
)))
2660 if (!NILP (XCDR (link
)))
2664 kb
->kbd_queue
= Fcons (c
, Qnil
);
2666 XSETCDR (link
, Fcons (c
, Qnil
));
2667 kb
->kbd_queue_has_data
= 1;
2668 current_kboard
= kb
;
2669 /* This is going to exit from read_char
2670 so we had better get rid of this frame's stuff. */
2672 return make_number (-2); /* wrong_kboard_jmpbuf */
2678 /* Start idle timers if no time limit is supplied. We don't do it
2679 if a time limit is supplied to avoid an infinite recursion in the
2680 situation where an idle timer calls `sit-for'. */
2683 timer_start_idle ();
2685 /* If in middle of key sequence and minibuffer not active,
2686 start echoing if enough time elapses. */
2688 if (minibuf_level
== 0
2690 && !current_kboard
->immediate_echo
2691 && this_command_key_count
> 0
2693 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2694 && NILP (Fzerop (Vecho_keystrokes
))
2695 && (/* No message. */
2696 NILP (echo_area_buffer
[0])
2697 /* Or empty message. */
2698 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2699 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2700 /* Or already echoing from same kboard. */
2701 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2702 /* Or not echoing before and echoing allowed. */
2703 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2705 /* After a mouse event, start echoing right away.
2706 This is because we are probably about to display a menu,
2707 and we don't want to delay before doing so. */
2708 if (EVENT_HAS_PARAMETERS (prev_event
))
2714 save_getcjmp (save_jump
);
2715 restore_getcjmp (local_getcjmp
);
2716 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2717 restore_getcjmp (save_jump
);
2719 && ! CONSP (Vunread_command_events
))
2724 /* Maybe auto save due to number of keystrokes. */
2726 if (commandflag
!= 0
2727 && auto_save_interval
> 0
2728 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2729 && !detect_input_pending_run_timers (0))
2731 Fdo_auto_save (Qnil
, Qnil
);
2732 /* Hooks can actually change some buffers in auto save. */
2736 /* Try reading using an X menu.
2737 This is never confused with reading using the minibuf
2738 because the recursive call of read_char in read_char_minibuf_menu_prompt
2739 does not pass on any keymaps. */
2741 if (nmaps
> 0 && INTERACTIVE
2742 && !NILP (prev_event
)
2743 && EVENT_HAS_PARAMETERS (prev_event
)
2744 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2745 && !EQ (XCAR (prev_event
), Qtool_bar
)
2746 /* Don't bring up a menu if we already have another event. */
2747 && NILP (Vunread_command_events
)
2748 && unread_command_char
< 0)
2750 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2752 /* Now that we have read an event, Emacs is not idle. */
2759 /* Maybe autosave and/or garbage collect due to idleness. */
2761 if (INTERACTIVE
&& NILP (c
))
2763 int delay_level
, buffer_size
;
2765 /* Slow down auto saves logarithmically in size of current buffer,
2766 and garbage collect while we're at it. */
2767 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2768 last_non_minibuf_size
= Z
- BEG
;
2769 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2771 while (buffer_size
> 64)
2772 delay_level
++, buffer_size
-= buffer_size
>> 2;
2773 if (delay_level
< 4) delay_level
= 4;
2774 /* delay_level is 4 for files under around 50k, 7 at 100k,
2775 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2777 /* Auto save if enough time goes by without input. */
2778 if (commandflag
!= 0
2779 && num_nonmacro_input_events
> last_auto_save
2780 && INTEGERP (Vauto_save_timeout
)
2781 && XINT (Vauto_save_timeout
) > 0)
2784 int timeout
= delay_level
* XFASTINT (Vauto_save_timeout
) / 4;
2786 save_getcjmp (save_jump
);
2787 restore_getcjmp (local_getcjmp
);
2788 tem0
= sit_for (make_number (timeout
), 1, 1);
2789 restore_getcjmp (save_jump
);
2792 && ! CONSP (Vunread_command_events
))
2794 Fdo_auto_save (Qnil
, Qnil
);
2796 /* If we have auto-saved and there is still no input
2797 available, garbage collect if there has been enough
2798 consing going on to make it worthwhile. */
2799 if (!detect_input_pending_run_timers (0)
2800 && consing_since_gc
> gc_cons_threshold
/ 2)
2801 Fgarbage_collect ();
2808 /* Notify the caller if an autosave hook, or a timer, sentinel or
2809 filter in the sit_for calls above have changed the current
2810 kboard. This could happen if they use the minibuffer or start a
2811 recursive edit, like the fancy splash screen in server.el's
2812 filter. If this longjmp wasn't here, read_key_sequence would
2813 interpret the next key sequence using the wrong translation
2814 tables and function keymaps. */
2815 if (NILP (c
) && current_kboard
!= orig_kboard
)
2818 return make_number (-2); /* wrong_kboard_jmpbuf */
2821 /* If this has become non-nil here, it has been set by a timer
2822 or sentinel or filter. */
2823 if (CONSP (Vunread_command_events
))
2825 c
= XCAR (Vunread_command_events
);
2826 Vunread_command_events
= XCDR (Vunread_command_events
);
2829 /* Read something from current KBOARD's side queue, if possible. */
2833 if (current_kboard
->kbd_queue_has_data
)
2835 if (!CONSP (current_kboard
->kbd_queue
))
2837 c
= XCAR (current_kboard
->kbd_queue
);
2838 current_kboard
->kbd_queue
2839 = XCDR (current_kboard
->kbd_queue
);
2840 if (NILP (current_kboard
->kbd_queue
))
2841 current_kboard
->kbd_queue_has_data
= 0;
2842 input_pending
= readable_events (0);
2843 if (EVENT_HAS_PARAMETERS (c
)
2844 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2845 internal_last_event_frame
= XCAR (XCDR (c
));
2846 Vlast_event_frame
= internal_last_event_frame
;
2850 /* If current_kboard's side queue is empty check the other kboards.
2851 If one of them has data that we have not yet seen here,
2852 switch to it and process the data waiting for it.
2854 Note: if the events queued up for another kboard
2855 have already been seen here, and therefore are not a complete command,
2856 the kbd_queue_has_data field is 0, so we skip that kboard here.
2857 That's to avoid an infinite loop switching between kboards here. */
2858 if (NILP (c
) && !single_kboard
)
2861 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2862 if (kb
->kbd_queue_has_data
)
2864 current_kboard
= kb
;
2865 /* This is going to exit from read_char
2866 so we had better get rid of this frame's stuff. */
2868 return make_number (-2); /* wrong_kboard_jmpbuf */
2876 /* Finally, we read from the main queue,
2877 and if that gives us something we can't use yet, we put it on the
2878 appropriate side queue and try again. */
2887 EMACS_GET_TIME (now
);
2888 if (EMACS_TIME_GE (now
, *end_time
))
2892 /* Actually read a character, waiting if necessary. */
2893 save_getcjmp (save_jump
);
2894 restore_getcjmp (local_getcjmp
);
2896 timer_start_idle ();
2897 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2898 restore_getcjmp (save_jump
);
2900 if (! NILP (c
) && (kb
!= current_kboard
))
2902 Lisp_Object link
= kb
->kbd_queue
;
2905 while (CONSP (XCDR (link
)))
2907 if (!NILP (XCDR (link
)))
2911 kb
->kbd_queue
= Fcons (c
, Qnil
);
2913 XSETCDR (link
, Fcons (c
, Qnil
));
2914 kb
->kbd_queue_has_data
= 1;
2918 current_kboard
= kb
;
2919 /* This is going to exit from read_char
2920 so we had better get rid of this frame's stuff. */
2922 return make_number (-2);
2926 /* Terminate Emacs in batch mode if at eof. */
2927 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2928 Fkill_emacs (make_number (1));
2932 /* Add in any extra modifiers, where appropriate. */
2933 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2934 || ((extra_keyboard_modifiers
& 0177) < ' '
2935 && (extra_keyboard_modifiers
& 0177) != 0))
2936 XSETINT (c
, make_ctrl_char (XINT (c
)));
2938 /* Transfer any other modifier bits directly from
2939 extra_keyboard_modifiers to c. Ignore the actual character code
2940 in the low 16 bits of extra_keyboard_modifiers. */
2941 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2952 if (commandflag
>= 0
2953 && !input_pending
&& !detect_input_pending_run_timers (0))
2961 /* Buffer switch events are only for internal wakeups
2962 so don't show them to the user.
2963 Also, don't record a key if we already did. */
2964 if (BUFFERP (c
) || key_already_recorded
)
2967 /* Process special events within read_char
2968 and loop around to read another event. */
2971 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2976 struct buffer
*prev_buffer
= current_buffer
;
2977 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2978 int was_locked
= single_kboard
;
2979 int count
= SPECPDL_INDEX ();
2980 record_single_kboard_state ();
2983 last_input_event
= c
;
2984 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2986 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2987 /* We stopped being idle for this event; undo that. This
2988 prevents automatic window selection (under
2989 mouse_autoselect_window from acting as a real input event, for
2990 example banishing the mouse under mouse-avoidance-mode. */
2991 timer_resume_idle ();
2993 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2994 /* Resume allowing input from any kboard, if that was true before. */
2996 any_kboard_state ();
2997 unbind_to (count
, Qnil
);
3000 if (current_buffer
!= prev_buffer
)
3002 /* The command may have changed the keymaps. Pretend there
3003 is input in another keyboard and return. This will
3004 recalculate keymaps. */
3005 c
= make_number (-2);
3012 /* Handle things that only apply to characters. */
3015 /* If kbd_buffer_get_event gave us an EOF, return that. */
3019 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3020 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3021 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3022 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3023 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3027 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3028 /* nil in keyboard-translate-table means no translation. */
3034 /* If this event is a mouse click in the menu bar,
3035 return just menu-bar for now. Modify the mouse click event
3036 so we won't do this twice, then queue it up. */
3037 if (EVENT_HAS_PARAMETERS (c
)
3039 && CONSP (EVENT_START (c
))
3040 && CONSP (XCDR (EVENT_START (c
))))
3044 posn
= POSN_POSN (EVENT_START (c
));
3045 /* Handle menu-bar events:
3046 insert the dummy prefix event `menu-bar'. */
3047 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3049 /* Change menu-bar to (menu-bar) as the event "position". */
3050 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3053 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3058 /* Store these characters into recent_keys, the dribble file if any,
3059 and the keyboard macro being defined, if any. */
3061 if (! NILP (also_record
))
3062 record_char (also_record
);
3064 /* Wipe the echo area.
3065 But first, if we are about to use an input method,
3066 save the echo area contents for it to refer to. */
3068 && ! NILP (Vinput_method_function
)
3069 && (unsigned) XINT (c
) >= ' '
3070 && (unsigned) XINT (c
) != 127
3071 && (unsigned) XINT (c
) < 256)
3073 previous_echo_area_message
= Fcurrent_message ();
3074 Vinput_method_previous_message
= previous_echo_area_message
;
3077 /* Now wipe the echo area, except for help events which do their
3078 own stuff with the echo area. */
3080 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3081 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3083 if (!NILP (echo_area_buffer
[0]))
3084 safe_run_hooks (Qecho_area_clear_hook
);
3085 clear_message (1, 0);
3088 reread_for_input_method
:
3090 /* Pass this to the input method, if appropriate. */
3092 && ! NILP (Vinput_method_function
)
3093 /* Don't run the input method within a key sequence,
3094 after the first event of the key sequence. */
3095 && NILP (prev_event
)
3096 && (unsigned) XINT (c
) >= ' '
3097 && (unsigned) XINT (c
) != 127
3098 && (unsigned) XINT (c
) < 256)
3101 int key_count
, key_count_reset
;
3102 struct gcpro gcpro1
;
3103 int count
= SPECPDL_INDEX ();
3105 /* Save the echo status. */
3106 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3107 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3108 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3109 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3112 if (before_command_restore_flag
)
3114 this_command_key_count
= before_command_key_count_1
;
3115 if (this_command_key_count
< this_single_command_key_start
)
3116 this_single_command_key_start
= this_command_key_count
;
3117 echo_truncate (before_command_echo_length_1
);
3118 before_command_restore_flag
= 0;
3122 /* Save the this_command_keys status. */
3123 key_count
= this_command_key_count
;
3124 key_count_reset
= this_command_key_count_reset
;
3127 keys
= Fcopy_sequence (this_command_keys
);
3132 /* Clear out this_command_keys. */
3133 this_command_key_count
= 0;
3134 this_command_key_count_reset
= 0;
3136 /* Now wipe the echo area. */
3137 if (!NILP (echo_area_buffer
[0]))
3138 safe_run_hooks (Qecho_area_clear_hook
);
3139 clear_message (1, 0);
3142 /* If we are not reading a key sequence,
3143 never use the echo area. */
3146 specbind (Qinput_method_use_echo_area
, Qt
);
3149 /* Call the input method. */
3150 tem
= call1 (Vinput_method_function
, c
);
3152 tem
= unbind_to (count
, tem
);
3154 /* Restore the saved echoing state
3155 and this_command_keys state. */
3156 this_command_key_count
= key_count
;
3157 this_command_key_count_reset
= key_count_reset
;
3159 this_command_keys
= keys
;
3162 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3163 current_kboard
->echo_string
= saved_echo_string
;
3164 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3165 if (saved_immediate_echo
)
3170 /* The input method can return no events. */
3173 /* Bring back the previous message, if any. */
3174 if (! NILP (previous_echo_area_message
))
3175 message_with_string ("%s", previous_echo_area_message
, 0);
3178 /* It returned one event or more. */
3180 Vunread_post_input_method_events
3181 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3186 /* Display help if not echoing. */
3187 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3189 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3190 Lisp_Object help
, object
, position
, window
, tem
;
3192 tem
= Fcdr (XCDR (c
));
3195 window
= Fcar (tem
);
3197 object
= Fcar (tem
);
3199 position
= Fcar (tem
);
3201 show_help_echo (help
, window
, object
, position
, 0);
3203 /* We stopped being idle for this event; undo that. */
3205 timer_resume_idle ();
3209 if ((! reread
|| this_command_key_count
== 0
3210 || this_command_key_count_reset
)
3214 /* Don't echo mouse motion events. */
3215 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3216 && NILP (Fzerop (Vecho_keystrokes
))
3217 && ! (EVENT_HAS_PARAMETERS (c
)
3218 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3221 if (! NILP (also_record
))
3222 echo_char (also_record
);
3223 /* Once we reread a character, echoing can happen
3224 the next time we pause to read a new one. */
3225 ok_to_echo_at_next_pause
= current_kboard
;
3228 /* Record this character as part of the current key. */
3229 add_command_key (c
);
3230 if (! NILP (also_record
))
3231 add_command_key (also_record
);
3234 last_input_event
= c
;
3237 /* Process the help character specially if enabled */
3238 if (!NILP (Vhelp_form
) && help_char_p (c
))
3241 count
= SPECPDL_INDEX ();
3243 help_form_saved_window_configs
3244 = Fcons (Fcurrent_window_configuration (Qnil
),
3245 help_form_saved_window_configs
);
3246 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3248 tem0
= Feval (Vhelp_form
);
3250 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3255 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3256 if (EVENT_HAS_PARAMETERS (c
)
3257 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3258 XSETCAR (help_form_saved_window_configs
, Qnil
);
3260 while (BUFFERP (c
));
3261 /* Remove the help from the frame */
3262 unbind_to (count
, Qnil
);
3265 if (EQ (c
, make_number (040)))
3269 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3270 while (BUFFERP (c
));
3279 /* Record a key that came from a mouse menu.
3280 Record it for echoing, for this-command-keys, and so on. */
3283 record_menu_key (Lisp_Object c
)
3285 /* Wipe the echo area. */
3286 clear_message (1, 0);
3291 before_command_key_count
= this_command_key_count
;
3292 before_command_echo_length
= echo_length ();
3295 /* Don't echo mouse motion events. */
3296 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3297 && NILP (Fzerop (Vecho_keystrokes
)))
3301 /* Once we reread a character, echoing can happen
3302 the next time we pause to read a new one. */
3303 ok_to_echo_at_next_pause
= 0;
3306 /* Record this character as part of the current key. */
3307 add_command_key (c
);
3309 /* Re-reading in the middle of a command */
3310 last_input_event
= c
;
3314 /* Return 1 if should recognize C as "the help character". */
3317 help_char_p (Lisp_Object c
)
3321 if (EQ (c
, Vhelp_char
))
3323 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3324 if (EQ (c
, XCAR (tail
)))
3329 /* Record the input event C in various ways. */
3332 record_char (Lisp_Object c
)
3336 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3338 /* To avoid filling recent_keys with help-echo and mouse-movement
3339 events, we filter out repeated help-echo events, only store the
3340 first and last in a series of mouse-movement events, and don't
3341 store repeated help-echo events which are only separated by
3342 mouse-movement events. */
3344 Lisp_Object ev1
, ev2
, ev3
;
3347 if ((ix1
= recent_keys_index
- 1) < 0)
3348 ix1
= NUM_RECENT_KEYS
- 1;
3349 ev1
= AREF (recent_keys
, ix1
);
3351 if ((ix2
= ix1
- 1) < 0)
3352 ix2
= NUM_RECENT_KEYS
- 1;
3353 ev2
= AREF (recent_keys
, ix2
);
3355 if ((ix3
= ix2
- 1) < 0)
3356 ix3
= NUM_RECENT_KEYS
- 1;
3357 ev3
= AREF (recent_keys
, ix3
);
3359 if (EQ (XCAR (c
), Qhelp_echo
))
3361 /* Don't record `help-echo' in recent_keys unless it shows some help
3362 message, and a different help than the previously recorded
3364 Lisp_Object help
, last_help
;
3366 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3367 if (!STRINGP (help
))
3369 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3370 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3372 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3373 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3374 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3376 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3377 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3378 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3379 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3382 else if (EQ (XCAR (c
), Qmouse_movement
))
3384 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3385 So additional mouse movement events replace the last element. */
3386 Lisp_Object last_window
, window
;
3388 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3389 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3390 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3391 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3392 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3394 ASET (recent_keys
, ix1
, c
);
3400 store_kbd_macro_char (c
);
3405 ASET (recent_keys
, recent_keys_index
, c
);
3406 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3407 recent_keys_index
= 0;
3409 else if (recorded
< 0)
3411 /* We need to remove one or two events from recent_keys.
3412 To do this, we simply put nil at those events and move the
3413 recent_keys_index backwards over those events. Usually,
3414 users will never see those nil events, as they will be
3415 overwritten by the command keys entered to see recent_keys
3418 while (recorded
++ < 0 && total_keys
> 0)
3420 if (total_keys
< NUM_RECENT_KEYS
)
3422 if (--recent_keys_index
< 0)
3423 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3424 ASET (recent_keys
, recent_keys_index
, Qnil
);
3428 num_nonmacro_input_events
++;
3430 /* Write c to the dribble file. If c is a lispy event, write
3431 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3432 If you, dear reader, have a better idea, you've got the source. :-) */
3438 if (XUINT (c
) < 0x100)
3439 putc (XINT (c
), dribble
);
3441 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3445 Lisp_Object dribblee
;
3447 /* If it's a structured event, take the event header. */
3448 dribblee
= EVENT_HEAD (c
);
3450 if (SYMBOLP (dribblee
))
3452 putc ('<', dribble
);
3453 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3454 SBYTES (SYMBOL_NAME (dribblee
)),
3456 putc ('>', dribble
);
3466 print_help (Lisp_Object object
)
3468 struct buffer
*old
= current_buffer
;
3469 Fprinc (object
, Qnil
);
3470 set_buffer_internal (XBUFFER (Vstandard_output
));
3471 call0 (intern ("help-mode"));
3472 set_buffer_internal (old
);
3476 /* Copy out or in the info on where C-g should throw to.
3477 This is used when running Lisp code from within get_char,
3478 in case get_char is called recursively.
3479 See read_process_output. */
3482 save_getcjmp (jmp_buf temp
)
3484 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3488 restore_getcjmp (jmp_buf temp
)
3490 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3493 /* Low level keyboard/mouse input.
3494 kbd_buffer_store_event places events in kbd_buffer, and
3495 kbd_buffer_get_event retrieves them. */
3497 /* Return true if there are any events in the queue that read-char
3498 would return. If this returns false, a read-char would block. */
3500 readable_events (int flags
)
3503 /* Check whether a D-Bus message has arrived. */
3504 if (xd_pending_messages () > 0)
3506 #endif /* HAVE_DBUS */
3508 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3511 /* If the buffer contains only FOCUS_IN_EVENT events, and
3512 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3513 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3515 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3516 #ifdef USE_TOOLKIT_SCROLL_BARS
3517 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3521 struct input_event
*event
;
3523 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3530 #ifdef USE_TOOLKIT_SCROLL_BARS
3531 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3533 event
->kind
== FOCUS_IN_EVENT
)
3534 #ifdef USE_TOOLKIT_SCROLL_BARS
3535 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3536 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3537 && event
->part
== scroll_bar_handle
3538 && event
->modifiers
== 0)
3543 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3546 while (event
!= kbd_store_ptr
);
3552 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3553 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3554 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3559 if (current_kboard
->kbd_queue_has_data
)
3565 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3566 if (kb
->kbd_queue_has_data
)
3572 /* Set this for debugging, to have a way to get out */
3576 event_to_kboard (struct input_event
*event
)
3579 frame
= event
->frame_or_window
;
3581 frame
= XCAR (frame
);
3582 else if (WINDOWP (frame
))
3583 frame
= WINDOW_FRAME (XWINDOW (frame
));
3585 /* There are still some events that don't set this field.
3586 For now, just ignore the problem.
3587 Also ignore dead frames here. */
3588 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3591 return FRAME_KBOARD (XFRAME (frame
));
3594 /* Return the number of slots occupied in kbd_buffer. */
3597 kbd_buffer_nr_stored ()
3599 return kbd_fetch_ptr
== kbd_store_ptr
3601 : (kbd_fetch_ptr
< kbd_store_ptr
3602 ? kbd_store_ptr
- kbd_fetch_ptr
3603 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3604 + (kbd_store_ptr
- kbd_buffer
)));
3607 Lisp_Object Vthrow_on_input
;
3609 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3612 kbd_buffer_store_event (register struct input_event
*event
)
3614 kbd_buffer_store_event_hold (event
, 0);
3617 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3619 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3620 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3621 Else, if EVENT is a quit event, store the quit event
3622 in HOLD_QUIT, and return (thus ignoring further events).
3624 This is used in read_avail_input to postpone the processing
3625 of the quit event until all subsequent input events have been
3626 parsed (and discarded).
3630 kbd_buffer_store_event_hold (register struct input_event
*event
,
3631 struct input_event
*hold_quit
)
3633 if (event
->kind
== NO_EVENT
)
3636 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3639 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3641 register int c
= event
->code
& 0377;
3643 if (event
->modifiers
& ctrl_modifier
)
3644 c
= make_ctrl_char (c
);
3646 c
|= (event
->modifiers
3647 & (meta_modifier
| alt_modifier
3648 | hyper_modifier
| super_modifier
));
3652 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3653 struct input_event
*sp
;
3655 if (single_kboard
&& kb
!= current_kboard
)
3658 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3659 Fcons (make_number (c
), Qnil
));
3660 kb
->kbd_queue_has_data
= 1;
3661 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3663 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3666 if (event_to_kboard (sp
) == kb
)
3668 sp
->kind
= NO_EVENT
;
3669 sp
->frame_or_window
= Qnil
;
3678 memcpy (hold_quit
, event
, sizeof (*event
));
3682 /* If this results in a quit_char being returned to Emacs as
3683 input, set Vlast_event_frame properly. If this doesn't
3684 get returned to Emacs as an event, the next event read
3685 will set Vlast_event_frame again, so this is safe to do. */
3689 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3691 focus
= event
->frame_or_window
;
3692 internal_last_event_frame
= focus
;
3693 Vlast_event_frame
= focus
;
3696 last_event_timestamp
= event
->timestamp
;
3697 handle_interrupt ();
3701 if (c
&& c
== stop_character
)
3707 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3708 Just ignore the second one. */
3709 else if (event
->kind
== BUFFER_SWITCH_EVENT
3710 && kbd_fetch_ptr
!= kbd_store_ptr
3711 && ((kbd_store_ptr
== kbd_buffer
3712 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3713 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3716 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3717 kbd_store_ptr
= kbd_buffer
;
3719 /* Don't let the very last slot in the buffer become full,
3720 since that would make the two pointers equal,
3721 and that is indistinguishable from an empty buffer.
3722 Discard the event if it would fill the last slot. */
3723 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3725 *kbd_store_ptr
= *event
;
3727 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3729 /* Don't read keyboard input until we have processed kbd_buffer.
3730 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3731 hold_keyboard_input ();
3733 if (!noninteractive
)
3734 signal (SIGIO
, SIG_IGN
);
3740 /* If we're inside while-no-input, and this event qualifies
3741 as input, set quit-flag to cause an interrupt. */
3742 if (!NILP (Vthrow_on_input
)
3743 && event
->kind
!= FOCUS_IN_EVENT
3744 && event
->kind
!= HELP_EVENT
3745 && event
->kind
!= DEICONIFY_EVENT
)
3747 Vquit_flag
= Vthrow_on_input
;
3748 /* If we're inside a function that wants immediate quits,
3750 if (immediate_quit
&& NILP (Vinhibit_quit
))
3760 /* Put an input event back in the head of the event queue. */
3763 kbd_buffer_unget_event (register struct input_event
*event
)
3765 if (kbd_fetch_ptr
== kbd_buffer
)
3766 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3768 /* Don't let the very last slot in the buffer become full, */
3769 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3772 *kbd_fetch_ptr
= *event
;
3777 /* Generate HELP_EVENT input_events in BUFP which has room for
3778 SIZE events. If there's not enough room in BUFP, ignore this
3781 HELP is the help form.
3783 FRAME is the frame on which the help is generated. OBJECT is the
3784 Lisp object where the help was found (a buffer, a string, an
3785 overlay, or nil if neither from a string nor from a buffer. POS is
3786 the position within OBJECT where the help was found.
3788 Value is the number of input_events generated. */
3791 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3792 Lisp_Object object
, int pos
)
3794 struct input_event event
;
3798 event
.kind
= HELP_EVENT
;
3799 event
.frame_or_window
= frame
;
3801 event
.x
= WINDOWP (window
) ? window
: frame
;
3804 kbd_buffer_store_event (&event
);
3808 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3811 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3813 struct input_event event
;
3815 event
.kind
= HELP_EVENT
;
3816 event
.frame_or_window
= frame
;
3821 kbd_buffer_store_event (&event
);
3825 /* Discard any mouse events in the event buffer by setting them to
3828 discard_mouse_events (void)
3830 struct input_event
*sp
;
3831 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3833 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3836 if (sp
->kind
== MOUSE_CLICK_EVENT
3837 || sp
->kind
== WHEEL_EVENT
3838 || sp
->kind
== HORIZ_WHEEL_EVENT
3840 || sp
->kind
== GPM_CLICK_EVENT
3842 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3844 sp
->kind
= NO_EVENT
;
3850 /* Return non-zero if there are any real events waiting in the event
3851 buffer, not counting `NO_EVENT's.
3853 If DISCARD is non-zero, discard NO_EVENT events at the front of
3854 the input queue, possibly leaving the input queue empty if there
3855 are no real input events. */
3858 kbd_buffer_events_waiting (int discard
)
3860 struct input_event
*sp
;
3862 for (sp
= kbd_fetch_ptr
;
3863 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3866 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3873 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3877 /* Clear input event EVENT. */
3880 clear_event (struct input_event
*event
)
3882 event
->kind
= NO_EVENT
;
3886 /* Read one event from the event buffer, waiting if necessary.
3887 The value is a Lisp object representing the event.
3888 The value is nil for an event that should be ignored,
3889 or that was handled here.
3890 We always read and discard one event. */
3893 kbd_buffer_get_event (KBOARD
**kbp
,
3894 int *used_mouse_menu
,
3895 struct timeval
*end_time
)
3900 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3902 /* Start reading input again, we have processed enough so we can
3903 accept new events again. */
3904 unhold_keyboard_input ();
3906 if (!noninteractive
)
3907 signal (SIGIO
, input_available_signal
);
3913 /* In case we are running as a daemon, only do this before
3914 detaching from the terminal. */
3915 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3919 *kbp
= current_kboard
;
3923 /* Wait until there is input available. */
3926 /* Break loop if there's an unread command event. Needed in
3927 moused window autoselection which uses a timer to insert such
3929 if (CONSP (Vunread_command_events
))
3932 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3934 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3935 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3939 /* If the quit flag is set, then read_char will return
3940 quit_char, so that counts as "available input." */
3941 if (!NILP (Vquit_flag
))
3942 quit_throw_to_read_char ();
3944 /* One way or another, wait until input is available; then, if
3945 interrupt handlers have not read it, read it now. */
3947 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3951 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3953 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3954 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3959 EMACS_TIME duration
;
3960 EMACS_GET_TIME (duration
);
3961 if (EMACS_TIME_GE (duration
, *end_time
))
3962 return Qnil
; /* finished waiting */
3965 EMACS_SUB_TIME (duration
, *end_time
, duration
);
3966 wait_reading_process_output (EMACS_SECS (duration
),
3967 EMACS_USECS (duration
),
3968 -1, 1, Qnil
, NULL
, 0);
3972 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3974 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3975 /* Pass 1 for EXPECT since we just waited to have input. */
3976 read_avail_input (1);
3979 if (CONSP (Vunread_command_events
))
3982 first
= XCAR (Vunread_command_events
);
3983 Vunread_command_events
= XCDR (Vunread_command_events
);
3984 *kbp
= current_kboard
;
3988 /* At this point, we know that there is a readable event available
3989 somewhere. If the event queue is empty, then there must be a
3990 mouse movement enabled and available. */
3991 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3993 struct input_event
*event
;
3995 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3999 last_event_timestamp
= event
->timestamp
;
4001 *kbp
= event_to_kboard (event
);
4003 *kbp
= current_kboard
; /* Better than returning null ptr? */
4007 /* These two kinds of events get special handling
4008 and don't actually appear to the command loop.
4009 We return nil for them. */
4010 if (event
->kind
== SELECTION_REQUEST_EVENT
4011 || event
->kind
== SELECTION_CLEAR_EVENT
)
4014 struct input_event copy
;
4016 /* Remove it from the buffer before processing it,
4017 since otherwise swallow_events will see it
4018 and process it again. */
4020 kbd_fetch_ptr
= event
+ 1;
4021 input_pending
= readable_events (0);
4022 x_handle_selection_event (©
);
4024 /* We're getting selection request events, but we don't have
4030 #if defined (HAVE_NS)
4031 else if (event
->kind
== NS_TEXT_EVENT
)
4033 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4034 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
4036 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
4037 kbd_fetch_ptr
= event
+ 1;
4038 if (used_mouse_menu
)
4039 *used_mouse_menu
= 1;
4043 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4044 || defined (HAVE_NS)
4045 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4047 /* Make an event (delete-frame (FRAME)). */
4048 obj
= Fcons (event
->frame_or_window
, Qnil
);
4049 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4050 kbd_fetch_ptr
= event
+ 1;
4053 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4054 || defined (HAVE_NS)
4055 else if (event
->kind
== ICONIFY_EVENT
)
4057 /* Make an event (iconify-frame (FRAME)). */
4058 obj
= Fcons (event
->frame_or_window
, Qnil
);
4059 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4060 kbd_fetch_ptr
= event
+ 1;
4062 else if (event
->kind
== DEICONIFY_EVENT
)
4064 /* Make an event (make-frame-visible (FRAME)). */
4065 obj
= Fcons (event
->frame_or_window
, Qnil
);
4066 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4067 kbd_fetch_ptr
= event
+ 1;
4070 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4072 /* The value doesn't matter here; only the type is tested. */
4073 XSETBUFFER (obj
, current_buffer
);
4074 kbd_fetch_ptr
= event
+ 1;
4076 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4077 || defined(HAVE_NS) || defined (USE_GTK)
4078 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4080 kbd_fetch_ptr
= event
+ 1;
4081 input_pending
= readable_events (0);
4082 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4083 x_activate_menubar (XFRAME (event
->frame_or_window
));
4086 #if defined (WINDOWSNT)
4087 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4089 /* Make an event (language-change (FRAME CHARSET LCID)). */
4090 obj
= Fcons (event
->frame_or_window
, Qnil
);
4091 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4092 kbd_fetch_ptr
= event
+ 1;
4095 else if (event
->kind
== SAVE_SESSION_EVENT
)
4097 obj
= Fcons (Qsave_session
, Qnil
);
4098 kbd_fetch_ptr
= event
+ 1;
4100 /* Just discard these, by returning nil.
4101 With MULTI_KBOARD, these events are used as placeholders
4102 when we need to randomly delete events from the queue.
4103 (They shouldn't otherwise be found in the buffer,
4104 but on some machines it appears they do show up
4105 even without MULTI_KBOARD.) */
4106 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4107 mouse events during a popup-menu call. */
4108 else if (event
->kind
== NO_EVENT
)
4109 kbd_fetch_ptr
= event
+ 1;
4110 else if (event
->kind
== HELP_EVENT
)
4112 Lisp_Object object
, position
, help
, frame
, window
;
4114 frame
= event
->frame_or_window
;
4115 object
= event
->arg
;
4116 position
= make_number (event
->code
);
4119 clear_event (event
);
4121 kbd_fetch_ptr
= event
+ 1;
4122 if (!WINDOWP (window
))
4124 obj
= Fcons (Qhelp_echo
,
4125 list5 (frame
, help
, window
, object
, position
));
4127 else if (event
->kind
== FOCUS_IN_EVENT
)
4129 /* Notification of a FocusIn event. The frame receiving the
4130 focus is in event->frame_or_window. Generate a
4131 switch-frame event if necessary. */
4132 Lisp_Object frame
, focus
;
4134 frame
= event
->frame_or_window
;
4135 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4139 if (!EQ (frame
, internal_last_event_frame
)
4140 && !EQ (frame
, selected_frame
))
4141 obj
= make_lispy_switch_frame (frame
);
4142 internal_last_event_frame
= frame
;
4143 kbd_fetch_ptr
= event
+ 1;
4146 else if (event
->kind
== DBUS_EVENT
)
4148 obj
= make_lispy_event (event
);
4149 kbd_fetch_ptr
= event
+ 1;
4152 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4154 obj
= make_lispy_event (event
);
4155 kbd_fetch_ptr
= event
+ 1;
4159 /* If this event is on a different frame, return a switch-frame this
4160 time, and leave the event in the queue for next time. */
4164 frame
= event
->frame_or_window
;
4166 frame
= XCAR (frame
);
4167 else if (WINDOWP (frame
))
4168 frame
= WINDOW_FRAME (XWINDOW (frame
));
4170 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4174 if (! EQ (frame
, internal_last_event_frame
)
4175 && !EQ (frame
, selected_frame
))
4176 obj
= make_lispy_switch_frame (frame
);
4177 internal_last_event_frame
= frame
;
4179 /* If we didn't decide to make a switch-frame event, go ahead
4180 and build a real event from the queue entry. */
4184 obj
= make_lispy_event (event
);
4186 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4187 || defined(HAVE_NS) || defined (USE_GTK)
4188 /* If this was a menu selection, then set the flag to inhibit
4189 writing to last_nonmenu_event. Don't do this if the event
4190 we're returning is (menu-bar), though; that indicates the
4191 beginning of the menu sequence, and we might as well leave
4192 that as the `event with parameters' for this selection. */
4194 && !EQ (event
->frame_or_window
, event
->arg
)
4195 && (event
->kind
== MENU_BAR_EVENT
4196 || event
->kind
== TOOL_BAR_EVENT
))
4197 *used_mouse_menu
= 1;
4200 /* certain system events are non-key events */
4202 && event
->kind
== NS_NONKEY_EVENT
)
4203 *used_mouse_menu
= 1;
4206 /* Wipe out this event, to catch bugs. */
4207 clear_event (event
);
4208 kbd_fetch_ptr
= event
+ 1;
4212 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4213 /* Try generating a mouse motion event. */
4214 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4216 FRAME_PTR f
= some_mouse_moved ();
4217 Lisp_Object bar_window
;
4218 enum scroll_bar_part part
;
4222 *kbp
= current_kboard
;
4223 /* Note that this uses F to determine which terminal to look at.
4224 If there is no valid info, it does not store anything
4225 so x remains nil. */
4228 /* XXX Can f or mouse_position_hook be NULL here? */
4229 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4230 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4231 &part
, &x
, &y
, &time
);
4235 /* Decide if we should generate a switch-frame event. Don't
4236 generate switch-frame events for motion outside of all Emacs
4242 frame
= FRAME_FOCUS_FRAME (f
);
4244 XSETFRAME (frame
, f
);
4246 if (! EQ (frame
, internal_last_event_frame
)
4247 && !EQ (frame
, selected_frame
))
4248 obj
= make_lispy_switch_frame (frame
);
4249 internal_last_event_frame
= frame
;
4252 /* If we didn't decide to make a switch-frame event, go ahead and
4253 return a mouse-motion event. */
4254 if (!NILP (x
) && NILP (obj
))
4255 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4257 #endif /* HAVE_MOUSE || HAVE GPM */
4259 /* We were promised by the above while loop that there was
4260 something for us to read! */
4263 input_pending
= readable_events (0);
4265 Vlast_event_frame
= internal_last_event_frame
;
4270 /* Process any events that are not user-visible,
4271 then return, without reading any user-visible events. */
4274 swallow_events (int do_display
)
4278 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4280 struct input_event
*event
;
4282 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4286 last_event_timestamp
= event
->timestamp
;
4288 /* These two kinds of events get special handling
4289 and don't actually appear to the command loop. */
4290 if (event
->kind
== SELECTION_REQUEST_EVENT
4291 || event
->kind
== SELECTION_CLEAR_EVENT
)
4294 struct input_event copy
;
4296 /* Remove it from the buffer before processing it,
4297 since otherwise swallow_events called recursively could see it
4298 and process it again. */
4300 kbd_fetch_ptr
= event
+ 1;
4301 input_pending
= readable_events (0);
4302 x_handle_selection_event (©
);
4304 /* We're getting selection request events, but we don't have
4313 old_timers_run
= timers_run
;
4314 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4316 if (timers_run
!= old_timers_run
&& do_display
)
4317 redisplay_preserve_echo_area (7);
4320 /* Record the start of when Emacs is idle,
4321 for the sake of running idle-time timers. */
4324 timer_start_idle (void)
4328 /* If we are already in the idle state, do nothing. */
4329 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4332 EMACS_GET_TIME (timer_idleness_start_time
);
4334 timer_last_idleness_start_time
= timer_idleness_start_time
;
4336 /* Mark all idle-time timers as once again candidates for running. */
4337 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4341 timer
= XCAR (timers
);
4343 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4345 XVECTOR (timer
)->contents
[0] = Qnil
;
4349 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4352 timer_stop_idle (void)
4354 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4357 /* Resume idle timer from last idle start time. */
4360 timer_resume_idle (void)
4362 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4365 timer_idleness_start_time
= timer_last_idleness_start_time
;
4368 /* This is only for debugging. */
4369 struct input_event last_timer_event
;
4371 /* List of elisp functions to call, delayed because they were generated in
4372 a context where Elisp could not be safely run (e.g. redisplay, signal,
4373 ...). Each element has the form (FUN . ARGS). */
4374 Lisp_Object pending_funcalls
;
4376 extern Lisp_Object Qapply
;
4378 /* Check whether a timer has fired. To prevent larger problems we simply
4379 disregard elements that are not proper timers. Do not make a circular
4380 timer list for the time being.
4382 Returns the time to wait until the next timer fires. If a
4383 timer is triggering now, return zero.
4384 If no timer is active, return -1.
4386 If a timer is ripe, we run it, with quitting turned off.
4387 In that case we return 0 to indicate that a new timer_check_2 call
4391 timer_check_2 (void)
4393 EMACS_TIME nexttime
;
4394 EMACS_TIME now
, idleness_now
;
4395 Lisp_Object timers
, idle_timers
, chosen_timer
;
4396 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4398 EMACS_SET_SECS (nexttime
, -1);
4399 EMACS_SET_USECS (nexttime
, -1);
4401 /* Always consider the ordinary timers. */
4402 timers
= Vtimer_list
;
4403 /* Consider the idle timers only if Emacs is idle. */
4404 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4405 idle_timers
= Vtimer_idle_list
;
4408 chosen_timer
= Qnil
;
4409 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4411 /* First run the code that was delayed. */
4412 while (CONSP (pending_funcalls
))
4414 Lisp_Object funcall
= XCAR (pending_funcalls
);
4415 pending_funcalls
= XCDR (pending_funcalls
);
4416 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4419 if (CONSP (timers
) || CONSP (idle_timers
))
4421 EMACS_GET_TIME (now
);
4422 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4423 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4426 while (CONSP (timers
) || CONSP (idle_timers
))
4428 Lisp_Object
*vector
;
4429 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4430 EMACS_TIME timer_time
, idle_timer_time
;
4431 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4433 /* Skip past invalid timers and timers already handled. */
4436 timer
= XCAR (timers
);
4437 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4439 timers
= XCDR (timers
);
4442 vector
= XVECTOR (timer
)->contents
;
4444 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4445 || !INTEGERP (vector
[3])
4446 || ! NILP (vector
[0]))
4448 timers
= XCDR (timers
);
4452 if (!NILP (idle_timers
))
4454 timer
= XCAR (idle_timers
);
4455 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4457 idle_timers
= XCDR (idle_timers
);
4460 vector
= XVECTOR (timer
)->contents
;
4462 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4463 || !INTEGERP (vector
[3])
4464 || ! NILP (vector
[0]))
4466 idle_timers
= XCDR (idle_timers
);
4471 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4472 based on the next ordinary timer.
4473 TIMER_DIFFERENCE is the distance in time from NOW to when
4474 this timer becomes ripe (negative if it's already ripe). */
4477 timer
= XCAR (timers
);
4478 vector
= XVECTOR (timer
)->contents
;
4479 EMACS_SET_SECS (timer_time
,
4480 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4481 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4482 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4485 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4486 based on the next idle timer. */
4487 if (!NILP (idle_timers
))
4489 idle_timer
= XCAR (idle_timers
);
4490 vector
= XVECTOR (idle_timer
)->contents
;
4491 EMACS_SET_SECS (idle_timer_time
,
4492 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4493 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4494 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4497 /* Decide which timer is the next timer,
4498 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4499 Also step down the list where we found that timer. */
4501 if (! NILP (timers
) && ! NILP (idle_timers
))
4504 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4505 if (EMACS_TIME_NEG_P (temp
))
4507 chosen_timer
= timer
;
4508 timers
= XCDR (timers
);
4509 difference
= timer_difference
;
4513 chosen_timer
= idle_timer
;
4514 idle_timers
= XCDR (idle_timers
);
4515 difference
= idle_timer_difference
;
4518 else if (! NILP (timers
))
4520 chosen_timer
= timer
;
4521 timers
= XCDR (timers
);
4522 difference
= timer_difference
;
4526 chosen_timer
= idle_timer
;
4527 idle_timers
= XCDR (idle_timers
);
4528 difference
= idle_timer_difference
;
4530 vector
= XVECTOR (chosen_timer
)->contents
;
4532 /* If timer is ripe, run it if it hasn't been run. */
4533 if (EMACS_TIME_NEG_P (difference
)
4534 || (EMACS_SECS (difference
) == 0
4535 && EMACS_USECS (difference
) == 0))
4537 if (NILP (vector
[0]))
4539 int count
= SPECPDL_INDEX ();
4540 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4542 /* Mark the timer as triggered to prevent problems if the lisp
4543 code fails to reschedule it right. */
4546 specbind (Qinhibit_quit
, Qt
);
4548 call1 (Qtimer_event_handler
, chosen_timer
);
4549 Vdeactivate_mark
= old_deactivate_mark
;
4551 unbind_to (count
, Qnil
);
4553 /* Since we have handled the event,
4554 we don't need to tell the caller to wake up and do it. */
4555 /* But the caller must still wait for the next timer, so
4556 return 0 to indicate that. */
4559 EMACS_SET_SECS (nexttime
, 0);
4560 EMACS_SET_USECS (nexttime
, 0);
4563 /* When we encounter a timer that is still waiting,
4564 return the amount of time to wait before it is ripe. */
4571 /* No timers are pending in the future. */
4572 /* Return 0 if we generated an event, and -1 if not. */
4578 /* Check whether a timer has fired. To prevent larger problems we simply
4579 disregard elements that are not proper timers. Do not make a circular
4580 timer list for the time being.
4582 Returns the time to wait until the next timer fires.
4583 If no timer is active, return -1.
4585 As long as any timer is ripe, we run it.
4587 DO_IT_NOW is now ignored. It used to mean that we should
4588 run the timer directly instead of queueing a timer-event.
4589 Now we always run timers directly. */
4592 timer_check (int do_it_now
)
4594 EMACS_TIME nexttime
;
4598 nexttime
= timer_check_2 ();
4600 while (EMACS_SECS (nexttime
) == 0 && EMACS_USECS (nexttime
) == 0);
4605 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4606 doc
: /* Return the current length of Emacs idleness, or nil.
4607 The value when Emacs is idle is a list of three integers. The first has
4608 the most significant 16 bits of the seconds, while the second has the least
4609 significant 16 bits. The third integer gives the microsecond count.
4611 The value when Emacs is not idle is nil.
4613 The microsecond count is zero on systems that do not provide
4614 resolution finer than a second. */)
4617 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4619 EMACS_TIME now
, idleness_now
;
4621 EMACS_GET_TIME (now
);
4622 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4624 return list3 (make_number ((EMACS_SECS (idleness_now
) >> 16) & 0xffff),
4625 make_number ((EMACS_SECS (idleness_now
) >> 0) & 0xffff),
4626 make_number (EMACS_USECS (idleness_now
)));
4632 /* Caches for modify_event_symbol. */
4633 static Lisp_Object accent_key_syms
;
4634 static Lisp_Object func_key_syms
;
4635 static Lisp_Object mouse_syms
;
4636 static Lisp_Object wheel_syms
;
4637 static Lisp_Object drag_n_drop_syms
;
4639 /* This is a list of keysym codes for special "accent" characters.
4640 It parallels lispy_accent_keys. */
4642 static const int lispy_accent_codes
[] =
4644 #ifdef XK_dead_circumflex
4649 #ifdef XK_dead_grave
4654 #ifdef XK_dead_tilde
4659 #ifdef XK_dead_diaeresis
4664 #ifdef XK_dead_macron
4669 #ifdef XK_dead_degree
4674 #ifdef XK_dead_acute
4679 #ifdef XK_dead_cedilla
4684 #ifdef XK_dead_breve
4689 #ifdef XK_dead_ogonek
4694 #ifdef XK_dead_caron
4699 #ifdef XK_dead_doubleacute
4700 XK_dead_doubleacute
,
4704 #ifdef XK_dead_abovedot
4709 #ifdef XK_dead_abovering
4719 #ifdef XK_dead_belowdot
4724 #ifdef XK_dead_voiced_sound
4725 XK_dead_voiced_sound
,
4729 #ifdef XK_dead_semivoiced_sound
4730 XK_dead_semivoiced_sound
,
4746 /* This is a list of Lisp names for special "accent" characters.
4747 It parallels lispy_accent_codes. */
4749 static char *lispy_accent_keys
[] =
4767 "dead-voiced-sound",
4768 "dead-semivoiced-sound",
4774 #define FUNCTION_KEY_OFFSET 0x0
4776 char *lispy_function_keys
[] =
4780 0, /* VK_LBUTTON 0x01 */
4781 0, /* VK_RBUTTON 0x02 */
4782 "cancel", /* VK_CANCEL 0x03 */
4783 0, /* VK_MBUTTON 0x04 */
4785 0, 0, 0, /* 0x05 .. 0x07 */
4787 "backspace", /* VK_BACK 0x08 */
4788 "tab", /* VK_TAB 0x09 */
4790 0, 0, /* 0x0A .. 0x0B */
4792 "clear", /* VK_CLEAR 0x0C */
4793 "return", /* VK_RETURN 0x0D */
4795 0, 0, /* 0x0E .. 0x0F */
4797 0, /* VK_SHIFT 0x10 */
4798 0, /* VK_CONTROL 0x11 */
4799 0, /* VK_MENU 0x12 */
4800 "pause", /* VK_PAUSE 0x13 */
4801 "capslock", /* VK_CAPITAL 0x14 */
4802 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4804 "junja", /* VK_JUNJA 0x17 */
4805 "final", /* VK_FINAL 0x18 */
4806 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4808 "escape", /* VK_ESCAPE 0x1B */
4809 "convert", /* VK_CONVERT 0x1C */
4810 "non-convert", /* VK_NONCONVERT 0x1D */
4811 "accept", /* VK_ACCEPT 0x1E */
4812 "mode-change", /* VK_MODECHANGE 0x1F */
4813 0, /* VK_SPACE 0x20 */
4814 "prior", /* VK_PRIOR 0x21 */
4815 "next", /* VK_NEXT 0x22 */
4816 "end", /* VK_END 0x23 */
4817 "home", /* VK_HOME 0x24 */
4818 "left", /* VK_LEFT 0x25 */
4819 "up", /* VK_UP 0x26 */
4820 "right", /* VK_RIGHT 0x27 */
4821 "down", /* VK_DOWN 0x28 */
4822 "select", /* VK_SELECT 0x29 */
4823 "print", /* VK_PRINT 0x2A */
4824 "execute", /* VK_EXECUTE 0x2B */
4825 "snapshot", /* VK_SNAPSHOT 0x2C */
4826 "insert", /* VK_INSERT 0x2D */
4827 "delete", /* VK_DELETE 0x2E */
4828 "help", /* VK_HELP 0x2F */
4830 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4832 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4834 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4836 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4838 0, 0, 0, 0, 0, 0, 0, 0, 0,
4839 0, 0, 0, 0, 0, 0, 0, 0, 0,
4840 0, 0, 0, 0, 0, 0, 0, 0,
4842 "lwindow", /* VK_LWIN 0x5B */
4843 "rwindow", /* VK_RWIN 0x5C */
4844 "apps", /* VK_APPS 0x5D */
4847 "kp-0", /* VK_NUMPAD0 0x60 */
4848 "kp-1", /* VK_NUMPAD1 0x61 */
4849 "kp-2", /* VK_NUMPAD2 0x62 */
4850 "kp-3", /* VK_NUMPAD3 0x63 */
4851 "kp-4", /* VK_NUMPAD4 0x64 */
4852 "kp-5", /* VK_NUMPAD5 0x65 */
4853 "kp-6", /* VK_NUMPAD6 0x66 */
4854 "kp-7", /* VK_NUMPAD7 0x67 */
4855 "kp-8", /* VK_NUMPAD8 0x68 */
4856 "kp-9", /* VK_NUMPAD9 0x69 */
4857 "kp-multiply", /* VK_MULTIPLY 0x6A */
4858 "kp-add", /* VK_ADD 0x6B */
4859 "kp-separator", /* VK_SEPARATOR 0x6C */
4860 "kp-subtract", /* VK_SUBTRACT 0x6D */
4861 "kp-decimal", /* VK_DECIMAL 0x6E */
4862 "kp-divide", /* VK_DIVIDE 0x6F */
4863 "f1", /* VK_F1 0x70 */
4864 "f2", /* VK_F2 0x71 */
4865 "f3", /* VK_F3 0x72 */
4866 "f4", /* VK_F4 0x73 */
4867 "f5", /* VK_F5 0x74 */
4868 "f6", /* VK_F6 0x75 */
4869 "f7", /* VK_F7 0x76 */
4870 "f8", /* VK_F8 0x77 */
4871 "f9", /* VK_F9 0x78 */
4872 "f10", /* VK_F10 0x79 */
4873 "f11", /* VK_F11 0x7A */
4874 "f12", /* VK_F12 0x7B */
4875 "f13", /* VK_F13 0x7C */
4876 "f14", /* VK_F14 0x7D */
4877 "f15", /* VK_F15 0x7E */
4878 "f16", /* VK_F16 0x7F */
4879 "f17", /* VK_F17 0x80 */
4880 "f18", /* VK_F18 0x81 */
4881 "f19", /* VK_F19 0x82 */
4882 "f20", /* VK_F20 0x83 */
4883 "f21", /* VK_F21 0x84 */
4884 "f22", /* VK_F22 0x85 */
4885 "f23", /* VK_F23 0x86 */
4886 "f24", /* VK_F24 0x87 */
4888 0, 0, 0, 0, /* 0x88 .. 0x8B */
4889 0, 0, 0, 0, /* 0x8C .. 0x8F */
4891 "kp-numlock", /* VK_NUMLOCK 0x90 */
4892 "scroll", /* VK_SCROLL 0x91 */
4893 /* Not sure where the following block comes from.
4894 Windows headers have NEC and Fujitsu specific keys in
4895 this block, but nothing generic. */
4896 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4897 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4898 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4899 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4900 "kp-end", /* VK_NUMPAD_END 0x96 */
4901 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4902 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4903 "kp-up", /* VK_NUMPAD_UP 0x99 */
4904 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4905 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4906 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4907 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4909 0, 0, /* 0x9E .. 0x9F */
4912 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4913 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4914 * No other API or message will distinguish left and right keys this way.
4919 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4920 to enable them selectively, and gives access to a few more functions.
4921 See lispy_multimedia_keys below. */
4922 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4923 0, 0, 0, /* 0xAD .. 0xAF Volume */
4924 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4925 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4927 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4928 0, 0, 0, 0, 0, 0, 0, 0, 0,
4930 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4931 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4932 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4935 "ax", /* VK_OEM_AX 0xE1 */
4936 0, /* VK_OEM_102 0xE2 */
4937 "ico-help", /* VK_ICO_HELP 0xE3 */
4938 "ico-00", /* VK_ICO_00 0xE4 */
4939 0, /* VK_PROCESSKEY 0xE5 */
4940 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4941 "packet", /* VK_PACKET 0xE7 */
4943 "reset", /* VK_OEM_RESET 0xE9 */
4944 "jump", /* VK_OEM_JUMP 0xEA */
4945 "oem-pa1", /* VK_OEM_PA1 0xEB */
4946 "oem-pa2", /* VK_OEM_PA2 0xEC */
4947 "oem-pa3", /* VK_OEM_PA3 0xED */
4948 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4949 "cusel", /* VK_OEM_CUSEL 0xEF */
4950 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4951 "finish", /* VK_OEM_FINISH 0xF1 */
4952 "copy", /* VK_OEM_COPY 0xF2 */
4953 "auto", /* VK_OEM_AUTO 0xF3 */
4954 "enlw", /* VK_OEM_ENLW 0xF4 */
4955 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4956 "attn", /* VK_ATTN 0xF6 */
4957 "crsel", /* VK_CRSEL 0xF7 */
4958 "exsel", /* VK_EXSEL 0xF8 */
4959 "ereof", /* VK_EREOF 0xF9 */
4960 "play", /* VK_PLAY 0xFA */
4961 "zoom", /* VK_ZOOM 0xFB */
4962 "noname", /* VK_NONAME 0xFC */
4963 "pa1", /* VK_PA1 0xFD */
4964 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4968 /* Some of these duplicate the "Media keys" on newer keyboards,
4969 but they are delivered to the application in a different way. */
4970 static char *lispy_multimedia_keys
[] =
4978 "browser-favorites",
5015 "toggle-dictate-command",
5021 "media-fast-forward",
5024 "media-channel-down"
5027 #else /* not HAVE_NTGUI */
5029 /* This should be dealt with in XTread_socket now, and that doesn't
5030 depend on the client system having the Kana syms defined. See also
5031 the XK_kana_A case below. */
5034 static char *lispy_kana_keys
[] =
5036 /* X Keysym value */
5037 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5038 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5039 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5040 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5041 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5042 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5043 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5044 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5045 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5046 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5047 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5048 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5049 "kana-i", "kana-u", "kana-e", "kana-o",
5050 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5051 "prolongedsound", "kana-A", "kana-I", "kana-U",
5052 "kana-E", "kana-O", "kana-KA", "kana-KI",
5053 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5054 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5055 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5056 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5057 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5058 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5059 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5060 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5061 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5062 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5063 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5064 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5066 #endif /* XK_kana_A */
5069 #define FUNCTION_KEY_OFFSET 0xff00
5071 /* You'll notice that this table is arranged to be conveniently
5072 indexed by X Windows keysym values. */
5073 static char *lispy_function_keys
[] =
5075 /* X Keysym value */
5077 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5078 "backspace", "tab", "linefeed", "clear",
5080 0, 0, 0, "pause", /* 0xff10...1f */
5081 0, 0, 0, 0, 0, 0, 0, "escape",
5083 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5084 "romaji", "hiragana", "katakana", "hiragana-katakana",
5085 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5086 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5087 "eisu-toggle", /* 0xff30...3f */
5088 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5089 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5091 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5092 "down", "prior", "next", "end",
5093 "begin", 0, 0, 0, 0, 0, 0, 0,
5094 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5105 "break", /* 0xff6b */
5108 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5109 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5110 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5111 0, 0, 0, 0, 0, 0, 0, 0,
5112 "kp-tab", /* 0xff89 */
5114 "kp-enter", /* 0xff8d */
5116 "kp-f1", /* 0xff91 */
5120 "kp-home", /* 0xff95 */
5125 "kp-prior", /* kp-page-up */
5126 "kp-next", /* kp-page-down */
5132 0, 0, 0, 0, 0, 0, 0, 0, 0,
5133 "kp-multiply", /* 0xffaa */
5138 "kp-divide", /* 0xffaf */
5139 "kp-0", /* 0xffb0 */
5140 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5143 "kp-equal", /* 0xffbd */
5144 "f1", /* 0xffbe */ /* IsFunctionKey */
5146 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5147 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5148 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5149 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5150 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5151 0, 0, 0, 0, 0, 0, 0, 0,
5152 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5153 0, 0, 0, 0, 0, 0, 0, "delete"
5156 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5157 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5159 static char *iso_lispy_function_keys
[] =
5161 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5162 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5163 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5164 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5165 "iso-lefttab", /* 0xfe20 */
5166 "iso-move-line-up", "iso-move-line-down",
5167 "iso-partial-line-up", "iso-partial-line-down",
5168 "iso-partial-space-left", "iso-partial-space-right",
5169 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5170 "iso-release-margin-left", "iso-release-margin-right",
5171 "iso-release-both-margins",
5172 "iso-fast-cursor-left", "iso-fast-cursor-right",
5173 "iso-fast-cursor-up", "iso-fast-cursor-down",
5174 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5175 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5178 #endif /* not HAVE_NTGUI */
5180 Lisp_Object Vlispy_mouse_stem
;
5182 static char *lispy_wheel_names
[] =
5184 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5187 /* drag-n-drop events are generated when a set of selected files are
5188 dragged from another application and dropped onto an Emacs window. */
5189 static char *lispy_drag_n_drop_names
[] =
5194 /* Scroll bar parts. */
5195 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5196 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5197 Lisp_Object Qtop
, Qratio
;
5199 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5200 Lisp_Object
*scroll_bar_parts
[] = {
5201 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5202 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5205 /* A vector, indexed by button number, giving the down-going location
5206 of currently depressed buttons, both scroll bar and non-scroll bar.
5208 The elements have the form
5209 (BUTTON-NUMBER MODIFIER-MASK . REST)
5210 where REST is the cdr of a position as it would be reported in the event.
5212 The make_lispy_event function stores positions here to tell the
5213 difference between click and drag events, and to store the starting
5214 location to be included in drag events. */
5216 static Lisp_Object button_down_location
;
5218 /* Information about the most recent up-going button event: Which
5219 button, what location, and what time. */
5221 static int last_mouse_button
;
5222 static int last_mouse_x
;
5223 static int last_mouse_y
;
5224 static unsigned long button_down_time
;
5226 /* The maximum time between clicks to make a double-click, or Qnil to
5227 disable double-click detection, or Qt for no time limit. */
5229 Lisp_Object Vdouble_click_time
;
5231 /* Maximum number of pixels the mouse may be moved between clicks
5232 to make a double-click. */
5234 EMACS_INT double_click_fuzz
;
5236 /* The number of clicks in this multiple-click. */
5238 int double_click_count
;
5240 /* Return position of a mouse click or wheel event */
5243 make_lispy_position (struct frame
*f
, Lisp_Object
*x
, Lisp_Object
*y
,
5247 enum window_part part
;
5248 Lisp_Object posn
= Qnil
;
5249 Lisp_Object extra_info
= Qnil
;
5252 /* Set `window' to the window under frame pixel coordinates (x,y) */
5254 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5255 &part
, &wx
, &wy
, 0);
5259 if (WINDOWP (window
))
5261 /* It's a click in window window at frame coordinates (x,y) */
5262 struct window
*w
= XWINDOW (window
);
5263 Lisp_Object string_info
= Qnil
;
5264 int textpos
= -1, rx
= -1, ry
= -1;
5265 int dx
= -1, dy
= -1;
5266 int width
= -1, height
= -1;
5267 Lisp_Object object
= Qnil
;
5269 /* Set event coordinates to window-relative coordinates
5270 for constructing the Lisp event below. */
5274 if (part
== ON_TEXT
)
5276 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5278 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5280 /* Mode line or header line. Look for a string under
5281 the mouse that may have a `local-map' property. */
5285 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5287 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5288 &object
, &dx
, &dy
, &width
, &height
);
5289 if (STRINGP (string
))
5290 string_info
= Fcons (string
, make_number (charpos
));
5291 if (w
== XWINDOW (selected_window
)
5292 && current_buffer
== XBUFFER (w
->buffer
))
5295 textpos
= XMARKER (w
->pointm
)->charpos
;
5297 else if (part
== ON_VERTICAL_BORDER
)
5299 posn
= Qvertical_line
;
5304 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5309 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5311 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5312 &object
, &dx
, &dy
, &width
, &height
);
5313 if (STRINGP (string
))
5314 string_info
= Fcons (string
, make_number (charpos
));
5315 if (part
== ON_LEFT_MARGIN
)
5318 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5320 else if (part
== ON_LEFT_FRINGE
)
5322 posn
= Qleft_fringe
;
5325 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5327 : window_box_width (w
, LEFT_MARGIN_AREA
));
5330 else if (part
== ON_RIGHT_FRINGE
)
5332 posn
= Qright_fringe
;
5335 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5336 + window_box_width (w
, TEXT_AREA
)
5337 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5338 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5344 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5345 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5350 Lisp_Object string2
, object2
= Qnil
;
5351 struct display_pos p
;
5353 int width2
, height2
;
5354 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5355 &object2
, &dx2
, &dy2
,
5357 textpos
= CHARPOS (p
.pos
);
5358 if (rx
< 0) rx
= wx
;
5359 if (ry
< 0) ry
= wy
;
5360 if (dx
< 0) dx
= dx2
;
5361 if (dy
< 0) dy
= dy2
;
5362 if (width
< 0) width
= width2
;
5363 if (height
< 0) height
= height2
;
5367 posn
= make_number (textpos
);
5368 if (STRINGP (string2
))
5369 string_info
= Fcons (string2
,
5370 make_number (CHARPOS (p
.string_pos
)));
5376 #ifdef HAVE_WINDOW_SYSTEM
5377 if (IMAGEP (object
))
5379 Lisp_Object image_map
, hotspot
;
5380 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5382 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5384 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5385 posn
= XCAR (hotspot
);
5390 extra_info
= Fcons (object
,
5391 Fcons (Fcons (make_number (dx
),
5393 Fcons (Fcons (make_number (width
),
5394 make_number (height
)),
5398 extra_info
= Fcons (string_info
,
5399 Fcons (make_number (textpos
),
5400 Fcons (Fcons (make_number (rx
),
5406 XSETFRAME (window
, f
);
5411 XSETFASTINT (*x
, 0);
5412 XSETFASTINT (*y
, 0);
5415 return Fcons (window
,
5417 Fcons (Fcons (*x
, *y
),
5418 Fcons (make_number (time
),
5422 /* Given a struct input_event, build the lisp event which represents
5423 it. If EVENT is 0, build a mouse movement event from the mouse
5424 movement buffer, which should have a movement event in it.
5426 Note that events must be passed to this function in the order they
5427 are received; this function stores the location of button presses
5428 in order to build drag events when the button is released. */
5431 make_lispy_event (struct input_event
*event
)
5435 switch (SWITCH_ENUM_CAST (event
->kind
))
5437 /* A simple keystroke. */
5438 case ASCII_KEYSTROKE_EVENT
:
5439 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5441 Lisp_Object lispy_c
;
5442 int c
= event
->code
;
5443 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5446 eassert (c
== event
->code
);
5447 /* Turn ASCII characters into control characters
5449 if (event
->modifiers
& ctrl_modifier
)
5451 c
= make_ctrl_char (c
);
5452 event
->modifiers
&= ~ctrl_modifier
;
5456 /* Add in the other modifier bits. The shift key was taken care
5457 of by the X code. */
5458 c
|= (event
->modifiers
5459 & (meta_modifier
| alt_modifier
5460 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5461 /* Distinguish Shift-SPC from SPC. */
5462 if ((event
->code
) == 040
5463 && event
->modifiers
& shift_modifier
)
5464 c
|= shift_modifier
;
5465 button_down_time
= 0;
5466 XSETFASTINT (lispy_c
, c
);
5471 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5472 except that they are non-key events (last-nonmenu-event is nil). */
5473 case NS_NONKEY_EVENT
:
5476 /* A function key. The symbol may need to have modifier prefixes
5478 case NON_ASCII_KEYSTROKE_EVENT
:
5479 button_down_time
= 0;
5481 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5482 if (event
->code
== lispy_accent_codes
[i
])
5483 return modify_event_symbol (i
,
5485 Qfunction_key
, Qnil
,
5486 lispy_accent_keys
, &accent_key_syms
,
5487 (sizeof (lispy_accent_keys
)
5488 / sizeof (lispy_accent_keys
[0])));
5492 if (event
->code
>= 0x400 && event
->code
< 0x500)
5493 return modify_event_symbol (event
->code
- 0x400,
5494 event
->modifiers
& ~shift_modifier
,
5495 Qfunction_key
, Qnil
,
5496 lispy_kana_keys
, &func_key_syms
,
5497 (sizeof (lispy_kana_keys
)
5498 / sizeof (lispy_kana_keys
[0])));
5499 #endif /* XK_kana_A */
5502 #ifdef ISO_FUNCTION_KEY_OFFSET
5503 if (event
->code
< FUNCTION_KEY_OFFSET
5504 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5505 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5507 Qfunction_key
, Qnil
,
5508 iso_lispy_function_keys
, &func_key_syms
,
5509 (sizeof (iso_lispy_function_keys
)
5510 / sizeof (iso_lispy_function_keys
[0])));
5513 /* Handle system-specific or unknown keysyms. */
5514 if (event
->code
& (1 << 28)
5515 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5516 || (event
->code
- FUNCTION_KEY_OFFSET
5517 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5518 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5520 /* We need to use an alist rather than a vector as the cache
5521 since we can't make a vector long enuf. */
5522 if (NILP (current_kboard
->system_key_syms
))
5523 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5524 return modify_event_symbol (event
->code
,
5527 current_kboard
->Vsystem_key_alist
,
5528 0, ¤t_kboard
->system_key_syms
,
5532 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5534 Qfunction_key
, Qnil
,
5535 lispy_function_keys
, &func_key_syms
,
5536 (sizeof (lispy_function_keys
)
5537 / sizeof (lispy_function_keys
[0])));
5540 case MULTIMEDIA_KEY_EVENT
:
5541 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5542 / sizeof (lispy_multimedia_keys
[0]))
5543 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5545 return modify_event_symbol (event
->code
, event
->modifiers
,
5546 Qfunction_key
, Qnil
,
5547 lispy_multimedia_keys
, &func_key_syms
,
5548 (sizeof (lispy_multimedia_keys
)
5549 / sizeof (lispy_multimedia_keys
[0])));
5555 /* A mouse click. Figure out where it is, decide whether it's
5556 a press, click or drag, and build the appropriate structure. */
5557 case MOUSE_CLICK_EVENT
:
5558 #ifndef USE_TOOLKIT_SCROLL_BARS
5559 case SCROLL_BAR_CLICK_EVENT
:
5562 int button
= event
->code
;
5564 Lisp_Object position
;
5565 Lisp_Object
*start_pos_ptr
;
5566 Lisp_Object start_pos
;
5570 /* Build the position as appropriate for this mouse click. */
5571 if (event
->kind
== MOUSE_CLICK_EVENT
)
5573 struct frame
*f
= XFRAME (event
->frame_or_window
);
5574 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5578 /* Ignore mouse events that were made on frame that
5579 have been deleted. */
5580 if (! FRAME_LIVE_P (f
))
5583 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5584 /* EVENT->x and EVENT->y are frame-relative pixel
5585 coordinates at this place. Under old redisplay, COLUMN
5586 and ROW are set to frame relative glyph coordinates
5587 which are then used to determine whether this click is
5588 in a menu (non-toolkit version). */
5589 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5590 &column
, &row
, NULL
, 1);
5592 /* In the non-toolkit version, clicks on the menu bar
5593 are ordinary button events in the event buffer.
5594 Distinguish them, and invoke the menu.
5596 (In the toolkit version, the toolkit handles the menu bar
5597 and Emacs doesn't know about it until after the user
5598 makes a selection.) */
5599 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5600 && (event
->modifiers
& down_modifier
))
5602 Lisp_Object items
, item
;
5607 /* Activate the menu bar on the down event. If the
5608 up event comes in before the menu code can deal with it,
5610 if (! (event
->modifiers
& down_modifier
))
5614 /* Find the menu bar item under `column'. */
5616 items
= FRAME_MENU_BAR_ITEMS (f
);
5617 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5619 Lisp_Object pos
, string
;
5620 string
= AREF (items
, i
+ 1);
5621 pos
= AREF (items
, i
+ 3);
5624 if (column
>= XINT (pos
)
5625 && column
< XINT (pos
) + SCHARS (string
))
5627 item
= AREF (items
, i
);
5632 /* ELisp manual 2.4b says (x y) are window relative but
5633 code says they are frame-relative. */
5635 = Fcons (event
->frame_or_window
,
5637 Fcons (Fcons (event
->x
, event
->y
),
5638 Fcons (make_number (event
->timestamp
),
5641 return Fcons (item
, Fcons (position
, Qnil
));
5643 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5645 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5648 #ifndef USE_TOOLKIT_SCROLL_BARS
5651 /* It's a scrollbar click. */
5653 Lisp_Object portion_whole
;
5656 window
= event
->frame_or_window
;
5657 portion_whole
= Fcons (event
->x
, event
->y
);
5658 part
= *scroll_bar_parts
[(int) event
->part
];
5662 Fcons (Qvertical_scroll_bar
,
5663 Fcons (portion_whole
,
5664 Fcons (make_number (event
->timestamp
),
5665 Fcons (part
, Qnil
)))));
5667 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5669 if (button
>= ASIZE (button_down_location
))
5671 button_down_location
= larger_vector (button_down_location
,
5673 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5676 start_pos_ptr
= &AREF (button_down_location
, button
);
5677 start_pos
= *start_pos_ptr
;
5678 *start_pos_ptr
= Qnil
;
5681 /* On window-system frames, use the value of
5682 double-click-fuzz as is. On other frames, interpret it
5683 as a multiple of 1/8 characters. */
5687 if (WINDOWP (event
->frame_or_window
))
5688 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5689 else if (FRAMEP (event
->frame_or_window
))
5690 f
= XFRAME (event
->frame_or_window
);
5694 if (FRAME_WINDOW_P (f
))
5695 fuzz
= double_click_fuzz
;
5697 fuzz
= double_click_fuzz
/ 8;
5699 is_double
= (button
== last_mouse_button
5700 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5701 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5702 && button_down_time
!= 0
5703 && (EQ (Vdouble_click_time
, Qt
)
5704 || (INTEGERP (Vdouble_click_time
)
5705 && ((int)(event
->timestamp
- button_down_time
)
5706 < XINT (Vdouble_click_time
)))));
5709 last_mouse_button
= button
;
5710 last_mouse_x
= XINT (event
->x
);
5711 last_mouse_y
= XINT (event
->y
);
5713 /* If this is a button press, squirrel away the location, so
5714 we can decide later whether it was a click or a drag. */
5715 if (event
->modifiers
& down_modifier
)
5719 double_click_count
++;
5720 event
->modifiers
|= ((double_click_count
> 2)
5725 double_click_count
= 1;
5726 button_down_time
= event
->timestamp
;
5727 *start_pos_ptr
= Fcopy_alist (position
);
5728 ignore_mouse_drag_p
= 0;
5731 /* Now we're releasing a button - check the co-ordinates to
5732 see if this was a click or a drag. */
5733 else if (event
->modifiers
& up_modifier
)
5735 /* If we did not see a down before this up, ignore the up.
5736 Probably this happened because the down event chose a
5737 menu item. It would be an annoyance to treat the
5738 release of the button that chose the menu item as a
5741 if (!CONSP (start_pos
))
5744 event
->modifiers
&= ~up_modifier
;
5745 #if 0 /* Formerly we treated an up with no down as a click event. */
5746 if (!CONSP (start_pos
))
5747 event
->modifiers
|= click_modifier
;
5752 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5754 /* The third element of every position
5755 should be the (x,y) pair. */
5756 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5758 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5760 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5761 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5764 if (ignore_mouse_drag_p
)
5766 event
->modifiers
|= click_modifier
;
5767 ignore_mouse_drag_p
= 0;
5769 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5770 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5771 /* Maybe the mouse has moved a lot, caused scrolling, and
5772 eventually ended up at the same screen position (but
5773 not buffer position) in which case it is a drag, not
5775 /* FIXME: OTOH if the buffer position has changed
5776 because of a timer or process filter rather than
5777 because of mouse movement, it should be considered as
5778 a click. But mouse-drag-region completely ignores
5779 this case and it hasn't caused any real problem, so
5780 it's probably OK to ignore it as well. */
5781 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5782 /* Mouse hasn't moved (much). */
5783 event
->modifiers
|= click_modifier
;
5786 button_down_time
= 0;
5787 event
->modifiers
|= drag_modifier
;
5790 /* Don't check is_double; treat this as multiple
5791 if the down-event was multiple. */
5792 if (double_click_count
> 1)
5793 event
->modifiers
|= ((double_click_count
> 2)
5799 /* Every mouse event should either have the down_modifier or
5800 the up_modifier set. */
5804 /* Get the symbol we should use for the mouse click. */
5807 head
= modify_event_symbol (button
,
5809 Qmouse_click
, Vlispy_mouse_stem
,
5812 XVECTOR (mouse_syms
)->size
);
5813 if (event
->modifiers
& drag_modifier
)
5818 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5821 Fcons (make_number (double_click_count
),
5831 case HORIZ_WHEEL_EVENT
:
5833 Lisp_Object position
;
5836 /* Build the position as appropriate for this mouse click. */
5837 struct frame
*f
= XFRAME (event
->frame_or_window
);
5839 /* Ignore wheel events that were made on frame that have been
5841 if (! FRAME_LIVE_P (f
))
5844 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5847 /* Set double or triple modifiers to indicate the wheel speed. */
5849 /* On window-system frames, use the value of
5850 double-click-fuzz as is. On other frames, interpret it
5851 as a multiple of 1/8 characters. */
5857 if (WINDOWP (event
->frame_or_window
))
5858 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5859 else if (FRAMEP (event
->frame_or_window
))
5860 f
= XFRAME (event
->frame_or_window
);
5864 if (FRAME_WINDOW_P (f
))
5865 fuzz
= double_click_fuzz
;
5867 fuzz
= double_click_fuzz
/ 8;
5869 if (event
->modifiers
& up_modifier
)
5871 /* Emit a wheel-up event. */
5872 event
->modifiers
&= ~up_modifier
;
5875 else if (event
->modifiers
& down_modifier
)
5877 /* Emit a wheel-down event. */
5878 event
->modifiers
&= ~down_modifier
;
5882 /* Every wheel event should either have the down_modifier or
5883 the up_modifier set. */
5886 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5889 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5890 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5891 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5892 && button_down_time
!= 0
5893 && (EQ (Vdouble_click_time
, Qt
)
5894 || (INTEGERP (Vdouble_click_time
)
5895 && ((int)(event
->timestamp
- button_down_time
)
5896 < XINT (Vdouble_click_time
)))));
5899 double_click_count
++;
5900 event
->modifiers
|= ((double_click_count
> 2)
5906 double_click_count
= 1;
5907 event
->modifiers
|= click_modifier
;
5910 button_down_time
= event
->timestamp
;
5911 /* Use a negative value to distinguish wheel from mouse button. */
5912 last_mouse_button
= - (1 + symbol_num
);
5913 last_mouse_x
= XINT (event
->x
);
5914 last_mouse_y
= XINT (event
->y
);
5916 /* Get the symbol we should use for the wheel event. */
5917 head
= modify_event_symbol (symbol_num
,
5923 ASIZE (wheel_syms
));
5926 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5929 Fcons (make_number (double_click_count
),
5938 #ifdef USE_TOOLKIT_SCROLL_BARS
5940 /* We don't have down and up events if using toolkit scroll bars,
5941 so make this always a click event. Store in the `part' of
5942 the Lisp event a symbol which maps to the following actions:
5944 `above_handle' page up
5945 `below_handle' page down
5949 `bottom' bottom of buffer
5950 `handle' thumb has been dragged.
5951 `end-scroll' end of interaction with scroll bar
5953 The incoming input_event contains in its `part' member an
5954 index of type `enum scroll_bar_part' which we can use as an
5955 index in scroll_bar_parts to get the appropriate symbol. */
5957 case SCROLL_BAR_CLICK_EVENT
:
5959 Lisp_Object position
, head
, window
, portion_whole
, part
;
5961 window
= event
->frame_or_window
;
5962 portion_whole
= Fcons (event
->x
, event
->y
);
5963 part
= *scroll_bar_parts
[(int) event
->part
];
5967 Fcons (Qvertical_scroll_bar
,
5968 Fcons (portion_whole
,
5969 Fcons (make_number (event
->timestamp
),
5970 Fcons (part
, Qnil
)))));
5972 /* Always treat scroll bar events as clicks. */
5973 event
->modifiers
|= click_modifier
;
5974 event
->modifiers
&= ~up_modifier
;
5976 if (event
->code
>= ASIZE (mouse_syms
))
5977 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5979 /* Get the symbol we should use for the mouse click. */
5980 head
= modify_event_symbol (event
->code
,
5985 XVECTOR (mouse_syms
)->size
);
5986 return Fcons (head
, Fcons (position
, Qnil
));
5989 #endif /* USE_TOOLKIT_SCROLL_BARS */
5991 case DRAG_N_DROP_EVENT
:
5994 Lisp_Object head
, position
;
5997 f
= XFRAME (event
->frame_or_window
);
6000 /* Ignore mouse events that were made on frames that
6001 have been deleted. */
6002 if (! FRAME_LIVE_P (f
))
6005 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6008 head
= modify_event_symbol (0, event
->modifiers
,
6010 lispy_drag_n_drop_names
,
6011 &drag_n_drop_syms
, 1);
6017 #endif /* HAVE_MOUSE */
6019 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6020 || defined(HAVE_NS) || defined (USE_GTK)
6021 case MENU_BAR_EVENT
:
6022 if (EQ (event
->arg
, event
->frame_or_window
))
6023 /* This is the prefix key. We translate this to
6024 `(menu_bar)' because the code in keyboard.c for menu
6025 events, which we use, relies on this. */
6026 return Fcons (Qmenu_bar
, Qnil
);
6030 case SELECT_WINDOW_EVENT
:
6031 /* Make an event (select-window (WINDOW)). */
6032 return Fcons (Qselect_window
,
6033 Fcons (Fcons (event
->frame_or_window
, Qnil
),
6036 case TOOL_BAR_EVENT
:
6037 if (EQ (event
->arg
, event
->frame_or_window
))
6038 /* This is the prefix key. We translate this to
6039 `(tool_bar)' because the code in keyboard.c for tool bar
6040 events, which we use, relies on this. */
6041 return Fcons (Qtool_bar
, Qnil
);
6042 else if (SYMBOLP (event
->arg
))
6043 return apply_modifiers (event
->modifiers
, event
->arg
);
6046 case USER_SIGNAL_EVENT
:
6047 /* A user signal. */
6049 char *name
= find_user_signal_name (event
->code
);
6052 return intern (name
);
6055 case SAVE_SESSION_EVENT
:
6056 return Qsave_session
;
6061 return Fcons (Qdbus_event
, event
->arg
);
6063 #endif /* HAVE_DBUS */
6065 case CONFIG_CHANGED_EVENT
:
6066 return Fcons (Qconfig_changed_event
,
6068 Fcons (event
->frame_or_window
, Qnil
)));
6070 case GPM_CLICK_EVENT
:
6072 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
6073 Lisp_Object head
, position
;
6074 Lisp_Object
*start_pos_ptr
;
6075 Lisp_Object start_pos
;
6076 int button
= event
->code
;
6078 if (button
>= ASIZE (button_down_location
))
6080 button_down_location
= larger_vector (button_down_location
,
6082 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
6085 start_pos_ptr
= &AREF (button_down_location
, button
);
6086 start_pos
= *start_pos_ptr
;
6088 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
6091 if (event
->modifiers
& down_modifier
)
6092 *start_pos_ptr
= Fcopy_alist (position
);
6093 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6095 if (!CONSP (start_pos
))
6097 event
->modifiers
&= ~up_modifier
;
6100 head
= modify_event_symbol (button
,
6102 Qmouse_click
, Vlispy_mouse_stem
,
6105 XVECTOR (mouse_syms
)->size
);
6107 if (event
->modifiers
& drag_modifier
)
6112 else if (event
->modifiers
& double_modifier
)
6115 Fcons (make_number (2),
6117 else if (event
->modifiers
& triple_modifier
)
6120 Fcons (make_number (3),
6127 #endif /* HAVE_GPM */
6129 /* The 'kind' field of the event is something we don't recognize. */
6135 #if defined(HAVE_MOUSE) || defined(HAVE_GPM)
6138 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6139 Lisp_Object x
, Lisp_Object y
, unsigned long time
)
6141 /* Is it a scroll bar movement? */
6142 if (frame
&& ! NILP (bar_window
))
6144 Lisp_Object part_sym
;
6146 part_sym
= *scroll_bar_parts
[(int) part
];
6147 return Fcons (Qscroll_bar_movement
,
6148 (Fcons (Fcons (bar_window
,
6149 Fcons (Qvertical_scroll_bar
,
6150 Fcons (Fcons (x
, y
),
6151 Fcons (make_number (time
),
6157 /* Or is it an ordinary mouse movement? */
6160 Lisp_Object position
;
6162 position
= make_lispy_position (frame
, &x
, &y
, time
);
6164 return Fcons (Qmouse_movement
,
6170 #endif /* HAVE_MOUSE || HAVE GPM */
6172 /* Construct a switch frame event. */
6174 make_lispy_switch_frame (Lisp_Object frame
)
6176 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6179 /* Manipulating modifiers. */
6181 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6183 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6184 SYMBOL's name of the end of the modifiers; the string from this
6185 position is the unmodified symbol name.
6187 This doesn't use any caches. */
6190 parse_modifiers_uncached (Lisp_Object symbol
, int *modifier_end
)
6196 CHECK_SYMBOL (symbol
);
6199 name
= SYMBOL_NAME (symbol
);
6201 for (i
= 0; i
+2 <= SBYTES (name
); )
6203 int this_mod_end
= 0;
6206 /* See if the name continues with a modifier word.
6207 Check that the word appears, but don't check what follows it.
6208 Set this_mod and this_mod_end to record what we find. */
6210 switch (SREF (name
, i
))
6212 #define SINGLE_LETTER_MOD(BIT) \
6213 (this_mod_end = i + 1, this_mod = BIT)
6216 SINGLE_LETTER_MOD (alt_modifier
);
6220 SINGLE_LETTER_MOD (ctrl_modifier
);
6224 SINGLE_LETTER_MOD (hyper_modifier
);
6228 SINGLE_LETTER_MOD (meta_modifier
);
6232 SINGLE_LETTER_MOD (shift_modifier
);
6236 SINGLE_LETTER_MOD (super_modifier
);
6239 #undef SINGLE_LETTER_MOD
6241 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6242 if (i + LEN + 1 <= SBYTES (name) \
6243 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6245 this_mod_end = i + LEN; \
6250 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6251 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6252 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6256 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6258 #undef MULTI_LETTER_MOD
6262 /* If we found no modifier, stop looking for them. */
6263 if (this_mod_end
== 0)
6266 /* Check there is a dash after the modifier, so that it
6267 really is a modifier. */
6268 if (this_mod_end
>= SBYTES (name
)
6269 || SREF (name
, this_mod_end
) != '-')
6272 /* This modifier is real; look for another. */
6273 modifiers
|= this_mod
;
6274 i
= this_mod_end
+ 1;
6277 /* Should we include the `click' modifier? */
6278 if (! (modifiers
& (down_modifier
| drag_modifier
6279 | double_modifier
| triple_modifier
))
6280 && i
+ 7 == SBYTES (name
)
6281 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6282 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6283 modifiers
|= click_modifier
;
6285 if (! (modifiers
& (double_modifier
| triple_modifier
))
6286 && i
+ 6 < SBYTES (name
)
6287 && strncmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6288 modifiers
|= click_modifier
;
6296 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6297 prepended to the string BASE[0..BASE_LEN-1].
6298 This doesn't use any caches. */
6300 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6302 /* Since BASE could contain nulls, we can't use intern here; we have
6303 to use Fintern, which expects a genuine Lisp_String, and keeps a
6306 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6312 /* Only the event queue may use the `up' modifier; it should always
6313 be turned into a click or drag event before presented to lisp code. */
6314 if (modifiers
& up_modifier
)
6317 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6318 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6319 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6320 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6321 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6322 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6323 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6324 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6325 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6326 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6327 /* The click modifier is denoted by the absence of other modifiers. */
6331 mod_len
= p
- new_mods
;
6335 Lisp_Object new_name
;
6337 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6338 mod_len
+ base_len_byte
);
6339 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6340 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6342 return Fintern (new_name
, Qnil
);
6347 static const char *modifier_names
[] =
6349 "up", "down", "drag", "click", "double", "triple", 0, 0,
6350 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6351 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6353 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6355 static Lisp_Object modifier_symbols
;
6357 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6359 lispy_modifier_list (int modifiers
)
6361 Lisp_Object modifier_list
;
6364 modifier_list
= Qnil
;
6365 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6366 if (modifiers
& (1<<i
))
6367 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6370 return modifier_list
;
6374 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6375 where UNMODIFIED is the unmodified form of SYMBOL,
6376 MASK is the set of modifiers present in SYMBOL's name.
6377 This is similar to parse_modifiers_uncached, but uses the cache in
6378 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6379 Qevent_symbol_elements property. */
6381 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6384 parse_modifiers (Lisp_Object symbol
)
6386 Lisp_Object elements
;
6388 if (INTEGERP (symbol
))
6389 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6390 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6392 else if (!SYMBOLP (symbol
))
6395 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6396 if (CONSP (elements
))
6401 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6402 Lisp_Object unmodified
;
6405 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6406 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6409 if (modifiers
& ~INTMASK
)
6411 XSETFASTINT (mask
, modifiers
);
6412 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6414 /* Cache the parsing results on SYMBOL. */
6415 Fput (symbol
, Qevent_symbol_element_mask
,
6417 Fput (symbol
, Qevent_symbol_elements
,
6418 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6420 /* Since we know that SYMBOL is modifiers applied to unmodified,
6421 it would be nice to put that in unmodified's cache.
6422 But we can't, since we're not sure that parse_modifiers is
6429 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6430 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6431 doc
: /* Parse the event symbol. For internal use. */)
6435 /* Fill the cache if needed. */
6436 parse_modifiers (symbol
);
6437 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6438 and use the Lispier representation stored on Qevent_symbol_elements
6440 return Fget (symbol
, Qevent_symbol_elements
);
6443 /* Apply the modifiers MODIFIERS to the symbol BASE.
6444 BASE must be unmodified.
6446 This is like apply_modifiers_uncached, but uses BASE's
6447 Qmodifier_cache property, if present. It also builds
6448 Qevent_symbol_elements properties, since it has that info anyway.
6450 apply_modifiers copies the value of BASE's Qevent_kind property to
6451 the modified symbol. */
6453 apply_modifiers (int modifiers
, Lisp_Object base
)
6455 Lisp_Object cache
, index
, entry
, new_symbol
;
6457 /* Mask out upper bits. We don't know where this value's been. */
6458 modifiers
&= INTMASK
;
6460 if (INTEGERP (base
))
6461 return make_number (XINT (base
) | modifiers
);
6463 /* The click modifier never figures into cache indices. */
6464 cache
= Fget (base
, Qmodifier_cache
);
6465 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6466 entry
= assq_no_quit (index
, cache
);
6469 new_symbol
= XCDR (entry
);
6472 /* We have to create the symbol ourselves. */
6473 new_symbol
= apply_modifiers_uncached (modifiers
,
6474 SDATA (SYMBOL_NAME (base
)),
6475 SCHARS (SYMBOL_NAME (base
)),
6476 SBYTES (SYMBOL_NAME (base
)));
6478 /* Add the new symbol to the base's cache. */
6479 entry
= Fcons (index
, new_symbol
);
6480 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6482 /* We have the parsing info now for free, so we could add it to
6484 XSETFASTINT (index, modifiers);
6485 Fput (new_symbol, Qevent_symbol_element_mask,
6486 Fcons (base, Fcons (index, Qnil)));
6487 Fput (new_symbol, Qevent_symbol_elements,
6488 Fcons (base, lispy_modifier_list (modifiers)));
6489 Sadly, this is only correct if `base' is indeed a base event,
6490 which is not necessarily the case. -stef */
6493 /* Make sure this symbol is of the same kind as BASE.
6495 You'd think we could just set this once and for all when we
6496 intern the symbol above, but reorder_modifiers may call us when
6497 BASE's property isn't set right; we can't assume that just
6498 because it has a Qmodifier_cache property it must have its
6499 Qevent_kind set right as well. */
6500 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6504 kind
= Fget (base
, Qevent_kind
);
6506 Fput (new_symbol
, Qevent_kind
, kind
);
6513 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6514 return a symbol with the modifiers placed in the canonical order.
6515 Canonical order is alphabetical, except for down and drag, which
6516 always come last. The 'click' modifier is never written out.
6518 Fdefine_key calls this to make sure that (for example) C-M-foo
6519 and M-C-foo end up being equivalent in the keymap. */
6522 reorder_modifiers (Lisp_Object symbol
)
6524 /* It's hopefully okay to write the code this way, since everything
6525 will soon be in caches, and no consing will be done at all. */
6528 parsed
= parse_modifiers (symbol
);
6529 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6534 /* For handling events, we often want to produce a symbol whose name
6535 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6536 to some base, like the name of a function key or mouse button.
6537 modify_event_symbol produces symbols of this sort.
6539 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6540 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6543 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6544 into symbol names, or a string specifying a name stem used to
6545 construct a symbol name or the form `STEM-N', where N is the decimal
6546 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6547 non-nil; otherwise NAME_TABLE is used.
6549 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6550 persist between calls to modify_event_symbol that it can use to
6551 store a cache of the symbols it's generated for this NAME_TABLE
6552 before. The object stored there may be a vector or an alist.
6554 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6556 MODIFIERS is a set of modifier bits (as given in struct input_events)
6557 whose prefixes should be applied to the symbol name.
6559 SYMBOL_KIND is the value to be placed in the event_kind property of
6560 the returned symbol.
6562 The symbols we create are supposed to have an
6563 `event-symbol-elements' property, which lists the modifiers present
6564 in the symbol's name. */
6567 modify_event_symbol (int symbol_num
, unsigned int modifiers
, Lisp_Object symbol_kind
,
6568 Lisp_Object name_alist_or_stem
, char **name_table
,
6569 Lisp_Object
*symbol_table
, unsigned int table_size
)
6572 Lisp_Object symbol_int
;
6574 /* Get rid of the "vendor-specific" bit here. */
6575 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6577 /* Is this a request for a valid symbol? */
6578 if (symbol_num
< 0 || symbol_num
>= table_size
)
6581 if (CONSP (*symbol_table
))
6582 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6584 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6585 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6586 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6587 we've never used that symbol before. */
6590 if (! VECTORP (*symbol_table
)
6591 || XVECTOR (*symbol_table
)->size
!= table_size
)
6595 XSETFASTINT (size
, table_size
);
6596 *symbol_table
= Fmake_vector (size
, Qnil
);
6599 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6602 /* Have we already used this symbol before? */
6605 /* No; let's create it. */
6606 if (CONSP (name_alist_or_stem
))
6607 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6608 else if (STRINGP (name_alist_or_stem
))
6610 int len
= SBYTES (name_alist_or_stem
);
6611 char *buf
= (char *) alloca (len
+ 50);
6612 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6613 (long) XINT (symbol_int
) + 1);
6614 value
= intern (buf
);
6616 else if (name_table
!= 0 && name_table
[symbol_num
])
6617 value
= intern (name_table
[symbol_num
]);
6619 #ifdef HAVE_WINDOW_SYSTEM
6622 char *name
= x_get_keysym_name (symbol_num
);
6624 value
= intern (name
);
6631 sprintf (buf
, "key-%d", symbol_num
);
6632 value
= intern (buf
);
6635 if (CONSP (*symbol_table
))
6636 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6638 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6640 /* Fill in the cache entries for this symbol; this also
6641 builds the Qevent_symbol_elements property, which the user
6643 apply_modifiers (modifiers
& click_modifier
, value
);
6644 Fput (value
, Qevent_kind
, symbol_kind
);
6647 /* Apply modifiers to that symbol. */
6648 return apply_modifiers (modifiers
, value
);
6651 /* Convert a list that represents an event type,
6652 such as (ctrl meta backspace), into the usual representation of that
6653 event type as a number or a symbol. */
6655 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6656 doc
: /* Convert the event description list EVENT-DESC to an event type.
6657 EVENT-DESC should contain one base event type (a character or symbol)
6658 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6659 drag, down, double or triple). The base must be last.
6660 The return value is an event type (a character or symbol) which
6661 has the same base event type and all the specified modifiers. */)
6663 Lisp_Object event_desc
;
6671 while (CONSP (rest
))
6679 /* Given a symbol, see if it is a modifier name. */
6680 if (SYMBOLP (elt
) && CONSP (rest
))
6681 this = parse_solitary_modifier (elt
);
6685 else if (!NILP (base
))
6686 error ("Two bases given in one event");
6692 /* Let the symbol A refer to the character A. */
6693 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6694 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6696 if (INTEGERP (base
))
6698 /* Turn (shift a) into A. */
6699 if ((modifiers
& shift_modifier
) != 0
6700 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6702 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6703 modifiers
&= ~shift_modifier
;
6706 /* Turn (control a) into C-a. */
6707 if (modifiers
& ctrl_modifier
)
6708 return make_number ((modifiers
& ~ctrl_modifier
)
6709 | make_ctrl_char (XINT (base
)));
6711 return make_number (modifiers
| XINT (base
));
6713 else if (SYMBOLP (base
))
6714 return apply_modifiers (modifiers
, base
);
6717 error ("Invalid base event");
6722 /* Try to recognize SYMBOL as a modifier name.
6723 Return the modifier flag bit, or 0 if not recognized. */
6726 parse_solitary_modifier (Lisp_Object symbol
)
6728 Lisp_Object name
= SYMBOL_NAME (symbol
);
6730 switch (SREF (name
, 0))
6732 #define SINGLE_LETTER_MOD(BIT) \
6733 if (SBYTES (name) == 1) \
6736 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6737 if (LEN == SBYTES (name) \
6738 && ! strncmp (SDATA (name), NAME, LEN)) \
6742 SINGLE_LETTER_MOD (alt_modifier
);
6746 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6750 SINGLE_LETTER_MOD (ctrl_modifier
);
6754 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6755 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6759 SINGLE_LETTER_MOD (hyper_modifier
);
6763 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6767 SINGLE_LETTER_MOD (meta_modifier
);
6771 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6775 SINGLE_LETTER_MOD (shift_modifier
);
6779 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6780 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6781 SINGLE_LETTER_MOD (super_modifier
);
6785 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6786 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6787 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6791 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6794 #undef SINGLE_LETTER_MOD
6795 #undef MULTI_LETTER_MOD
6801 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6802 Such a list is not valid as an event,
6803 but it can be a Lucid-style event type list. */
6806 lucid_event_type_list_p (Lisp_Object object
)
6810 if (! CONSP (object
))
6813 if (EQ (XCAR (object
), Qhelp_echo
)
6814 || EQ (XCAR (object
), Qvertical_line
)
6815 || EQ (XCAR (object
), Qmode_line
)
6816 || EQ (XCAR (object
), Qheader_line
))
6819 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6823 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6830 /* Store into *addr a value nonzero if terminal input chars are available.
6831 Serves the purpose of ioctl (0, FIONREAD, addr)
6832 but works even if FIONREAD does not exist.
6833 (In fact, this may actually read some input.)
6835 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6836 timer events that are ripe.
6837 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6838 events (FOCUS_IN_EVENT).
6839 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6840 movements and toolkit scroll bar thumb drags. */
6843 get_input_pending (int *addr
, int flags
)
6845 /* First of all, have we already counted some input? */
6846 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6848 /* If input is being read as it arrives, and we have none, there is none. */
6849 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6852 /* Try to read some input and see how much we get. */
6854 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6857 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6860 gobble_input (int expected
)
6863 /* Read D-Bus messages. */
6864 xd_read_queued_messages ();
6865 #endif /* HAVE_DBUS */
6868 if (interrupt_input
)
6871 mask
= sigblock (sigmask (SIGIO
));
6872 read_avail_input (expected
);
6876 #ifdef POLL_FOR_INPUT
6877 /* XXX This condition was (read_socket_hook && !interrupt_input),
6878 but read_socket_hook is not global anymore. Let's pretend that
6880 if (!interrupt_input
&& poll_suppress_count
== 0)
6883 mask
= sigblock (sigmask (SIGALRM
));
6884 read_avail_input (expected
);
6890 read_avail_input (expected
);
6893 /* Put a BUFFER_SWITCH_EVENT in the buffer
6894 so that read_key_sequence will notice the new current buffer. */
6897 record_asynch_buffer_change (void)
6899 struct input_event event
;
6903 event
.kind
= BUFFER_SWITCH_EVENT
;
6904 event
.frame_or_window
= Qnil
;
6908 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6909 The purpose of the event is to make read_key_sequence look up the
6910 keymaps again. If we aren't in read_key_sequence, we don't need one,
6911 and the event could cause trouble by messing up (input-pending-p). */
6912 tem
= Fwaiting_for_user_input_p ();
6916 /* We never need these events if we have no asynchronous subprocesses. */
6920 /* Make sure no interrupt happens while storing the event. */
6922 if (interrupt_input
)
6925 mask
= sigblock (sigmask (SIGIO
));
6926 kbd_buffer_store_event (&event
);
6933 kbd_buffer_store_event (&event
);
6938 /* Read any terminal input already buffered up by the system
6939 into the kbd_buffer, but do not wait.
6941 EXPECTED should be nonzero if the caller knows there is some input.
6943 Returns the number of keyboard chars read, or -1 meaning
6944 this is a bad time to try to read input. */
6947 read_avail_input (int expected
)
6953 /* Store pending user signal events, if any. */
6954 if (store_user_signal_events ())
6957 /* Loop through the available terminals, and call their input hooks. */
6961 struct terminal
*next
= t
->next_terminal
;
6963 if (t
->read_socket_hook
)
6966 struct input_event hold_quit
;
6968 EVENT_INIT (hold_quit
);
6969 hold_quit
.kind
= NO_EVENT
;
6971 /* No need for FIONREAD or fcntl; just say don't wait. */
6972 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6978 if (nr
== -1) /* Not OK to read input now. */
6982 else if (nr
== -2) /* Non-transient error. */
6984 /* The terminal device terminated; it should be closed. */
6986 /* Kill Emacs if this was our last terminal. */
6987 if (!terminal_list
->next_terminal
)
6988 /* Formerly simply reported no input, but that
6989 sometimes led to a failure of Emacs to terminate.
6990 SIGHUP seems appropriate if we can't reach the
6992 /* ??? Is it really right to send the signal just to
6993 this process rather than to the whole process
6994 group? Perhaps on systems with FIONREAD Emacs is
6995 alone in its group. */
6996 kill (getpid (), SIGHUP
);
6998 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
7001 XSETTERMINAL (tmp
, t
);
7002 Fdelete_terminal (tmp
, Qnoelisp
);
7006 if (hold_quit
.kind
!= NO_EVENT
)
7007 kbd_buffer_store_event (&hold_quit
);
7016 frame_make_pointer_visible ();
7022 decode_keyboard_code (struct tty_display_info
*tty
,
7023 struct coding_system
*coding
,
7024 unsigned char *buf
, int nbytes
)
7026 unsigned char *src
= buf
;
7027 const unsigned char *p
;
7032 if (tty
->meta_key
!= 2)
7033 for (i
= 0; i
< nbytes
; i
++)
7035 if (coding
->carryover_bytes
> 0)
7037 src
= alloca (coding
->carryover_bytes
+ nbytes
);
7038 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
7039 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
7040 nbytes
+= coding
->carryover_bytes
;
7042 coding
->destination
= alloca (nbytes
* 4);
7043 coding
->dst_bytes
= nbytes
* 4;
7044 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
7045 if (coding
->produced_char
== 0)
7047 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
7049 struct input_event buf
;
7052 buf
.code
= STRING_CHAR_ADVANCE (p
);
7053 buf
.kind
= (ASCII_CHAR_P (buf
.code
)
7054 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
7055 /* See the comment in tty_read_avail_input. */
7056 buf
.frame_or_window
= tty
->top_frame
;
7058 kbd_buffer_store_event (&buf
);
7062 /* This is the tty way of reading available input.
7064 Note that each terminal device has its own `struct terminal' object,
7065 and so this function is called once for each individual termcap
7066 terminal. The first parameter indicates which terminal to read from. */
7069 tty_read_avail_input (struct terminal
*terminal
,
7071 struct input_event
*hold_quit
)
7073 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7074 the kbd_buffer can really hold. That may prevent loss
7075 of characters on some systems when input is stuffed at us. */
7076 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7078 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7080 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
7082 if (kbd_on_hold_p () || buffer_free
<= 0)
7085 if (!terminal
->name
) /* Don't read from a dead terminal. */
7088 if (terminal
->type
!= output_termcap
7089 && terminal
->type
!= output_msdos_raw
)
7092 /* XXX I think the following code should be moved to separate hook
7093 functions in system-dependent files. */
7096 #else /* not WINDOWSNT */
7097 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7101 return 0; /* The terminal is suspended. */
7104 n_to_read
= dos_keysns ();
7108 cbuf
[0] = dos_keyread ();
7111 #else /* not MSDOS */
7116 struct input_event hold_quit
;
7117 int gpm
, fd
= gpm_fd
;
7119 EVENT_INIT (hold_quit
);
7120 hold_quit
.kind
= NO_EVENT
;
7122 /* gpm==1 if event received.
7123 gpm==0 if the GPM daemon has closed the connection, in which case
7124 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7125 we save it in `fd' so close_gpm can remove it from the
7127 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7128 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7129 nread
+= handle_one_term_event (tty
, &event
, &hold_quit
);
7132 /* Presumably the GPM daemon has closed the connection. */
7134 if (hold_quit
.kind
!= NO_EVENT
)
7135 kbd_buffer_store_event (&hold_quit
);
7139 #endif /* HAVE_GPM */
7141 /* Determine how many characters we should *try* to read. */
7143 /* Find out how much input is available. */
7144 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7146 if (! noninteractive
)
7147 return -2; /* Close this terminal. */
7153 if (n_to_read
> sizeof cbuf
)
7154 n_to_read
= sizeof cbuf
;
7155 #else /* no FIONREAD */
7156 #if defined (USG) || defined(CYGWIN)
7157 /* Read some input if available, but don't wait. */
7158 n_to_read
= sizeof cbuf
;
7159 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7165 /* Don't read more than we can store. */
7166 if (n_to_read
> buffer_free
)
7167 n_to_read
= buffer_free
;
7169 /* Now read; for one reason or another, this will not block.
7170 NREAD is set to the number of chars read. */
7173 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
7174 /* POSIX infers that processes which are not in the session leader's
7175 process group won't get SIGHUP's at logout time. BSDI adheres to
7176 this part standard and returns -1 from read (0) with errno==EIO
7177 when the control tty is taken away.
7178 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7179 if (nread
== -1 && errno
== EIO
)
7180 return -2; /* Close this terminal. */
7181 #if defined (AIX) && defined (_BSD)
7182 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7183 This looks incorrect, but it isn't, because _BSD causes
7184 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7185 and that causes a value other than 0 when there is no input. */
7187 return -2; /* Close this terminal. */
7191 /* We used to retry the read if it was interrupted.
7192 But this does the wrong thing when O_NDELAY causes
7193 an EAGAIN error. Does anybody know of a situation
7194 where a retry is actually needed? */
7196 nread
< 0 && (errno
== EAGAIN
7210 #if defined (USG) || defined (CYGWIN)
7211 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7212 #endif /* USG or CYGWIN */
7213 #endif /* no FIONREAD */
7218 #endif /* not MSDOS */
7219 #endif /* not WINDOWSNT */
7221 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7222 & CODING_REQUIRE_DECODING_MASK
)
7224 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7227 /* Decode the key sequence except for those with meta
7229 for (i
= from
= 0; ; i
++)
7230 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7232 struct input_event buf
;
7234 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7239 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7240 buf
.modifiers
= meta_modifier
;
7241 buf
.code
= cbuf
[i
] & ~0x80;
7242 /* See the comment below. */
7243 buf
.frame_or_window
= tty
->top_frame
;
7245 kbd_buffer_store_event (&buf
);
7251 for (i
= 0; i
< nread
; i
++)
7253 struct input_event buf
;
7255 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7257 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7258 buf
.modifiers
= meta_modifier
;
7259 if (tty
->meta_key
!= 2)
7263 /* Set the frame corresponding to the active tty. Note that the
7264 value of selected_frame is not reliable here, redisplay tends
7265 to temporarily change it. */
7266 buf
.frame_or_window
= tty
->top_frame
;
7269 kbd_buffer_store_event (&buf
);
7270 /* Don't look at input that follows a C-g too closely.
7271 This reduces lossage due to autorepeat on C-g. */
7272 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7273 && buf
.code
== quit_char
)
7281 handle_async_input (void)
7283 interrupt_input_pending
= 0;
7285 pending_signals
= pending_atimers
;
7287 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7288 doing anything dangerous. */
7295 nread
= read_avail_input (1);
7296 /* -1 means it's not ok to read the input now.
7297 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7298 0 means there was no keyboard input available. */
7308 process_pending_signals (void)
7310 if (interrupt_input_pending
)
7311 handle_async_input ();
7312 do_pending_atimers ();
7315 #ifdef SIGIO /* for entire page */
7316 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7319 input_available_signal (int signo
)
7321 /* Must preserve main program's value of errno. */
7322 int old_errno
= errno
;
7323 SIGNAL_THREAD_CHECK (signo
);
7326 interrupt_input_pending
= 1;
7327 pending_signals
= 1;
7330 if (input_available_clear_time
)
7331 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7334 handle_async_input ();
7341 /* Send ourselves a SIGIO.
7343 This function exists so that the UNBLOCK_INPUT macro in
7344 blockinput.h can have some way to take care of input we put off
7345 dealing with, without assuming that every file which uses
7346 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7348 reinvoke_input_signal (void)
7351 handle_async_input ();
7357 /* User signal events. */
7359 struct user_signal_info
7361 /* Signal number. */
7364 /* Name of the signal. */
7367 /* Number of pending signals. */
7370 struct user_signal_info
*next
;
7373 /* List of user signals. */
7374 static struct user_signal_info
*user_signals
= NULL
;
7377 add_user_signal (int sig
, const char *name
)
7379 struct user_signal_info
*p
;
7381 for (p
= user_signals
; p
; p
= p
->next
)
7383 /* Already added. */
7386 p
= xmalloc (sizeof (struct user_signal_info
));
7388 p
->name
= xstrdup (name
);
7390 p
->next
= user_signals
;
7393 signal (sig
, handle_user_signal
);
7397 handle_user_signal (int sig
)
7399 int old_errno
= errno
;
7400 struct user_signal_info
*p
;
7402 SIGNAL_THREAD_CHECK (sig
);
7404 for (p
= user_signals
; p
; p
= p
->next
)
7409 if (interrupt_input
)
7410 kill (getpid (), SIGIO
);
7414 /* Tell wait_reading_process_output that it needs to wake
7415 up and look around. */
7416 if (input_available_clear_time
)
7417 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7426 find_user_signal_name (int sig
)
7428 struct user_signal_info
*p
;
7430 for (p
= user_signals
; p
; p
= p
->next
)
7438 store_user_signal_events (void)
7440 struct user_signal_info
*p
;
7441 struct input_event buf
;
7444 for (p
= user_signals
; p
; p
= p
->next
)
7445 if (p
->npending
> 0)
7451 memset (&buf
, 0, sizeof buf
);
7452 buf
.kind
= USER_SIGNAL_EVENT
;
7453 buf
.frame_or_window
= selected_frame
;
7455 nstored
+= p
->npending
;
7457 mask
= sigblock (sigmask (p
->sig
));
7461 kbd_buffer_store_event (&buf
);
7464 while (p
->npending
> 0);
7472 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7473 static Lisp_Object menu_bar_one_keymap_changed_items
;
7475 /* These variables hold the vector under construction within
7476 menu_bar_items and its subroutines, and the current index
7477 for storing into that vector. */
7478 static Lisp_Object menu_bar_items_vector
;
7479 static int menu_bar_items_index
;
7481 /* Return a vector of menu items for a menu bar, appropriate
7482 to the current buffer. Each item has three elements in the vector:
7485 OLD is an old vector we can optionally reuse, or nil. */
7488 menu_bar_items (Lisp_Object old
)
7490 /* The number of keymaps we're scanning right now, and the number of
7491 keymaps we have allocated space for. */
7494 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7495 in the current keymaps, or nil where it is not a prefix. */
7498 Lisp_Object def
, tail
;
7507 /* In order to build the menus, we need to call the keymap
7508 accessors. They all call QUIT. But this function is called
7509 during redisplay, during which a quit is fatal. So inhibit
7510 quitting while building the menus.
7511 We do this instead of specbind because (1) errors will clear it anyway
7512 and (2) this avoids risk of specpdl overflow. */
7513 oquit
= Vinhibit_quit
;
7517 menu_bar_items_vector
= old
;
7519 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7520 menu_bar_items_index
= 0;
7522 /* Build our list of keymaps.
7523 If we recognize a function key and replace its escape sequence in
7524 keybuf with its symbol, or if the sequence starts with a mouse
7525 click and we need to switch buffers, we jump back here to rebuild
7526 the initial keymaps from the current buffer. */
7530 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7531 if (!NILP (Voverriding_local_map_menu_flag
))
7533 /* Yes, use them (if non-nil) as well as the global map. */
7534 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7536 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7537 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7538 if (!NILP (Voverriding_local_map
))
7539 maps
[nmaps
++] = Voverriding_local_map
;
7543 /* No, so use major and minor mode keymaps and keymap property.
7544 Note that menu-bar bindings in the local-map and keymap
7545 properties may not work reliable, as they are only
7546 recognized when the menu-bar (or mode-line) is updated,
7547 which does not normally happen after every command. */
7550 nminor
= current_minor_maps (NULL
, &tmaps
);
7551 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7553 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7554 maps
[nmaps
++] = tem
;
7555 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7557 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7559 maps
[nmaps
++] = current_global_map
;
7562 /* Look up in each map the dummy prefix key `menu-bar'. */
7566 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7567 if (!NILP (maps
[mapno
]))
7569 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7573 menu_bar_one_keymap_changed_items
= Qnil
;
7574 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7578 /* Move to the end those items that should be at the end. */
7580 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7583 int end
= menu_bar_items_index
;
7585 for (i
= 0; i
< end
; i
+= 4)
7586 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7588 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7589 /* Move the item at index I to the end,
7590 shifting all the others forward. */
7591 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7592 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7593 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7594 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7596 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7597 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7598 (end
- i
- 4) * sizeof (Lisp_Object
));
7599 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7600 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7601 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7602 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7607 /* Add nil, nil, nil, nil at the end. */
7608 i
= menu_bar_items_index
;
7609 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7610 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7611 /* Add this item. */
7612 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7613 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7614 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7615 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7616 menu_bar_items_index
= i
;
7618 Vinhibit_quit
= oquit
;
7619 return menu_bar_items_vector
;
7622 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7623 If there's already an item for KEY, add this DEF to it. */
7625 Lisp_Object item_properties
;
7628 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7630 struct gcpro gcpro1
;
7634 if (EQ (item
, Qundefined
))
7636 /* If a map has an explicit `undefined' as definition,
7637 discard any previously made menu bar item. */
7639 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7640 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7642 if (menu_bar_items_index
> i
+ 4)
7643 memmove (&XVECTOR (menu_bar_items_vector
)->contents
[i
],
7644 &XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7645 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7646 menu_bar_items_index
-= 4;
7650 /* If this keymap has already contributed to this KEY,
7651 don't contribute to it a second time. */
7652 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7653 if (!NILP (tem
) || NILP (item
))
7656 menu_bar_one_keymap_changed_items
7657 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7659 /* We add to menu_bar_one_keymap_changed_items before doing the
7660 parse_menu_item, so that if it turns out it wasn't a menu item,
7661 it still correctly hides any further menu item. */
7663 i
= parse_menu_item (item
, 1);
7668 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7670 /* Find any existing item for this KEY. */
7671 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7672 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7675 /* If we did not find this KEY, add it at the end. */
7676 if (i
== menu_bar_items_index
)
7678 /* If vector is too small, get a bigger one. */
7679 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7680 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 2 * i
, Qnil
);
7681 /* Add this item. */
7682 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7683 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7684 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7685 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7686 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7687 menu_bar_items_index
= i
;
7689 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7693 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7694 /* If the new and the old items are not both keymaps,
7695 the lookup will only find `item'. */
7696 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7697 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7701 /* This is used as the handler when calling menu_item_eval_property. */
7703 menu_item_eval_property_1 (Lisp_Object arg
)
7705 /* If we got a quit from within the menu computation,
7706 quit all the way out of it. This takes care of C-] in the debugger. */
7707 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7708 Fsignal (Qquit
, Qnil
);
7713 /* Evaluate an expression and return the result (or nil if something
7714 went wrong). Used to evaluate dynamic parts of menu items. */
7716 menu_item_eval_property (Lisp_Object sexpr
)
7718 int count
= SPECPDL_INDEX ();
7720 specbind (Qinhibit_redisplay
, Qt
);
7721 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7722 menu_item_eval_property_1
);
7723 return unbind_to (count
, val
);
7726 /* This function parses a menu item and leaves the result in the
7727 vector item_properties.
7728 ITEM is a key binding, a possible menu item.
7729 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7731 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7732 parse_menu_item returns true if the item is a menu item and false
7736 parse_menu_item (Lisp_Object item
, int inmenubar
)
7738 Lisp_Object def
, tem
, item_string
, start
;
7740 Lisp_Object keyhint
;
7749 /* Create item_properties vector if necessary. */
7750 if (NILP (item_properties
))
7752 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7754 /* Initialize optional entries. */
7755 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7756 ASET (item_properties
, i
, Qnil
);
7757 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7759 /* Save the item here to protect it from GC. */
7760 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7762 item_string
= XCAR (item
);
7766 if (STRINGP (item_string
))
7768 /* Old format menu item. */
7769 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7771 /* Maybe help string. */
7772 if (CONSP (item
) && STRINGP (XCAR (item
)))
7774 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7779 /* Maybe an obsolete key binding cache. */
7780 if (CONSP (item
) && CONSP (XCAR (item
))
7781 && (NILP (XCAR (XCAR (item
)))
7782 || VECTORP (XCAR (XCAR (item
)))))
7785 /* This is the real definition--the function to run. */
7786 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7788 /* Get enable property, if any. */
7791 tem
= Fget (item
, Qmenu_enable
);
7792 if (!NILP (Venable_disabled_menus_and_buttons
))
7793 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7794 else if (!NILP (tem
))
7795 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7798 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7800 /* New format menu item. */
7801 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7802 start
= XCDR (item
);
7805 /* We have a real binding. */
7806 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7808 item
= XCDR (start
);
7809 /* Is there an obsolete cache list with key equivalences. */
7810 if (CONSP (item
) && CONSP (XCAR (item
)))
7813 /* Parse properties. */
7814 while (CONSP (item
) && CONSP (XCDR (item
)))
7819 if (EQ (tem
, QCenable
))
7821 if (!NILP (Venable_disabled_menus_and_buttons
))
7822 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7824 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7826 else if (EQ (tem
, QCvisible
))
7828 /* If got a visible property and that evaluates to nil
7829 then ignore this item. */
7830 tem
= menu_item_eval_property (XCAR (item
));
7834 else if (EQ (tem
, QChelp
))
7835 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7836 else if (EQ (tem
, QCfilter
))
7838 else if (EQ (tem
, QCkey_sequence
))
7841 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7842 /* Be GC protected. Set keyhint to item instead of tem. */
7845 else if (EQ (tem
, QCkeys
))
7848 if (CONSP (tem
) || STRINGP (tem
))
7849 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7851 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7856 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7858 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7860 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7866 else if (inmenubar
|| !NILP (start
))
7870 return 0; /* not a menu item */
7872 /* If item string is not a string, evaluate it to get string.
7873 If we don't get a string, skip this item. */
7874 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7875 if (!(STRINGP (item_string
)))
7877 item_string
= menu_item_eval_property (item_string
);
7878 if (!STRINGP (item_string
))
7880 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7883 /* If got a filter apply it on definition. */
7884 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7887 def
= menu_item_eval_property (list2 (XCAR (filter
),
7888 list2 (Qquote
, def
)));
7890 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7893 /* Enable or disable selection of item. */
7894 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7897 tem
= menu_item_eval_property (tem
);
7898 if (inmenubar
&& NILP (tem
))
7899 return 0; /* Ignore disabled items in menu bar. */
7900 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7903 /* If we got no definition, this item is just unselectable text which
7904 is OK in a submenu but not in the menubar. */
7906 return (inmenubar
? 0 : 1);
7908 /* See if this is a separate pane or a submenu. */
7909 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7910 tem
= get_keymap (def
, 0, 1);
7911 /* For a subkeymap, just record its details and exit. */
7914 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7915 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7919 /* At the top level in the menu bar, do likewise for commands also.
7920 The menu bar does not display equivalent key bindings anyway.
7921 ITEM_PROPERTY_DEF is already set up properly. */
7925 { /* This is a command. See if there is an equivalent key binding. */
7926 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7928 /* The previous code preferred :key-sequence to :keys, so we
7929 preserve this behavior. */
7930 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7931 keyeq
= Fsubstitute_command_keys (keyeq
);
7934 Lisp_Object prefix
= keyeq
;
7935 Lisp_Object keys
= Qnil
;
7939 def
= XCAR (prefix
);
7940 prefix
= XCDR (prefix
);
7943 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7945 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7947 keys
= XCAR (keyhint
);
7948 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7950 /* We have a suggested key. Is it bound to the command? */
7953 /* If the command is an alias for another
7954 (such as lmenu.el set it up), check if the
7955 original command matches the cached command. */
7956 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7961 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7965 tem
= Fkey_description (keys
, Qnil
);
7968 if (STRINGP (XCAR (prefix
)))
7969 tem
= concat2 (XCAR (prefix
), tem
);
7970 if (STRINGP (XCDR (prefix
)))
7971 tem
= concat2 (tem
, XCDR (prefix
));
7973 keyeq
= concat2 (build_string (" "), tem
);
7974 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7980 /* If we have an equivalent key binding, use that. */
7981 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7984 /* Include this when menu help is implemented.
7985 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7986 if (!(NILP (tem) || STRINGP (tem)))
7988 tem = menu_item_eval_property (tem);
7991 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7995 /* Handle radio buttons or toggle boxes. */
7996 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7998 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7999 menu_item_eval_property (tem
));
8006 /***********************************************************************
8008 ***********************************************************************/
8010 /* A vector holding tool bar items while they are parsed in function
8011 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8014 static Lisp_Object tool_bar_items_vector
;
8016 /* A vector holding the result of parse_tool_bar_item. Layout is like
8017 the one for a single item in tool_bar_items_vector. */
8019 static Lisp_Object tool_bar_item_properties
;
8021 /* Next free index in tool_bar_items_vector. */
8023 static int ntool_bar_items
;
8025 /* The symbols `tool-bar', `:image' and `:rtl'. */
8027 extern Lisp_Object Qtool_bar
;
8028 Lisp_Object QCimage
;
8031 /* Function prototypes. */
8033 static void init_tool_bar_items (Lisp_Object
);
8034 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8035 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8036 static void append_tool_bar_item (void);
8039 /* Return a vector of tool bar items for keymaps currently in effect.
8040 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8041 tool bar items found. */
8044 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8053 /* In order to build the menus, we need to call the keymap
8054 accessors. They all call QUIT. But this function is called
8055 during redisplay, during which a quit is fatal. So inhibit
8056 quitting while building the menus. We do this instead of
8057 specbind because (1) errors will clear it anyway and (2) this
8058 avoids risk of specpdl overflow. */
8059 oquit
= Vinhibit_quit
;
8062 /* Initialize tool_bar_items_vector and protect it from GC. */
8063 init_tool_bar_items (reuse
);
8065 /* Build list of keymaps in maps. Set nmaps to the number of maps
8068 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8069 if (!NILP (Voverriding_local_map_menu_flag
))
8071 /* Yes, use them (if non-nil) as well as the global map. */
8072 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
8074 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8075 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8076 if (!NILP (Voverriding_local_map
))
8077 maps
[nmaps
++] = Voverriding_local_map
;
8081 /* No, so use major and minor mode keymaps and keymap property.
8082 Note that tool-bar bindings in the local-map and keymap
8083 properties may not work reliable, as they are only
8084 recognized when the tool-bar (or mode-line) is updated,
8085 which does not normally happen after every command. */
8088 nminor
= current_minor_maps (NULL
, &tmaps
);
8089 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
8091 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8092 maps
[nmaps
++] = tem
;
8093 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8095 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8098 /* Add global keymap at the end. */
8099 maps
[nmaps
++] = current_global_map
;
8101 /* Process maps in reverse order and look up in each map the prefix
8103 for (i
= nmaps
- 1; i
>= 0; --i
)
8104 if (!NILP (maps
[i
]))
8108 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8110 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8113 Vinhibit_quit
= oquit
;
8114 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8115 return tool_bar_items_vector
;
8119 /* Process the definition of KEY which is DEF. */
8122 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8125 extern Lisp_Object Qundefined
;
8126 struct gcpro gcpro1
, gcpro2
;
8128 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8132 if (EQ (def
, Qundefined
))
8134 /* If a map has an explicit `undefined' as definition,
8135 discard any previously made item. */
8136 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8138 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8140 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8142 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8143 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8144 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8145 * sizeof (Lisp_Object
)));
8146 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8151 else if (parse_tool_bar_item (key
, def
))
8152 /* Append a new tool bar item to tool_bar_items_vector. Accept
8153 more than one definition for the same key. */
8154 append_tool_bar_item ();
8160 /* Parse a tool bar item specification ITEM for key KEY and return the
8161 result in tool_bar_item_properties. Value is zero if ITEM is
8164 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8166 CAPTION is the caption of the item, If it's not a string, it is
8167 evaluated to get a string.
8169 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8170 as binding are currently ignored.
8172 The following properties are recognized:
8176 FORM is evaluated and specifies whether the tool bar item is
8177 enabled or disabled.
8181 FORM is evaluated and specifies whether the tool bar item is visible.
8183 - `:filter FUNCTION'
8185 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8186 result is stored as the new binding.
8188 - `:button (TYPE SELECTED)'
8190 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8191 and specifies whether the button is selected (pressed) or not.
8195 IMAGES is either a single image specification or a vector of four
8196 image specifications. See enum tool_bar_item_images.
8198 - `:help HELP-STRING'.
8200 Gives a help string to display for the tool bar item.
8202 - `:label LABEL-STRING'.
8204 A text label to show with the tool bar button if labels are enabled. */
8207 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8209 /* Access slot with index IDX of vector tool_bar_item_properties. */
8210 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
8212 Lisp_Object filter
= Qnil
;
8213 Lisp_Object caption
;
8214 int i
, have_label
= 0;
8216 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
8217 Rule out items that aren't lists, don't start with
8218 `menu-item' or whose rest following `tool-bar-item' is not a
8221 || !EQ (XCAR (item
), Qmenu_item
)
8222 || (item
= XCDR (item
),
8226 /* Create tool_bar_item_properties vector if necessary. Reset it to
8228 if (VECTORP (tool_bar_item_properties
))
8230 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8234 tool_bar_item_properties
8235 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8238 PROP (TOOL_BAR_ITEM_KEY
) = key
;
8239 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8241 /* Get the caption of the item. If the caption is not a string,
8242 evaluate it to get a string. If we don't get a string, skip this
8244 caption
= XCAR (item
);
8245 if (!STRINGP (caption
))
8247 caption
= menu_item_eval_property (caption
);
8248 if (!STRINGP (caption
))
8251 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
8253 /* Give up if rest following the caption is not a list. */
8258 /* Store the binding. */
8259 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
8262 /* Ignore cached key binding, if any. */
8263 if (CONSP (item
) && CONSP (XCAR (item
)))
8266 /* Process the rest of the properties. */
8267 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8269 Lisp_Object key
, value
;
8272 value
= XCAR (XCDR (item
));
8274 if (EQ (key
, QCenable
))
8276 /* `:enable FORM'. */
8277 if (!NILP (Venable_disabled_menus_and_buttons
))
8278 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
8280 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
8282 else if (EQ (key
, QCvisible
))
8284 /* `:visible FORM'. If got a visible property and that
8285 evaluates to nil then ignore this item. */
8286 if (NILP (menu_item_eval_property (value
)))
8289 else if (EQ (key
, QChelp
))
8290 /* `:help HELP-STRING'. */
8291 PROP (TOOL_BAR_ITEM_HELP
) = value
;
8292 else if (EQ (key
, QClabel
))
8294 /* `:label LABEL-STRING'. */
8295 PROP (TOOL_BAR_ITEM_LABEL
) = value
;
8298 else if (EQ (key
, QCfilter
))
8299 /* ':filter FORM'. */
8301 else if (EQ (key
, QCbutton
) && CONSP (value
))
8303 /* `:button (TYPE . SELECTED)'. */
8304 Lisp_Object type
, selected
;
8306 type
= XCAR (value
);
8307 selected
= XCDR (value
);
8308 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8310 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
8311 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
8314 else if (EQ (key
, QCimage
)
8316 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
8317 /* Value is either a single image specification or a vector
8318 of 4 such specifications for the different button states. */
8319 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
8320 else if (EQ (key
, Qrtl
))
8322 PROP (TOOL_BAR_ITEM_RTL_IMAGE
) = value
;
8328 /* Try to make one from caption and key. */
8329 Lisp_Object key
= PROP (TOOL_BAR_ITEM_KEY
);
8330 Lisp_Object capt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8331 char *label
= SYMBOLP (key
) ? (char *) SDATA (SYMBOL_NAME (key
)) : "";
8332 char *caption
= STRINGP (capt
) ? (char *) SDATA (capt
) : "";
8334 EMACS_INT max_lbl
= 2*tool_bar_max_label_size
;
8335 Lisp_Object new_lbl
;
8337 if (strlen (caption
) < max_lbl
&& caption
[0] != '\0')
8339 strcpy (buf
, caption
);
8340 while (buf
[0] != '\0' && buf
[strlen (buf
) -1] == '.')
8341 buf
[strlen (buf
)-1] = '\0';
8342 if (strlen (buf
) <= max_lbl
)
8346 if (strlen (caption
) <= max_lbl
)
8349 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8352 if (label
!= buf
) strcpy (buf
, label
);
8354 for (i
= 0; i
< strlen (buf
); ++i
)
8356 if (buf
[i
] == '-') buf
[i
] = ' ';
8363 new_lbl
= Fupcase_initials (make_string (label
, strlen (label
)));
8364 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8365 PROP (TOOL_BAR_ITEM_LABEL
) = new_lbl
;
8368 /* If got a filter apply it on binding. */
8370 PROP (TOOL_BAR_ITEM_BINDING
)
8371 = menu_item_eval_property (list2 (filter
,
8373 PROP (TOOL_BAR_ITEM_BINDING
))));
8375 /* See if the binding is a keymap. Give up if it is. */
8376 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8379 /* Enable or disable selection of item. */
8380 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8381 PROP (TOOL_BAR_ITEM_ENABLED_P
)
8382 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
8384 /* Handle radio buttons or toggle boxes. */
8385 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8386 PROP (TOOL_BAR_ITEM_SELECTED_P
)
8387 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8395 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8396 that can be reused. */
8399 init_tool_bar_items (Lisp_Object reuse
)
8401 if (VECTORP (reuse
))
8402 tool_bar_items_vector
= reuse
;
8404 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8405 ntool_bar_items
= 0;
8409 /* Append parsed tool bar item properties from
8410 tool_bar_item_properties */
8413 append_tool_bar_item (void)
8415 Lisp_Object
*to
, *from
;
8417 /* Enlarge tool_bar_items_vector if necessary. */
8418 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8419 >= XVECTOR (tool_bar_items_vector
)->size
)
8420 tool_bar_items_vector
8421 = larger_vector (tool_bar_items_vector
,
8422 2 * XVECTOR (tool_bar_items_vector
)->size
, Qnil
);
8424 /* Append entries from tool_bar_item_properties to the end of
8425 tool_bar_items_vector. */
8426 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8427 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8428 memcpy (to
, from
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8429 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8436 /* Read a character using menus based on maps in the array MAPS.
8437 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8438 Return t if we displayed a menu but the user rejected it.
8440 PREV_EVENT is the previous input event, or nil if we are reading
8441 the first event of a key sequence.
8443 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8444 if we used a mouse menu to read the input, or zero otherwise. If
8445 USED_MOUSE_MENU is null, we don't dereference it.
8447 The prompting is done based on the prompt-string of the map
8448 and the strings associated with various map elements.
8450 This can be done with X menus or with menus put in the minibuf.
8451 These are done in different ways, depending on how the input will be read.
8452 Menus using X are done after auto-saving in read-char, getting the input
8453 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8454 and do auto-saving in the inner call of read_char. */
8457 read_char_x_menu_prompt (int nmaps
, Lisp_Object
*maps
, Lisp_Object prev_event
,
8458 int *used_mouse_menu
)
8462 if (used_mouse_menu
)
8463 *used_mouse_menu
= 0;
8465 /* Use local over global Menu maps */
8467 if (! menu_prompting
)
8470 /* Optionally disregard all but the global map. */
8471 if (inhibit_local_menu_bar_menus
)
8473 maps
+= (nmaps
- 1);
8478 /* If we got to this point via a mouse click,
8479 use a real menu for mouse selection. */
8480 if (EVENT_HAS_PARAMETERS (prev_event
)
8481 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8482 && !EQ (XCAR (prev_event
), Qtool_bar
))
8484 /* Display the menu and get the selection. */
8485 Lisp_Object
*realmaps
8486 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8490 /* Use the maps that are not nil. */
8491 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8492 if (!NILP (maps
[mapno
]))
8493 realmaps
[nmaps1
++] = maps
[mapno
];
8495 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8500 record_menu_key (XCAR (value
));
8502 /* If we got multiple events, unread all but
8504 There is no way to prevent those unread events
8505 from showing up later in last_nonmenu_event.
8506 So turn symbol and integer events into lists,
8507 to indicate that they came from a mouse menu,
8508 so that when present in last_nonmenu_event
8509 they won't confuse things. */
8510 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8512 record_menu_key (XCAR (tem
));
8513 if (SYMBOLP (XCAR (tem
))
8514 || INTEGERP (XCAR (tem
)))
8515 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8518 /* If we got more than one event, put all but the first
8519 onto this list to be read later.
8520 Return just the first event now. */
8521 Vunread_command_events
8522 = nconc2 (XCDR (value
), Vunread_command_events
);
8523 value
= XCAR (value
);
8525 else if (NILP (value
))
8527 if (used_mouse_menu
)
8528 *used_mouse_menu
= 1;
8531 #endif /* HAVE_MENUS */
8535 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8536 We make this bigger when necessary, and never free it. */
8537 static char *read_char_minibuf_menu_text
;
8538 /* Size of that buffer. */
8539 static int read_char_minibuf_menu_width
;
8542 read_char_minibuf_menu_prompt (int commandflag
, int nmaps
, Lisp_Object
*maps
)
8545 register Lisp_Object name
;
8547 /* FIXME: Use the minibuffer's frame width. */
8548 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8551 Lisp_Object rest
, vector
;
8557 if (! menu_prompting
)
8560 /* Get the menu name from the first map that has one (a prompt string). */
8561 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8563 name
= Fkeymap_prompt (maps
[mapno
]);
8568 /* If we don't have any menus, just read a character normally. */
8569 if (!STRINGP (name
))
8572 /* Make sure we have a big enough buffer for the menu text. */
8573 width
= max (width
, SBYTES (name
));
8574 if (read_char_minibuf_menu_text
== 0)
8576 read_char_minibuf_menu_width
= width
+ 4;
8577 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8579 else if (width
+ 4 > read_char_minibuf_menu_width
)
8581 read_char_minibuf_menu_width
= width
+ 4;
8582 read_char_minibuf_menu_text
8583 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8585 menu
= read_char_minibuf_menu_text
;
8587 /* Prompt string always starts with map's prompt, and a space. */
8588 strcpy (menu
, SDATA (name
));
8589 nlength
= SBYTES (name
);
8590 menu
[nlength
++] = ':';
8591 menu
[nlength
++] = ' ';
8594 /* Start prompting at start of first map. */
8598 /* Present the documented bindings, a line at a time. */
8605 Lisp_Object orig_defn_macro
;
8607 /* Loop over elements of map. */
8612 /* If reached end of map, start at beginning of next map. */
8616 /* At end of last map, wrap around to first map if just starting,
8617 or end this line if already have something on it. */
8621 if (notfirst
|| nobindings
) break;
8626 /* Look at the next element of the map. */
8628 elt
= XVECTOR (vector
)->contents
[idx
];
8630 elt
= Fcar_safe (rest
);
8632 if (idx
< 0 && VECTORP (elt
))
8634 /* If we found a dense table in the keymap,
8635 advanced past it, but start scanning its contents. */
8636 rest
= Fcdr_safe (rest
);
8642 /* An ordinary element. */
8643 Lisp_Object event
, tem
;
8647 event
= Fcar_safe (elt
); /* alist */
8648 elt
= Fcdr_safe (elt
);
8652 XSETINT (event
, idx
); /* vector */
8655 /* Ignore the element if it has no prompt string. */
8656 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8658 /* 1 if the char to type matches the string. */
8660 Lisp_Object upcased_event
, downcased_event
;
8661 Lisp_Object desc
= Qnil
;
8663 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8665 upcased_event
= Fupcase (event
);
8666 downcased_event
= Fdowncase (event
);
8667 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8668 || XINT (downcased_event
) == SREF (s
, 0));
8670 desc
= Fsingle_key_description (event
, Qnil
);
8672 #if 0 /* It is redundant to list the equivalent key bindings because
8673 the prefix is what the user has already typed. */
8675 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8677 /* Insert equivalent keybinding. */
8678 s
= concat2 (s
, tem
);
8681 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8682 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8684 /* Insert button prefix. */
8685 Lisp_Object selected
8686 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8687 if (EQ (tem
, QCradio
))
8688 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8690 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8691 s
= concat2 (tem
, s
);
8695 /* If we have room for the prompt string, add it to this line.
8696 If this is the first on the line, always add it. */
8697 if ((SCHARS (s
) + i
+ 2
8698 + (char_matches
? 0 : SCHARS (desc
) + 3))
8704 /* Punctuate between strings. */
8707 strcpy (menu
+ i
, ", ");
8713 /* If the char to type doesn't match the string's
8714 first char, explicitly show what char to type. */
8717 /* Add as much of string as fits. */
8718 thiswidth
= SCHARS (desc
);
8719 if (thiswidth
+ i
> width
)
8720 thiswidth
= width
- i
;
8721 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8723 strcpy (menu
+ i
, " = ");
8727 /* Add as much of string as fits. */
8728 thiswidth
= SCHARS (s
);
8729 if (thiswidth
+ i
> width
)
8730 thiswidth
= width
- i
;
8731 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8737 /* If this element does not fit, end the line now,
8738 and save the element for the next line. */
8739 strcpy (menu
+ i
, "...");
8744 /* Move past this element. */
8745 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8746 /* Handle reaching end of dense table. */
8751 rest
= Fcdr_safe (rest
);
8755 /* Prompt with that and read response. */
8756 message2_nolog (menu
, strlen (menu
),
8757 ! NILP (current_buffer
->enable_multibyte_characters
));
8759 /* Make believe its not a keyboard macro in case the help char
8760 is pressed. Help characters are not recorded because menu prompting
8761 is not used on replay.
8763 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8764 current_kboard
->defining_kbd_macro
= Qnil
;
8766 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8767 while (BUFFERP (obj
));
8768 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8770 if (!INTEGERP (obj
))
8772 else if (XINT (obj
) == -2)
8777 if (! EQ (obj
, menu_prompt_more_char
)
8778 && (!INTEGERP (menu_prompt_more_char
)
8779 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8781 if (!NILP (current_kboard
->defining_kbd_macro
))
8782 store_kbd_macro_char (obj
);
8785 /* Help char - go round again */
8789 /* Reading key sequences. */
8791 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8792 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8793 keymap, or nil otherwise. Return the index of the first keymap in
8794 which KEY has any binding, or NMAPS if no map has a binding.
8796 If KEY is a meta ASCII character, treat it like meta-prefix-char
8797 followed by the corresponding non-meta character. Keymaps in
8798 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8801 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8804 NEXT may be the same array as CURRENT. */
8807 follow_key (Lisp_Object key
, int nmaps
, Lisp_Object
*current
, Lisp_Object
*defs
,
8810 int i
, first_binding
;
8812 first_binding
= nmaps
;
8813 for (i
= nmaps
- 1; i
>= 0; i
--)
8815 if (! NILP (current
[i
]))
8817 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8818 if (! NILP (defs
[i
]))
8825 /* Given the set of bindings we've found, produce the next set of maps. */
8826 if (first_binding
< nmaps
)
8827 for (i
= 0; i
< nmaps
; i
++)
8828 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8830 return first_binding
;
8833 /* Structure used to keep track of partial application of key remapping
8834 such as Vfunction_key_map and Vkey_translation_map. */
8835 typedef struct keyremap
8837 /* This is the map originally specified for this use. */
8839 /* This is a submap reached by looking up, in PARENT,
8840 the events from START to END. */
8842 /* Positions [START, END) in the key sequence buffer
8843 are the key that we have scanned so far.
8844 Those events are the ones that we will replace
8845 if PAREHT maps them into a key sequence. */
8849 /* Lookup KEY in MAP.
8850 MAP is a keymap mapping keys to key vectors or functions.
8851 If the mapping is a function and DO_FUNCTION is non-zero, then
8852 the function is called with PROMPT as parameter and its return
8853 value is used as the return value of this function (after checking
8854 that it is indeed a vector). */
8857 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8862 next
= access_keymap (map
, key
, 1, 0, 1);
8864 /* Handle symbol with autoload definition. */
8865 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8866 && CONSP (XSYMBOL (next
)->function
)
8867 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8868 do_autoload (XSYMBOL (next
)->function
, next
);
8870 /* Handle a symbol whose function definition is a keymap
8872 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8873 && (ARRAYP (XSYMBOL (next
)->function
)
8874 || KEYMAPP (XSYMBOL (next
)->function
)))
8875 next
= XSYMBOL (next
)->function
;
8877 /* If the keymap gives a function, not an
8878 array, then call the function with one arg and use
8879 its value instead. */
8880 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8885 next
= call1 (next
, prompt
);
8886 /* If the function returned something invalid,
8887 barf--don't ignore it.
8888 (To ignore it safely, we would need to gcpro a bunch of
8889 other variables.) */
8890 if (! (VECTORP (next
) || STRINGP (next
)))
8891 error ("Function %s returns invalid key sequence", tem
);
8896 /* Do one step of the key remapping used for function-key-map and
8897 key-translation-map:
8898 KEYBUF is the buffer holding the input events.
8899 BUFSIZE is its maximum size.
8900 FKEY is a pointer to the keyremap structure to use.
8901 INPUT is the index of the last element in KEYBUF.
8902 DOIT if non-zero says that the remapping can actually take place.
8903 DIFF is used to return the number of keys added/removed by the remapping.
8904 PARENT is the root of the keymap.
8905 PROMPT is the prompt to use if the remapping happens through a function.
8906 The return value is non-zero if the remapping actually took place. */
8909 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8910 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8912 Lisp_Object next
, key
;
8914 key
= keybuf
[fkey
->end
++];
8916 if (KEYMAPP (fkey
->parent
))
8917 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8921 /* If keybuf[fkey->start..fkey->end] is bound in the
8922 map and we're in a position to do the key remapping, replace it with
8923 the binding and restart with fkey->start at the end. */
8924 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8926 int len
= XFASTINT (Flength (next
));
8929 *diff
= len
- (fkey
->end
- fkey
->start
);
8931 if (input
+ *diff
>= bufsize
)
8932 error ("Key sequence too long");
8934 /* Shift the keys that follow fkey->end. */
8936 for (i
= fkey
->end
; i
< input
; i
++)
8937 keybuf
[i
+ *diff
] = keybuf
[i
];
8939 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8940 keybuf
[i
+ *diff
] = keybuf
[i
];
8941 /* Overwrite the old keys with the new ones. */
8942 for (i
= 0; i
< len
; i
++)
8943 keybuf
[fkey
->start
+ i
]
8944 = Faref (next
, make_number (i
));
8946 fkey
->start
= fkey
->end
+= *diff
;
8947 fkey
->map
= fkey
->parent
;
8952 fkey
->map
= get_keymap (next
, 0, 1);
8954 /* If we no longer have a bound suffix, try a new position for
8956 if (!CONSP (fkey
->map
))
8958 fkey
->end
= ++fkey
->start
;
8959 fkey
->map
= fkey
->parent
;
8964 /* Read a sequence of keys that ends with a non prefix character,
8965 storing it in KEYBUF, a buffer of size BUFSIZE.
8967 Return the length of the key sequence stored.
8968 Return -1 if the user rejected a command menu.
8970 Echo starting immediately unless `prompt' is 0.
8972 Where a key sequence ends depends on the currently active keymaps.
8973 These include any minor mode keymaps active in the current buffer,
8974 the current buffer's local map, and the global map.
8976 If a key sequence has no other bindings, we check Vfunction_key_map
8977 to see if some trailing subsequence might be the beginning of a
8978 function key's sequence. If so, we try to read the whole function
8979 key, and substitute its symbolic name into the key sequence.
8981 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8982 `double-' events into similar click events, if that would make them
8983 bound. We try to turn `triple-' events first into `double-' events,
8986 If we get a mouse click in a mode line, vertical divider, or other
8987 non-text area, we treat the click as if it were prefixed by the
8988 symbol denoting that area - `mode-line', `vertical-line', or
8991 If the sequence starts with a mouse click, we read the key sequence
8992 with respect to the buffer clicked on, not the current buffer.
8994 If the user switches frames in the midst of a key sequence, we put
8995 off the switch-frame event until later; the next call to
8996 read_char will return it.
8998 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8999 from the selected window's buffer. */
9002 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
9003 int dont_downcase_last
, int can_return_switch_frame
,
9004 int fix_current_buffer
)
9006 volatile Lisp_Object from_string
;
9007 volatile int count
= SPECPDL_INDEX ();
9009 /* How many keys there are in the current key sequence. */
9012 /* The length of the echo buffer when we started reading, and
9013 the length of this_command_keys when we started reading. */
9014 volatile int echo_start
;
9015 volatile int keys_start
;
9017 /* The number of keymaps we're scanning right now, and the number of
9018 keymaps we have allocated space for. */
9020 volatile int nmaps_allocated
= 0;
9022 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9023 the current keymaps. */
9024 Lisp_Object
*volatile defs
= NULL
;
9026 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9027 in the current keymaps, or nil where it is not a prefix. */
9028 Lisp_Object
*volatile submaps
= NULL
;
9030 /* The local map to start out with at start of key sequence. */
9031 volatile Lisp_Object orig_local_map
;
9033 /* The map from the `keymap' property to start out with at start of
9035 volatile Lisp_Object orig_keymap
;
9037 /* 1 if we have already considered switching to the local-map property
9038 of the place where a mouse click occurred. */
9039 volatile int localized_local_map
= 0;
9041 /* The index in submaps[] of the first keymap that has a binding for
9042 this key sequence. In other words, the lowest i such that
9043 submaps[i] is non-nil. */
9044 volatile int first_binding
;
9045 /* Index of the first key that has no binding.
9046 It is useless to try fkey.start larger than that. */
9047 volatile int first_unbound
;
9049 /* If t < mock_input, then KEYBUF[t] should be read as the next
9052 We use this to recover after recognizing a function key. Once we
9053 realize that a suffix of the current key sequence is actually a
9054 function key's escape sequence, we replace the suffix with the
9055 function key's binding from Vfunction_key_map. Now keybuf
9056 contains a new and different key sequence, so the echo area,
9057 this_command_keys, and the submaps and defs arrays are wrong. In
9058 this situation, we set mock_input to t, set t to 0, and jump to
9059 restart_sequence; the loop will read keys from keybuf up until
9060 mock_input, thus rebuilding the state; and then it will resume
9061 reading characters from the keyboard. */
9062 volatile int mock_input
= 0;
9064 /* If the sequence is unbound in submaps[], then
9065 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9066 and fkey.map is its binding.
9068 These might be > t, indicating that all function key scanning
9069 should hold off until t reaches them. We do this when we've just
9070 recognized a function key, to avoid searching for the function
9071 key's again in Vfunction_key_map. */
9072 volatile keyremap fkey
;
9074 /* Likewise, for key_translation_map and input-decode-map. */
9075 volatile keyremap keytran
, indec
;
9077 /* Non-zero if we are trying to map a key by changing an upper-case
9078 letter to lower case, or a shifted function key to an unshifted
9080 volatile int shift_translated
= 0;
9082 /* If we receive a `switch-frame' or `select-window' event in the middle of
9083 a key sequence, we put it off for later.
9084 While we're reading, we keep the event here. */
9085 volatile Lisp_Object delayed_switch_frame
;
9087 /* See the comment below... */
9088 #if defined (GOBBLE_FIRST_EVENT)
9089 Lisp_Object first_event
;
9092 volatile Lisp_Object original_uppercase
;
9093 volatile int original_uppercase_position
= -1;
9095 /* Gets around Microsoft compiler limitations. */
9098 struct buffer
*starting_buffer
;
9100 /* List of events for which a fake prefix key has been generated. */
9101 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
9103 #if defined (GOBBLE_FIRST_EVENT)
9107 struct gcpro gcpro1
;
9109 GCPRO1 (fake_prefixed_keys
);
9110 raw_keybuf_count
= 0;
9112 last_nonmenu_event
= Qnil
;
9114 delayed_switch_frame
= Qnil
;
9119 echo_prompt (prompt
);
9120 else if (cursor_in_echo_area
9121 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9122 && NILP (Fzerop (Vecho_keystrokes
)))
9123 /* This doesn't put in a dash if the echo buffer is empty, so
9124 you don't always see a dash hanging out in the minibuffer. */
9128 /* Record the initial state of the echo area and this_command_keys;
9129 we will need to restore them if we replay a key sequence. */
9131 echo_start
= echo_length ();
9132 keys_start
= this_command_key_count
;
9133 this_single_command_key_start
= keys_start
;
9135 #if defined (GOBBLE_FIRST_EVENT)
9136 /* This doesn't quite work, because some of the things that read_char
9137 does cannot safely be bypassed. It seems too risky to try to make
9140 /* Read the first char of the sequence specially, before setting
9141 up any keymaps, in case a filter runs and switches buffers on us. */
9142 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9144 #endif /* GOBBLE_FIRST_EVENT */
9146 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9147 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9150 /* We jump here when we need to reinitialize fkey and keytran; this
9151 happens if we switch keyboards between rescans. */
9152 replay_entire_sequence
:
9154 indec
.map
= indec
.parent
= current_kboard
->Vinput_decode_map
;
9155 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
9156 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9157 indec
.start
= indec
.end
= 0;
9158 fkey
.start
= fkey
.end
= 0;
9159 keytran
.start
= keytran
.end
= 0;
9161 /* We jump here when the key sequence has been thoroughly changed, and
9162 we need to rescan it starting from the beginning. When we jump here,
9163 keybuf[0..mock_input] holds the sequence we should reread. */
9166 starting_buffer
= current_buffer
;
9167 first_unbound
= bufsize
+ 1;
9169 /* Build our list of keymaps.
9170 If we recognize a function key and replace its escape sequence in
9171 keybuf with its symbol, or if the sequence starts with a mouse
9172 click and we need to switch buffers, we jump back here to rebuild
9173 the initial keymaps from the current buffer. */
9176 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
9178 if (2 > nmaps_allocated
)
9180 submaps
= (Lisp_Object
*) alloca (2 * sizeof (submaps
[0]));
9181 defs
= (Lisp_Object
*) alloca (2 * sizeof (defs
[0]));
9182 nmaps_allocated
= 2;
9184 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
9186 else if (!NILP (Voverriding_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
++] = Voverriding_local_map
;
9202 nminor
= current_minor_maps (0, &maps
);
9203 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9205 if (total
> nmaps_allocated
)
9207 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
9208 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
9209 nmaps_allocated
= total
;
9212 if (!NILP (orig_keymap
))
9213 submaps
[nmaps
++] = orig_keymap
;
9215 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9219 submaps
[nmaps
++] = orig_local_map
;
9221 submaps
[nmaps
++] = current_global_map
;
9223 /* Find an accurate initial value for first_binding. */
9224 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9225 if (! NILP (submaps
[first_binding
]))
9228 /* Start from the beginning in keybuf. */
9231 /* These are no-ops the first time through, but if we restart, they
9232 revert the echo area and this_command_keys to their original state. */
9233 this_command_key_count
= keys_start
;
9234 if (INTERACTIVE
&& t
< mock_input
)
9235 echo_truncate (echo_start
);
9237 /* If the best binding for the current key sequence is a keymap, or
9238 we may be looking at a function key's escape sequence, keep on
9240 while (first_binding
< nmaps
9241 /* Keep reading as long as there's a prefix binding. */
9242 ? !NILP (submaps
[first_binding
])
9243 /* Don't return in the middle of a possible function key sequence,
9244 if the only bindings we found were via case conversion.
9245 Thus, if ESC O a has a function-key-map translation
9246 and ESC o has a binding, don't return after ESC O,
9247 so that we can translate ESC O plus the next character. */
9248 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9251 int used_mouse_menu
= 0;
9253 /* Where the last real key started. If we need to throw away a
9254 key that has expanded into more than one element of keybuf
9255 (say, a mouse click on the mode line which is being treated
9256 as [mode-line (mouse-...)], then we backtrack to this point
9258 volatile int last_real_key_start
;
9260 /* These variables are analogous to echo_start and keys_start;
9261 while those allow us to restart the entire key sequence,
9262 echo_local_start and keys_local_start allow us to throw away
9264 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
9266 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9267 eassert (indec
.start
<= indec
.end
);
9268 eassert (fkey
.start
<= fkey
.end
);
9269 eassert (keytran
.start
<= keytran
.end
);
9270 /* key-translation-map is applied *after* function-key-map
9271 which is itself applied *after* input-decode-map. */
9272 eassert (fkey
.end
<= indec
.start
);
9273 eassert (keytran
.end
<= fkey
.start
);
9275 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9276 first_unbound
< keytran
.start
)
9277 { /* The prefix upto first_unbound has no binding and has
9278 no translation left to do either, so we know it's unbound.
9279 If we don't stop now, we risk staying here indefinitely
9280 (if the user keeps entering fkey or keytran prefixes
9281 like C-c ESC ESC ESC ESC ...) */
9283 for (i
= first_unbound
+ 1; i
< t
; i
++)
9284 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9285 mock_input
= t
- first_unbound
- 1;
9286 indec
.end
= indec
.start
-= first_unbound
+ 1;
9287 indec
.map
= indec
.parent
;
9288 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9289 fkey
.map
= fkey
.parent
;
9290 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9291 keytran
.map
= keytran
.parent
;
9292 goto replay_sequence
;
9296 error ("Key sequence too long");
9299 echo_local_start
= echo_length ();
9300 keys_local_start
= this_command_key_count
;
9301 local_first_binding
= first_binding
;
9304 /* These are no-ops, unless we throw away a keystroke below and
9305 jumped back up to replay_key; in that case, these restore the
9306 variables to their original state, allowing us to replay the
9308 if (INTERACTIVE
&& t
< mock_input
)
9309 echo_truncate (echo_local_start
);
9310 this_command_key_count
= keys_local_start
;
9311 first_binding
= local_first_binding
;
9313 /* By default, assume each event is "real". */
9314 last_real_key_start
= t
;
9316 /* Does mock_input indicate that we are re-reading a key sequence? */
9320 add_command_key (key
);
9321 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9322 && NILP (Fzerop (Vecho_keystrokes
)))
9326 /* If not, we should actually read a character. */
9330 KBOARD
*interrupted_kboard
= current_kboard
;
9331 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9332 key
= read_char (NILP (prompt
), nmaps
,
9333 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9334 &used_mouse_menu
, NULL
);
9335 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9336 /* When switching to a new tty (with a new keyboard),
9337 read_char returns the new buffer, rather than -2
9338 (Bug#5095). This is because `terminal-init-xterm'
9339 calls read-char, which eats the wrong_kboard_jmpbuf
9340 return. Any better way to fix this? -- cyd */
9341 || (interrupted_kboard
!= current_kboard
))
9346 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9347 if (k
== interrupted_kboard
)
9352 /* Don't touch interrupted_kboard when it's been
9354 delayed_switch_frame
= Qnil
;
9355 goto replay_entire_sequence
;
9358 if (!NILP (delayed_switch_frame
))
9360 interrupted_kboard
->kbd_queue
9361 = Fcons (delayed_switch_frame
,
9362 interrupted_kboard
->kbd_queue
);
9363 delayed_switch_frame
= Qnil
;
9367 interrupted_kboard
->kbd_queue
9368 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
9370 /* If the side queue is non-empty, ensure it begins with a
9371 switch-frame, so we'll replay it in the right context. */
9372 if (CONSP (interrupted_kboard
->kbd_queue
)
9373 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
9374 !(EVENT_HAS_PARAMETERS (key
)
9375 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9379 XSETFRAME (frame
, interrupted_frame
);
9380 interrupted_kboard
->kbd_queue
9381 = Fcons (make_lispy_switch_frame (frame
),
9382 interrupted_kboard
->kbd_queue
);
9385 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9386 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9387 goto replay_entire_sequence
;
9391 /* read_char returns t when it shows a menu and the user rejects it.
9395 unbind_to (count
, Qnil
);
9400 /* read_char returns -1 at the end of a macro.
9401 Emacs 18 handles this by returning immediately with a
9402 zero, so that's what we'll do. */
9403 if (INTEGERP (key
) && XINT (key
) == -1)
9406 /* The Microsoft C compiler can't handle the goto that
9412 /* If the current buffer has been changed from under us, the
9413 keymap may have changed, so replay the sequence. */
9416 timer_resume_idle ();
9419 /* Reset the current buffer from the selected window
9420 in case something changed the former and not the latter.
9421 This is to be more consistent with the behavior
9422 of the command_loop_1. */
9423 if (fix_current_buffer
)
9425 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9427 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9428 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9431 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9432 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9433 goto replay_sequence
;
9436 /* If we have a quit that was typed in another frame, and
9437 quit_throw_to_read_char switched buffers,
9438 replay to get the right keymap. */
9440 && XINT (key
) == quit_char
9441 && current_buffer
!= starting_buffer
)
9444 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9448 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9449 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9450 goto replay_sequence
;
9455 if (EVENT_HAS_PARAMETERS (key
)
9456 /* Either a `switch-frame' or a `select-window' event. */
9457 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9459 /* If we're at the beginning of a key sequence, and the caller
9460 says it's okay, go ahead and return this event. If we're
9461 in the midst of a key sequence, delay it until the end. */
9462 if (t
> 0 || !can_return_switch_frame
)
9464 delayed_switch_frame
= key
;
9470 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9474 /* Clicks in non-text areas get prefixed by the symbol
9475 in their CHAR-ADDRESS field. For example, a click on
9476 the mode line is prefixed by the symbol `mode-line'.
9478 Furthermore, key sequences beginning with mouse clicks
9479 are read using the keymaps of the buffer clicked on, not
9480 the current buffer. So we may have to switch the buffer
9483 When we turn one event into two events, we must make sure
9484 that neither of the two looks like the original--so that,
9485 if we replay the events, they won't be expanded again.
9486 If not for this, such reexpansion could happen either here
9487 or when user programs play with this-command-keys. */
9488 if (EVENT_HAS_PARAMETERS (key
))
9493 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9494 if (EQ (kind
, Qmouse_click
))
9496 Lisp_Object window
, posn
;
9498 window
= POSN_WINDOW (EVENT_START (key
));
9499 posn
= POSN_POSN (EVENT_START (key
));
9502 || (!NILP (fake_prefixed_keys
)
9503 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9505 /* We're looking a second time at an event for which
9506 we generated a fake prefix key. Set
9507 last_real_key_start appropriately. */
9509 last_real_key_start
= t
- 1;
9512 /* Key sequences beginning with mouse clicks are
9513 read using the keymaps in the buffer clicked on,
9514 not the current buffer. If we're at the
9515 beginning of a key sequence, switch buffers. */
9516 if (last_real_key_start
== 0
9518 && BUFFERP (XWINDOW (window
)->buffer
)
9519 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9521 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9525 /* Arrange to go back to the original buffer once we're
9526 done reading the key sequence. Note that we can't
9527 use save_excursion_{save,restore} here, because they
9528 save point as well as the current buffer; we don't
9529 want to save point, because redisplay may change it,
9530 to accommodate a Fset_window_start or something. We
9531 don't want to do this at the top of the function,
9532 because we may get input from a subprocess which
9533 wants to change the selected window and stuff (say,
9535 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9537 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9539 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9540 orig_local_map
= get_local_map (PT
, current_buffer
,
9542 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9543 goto replay_sequence
;
9546 /* For a mouse click, get the local text-property keymap
9547 of the place clicked on, rather than point. */
9548 if (last_real_key_start
== 0
9549 && CONSP (XCDR (key
))
9550 && ! localized_local_map
)
9552 Lisp_Object map_here
, start
, pos
;
9554 localized_local_map
= 1;
9555 start
= EVENT_START (key
);
9557 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9559 pos
= POSN_BUFFER_POSN (start
);
9561 && XINT (pos
) >= BEGV
9562 && XINT (pos
) <= ZV
)
9564 map_here
= get_local_map (XINT (pos
),
9565 current_buffer
, Qlocal_map
);
9566 if (!EQ (map_here
, orig_local_map
))
9568 orig_local_map
= map_here
;
9569 ++localized_local_map
;
9572 map_here
= get_local_map (XINT (pos
),
9573 current_buffer
, Qkeymap
);
9574 if (!EQ (map_here
, orig_keymap
))
9576 orig_keymap
= map_here
;
9577 ++localized_local_map
;
9580 if (localized_local_map
> 1)
9585 goto replay_sequence
;
9591 /* Expand mode-line and scroll-bar events into two events:
9592 use posn as a fake prefix key. */
9594 && (NILP (fake_prefixed_keys
)
9595 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9597 if (t
+ 1 >= bufsize
)
9598 error ("Key sequence too long");
9601 keybuf
[t
+ 1] = key
;
9604 /* Record that a fake prefix key has been generated
9605 for KEY. Don't modify the event; this would
9606 prevent proper action when the event is pushed
9607 back into unread-command-events. */
9608 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9610 /* If on a mode line string with a local keymap,
9611 reconsider the key sequence with that keymap. */
9612 if (string
= POSN_STRING (EVENT_START (key
)),
9613 (CONSP (string
) && STRINGP (XCAR (string
))))
9615 Lisp_Object pos
, map
, map2
;
9617 pos
= XCDR (string
);
9618 string
= XCAR (string
);
9620 && XINT (pos
) < SCHARS (string
))
9622 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9624 orig_local_map
= map
;
9625 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9628 if (!NILP (map
) || !NILP (map2
))
9629 goto replay_sequence
;
9635 else if (NILP (from_string
)
9636 && (string
= POSN_STRING (EVENT_START (key
)),
9637 (CONSP (string
) && STRINGP (XCAR (string
)))))
9639 /* For a click on a string, i.e. overlay string or a
9640 string displayed via the `display' property,
9641 consider `local-map' and `keymap' properties of
9643 Lisp_Object pos
, map
, map2
;
9645 pos
= XCDR (string
);
9646 string
= XCAR (string
);
9648 && XINT (pos
) < SCHARS (string
))
9650 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9652 orig_local_map
= map
;
9653 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9657 if (!NILP (map
) || !NILP (map2
))
9659 from_string
= string
;
9662 goto replay_sequence
;
9667 else if (CONSP (XCDR (key
))
9668 && CONSP (EVENT_START (key
))
9669 && CONSP (XCDR (EVENT_START (key
))))
9673 posn
= POSN_POSN (EVENT_START (key
));
9674 /* Handle menu-bar events:
9675 insert the dummy prefix event `menu-bar'. */
9676 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9678 if (t
+ 1 >= bufsize
)
9679 error ("Key sequence too long");
9683 /* Zap the position in key, so we know that we've
9684 expanded it, and don't try to do so again. */
9685 POSN_SET_POSN (EVENT_START (key
),
9686 Fcons (posn
, Qnil
));
9689 goto replay_sequence
;
9691 else if (CONSP (posn
))
9693 /* We're looking at the second event of a
9694 sequence which we expanded before. Set
9695 last_real_key_start appropriately. */
9696 if (last_real_key_start
== t
&& t
> 0)
9697 last_real_key_start
= t
- 1;
9702 /* We have finally decided that KEY is something we might want
9704 first_binding
= (follow_key (key
,
9705 nmaps
- first_binding
,
9706 submaps
+ first_binding
,
9707 defs
+ first_binding
,
9708 submaps
+ first_binding
)
9711 /* If KEY wasn't bound, we'll try some fallbacks. */
9712 if (first_binding
< nmaps
)
9713 /* This is needed for the following scenario:
9714 event 0: a down-event that gets dropped by calling replay_key.
9715 event 1: some normal prefix like C-h.
9716 After event 0, first_unbound is 0, after event 1 indec.start,
9717 fkey.start, and keytran.start are all 1, so when we see that
9718 C-h is bound, we need to update first_unbound. */
9719 first_unbound
= max (t
+ 1, first_unbound
);
9724 /* Remember the position to put an upper bound on indec.start. */
9725 first_unbound
= min (t
, first_unbound
);
9727 head
= EVENT_HEAD (key
);
9728 if (help_char_p (head
) && t
> 0)
9730 read_key_sequence_cmd
= Vprefix_help_command
;
9732 last_nonmenu_event
= key
;
9733 /* The Microsoft C compiler can't handle the goto that
9741 Lisp_Object breakdown
;
9744 breakdown
= parse_modifiers (head
);
9745 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9746 /* Attempt to reduce an unbound mouse event to a simpler
9747 event that is bound:
9748 Drags reduce to clicks.
9749 Double-clicks reduce to clicks.
9750 Triple-clicks reduce to double-clicks, then to clicks.
9751 Down-clicks are eliminated.
9752 Double-downs reduce to downs, then are eliminated.
9753 Triple-downs reduce to double-downs, then to downs,
9754 then are eliminated. */
9755 if (modifiers
& (down_modifier
| drag_modifier
9756 | double_modifier
| triple_modifier
))
9758 while (modifiers
& (down_modifier
| drag_modifier
9759 | double_modifier
| triple_modifier
))
9761 Lisp_Object new_head
, new_click
;
9762 if (modifiers
& triple_modifier
)
9763 modifiers
^= (double_modifier
| triple_modifier
);
9764 else if (modifiers
& double_modifier
)
9765 modifiers
&= ~double_modifier
;
9766 else if (modifiers
& drag_modifier
)
9767 modifiers
&= ~drag_modifier
;
9770 /* Dispose of this `down' event by simply jumping
9771 back to replay_key, to get another event.
9773 Note that if this event came from mock input,
9774 then just jumping back to replay_key will just
9775 hand it to us again. So we have to wipe out any
9778 We could delete keybuf[t] and shift everything
9779 after that to the left by one spot, but we'd also
9780 have to fix up any variable that points into
9781 keybuf, and shifting isn't really necessary
9784 Adding prefixes for non-textual mouse clicks
9785 creates two characters of mock input, and both
9786 must be thrown away. If we're only looking at
9787 the prefix now, we can just jump back to
9788 replay_key. On the other hand, if we've already
9789 processed the prefix, and now the actual click
9790 itself is giving us trouble, then we've lost the
9791 state of the keymaps we want to backtrack to, and
9792 we need to replay the whole sequence to rebuild
9795 Beyond that, only function key expansion could
9796 create more than two keys, but that should never
9797 generate mouse events, so it's okay to zero
9798 mock_input in that case too.
9800 FIXME: The above paragraph seems just plain
9801 wrong, if you consider things like
9802 xterm-mouse-mode. -stef
9804 Isn't this just the most wonderful code ever? */
9806 /* If mock_input > t + 1, the above simplification
9807 will actually end up dropping keys on the floor.
9808 This is probably OK for now, but even
9809 if mock_input <= t + 1, we need to adjust indec,
9811 Typical case [header-line down-mouse-N]:
9812 mock_input = 2, t = 1, fkey.end = 1,
9813 last_real_key_start = 0. */
9814 if (indec
.end
> last_real_key_start
)
9816 indec
.end
= indec
.start
9817 = min (last_real_key_start
, indec
.start
);
9818 indec
.map
= indec
.parent
;
9819 if (fkey
.end
> last_real_key_start
)
9821 fkey
.end
= fkey
.start
9822 = min (last_real_key_start
, fkey
.start
);
9823 fkey
.map
= fkey
.parent
;
9824 if (keytran
.end
> last_real_key_start
)
9826 keytran
.end
= keytran
.start
9827 = min (last_real_key_start
, keytran
.start
);
9828 keytran
.map
= keytran
.parent
;
9832 if (t
== last_real_key_start
)
9839 mock_input
= last_real_key_start
;
9840 goto replay_sequence
;
9845 = apply_modifiers (modifiers
, XCAR (breakdown
));
9847 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9849 /* Look for a binding for this new key. follow_key
9850 promises that it didn't munge submaps the
9851 last time we called it, since key was unbound. */
9853 = (follow_key (new_click
,
9854 nmaps
- local_first_binding
,
9855 submaps
+ local_first_binding
,
9856 defs
+ local_first_binding
,
9857 submaps
+ local_first_binding
)
9858 + local_first_binding
);
9860 /* If that click is bound, go for it. */
9861 if (first_binding
< nmaps
)
9866 /* Otherwise, we'll leave key set to the drag event. */
9873 /* Normally, last_nonmenu_event gets the previous key we read.
9874 But when a mouse popup menu is being used,
9875 we don't update last_nonmenu_event; it continues to hold the mouse
9876 event that preceded the first level of menu. */
9877 if (!used_mouse_menu
)
9878 last_nonmenu_event
= key
;
9880 /* Record what part of this_command_keys is the current key sequence. */
9881 this_single_command_key_start
= this_command_key_count
- t
;
9883 /* Look for this sequence in input-decode-map.
9884 Scan from indec.end until we find a bound suffix. */
9885 while (indec
.end
< t
)
9887 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9890 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9891 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9896 mock_input
= diff
+ max (t
, mock_input
);
9897 goto replay_sequence
;
9901 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
])
9902 && indec
.start
>= t
)
9903 /* There is a binding and it's not a prefix.
9904 (and it doesn't have any input-decode-map translation pending).
9905 There is thus no function-key in this sequence.
9906 Moving fkey.start is important in this case to allow keytran.start
9907 to go over the sequence before we return (since we keep the
9908 invariant that keytran.end <= fkey.start). */
9911 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9914 /* If the sequence is unbound, see if we can hang a function key
9915 off the end of it. */
9916 /* Continue scan from fkey.end until we find a bound suffix. */
9917 while (fkey
.end
< indec
.start
)
9919 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9922 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9923 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9924 max (t
, mock_input
),
9925 /* If there's a binding (i.e.
9926 first_binding >= nmaps) we don't want
9927 to apply this function-key-mapping. */
9928 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9933 mock_input
= diff
+ max (t
, mock_input
);
9934 /* Adjust the input-decode-map counters. */
9936 indec
.start
+= diff
;
9938 goto replay_sequence
;
9942 /* Look for this sequence in key-translation-map.
9943 Scan from keytran.end until we find a bound suffix. */
9944 while (keytran
.end
< fkey
.start
)
9946 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9949 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9950 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9955 mock_input
= diff
+ max (t
, mock_input
);
9956 /* Adjust the function-key-map and input-decode-map counters. */
9958 indec
.start
+= diff
;
9962 goto replay_sequence
;
9966 /* If KEY is not defined in any of the keymaps,
9967 and cannot be part of a function key or translation,
9968 and is an upper case letter
9969 use the corresponding lower-case letter instead. */
9970 if (first_binding
>= nmaps
9971 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9973 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9974 && UPPERCASEP (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9975 || (XINT (key
) & shift_modifier
)))
9977 Lisp_Object new_key
;
9979 original_uppercase
= key
;
9980 original_uppercase_position
= t
- 1;
9982 if (XINT (key
) & shift_modifier
)
9983 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9985 XSETINT (new_key
, (DOWNCASE (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9986 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9988 /* We have to do this unconditionally, regardless of whether
9989 the lower-case char is defined in the keymaps, because they
9990 might get translated through function-key-map. */
9991 keybuf
[t
- 1] = new_key
;
9992 mock_input
= max (t
, mock_input
);
9993 shift_translated
= 1;
9995 goto replay_sequence
;
9997 /* If KEY is not defined in any of the keymaps,
9998 and cannot be part of a function key or translation,
9999 and is a shifted function key,
10000 use the corresponding unshifted function key instead. */
10001 if (first_binding
>= nmaps
10002 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10004 Lisp_Object breakdown
= parse_modifiers (key
);
10006 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10008 if (modifiers
& shift_modifier
10009 /* Treat uppercase keys as shifted. */
10011 && (KEY_TO_CHAR (key
)
10012 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
10013 && UPPERCASEP (KEY_TO_CHAR (key
))))
10015 Lisp_Object new_key
10016 = (modifiers
& shift_modifier
10017 ? apply_modifiers (modifiers
& ~shift_modifier
,
10019 : make_number (DOWNCASE (KEY_TO_CHAR (key
)) | modifiers
));
10021 original_uppercase
= key
;
10022 original_uppercase_position
= t
- 1;
10024 /* We have to do this unconditionally, regardless of whether
10025 the lower-case char is defined in the keymaps, because they
10026 might get translated through function-key-map. */
10027 keybuf
[t
- 1] = new_key
;
10028 mock_input
= max (t
, mock_input
);
10029 /* Reset fkey (and consequently keytran) to apply
10030 function-key-map on the result, so that S-backspace is
10031 correctly mapped to DEL (via backspace). OTOH,
10032 input-decode-map doesn't need to go through it again. */
10033 fkey
.start
= fkey
.end
= 0;
10034 keytran
.start
= keytran
.end
= 0;
10035 shift_translated
= 1;
10037 goto replay_sequence
;
10042 read_key_sequence_cmd
= (first_binding
< nmaps
10043 ? defs
[first_binding
]
10046 unread_switch_frame
= delayed_switch_frame
;
10047 unbind_to (count
, Qnil
);
10049 /* Don't downcase the last character if the caller says don't.
10050 Don't downcase it if the result is undefined, either. */
10051 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10053 && t
- 1 == original_uppercase_position
)
10055 keybuf
[t
- 1] = original_uppercase
;
10056 shift_translated
= 0;
10059 if (shift_translated
)
10060 Vthis_command_keys_shift_translated
= Qt
;
10062 /* Occasionally we fabricate events, perhaps by expanding something
10063 according to function-key-map, or by adding a prefix symbol to a
10064 mouse click in the scroll bar or modeline. In this cases, return
10065 the entire generated key sequence, even if we hit an unbound
10066 prefix or a definition before the end. This means that you will
10067 be able to push back the event properly, and also means that
10068 read-key-sequence will always return a logical unit.
10071 for (; t
< mock_input
; t
++)
10073 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10074 && NILP (Fzerop (Vecho_keystrokes
)))
10075 echo_char (keybuf
[t
]);
10076 add_command_key (keybuf
[t
]);
10083 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10084 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10085 The sequence is sufficient to specify a non-prefix command in the
10086 current local and global maps.
10088 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10089 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10090 as a continuation of the previous key.
10092 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10093 convert the last event to lower case. (Normally any upper case event
10094 is converted to lower case if the original event is undefined and the lower
10095 case equivalent is defined.) A non-nil value is appropriate for reading
10096 a key sequence to be defined.
10098 A C-g typed while in this function is treated like any other character,
10099 and `quit-flag' is not set.
10101 If the key sequence starts with a mouse click, then the sequence is read
10102 using the keymaps of the buffer of the window clicked in, not the buffer
10103 of the selected window as normal.
10105 `read-key-sequence' drops unbound button-down events, since you normally
10106 only care about the click or drag events which follow them. If a drag
10107 or multi-click event is unbound, but the corresponding click event would
10108 be bound, `read-key-sequence' turns the event into a click event at the
10109 drag's starting position. This means that you don't have to distinguish
10110 between click and drag, double, or triple events unless you want to.
10112 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10113 lines separating windows, and scroll bars with imaginary keys
10114 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10116 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10117 function will process a switch-frame event if the user switches frames
10118 before typing anything. If the user switches frames in the middle of a
10119 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10120 is nil, then the event will be put off until after the current key sequence.
10122 `read-key-sequence' checks `function-key-map' for function key
10123 sequences, where they wouldn't conflict with ordinary bindings. See
10124 `function-key-map' for more details.
10126 The optional fifth argument COMMAND-LOOP, if non-nil, means
10127 that this key sequence is being read by something that will
10128 read commands one after another. It should be nil if the caller
10129 will read just one key sequence. */)
10130 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10132 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10133 Lisp_Object can_return_switch_frame
, command_loop
;
10135 Lisp_Object keybuf
[30];
10137 struct gcpro gcpro1
;
10138 int count
= SPECPDL_INDEX ();
10140 if (!NILP (prompt
))
10141 CHECK_STRING (prompt
);
10144 specbind (Qinput_method_exit_on_first_char
,
10145 (NILP (command_loop
) ? Qt
: Qnil
));
10146 specbind (Qinput_method_use_echo_area
,
10147 (NILP (command_loop
) ? Qt
: Qnil
));
10149 memset (keybuf
, 0, sizeof keybuf
);
10150 GCPRO1 (keybuf
[0]);
10151 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10153 if (NILP (continue_echo
))
10155 this_command_key_count
= 0;
10156 this_command_key_count_reset
= 0;
10157 this_single_command_key_start
= 0;
10160 #ifdef HAVE_WINDOW_SYSTEM
10161 if (display_hourglass_p
)
10162 cancel_hourglass ();
10165 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10166 prompt
, ! NILP (dont_downcase_last
),
10167 ! NILP (can_return_switch_frame
), 0);
10169 #if 0 /* The following is fine for code reading a key sequence and
10170 then proceeding with a lenghty computation, but it's not good
10171 for code reading keys in a loop, like an input method. */
10172 #ifdef HAVE_WINDOW_SYSTEM
10173 if (display_hourglass_p
)
10174 start_hourglass ();
10184 return unbind_to (count
, make_event_array (i
, keybuf
));
10187 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10188 Sread_key_sequence_vector
, 1, 5, 0,
10189 doc
: /* Like `read-key-sequence' but always return a vector. */)
10190 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
10192 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
10193 Lisp_Object can_return_switch_frame
, command_loop
;
10195 Lisp_Object keybuf
[30];
10197 struct gcpro gcpro1
;
10198 int count
= SPECPDL_INDEX ();
10200 if (!NILP (prompt
))
10201 CHECK_STRING (prompt
);
10204 specbind (Qinput_method_exit_on_first_char
,
10205 (NILP (command_loop
) ? Qt
: Qnil
));
10206 specbind (Qinput_method_use_echo_area
,
10207 (NILP (command_loop
) ? Qt
: Qnil
));
10209 memset (keybuf
, 0, sizeof keybuf
);
10210 GCPRO1 (keybuf
[0]);
10211 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10213 if (NILP (continue_echo
))
10215 this_command_key_count
= 0;
10216 this_command_key_count_reset
= 0;
10217 this_single_command_key_start
= 0;
10220 #ifdef HAVE_WINDOW_SYSTEM
10221 if (display_hourglass_p
)
10222 cancel_hourglass ();
10225 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10226 prompt
, ! NILP (dont_downcase_last
),
10227 ! NILP (can_return_switch_frame
), 0);
10229 #ifdef HAVE_WINDOW_SYSTEM
10230 if (display_hourglass_p
)
10231 start_hourglass ();
10240 return unbind_to (count
, Fvector (i
, keybuf
));
10243 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10244 doc
: /* Execute CMD as an editor command.
10245 CMD must be a symbol that satisfies the `commandp' predicate.
10246 Optional second arg RECORD-FLAG non-nil
10247 means unconditionally put this command in `command-history'.
10248 Otherwise, that is done only if an arg is read using the minibuffer.
10249 The argument KEYS specifies the value to use instead of (this-command-keys)
10250 when reading the arguments; if it is nil, (this-command-keys) is used.
10251 The argument SPECIAL, if non-nil, means that this command is executing
10252 a special event, so ignore the prefix argument and don't clear it. */)
10253 (cmd
, record_flag
, keys
, special
)
10254 Lisp_Object cmd
, record_flag
, keys
, special
;
10256 register Lisp_Object final
;
10257 register Lisp_Object tem
;
10258 Lisp_Object prefixarg
;
10259 extern int debug_on_next_call
;
10261 debug_on_next_call
= 0;
10263 if (NILP (special
))
10265 prefixarg
= current_kboard
->Vprefix_arg
;
10266 Vcurrent_prefix_arg
= prefixarg
;
10267 current_kboard
->Vprefix_arg
= Qnil
;
10274 tem
= Fget (cmd
, Qdisabled
);
10275 if (!NILP (tem
) && !NILP (Vrun_hooks
))
10277 tem
= Fsymbol_value (Qdisabled_command_function
);
10279 return call1 (Vrun_hooks
, Qdisabled_command_function
);
10285 final
= Findirect_function (cmd
, Qnil
);
10287 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10289 struct gcpro gcpro1
, gcpro2
;
10291 GCPRO2 (cmd
, prefixarg
);
10292 do_autoload (final
, cmd
);
10299 if (STRINGP (final
) || VECTORP (final
))
10301 /* If requested, place the macro in the command history. For
10302 other sorts of commands, call-interactively takes care of
10304 if (!NILP (record_flag
))
10307 = Fcons (Fcons (Qexecute_kbd_macro
,
10308 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10311 /* Don't keep command history around forever. */
10312 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10314 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10316 XSETCDR (tem
, Qnil
);
10320 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10323 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10324 /* Don't call Fcall_interactively directly because we want to make
10325 sure the backtrace has an entry for `call-interactively'.
10326 For the same reason, pass `cmd' rather than `final'. */
10327 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10334 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
10336 doc
: /* Read function name, then read its arguments and call it.
10338 To pass a numeric argument to the command you are invoking with, specify
10339 the numeric argument to this command.
10341 Noninteractively, the argument PREFIXARG is the prefix argument to
10342 give to the command you invoke, if it asks for an argument. */)
10344 Lisp_Object prefixarg
;
10346 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 wil 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
;
10367 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
10369 if (EQ (prefixarg
, Qminus
))
10370 strcpy (buf
, "- ");
10371 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
10372 strcpy (buf
, "C-u ");
10373 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
10374 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
10375 else if (INTEGERP (prefixarg
))
10376 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
10378 /* This isn't strictly correct if execute-extended-command
10379 is bound to anything else. Perhaps it should use
10380 this_command_keys? */
10381 strcat (buf
, "M-x ");
10383 /* Prompt with buf, and then read a string, completing from and
10384 restricting to the set of all defined commands. Don't provide
10385 any initial input. Save the command read on the extended-command
10387 function
= Fcompleting_read (build_string (buf
),
10388 Vobarray
, Qcommandp
,
10389 Qt
, Qnil
, Qextended_command_history
, Qnil
,
10392 #ifdef HAVE_WINDOW_SYSTEM
10393 if (hstarted
) start_hourglass ();
10396 if (STRINGP (function
) && SCHARS (function
) == 0)
10397 error ("No command name given");
10399 /* Set this_command_keys to the concatenation of saved_keys and
10400 function, followed by a RET. */
10405 this_command_key_count
= 0;
10406 this_command_key_count_reset
= 0;
10407 this_single_command_key_start
= 0;
10409 keys
= XVECTOR (saved_keys
)->contents
;
10410 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
10411 add_command_key (keys
[i
]);
10413 for (i
= 0; i
< SCHARS (function
); i
++)
10414 add_command_key (Faref (function
, make_number (i
)));
10416 add_command_key (make_number ('\015'));
10419 last_point_position
= saved_last_point_position
;
10420 last_point_position_buffer
= saved_last_point_position_buffer
;
10424 function
= Fintern (function
, Qnil
);
10425 current_kboard
->Vprefix_arg
= prefixarg
;
10426 Vthis_command
= function
;
10427 real_this_command
= function
;
10429 /* If enabled, show which key runs this command. */
10430 if (!NILP (Vsuggest_key_bindings
)
10431 && NILP (Vexecuting_kbd_macro
)
10432 && SYMBOLP (function
))
10433 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
10439 GCPRO3 (bindings
, value
, function
);
10440 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
10442 /* If the command has a key binding, print it now. */
10443 if (!NILP (bindings
)
10444 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
10447 /* But first wait, and skip the message if there is input. */
10448 Lisp_Object waited
;
10450 /* If this command displayed something in the echo area;
10451 wait a few seconds, then display our suggestion message. */
10452 if (NILP (echo_area_buffer
[0]))
10453 waited
= sit_for (make_number (0), 0, 2);
10454 else if (NUMBERP (Vsuggest_key_bindings
))
10455 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10457 waited
= sit_for (make_number (2), 0, 2);
10459 if (!NILP (waited
) && ! CONSP (Vunread_command_events
))
10461 Lisp_Object binding
;
10463 int message_p
= push_message ();
10464 int count
= SPECPDL_INDEX ();
10466 record_unwind_protect (pop_message_unwind
, Qnil
);
10467 binding
= Fkey_description (bindings
, Qnil
);
10470 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10473 sprintf (newmessage
, "You can run the command `%s' with %s",
10474 SDATA (SYMBOL_NAME (function
)),
10476 message2_nolog (newmessage
,
10477 strlen (newmessage
),
10478 STRING_MULTIBYTE (binding
));
10479 if (NUMBERP (Vsuggest_key_bindings
))
10480 waited
= sit_for (Vsuggest_key_bindings
, 0, 2);
10482 waited
= sit_for (make_number (2), 0, 2);
10484 if (!NILP (waited
) && message_p
)
10485 restore_message ();
10487 unbind_to (count
, Qnil
);
10491 RETURN_UNGCPRO (value
);
10495 /* Return nonzero if input events are pending. */
10498 detect_input_pending (void)
10500 if (!input_pending
)
10501 get_input_pending (&input_pending
, 0);
10503 return input_pending
;
10506 /* Return nonzero if input events other than mouse movements are
10510 detect_input_pending_ignore_squeezables (void)
10512 if (!input_pending
)
10513 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10515 return input_pending
;
10518 /* Return nonzero if input events are pending, and run any pending timers. */
10521 detect_input_pending_run_timers (int do_display
)
10523 int old_timers_run
= timers_run
;
10525 if (!input_pending
)
10526 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10528 if (old_timers_run
!= timers_run
&& do_display
)
10530 redisplay_preserve_echo_area (8);
10531 /* The following fixes a bug when using lazy-lock with
10532 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10533 from an idle timer function. The symptom of the bug is that
10534 the cursor sometimes doesn't become visible until the next X
10535 event is processed. --gerd. */
10537 Lisp_Object tail
, frame
;
10538 FOR_EACH_FRAME (tail
, frame
)
10539 if (FRAME_RIF (XFRAME (frame
)))
10540 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10544 return input_pending
;
10547 /* This is called in some cases before a possible quit.
10548 It cases the next call to detect_input_pending to recompute input_pending.
10549 So calling this function unnecessarily can't do any harm. */
10552 clear_input_pending (void)
10557 /* Return nonzero if there are pending requeued events.
10558 This isn't used yet. The hope is to make wait_reading_process_output
10559 call it, and return if it runs Lisp code that unreads something.
10560 The problem is, kbd_buffer_get_event needs to be fixed to know what
10561 to do in that case. It isn't trivial. */
10564 requeued_events_pending_p (void)
10566 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10570 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10571 doc
: /* Return t if command input is currently available with no wait.
10572 Actually, the value is nil only if we can be sure that no input is available;
10573 if there is a doubt, the value is t. */)
10576 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10577 || !NILP (Vunread_post_input_method_events
)
10578 || !NILP (Vunread_input_method_events
))
10581 get_input_pending (&input_pending
,
10582 READABLE_EVENTS_DO_TIMERS_NOW
10583 | READABLE_EVENTS_FILTER_EVENTS
);
10584 return input_pending
> 0 ? Qt
: Qnil
;
10587 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10588 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10591 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10594 if (total_keys
< NUM_RECENT_KEYS
)
10595 return Fvector (total_keys
, keys
);
10598 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10599 memcpy (XVECTOR (val
)->contents
, keys
+ recent_keys_index
,
10600 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10601 memcpy (XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10602 keys
, recent_keys_index
* sizeof (Lisp_Object
));
10607 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10608 doc
: /* Return the key sequence that invoked this command.
10609 However, if the command has called `read-key-sequence', it returns
10610 the last key sequence that has been read.
10611 The value is a string or a vector.
10613 See also `this-command-keys-vector'. */)
10616 return make_event_array (this_command_key_count
,
10617 XVECTOR (this_command_keys
)->contents
);
10620 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10621 doc
: /* Return the key sequence that invoked this command, as a vector.
10622 However, if the command has called `read-key-sequence', it returns
10623 the last key sequence that has been read.
10625 See also `this-command-keys'. */)
10628 return Fvector (this_command_key_count
,
10629 XVECTOR (this_command_keys
)->contents
);
10632 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10633 Sthis_single_command_keys
, 0, 0, 0,
10634 doc
: /* Return the key sequence that invoked this command.
10635 More generally, it returns the last key sequence read, either by
10636 the command loop or by `read-key-sequence'.
10637 Unlike `this-command-keys', this function's value
10638 does not include prefix arguments.
10639 The value is always a vector. */)
10642 return Fvector (this_command_key_count
10643 - this_single_command_key_start
,
10644 (XVECTOR (this_command_keys
)->contents
10645 + this_single_command_key_start
));
10648 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10649 Sthis_single_command_raw_keys
, 0, 0, 0,
10650 doc
: /* Return the raw events that were read for this command.
10651 More generally, it returns the last key sequence read, either by
10652 the command loop or by `read-key-sequence'.
10653 Unlike `this-single-command-keys', this function's value
10654 shows the events before all translations (except for input methods).
10655 The value is always a vector. */)
10658 return Fvector (raw_keybuf_count
,
10659 (XVECTOR (raw_keybuf
)->contents
));
10662 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10663 Sreset_this_command_lengths
, 0, 0, 0,
10664 doc
: /* Make the unread events replace the last command and echo.
10665 Used in `universal-argument-other-key'.
10667 `universal-argument-other-key' rereads the event just typed.
10668 It then gets translated through `function-key-map'.
10669 The translated event has to replace the real events,
10670 both in the value of (this-command-keys) and in echoing.
10671 To achieve this, `universal-argument-other-key' calls
10672 `reset-this-command-lengths', which discards the record of reading
10673 these events the first time. */)
10676 this_command_key_count
= before_command_key_count
;
10677 if (this_command_key_count
< this_single_command_key_start
)
10678 this_single_command_key_start
= this_command_key_count
;
10680 echo_truncate (before_command_echo_length
);
10682 /* Cause whatever we put into unread-command-events
10683 to echo as if it were being freshly read from the keyboard. */
10684 this_command_key_count_reset
= 1;
10689 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10690 Sclear_this_command_keys
, 0, 1, 0,
10691 doc
: /* Clear out the vector that `this-command-keys' returns.
10692 Also clear the record of the last 100 events, unless optional arg
10693 KEEP-RECORD is non-nil. */)
10695 Lisp_Object keep_record
;
10699 this_command_key_count
= 0;
10700 this_command_key_count_reset
= 0;
10702 if (NILP (keep_record
))
10704 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10705 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10707 recent_keys_index
= 0;
10712 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10713 doc
: /* Return the current depth in recursive edits. */)
10717 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10721 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10722 "FOpen dribble file: ",
10723 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10724 If FILE is nil, close any open dribble file. */)
10737 file
= Fexpand_file_name (file
, Qnil
);
10738 dribble
= fopen (SDATA (file
), "w");
10740 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10745 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10746 doc
: /* Discard the contents of the terminal input buffer.
10747 Also end any kbd macro being defined. */)
10750 if (!NILP (current_kboard
->defining_kbd_macro
))
10752 /* Discard the last command from the macro. */
10753 Fcancel_kbd_macro_events ();
10757 update_mode_lines
++;
10759 Vunread_command_events
= Qnil
;
10760 unread_command_char
= -1;
10762 discard_tty_input ();
10764 kbd_fetch_ptr
= kbd_store_ptr
;
10770 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10771 doc
: /* Stop Emacs and return to superior process. You can resume later.
10772 If `cannot-suspend' is non-nil, or if the system doesn't support job
10773 control, run a subshell instead.
10775 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10776 to be read as terminal input by Emacs's parent, after suspension.
10778 Before suspending, run the normal hook `suspend-hook'.
10779 After resumption run the normal hook `suspend-resume-hook'.
10781 Some operating systems cannot stop the Emacs process and resume it later.
10782 On such systems, Emacs starts a subshell instead of suspending. */)
10784 Lisp_Object stuffstring
;
10786 int count
= SPECPDL_INDEX ();
10787 int old_height
, old_width
;
10789 struct gcpro gcpro1
;
10791 if (tty_list
&& tty_list
->next
)
10792 error ("There are other tty frames open; close them before suspending Emacs");
10794 if (!NILP (stuffstring
))
10795 CHECK_STRING (stuffstring
);
10797 /* Run the functions in suspend-hook. */
10798 if (!NILP (Vrun_hooks
))
10799 call1 (Vrun_hooks
, intern ("suspend-hook"));
10801 GCPRO1 (stuffstring
);
10802 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10803 reset_all_sys_modes ();
10804 /* sys_suspend can get an error if it tries to fork a subshell
10805 and the system resources aren't available for that. */
10806 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10808 stuff_buffered_input (stuffstring
);
10809 if (cannot_suspend
)
10813 unbind_to (count
, Qnil
);
10815 /* Check if terminal/window size has changed.
10816 Note that this is not useful when we are running directly
10817 with a window system; but suspend should be disabled in that case. */
10818 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10819 if (width
!= old_width
|| height
!= old_height
)
10820 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10822 /* Run suspend-resume-hook. */
10823 if (!NILP (Vrun_hooks
))
10824 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10830 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10831 Then in any case stuff anything Emacs has read ahead and not used. */
10834 stuff_buffered_input (Lisp_Object stuffstring
)
10836 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10837 register unsigned char *p
;
10839 if (STRINGP (stuffstring
))
10841 register int count
;
10843 p
= SDATA (stuffstring
);
10844 count
= SBYTES (stuffstring
);
10845 while (count
-- > 0)
10850 /* Anything we have read ahead, put back for the shell to read. */
10851 /* ?? What should this do when we have multiple keyboards??
10852 Should we ignore anything that was typed in at the "wrong" kboard?
10854 rms: we should stuff everything back into the kboard
10856 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10859 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10860 kbd_fetch_ptr
= kbd_buffer
;
10861 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10862 stuff_char (kbd_fetch_ptr
->code
);
10864 clear_event (kbd_fetch_ptr
);
10868 #endif /* SIGTSTP */
10872 set_waiting_for_input (struct timeval
*time_to_clear
)
10874 input_available_clear_time
= time_to_clear
;
10876 /* Tell handle_interrupt to throw back to read_char, */
10877 waiting_for_input
= 1;
10879 /* If handle_interrupt was called before and buffered a C-g,
10880 make it run again now, to avoid timing error. */
10881 if (!NILP (Vquit_flag
))
10882 quit_throw_to_read_char ();
10886 clear_waiting_for_input (void)
10888 /* Tell handle_interrupt not to throw back to read_char, */
10889 waiting_for_input
= 0;
10890 input_available_clear_time
= 0;
10893 /* The SIGINT handler.
10895 If we have a frame on the controlling tty, we assume that the
10896 SIGINT was generated by C-g, so we call handle_interrupt.
10897 Otherwise, the handler kills Emacs. */
10900 interrupt_signal (int signalnum
) /* If we don't have an argument, some */
10901 /* compilers complain in signal calls. */
10903 /* Must preserve main program's value of errno. */
10904 int old_errno
= errno
;
10905 struct terminal
*terminal
;
10907 SIGNAL_THREAD_CHECK (signalnum
);
10909 /* See if we have an active terminal on our controlling tty. */
10910 terminal
= get_named_tty ("/dev/tty");
10913 /* If there are no frames there, let's pretend that we are a
10914 well-behaving UN*X program and quit. */
10915 Fkill_emacs (Qnil
);
10919 /* Otherwise, the SIGINT was probably generated by C-g. */
10921 /* Set internal_last_event_frame to the top frame of the
10922 controlling tty, if we have a frame there. We disable the
10923 interrupt key on secondary ttys, so the SIGINT must have come
10924 from the controlling tty. */
10925 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10927 handle_interrupt ();
10933 /* This routine is called at interrupt level in response to C-g.
10935 It is called from the SIGINT handler or kbd_buffer_store_event.
10937 If `waiting_for_input' is non zero, then unless `echoing' is
10938 nonzero, immediately throw back to read_char.
10940 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10941 eval to throw, when it gets a chance. If quit-flag is already
10942 non-nil, it stops the job right away. */
10945 handle_interrupt (void)
10951 /* XXX This code needs to be revised for multi-tty support. */
10952 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10954 /* If SIGINT isn't blocked, don't let us be interrupted by
10955 another SIGINT, it might be harmful due to non-reentrancy
10956 in I/O functions. */
10957 sigblock (sigmask (SIGINT
));
10960 reset_all_sys_modes ();
10962 #ifdef SIGTSTP /* Support possible in later USG versions */
10964 * On systems which can suspend the current process and return to the original
10965 * shell, this command causes the user to end up back at the shell.
10966 * The "Auto-save" and "Abort" questions are not asked until
10967 * the user elects to return to emacs, at which point he can save the current
10968 * job and either dump core or continue.
10972 /* Perhaps should really fork an inferior shell?
10973 But that would not provide any way to get back
10974 to the original shell, ever. */
10975 printf ("No support for stopping a process on this operating system;\n");
10976 printf ("you can continue or abort.\n");
10977 #endif /* not SIGTSTP */
10979 /* We must remain inside the screen area when the internal terminal
10980 is used. Note that [Enter] is not echoed by dos. */
10981 cursor_to (SELECTED_FRAME (), 0, 0);
10983 /* It doesn't work to autosave while GC is in progress;
10984 the code used for auto-saving doesn't cope with the mark bit. */
10985 if (!gc_in_progress
)
10987 printf ("Auto-save? (y or n) ");
10989 if (((c
= getchar ()) & ~040) == 'Y')
10991 Fdo_auto_save (Qt
, Qnil
);
10993 printf ("\r\nAuto-save done");
10994 #else /* not MSDOS */
10995 printf ("Auto-save done\n");
10996 #endif /* not MSDOS */
10998 while (c
!= '\n') c
= getchar ();
11002 /* During GC, it must be safe to reenable quitting again. */
11003 Vinhibit_quit
= Qnil
;
11006 #endif /* not MSDOS */
11007 printf ("Garbage collection in progress; cannot auto-save now\r\n");
11008 printf ("but will instead do a real quit after garbage collection ends\r\n");
11013 printf ("\r\nAbort? (y or n) ");
11014 #else /* not MSDOS */
11015 printf ("Abort (and dump core)? (y or n) ");
11016 #endif /* not MSDOS */
11018 if (((c
= getchar ()) & ~040) == 'Y')
11020 while (c
!= '\n') c
= getchar ();
11022 printf ("\r\nContinuing...\r\n");
11023 #else /* not MSDOS */
11024 printf ("Continuing...\n");
11025 #endif /* not MSDOS */
11027 init_all_sys_modes ();
11032 /* If executing a function that wants to be interrupted out of
11033 and the user has not deferred quitting by binding `inhibit-quit'
11034 then quit right away. */
11035 if (immediate_quit
&& NILP (Vinhibit_quit
))
11037 struct gl_state_s saved
;
11038 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
11040 immediate_quit
= 0;
11043 GCPRO4 (saved
.object
, saved
.global_code
,
11044 saved
.current_syntax_table
, saved
.old_prop
);
11045 Fsignal (Qquit
, Qnil
);
11046 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
11051 /* Else request quit when it's safe */
11055 /* TODO: The longjmp in this call throws the NS event loop integration off,
11056 and it seems to do fine without this. Probably some attention
11057 needs to be paid to the setting of waiting_for_input in
11058 wait_reading_process_output() under HAVE_NS because of the call
11059 to ns_select there (needed because otherwise events aren't picked up
11060 outside of polling since we don't get SIGIO like X and we don't have a
11061 separate event loop thread like W32. */
11063 if (waiting_for_input
&& !echoing
)
11064 quit_throw_to_read_char ();
11068 /* Handle a C-g by making read_char return C-g. */
11071 quit_throw_to_read_char (void)
11074 /* Prevent another signal from doing this before we finish. */
11075 clear_waiting_for_input ();
11078 Vunread_command_events
= Qnil
;
11079 unread_command_char
= -1;
11081 #if 0 /* Currently, sit_for is called from read_char without turning
11082 off polling. And that can call set_waiting_for_input.
11083 It seems to be harmless. */
11084 #ifdef POLL_FOR_INPUT
11085 /* May be > 1 if in recursive minibuffer. */
11086 if (poll_suppress_count
== 0)
11090 if (FRAMEP (internal_last_event_frame
)
11091 && !EQ (internal_last_event_frame
, selected_frame
))
11092 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
11095 _longjmp (getcjmp
, 1);
11098 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
11099 doc
: /* Set interrupt mode of reading keyboard input.
11100 If INTERRUPT is non-nil, Emacs will use input interrupts;
11101 otherwise Emacs uses CBREAK mode.
11103 See also `current-input-mode'. */)
11105 Lisp_Object interrupt
;
11107 int new_interrupt_input
;
11109 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11110 #ifdef HAVE_X_WINDOWS
11111 if (x_display_list
!= NULL
)
11113 /* When using X, don't give the user a real choice,
11114 because we haven't implemented the mechanisms to support it. */
11115 new_interrupt_input
= 1;
11118 #endif /* HAVE_X_WINDOWS */
11119 new_interrupt_input
= !NILP (interrupt
);
11120 #else /* not SIGIO */
11121 new_interrupt_input
= 0;
11122 #endif /* not SIGIO */
11124 if (new_interrupt_input
!= interrupt_input
)
11126 #ifdef POLL_FOR_INPUT
11130 /* this causes startup screen to be restored and messes with the mouse */
11131 reset_all_sys_modes ();
11133 interrupt_input
= new_interrupt_input
;
11135 init_all_sys_modes ();
11138 #ifdef POLL_FOR_INPUT
11139 poll_suppress_count
= 1;
11146 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11147 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11148 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11149 C-q in key sequences.
11151 This setting only has an effect on tty terminals and only when
11152 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11154 See also `current-input-mode'. */)
11156 Lisp_Object flow
, terminal
;
11158 struct terminal
*t
= get_terminal (terminal
, 1);
11159 struct tty_display_info
*tty
;
11160 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11162 tty
= t
->display_info
.tty
;
11164 if (tty
->flow_control
!= !NILP (flow
))
11167 /* this causes startup screen to be restored and messes with the mouse */
11168 reset_sys_modes (tty
);
11171 tty
->flow_control
= !NILP (flow
);
11174 init_sys_modes (tty
);
11180 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11181 doc
: /* Enable or disable 8-bit input on TERMINAL.
11182 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11183 bit as the Meta modifier.
11185 If META is nil, Emacs will ignore the top bit, on the assumption it is
11188 Otherwise, Emacs will accept and pass through 8-bit input without
11189 specially interpreting the top bit.
11191 This setting only has an effect on tty terminal devices.
11193 Optional parameter TERMINAL specifies the tty terminal device to use.
11194 It may be a terminal object, a frame, or nil for the terminal used by
11195 the currently selected frame.
11197 See also `current-input-mode'. */)
11199 Lisp_Object meta
, terminal
;
11201 struct terminal
*t
= get_terminal (terminal
, 1);
11202 struct tty_display_info
*tty
;
11205 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11207 tty
= t
->display_info
.tty
;
11211 else if (EQ (meta
, Qt
))
11216 if (tty
->meta_key
!= new_meta
)
11219 /* this causes startup screen to be restored and messes with the mouse */
11220 reset_sys_modes (tty
);
11223 tty
->meta_key
= new_meta
;
11226 init_sys_modes (tty
);
11232 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11233 doc
: /* Specify character used for quitting.
11234 QUIT must be an ASCII character.
11236 This function only has an effect on the controlling tty of the Emacs
11239 See also `current-input-mode'. */)
11243 struct terminal
*t
= get_named_tty ("/dev/tty");
11244 struct tty_display_info
*tty
;
11245 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11247 tty
= t
->display_info
.tty
;
11249 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11250 error ("QUIT must be an ASCII character");
11253 /* this causes startup screen to be restored and messes with the mouse */
11254 reset_sys_modes (tty
);
11257 /* Don't let this value be out of range. */
11258 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11261 init_sys_modes (tty
);
11267 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11268 doc
: /* Set mode of reading keyboard input.
11269 First arg INTERRUPT non-nil means use input interrupts;
11270 nil means use CBREAK mode.
11271 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11272 (no effect except in CBREAK mode).
11273 Third arg META t means accept 8-bit input (for a Meta key).
11274 META nil means ignore the top bit, on the assumption it is parity.
11275 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11276 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11277 See also `current-input-mode'. */)
11278 (interrupt
, flow
, meta
, quit
)
11279 Lisp_Object interrupt
, flow
, meta
, quit
;
11281 Fset_input_interrupt_mode (interrupt
);
11282 Fset_output_flow_control (flow
, Qnil
);
11283 Fset_input_meta_mode (meta
, Qnil
);
11285 Fset_quit_char (quit
);
11289 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11290 doc
: /* Return information about the way Emacs currently reads keyboard input.
11291 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11292 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11293 nil, Emacs is using CBREAK mode.
11294 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11295 terminal; this does not apply if Emacs uses interrupt-driven input.
11296 META is t if accepting 8-bit input with 8th bit as Meta flag.
11297 META nil means ignoring the top bit, on the assumption it is parity.
11298 META is neither t nor nil if accepting 8-bit input and using
11299 all 8 bits as the character code.
11300 QUIT is the character Emacs currently uses to quit.
11301 The elements of this list correspond to the arguments of
11302 `set-input-mode'. */)
11305 Lisp_Object val
[4];
11306 struct frame
*sf
= XFRAME (selected_frame
);
11308 val
[0] = interrupt_input
? Qt
: Qnil
;
11309 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11311 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11312 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11314 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11321 XSETFASTINT (val
[3], quit_char
);
11323 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11326 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11327 doc
: /* Return position information for pixel coordinates X and Y.
11328 By default, X and Y are relative to text area of the selected window.
11329 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11330 If optional fourth arg WHOLE is non-nil, X is relative to the left
11331 edge of the window.
11333 The return value is similar to a mouse click position:
11334 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11335 IMAGE (DX . DY) (WIDTH . HEIGHT))
11336 The `posn-' functions access elements of such lists. */)
11337 (x
, y
, frame_or_window
, whole
)
11338 Lisp_Object x
, y
, frame_or_window
, whole
;
11343 if (NILP (frame_or_window
))
11344 frame_or_window
= selected_window
;
11346 if (WINDOWP (frame_or_window
))
11350 CHECK_LIVE_WINDOW (frame_or_window
);
11352 w
= XWINDOW (frame_or_window
);
11353 XSETINT (x
, (XINT (x
)
11354 + WINDOW_LEFT_EDGE_X (w
)
11356 ? window_box_left_offset (w
, TEXT_AREA
)
11358 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11359 frame_or_window
= w
->frame
;
11362 CHECK_LIVE_FRAME (frame_or_window
);
11364 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
11367 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11368 doc
: /* Return position information for buffer POS in WINDOW.
11369 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11371 Return nil if position is not visible in window. Otherwise,
11372 the return value is similar to that returned by `event-start' for
11373 a mouse click at the upper left corner of the glyph corresponding
11374 to the given buffer position:
11375 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11376 IMAGE (DX . DY) (WIDTH . HEIGHT))
11377 The `posn-' functions access elements of such lists. */)
11379 Lisp_Object pos
, window
;
11384 window
= selected_window
;
11386 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11389 Lisp_Object x
= XCAR (tem
);
11390 Lisp_Object y
= XCAR (XCDR (tem
));
11392 /* Point invisible due to hscrolling? */
11395 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11403 * Set up a new kboard object with reasonable initial values.
11406 init_kboard (KBOARD
*kb
)
11408 kb
->Voverriding_terminal_local_map
= Qnil
;
11409 kb
->Vlast_command
= Qnil
;
11410 kb
->Vreal_last_command
= Qnil
;
11411 kb
->Vkeyboard_translate_table
= Qnil
;
11412 kb
->Vlast_repeatable_command
= Qnil
;
11413 kb
->Vprefix_arg
= Qnil
;
11414 kb
->Vlast_prefix_arg
= Qnil
;
11415 kb
->kbd_queue
= Qnil
;
11416 kb
->kbd_queue_has_data
= 0;
11417 kb
->immediate_echo
= 0;
11418 kb
->echo_string
= Qnil
;
11419 kb
->echo_after_prompt
= -1;
11420 kb
->kbd_macro_buffer
= 0;
11421 kb
->kbd_macro_bufsize
= 0;
11422 kb
->defining_kbd_macro
= Qnil
;
11423 kb
->Vlast_kbd_macro
= Qnil
;
11424 kb
->reference_count
= 0;
11425 kb
->Vsystem_key_alist
= Qnil
;
11426 kb
->system_key_syms
= Qnil
;
11427 kb
->Vwindow_system
= Qt
; /* Unset. */
11428 kb
->Vinput_decode_map
= Fmake_sparse_keymap (Qnil
);
11429 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
11430 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
11431 kb
->Vdefault_minibuffer_frame
= Qnil
;
11435 * Destroy the contents of a kboard object, but not the object itself.
11436 * We use this just before deleting it, or if we're going to initialize
11437 * it a second time.
11440 wipe_kboard (KBOARD
*kb
)
11442 xfree (kb
->kbd_macro_buffer
);
11445 /* Free KB and memory referenced from it. */
11448 delete_kboard (KBOARD
*kb
)
11452 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11455 *kbp
= kb
->next_kboard
;
11457 /* Prevent a dangling reference to KB. */
11458 if (kb
== current_kboard
11459 && FRAMEP (selected_frame
)
11460 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11462 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11464 if (current_kboard
== kb
)
11473 init_keyboard (void)
11475 /* This is correct before outermost invocation of the editor loop */
11476 command_loop_level
= -1;
11477 immediate_quit
= 0;
11478 quit_char
= Ctl ('g');
11479 Vunread_command_events
= Qnil
;
11480 unread_command_char
= -1;
11481 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11483 recent_keys_index
= 0;
11484 kbd_fetch_ptr
= kbd_buffer
;
11485 kbd_store_ptr
= kbd_buffer
;
11486 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11487 do_mouse_tracking
= Qnil
;
11490 interrupt_input_blocked
= 0;
11491 interrupt_input_pending
= 0;
11493 pending_signals
= 0;
11496 /* This means that command_loop_1 won't try to select anything the first
11498 internal_last_event_frame
= Qnil
;
11499 Vlast_event_frame
= internal_last_event_frame
;
11501 current_kboard
= initial_kboard
;
11502 /* Re-initialize the keyboard again. */
11503 wipe_kboard (current_kboard
);
11504 init_kboard (current_kboard
);
11505 /* A value of nil for Vwindow_system normally means a tty, but we also use
11506 it for the initial terminal since there is no window system there. */
11507 current_kboard
->Vwindow_system
= Qnil
;
11509 if (!noninteractive
)
11511 /* Before multi-tty support, these handlers used to be installed
11512 only if the current session was a tty session. Now an Emacs
11513 session may have multiple display types, so we always handle
11514 SIGINT. There is special code in interrupt_signal to exit
11515 Emacs on SIGINT when there are no termcap frames on the
11516 controlling terminal. */
11517 signal (SIGINT
, interrupt_signal
);
11518 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11519 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11520 SIGQUIT and we can't tell which one it will give us. */
11521 signal (SIGQUIT
, interrupt_signal
);
11522 #endif /* HAVE_TERMIO */
11524 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11526 if (!noninteractive
)
11527 signal (SIGIO
, input_available_signal
);
11530 /* Use interrupt input by default, if it works and noninterrupt input
11531 has deficiencies. */
11533 #ifdef INTERRUPT_INPUT
11534 interrupt_input
= 1;
11536 interrupt_input
= 0;
11542 if (keyboard_init_hook
)
11543 (*keyboard_init_hook
) ();
11545 #ifdef POLL_FOR_INPUT
11547 poll_suppress_count
= 1;
11552 /* This type's only use is in syms_of_keyboard, to initialize the
11553 event header symbols and put properties on them. */
11554 struct event_head
{
11560 struct event_head head_table
[] = {
11561 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11562 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11563 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11564 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11565 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11566 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11567 /* `select-window' should be handled just like `switch-frame'
11568 in read_key_sequence. */
11569 {&Qselect_window
, "select-window", &Qswitch_frame
}
11573 syms_of_keyboard (void)
11575 pending_funcalls
= Qnil
;
11576 staticpro (&pending_funcalls
);
11578 Vlispy_mouse_stem
= make_pure_c_string ("mouse");
11579 staticpro (&Vlispy_mouse_stem
);
11582 QCimage
= intern_c_string (":image");
11583 staticpro (&QCimage
);
11585 staticpro (&Qhelp_echo
);
11586 Qhelp_echo
= intern_c_string ("help-echo");
11589 Qrtl
= intern_c_string (":rtl");
11591 staticpro (&item_properties
);
11592 item_properties
= Qnil
;
11594 staticpro (&tool_bar_item_properties
);
11595 tool_bar_item_properties
= Qnil
;
11596 staticpro (&tool_bar_items_vector
);
11597 tool_bar_items_vector
= Qnil
;
11599 staticpro (&real_this_command
);
11600 real_this_command
= Qnil
;
11602 Qtimer_event_handler
= intern_c_string ("timer-event-handler");
11603 staticpro (&Qtimer_event_handler
);
11605 Qdisabled_command_function
= intern_c_string ("disabled-command-function");
11606 staticpro (&Qdisabled_command_function
);
11608 Qself_insert_command
= intern_c_string ("self-insert-command");
11609 staticpro (&Qself_insert_command
);
11611 Qforward_char
= intern_c_string ("forward-char");
11612 staticpro (&Qforward_char
);
11614 Qbackward_char
= intern_c_string ("backward-char");
11615 staticpro (&Qbackward_char
);
11617 Qdisabled
= intern_c_string ("disabled");
11618 staticpro (&Qdisabled
);
11620 Qundefined
= intern_c_string ("undefined");
11621 staticpro (&Qundefined
);
11623 Qpre_command_hook
= intern_c_string ("pre-command-hook");
11624 staticpro (&Qpre_command_hook
);
11626 Qpost_command_hook
= intern_c_string ("post-command-hook");
11627 staticpro (&Qpost_command_hook
);
11629 Qdeferred_action_function
= intern_c_string ("deferred-action-function");
11630 staticpro (&Qdeferred_action_function
);
11632 Qcommand_hook_internal
= intern_c_string ("command-hook-internal");
11633 staticpro (&Qcommand_hook_internal
);
11635 Qfunction_key
= intern_c_string ("function-key");
11636 staticpro (&Qfunction_key
);
11637 Qmouse_click
= intern_c_string ("mouse-click");
11638 staticpro (&Qmouse_click
);
11639 #if defined (WINDOWSNT)
11640 Qlanguage_change
= intern_c_string ("language-change");
11641 staticpro (&Qlanguage_change
);
11643 Qdrag_n_drop
= intern_c_string ("drag-n-drop");
11644 staticpro (&Qdrag_n_drop
);
11646 Qsave_session
= intern_c_string ("save-session");
11647 staticpro (&Qsave_session
);
11650 Qdbus_event
= intern_c_string ("dbus-event");
11651 staticpro (&Qdbus_event
);
11654 Qconfig_changed_event
= intern_c_string ("config-changed-event");
11655 staticpro (&Qconfig_changed_event
);
11657 Qmenu_enable
= intern_c_string ("menu-enable");
11658 staticpro (&Qmenu_enable
);
11659 QCenable
= intern_c_string (":enable");
11660 staticpro (&QCenable
);
11661 QCvisible
= intern_c_string (":visible");
11662 staticpro (&QCvisible
);
11663 QChelp
= intern_c_string (":help");
11664 staticpro (&QChelp
);
11665 QCfilter
= intern_c_string (":filter");
11666 staticpro (&QCfilter
);
11667 QCbutton
= intern_c_string (":button");
11668 staticpro (&QCbutton
);
11669 QCkeys
= intern_c_string (":keys");
11670 staticpro (&QCkeys
);
11671 QCkey_sequence
= intern_c_string (":key-sequence");
11672 staticpro (&QCkey_sequence
);
11673 QCtoggle
= intern_c_string (":toggle");
11674 staticpro (&QCtoggle
);
11675 QCradio
= intern_c_string (":radio");
11676 staticpro (&QCradio
);
11677 QClabel
= intern_c_string (":label");
11678 staticpro (&QClabel
);
11680 Qmode_line
= intern_c_string ("mode-line");
11681 staticpro (&Qmode_line
);
11682 Qvertical_line
= intern_c_string ("vertical-line");
11683 staticpro (&Qvertical_line
);
11684 Qvertical_scroll_bar
= intern_c_string ("vertical-scroll-bar");
11685 staticpro (&Qvertical_scroll_bar
);
11686 Qmenu_bar
= intern_c_string ("menu-bar");
11687 staticpro (&Qmenu_bar
);
11689 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11690 Qmouse_fixup_help_message
= intern_c_string ("mouse-fixup-help-message");
11691 staticpro (&Qmouse_fixup_help_message
);
11694 Qabove_handle
= intern_c_string ("above-handle");
11695 staticpro (&Qabove_handle
);
11696 Qhandle
= intern_c_string ("handle");
11697 staticpro (&Qhandle
);
11698 Qbelow_handle
= intern_c_string ("below-handle");
11699 staticpro (&Qbelow_handle
);
11700 Qup
= intern_c_string ("up");
11702 Qdown
= intern_c_string ("down");
11703 staticpro (&Qdown
);
11704 Qtop
= intern_c_string ("top");
11706 Qbottom
= intern_c_string ("bottom");
11707 staticpro (&Qbottom
);
11708 Qend_scroll
= intern_c_string ("end-scroll");
11709 staticpro (&Qend_scroll
);
11710 Qratio
= intern_c_string ("ratio");
11711 staticpro (&Qratio
);
11713 Qevent_kind
= intern_c_string ("event-kind");
11714 staticpro (&Qevent_kind
);
11715 Qevent_symbol_elements
= intern_c_string ("event-symbol-elements");
11716 staticpro (&Qevent_symbol_elements
);
11717 Qevent_symbol_element_mask
= intern_c_string ("event-symbol-element-mask");
11718 staticpro (&Qevent_symbol_element_mask
);
11719 Qmodifier_cache
= intern_c_string ("modifier-cache");
11720 staticpro (&Qmodifier_cache
);
11722 Qrecompute_lucid_menubar
= intern_c_string ("recompute-lucid-menubar");
11723 staticpro (&Qrecompute_lucid_menubar
);
11724 Qactivate_menubar_hook
= intern_c_string ("activate-menubar-hook");
11725 staticpro (&Qactivate_menubar_hook
);
11727 Qpolling_period
= intern_c_string ("polling-period");
11728 staticpro (&Qpolling_period
);
11730 Qinput_method_function
= intern_c_string ("input-method-function");
11731 staticpro (&Qinput_method_function
);
11733 Qinput_method_exit_on_first_char
= intern_c_string ("input-method-exit-on-first-char");
11734 staticpro (&Qinput_method_exit_on_first_char
);
11735 Qinput_method_use_echo_area
= intern_c_string ("input-method-use-echo-area");
11736 staticpro (&Qinput_method_use_echo_area
);
11738 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11739 Fset (Qinput_method_use_echo_area
, Qnil
);
11741 last_point_position_buffer
= Qnil
;
11742 last_point_position_window
= Qnil
;
11745 struct event_head
*p
;
11747 for (p
= head_table
;
11748 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11751 *p
->var
= intern_c_string (p
->name
);
11752 staticpro (p
->var
);
11753 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11754 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11758 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11759 staticpro (&button_down_location
);
11760 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11761 staticpro (&mouse_syms
);
11762 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11763 / sizeof (lispy_wheel_names
[0])),
11765 staticpro (&wheel_syms
);
11769 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11771 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11772 for (i
= 0; i
< len
; i
++)
11773 if (modifier_names
[i
])
11774 XVECTOR (modifier_symbols
)->contents
[i
] = intern_c_string (modifier_names
[i
]);
11775 staticpro (&modifier_symbols
);
11778 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11779 staticpro (&recent_keys
);
11781 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11782 staticpro (&this_command_keys
);
11784 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11785 staticpro (&raw_keybuf
);
11787 Qextended_command_history
= intern_c_string ("extended-command-history");
11788 Fset (Qextended_command_history
, Qnil
);
11789 staticpro (&Qextended_command_history
);
11791 accent_key_syms
= Qnil
;
11792 staticpro (&accent_key_syms
);
11794 func_key_syms
= Qnil
;
11795 staticpro (&func_key_syms
);
11797 drag_n_drop_syms
= Qnil
;
11798 staticpro (&drag_n_drop_syms
);
11800 unread_switch_frame
= Qnil
;
11801 staticpro (&unread_switch_frame
);
11803 internal_last_event_frame
= Qnil
;
11804 staticpro (&internal_last_event_frame
);
11806 read_key_sequence_cmd
= Qnil
;
11807 staticpro (&read_key_sequence_cmd
);
11809 menu_bar_one_keymap_changed_items
= Qnil
;
11810 staticpro (&menu_bar_one_keymap_changed_items
);
11812 menu_bar_items_vector
= Qnil
;
11813 staticpro (&menu_bar_items_vector
);
11815 help_form_saved_window_configs
= Qnil
;
11816 staticpro (&help_form_saved_window_configs
);
11818 defsubr (&Scurrent_idle_time
);
11819 defsubr (&Sevent_symbol_parse_modifiers
);
11820 defsubr (&Sevent_convert_list
);
11821 defsubr (&Sread_key_sequence
);
11822 defsubr (&Sread_key_sequence_vector
);
11823 defsubr (&Srecursive_edit
);
11824 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11825 defsubr (&Strack_mouse
);
11827 defsubr (&Sinput_pending_p
);
11828 defsubr (&Scommand_execute
);
11829 defsubr (&Srecent_keys
);
11830 defsubr (&Sthis_command_keys
);
11831 defsubr (&Sthis_command_keys_vector
);
11832 defsubr (&Sthis_single_command_keys
);
11833 defsubr (&Sthis_single_command_raw_keys
);
11834 defsubr (&Sreset_this_command_lengths
);
11835 defsubr (&Sclear_this_command_keys
);
11836 defsubr (&Ssuspend_emacs
);
11837 defsubr (&Sabort_recursive_edit
);
11838 defsubr (&Sexit_recursive_edit
);
11839 defsubr (&Srecursion_depth
);
11840 defsubr (&Stop_level
);
11841 defsubr (&Sdiscard_input
);
11842 defsubr (&Sopen_dribble_file
);
11843 defsubr (&Sset_input_interrupt_mode
);
11844 defsubr (&Sset_output_flow_control
);
11845 defsubr (&Sset_input_meta_mode
);
11846 defsubr (&Sset_quit_char
);
11847 defsubr (&Sset_input_mode
);
11848 defsubr (&Scurrent_input_mode
);
11849 defsubr (&Sexecute_extended_command
);
11850 defsubr (&Sposn_at_point
);
11851 defsubr (&Sposn_at_x_y
);
11853 DEFVAR_LISP ("last-command-event", &last_command_event
,
11854 doc
: /* Last input event that was part of a command. */);
11856 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11857 doc
: /* Last input event in a command, except for mouse menu events.
11858 Mouse menus give back keys that don't look like mouse events;
11859 this variable holds the actual mouse event that led to the menu,
11860 so that you can determine whether the command was run by mouse or not. */);
11862 DEFVAR_LISP ("last-input-event", &last_input_event
,
11863 doc
: /* Last input event. */);
11865 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11866 doc
: /* List of events to be read as the command input.
11867 These events are processed first, before actual keyboard input.
11868 Events read from this list are not normally added to `this-command-keys',
11869 as they will already have been added once as they were read for the first time.
11870 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11871 Vunread_command_events
= Qnil
;
11873 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11874 doc
: /* If not -1, an object to be read as next command input event. */);
11876 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11877 doc
: /* List of events to be processed as input by input methods.
11878 These events are processed before `unread-command-events'
11879 and actual keyboard input, but are not given to `input-method-function'. */);
11880 Vunread_post_input_method_events
= Qnil
;
11882 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11883 doc
: /* List of events to be processed as input by input methods.
11884 These events are processed after `unread-command-events', but
11885 before actual keyboard input.
11886 If there's an active input method, the events are given to
11887 `input-method-function'. */);
11888 Vunread_input_method_events
= Qnil
;
11890 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11891 doc
: /* Meta-prefix character code.
11892 Meta-foo as command input turns into this character followed by foo. */);
11893 XSETINT (meta_prefix_char
, 033);
11895 DEFVAR_KBOARD ("last-command", Vlast_command
,
11896 doc
: /* The last command executed.
11897 Normally a symbol with a function definition, but can be whatever was found
11898 in the keymap, or whatever the variable `this-command' was set to by that
11901 The value `mode-exit' is special; it means that the previous command
11902 read an event that told it to exit, and it did so and unread that event.
11903 In other words, the present command is the event that made the previous
11906 The value `kill-region' is special; it means that the previous command
11907 was a kill command.
11909 `last-command' has a separate binding for each terminal device.
11910 See Info node `(elisp)Multiple Terminals'. */);
11912 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11913 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11915 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11916 doc
: /* Last command that may be repeated.
11917 The last command executed that was not bound to an input event.
11918 This is the command `repeat' will try to repeat. */);
11920 DEFVAR_LISP ("this-command", &Vthis_command
,
11921 doc
: /* The command now being executed.
11922 The command can set this variable; whatever is put here
11923 will be in `last-command' during the following command. */);
11924 Vthis_command
= Qnil
;
11926 DEFVAR_LISP ("this-command-keys-shift-translated",
11927 &Vthis_command_keys_shift_translated
,
11928 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11929 Shift-translation occurs when there is no binding for the key sequence
11930 as entered, but a binding was found by changing an upper-case letter
11931 to lower-case, or a shifted function key to an unshifted one. */);
11932 Vthis_command_keys_shift_translated
= Qnil
;
11934 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11935 doc
: /* The command bound to the current key sequence before remapping.
11936 It equals `this-command' if the original command was not remapped through
11937 any of the active keymaps. Otherwise, the value of `this-command' is the
11938 result of looking up the original command in the active keymaps. */);
11939 Vthis_original_command
= Qnil
;
11941 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11942 doc
: /* *Number of input events between auto-saves.
11943 Zero means disable autosaving due to number of characters typed. */);
11944 auto_save_interval
= 300;
11946 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11947 doc
: /* *Number of seconds idle time before auto-save.
11948 Zero or nil means disable auto-saving due to idleness.
11949 After auto-saving due to this many seconds of idle time,
11950 Emacs also does a garbage collection if that seems to be warranted. */);
11951 XSETFASTINT (Vauto_save_timeout
, 30);
11953 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11954 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11955 The value may be integer or floating point. */);
11956 Vecho_keystrokes
= make_number (1);
11958 DEFVAR_INT ("polling-period", &polling_period
,
11959 doc
: /* *Interval between polling for input during Lisp execution.
11960 The reason for polling is to make C-g work to stop a running program.
11961 Polling is needed only when using X windows and SIGIO does not work.
11962 Polling is automatically disabled in all other cases. */);
11963 polling_period
= 2;
11965 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11966 doc
: /* *Maximum time between mouse clicks to make a double-click.
11967 Measured in milliseconds. The value nil means disable double-click
11968 recognition; t means double-clicks have no time limit and are detected
11969 by position only. */);
11970 Vdouble_click_time
= make_number (500);
11972 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11973 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11974 On window-system frames, value is the number of pixels the mouse may have
11975 moved horizontally or vertically between two clicks to make a double-click.
11976 On non window-system frames, value is interpreted in units of 1/8 characters
11979 This variable is also the threshold for motion of the mouse
11980 to count as a drag. */);
11981 double_click_fuzz
= 3;
11983 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11984 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11985 inhibit_local_menu_bar_menus
= 0;
11987 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11988 doc
: /* Number of complete key sequences read as input so far.
11989 This includes key sequences read from keyboard macros.
11990 The number is effectively the number of interactive command invocations. */);
11991 num_input_keys
= 0;
11993 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11994 doc
: /* Number of input events read from the keyboard so far.
11995 This does not include events generated by keyboard macros. */);
11996 num_nonmacro_input_events
= 0;
11998 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11999 doc
: /* The frame in which the most recently read event occurred.
12000 If the last event came from a keyboard macro, this is set to `macro'. */);
12001 Vlast_event_frame
= Qnil
;
12003 /* This variable is set up in sysdep.c. */
12004 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
12005 doc
: /* The ERASE character as set by the user with stty. */);
12007 DEFVAR_LISP ("help-char", &Vhelp_char
,
12008 doc
: /* Character to recognize as meaning Help.
12009 When it is read, do `(eval help-form)', and display result if it's a string.
12010 If the value of `help-form' is nil, this char can be read normally. */);
12011 XSETINT (Vhelp_char
, Ctl ('H'));
12013 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
12014 doc
: /* List of input events to recognize as meaning Help.
12015 These work just like the value of `help-char' (see that). */);
12016 Vhelp_event_list
= Qnil
;
12018 DEFVAR_LISP ("help-form", &Vhelp_form
,
12019 doc
: /* Form to execute when character `help-char' is read.
12020 If the form returns a string, that string is displayed.
12021 If `help-form' is nil, the help char is not recognized. */);
12024 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
12025 doc
: /* Command to run when `help-char' character follows a prefix key.
12026 This command is used only when there is no actual binding
12027 for that character after that prefix key. */);
12028 Vprefix_help_command
= Qnil
;
12030 DEFVAR_LISP ("top-level", &Vtop_level
,
12031 doc
: /* Form to evaluate when Emacs starts up.
12032 Useful to set before you dump a modified Emacs. */);
12035 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
12036 doc
: /* Translate table for local keyboard input, or nil.
12037 If non-nil, the value should be a char-table. Each character read
12038 from the keyboard is looked up in this char-table. If the value found
12039 there is non-nil, then it is used instead of the actual input character.
12041 The value can also be a string or vector, but this is considered obsolete.
12042 If it is a string or vector of length N, character codes N and up are left
12043 untranslated. In a vector, an element which is nil means "no translation".
12045 This is applied to the characters supplied to input methods, not their
12046 output. See also `translation-table-for-input'.
12048 This variable has a separate binding for each terminal.
12049 See Info node `(elisp)Multiple Terminals'. */);
12051 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
12052 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
12053 \(Even if the operating system has support for stopping a process.\) */);
12054 cannot_suspend
= 0;
12056 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
12057 doc
: /* Non-nil means prompt with menus when appropriate.
12058 This is done when reading from a keymap that has a prompt string,
12059 for elements that have prompt strings.
12060 The menu is displayed on the screen
12061 if X menus were enabled at configuration
12062 time and the previous event was a mouse click prefix key.
12063 Otherwise, menu prompting uses the echo area. */);
12064 menu_prompting
= 1;
12066 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
12067 doc
: /* Character to see next line of menu prompt.
12068 Type this character while in a menu prompt to rotate around the lines of it. */);
12069 XSETINT (menu_prompt_more_char
, ' ');
12071 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
12072 doc
: /* A mask of additional modifier keys to use with every keyboard character.
12073 Emacs applies the modifiers of the character stored here to each keyboard
12074 character it reads. For example, after evaluating the expression
12075 (setq extra-keyboard-modifiers ?\\C-x)
12076 all input characters will have the control modifier applied to them.
12078 Note that the character ?\\C-@, equivalent to the integer zero, does
12079 not count as a control character; rather, it counts as a character
12080 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
12081 cancels any modification. */);
12082 extra_keyboard_modifiers
= 0;
12084 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
12085 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
12086 The command loop sets this to nil before each command,
12087 and tests the value when the command returns.
12088 Buffer modification stores t in this variable. */);
12089 Vdeactivate_mark
= Qnil
;
12090 Qdeactivate_mark
= intern_c_string ("deactivate-mark");
12091 staticpro (&Qdeactivate_mark
);
12093 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
12094 doc
: /* Temporary storage of `pre-command-hook' or `post-command-hook'. */);
12095 Vcommand_hook_internal
= Qnil
;
12097 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
12098 doc
: /* Normal hook run before each command is executed.
12099 If an unhandled error happens in running this hook,
12100 the hook value is set to nil, since otherwise the error
12101 might happen repeatedly and make Emacs nonfunctional. */);
12102 Vpre_command_hook
= Qnil
;
12104 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
12105 doc
: /* Normal hook run after each command is executed.
12106 If an unhandled error happens in running this hook,
12107 the hook value is set to nil, since otherwise the error
12108 might happen repeatedly and make Emacs nonfunctional. */);
12109 Vpost_command_hook
= Qnil
;
12112 DEFVAR_LISP ("echo-area-clear-hook", ...,
12113 doc
: /* Normal hook run when clearing the echo area. */);
12115 Qecho_area_clear_hook
= intern_c_string ("echo-area-clear-hook");
12116 staticpro (&Qecho_area_clear_hook
);
12117 Fset (Qecho_area_clear_hook
, Qnil
);
12119 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
12120 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
12121 Vlucid_menu_bar_dirty_flag
= Qnil
;
12123 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
12124 doc
: /* List of menu bar items to move to the end of the menu bar.
12125 The elements of the list are event types that may have menu bar bindings. */);
12126 Vmenu_bar_final_items
= Qnil
;
12128 DEFVAR_KBOARD ("overriding-terminal-local-map",
12129 Voverriding_terminal_local_map
,
12130 doc
: /* Per-terminal keymap that overrides all other local keymaps.
12131 If this variable is non-nil, it is used as a keymap instead of the
12132 buffer's local map, and the minor mode keymaps and text property keymaps.
12133 It also replaces `overriding-local-map'.
12135 This variable is intended to let commands such as `universal-argument'
12136 set up a different keymap for reading the next command.
12138 `overriding-terminal-local-map' has a separate binding for each
12140 See Info node `(elisp)Multiple Terminals'. */);
12142 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
12143 doc
: /* Keymap that overrides all other local keymaps.
12144 If this variable is non-nil, it is used as a keymap--replacing the
12145 buffer's local map, the minor mode keymaps, and char property keymaps. */);
12146 Voverriding_local_map
= Qnil
;
12148 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
12149 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
12150 Otherwise, the menu bar continues to reflect the buffer's local map
12151 and the minor mode maps regardless of `overriding-local-map'. */);
12152 Voverriding_local_map_menu_flag
= Qnil
;
12154 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
12155 doc
: /* Keymap defining bindings for special events to execute at low level. */);
12156 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
12158 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
12159 doc
: /* *Non-nil means generate motion events for mouse motion. */);
12161 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
12162 doc
: /* Alist of system-specific X windows key symbols.
12163 Each element should have the form (N . SYMBOL) where N is the
12164 numeric keysym code (sans the \"system-specific\" bit 1<<28)
12165 and SYMBOL is its name.
12167 `system-key-alist' has a separate binding for each terminal device.
12168 See Info node `(elisp)Multiple Terminals'. */);
12170 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12171 doc
: /* Keymap that translates key sequences to key sequences during input.
12172 This is used mainly for mapping key sequences into some preferred
12173 key events (symbols).
12175 The `read-key-sequence' function replaces any subsequence bound by
12176 `local-function-key-map' with its binding. More precisely, when the
12177 active keymaps have no binding for the current key sequence but
12178 `local-function-key-map' binds a suffix of the sequence to a vector or
12179 string, `read-key-sequence' replaces the matching suffix with its
12180 binding, and continues with the new sequence.
12182 If the binding is a function, it is called with one argument (the prompt)
12183 and its return value (a key sequence) is used.
12185 The events that come from bindings in `local-function-key-map' are not
12186 themselves looked up in `local-function-key-map'.
12188 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12189 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12190 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12191 typing `ESC O P x' would return [f1 x].
12193 `local-function-key-map' has a separate binding for each terminal
12194 device. See Info node `(elisp)Multiple Terminals'. If you need to
12195 define a binding on all terminals, change `function-key-map'
12196 instead. Initially, `local-function-key-map' is an empty keymap that
12197 has `function-key-map' as its parent on all terminal devices. */);
12199 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12200 doc
: /* Keymap that decodes input escape sequences.
12201 This is used mainly for mapping ASCII function key sequences into
12202 real Emacs function key events (symbols).
12204 The `read-key-sequence' function replaces any subsequence bound by
12205 `input-decode-map' with its binding. Contrary to `function-key-map',
12206 this map applies its rebinding regardless of the presence of an ordinary
12207 binding. So it is more like `key-translation-map' except that it applies
12208 before `function-key-map' rather than after.
12210 If the binding is a function, it is called with one argument (the prompt)
12211 and its return value (a key sequence) is used.
12213 The events that come from bindings in `input-decode-map' are not
12214 themselves looked up in `input-decode-map'.
12216 This variable is keyboard-local. */);
12218 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
12219 doc
: /* The parent keymap of all `local-function-key-map' instances.
12220 Function key definitions that apply to all terminal devices should go
12221 here. If a mapping is defined in both the current
12222 `local-function-key-map' binding and this variable, then the local
12223 definition will take precendence. */);
12224 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12226 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
12227 doc
: /* Keymap of key translations that can override keymaps.
12228 This keymap works like `function-key-map', but comes after that,
12229 and its non-prefix bindings override ordinary bindings.
12230 Another difference is that it is global rather than keyboard-local. */);
12231 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12233 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
12234 doc
: /* List of deferred actions to be performed at a later time.
12235 The precise format isn't relevant here; we just check whether it is nil. */);
12236 Vdeferred_action_list
= Qnil
;
12238 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
12239 doc
: /* Function to call to handle deferred actions, after each command.
12240 This function is called with no arguments after each command
12241 whenever `deferred-action-list' is non-nil. */);
12242 Vdeferred_action_function
= Qnil
;
12244 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
12245 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
12246 The value can be a length of time to show the message for.
12247 If the value is non-nil and not a number, we wait 2 seconds. */);
12248 Vsuggest_key_bindings
= Qt
;
12250 DEFVAR_LISP ("timer-list", &Vtimer_list
,
12251 doc
: /* List of active absolute time timers in order of increasing time. */);
12252 Vtimer_list
= Qnil
;
12254 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
12255 doc
: /* List of active idle-time timers in order of increasing time. */);
12256 Vtimer_idle_list
= Qnil
;
12258 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
12259 doc
: /* If non-nil, the function that implements the current input method.
12260 It's called with one argument, a printing character that was just read.
12261 \(That means a character with code 040...0176.)
12262 Typically this function uses `read-event' to read additional events.
12263 When it does so, it should first bind `input-method-function' to nil
12264 so it will not be called recursively.
12266 The function should return a list of zero or more events
12267 to be used as input. If it wants to put back some events
12268 to be reconsidered, separately, by the input method,
12269 it can add them to the beginning of `unread-command-events'.
12271 The input method function can find in `input-method-previous-message'
12272 the previous echo area message.
12274 The input method function should refer to the variables
12275 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12276 for guidance on what to do. */);
12277 Vinput_method_function
= Qnil
;
12279 DEFVAR_LISP ("input-method-previous-message",
12280 &Vinput_method_previous_message
,
12281 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12282 This variable exists because `read-event' clears the echo area
12283 before running the input method. It is nil if there was no message. */);
12284 Vinput_method_previous_message
= Qnil
;
12286 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
12287 doc
: /* If non-nil, the function that implements the display of help.
12288 It's called with one argument, the help string to display. */);
12289 Vshow_help_function
= Qnil
;
12291 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
12292 doc
: /* If non-nil, suppress point adjustment after executing a command.
12294 After a command is executed, if point is moved into a region that has
12295 special properties (e.g. composition, display), we adjust point to
12296 the boundary of the region. But, when a command sets this variable to
12297 non-nil, we suppress the point adjustment.
12299 This variable is set to nil before reading a command, and is checked
12300 just after executing the command. */);
12301 Vdisable_point_adjustment
= Qnil
;
12303 DEFVAR_LISP ("global-disable-point-adjustment",
12304 &Vglobal_disable_point_adjustment
,
12305 doc
: /* *If non-nil, always suppress point adjustment.
12307 The default value is nil, in which case, point adjustment are
12308 suppressed only after special commands that set
12309 `disable-point-adjustment' (which see) to non-nil. */);
12310 Vglobal_disable_point_adjustment
= Qnil
;
12312 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
12313 doc
: /* *How long to display an echo-area message when the minibuffer is active.
12314 If the value is not a number, such messages don't time out. */);
12315 Vminibuffer_message_timeout
= make_number (2);
12317 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
12318 doc
: /* If non-nil, any keyboard input throws to this symbol.
12319 The value of that variable is passed to `quit-flag' and later causes a
12320 peculiar kind of quitting. */);
12321 Vthrow_on_input
= Qnil
;
12323 DEFVAR_LISP ("command-error-function", &Vcommand_error_function
,
12324 doc
: /* If non-nil, function to output error messages.
12325 The arguments are the error data, a list of the form
12326 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12327 such as just as `condition-case' would bind its variable to,
12328 the context (a string which normally goes at the start of the message),
12329 and the Lisp function within which the error was signaled. */);
12330 Vcommand_error_function
= Qnil
;
12332 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12333 &Venable_disabled_menus_and_buttons
,
12334 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12336 Help functions bind this to allow help on disabled menu items
12337 and tool-bar buttons. */);
12338 Venable_disabled_menus_and_buttons
= Qnil
;
12340 /* Create the initial keyboard. */
12341 initial_kboard
= (KBOARD
*) xmalloc (sizeof (KBOARD
));
12342 init_kboard (initial_kboard
);
12343 /* Vwindow_system is left at t for now. */
12344 initial_kboard
->next_kboard
= all_kboards
;
12345 all_kboards
= initial_kboard
;
12349 keys_of_keyboard (void)
12351 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12352 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12353 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12354 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12355 initial_define_key (meta_map
, 'x', "execute-extended-command");
12357 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12358 "handle-delete-frame");
12359 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12360 "ns-put-working-text");
12361 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12362 "ns-unput-working-text");
12363 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12364 current-prefix-arg, as is done in `handle-switch-frame'.
12365 But `handle-switch-frame is not run from the special-map.
12366 Commands from that map are run in a special way that automatically
12367 preserves the prefix-arg. Restoring the prefix arg here is not just
12368 redundant but harmful:
12370 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12371 - after the first prompt, the exit-minibuffer-hook is run which may
12372 iconify a frame and thus push a `iconify-frame' event.
12373 - after running exit-minibuffer-hook, current-prefix-arg is
12374 restored to the non-nil value it had before the prompt.
12375 - we enter the second prompt.
12376 current-prefix-arg is non-nil, prefix-arg is nil.
12377 - before running the first real event, we run the special iconify-frame
12378 event, but we pass the `special' arg to execute-command so
12379 current-prefix-arg and prefix-arg are left untouched.
12380 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12381 - the next key event will have a spuriously non-nil current-prefix-arg. */
12382 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12384 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12386 /* Handling it at such a low-level causes read_key_sequence to get
12387 * confused because it doesn't realize that the current_buffer was
12388 * changed by read_char.
12390 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12391 * "handle-select-window"); */
12392 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12393 "handle-save-session");
12396 /* Define a special event which is raised for dbus callback
12398 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12399 "dbus-handle-event");
12402 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12406 /* Mark the pointers in the kboard objects.
12407 Called by the Fgarbage_collector. */
12409 mark_kboards (void)
12413 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12415 if (kb
->kbd_macro_buffer
)
12416 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12418 mark_object (kb
->Voverriding_terminal_local_map
);
12419 mark_object (kb
->Vlast_command
);
12420 mark_object (kb
->Vreal_last_command
);
12421 mark_object (kb
->Vkeyboard_translate_table
);
12422 mark_object (kb
->Vlast_repeatable_command
);
12423 mark_object (kb
->Vprefix_arg
);
12424 mark_object (kb
->Vlast_prefix_arg
);
12425 mark_object (kb
->kbd_queue
);
12426 mark_object (kb
->defining_kbd_macro
);
12427 mark_object (kb
->Vlast_kbd_macro
);
12428 mark_object (kb
->Vsystem_key_alist
);
12429 mark_object (kb
->system_key_syms
);
12430 mark_object (kb
->Vwindow_system
);
12431 mark_object (kb
->Vinput_decode_map
);
12432 mark_object (kb
->Vlocal_function_key_map
);
12433 mark_object (kb
->Vdefault_minibuffer_frame
);
12434 mark_object (kb
->echo_string
);
12437 struct input_event
*event
;
12438 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12440 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12441 event
= kbd_buffer
;
12442 if (event
->kind
!= SELECTION_REQUEST_EVENT
12443 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12445 mark_object (event
->x
);
12446 mark_object (event
->y
);
12448 mark_object (event
->frame_or_window
);
12449 mark_object (event
->arg
);
12454 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
12455 (do not change this comment) */