1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995, 1996, 1997,
3 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
29 #include "termhooks.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
48 #ifdef HAVE_GTK_AND_PTHREAD
56 #include <sys/ioctl.h>
58 #endif /* not MSDOS */
60 #include "syssignal.h"
62 #include <sys/types.h>
71 /* This is to get the definitions of the XK_ symbols. */
78 #endif /* HAVE_NTGUI */
88 /* Variables for blockinput.h: */
90 /* Non-zero if interrupt input is blocked right now. */
91 int interrupt_input_blocked
;
93 /* Nonzero means an input interrupt has arrived
94 during the current critical section. */
95 int interrupt_input_pending
;
98 #ifdef HAVE_WINDOW_SYSTEM
99 /* Make all keyboard buffers much bigger when using X windows. */
101 /* But not too big (local data > 32K error) if on Mac OS Classic. */
102 #define KBD_BUFFER_SIZE 512
104 #define KBD_BUFFER_SIZE 4096
106 #else /* No X-windows, character input */
107 #define KBD_BUFFER_SIZE 4096
108 #endif /* No X-windows */
110 #define abs(x) ((x) >= 0 ? (x) : -(x))
112 /* Following definition copied from eval.c */
116 struct backtrace
*next
;
117 Lisp_Object
*function
;
118 Lisp_Object
*args
; /* Points to vector of args. */
119 int nargs
; /* length of vector. If nargs is UNEVALLED,
120 args points to slot holding list of
123 /* Nonzero means call value of debugger when done with this operation. */
128 KBOARD
*initial_kboard
;
129 KBOARD
*current_kboard
;
133 KBOARD the_only_kboard
;
136 /* Non-nil disable property on a command means
137 do not execute it; call disabled-command-function's value instead. */
138 Lisp_Object Qdisabled
, Qdisabled_command_function
;
140 #define NUM_RECENT_KEYS (100)
141 int recent_keys_index
; /* Index for storing next element into recent_keys */
142 int total_keys
; /* Total number of elements stored into recent_keys */
143 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
145 /* Vector holding the key sequence that invoked the current command.
146 It is reused for each command, and it may be longer than the current
147 sequence; this_command_key_count indicates how many elements
148 actually mean something.
149 It's easier to staticpro a single Lisp_Object than an array. */
150 Lisp_Object this_command_keys
;
151 int this_command_key_count
;
153 /* 1 after calling Freset_this_command_lengths.
155 int this_command_key_count_reset
;
157 /* This vector is used as a buffer to record the events that were actually read
158 by read_key_sequence. */
159 Lisp_Object raw_keybuf
;
160 int raw_keybuf_count
;
162 #define GROW_RAW_KEYBUF \
163 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
165 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
167 new = Fmake_vector (make_number (newsize), Qnil); \
168 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
169 raw_keybuf_count * sizeof (Lisp_Object)); \
173 /* Number of elements of this_command_keys
174 that precede this key sequence. */
175 int this_single_command_key_start
;
177 /* Record values of this_command_key_count and echo_length ()
178 before this command was read. */
179 static int before_command_key_count
;
180 static int before_command_echo_length
;
182 extern int minbuf_level
;
184 extern int message_enable_multibyte
;
186 extern struct backtrace
*backtrace_list
;
188 /* If non-nil, the function that implements the display of help.
189 It's called with one argument, the help string to display. */
191 Lisp_Object Vshow_help_function
;
193 /* If a string, the message displayed before displaying a help-echo
196 Lisp_Object Vpre_help_message
;
198 /* Nonzero means do menu prompting. */
200 static int menu_prompting
;
202 /* Character to see next line of menu prompt. */
204 static Lisp_Object menu_prompt_more_char
;
206 /* For longjmp to where kbd input is being done. */
208 static jmp_buf getcjmp
;
210 /* True while doing kbd input. */
211 int waiting_for_input
;
213 /* True while displaying for echoing. Delays C-g throwing. */
217 /* Non-null means we can start echoing at the next input pause even
218 though there is something in the echo area. */
220 static struct kboard
*ok_to_echo_at_next_pause
;
222 /* The kboard last echoing, or null for none. Reset to 0 in
223 cancel_echoing. If non-null, and a current echo area message
224 exists, and echo_message_buffer is eq to the current message
225 buffer, we know that the message comes from echo_kboard. */
227 struct kboard
*echo_kboard
;
229 /* The buffer used for echoing. Set in echo_now, reset in
232 Lisp_Object echo_message_buffer
;
234 /* Nonzero means disregard local maps for the menu bar. */
235 static int inhibit_local_menu_bar_menus
;
237 /* Nonzero means C-g should cause immediate error-signal. */
240 /* The user's ERASE setting. */
241 Lisp_Object Vtty_erase_char
;
243 /* Character to recognize as the help char. */
244 Lisp_Object Vhelp_char
;
246 /* List of other event types to recognize as meaning "help". */
247 Lisp_Object Vhelp_event_list
;
249 /* Form to execute when help char is typed. */
250 Lisp_Object Vhelp_form
;
252 /* Command to run when the help character follows a prefix key. */
253 Lisp_Object Vprefix_help_command
;
255 /* List of items that should move to the end of the menu bar. */
256 Lisp_Object Vmenu_bar_final_items
;
258 /* Non-nil means show the equivalent key-binding for
259 any M-x command that has one.
260 The value can be a length of time to show the message for.
261 If the value is non-nil and not a number, we wait 2 seconds. */
262 Lisp_Object Vsuggest_key_bindings
;
264 /* How long to display an echo-area message when the minibuffer is active.
265 If the value is not a number, such messages don't time out. */
266 Lisp_Object Vminibuffer_message_timeout
;
268 /* Character that causes a quit. Normally C-g.
270 If we are running on an ordinary terminal, this must be an ordinary
271 ASCII char, since we want to make it our interrupt character.
273 If we are not running on an ordinary terminal, it still needs to be
274 an ordinary ASCII char. This character needs to be recognized in
275 the input interrupt handler. At this point, the keystroke is
276 represented as a struct input_event, while the desired quit
277 character is specified as a lispy event. The mapping from struct
278 input_events to lispy events cannot run in an interrupt handler,
279 and the reverse mapping is difficult for anything but ASCII
282 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
286 extern Lisp_Object current_global_map
;
287 extern int minibuf_level
;
289 /* If non-nil, this is a map that overrides all other local maps. */
290 Lisp_Object Voverriding_local_map
;
292 /* If non-nil, Voverriding_local_map applies to the menu bar. */
293 Lisp_Object Voverriding_local_map_menu_flag
;
295 /* Keymap that defines special misc events that should
296 be processed immediately at a low level. */
297 Lisp_Object Vspecial_event_map
;
299 /* Current depth in recursive edits. */
300 int command_loop_level
;
302 /* Total number of times command_loop has read a key sequence. */
303 EMACS_INT num_input_keys
;
305 /* Last input character read as a command. */
306 Lisp_Object last_command_char
;
308 /* Last input character read as a command, not counting menus
309 reached by the mouse. */
310 Lisp_Object last_nonmenu_event
;
312 /* Last input character read for any purpose. */
313 Lisp_Object last_input_char
;
315 /* If not Qnil, a list of objects to be read as subsequent command input. */
316 Lisp_Object Vunread_command_events
;
318 /* If not Qnil, a list of objects to be read as subsequent command input
319 including input method processing. */
320 Lisp_Object Vunread_input_method_events
;
322 /* If not Qnil, a list of objects to be read as subsequent command input
323 but NOT including input method processing. */
324 Lisp_Object Vunread_post_input_method_events
;
326 /* If not -1, an event to be read as subsequent command input. */
327 EMACS_INT unread_command_char
;
329 /* If not Qnil, this is a switch-frame event which we decided to put
330 off until the end of a key sequence. This should be read as the
331 next command input, after any unread_command_events.
333 read_key_sequence uses this to delay switch-frame events until the
334 end of the key sequence; Fread_char uses it to put off switch-frame
335 events until a non-ASCII event is acceptable as input. */
336 Lisp_Object unread_switch_frame
;
338 /* A mask of extra modifier bits to put into every keyboard char. */
339 EMACS_INT extra_keyboard_modifiers
;
341 /* Char to use as prefix when a meta character is typed in.
342 This is bound on entry to minibuffer in case ESC is changed there. */
344 Lisp_Object meta_prefix_char
;
346 /* Last size recorded for a current buffer which is not a minibuffer. */
347 static int last_non_minibuf_size
;
349 /* Number of idle seconds before an auto-save and garbage collection. */
350 static Lisp_Object Vauto_save_timeout
;
352 /* Total number of times read_char has returned. */
353 int num_input_events
;
355 /* Total number of times read_char has returned, outside of macros. */
356 EMACS_INT num_nonmacro_input_events
;
358 /* Auto-save automatically when this many characters have been typed
359 since the last time. */
361 static EMACS_INT auto_save_interval
;
363 /* Value of num_nonmacro_input_events as of last auto save. */
367 /* The command being executed by the command loop.
368 Commands may set this, and the value set will be copied into
369 current_kboard->Vlast_command instead of the actual command. */
370 Lisp_Object Vthis_command
;
372 /* This is like Vthis_command, except that commands never set it. */
373 Lisp_Object real_this_command
;
375 /* If the lookup of the command returns a binding, the original
376 command is stored in this-original-command. It is nil otherwise. */
377 Lisp_Object Vthis_original_command
;
379 /* The value of point when the last command was executed. */
380 int last_point_position
;
382 /* The buffer that was current when the last command was started. */
383 Lisp_Object last_point_position_buffer
;
385 /* The frame in which the last input event occurred, or Qmacro if the
386 last event came from a macro. We use this to determine when to
387 generate switch-frame events. This may be cleared by functions
388 like Fselect_frame, to make sure that a switch-frame event is
389 generated by the next character. */
390 Lisp_Object internal_last_event_frame
;
392 /* A user-visible version of the above, intended to allow users to
393 figure out where the last event came from, if the event doesn't
394 carry that information itself (i.e. if it was a character). */
395 Lisp_Object Vlast_event_frame
;
397 /* The timestamp of the last input event we received from the X server.
398 X Windows wants this for selection ownership. */
399 unsigned long last_event_timestamp
;
401 Lisp_Object Qself_insert_command
;
402 Lisp_Object Qforward_char
;
403 Lisp_Object Qbackward_char
;
404 Lisp_Object Qundefined
;
405 Lisp_Object Qtimer_event_handler
;
407 /* read_key_sequence stores here the command definition of the
408 key sequence that it reads. */
409 Lisp_Object read_key_sequence_cmd
;
411 /* Echo unfinished commands after this many seconds of pause. */
412 Lisp_Object Vecho_keystrokes
;
414 /* Form to evaluate (if non-nil) when Emacs is started. */
415 Lisp_Object Vtop_level
;
417 /* User-supplied table to translate input characters. */
418 Lisp_Object Vkeyboard_translate_table
;
420 /* If non-nil, this implements the current input method. */
421 Lisp_Object Vinput_method_function
;
422 Lisp_Object Qinput_method_function
;
424 /* When we call Vinput_method_function,
425 this holds the echo area message that was just erased. */
426 Lisp_Object Vinput_method_previous_message
;
428 /* Non-nil means deactivate the mark at end of this command. */
429 Lisp_Object Vdeactivate_mark
;
431 /* Menu bar specified in Lucid Emacs fashion. */
433 Lisp_Object Vlucid_menu_bar_dirty_flag
;
434 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
436 Lisp_Object Qecho_area_clear_hook
;
438 /* Hooks to run before and after each command. */
439 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
440 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
441 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
443 /* Parent keymap of terminal-local function-key-map instances. */
444 Lisp_Object Vfunction_key_map
;
446 /* Parent keymap of terminal-local key-translation-map instances. */
447 Lisp_Object Vkey_translation_map
;
449 /* List of deferred actions to be performed at a later time.
450 The precise format isn't relevant here; we just check whether it is nil. */
451 Lisp_Object Vdeferred_action_list
;
453 /* Function to call to handle deferred actions, when there are any. */
454 Lisp_Object Vdeferred_action_function
;
455 Lisp_Object Qdeferred_action_function
;
457 Lisp_Object Qinput_method_exit_on_first_char
;
458 Lisp_Object Qinput_method_use_echo_area
;
460 /* File in which we write all commands we read. */
463 /* Nonzero if input is available. */
466 /* Non-zero means force key bindings update in parse_menu_item. */
468 int update_menu_bindings
;
470 extern char *pending_malloc_warning
;
472 /* Circular buffer for pre-read keyboard input. */
474 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
476 /* Pointer to next available character in kbd_buffer.
477 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
478 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
479 next available char is in kbd_buffer[0]. */
480 static struct input_event
*kbd_fetch_ptr
;
482 /* Pointer to next place to store character in kbd_buffer. This
483 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
484 character should go in kbd_buffer[0]. */
485 static struct input_event
* volatile kbd_store_ptr
;
487 /* The above pair of variables forms a "queue empty" flag. When we
488 enqueue a non-hook event, we increment kbd_store_ptr. When we
489 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
490 there is input available iff the two pointers are not equal.
492 Why not just have a flag set and cleared by the enqueuing and
493 dequeuing functions? Such a flag could be screwed up by interrupts
494 at inopportune times. */
496 /* If this flag is non-nil, we check mouse_moved to see when the
497 mouse moves, and motion events will appear in the input stream.
498 Otherwise, mouse motion is ignored. */
499 Lisp_Object do_mouse_tracking
;
501 /* Symbols to head events. */
502 Lisp_Object Qmouse_movement
;
503 Lisp_Object Qscroll_bar_movement
;
504 Lisp_Object Qswitch_frame
;
505 Lisp_Object Qdelete_frame
;
506 Lisp_Object Qiconify_frame
;
507 Lisp_Object Qmake_frame_visible
;
508 Lisp_Object Qselect_window
;
509 Lisp_Object Qhelp_echo
;
512 Lisp_Object Qmouse_fixup_help_message
;
515 /* Symbols to denote kinds of events. */
516 Lisp_Object Qfunction_key
;
517 Lisp_Object Qmouse_click
;
518 #if defined (WINDOWSNT) || defined (MAC_OS)
519 Lisp_Object Qlanguage_change
;
521 Lisp_Object Qdrag_n_drop
;
522 Lisp_Object Qsave_session
;
524 /* Lisp_Object Qmouse_movement; - also an event header */
526 /* Properties of event headers. */
527 Lisp_Object Qevent_kind
;
528 Lisp_Object Qevent_symbol_elements
;
530 /* menu item parts */
531 Lisp_Object Qmenu_alias
;
532 Lisp_Object Qmenu_enable
;
533 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
534 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
535 extern Lisp_Object Vdefine_key_rebound_commands
;
536 extern Lisp_Object Qmenu_item
;
538 /* An event header symbol HEAD may have a property named
539 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
540 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
541 mask of modifiers applied to it. If present, this is used to help
542 speed up parse_modifiers. */
543 Lisp_Object Qevent_symbol_element_mask
;
545 /* An unmodified event header BASE may have a property named
546 Qmodifier_cache, which is an alist mapping modifier masks onto
547 modified versions of BASE. If present, this helps speed up
549 Lisp_Object Qmodifier_cache
;
551 /* Symbols to use for parts of windows. */
552 Lisp_Object Qmode_line
;
553 Lisp_Object Qvertical_line
;
554 Lisp_Object Qvertical_scroll_bar
;
555 Lisp_Object Qmenu_bar
;
556 extern Lisp_Object Qleft_margin
, Qright_margin
;
557 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
558 extern Lisp_Object QCmap
;
560 Lisp_Object
recursive_edit_unwind (), command_loop ();
561 Lisp_Object
Fthis_command_keys ();
562 Lisp_Object Qextended_command_history
;
563 EMACS_TIME
timer_check ();
565 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
567 extern char *x_get_keysym_name ();
569 static void record_menu_key ();
570 static int echo_length ();
572 Lisp_Object Qpolling_period
;
574 /* List of absolute timers. Appears in order of next scheduled event. */
575 Lisp_Object Vtimer_list
;
577 /* List of idle time timers. Appears in order of next scheduled event. */
578 Lisp_Object Vtimer_idle_list
;
580 /* Incremented whenever a timer is run. */
583 extern Lisp_Object Vprint_level
, Vprint_length
;
585 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
587 EMACS_TIME
*input_available_clear_time
;
589 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
590 Default is 1 if INTERRUPT_INPUT is defined. */
593 /* Nonzero while interrupts are temporarily deferred during redisplay. */
594 int interrupts_deferred
;
596 /* Allow m- file to inhibit use of FIONREAD. */
597 #ifdef BROKEN_FIONREAD
601 /* We are unable to use interrupts if FIONREAD is not available,
602 so flush SIGIO so we won't try. */
603 #if !defined (FIONREAD)
609 /* If we support a window system, turn on the code to poll periodically
610 to detect C-g. It isn't actually used when doing interrupt input. */
611 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
612 #define POLL_FOR_INPUT
615 /* After a command is executed, if point is moved into a region that
616 has specific properties (e.g. composition, display), we adjust
617 point to the boundary of the region. But, if a command sets this
618 variable to non-nil, we suppress this point adjustment. This
619 variable is set to nil before reading a command. */
621 Lisp_Object Vdisable_point_adjustment
;
623 /* If non-nil, always disable point adjustment. */
625 Lisp_Object Vglobal_disable_point_adjustment
;
627 /* The time when Emacs started being idle. */
629 static EMACS_TIME timer_idleness_start_time
;
631 /* After Emacs stops being idle, this saves the last value
632 of timer_idleness_start_time from when it was idle. */
634 static EMACS_TIME timer_last_idleness_start_time
;
637 /* Global variable declarations. */
639 /* Flags for readable_events. */
640 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
641 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
642 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
644 /* Function for init_keyboard to call with no args (if nonzero). */
645 void (*keyboard_init_hook
) ();
647 static int read_avail_input
P_ ((int));
648 static void get_input_pending
P_ ((int *, int));
649 static int readable_events
P_ ((int));
650 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
651 Lisp_Object
, int *));
652 static Lisp_Object
read_char_x_menu_prompt ();
653 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
655 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
657 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
658 enum scroll_bar_part
,
659 Lisp_Object
, Lisp_Object
,
662 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
663 Lisp_Object
, char **,
664 Lisp_Object
*, unsigned));
665 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
666 static int parse_solitary_modifier
P_ ((Lisp_Object
));
667 static int parse_solitary_modifier ();
668 static void save_getcjmp
P_ ((jmp_buf));
669 static void save_getcjmp ();
670 static void restore_getcjmp
P_ ((jmp_buf));
671 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
672 static void clear_event
P_ ((struct input_event
*));
673 static void any_kboard_state
P_ ((void));
674 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
675 static void handle_interrupt
P_ ((void));
676 static void timer_start_idle
P_ ((void));
677 static void timer_stop_idle
P_ ((void));
678 static void timer_resume_idle
P_ ((void));
680 /* Nonzero means don't try to suspend even if the operating system seems
682 static int cannot_suspend
;
684 extern Lisp_Object Qidentity
, Qonly
;
686 /* Install the string STR as the beginning of the string of echoing,
687 so that it serves as a prompt for the next character.
688 Also start echoing. */
694 current_kboard
->echo_string
= str
;
695 current_kboard
->echo_after_prompt
= SCHARS (str
);
699 /* Add C to the echo string, if echoing is going on.
700 C can be a character, which is printed prettily ("M-C-x" and all that
701 jazz), or a symbol, whose name is printed. */
707 if (current_kboard
->immediate_echo
)
709 int size
= KEY_DESCRIPTION_SIZE
+ 100;
710 char *buffer
= (char *) alloca (size
);
712 Lisp_Object echo_string
;
714 echo_string
= current_kboard
->echo_string
;
716 /* If someone has passed us a composite event, use its head symbol. */
721 ptr
= push_key_description (XINT (c
), ptr
, 1);
723 else if (SYMBOLP (c
))
725 Lisp_Object name
= SYMBOL_NAME (c
);
726 int nbytes
= SBYTES (name
);
728 if (size
- (ptr
- buffer
) < nbytes
)
730 int offset
= ptr
- buffer
;
731 size
= max (2 * size
, size
+ nbytes
);
732 buffer
= (char *) alloca (size
);
733 ptr
= buffer
+ offset
;
736 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
737 STRING_MULTIBYTE (name
), 1);
740 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
743 const char *text
= " (Type ? for further options)";
744 int len
= strlen (text
);
746 if (size
- (ptr
- buffer
) < len
)
748 int offset
= ptr
- buffer
;
750 buffer
= (char *) alloca (size
);
751 ptr
= buffer
+ offset
;
754 bcopy (text
, ptr
, len
);
758 /* Replace a dash from echo_dash with a space, otherwise
759 add a space at the end as a separator between keys. */
760 if (STRINGP (echo_string
)
761 && SCHARS (echo_string
) > 1)
763 Lisp_Object last_char
, prev_char
, idx
;
765 idx
= make_number (SCHARS (echo_string
) - 2);
766 prev_char
= Faref (echo_string
, idx
);
768 idx
= make_number (SCHARS (echo_string
) - 1);
769 last_char
= Faref (echo_string
, idx
);
771 /* We test PREV_CHAR to make sure this isn't the echoing
773 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
774 Faset (echo_string
, idx
, make_number (' '));
776 echo_string
= concat2 (echo_string
, build_string (" "));
779 current_kboard
->echo_string
780 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
786 /* Temporarily add a dash to the end of the echo string if it's not
787 empty, so that it serves as a mini-prompt for the very next character. */
792 /* Do nothing if not echoing at all. */
793 if (NILP (current_kboard
->echo_string
))
796 if (!current_kboard
->immediate_echo
797 && SCHARS (current_kboard
->echo_string
) == 0)
800 /* Do nothing if we just printed a prompt. */
801 if (current_kboard
->echo_after_prompt
802 == SCHARS (current_kboard
->echo_string
))
805 /* Do nothing if we have already put a dash at the end. */
806 if (SCHARS (current_kboard
->echo_string
) > 1)
808 Lisp_Object last_char
, prev_char
, idx
;
810 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
811 prev_char
= Faref (current_kboard
->echo_string
, idx
);
813 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
814 last_char
= Faref (current_kboard
->echo_string
, idx
);
816 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
820 /* Put a dash at the end of the buffer temporarily,
821 but make it go away when the next character is added. */
822 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
827 /* Display the current echo string, and begin echoing if not already
833 if (!current_kboard
->immediate_echo
)
836 current_kboard
->immediate_echo
= 1;
838 for (i
= 0; i
< this_command_key_count
; i
++)
842 /* Set before_command_echo_length to the value that would
843 have been saved before the start of this subcommand in
844 command_loop_1, if we had already been echoing then. */
845 if (i
== this_single_command_key_start
)
846 before_command_echo_length
= echo_length ();
848 c
= XVECTOR (this_command_keys
)->contents
[i
];
849 if (! (EVENT_HAS_PARAMETERS (c
)
850 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
854 /* Set before_command_echo_length to the value that would
855 have been saved before the start of this subcommand in
856 command_loop_1, if we had already been echoing then. */
857 if (this_command_key_count
== this_single_command_key_start
)
858 before_command_echo_length
= echo_length ();
860 /* Put a dash at the end to invite the user to type more. */
865 message3_nolog (current_kboard
->echo_string
,
866 SBYTES (current_kboard
->echo_string
),
867 STRING_MULTIBYTE (current_kboard
->echo_string
));
870 /* Record in what buffer we echoed, and from which kboard. */
871 echo_message_buffer
= echo_area_buffer
[0];
872 echo_kboard
= current_kboard
;
874 if (waiting_for_input
&& !NILP (Vquit_flag
))
875 quit_throw_to_read_char ();
878 /* Turn off echoing, for the start of a new command. */
883 current_kboard
->immediate_echo
= 0;
884 current_kboard
->echo_after_prompt
= -1;
885 current_kboard
->echo_string
= Qnil
;
886 ok_to_echo_at_next_pause
= NULL
;
888 echo_message_buffer
= Qnil
;
891 /* Return the length of the current echo string. */
896 return (STRINGP (current_kboard
->echo_string
)
897 ? SCHARS (current_kboard
->echo_string
)
901 /* Truncate the current echo message to its first LEN chars.
902 This and echo_char get used by read_key_sequence when the user
903 switches frames while entering a key sequence. */
906 echo_truncate (nchars
)
909 if (STRINGP (current_kboard
->echo_string
))
910 current_kboard
->echo_string
911 = Fsubstring (current_kboard
->echo_string
,
912 make_number (0), make_number (nchars
));
913 truncate_echo_area (nchars
);
917 /* Functions for manipulating this_command_keys. */
919 add_command_key (key
)
922 #if 0 /* Not needed after we made Freset_this_command_lengths
923 do the job immediately. */
924 /* If reset-this-command-length was called recently, obey it now.
925 See the doc string of that function for an explanation of why. */
926 if (before_command_restore_flag
)
928 this_command_key_count
= before_command_key_count_1
;
929 if (this_command_key_count
< this_single_command_key_start
)
930 this_single_command_key_start
= this_command_key_count
;
931 echo_truncate (before_command_echo_length_1
);
932 before_command_restore_flag
= 0;
936 if (this_command_key_count
>= ASIZE (this_command_keys
))
937 this_command_keys
= larger_vector (this_command_keys
,
938 2 * ASIZE (this_command_keys
),
941 AREF (this_command_keys
, this_command_key_count
) = key
;
942 ++this_command_key_count
;
949 int count
= SPECPDL_INDEX ();
952 if (command_loop_level
> 0)
954 specbind (Qstandard_output
, Qt
);
955 specbind (Qstandard_input
, Qt
);
958 #ifdef HAVE_X_WINDOWS
959 /* The command loop has started an hourglass timer, so we have to
960 cancel it here, otherwise it will fire because the recursive edit
961 can take some time. Do not check for display_hourglass_p here,
962 because it could already be nil. */
966 /* This function may have been called from a debugger called from
967 within redisplay, for instance by Edebugging a function called
968 from fontification-functions. We want to allow redisplay in
969 the debugging session.
971 The recursive edit is left with a `(throw exit ...)'. The `exit'
972 tag is not caught anywhere in redisplay, i.e. when we leave the
973 recursive edit, the original redisplay leading to the recursive
974 edit will be unwound. The outcome should therefore be safe. */
975 specbind (Qinhibit_redisplay
, Qnil
);
978 val
= command_loop ();
980 Fsignal (Qquit
, Qnil
);
981 /* Handle throw from read_minibuf when using minibuffer
982 while it's active but we're in another window. */
984 Fsignal (Qerror
, Fcons (val
, Qnil
));
986 return unbind_to (count
, Qnil
);
989 /* When an auto-save happens, record the "time", and don't do again soon. */
994 last_auto_save
= num_nonmacro_input_events
;
997 /* Make an auto save happen as soon as possible at command level. */
1000 force_auto_save_soon ()
1002 last_auto_save
= - auto_save_interval
- 1;
1004 record_asynch_buffer_change ();
1007 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1008 doc
: /* Invoke the editor command loop recursively.
1009 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1010 that tells this function to return.
1011 Alternatively, `(throw 'exit t)' makes this function signal an error.
1012 This function is called by the editor initialization to begin editing. */)
1015 int count
= SPECPDL_INDEX ();
1018 /* If we enter while input is blocked, don't lock up here.
1019 This may happen through the debugger during redisplay. */
1020 if (INPUT_BLOCKED_P
)
1023 command_loop_level
++;
1024 update_mode_lines
= 1;
1026 if (command_loop_level
1027 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1028 buffer
= Fcurrent_buffer ();
1032 /* If we leave recursive_edit_1 below with a `throw' for instance,
1033 like it is done in the splash screen display, we have to
1034 make sure that we restore single_kboard as command_loop_1
1035 would have done if it were left normally. */
1036 record_unwind_protect (recursive_edit_unwind
,
1037 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1039 recursive_edit_1 ();
1040 return unbind_to (count
, Qnil
);
1044 recursive_edit_unwind (info
)
1047 if (BUFFERP (XCAR (info
)))
1048 Fset_buffer (XCAR (info
));
1050 if (NILP (XCDR (info
)))
1051 any_kboard_state ();
1053 single_kboard_state ();
1055 command_loop_level
--;
1056 update_mode_lines
= 1;
1065 #if 0 /* Theory: if there's anything in Vunread_command_events,
1066 it will right away be read by read_key_sequence,
1067 and then if we do switch KBOARDS, it will go into the side
1068 queue then. So we don't need to do anything special here -- rms. */
1069 if (CONSP (Vunread_command_events
))
1071 current_kboard
->kbd_queue
1072 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1073 current_kboard
->kbd_queue_has_data
= 1;
1075 Vunread_command_events
= Qnil
;
1081 /* Switch to the single-kboard state, making current_kboard
1082 the only KBOARD from which further input is accepted. */
1085 single_kboard_state ()
1092 /* If we're in single_kboard state for kboard KBOARD,
1096 not_single_kboard_state (kboard
)
1100 if (kboard
== current_kboard
)
1105 /* Maintain a stack of kboards, so other parts of Emacs
1106 can switch temporarily to the kboard of a given frame
1107 and then revert to the previous status. */
1112 struct kboard_stack
*next
;
1115 static struct kboard_stack
*kboard_stack
;
1118 push_device_kboard (d
)
1122 struct kboard_stack
*p
1123 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1125 p
->next
= kboard_stack
;
1126 p
->kboard
= current_kboard
;
1129 current_kboard
= d
->kboard
;
1134 push_frame_kboard (f
)
1138 struct kboard_stack
*p
1139 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1141 p
->next
= kboard_stack
;
1142 p
->kboard
= current_kboard
;
1145 current_kboard
= FRAME_KBOARD (f
);
1153 struct kboard_stack
*p
= kboard_stack
;
1154 current_kboard
= p
->kboard
;
1155 kboard_stack
= p
->next
;
1160 /* Handle errors that are not handled at inner levels
1161 by printing an error message and returning to the editor command loop. */
1167 Lisp_Object old_level
, old_length
;
1168 char macroerror
[50];
1170 #ifdef HAVE_X_WINDOWS
1171 if (display_hourglass_p
)
1172 cancel_hourglass ();
1175 if (!NILP (executing_kbd_macro
))
1177 if (executing_kbd_macro_iterations
== 1)
1178 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1180 sprintf (macroerror
, "After %d kbd macro iterations: ",
1181 executing_kbd_macro_iterations
);
1186 Vstandard_output
= Qt
;
1187 Vstandard_input
= Qt
;
1188 Vexecuting_kbd_macro
= Qnil
;
1189 executing_kbd_macro
= Qnil
;
1190 current_kboard
->Vprefix_arg
= Qnil
;
1191 current_kboard
->Vlast_prefix_arg
= Qnil
;
1194 /* Avoid unquittable loop if data contains a circular list. */
1195 old_level
= Vprint_level
;
1196 old_length
= Vprint_length
;
1197 XSETFASTINT (Vprint_level
, 10);
1198 XSETFASTINT (Vprint_length
, 10);
1199 cmd_error_internal (data
, macroerror
);
1200 Vprint_level
= old_level
;
1201 Vprint_length
= old_length
;
1205 Vinhibit_quit
= Qnil
;
1207 if (command_loop_level
== 0 && minibuf_level
== 0)
1208 any_kboard_state ();
1211 return make_number (0);
1214 /* Take actions on handling an error. DATA is the data that describes
1217 CONTEXT is a C-string containing ASCII characters only which
1218 describes the context in which the error happened. If we need to
1219 generalize CONTEXT to allow multibyte characters, make it a Lisp
1223 cmd_error_internal (data
, context
)
1228 int kill_emacs_p
= 0;
1229 struct frame
*sf
= SELECTED_FRAME ();
1233 clear_message (1, 0);
1235 /* If the window system or terminal frame hasn't been initialized
1236 yet, or we're not interactive, it's best to dump this message out
1237 to stderr and exit. */
1238 if (!sf
->glyphs_initialized_p
1239 || FRAME_INITIAL_P (sf
)
1242 stream
= Qexternal_debugging_output
;
1248 message_log_maybe_newline ();
1253 /* The immediate context is not interesting for Quits,
1254 since they are asyncronous. */
1255 if (EQ (XCAR (data
), Qquit
))
1256 Vsignaling_function
= Qnil
;
1258 print_error_message (data
, stream
, context
, Vsignaling_function
);
1260 Vsignaling_function
= Qnil
;
1262 /* If the window system or terminal frame hasn't been initialized
1263 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1267 Fkill_emacs (make_number (-1));
1271 Lisp_Object
command_loop_1 ();
1272 Lisp_Object
command_loop_2 ();
1273 Lisp_Object
top_level_1 ();
1275 /* Entry to editor-command-loop.
1276 This level has the catches for exiting/returning to editor command loop.
1277 It returns nil to exit recursive edit, t to abort it. */
1282 if (command_loop_level
> 0 || minibuf_level
> 0)
1285 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1286 executing_kbd_macro
= Qnil
;
1292 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1293 /* Reset single_kboard in case top-level set it while
1294 evaluating an -f option, or we are stuck there for some
1296 any_kboard_state ();
1297 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1298 executing_kbd_macro
= Qnil
;
1300 /* End of file in -batch run causes exit here. */
1306 /* Here we catch errors in execution of commands within the
1307 editing loop, and reenter the editing loop.
1308 When there is an error, cmd_error runs and returns a non-nil
1309 value to us. A value of nil means that command_loop_1 itself
1310 returned due to end of file (or end of kbd macro). */
1315 register Lisp_Object val
;
1318 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1319 while (!NILP (val
));
1327 return Feval (Vtop_level
);
1333 /* On entry to the outer level, run the startup file */
1334 if (!NILP (Vtop_level
))
1335 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1336 else if (!NILP (Vpurify_flag
))
1337 message ("Bare impure Emacs (standard Lisp code not loaded)");
1339 message ("Bare Emacs (standard Lisp code not loaded)");
1343 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1344 doc
: /* Exit all recursive editing levels. */)
1347 #ifdef HAVE_X_WINDOWS
1348 if (display_hourglass_p
)
1349 cancel_hourglass ();
1352 /* Unblock input if we enter with input blocked. This may happen if
1353 redisplay traps e.g. during tool-bar update with input blocked. */
1354 while (INPUT_BLOCKED_P
)
1357 return Fthrow (Qtop_level
, Qnil
);
1360 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1361 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1364 if (command_loop_level
> 0 || minibuf_level
> 0)
1365 Fthrow (Qexit
, Qnil
);
1367 error ("No recursive edit is in progress");
1371 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1372 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1375 if (command_loop_level
> 0 || minibuf_level
> 0)
1378 error ("No recursive edit is in progress");
1382 /* This is the actual command reading loop,
1383 sans error-handling encapsulation. */
1385 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1387 void safe_run_hooks
P_ ((Lisp_Object
));
1388 static void adjust_point_for_property
P_ ((int, int));
1390 /* Cancel hourglass from protect_unwind.
1392 #ifdef HAVE_X_WINDOWS
1394 cancel_hourglass_unwind (arg
)
1397 cancel_hourglass ();
1408 Lisp_Object keybuf
[30];
1411 int prev_modiff
= 0;
1412 struct buffer
*prev_buffer
= NULL
;
1414 int was_locked
= single_kboard
;
1416 int already_adjusted
= 0;
1418 current_kboard
->Vprefix_arg
= Qnil
;
1419 current_kboard
->Vlast_prefix_arg
= Qnil
;
1420 Vdeactivate_mark
= Qnil
;
1421 waiting_for_input
= 0;
1425 this_command_key_count
= 0;
1426 this_command_key_count_reset
= 0;
1427 this_single_command_key_start
= 0;
1429 if (NILP (Vmemory_full
))
1431 /* Make sure this hook runs after commands that get errors and
1432 throw to top level. */
1433 /* Note that the value cell will never directly contain nil
1434 if the symbol is a local variable. */
1435 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1436 safe_run_hooks (Qpost_command_hook
);
1438 /* If displaying a message, resize the echo area window to fit
1439 that message's size exactly. */
1440 if (!NILP (echo_area_buffer
[0]))
1441 resize_echo_area_exactly ();
1443 if (!NILP (Vdeferred_action_list
))
1444 safe_run_hooks (Qdeferred_action_function
);
1447 Vmemory_full
= Qnil
;
1449 /* Do this after running Vpost_command_hook, for consistency. */
1450 current_kboard
->Vlast_command
= Vthis_command
;
1451 current_kboard
->Vreal_last_command
= real_this_command
;
1455 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1458 /* Make sure the current window's buffer is selected. */
1459 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1460 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1462 /* Display any malloc warning that just came out. Use while because
1463 displaying one warning can cause another. */
1465 while (pending_malloc_warning
)
1466 display_malloc_warning ();
1470 Vdeactivate_mark
= Qnil
;
1472 /* If minibuffer on and echo area in use,
1473 wait a short time and redraw minibuffer. */
1476 && !NILP (echo_area_buffer
[0])
1477 && EQ (minibuf_window
, echo_area_window
)
1478 && NUMBERP (Vminibuffer_message_timeout
))
1480 /* Bind inhibit-quit to t so that C-g gets read in
1481 rather than quitting back to the minibuffer. */
1482 int count
= SPECPDL_INDEX ();
1483 specbind (Qinhibit_quit
, Qt
);
1485 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1486 /* Clear the echo area. */
1488 safe_run_hooks (Qecho_area_clear_hook
);
1490 unbind_to (count
, Qnil
);
1492 /* If a C-g came in before, treat it as input now. */
1493 if (!NILP (Vquit_flag
))
1496 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1501 alloca (0); /* Cause a garbage collection now */
1502 /* Since we can free the most stuff here. */
1503 #endif /* C_ALLOCA */
1506 /* Select the frame that the last event came from. Usually,
1507 switch-frame events will take care of this, but if some lisp
1508 code swallows a switch-frame event, we'll fix things up here.
1509 Is this a good idea? */
1510 if (FRAMEP (internal_last_event_frame
)
1511 && !EQ (internal_last_event_frame
, selected_frame
))
1512 Fselect_frame (internal_last_event_frame
);
1514 /* If it has changed current-menubar from previous value,
1515 really recompute the menubar from the value. */
1516 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1517 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1518 call0 (Qrecompute_lucid_menubar
);
1520 before_command_key_count
= this_command_key_count
;
1521 before_command_echo_length
= echo_length ();
1523 Vthis_command
= Qnil
;
1524 real_this_command
= Qnil
;
1525 Vthis_original_command
= Qnil
;
1527 /* Read next key sequence; i gets its length. */
1528 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1531 /* A filter may have run while we were reading the input. */
1532 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1534 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1535 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1539 /* Now we have read a key sequence of length I,
1540 or else I is 0 and we found end of file. */
1542 if (i
== 0) /* End of file -- happens only in */
1543 return Qnil
; /* a kbd macro, at the end. */
1544 /* -1 means read_key_sequence got a menu that was rejected.
1545 Just loop around and read another command. */
1549 this_command_key_count
= 0;
1550 this_command_key_count_reset
= 0;
1551 this_single_command_key_start
= 0;
1555 last_command_char
= keybuf
[i
- 1];
1557 /* If the previous command tried to force a specific window-start,
1558 forget about that, in case this command moves point far away
1559 from that position. But also throw away beg_unchanged and
1560 end_unchanged information in that case, so that redisplay will
1561 update the whole window properly. */
1562 if (!NILP (XWINDOW (selected_window
)->force_start
))
1565 XWINDOW (selected_window
)->force_start
= Qnil
;
1566 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1567 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1570 cmd
= read_key_sequence_cmd
;
1571 if (!NILP (Vexecuting_kbd_macro
))
1573 if (!NILP (Vquit_flag
))
1575 Vexecuting_kbd_macro
= Qt
;
1576 QUIT
; /* Make some noise. */
1577 /* Will return since macro now empty. */
1581 /* Do redisplay processing after this command except in special
1582 cases identified below. */
1583 prev_buffer
= current_buffer
;
1584 prev_modiff
= MODIFF
;
1585 last_point_position
= PT
;
1586 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1588 /* By default, we adjust point to a boundary of a region that
1589 has such a property that should be treated intangible
1590 (e.g. composition, display). But, some commands will set
1591 this variable differently. */
1592 Vdisable_point_adjustment
= Qnil
;
1594 /* Process filters and timers may have messed with deactivate-mark.
1595 reset it before we execute the command. */
1596 Vdeactivate_mark
= Qnil
;
1598 /* Remap command through active keymaps */
1599 Vthis_original_command
= cmd
;
1603 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1607 /* Execute the command. */
1609 Vthis_command
= cmd
;
1610 real_this_command
= cmd
;
1611 /* Note that the value cell will never directly contain nil
1612 if the symbol is a local variable. */
1613 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1614 safe_run_hooks (Qpre_command_hook
);
1616 already_adjusted
= 0;
1618 if (NILP (Vthis_command
))
1620 /* nil means key is undefined. */
1621 Lisp_Object keys
= Fvector (i
, keybuf
);
1622 keys
= Fkey_description (keys
, Qnil
);
1624 message_with_string ("%s is undefined", keys
, 0);
1625 current_kboard
->defining_kbd_macro
= Qnil
;
1626 update_mode_lines
= 1;
1627 current_kboard
->Vprefix_arg
= Qnil
;
1631 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1633 /* In case we jump to directly_done. */
1634 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1636 /* Recognize some common commands in common situations and
1637 do them directly. */
1638 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1640 struct Lisp_Char_Table
*dp
1641 = window_display_table (XWINDOW (selected_window
));
1642 lose
= FETCH_CHAR (PT_BYTE
);
1644 if (! NILP (Vpost_command_hook
))
1645 /* Put this before calling adjust_point_for_property
1646 so it will only get called once in any case. */
1648 if (current_buffer
== prev_buffer
1649 && last_point_position
!= PT
1650 && NILP (Vdisable_point_adjustment
)
1651 && NILP (Vglobal_disable_point_adjustment
))
1652 adjust_point_for_property (last_point_position
, 0);
1653 already_adjusted
= 1;
1654 if (PT
== last_point_position
+ 1
1656 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1657 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1658 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1659 && (lose
>= 0x20 && lose
< 0x7f)))
1660 : (lose
>= 0x20 && lose
< 0x7f))
1661 /* To extract the case of continuation on
1662 wide-column characters. */
1663 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1664 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1666 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1668 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1670 && !windows_or_buffers_changed
1671 && EQ (current_buffer
->selective_display
, Qnil
)
1672 && !detect_input_pending ()
1673 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1674 && NILP (Vexecuting_kbd_macro
))
1675 direct_output_forward_char (1);
1678 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1680 struct Lisp_Char_Table
*dp
1681 = window_display_table (XWINDOW (selected_window
));
1683 lose
= FETCH_CHAR (PT_BYTE
);
1684 if (! NILP (Vpost_command_hook
))
1686 if (current_buffer
== prev_buffer
1687 && last_point_position
!= PT
1688 && NILP (Vdisable_point_adjustment
)
1689 && NILP (Vglobal_disable_point_adjustment
))
1690 adjust_point_for_property (last_point_position
, 0);
1691 already_adjusted
= 1;
1692 if (PT
== last_point_position
- 1
1694 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1695 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1696 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1697 && (lose
>= 0x20 && lose
< 0x7f)))
1698 : (lose
>= 0x20 && lose
< 0x7f))
1699 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1701 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1703 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1705 && !windows_or_buffers_changed
1706 && EQ (current_buffer
->selective_display
, Qnil
)
1707 && !detect_input_pending ()
1708 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1709 && NILP (Vexecuting_kbd_macro
))
1710 direct_output_forward_char (-1);
1713 else if (EQ (Vthis_command
, Qself_insert_command
)
1714 /* Try this optimization only on char keystrokes. */
1715 && NATNUMP (last_command_char
)
1716 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1719 = translate_char (Vtranslation_table_for_input
,
1720 XFASTINT (last_command_char
), 0, 0, 0);
1722 if (NILP (Vexecuting_kbd_macro
)
1723 && !EQ (minibuf_window
, selected_window
))
1725 if (!nonundocount
|| nonundocount
>= 20)
1733 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1735 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1737 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1739 || MODIFF
<= SAVE_MODIFF
1740 || windows_or_buffers_changed
1741 || !EQ (current_buffer
->selective_display
, Qnil
)
1742 || detect_input_pending ()
1743 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1744 || !NILP (Vexecuting_kbd_macro
));
1746 value
= internal_self_insert (c
, 0);
1751 if (! NILP (Vpost_command_hook
))
1752 /* Put this before calling adjust_point_for_property
1753 so it will only get called once in any case. */
1756 /* VALUE == 1 when AFTER-CHANGE functions are
1757 installed which is the case most of the time
1758 because FONT-LOCK installs one. */
1759 if (!lose
&& !value
)
1760 direct_output_for_insert (c
);
1765 /* Here for a command that isn't executed directly */
1768 #ifdef HAVE_X_WINDOWS
1769 int scount
= SPECPDL_INDEX ();
1771 if (display_hourglass_p
1772 && NILP (Vexecuting_kbd_macro
))
1774 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1780 if (NILP (current_kboard
->Vprefix_arg
))
1782 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1784 #ifdef HAVE_X_WINDOWS
1785 /* Do not check display_hourglass_p here, because
1786 Fcommand_execute could change it, but we should cancel
1787 hourglass cursor anyway.
1788 But don't cancel the hourglass within a macro
1789 just because a command in the macro finishes. */
1790 if (NILP (Vexecuting_kbd_macro
))
1791 unbind_to (scount
, Qnil
);
1796 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1798 /* Note that the value cell will never directly contain nil
1799 if the symbol is a local variable. */
1800 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1801 safe_run_hooks (Qpost_command_hook
);
1803 /* If displaying a message, resize the echo area window to fit
1804 that message's size exactly. */
1805 if (!NILP (echo_area_buffer
[0]))
1806 resize_echo_area_exactly ();
1808 if (!NILP (Vdeferred_action_list
))
1809 safe_run_hooks (Qdeferred_action_function
);
1811 /* If there is a prefix argument,
1812 1) We don't want Vlast_command to be ``universal-argument''
1813 (that would be dumb), so don't set Vlast_command,
1814 2) we want to leave echoing on so that the prefix will be
1815 echoed as part of this key sequence, so don't call
1817 3) we want to leave this_command_key_count non-zero, so that
1818 read_char will realize that it is re-reading a character, and
1819 not echo it a second time.
1821 If the command didn't actually create a prefix arg,
1822 but is merely a frame event that is transparent to prefix args,
1823 then the above doesn't apply. */
1824 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1826 current_kboard
->Vlast_command
= Vthis_command
;
1827 current_kboard
->Vreal_last_command
= real_this_command
;
1829 this_command_key_count
= 0;
1830 this_command_key_count_reset
= 0;
1831 this_single_command_key_start
= 0;
1834 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1836 /* Setting transient-mark-mode to `only' is a way of
1837 turning it on for just one command. */
1839 if (EQ (Vtransient_mark_mode
, Qidentity
))
1840 Vtransient_mark_mode
= Qnil
;
1841 if (EQ (Vtransient_mark_mode
, Qonly
))
1842 Vtransient_mark_mode
= Qidentity
;
1844 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1846 /* We could also call `deactivate'mark'. */
1847 if (EQ (Vtransient_mark_mode
, Qlambda
))
1848 Vtransient_mark_mode
= Qnil
;
1851 current_buffer
->mark_active
= Qnil
;
1852 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1855 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1856 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1861 if (current_buffer
== prev_buffer
1862 && last_point_position
!= PT
1863 && NILP (Vdisable_point_adjustment
)
1864 && NILP (Vglobal_disable_point_adjustment
)
1865 && !already_adjusted
)
1866 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1868 /* Install chars successfully executed in kbd macro. */
1870 if (!NILP (current_kboard
->defining_kbd_macro
)
1871 && NILP (current_kboard
->Vprefix_arg
))
1872 finalize_kbd_macro_chars ();
1876 any_kboard_state ();
1881 extern Lisp_Object Qcomposition
, Qdisplay
;
1883 /* Adjust point to a boundary of a region that has such a property
1884 that should be treated intangible. For the moment, we check
1885 `composition', `display' and `invisible' properties.
1886 LAST_PT is the last position of point. */
1888 extern Lisp_Object Qafter_string
, Qbefore_string
;
1889 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1892 adjust_point_for_property (last_pt
, modified
)
1897 Lisp_Object val
, overlay
, tmp
;
1898 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1901 /* FIXME: cycling is probably not necessary because these properties
1902 can't be usefully combined anyway. */
1903 while (check_composition
|| check_display
|| check_invisible
)
1905 if (check_composition
1906 && PT
> BEGV
&& PT
< ZV
1907 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1908 && COMPOSITION_VALID_P (beg
, end
, val
)
1909 && beg
< PT
/* && end > PT <- It's always the case. */
1910 && (last_pt
<= beg
|| last_pt
>= end
))
1913 SET_PT (PT
< last_pt
? beg
: end
);
1914 check_display
= check_invisible
= 1;
1916 check_composition
= 0;
1918 && PT
> BEGV
&& PT
< ZV
1919 && !NILP (val
= get_char_property_and_overlay
1920 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1921 && display_prop_intangible_p (val
)
1922 && (!OVERLAYP (overlay
)
1923 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1924 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1925 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1926 && (beg
< PT
/* && end > PT <- It's always the case. */
1927 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1930 SET_PT (PT
< last_pt
1931 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1933 check_composition
= check_invisible
= 1;
1936 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1938 int inv
, ellipsis
= 0;
1941 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1943 && !NILP (val
= get_char_property_and_overlay
1944 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1945 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1947 ellipsis
= ellipsis
|| inv
> 1
1948 || (OVERLAYP (overlay
)
1949 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1950 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1951 tmp
= Fnext_single_char_property_change
1952 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1953 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1956 && !NILP (val
= get_char_property_and_overlay
1957 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1958 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1960 ellipsis
= ellipsis
|| inv
> 1
1961 || (OVERLAYP (overlay
)
1962 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1963 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1964 tmp
= Fprevious_single_char_property_change
1965 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1966 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1969 /* Move away from the inside area. */
1970 if (beg
< PT
&& end
> PT
)
1972 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1973 /* We haven't moved yet (so we don't need to fear
1974 infinite-looping) and we were outside the range
1975 before (so either end of the range still corresponds
1976 to a move in the right direction): pretend we moved
1977 less than we actually did, so that we still have
1978 more freedom below in choosing which end of the range
1980 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1981 /* We either have moved already or the last point
1982 was already in the range: we don't get to choose
1983 which end of the range we have to go to. */
1984 : (PT
< last_pt
? beg
: end
));
1985 check_composition
= check_display
= 1;
1987 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1988 the point to something other than its argument, due to
1989 point-motion hooks, intangibility, etc. */
1990 xassert (PT
== beg
|| PT
== end
);
1993 /* Pretend the area doesn't exist if the buffer is not
1995 if (!modified
&& !ellipsis
&& beg
< end
)
1997 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1998 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1999 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2000 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2001 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2002 /* We've already moved as far as we can. Trying to go
2003 to the other end would mean moving backwards and thus
2004 could lead to an infinite loop. */
2006 else if (val
= get_pos_property (make_number (PT
),
2008 TEXT_PROP_MEANS_INVISIBLE (val
)
2009 && (val
= get_pos_property
2010 (make_number (PT
== beg
? end
: beg
),
2012 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2013 (check_composition
= check_display
= 1,
2014 SET_PT (PT
== beg
? end
: beg
));
2017 check_invisible
= 0;
2021 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2024 safe_run_hooks_1 (hook
)
2027 return call1 (Vrun_hooks
, Vinhibit_quit
);
2030 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2033 safe_run_hooks_error (data
)
2036 Lisp_Object args
[3];
2037 args
[0] = build_string ("Error in %s: %s");
2038 args
[1] = Vinhibit_quit
;
2041 return Fset (Vinhibit_quit
, Qnil
);
2044 /* If we get an error while running the hook, cause the hook variable
2045 to be nil. Also inhibit quits, so that C-g won't cause the hook
2046 to mysteriously evaporate. */
2049 safe_run_hooks (hook
)
2052 int count
= SPECPDL_INDEX ();
2053 specbind (Qinhibit_quit
, hook
);
2055 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2057 unbind_to (count
, Qnil
);
2061 /* Number of seconds between polling for input. This is a Lisp
2062 variable that can be bound. */
2064 EMACS_INT polling_period
;
2066 /* Nonzero means polling for input is temporarily suppressed. */
2068 int poll_suppress_count
;
2070 /* Asynchronous timer for polling. */
2072 struct atimer
*poll_timer
;
2075 #ifdef POLL_FOR_INPUT
2077 /* Poll for input, so what we catch a C-g if it comes in. This
2078 function is called from x_make_frame_visible, see comment
2084 if (interrupt_input_blocked
== 0
2085 && !waiting_for_input
)
2086 read_avail_input (0);
2089 /* Timer callback function for poll_timer. TIMER is equal to
2093 poll_for_input (timer
)
2094 struct atimer
*timer
;
2096 if (poll_suppress_count
== 0)
2098 interrupt_input_pending
= 1;
2100 poll_for_input_1 ();
2104 #endif /* POLL_FOR_INPUT */
2106 /* Begin signals to poll for input, if they are appropriate.
2107 This function is called unconditionally from various places. */
2112 #ifdef POLL_FOR_INPUT
2113 /* XXX This condition was (read_socket_hook && !interrupt_input),
2114 but read_socket_hook is not global anymore. Let's pretend that
2116 if (!interrupt_input
)
2118 /* Turn alarm handling on unconditionally. It might have
2119 been turned off in process.c. */
2120 turn_on_atimers (1);
2122 /* If poll timer doesn't exist, are we need one with
2123 a different interval, start a new one. */
2124 if (poll_timer
== NULL
2125 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2127 EMACS_TIME interval
;
2130 cancel_atimer (poll_timer
);
2132 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2133 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2134 poll_for_input
, NULL
);
2137 /* Let the timer's callback function poll for input
2138 if this becomes zero. */
2139 --poll_suppress_count
;
2144 /* Nonzero if we are using polling to handle input asynchronously. */
2147 input_polling_used ()
2149 #ifdef POLL_FOR_INPUT
2150 /* XXX This condition was (read_socket_hook && !interrupt_input),
2151 but read_socket_hook is not global anymore. Let's pretend that
2153 return !interrupt_input
;
2159 /* Turn off polling. */
2164 #ifdef POLL_FOR_INPUT
2165 /* XXX This condition was (read_socket_hook && !interrupt_input),
2166 but read_socket_hook is not global anymore. Let's pretend that
2168 if (!interrupt_input
)
2169 ++poll_suppress_count
;
2173 /* Set the value of poll_suppress_count to COUNT
2174 and start or stop polling accordingly. */
2177 set_poll_suppress_count (count
)
2180 #ifdef POLL_FOR_INPUT
2181 if (count
== 0 && poll_suppress_count
!= 0)
2183 poll_suppress_count
= 1;
2186 else if (count
!= 0 && poll_suppress_count
== 0)
2190 poll_suppress_count
= count
;
2194 /* Bind polling_period to a value at least N.
2195 But don't decrease it. */
2198 bind_polling_period (n
)
2201 #ifdef POLL_FOR_INPUT
2202 int new = polling_period
;
2207 stop_other_atimers (poll_timer
);
2209 specbind (Qpolling_period
, make_number (new));
2210 /* Start a new alarm with the new period. */
2215 /* Apply the control modifier to CHARACTER. */
2221 /* Save the upper bits here. */
2222 int upper
= c
& ~0177;
2226 /* Everything in the columns containing the upper-case letters
2227 denotes a control character. */
2228 if (c
>= 0100 && c
< 0140)
2232 /* Set the shift modifier for a control char
2233 made from a shifted letter. But only for letters! */
2234 if (oc
>= 'A' && oc
<= 'Z')
2235 c
|= shift_modifier
;
2238 /* The lower-case letters denote control characters too. */
2239 else if (c
>= 'a' && c
<= 'z')
2242 /* Include the bits for control and shift
2243 only if the basic ASCII code can't indicate them. */
2247 /* Replace the high bits. */
2248 c
|= (upper
& ~ctrl_modifier
);
2253 /* Display the help-echo property of the character after the mouse pointer.
2254 Either show it in the echo area, or call show-help-function to display
2255 it by other means (maybe in a tooltip).
2257 If HELP is nil, that means clear the previous help echo.
2259 If HELP is a string, display that string. If HELP is a function,
2260 call it with OBJECT and POS as arguments; the function should
2261 return a help string or nil for none. For all other types of HELP,
2262 evaluate it to obtain a string.
2264 WINDOW is the window in which the help was generated, if any.
2265 It is nil if not in a window.
2267 If OBJECT is a buffer, POS is the position in the buffer where the
2268 `help-echo' text property was found.
2270 If OBJECT is an overlay, that overlay has a `help-echo' property,
2271 and POS is the position in the overlay's buffer under the mouse.
2273 If OBJECT is a string (an overlay string or a string displayed with
2274 the `display' property). POS is the position in that string under
2277 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2278 echo overwrites a keystroke echo currently displayed in the echo
2281 Note: this function may only be called with HELP nil or a string
2282 from X code running asynchronously. */
2285 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2286 Lisp_Object help
, window
, object
, pos
;
2287 int ok_to_overwrite_keystroke_echo
;
2289 if (!NILP (help
) && !STRINGP (help
))
2291 if (FUNCTIONP (help
))
2293 Lisp_Object args
[4];
2298 help
= safe_call (4, args
);
2301 help
= safe_eval (help
);
2303 if (!STRINGP (help
))
2308 if (!noninteractive
&& STRINGP (help
))
2309 help
= call1 (Qmouse_fixup_help_message
, help
);
2312 if (STRINGP (help
) || NILP (help
))
2314 if (!NILP (Vshow_help_function
))
2315 call1 (Vshow_help_function
, help
);
2316 else if (/* Don't overwrite minibuffer contents. */
2317 !MINI_WINDOW_P (XWINDOW (selected_window
))
2318 /* Don't overwrite a keystroke echo. */
2319 && (NILP (echo_message_buffer
)
2320 || ok_to_overwrite_keystroke_echo
)
2321 /* Don't overwrite a prompt. */
2322 && !cursor_in_echo_area
)
2326 int count
= SPECPDL_INDEX ();
2328 if (!help_echo_showing_p
)
2329 Vpre_help_message
= current_message ();
2331 specbind (Qmessage_truncate_lines
, Qt
);
2332 message3_nolog (help
, SBYTES (help
),
2333 STRING_MULTIBYTE (help
));
2334 unbind_to (count
, Qnil
);
2336 else if (STRINGP (Vpre_help_message
))
2338 message3_nolog (Vpre_help_message
,
2339 SBYTES (Vpre_help_message
),
2340 STRING_MULTIBYTE (Vpre_help_message
));
2341 Vpre_help_message
= Qnil
;
2347 help_echo_showing_p
= STRINGP (help
);
2353 /* Input of single characters from keyboard */
2355 Lisp_Object
print_help ();
2356 static Lisp_Object
kbd_buffer_get_event ();
2357 static void record_char ();
2360 static jmp_buf wrong_kboard_jmpbuf
;
2363 #define STOP_POLLING \
2364 do { if (! polling_stopped_here) stop_polling (); \
2365 polling_stopped_here = 1; } while (0)
2367 #define RESUME_POLLING \
2368 do { if (polling_stopped_here) start_polling (); \
2369 polling_stopped_here = 0; } while (0)
2371 /* read a character from the keyboard; call the redisplay if needed */
2372 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2373 -1 means do not do redisplay, but do do autosaving.
2376 /* The arguments MAPS and NMAPS are for menu prompting.
2377 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2379 PREV_EVENT is the previous input event, or nil if we are reading
2380 the first event of a key sequence (or not reading a key sequence).
2381 If PREV_EVENT is t, that is a "magic" value that says
2382 not to run input methods, but in other respects to act as if
2383 not reading a key sequence.
2385 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2386 if we used a mouse menu to read the input, or zero otherwise. If
2387 USED_MOUSE_MENU is null, we don't dereference it.
2389 Value is t if we showed a menu and the user rejected it. */
2392 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2396 Lisp_Object prev_event
;
2397 int *used_mouse_menu
;
2399 volatile Lisp_Object c
;
2401 jmp_buf local_getcjmp
;
2403 volatile int key_already_recorded
= 0;
2404 Lisp_Object tem
, save
;
2405 volatile Lisp_Object previous_echo_area_message
;
2406 volatile Lisp_Object also_record
;
2407 volatile int reread
;
2408 struct gcpro gcpro1
, gcpro2
;
2409 int polling_stopped_here
= 0;
2413 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2414 before_command_key_count
= this_command_key_count
;
2415 before_command_echo_length
= echo_length ();
2418 previous_echo_area_message
= Qnil
;
2420 GCPRO2 (c
, previous_echo_area_message
);
2425 if (CONSP (Vunread_post_input_method_events
))
2427 c
= XCAR (Vunread_post_input_method_events
);
2428 Vunread_post_input_method_events
2429 = XCDR (Vunread_post_input_method_events
);
2431 /* Undo what read_char_x_menu_prompt did when it unread
2432 additional keys returned by Fx_popup_menu. */
2434 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2442 if (unread_command_char
!= -1)
2444 XSETINT (c
, unread_command_char
);
2445 unread_command_char
= -1;
2451 if (CONSP (Vunread_command_events
))
2453 c
= XCAR (Vunread_command_events
);
2454 Vunread_command_events
= XCDR (Vunread_command_events
);
2456 /* Undo what read_char_x_menu_prompt did when it unread
2457 additional keys returned by Fx_popup_menu. */
2459 && EQ (XCDR (c
), Qdisabled
)
2460 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2463 /* If the queued event is something that used the mouse,
2464 set used_mouse_menu accordingly. */
2466 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2467 *used_mouse_menu
= 1;
2470 goto reread_for_input_method
;
2473 if (CONSP (Vunread_input_method_events
))
2475 c
= XCAR (Vunread_input_method_events
);
2476 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2478 /* Undo what read_char_x_menu_prompt did when it unread
2479 additional keys returned by Fx_popup_menu. */
2481 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2485 goto reread_for_input_method
;
2488 this_command_key_count_reset
= 0;
2490 if (!NILP (Vexecuting_kbd_macro
))
2492 /* We set this to Qmacro; since that's not a frame, nobody will
2493 try to switch frames on us, and the selected window will
2496 Since this event came from a macro, it would be misleading to
2497 leave internal_last_event_frame set to wherever the last
2498 real event came from. Normally, a switch-frame event selects
2499 internal_last_event_frame after each command is read, but
2500 events read from a macro should never cause a new frame to be
2502 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2504 /* Exit the macro if we are at the end.
2505 Also, some things replace the macro with t
2506 to force an early exit. */
2507 if (EQ (Vexecuting_kbd_macro
, Qt
)
2508 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2514 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2515 if (STRINGP (Vexecuting_kbd_macro
)
2516 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2517 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2519 executing_kbd_macro_index
++;
2524 if (!NILP (unread_switch_frame
))
2526 c
= unread_switch_frame
;
2527 unread_switch_frame
= Qnil
;
2529 /* This event should make it into this_command_keys, and get echoed
2530 again, so we do not set `reread'. */
2534 /* if redisplay was requested */
2535 if (commandflag
>= 0)
2537 /* If there is pending input, process any events which are not
2538 user-visible, such as X selection_request events. */
2540 || detect_input_pending_run_timers (0))
2541 swallow_events (0); /* may clear input_pending */
2543 /* Redisplay if no pending input. */
2544 while (!input_pending
)
2546 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2547 redisplay_preserve_echo_area (5);
2552 /* Normal case: no input arrived during redisplay. */
2555 /* Input arrived and pre-empted redisplay.
2556 Process any events which are not user-visible. */
2558 /* If that cleared input_pending, try again to redisplay. */
2562 /* Message turns off echoing unless more keystrokes turn it on again.
2564 The code in 20.x for the condition was
2566 1. echo_area_glyphs && *echo_area_glyphs
2567 2. && echo_area_glyphs != current_kboard->echobuf
2568 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2570 (1) means there's a current message displayed
2572 (2) means it's not the message from echoing from the current
2575 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2576 is set to a non-null value. This is done in read_char and it is
2577 set to echo_area_glyphs after a call to echo_char. That means
2578 ok_to_echo_at_next_pause is either null or
2579 current_kboard->echobuf with the appropriate current_kboard at
2582 So, condition (3) means in clear text ok_to_echo_at_next_pause
2583 must be either null, or the current message isn't from echoing at
2584 all, or it's from echoing from a different kboard than the
2587 if (/* There currently is something in the echo area. */
2588 !NILP (echo_area_buffer
[0])
2589 && (/* And it's either not from echoing. */
2590 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2591 /* Or it's an echo from a different kboard. */
2592 || echo_kboard
!= current_kboard
2593 /* Or we explicitly allow overwriting whatever there is. */
2594 || ok_to_echo_at_next_pause
== NULL
))
2599 /* Try reading a character via menu prompting in the minibuf.
2600 Try this before the sit-for, because the sit-for
2601 would do the wrong thing if we are supposed to do
2602 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2603 after a mouse event so don't try a minibuf menu. */
2605 if (nmaps
> 0 && INTERACTIVE
2606 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2607 /* Don't bring up a menu if we already have another event. */
2608 && NILP (Vunread_command_events
)
2609 && unread_command_char
< 0
2610 && !detect_input_pending_run_timers (0))
2612 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2615 key_already_recorded
= 1;
2620 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2621 We will do that below, temporarily for short sections of code,
2622 when appropriate. local_getcjmp must be in effect
2623 around any call to sit_for or kbd_buffer_get_event;
2624 it *must not* be in effect when we call redisplay. */
2626 if (_setjmp (local_getcjmp
))
2628 /* We must have saved the outer value of getcjmp here,
2629 so restore it now. */
2630 restore_getcjmp (save_jump
);
2631 XSETINT (c
, quit_char
);
2632 internal_last_event_frame
= selected_frame
;
2633 Vlast_event_frame
= internal_last_event_frame
;
2634 /* If we report the quit char as an event,
2635 don't do so more than once. */
2636 if (!NILP (Vinhibit_quit
))
2641 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2642 if (kb
!= current_kboard
)
2644 Lisp_Object link
= kb
->kbd_queue
;
2645 /* We shouldn't get here if we were in single-kboard mode! */
2650 while (CONSP (XCDR (link
)))
2652 if (!NILP (XCDR (link
)))
2656 kb
->kbd_queue
= Fcons (c
, Qnil
);
2658 XSETCDR (link
, Fcons (c
, Qnil
));
2659 kb
->kbd_queue_has_data
= 1;
2660 current_kboard
= kb
;
2661 /* This is going to exit from read_char
2662 so we had better get rid of this frame's stuff. */
2664 longjmp (wrong_kboard_jmpbuf
, 1);
2671 timer_start_idle ();
2673 /* If in middle of key sequence and minibuffer not active,
2674 start echoing if enough time elapses. */
2676 if (minibuf_level
== 0
2677 && !current_kboard
->immediate_echo
2678 && this_command_key_count
> 0
2680 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2681 && NILP (Fzerop (Vecho_keystrokes
))
2682 && (/* No message. */
2683 NILP (echo_area_buffer
[0])
2684 /* Or empty message. */
2685 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2686 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2687 /* Or already echoing from same kboard. */
2688 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2689 /* Or not echoing before and echoing allowed. */
2690 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2694 /* After a mouse event, start echoing right away.
2695 This is because we are probably about to display a menu,
2696 and we don't want to delay before doing so. */
2697 if (EVENT_HAS_PARAMETERS (prev_event
))
2702 double duration
= extract_float (Vecho_keystrokes
);
2703 sec
= (int) duration
;
2704 usec
= (duration
- sec
) * 1000000;
2705 save_getcjmp (save_jump
);
2706 restore_getcjmp (local_getcjmp
);
2707 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2708 restore_getcjmp (save_jump
);
2710 && ! CONSP (Vunread_command_events
))
2715 /* Maybe auto save due to number of keystrokes. */
2717 if (commandflag
!= 0
2718 && auto_save_interval
> 0
2719 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2720 && !detect_input_pending_run_timers (0))
2722 Fdo_auto_save (Qnil
, Qnil
);
2723 /* Hooks can actually change some buffers in auto save. */
2727 /* Try reading using an X menu.
2728 This is never confused with reading using the minibuf
2729 because the recursive call of read_char in read_char_minibuf_menu_prompt
2730 does not pass on any keymaps. */
2732 if (nmaps
> 0 && INTERACTIVE
2733 && !NILP (prev_event
)
2734 && EVENT_HAS_PARAMETERS (prev_event
)
2735 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2736 && !EQ (XCAR (prev_event
), Qtool_bar
)
2737 /* Don't bring up a menu if we already have another event. */
2738 && NILP (Vunread_command_events
)
2739 && unread_command_char
< 0)
2741 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2743 /* Now that we have read an event, Emacs is not idle. */
2749 /* Maybe autosave and/or garbage collect due to idleness. */
2751 if (INTERACTIVE
&& NILP (c
))
2753 int delay_level
, buffer_size
;
2755 /* Slow down auto saves logarithmically in size of current buffer,
2756 and garbage collect while we're at it. */
2757 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2758 last_non_minibuf_size
= Z
- BEG
;
2759 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2761 while (buffer_size
> 64)
2762 delay_level
++, buffer_size
-= buffer_size
>> 2;
2763 if (delay_level
< 4) delay_level
= 4;
2764 /* delay_level is 4 for files under around 50k, 7 at 100k,
2765 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2767 /* Auto save if enough time goes by without input. */
2768 if (commandflag
!= 0
2769 && num_nonmacro_input_events
> last_auto_save
2770 && INTEGERP (Vauto_save_timeout
)
2771 && XINT (Vauto_save_timeout
) > 0)
2775 save_getcjmp (save_jump
);
2776 restore_getcjmp (local_getcjmp
);
2777 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2779 restore_getcjmp (save_jump
);
2782 && ! CONSP (Vunread_command_events
))
2784 Fdo_auto_save (Qnil
, Qnil
);
2786 /* If we have auto-saved and there is still no input
2787 available, garbage collect if there has been enough
2788 consing going on to make it worthwhile. */
2789 if (!detect_input_pending_run_timers (0)
2790 && consing_since_gc
> gc_cons_threshold
/ 2)
2791 Fgarbage_collect ();
2798 /* If this has become non-nil here, it has been set by a timer
2799 or sentinel or filter. */
2800 if (CONSP (Vunread_command_events
))
2802 c
= XCAR (Vunread_command_events
);
2803 Vunread_command_events
= XCDR (Vunread_command_events
);
2806 /* Read something from current KBOARD's side queue, if possible. */
2810 if (current_kboard
->kbd_queue_has_data
)
2812 if (!CONSP (current_kboard
->kbd_queue
))
2814 c
= XCAR (current_kboard
->kbd_queue
);
2815 current_kboard
->kbd_queue
2816 = XCDR (current_kboard
->kbd_queue
);
2817 if (NILP (current_kboard
->kbd_queue
))
2818 current_kboard
->kbd_queue_has_data
= 0;
2819 input_pending
= readable_events (0);
2820 if (EVENT_HAS_PARAMETERS (c
)
2821 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2822 internal_last_event_frame
= XCAR (XCDR (c
));
2823 Vlast_event_frame
= internal_last_event_frame
;
2828 /* If current_kboard's side queue is empty check the other kboards.
2829 If one of them has data that we have not yet seen here,
2830 switch to it and process the data waiting for it.
2832 Note: if the events queued up for another kboard
2833 have already been seen here, and therefore are not a complete command,
2834 the kbd_queue_has_data field is 0, so we skip that kboard here.
2835 That's to avoid an infinite loop switching between kboards here. */
2836 if (NILP (c
) && !single_kboard
)
2839 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2840 if (kb
->kbd_queue_has_data
)
2842 current_kboard
= kb
;
2843 /* This is going to exit from read_char
2844 so we had better get rid of this frame's stuff. */
2846 longjmp (wrong_kboard_jmpbuf
, 1);
2855 /* Finally, we read from the main queue,
2856 and if that gives us something we can't use yet, we put it on the
2857 appropriate side queue and try again. */
2863 /* Actually read a character, waiting if necessary. */
2864 save_getcjmp (save_jump
);
2865 restore_getcjmp (local_getcjmp
);
2866 timer_start_idle ();
2867 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2868 restore_getcjmp (save_jump
);
2871 if (! NILP (c
) && (kb
!= current_kboard
))
2873 Lisp_Object link
= kb
->kbd_queue
;
2876 while (CONSP (XCDR (link
)))
2878 if (!NILP (XCDR (link
)))
2882 kb
->kbd_queue
= Fcons (c
, Qnil
);
2884 XSETCDR (link
, Fcons (c
, Qnil
));
2885 kb
->kbd_queue_has_data
= 1;
2889 current_kboard
= kb
;
2890 /* This is going to exit from read_char
2891 so we had better get rid of this frame's stuff. */
2893 longjmp (wrong_kboard_jmpbuf
, 1);
2898 /* Terminate Emacs in batch mode if at eof. */
2899 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2900 Fkill_emacs (make_number (1));
2904 /* Add in any extra modifiers, where appropriate. */
2905 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2906 || ((extra_keyboard_modifiers
& 0177) < ' '
2907 && (extra_keyboard_modifiers
& 0177) != 0))
2908 XSETINT (c
, make_ctrl_char (XINT (c
)));
2910 /* Transfer any other modifier bits directly from
2911 extra_keyboard_modifiers to c. Ignore the actual character code
2912 in the low 16 bits of extra_keyboard_modifiers. */
2913 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2923 if (commandflag
>= 0
2924 && !input_pending
&& !detect_input_pending_run_timers (0))
2932 /* Buffer switch events are only for internal wakeups
2933 so don't show them to the user.
2934 Also, don't record a key if we already did. */
2935 if (BUFFERP (c
) || key_already_recorded
)
2938 /* Process special events within read_char
2939 and loop around to read another event. */
2942 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2947 int was_locked
= single_kboard
;
2949 last_input_char
= c
;
2950 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2952 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2953 /* We stopped being idle for this event; undo that. This
2954 prevents automatic window selection (under
2955 mouse_autoselect_window from acting as a real input event, for
2956 example banishing the mouse under mouse-avoidance-mode. */
2957 timer_resume_idle ();
2959 /* Resume allowing input from any kboard, if that was true before. */
2961 any_kboard_state ();
2966 /* Handle things that only apply to characters. */
2969 /* If kbd_buffer_get_event gave us an EOF, return that. */
2973 if ((STRINGP (Vkeyboard_translate_table
)
2974 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2975 || (VECTORP (Vkeyboard_translate_table
)
2976 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2977 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2978 && CHAR_VALID_P (XINT (c
), 0)))
2981 d
= Faref (Vkeyboard_translate_table
, c
);
2982 /* nil in keyboard-translate-table means no translation. */
2988 /* If this event is a mouse click in the menu bar,
2989 return just menu-bar for now. Modify the mouse click event
2990 so we won't do this twice, then queue it up. */
2991 if (EVENT_HAS_PARAMETERS (c
)
2993 && CONSP (EVENT_START (c
))
2994 && CONSP (XCDR (EVENT_START (c
))))
2998 posn
= POSN_POSN (EVENT_START (c
));
2999 /* Handle menu-bar events:
3000 insert the dummy prefix event `menu-bar'. */
3001 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3003 /* Change menu-bar to (menu-bar) as the event "position". */
3004 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3007 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3012 /* Store these characters into recent_keys, the dribble file if any,
3013 and the keyboard macro being defined, if any. */
3015 if (! NILP (also_record
))
3016 record_char (also_record
);
3018 /* Wipe the echo area.
3019 But first, if we are about to use an input method,
3020 save the echo area contents for it to refer to. */
3022 && ! NILP (Vinput_method_function
)
3023 && (unsigned) XINT (c
) >= ' '
3024 && (unsigned) XINT (c
) != 127
3025 && (unsigned) XINT (c
) < 256)
3027 previous_echo_area_message
= Fcurrent_message ();
3028 Vinput_method_previous_message
= previous_echo_area_message
;
3031 /* Now wipe the echo area, except for help events which do their
3032 own stuff with the echo area. */
3034 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3035 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3037 if (!NILP (echo_area_buffer
[0]))
3038 safe_run_hooks (Qecho_area_clear_hook
);
3039 clear_message (1, 0);
3042 reread_for_input_method
:
3044 /* Pass this to the input method, if appropriate. */
3046 && ! NILP (Vinput_method_function
)
3047 /* Don't run the input method within a key sequence,
3048 after the first event of the key sequence. */
3049 && NILP (prev_event
)
3050 && (unsigned) XINT (c
) >= ' '
3051 && (unsigned) XINT (c
) != 127
3052 && (unsigned) XINT (c
) < 256)
3055 int key_count
, key_count_reset
;
3056 struct gcpro gcpro1
;
3057 int count
= SPECPDL_INDEX ();
3059 /* Save the echo status. */
3060 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3061 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3062 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3063 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3066 if (before_command_restore_flag
)
3068 this_command_key_count
= before_command_key_count_1
;
3069 if (this_command_key_count
< this_single_command_key_start
)
3070 this_single_command_key_start
= this_command_key_count
;
3071 echo_truncate (before_command_echo_length_1
);
3072 before_command_restore_flag
= 0;
3076 /* Save the this_command_keys status. */
3077 key_count
= this_command_key_count
;
3078 key_count_reset
= this_command_key_count_reset
;
3081 keys
= Fcopy_sequence (this_command_keys
);
3086 /* Clear out this_command_keys. */
3087 this_command_key_count
= 0;
3088 this_command_key_count_reset
= 0;
3090 /* Now wipe the echo area. */
3091 if (!NILP (echo_area_buffer
[0]))
3092 safe_run_hooks (Qecho_area_clear_hook
);
3093 clear_message (1, 0);
3096 /* If we are not reading a key sequence,
3097 never use the echo area. */
3100 specbind (Qinput_method_use_echo_area
, Qt
);
3103 /* Call the input method. */
3104 tem
= call1 (Vinput_method_function
, c
);
3106 tem
= unbind_to (count
, tem
);
3108 /* Restore the saved echoing state
3109 and this_command_keys state. */
3110 this_command_key_count
= key_count
;
3111 this_command_key_count_reset
= key_count_reset
;
3113 this_command_keys
= keys
;
3116 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3117 current_kboard
->echo_string
= saved_echo_string
;
3118 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3119 if (saved_immediate_echo
)
3124 /* The input method can return no events. */
3127 /* Bring back the previous message, if any. */
3128 if (! NILP (previous_echo_area_message
))
3129 message_with_string ("%s", previous_echo_area_message
, 0);
3132 /* It returned one event or more. */
3134 Vunread_post_input_method_events
3135 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3140 /* Display help if not echoing. */
3141 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3143 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3144 Lisp_Object help
, object
, position
, window
, tem
;
3146 tem
= Fcdr (XCDR (c
));
3149 window
= Fcar (tem
);
3151 object
= Fcar (tem
);
3153 position
= Fcar (tem
);
3155 show_help_echo (help
, window
, object
, position
, 0);
3157 /* We stopped being idle for this event; undo that. */
3158 timer_resume_idle ();
3162 if (! reread
|| this_command_key_count
== 0
3163 || this_command_key_count_reset
)
3166 /* Don't echo mouse motion events. */
3167 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3168 && NILP (Fzerop (Vecho_keystrokes
))
3169 && ! (EVENT_HAS_PARAMETERS (c
)
3170 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3173 if (! NILP (also_record
))
3174 echo_char (also_record
);
3175 /* Once we reread a character, echoing can happen
3176 the next time we pause to read a new one. */
3177 ok_to_echo_at_next_pause
= current_kboard
;
3180 /* Record this character as part of the current key. */
3181 add_command_key (c
);
3182 if (! NILP (also_record
))
3183 add_command_key (also_record
);
3186 last_input_char
= c
;
3189 /* Process the help character specially if enabled */
3190 if (!NILP (Vhelp_form
) && help_char_p (c
))
3193 count
= SPECPDL_INDEX ();
3195 record_unwind_protect (Fset_window_configuration
,
3196 Fcurrent_window_configuration (Qnil
));
3198 tem0
= Feval (Vhelp_form
);
3200 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3204 c
= read_char (0, 0, 0, Qnil
, 0);
3205 while (BUFFERP (c
));
3206 /* Remove the help from the frame */
3207 unbind_to (count
, Qnil
);
3210 if (EQ (c
, make_number (040)))
3214 c
= read_char (0, 0, 0, Qnil
, 0);
3215 while (BUFFERP (c
));
3224 /* Record a key that came from a mouse menu.
3225 Record it for echoing, for this-command-keys, and so on. */
3231 /* Wipe the echo area. */
3232 clear_message (1, 0);
3237 before_command_key_count
= this_command_key_count
;
3238 before_command_echo_length
= echo_length ();
3241 /* Don't echo mouse motion events. */
3242 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3243 && NILP (Fzerop (Vecho_keystrokes
)))
3247 /* Once we reread a character, echoing can happen
3248 the next time we pause to read a new one. */
3249 ok_to_echo_at_next_pause
= 0;
3252 /* Record this character as part of the current key. */
3253 add_command_key (c
);
3255 /* Re-reading in the middle of a command */
3256 last_input_char
= c
;
3260 /* Return 1 if should recognize C as "the help character". */
3268 if (EQ (c
, Vhelp_char
))
3270 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3271 if (EQ (c
, XCAR (tail
)))
3276 /* Record the input event C in various ways. */
3284 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3286 /* To avoid filling recent_keys with help-echo and mouse-movement
3287 events, we filter out repeated help-echo events, only store the
3288 first and last in a series of mouse-movement events, and don't
3289 store repeated help-echo events which are only separated by
3290 mouse-movement events. */
3292 Lisp_Object ev1
, ev2
, ev3
;
3295 if ((ix1
= recent_keys_index
- 1) < 0)
3296 ix1
= NUM_RECENT_KEYS
- 1;
3297 ev1
= AREF (recent_keys
, ix1
);
3299 if ((ix2
= ix1
- 1) < 0)
3300 ix2
= NUM_RECENT_KEYS
- 1;
3301 ev2
= AREF (recent_keys
, ix2
);
3303 if ((ix3
= ix2
- 1) < 0)
3304 ix3
= NUM_RECENT_KEYS
- 1;
3305 ev3
= AREF (recent_keys
, ix3
);
3307 if (EQ (XCAR (c
), Qhelp_echo
))
3309 /* Don't record `help-echo' in recent_keys unless it shows some help
3310 message, and a different help than the previously recorded
3312 Lisp_Object help
, last_help
;
3314 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3315 if (!STRINGP (help
))
3317 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3318 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3320 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3321 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3322 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3324 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3325 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3326 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3327 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3330 else if (EQ (XCAR (c
), Qmouse_movement
))
3332 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3333 So additional mouse movement events replace the last element. */
3334 Lisp_Object last_window
, window
;
3336 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3337 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3338 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3339 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3340 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3342 ASET (recent_keys
, ix1
, c
);
3348 store_kbd_macro_char (c
);
3353 ASET (recent_keys
, recent_keys_index
, c
);
3354 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3355 recent_keys_index
= 0;
3357 else if (recorded
< 0)
3359 /* We need to remove one or two events from recent_keys.
3360 To do this, we simply put nil at those events and move the
3361 recent_keys_index backwards over those events. Usually,
3362 users will never see those nil events, as they will be
3363 overwritten by the command keys entered to see recent_keys
3366 while (recorded
++ < 0 && total_keys
> 0)
3368 if (total_keys
< NUM_RECENT_KEYS
)
3370 if (--recent_keys_index
< 0)
3371 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3372 ASET (recent_keys
, recent_keys_index
, Qnil
);
3376 num_nonmacro_input_events
++;
3378 /* Write c to the dribble file. If c is a lispy event, write
3379 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3380 If you, dear reader, have a better idea, you've got the source. :-) */
3385 if (XUINT (c
) < 0x100)
3386 putc (XINT (c
), dribble
);
3388 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3392 Lisp_Object dribblee
;
3394 /* If it's a structured event, take the event header. */
3395 dribblee
= EVENT_HEAD (c
);
3397 if (SYMBOLP (dribblee
))
3399 putc ('<', dribble
);
3400 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3401 SBYTES (SYMBOL_NAME (dribblee
)),
3403 putc ('>', dribble
);
3415 struct buffer
*old
= current_buffer
;
3416 Fprinc (object
, Qnil
);
3417 set_buffer_internal (XBUFFER (Vstandard_output
));
3418 call0 (intern ("help-mode"));
3419 set_buffer_internal (old
);
3423 /* Copy out or in the info on where C-g should throw to.
3424 This is used when running Lisp code from within get_char,
3425 in case get_char is called recursively.
3426 See read_process_output. */
3432 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3436 restore_getcjmp (temp
)
3439 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3444 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3445 of this function. */
3448 tracking_off (old_value
)
3449 Lisp_Object old_value
;
3451 do_mouse_tracking
= old_value
;
3452 if (NILP (old_value
))
3454 /* Redisplay may have been preempted because there was input
3455 available, and it assumes it will be called again after the
3456 input has been processed. If the only input available was
3457 the sort that we have just disabled, then we need to call
3459 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3461 redisplay_preserve_echo_area (6);
3462 get_input_pending (&input_pending
,
3463 READABLE_EVENTS_DO_TIMERS_NOW
);
3469 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3470 doc
: /* Evaluate BODY with mouse movement events enabled.
3471 Within a `track-mouse' form, mouse motion generates input events that
3472 you can read with `read-event'.
3473 Normally, mouse motion is ignored.
3474 usage: (track-mouse BODY ...) */)
3478 int count
= SPECPDL_INDEX ();
3481 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3483 do_mouse_tracking
= Qt
;
3485 val
= Fprogn (args
);
3486 return unbind_to (count
, val
);
3489 /* If mouse has moved on some frame, return one of those frames.
3490 Return 0 otherwise. */
3495 Lisp_Object tail
, frame
;
3497 FOR_EACH_FRAME (tail
, frame
)
3499 if (XFRAME (frame
)->mouse_moved
)
3500 return XFRAME (frame
);
3506 #endif /* HAVE_MOUSE */
3508 /* Low level keyboard/mouse input.
3509 kbd_buffer_store_event places events in kbd_buffer, and
3510 kbd_buffer_get_event retrieves them. */
3512 /* Return true iff there are any events in the queue that read-char
3513 would return. If this returns false, a read-char would block. */
3515 readable_events (flags
)
3518 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3521 /* If the buffer contains only FOCUS_IN_EVENT events, and
3522 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3523 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3525 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3526 #ifdef USE_TOOLKIT_SCROLL_BARS
3527 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3531 struct input_event
*event
;
3533 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3540 #ifdef USE_TOOLKIT_SCROLL_BARS
3541 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3543 event
->kind
== FOCUS_IN_EVENT
)
3544 #ifdef USE_TOOLKIT_SCROLL_BARS
3545 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3546 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3547 && event
->part
== scroll_bar_handle
3548 && event
->modifiers
== 0)
3553 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3556 while (event
!= kbd_store_ptr
);
3563 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3564 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3569 if (current_kboard
->kbd_queue_has_data
)
3575 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3576 if (kb
->kbd_queue_has_data
)
3582 /* Set this for debugging, to have a way to get out */
3587 event_to_kboard (event
)
3588 struct input_event
*event
;
3591 frame
= event
->frame_or_window
;
3593 frame
= XCAR (frame
);
3594 else if (WINDOWP (frame
))
3595 frame
= WINDOW_FRAME (XWINDOW (frame
));
3597 /* There are still some events that don't set this field.
3598 For now, just ignore the problem.
3599 Also ignore dead frames here. */
3600 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3603 return FRAME_KBOARD (XFRAME (frame
));
3608 Lisp_Object Vthrow_on_input
;
3610 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3613 kbd_buffer_store_event (event
)
3614 register struct input_event
*event
;
3616 kbd_buffer_store_event_hold (event
, 0);
3619 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3621 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3622 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3623 Else, if EVENT is a quit event, store the quit event
3624 in HOLD_QUIT, and return (thus ignoring further events).
3626 This is used in read_avail_input to postpone the processing
3627 of the quit event until all subsequent input events have been
3628 parsed (and discarded).
3632 kbd_buffer_store_event_hold (event
, hold_quit
)
3633 register struct input_event
*event
;
3634 struct input_event
*hold_quit
;
3636 if (event
->kind
== NO_EVENT
)
3639 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3642 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3644 register int c
= event
->code
& 0377;
3646 if (event
->modifiers
& ctrl_modifier
)
3647 c
= make_ctrl_char (c
);
3649 c
|= (event
->modifiers
3650 & (meta_modifier
| alt_modifier
3651 | hyper_modifier
| super_modifier
));
3657 struct input_event
*sp
;
3660 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3661 kb
!= current_kboard
))
3664 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3665 Fcons (make_number (c
), Qnil
));
3666 kb
->kbd_queue_has_data
= 1;
3667 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3669 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3672 if (event_to_kboard (sp
) == kb
)
3674 sp
->kind
= NO_EVENT
;
3675 sp
->frame_or_window
= Qnil
;
3685 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3689 /* If this results in a quit_char being returned to Emacs as
3690 input, set Vlast_event_frame properly. If this doesn't
3691 get returned to Emacs as an event, the next event read
3692 will set Vlast_event_frame again, so this is safe to do. */
3696 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3698 focus
= event
->frame_or_window
;
3699 internal_last_event_frame
= focus
;
3700 Vlast_event_frame
= focus
;
3703 last_event_timestamp
= event
->timestamp
;
3704 handle_interrupt ();
3708 if (c
&& c
== stop_character
)
3714 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3715 Just ignore the second one. */
3716 else if (event
->kind
== BUFFER_SWITCH_EVENT
3717 && kbd_fetch_ptr
!= kbd_store_ptr
3718 && ((kbd_store_ptr
== kbd_buffer
3719 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3720 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3723 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3724 kbd_store_ptr
= kbd_buffer
;
3726 /* Don't let the very last slot in the buffer become full,
3727 since that would make the two pointers equal,
3728 and that is indistinguishable from an empty buffer.
3729 Discard the event if it would fill the last slot. */
3730 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3732 *kbd_store_ptr
= *event
;
3736 /* If we're inside while-no-input, and this event qualifies
3737 as input, set quit-flag to cause an interrupt. */
3738 if (!NILP (Vthrow_on_input
)
3739 && event
->kind
!= FOCUS_IN_EVENT
3740 && event
->kind
!= HELP_EVENT
3741 && event
->kind
!= DEICONIFY_EVENT
)
3743 Vquit_flag
= Vthrow_on_input
;
3744 /* If we're inside a function that wants immediate quits,
3746 if (immediate_quit
&& NILP (Vinhibit_quit
))
3756 /* Put an input event back in the head of the event queue. */
3759 kbd_buffer_unget_event (event
)
3760 register struct input_event
*event
;
3762 if (kbd_fetch_ptr
== kbd_buffer
)
3763 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3765 /* Don't let the very last slot in the buffer become full, */
3766 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3769 *kbd_fetch_ptr
= *event
;
3774 /* Generate HELP_EVENT input_events in BUFP which has room for
3775 SIZE events. If there's not enough room in BUFP, ignore this
3778 HELP is the help form.
3780 FRAME is the frame on which the help is generated. OBJECT is the
3781 Lisp object where the help was found (a buffer, a string, an
3782 overlay, or nil if neither from a string nor from a buffer. POS is
3783 the position within OBJECT where the help was found.
3785 Value is the number of input_events generated. */
3788 gen_help_event (help
, frame
, window
, object
, pos
)
3789 Lisp_Object help
, frame
, object
, window
;
3792 struct input_event event
;
3796 event
.kind
= HELP_EVENT
;
3797 event
.frame_or_window
= frame
;
3799 event
.x
= WINDOWP (window
) ? window
: frame
;
3802 kbd_buffer_store_event (&event
);
3806 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3809 kbd_buffer_store_help_event (frame
, help
)
3810 Lisp_Object frame
, help
;
3812 struct input_event event
;
3814 event
.kind
= HELP_EVENT
;
3815 event
.frame_or_window
= frame
;
3820 kbd_buffer_store_event (&event
);
3824 /* Discard any mouse events in the event buffer by setting them to
3827 discard_mouse_events ()
3829 struct input_event
*sp
;
3830 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3832 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3835 if (sp
->kind
== MOUSE_CLICK_EVENT
3836 || sp
->kind
== WHEEL_EVENT
3838 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3840 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3842 sp
->kind
= NO_EVENT
;
3848 /* Return non-zero if there are any real events waiting in the event
3849 buffer, not counting `NO_EVENT's.
3851 If DISCARD is non-zero, discard NO_EVENT events at the front of
3852 the input queue, possibly leaving the input queue empty if there
3853 are no real input events. */
3856 kbd_buffer_events_waiting (discard
)
3859 struct input_event
*sp
;
3861 for (sp
= kbd_fetch_ptr
;
3862 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3865 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3872 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3876 /* Clear input event EVENT. */
3880 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 (kbp
, used_mouse_menu
)
3895 int *used_mouse_menu
;
3904 *kbp
= current_kboard
;
3908 /* Wait until there is input available. */
3911 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3914 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3918 /* If the quit flag is set, then read_char will return
3919 quit_char, so that counts as "available input." */
3920 if (!NILP (Vquit_flag
))
3921 quit_throw_to_read_char ();
3923 /* One way or another, wait until input is available; then, if
3924 interrupt handlers have not read it, read it now. */
3927 wait_for_kbd_input ();
3929 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3933 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3936 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3940 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3942 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3943 /* Pass 1 for EXPECT since we just waited to have input. */
3944 read_avail_input (1);
3946 #endif /* not VMS */
3949 if (CONSP (Vunread_command_events
))
3952 first
= XCAR (Vunread_command_events
);
3953 Vunread_command_events
= XCDR (Vunread_command_events
);
3954 *kbp
= current_kboard
;
3958 /* At this point, we know that there is a readable event available
3959 somewhere. If the event queue is empty, then there must be a
3960 mouse movement enabled and available. */
3961 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3963 struct input_event
*event
;
3965 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3969 last_event_timestamp
= event
->timestamp
;
3972 *kbp
= event_to_kboard (event
);
3974 *kbp
= current_kboard
; /* Better than returning null ptr? */
3976 *kbp
= &the_only_kboard
;
3981 /* These two kinds of events get special handling
3982 and don't actually appear to the command loop.
3983 We return nil for them. */
3984 if (event
->kind
== SELECTION_REQUEST_EVENT
3985 || event
->kind
== SELECTION_CLEAR_EVENT
)
3988 struct input_event copy
;
3990 /* Remove it from the buffer before processing it,
3991 since otherwise swallow_events will see it
3992 and process it again. */
3994 kbd_fetch_ptr
= event
+ 1;
3995 input_pending
= readable_events (0);
3996 x_handle_selection_event (©
);
3998 /* We're getting selection request events, but we don't have
4004 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4005 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4007 /* Make an event (delete-frame (FRAME)). */
4008 obj
= Fcons (event
->frame_or_window
, Qnil
);
4009 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4010 kbd_fetch_ptr
= event
+ 1;
4013 #if defined (HAVE_X11) || defined (HAVE_NTGUI)
4014 else if (event
->kind
== ICONIFY_EVENT
)
4016 /* Make an event (iconify-frame (FRAME)). */
4017 obj
= Fcons (event
->frame_or_window
, Qnil
);
4018 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4019 kbd_fetch_ptr
= event
+ 1;
4021 else if (event
->kind
== DEICONIFY_EVENT
)
4023 /* Make an event (make-frame-visible (FRAME)). */
4024 obj
= Fcons (event
->frame_or_window
, Qnil
);
4025 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4026 kbd_fetch_ptr
= event
+ 1;
4029 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4031 /* The value doesn't matter here; only the type is tested. */
4032 XSETBUFFER (obj
, current_buffer
);
4033 kbd_fetch_ptr
= event
+ 1;
4035 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4036 || defined (USE_GTK)
4037 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4039 kbd_fetch_ptr
= event
+ 1;
4040 input_pending
= readable_events (0);
4041 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4042 x_activate_menubar (XFRAME (event
->frame_or_window
));
4045 #if defined (WINDOWSNT) || defined (MAC_OS)
4046 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4049 /* Make an event (language-change (KEY_SCRIPT)). */
4050 obj
= Fcons (make_number (event
->code
), Qnil
);
4052 /* Make an event (language-change (FRAME CHARSET LCID)). */
4053 obj
= Fcons (event
->frame_or_window
, Qnil
);
4055 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4056 kbd_fetch_ptr
= event
+ 1;
4059 else if (event
->kind
== SAVE_SESSION_EVENT
)
4061 obj
= Fcons (Qsave_session
, Qnil
);
4062 kbd_fetch_ptr
= event
+ 1;
4064 /* Just discard these, by returning nil.
4065 With MULTI_KBOARD, these events are used as placeholders
4066 when we need to randomly delete events from the queue.
4067 (They shouldn't otherwise be found in the buffer,
4068 but on some machines it appears they do show up
4069 even without MULTI_KBOARD.) */
4070 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4071 mouse events during a popup-menu call. */
4072 else if (event
->kind
== NO_EVENT
)
4073 kbd_fetch_ptr
= event
+ 1;
4074 else if (event
->kind
== HELP_EVENT
)
4076 Lisp_Object object
, position
, help
, frame
, window
;
4078 frame
= event
->frame_or_window
;
4079 object
= event
->arg
;
4080 position
= make_number (event
->code
);
4083 clear_event (event
);
4085 kbd_fetch_ptr
= event
+ 1;
4086 if (!WINDOWP (window
))
4088 obj
= Fcons (Qhelp_echo
,
4089 list5 (frame
, help
, window
, object
, position
));
4091 else if (event
->kind
== FOCUS_IN_EVENT
)
4093 /* Notification of a FocusIn event. The frame receiving the
4094 focus is in event->frame_or_window. Generate a
4095 switch-frame event if necessary. */
4096 Lisp_Object frame
, focus
;
4098 frame
= event
->frame_or_window
;
4099 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4103 if (!EQ (frame
, internal_last_event_frame
)
4104 && !EQ (frame
, selected_frame
))
4105 obj
= make_lispy_switch_frame (frame
);
4106 internal_last_event_frame
= frame
;
4107 kbd_fetch_ptr
= event
+ 1;
4111 /* If this event is on a different frame, return a switch-frame this
4112 time, and leave the event in the queue for next time. */
4116 frame
= event
->frame_or_window
;
4118 frame
= XCAR (frame
);
4119 else if (WINDOWP (frame
))
4120 frame
= WINDOW_FRAME (XWINDOW (frame
));
4122 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4126 if (! EQ (frame
, internal_last_event_frame
)
4127 && !EQ (frame
, selected_frame
))
4128 obj
= make_lispy_switch_frame (frame
);
4129 internal_last_event_frame
= frame
;
4131 /* If we didn't decide to make a switch-frame event, go ahead
4132 and build a real event from the queue entry. */
4136 obj
= make_lispy_event (event
);
4138 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4139 || defined (USE_GTK)
4140 /* If this was a menu selection, then set the flag to inhibit
4141 writing to last_nonmenu_event. Don't do this if the event
4142 we're returning is (menu-bar), though; that indicates the
4143 beginning of the menu sequence, and we might as well leave
4144 that as the `event with parameters' for this selection. */
4146 && !EQ (event
->frame_or_window
, event
->arg
)
4147 && (event
->kind
== MENU_BAR_EVENT
4148 || event
->kind
== TOOL_BAR_EVENT
))
4149 *used_mouse_menu
= 1;
4152 /* Wipe out this event, to catch bugs. */
4153 clear_event (event
);
4154 kbd_fetch_ptr
= event
+ 1;
4159 /* Try generating a mouse motion event. */
4160 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4162 FRAME_PTR f
= some_mouse_moved ();
4163 Lisp_Object bar_window
;
4164 enum scroll_bar_part part
;
4168 *kbp
= current_kboard
;
4169 /* Note that this uses F to determine which display to look at.
4170 If there is no valid info, it does not store anything
4171 so x remains nil. */
4174 /* XXX Can f or mouse_position_hook be NULL here? */
4175 if (f
&& FRAME_DEVICE (f
)->mouse_position_hook
)
4176 (*FRAME_DEVICE (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4177 &part
, &x
, &y
, &time
);
4181 /* Decide if we should generate a switch-frame event. Don't
4182 generate switch-frame events for motion outside of all Emacs
4188 frame
= FRAME_FOCUS_FRAME (f
);
4190 XSETFRAME (frame
, f
);
4192 if (! EQ (frame
, internal_last_event_frame
)
4193 && !EQ (frame
, selected_frame
))
4194 obj
= make_lispy_switch_frame (frame
);
4195 internal_last_event_frame
= frame
;
4198 /* If we didn't decide to make a switch-frame event, go ahead and
4199 return a mouse-motion event. */
4200 if (!NILP (x
) && NILP (obj
))
4201 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4203 #endif /* HAVE_MOUSE */
4205 /* We were promised by the above while loop that there was
4206 something for us to read! */
4209 input_pending
= readable_events (0);
4211 Vlast_event_frame
= internal_last_event_frame
;
4216 /* Process any events that are not user-visible,
4217 then return, without reading any user-visible events. */
4220 swallow_events (do_display
)
4225 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4227 struct input_event
*event
;
4229 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4233 last_event_timestamp
= event
->timestamp
;
4235 /* These two kinds of events get special handling
4236 and don't actually appear to the command loop. */
4237 if (event
->kind
== SELECTION_REQUEST_EVENT
4238 || event
->kind
== SELECTION_CLEAR_EVENT
)
4241 struct input_event copy
;
4243 /* Remove it from the buffer before processing it,
4244 since otherwise swallow_events called recursively could see it
4245 and process it again. */
4247 kbd_fetch_ptr
= event
+ 1;
4248 input_pending
= readable_events (0);
4249 x_handle_selection_event (©
);
4251 /* We're getting selection request events, but we don't have
4260 old_timers_run
= timers_run
;
4261 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4263 if (timers_run
!= old_timers_run
&& do_display
)
4264 redisplay_preserve_echo_area (7);
4267 /* Record the start of when Emacs is idle,
4268 for the sake of running idle-time timers. */
4275 /* If we are already in the idle state, do nothing. */
4276 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4279 EMACS_GET_TIME (timer_idleness_start_time
);
4281 timer_last_idleness_start_time
= timer_idleness_start_time
;
4283 /* Mark all idle-time timers as once again candidates for running. */
4284 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4288 timer
= XCAR (timers
);
4290 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4292 XVECTOR (timer
)->contents
[0] = Qnil
;
4296 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4301 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4304 /* Resume idle timer from last idle start time. */
4307 timer_resume_idle ()
4309 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4312 timer_idleness_start_time
= timer_last_idleness_start_time
;
4315 /* This is only for debugging. */
4316 struct input_event last_timer_event
;
4318 /* Check whether a timer has fired. To prevent larger problems we simply
4319 disregard elements that are not proper timers. Do not make a circular
4320 timer list for the time being.
4322 Returns the number of seconds to wait until the next timer fires. If a
4323 timer is triggering now, return zero seconds.
4324 If no timer is active, return -1 seconds.
4326 If a timer is ripe, we run it, with quitting turned off.
4328 DO_IT_NOW is now ignored. It used to mean that we should
4329 run the timer directly instead of queueing a timer-event.
4330 Now we always run timers directly. */
4333 timer_check (do_it_now
)
4336 EMACS_TIME nexttime
;
4337 EMACS_TIME now
, idleness_now
;
4338 Lisp_Object timers
, idle_timers
, chosen_timer
;
4339 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4341 EMACS_SET_SECS (nexttime
, -1);
4342 EMACS_SET_USECS (nexttime
, -1);
4344 /* Always consider the ordinary timers. */
4345 timers
= Vtimer_list
;
4346 /* Consider the idle timers only if Emacs is idle. */
4347 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4348 idle_timers
= Vtimer_idle_list
;
4351 chosen_timer
= Qnil
;
4352 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4354 if (CONSP (timers
) || CONSP (idle_timers
))
4356 EMACS_GET_TIME (now
);
4357 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4358 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4361 while (CONSP (timers
) || CONSP (idle_timers
))
4363 Lisp_Object
*vector
;
4364 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4365 EMACS_TIME timer_time
, idle_timer_time
;
4366 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4368 /* Skip past invalid timers and timers already handled. */
4371 timer
= XCAR (timers
);
4372 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4374 timers
= XCDR (timers
);
4377 vector
= XVECTOR (timer
)->contents
;
4379 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4380 || !INTEGERP (vector
[3])
4381 || ! NILP (vector
[0]))
4383 timers
= XCDR (timers
);
4387 if (!NILP (idle_timers
))
4389 timer
= XCAR (idle_timers
);
4390 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4392 idle_timers
= XCDR (idle_timers
);
4395 vector
= XVECTOR (timer
)->contents
;
4397 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4398 || !INTEGERP (vector
[3])
4399 || ! NILP (vector
[0]))
4401 idle_timers
= XCDR (idle_timers
);
4406 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4407 based on the next ordinary timer.
4408 TIMER_DIFFERENCE is the distance in time from NOW to when
4409 this timer becomes ripe (negative if it's already ripe). */
4412 timer
= XCAR (timers
);
4413 vector
= XVECTOR (timer
)->contents
;
4414 EMACS_SET_SECS (timer_time
,
4415 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4416 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4417 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4420 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4421 based on the next idle timer. */
4422 if (!NILP (idle_timers
))
4424 idle_timer
= XCAR (idle_timers
);
4425 vector
= XVECTOR (idle_timer
)->contents
;
4426 EMACS_SET_SECS (idle_timer_time
,
4427 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4428 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4429 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4432 /* Decide which timer is the next timer,
4433 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4434 Also step down the list where we found that timer. */
4436 if (! NILP (timers
) && ! NILP (idle_timers
))
4439 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4440 if (EMACS_TIME_NEG_P (temp
))
4442 chosen_timer
= timer
;
4443 timers
= XCDR (timers
);
4444 difference
= timer_difference
;
4448 chosen_timer
= idle_timer
;
4449 idle_timers
= XCDR (idle_timers
);
4450 difference
= idle_timer_difference
;
4453 else if (! NILP (timers
))
4455 chosen_timer
= timer
;
4456 timers
= XCDR (timers
);
4457 difference
= timer_difference
;
4461 chosen_timer
= idle_timer
;
4462 idle_timers
= XCDR (idle_timers
);
4463 difference
= idle_timer_difference
;
4465 vector
= XVECTOR (chosen_timer
)->contents
;
4467 /* If timer is ripe, run it if it hasn't been run. */
4468 if (EMACS_TIME_NEG_P (difference
)
4469 || (EMACS_SECS (difference
) == 0
4470 && EMACS_USECS (difference
) == 0))
4472 if (NILP (vector
[0]))
4474 int was_locked
= single_kboard
;
4475 int count
= SPECPDL_INDEX ();
4476 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4478 /* Mark the timer as triggered to prevent problems if the lisp
4479 code fails to reschedule it right. */
4482 specbind (Qinhibit_quit
, Qt
);
4484 call1 (Qtimer_event_handler
, chosen_timer
);
4485 Vdeactivate_mark
= old_deactivate_mark
;
4487 unbind_to (count
, Qnil
);
4489 /* Resume allowing input from any kboard, if that was true before. */
4491 any_kboard_state ();
4493 /* Since we have handled the event,
4494 we don't need to tell the caller to wake up and do it. */
4498 /* When we encounter a timer that is still waiting,
4499 return the amount of time to wait before it is ripe. */
4506 /* No timers are pending in the future. */
4507 /* Return 0 if we generated an event, and -1 if not. */
4512 /* Caches for modify_event_symbol. */
4513 static Lisp_Object accent_key_syms
;
4514 static Lisp_Object func_key_syms
;
4515 static Lisp_Object mouse_syms
;
4516 static Lisp_Object wheel_syms
;
4517 static Lisp_Object drag_n_drop_syms
;
4519 /* This is a list of keysym codes for special "accent" characters.
4520 It parallels lispy_accent_keys. */
4522 static int lispy_accent_codes
[] =
4524 #ifdef XK_dead_circumflex
4529 #ifdef XK_dead_grave
4534 #ifdef XK_dead_tilde
4539 #ifdef XK_dead_diaeresis
4544 #ifdef XK_dead_macron
4549 #ifdef XK_dead_degree
4554 #ifdef XK_dead_acute
4559 #ifdef XK_dead_cedilla
4564 #ifdef XK_dead_breve
4569 #ifdef XK_dead_ogonek
4574 #ifdef XK_dead_caron
4579 #ifdef XK_dead_doubleacute
4580 XK_dead_doubleacute
,
4584 #ifdef XK_dead_abovedot
4589 #ifdef XK_dead_abovering
4599 #ifdef XK_dead_belowdot
4604 #ifdef XK_dead_voiced_sound
4605 XK_dead_voiced_sound
,
4609 #ifdef XK_dead_semivoiced_sound
4610 XK_dead_semivoiced_sound
,
4626 /* This is a list of Lisp names for special "accent" characters.
4627 It parallels lispy_accent_codes. */
4629 static char *lispy_accent_keys
[] =
4647 "dead-voiced-sound",
4648 "dead-semivoiced-sound",
4654 #define FUNCTION_KEY_OFFSET 0x0
4656 char *lispy_function_keys
[] =
4660 0, /* VK_LBUTTON 0x01 */
4661 0, /* VK_RBUTTON 0x02 */
4662 "cancel", /* VK_CANCEL 0x03 */
4663 0, /* VK_MBUTTON 0x04 */
4665 0, 0, 0, /* 0x05 .. 0x07 */
4667 "backspace", /* VK_BACK 0x08 */
4668 "tab", /* VK_TAB 0x09 */
4670 0, 0, /* 0x0A .. 0x0B */
4672 "clear", /* VK_CLEAR 0x0C */
4673 "return", /* VK_RETURN 0x0D */
4675 0, 0, /* 0x0E .. 0x0F */
4677 0, /* VK_SHIFT 0x10 */
4678 0, /* VK_CONTROL 0x11 */
4679 0, /* VK_MENU 0x12 */
4680 "pause", /* VK_PAUSE 0x13 */
4681 "capslock", /* VK_CAPITAL 0x14 */
4683 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4685 "escape", /* VK_ESCAPE 0x1B */
4687 0, 0, 0, 0, /* 0x1C .. 0x1F */
4689 0, /* VK_SPACE 0x20 */
4690 "prior", /* VK_PRIOR 0x21 */
4691 "next", /* VK_NEXT 0x22 */
4692 "end", /* VK_END 0x23 */
4693 "home", /* VK_HOME 0x24 */
4694 "left", /* VK_LEFT 0x25 */
4695 "up", /* VK_UP 0x26 */
4696 "right", /* VK_RIGHT 0x27 */
4697 "down", /* VK_DOWN 0x28 */
4698 "select", /* VK_SELECT 0x29 */
4699 "print", /* VK_PRINT 0x2A */
4700 "execute", /* VK_EXECUTE 0x2B */
4701 "snapshot", /* VK_SNAPSHOT 0x2C */
4702 "insert", /* VK_INSERT 0x2D */
4703 "delete", /* VK_DELETE 0x2E */
4704 "help", /* VK_HELP 0x2F */
4706 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4708 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4710 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4712 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4714 0, 0, 0, 0, 0, 0, 0, 0, 0,
4715 0, 0, 0, 0, 0, 0, 0, 0, 0,
4716 0, 0, 0, 0, 0, 0, 0, 0,
4718 "lwindow", /* VK_LWIN 0x5B */
4719 "rwindow", /* VK_RWIN 0x5C */
4720 "apps", /* VK_APPS 0x5D */
4722 0, 0, /* 0x5E .. 0x5F */
4724 "kp-0", /* VK_NUMPAD0 0x60 */
4725 "kp-1", /* VK_NUMPAD1 0x61 */
4726 "kp-2", /* VK_NUMPAD2 0x62 */
4727 "kp-3", /* VK_NUMPAD3 0x63 */
4728 "kp-4", /* VK_NUMPAD4 0x64 */
4729 "kp-5", /* VK_NUMPAD5 0x65 */
4730 "kp-6", /* VK_NUMPAD6 0x66 */
4731 "kp-7", /* VK_NUMPAD7 0x67 */
4732 "kp-8", /* VK_NUMPAD8 0x68 */
4733 "kp-9", /* VK_NUMPAD9 0x69 */
4734 "kp-multiply", /* VK_MULTIPLY 0x6A */
4735 "kp-add", /* VK_ADD 0x6B */
4736 "kp-separator", /* VK_SEPARATOR 0x6C */
4737 "kp-subtract", /* VK_SUBTRACT 0x6D */
4738 "kp-decimal", /* VK_DECIMAL 0x6E */
4739 "kp-divide", /* VK_DIVIDE 0x6F */
4740 "f1", /* VK_F1 0x70 */
4741 "f2", /* VK_F2 0x71 */
4742 "f3", /* VK_F3 0x72 */
4743 "f4", /* VK_F4 0x73 */
4744 "f5", /* VK_F5 0x74 */
4745 "f6", /* VK_F6 0x75 */
4746 "f7", /* VK_F7 0x76 */
4747 "f8", /* VK_F8 0x77 */
4748 "f9", /* VK_F9 0x78 */
4749 "f10", /* VK_F10 0x79 */
4750 "f11", /* VK_F11 0x7A */
4751 "f12", /* VK_F12 0x7B */
4752 "f13", /* VK_F13 0x7C */
4753 "f14", /* VK_F14 0x7D */
4754 "f15", /* VK_F15 0x7E */
4755 "f16", /* VK_F16 0x7F */
4756 "f17", /* VK_F17 0x80 */
4757 "f18", /* VK_F18 0x81 */
4758 "f19", /* VK_F19 0x82 */
4759 "f20", /* VK_F20 0x83 */
4760 "f21", /* VK_F21 0x84 */
4761 "f22", /* VK_F22 0x85 */
4762 "f23", /* VK_F23 0x86 */
4763 "f24", /* VK_F24 0x87 */
4765 0, 0, 0, 0, /* 0x88 .. 0x8B */
4766 0, 0, 0, 0, /* 0x8C .. 0x8F */
4768 "kp-numlock", /* VK_NUMLOCK 0x90 */
4769 "scroll", /* VK_SCROLL 0x91 */
4771 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4772 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4773 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4774 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4775 "kp-end", /* VK_NUMPAD_END 0x96 */
4776 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4777 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4778 "kp-up", /* VK_NUMPAD_UP 0x99 */
4779 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4780 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4781 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4782 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4784 0, 0, /* 0x9E .. 0x9F */
4787 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4788 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4789 * No other API or message will distinguish left and right keys this way.
4793 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4794 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4795 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4796 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4797 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4803 "attn", /* VK_ATTN 0xF6 */
4804 "crsel", /* VK_CRSEL 0xF7 */
4805 "exsel", /* VK_EXSEL 0xF8 */
4806 "ereof", /* VK_EREOF 0xF9 */
4807 "play", /* VK_PLAY 0xFA */
4808 "zoom", /* VK_ZOOM 0xFB */
4809 "noname", /* VK_NONAME 0xFC */
4810 "pa1", /* VK_PA1 0xFD */
4811 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4815 #else /* not HAVE_NTGUI */
4817 /* This should be dealt with in XTread_socket now, and that doesn't
4818 depend on the client system having the Kana syms defined. See also
4819 the XK_kana_A case below. */
4822 static char *lispy_kana_keys
[] =
4824 /* X Keysym value */
4825 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4826 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4827 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4828 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4829 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4830 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4831 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4832 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4833 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4834 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4835 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4836 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4837 "kana-i", "kana-u", "kana-e", "kana-o",
4838 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4839 "prolongedsound", "kana-A", "kana-I", "kana-U",
4840 "kana-E", "kana-O", "kana-KA", "kana-KI",
4841 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4842 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4843 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4844 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4845 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4846 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4847 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4848 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4849 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4850 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4851 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4852 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4854 #endif /* XK_kana_A */
4857 #define FUNCTION_KEY_OFFSET 0xff00
4859 /* You'll notice that this table is arranged to be conveniently
4860 indexed by X Windows keysym values. */
4861 static char *lispy_function_keys
[] =
4863 /* X Keysym value */
4865 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4866 "backspace", "tab", "linefeed", "clear",
4868 0, 0, 0, "pause", /* 0xff10...1f */
4869 0, 0, 0, 0, 0, 0, 0, "escape",
4871 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4872 "romaji", "hiragana", "katakana", "hiragana-katakana",
4873 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4874 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4875 "eisu-toggle", /* 0xff30...3f */
4876 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4877 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4879 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4880 "down", "prior", "next", "end",
4881 "begin", 0, 0, 0, 0, 0, 0, 0,
4882 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4893 "break", /* 0xff6b */
4896 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4897 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4898 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4899 0, 0, 0, 0, 0, 0, 0, 0,
4900 "kp-tab", /* 0xff89 */
4902 "kp-enter", /* 0xff8d */
4904 "kp-f1", /* 0xff91 */
4908 "kp-home", /* 0xff95 */
4913 "kp-prior", /* kp-page-up */
4914 "kp-next", /* kp-page-down */
4920 0, 0, 0, 0, 0, 0, 0, 0, 0,
4921 "kp-multiply", /* 0xffaa */
4926 "kp-divide", /* 0xffaf */
4927 "kp-0", /* 0xffb0 */
4928 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4931 "kp-equal", /* 0xffbd */
4932 "f1", /* 0xffbe */ /* IsFunctionKey */
4934 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4935 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4936 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4937 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4938 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4939 0, 0, 0, 0, 0, 0, 0, 0,
4940 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4941 0, 0, 0, 0, 0, 0, 0, "delete"
4944 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4945 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4947 static char *iso_lispy_function_keys
[] =
4949 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4950 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4951 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4952 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4953 "iso-lefttab", /* 0xfe20 */
4954 "iso-move-line-up", "iso-move-line-down",
4955 "iso-partial-line-up", "iso-partial-line-down",
4956 "iso-partial-space-left", "iso-partial-space-right",
4957 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4958 "iso-release-margin-left", "iso-release-margin-right",
4959 "iso-release-both-margins",
4960 "iso-fast-cursor-left", "iso-fast-cursor-right",
4961 "iso-fast-cursor-up", "iso-fast-cursor-down",
4962 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4963 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4966 #endif /* not HAVE_NTGUI */
4968 Lisp_Object Vlispy_mouse_stem
;
4970 static char *lispy_wheel_names
[] =
4972 "wheel-up", "wheel-down"
4975 /* drag-n-drop events are generated when a set of selected files are
4976 dragged from another application and dropped onto an Emacs window. */
4977 static char *lispy_drag_n_drop_names
[] =
4982 /* Scroll bar parts. */
4983 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4984 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4985 Lisp_Object Qtop
, Qratio
;
4987 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4988 Lisp_Object
*scroll_bar_parts
[] = {
4989 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4990 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4993 /* User signal events. */
4994 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4996 Lisp_Object
*lispy_user_signals
[] =
4998 &Qusr1_signal
, &Qusr2_signal
5002 /* A vector, indexed by button number, giving the down-going location
5003 of currently depressed buttons, both scroll bar and non-scroll bar.
5005 The elements have the form
5006 (BUTTON-NUMBER MODIFIER-MASK . REST)
5007 where REST is the cdr of a position as it would be reported in the event.
5009 The make_lispy_event function stores positions here to tell the
5010 difference between click and drag events, and to store the starting
5011 location to be included in drag events. */
5013 static Lisp_Object button_down_location
;
5015 /* Information about the most recent up-going button event: Which
5016 button, what location, and what time. */
5018 static int last_mouse_button
;
5019 static int last_mouse_x
;
5020 static int last_mouse_y
;
5021 static unsigned long button_down_time
;
5023 /* The maximum time between clicks to make a double-click, or Qnil to
5024 disable double-click detection, or Qt for no time limit. */
5026 Lisp_Object Vdouble_click_time
;
5028 /* Maximum number of pixels the mouse may be moved between clicks
5029 to make a double-click. */
5031 EMACS_INT double_click_fuzz
;
5033 /* The number of clicks in this multiple-click. */
5035 int double_click_count
;
5037 /* Return position of a mouse click or wheel event */
5040 make_lispy_position (f
, x
, y
, time
)
5046 enum window_part part
;
5047 Lisp_Object posn
= Qnil
;
5048 Lisp_Object extra_info
= Qnil
;
5051 /* Set `window' to the window under frame pixel coordinates (x,y) */
5053 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5054 &part
, &wx
, &wy
, 0);
5058 if (WINDOWP (window
))
5060 /* It's a click in window window at frame coordinates (x,y) */
5061 struct window
*w
= XWINDOW (window
);
5062 Lisp_Object string_info
= Qnil
;
5063 int textpos
= -1, rx
= -1, ry
= -1;
5064 int dx
= -1, dy
= -1;
5065 int width
= -1, height
= -1;
5066 Lisp_Object object
= Qnil
;
5068 /* Set event coordinates to window-relative coordinates
5069 for constructing the Lisp event below. */
5073 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5075 /* Mode line or header line. Look for a string under
5076 the mouse that may have a `local-map' property. */
5080 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5082 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5083 &object
, &dx
, &dy
, &width
, &height
);
5084 if (STRINGP (string
))
5085 string_info
= Fcons (string
, make_number (charpos
));
5086 if (w
== XWINDOW (selected_window
))
5089 textpos
= XMARKER (w
->pointm
)->charpos
;
5091 else if (part
== ON_VERTICAL_BORDER
)
5093 posn
= Qvertical_line
;
5098 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5103 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5105 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5106 &object
, &dx
, &dy
, &width
, &height
);
5107 if (STRINGP (string
))
5108 string_info
= Fcons (string
, make_number (charpos
));
5110 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5112 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5115 if (part
== ON_RIGHT_FRINGE
)
5116 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5117 + window_box_width (w
, TEXT_AREA
)
5118 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5119 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5121 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5122 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5127 Lisp_Object string2
, object2
= Qnil
;
5128 struct display_pos p
;
5130 int width2
, height2
;
5131 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5132 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5133 &object2
, &dx2
, &dy2
,
5135 textpos
= CHARPOS (p
.pos
);
5136 if (rx
< 0) rx
= wx
;
5137 if (ry
< 0) ry
= wy
;
5138 if (dx
< 0) dx
= dx2
;
5139 if (dy
< 0) dy
= dy2
;
5140 if (width
< 0) width
= width2
;
5141 if (height
< 0) height
= height2
;
5145 posn
= make_number (textpos
);
5146 if (STRINGP (string2
))
5147 string_info
= Fcons (string2
,
5148 make_number (CHARPOS (p
.string_pos
)));
5154 #ifdef HAVE_WINDOW_SYSTEM
5155 if (IMAGEP (object
))
5157 Lisp_Object image_map
, hotspot
;
5158 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5160 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5162 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5163 posn
= XCAR (hotspot
);
5168 extra_info
= Fcons (object
,
5169 Fcons (Fcons (make_number (dx
),
5171 Fcons (Fcons (make_number (width
),
5172 make_number (height
)),
5176 extra_info
= Fcons (string_info
,
5177 Fcons (make_number (textpos
),
5178 Fcons (Fcons (make_number (rx
),
5184 XSETFRAME (window
, f
);
5189 XSETFASTINT (*x
, 0);
5190 XSETFASTINT (*y
, 0);
5193 return Fcons (window
,
5195 Fcons (Fcons (*x
, *y
),
5196 Fcons (make_number (time
),
5200 /* Given a struct input_event, build the lisp event which represents
5201 it. If EVENT is 0, build a mouse movement event from the mouse
5202 movement buffer, which should have a movement event in it.
5204 Note that events must be passed to this function in the order they
5205 are received; this function stores the location of button presses
5206 in order to build drag events when the button is released. */
5209 make_lispy_event (event
)
5210 struct input_event
*event
;
5214 switch (SWITCH_ENUM_CAST (event
->kind
))
5216 /* A simple keystroke. */
5217 case ASCII_KEYSTROKE_EVENT
:
5219 Lisp_Object lispy_c
;
5220 int c
= event
->code
& 0377;
5221 /* Turn ASCII characters into control characters
5223 if (event
->modifiers
& ctrl_modifier
)
5224 c
= make_ctrl_char (c
);
5226 /* Add in the other modifier bits. We took care of ctrl_modifier
5227 just above, and the shift key was taken care of by the X code,
5228 and applied to control characters by make_ctrl_char. */
5229 c
|= (event
->modifiers
5230 & (meta_modifier
| alt_modifier
5231 | hyper_modifier
| super_modifier
));
5232 /* Distinguish Shift-SPC from SPC. */
5233 if ((event
->code
& 0377) == 040
5234 && event
->modifiers
& shift_modifier
)
5235 c
|= shift_modifier
;
5236 button_down_time
= 0;
5237 XSETFASTINT (lispy_c
, c
);
5241 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5243 Lisp_Object lispy_c
;
5244 int c
= event
->code
;
5246 /* Add in the other modifier bits. We took care of ctrl_modifier
5247 just above, and the shift key was taken care of by the X code,
5248 and applied to control characters by make_ctrl_char. */
5249 c
|= (event
->modifiers
5250 & (meta_modifier
| alt_modifier
5251 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5252 /* What about the `shift' modifier ? */
5253 button_down_time
= 0;
5254 XSETFASTINT (lispy_c
, c
);
5258 /* A function key. The symbol may need to have modifier prefixes
5260 case NON_ASCII_KEYSTROKE_EVENT
:
5261 button_down_time
= 0;
5263 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5264 if (event
->code
== lispy_accent_codes
[i
])
5265 return modify_event_symbol (i
,
5267 Qfunction_key
, Qnil
,
5268 lispy_accent_keys
, &accent_key_syms
,
5269 (sizeof (lispy_accent_keys
)
5270 / sizeof (lispy_accent_keys
[0])));
5274 if (event
->code
>= 0x400 && event
->code
< 0x500)
5275 return modify_event_symbol (event
->code
- 0x400,
5276 event
->modifiers
& ~shift_modifier
,
5277 Qfunction_key
, Qnil
,
5278 lispy_kana_keys
, &func_key_syms
,
5279 (sizeof (lispy_kana_keys
)
5280 / sizeof (lispy_kana_keys
[0])));
5281 #endif /* XK_kana_A */
5284 #ifdef ISO_FUNCTION_KEY_OFFSET
5285 if (event
->code
< FUNCTION_KEY_OFFSET
5286 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5287 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5289 Qfunction_key
, Qnil
,
5290 iso_lispy_function_keys
, &func_key_syms
,
5291 (sizeof (iso_lispy_function_keys
)
5292 / sizeof (iso_lispy_function_keys
[0])));
5295 /* Handle system-specific or unknown keysyms. */
5296 if (event
->code
& (1 << 28)
5297 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5298 || (event
->code
- FUNCTION_KEY_OFFSET
5299 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5300 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5302 /* We need to use an alist rather than a vector as the cache
5303 since we can't make a vector long enuf. */
5304 if (NILP (current_kboard
->system_key_syms
))
5305 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5306 return modify_event_symbol (event
->code
,
5309 current_kboard
->Vsystem_key_alist
,
5310 0, ¤t_kboard
->system_key_syms
,
5314 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5316 Qfunction_key
, Qnil
,
5317 lispy_function_keys
, &func_key_syms
,
5318 (sizeof (lispy_function_keys
)
5319 / sizeof (lispy_function_keys
[0])));
5322 /* A mouse click. Figure out where it is, decide whether it's
5323 a press, click or drag, and build the appropriate structure. */
5324 case MOUSE_CLICK_EVENT
:
5325 #ifndef USE_TOOLKIT_SCROLL_BARS
5326 case SCROLL_BAR_CLICK_EVENT
:
5329 int button
= event
->code
;
5331 Lisp_Object position
;
5332 Lisp_Object
*start_pos_ptr
;
5333 Lisp_Object start_pos
;
5337 /* Build the position as appropriate for this mouse click. */
5338 if (event
->kind
== MOUSE_CLICK_EVENT
)
5340 struct frame
*f
= XFRAME (event
->frame_or_window
);
5341 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5345 /* Ignore mouse events that were made on frame that
5346 have been deleted. */
5347 if (! FRAME_LIVE_P (f
))
5350 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5351 /* EVENT->x and EVENT->y are frame-relative pixel
5352 coordinates at this place. Under old redisplay, COLUMN
5353 and ROW are set to frame relative glyph coordinates
5354 which are then used to determine whether this click is
5355 in a menu (non-toolkit version). */
5356 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5357 &column
, &row
, NULL
, 1);
5359 /* In the non-toolkit version, clicks on the menu bar
5360 are ordinary button events in the event buffer.
5361 Distinguish them, and invoke the menu.
5363 (In the toolkit version, the toolkit handles the menu bar
5364 and Emacs doesn't know about it until after the user
5365 makes a selection.) */
5366 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5367 && (event
->modifiers
& down_modifier
))
5369 Lisp_Object items
, item
;
5374 /* Activate the menu bar on the down event. If the
5375 up event comes in before the menu code can deal with it,
5377 if (! (event
->modifiers
& down_modifier
))
5381 /* Find the menu bar item under `column'. */
5383 items
= FRAME_MENU_BAR_ITEMS (f
);
5384 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5386 Lisp_Object pos
, string
;
5387 string
= AREF (items
, i
+ 1);
5388 pos
= AREF (items
, i
+ 3);
5391 if (column
>= XINT (pos
)
5392 && column
< XINT (pos
) + SCHARS (string
))
5394 item
= AREF (items
, i
);
5399 /* ELisp manual 2.4b says (x y) are window relative but
5400 code says they are frame-relative. */
5402 = Fcons (event
->frame_or_window
,
5404 Fcons (Fcons (event
->x
, event
->y
),
5405 Fcons (make_number (event
->timestamp
),
5408 return Fcons (item
, Fcons (position
, Qnil
));
5410 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5412 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5415 #ifndef USE_TOOLKIT_SCROLL_BARS
5418 /* It's a scrollbar click. */
5420 Lisp_Object portion_whole
;
5423 window
= event
->frame_or_window
;
5424 portion_whole
= Fcons (event
->x
, event
->y
);
5425 part
= *scroll_bar_parts
[(int) event
->part
];
5429 Fcons (Qvertical_scroll_bar
,
5430 Fcons (portion_whole
,
5431 Fcons (make_number (event
->timestamp
),
5432 Fcons (part
, Qnil
)))));
5434 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5436 if (button
>= ASIZE (button_down_location
))
5438 button_down_location
= larger_vector (button_down_location
,
5440 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5443 start_pos_ptr
= &AREF (button_down_location
, button
);
5444 start_pos
= *start_pos_ptr
;
5445 *start_pos_ptr
= Qnil
;
5448 /* On window-system frames, use the value of
5449 double-click-fuzz as is. On other frames, interpret it
5450 as a multiple of 1/8 characters. */
5454 if (WINDOWP (event
->frame_or_window
))
5455 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5456 else if (FRAMEP (event
->frame_or_window
))
5457 f
= XFRAME (event
->frame_or_window
);
5461 if (FRAME_WINDOW_P (f
))
5462 fuzz
= double_click_fuzz
;
5464 fuzz
= double_click_fuzz
/ 8;
5466 is_double
= (button
== last_mouse_button
5467 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5468 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5469 && button_down_time
!= 0
5470 && (EQ (Vdouble_click_time
, Qt
)
5471 || (INTEGERP (Vdouble_click_time
)
5472 && ((int)(event
->timestamp
- button_down_time
)
5473 < XINT (Vdouble_click_time
)))));
5476 last_mouse_button
= button
;
5477 last_mouse_x
= XINT (event
->x
);
5478 last_mouse_y
= XINT (event
->y
);
5480 /* If this is a button press, squirrel away the location, so
5481 we can decide later whether it was a click or a drag. */
5482 if (event
->modifiers
& down_modifier
)
5486 double_click_count
++;
5487 event
->modifiers
|= ((double_click_count
> 2)
5492 double_click_count
= 1;
5493 button_down_time
= event
->timestamp
;
5494 *start_pos_ptr
= Fcopy_alist (position
);
5497 /* Now we're releasing a button - check the co-ordinates to
5498 see if this was a click or a drag. */
5499 else if (event
->modifiers
& up_modifier
)
5501 /* If we did not see a down before this up, ignore the up.
5502 Probably this happened because the down event chose a
5503 menu item. It would be an annoyance to treat the
5504 release of the button that chose the menu item as a
5507 if (!CONSP (start_pos
))
5510 event
->modifiers
&= ~up_modifier
;
5511 #if 0 /* Formerly we treated an up with no down as a click event. */
5512 if (!CONSP (start_pos
))
5513 event
->modifiers
|= click_modifier
;
5518 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5520 /* The third element of every position
5521 should be the (x,y) pair. */
5522 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5524 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5526 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5527 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5530 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5531 && ydiff
< double_click_fuzz
5532 && ydiff
> - double_click_fuzz
)
5533 /* Mouse hasn't moved (much). */
5534 event
->modifiers
|= click_modifier
;
5537 button_down_time
= 0;
5538 event
->modifiers
|= drag_modifier
;
5541 /* Don't check is_double; treat this as multiple
5542 if the down-event was multiple. */
5543 if (double_click_count
> 1)
5544 event
->modifiers
|= ((double_click_count
> 2)
5550 /* Every mouse event should either have the down_modifier or
5551 the up_modifier set. */
5555 /* Get the symbol we should use for the mouse click. */
5558 head
= modify_event_symbol (button
,
5560 Qmouse_click
, Vlispy_mouse_stem
,
5563 XVECTOR (mouse_syms
)->size
);
5564 if (event
->modifiers
& drag_modifier
)
5569 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5572 Fcons (make_number (double_click_count
),
5583 Lisp_Object position
;
5586 /* Build the position as appropriate for this mouse click. */
5587 struct frame
*f
= XFRAME (event
->frame_or_window
);
5589 /* Ignore wheel events that were made on frame that have been
5591 if (! FRAME_LIVE_P (f
))
5594 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5597 /* Set double or triple modifiers to indicate the wheel speed. */
5599 /* On window-system frames, use the value of
5600 double-click-fuzz as is. On other frames, interpret it
5601 as a multiple of 1/8 characters. */
5606 if (WINDOWP (event
->frame_or_window
))
5607 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5608 else if (FRAMEP (event
->frame_or_window
))
5609 f
= XFRAME (event
->frame_or_window
);
5613 if (FRAME_WINDOW_P (f
))
5614 fuzz
= double_click_fuzz
;
5616 fuzz
= double_click_fuzz
/ 8;
5618 is_double
= (last_mouse_button
< 0
5619 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5620 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5621 && button_down_time
!= 0
5622 && (EQ (Vdouble_click_time
, Qt
)
5623 || (INTEGERP (Vdouble_click_time
)
5624 && ((int)(event
->timestamp
- button_down_time
)
5625 < XINT (Vdouble_click_time
)))));
5628 double_click_count
++;
5629 event
->modifiers
|= ((double_click_count
> 2)
5635 double_click_count
= 1;
5636 event
->modifiers
|= click_modifier
;
5639 button_down_time
= event
->timestamp
;
5640 /* Use a negative value to distinguish wheel from mouse button. */
5641 last_mouse_button
= -1;
5642 last_mouse_x
= XINT (event
->x
);
5643 last_mouse_y
= XINT (event
->y
);
5649 if (event
->modifiers
& up_modifier
)
5651 /* Emit a wheel-up event. */
5652 event
->modifiers
&= ~up_modifier
;
5655 else if (event
->modifiers
& down_modifier
)
5657 /* Emit a wheel-down event. */
5658 event
->modifiers
&= ~down_modifier
;
5662 /* Every wheel event should either have the down_modifier or
5663 the up_modifier set. */
5666 /* Get the symbol we should use for the wheel event. */
5667 head
= modify_event_symbol (symbol_num
,
5673 ASIZE (wheel_syms
));
5676 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5679 Fcons (make_number (double_click_count
),
5688 #ifdef USE_TOOLKIT_SCROLL_BARS
5690 /* We don't have down and up events if using toolkit scroll bars,
5691 so make this always a click event. Store in the `part' of
5692 the Lisp event a symbol which maps to the following actions:
5694 `above_handle' page up
5695 `below_handle' page down
5699 `bottom' bottom of buffer
5700 `handle' thumb has been dragged.
5701 `end-scroll' end of interaction with scroll bar
5703 The incoming input_event contains in its `part' member an
5704 index of type `enum scroll_bar_part' which we can use as an
5705 index in scroll_bar_parts to get the appropriate symbol. */
5707 case SCROLL_BAR_CLICK_EVENT
:
5709 Lisp_Object position
, head
, window
, portion_whole
, part
;
5711 window
= event
->frame_or_window
;
5712 portion_whole
= Fcons (event
->x
, event
->y
);
5713 part
= *scroll_bar_parts
[(int) event
->part
];
5717 Fcons (Qvertical_scroll_bar
,
5718 Fcons (portion_whole
,
5719 Fcons (make_number (event
->timestamp
),
5720 Fcons (part
, Qnil
)))));
5722 /* Always treat scroll bar events as clicks. */
5723 event
->modifiers
|= click_modifier
;
5724 event
->modifiers
&= ~up_modifier
;
5726 if (event
->code
>= ASIZE (mouse_syms
))
5727 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5729 /* Get the symbol we should use for the mouse click. */
5730 head
= modify_event_symbol (event
->code
,
5735 XVECTOR (mouse_syms
)->size
);
5736 return Fcons (head
, Fcons (position
, Qnil
));
5739 #endif /* USE_TOOLKIT_SCROLL_BARS */
5742 case W32_SCROLL_BAR_CLICK_EVENT
:
5744 int button
= event
->code
;
5746 Lisp_Object position
;
5747 Lisp_Object
*start_pos_ptr
;
5748 Lisp_Object start_pos
;
5752 Lisp_Object portion_whole
;
5755 window
= event
->frame_or_window
;
5756 portion_whole
= Fcons (event
->x
, event
->y
);
5757 part
= *scroll_bar_parts
[(int) event
->part
];
5761 Fcons (Qvertical_scroll_bar
,
5762 Fcons (portion_whole
,
5763 Fcons (make_number (event
->timestamp
),
5764 Fcons (part
, Qnil
)))));
5767 /* Always treat W32 scroll bar events as clicks. */
5768 event
->modifiers
|= click_modifier
;
5771 /* Get the symbol we should use for the mouse click. */
5774 head
= modify_event_symbol (button
,
5779 XVECTOR (mouse_syms
)->size
);
5785 #endif /* WINDOWSNT */
5787 case DRAG_N_DROP_EVENT
:
5790 Lisp_Object head
, position
;
5793 /* The frame_or_window field should be a cons of the frame in
5794 which the event occurred and a list of the filenames
5796 if (! CONSP (event
->frame_or_window
))
5799 f
= XFRAME (XCAR (event
->frame_or_window
));
5800 files
= XCDR (event
->frame_or_window
);
5802 /* Ignore mouse events that were made on frames that
5803 have been deleted. */
5804 if (! FRAME_LIVE_P (f
))
5807 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5810 head
= modify_event_symbol (0, event
->modifiers
,
5812 lispy_drag_n_drop_names
,
5813 &drag_n_drop_syms
, 1);
5819 #endif /* HAVE_MOUSE */
5821 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5822 || defined (USE_GTK)
5823 case MENU_BAR_EVENT
:
5824 if (EQ (event
->arg
, event
->frame_or_window
))
5825 /* This is the prefix key. We translate this to
5826 `(menu_bar)' because the code in keyboard.c for menu
5827 events, which we use, relies on this. */
5828 return Fcons (Qmenu_bar
, Qnil
);
5832 case SELECT_WINDOW_EVENT
:
5833 /* Make an event (select-window (WINDOW)). */
5834 return Fcons (Qselect_window
,
5835 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5838 case TOOL_BAR_EVENT
:
5839 if (EQ (event
->arg
, event
->frame_or_window
))
5840 /* This is the prefix key. We translate this to
5841 `(tool_bar)' because the code in keyboard.c for tool bar
5842 events, which we use, relies on this. */
5843 return Fcons (Qtool_bar
, Qnil
);
5844 else if (SYMBOLP (event
->arg
))
5845 return apply_modifiers (event
->modifiers
, event
->arg
);
5848 case USER_SIGNAL_EVENT
:
5849 /* A user signal. */
5850 return *lispy_user_signals
[event
->code
];
5852 case SAVE_SESSION_EVENT
:
5853 return Qsave_session
;
5855 /* The 'kind' field of the event is something we don't recognize. */
5864 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5866 Lisp_Object bar_window
;
5867 enum scroll_bar_part part
;
5871 /* Is it a scroll bar movement? */
5872 if (frame
&& ! NILP (bar_window
))
5874 Lisp_Object part_sym
;
5876 part_sym
= *scroll_bar_parts
[(int) part
];
5877 return Fcons (Qscroll_bar_movement
,
5878 (Fcons (Fcons (bar_window
,
5879 Fcons (Qvertical_scroll_bar
,
5880 Fcons (Fcons (x
, y
),
5881 Fcons (make_number (time
),
5887 /* Or is it an ordinary mouse movement? */
5890 Lisp_Object position
;
5892 position
= make_lispy_position (frame
, &x
, &y
, time
);
5894 return Fcons (Qmouse_movement
,
5900 #endif /* HAVE_MOUSE */
5902 /* Construct a switch frame event. */
5904 make_lispy_switch_frame (frame
)
5907 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5910 /* Manipulating modifiers. */
5912 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5914 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5915 SYMBOL's name of the end of the modifiers; the string from this
5916 position is the unmodified symbol name.
5918 This doesn't use any caches. */
5921 parse_modifiers_uncached (symbol
, modifier_end
)
5929 CHECK_SYMBOL (symbol
);
5932 name
= SYMBOL_NAME (symbol
);
5934 for (i
= 0; i
+2 <= SBYTES (name
); )
5936 int this_mod_end
= 0;
5939 /* See if the name continues with a modifier word.
5940 Check that the word appears, but don't check what follows it.
5941 Set this_mod and this_mod_end to record what we find. */
5943 switch (SREF (name
, i
))
5945 #define SINGLE_LETTER_MOD(BIT) \
5946 (this_mod_end = i + 1, this_mod = BIT)
5949 SINGLE_LETTER_MOD (alt_modifier
);
5953 SINGLE_LETTER_MOD (ctrl_modifier
);
5957 SINGLE_LETTER_MOD (hyper_modifier
);
5961 SINGLE_LETTER_MOD (meta_modifier
);
5965 SINGLE_LETTER_MOD (shift_modifier
);
5969 SINGLE_LETTER_MOD (super_modifier
);
5972 #undef SINGLE_LETTER_MOD
5974 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5975 if (i + LEN + 1 <= SBYTES (name) \
5976 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5978 this_mod_end = i + LEN; \
5983 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5984 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5985 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5989 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5991 #undef MULTI_LETTER_MOD
5995 /* If we found no modifier, stop looking for them. */
5996 if (this_mod_end
== 0)
5999 /* Check there is a dash after the modifier, so that it
6000 really is a modifier. */
6001 if (this_mod_end
>= SBYTES (name
)
6002 || SREF (name
, this_mod_end
) != '-')
6005 /* This modifier is real; look for another. */
6006 modifiers
|= this_mod
;
6007 i
= this_mod_end
+ 1;
6010 /* Should we include the `click' modifier? */
6011 if (! (modifiers
& (down_modifier
| drag_modifier
6012 | double_modifier
| triple_modifier
))
6013 && i
+ 7 == SBYTES (name
)
6014 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6015 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6016 modifiers
|= click_modifier
;
6024 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6025 prepended to the string BASE[0..BASE_LEN-1].
6026 This doesn't use any caches. */
6028 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6031 int base_len
, base_len_byte
;
6033 /* Since BASE could contain nulls, we can't use intern here; we have
6034 to use Fintern, which expects a genuine Lisp_String, and keeps a
6037 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6043 /* Only the event queue may use the `up' modifier; it should always
6044 be turned into a click or drag event before presented to lisp code. */
6045 if (modifiers
& up_modifier
)
6048 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6049 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6050 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6051 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6052 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6053 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6054 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6055 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6056 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6057 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6058 /* The click modifier is denoted by the absence of other modifiers. */
6062 mod_len
= p
- new_mods
;
6066 Lisp_Object new_name
;
6068 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6069 mod_len
+ base_len_byte
);
6070 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6071 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6073 return Fintern (new_name
, Qnil
);
6078 static char *modifier_names
[] =
6080 "up", "down", "drag", "click", "double", "triple", 0, 0,
6081 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6082 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6084 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6086 static Lisp_Object modifier_symbols
;
6088 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6090 lispy_modifier_list (modifiers
)
6093 Lisp_Object modifier_list
;
6096 modifier_list
= Qnil
;
6097 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6098 if (modifiers
& (1<<i
))
6099 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6102 return modifier_list
;
6106 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6107 where UNMODIFIED is the unmodified form of SYMBOL,
6108 MASK is the set of modifiers present in SYMBOL's name.
6109 This is similar to parse_modifiers_uncached, but uses the cache in
6110 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6111 Qevent_symbol_elements property. */
6114 parse_modifiers (symbol
)
6117 Lisp_Object elements
;
6119 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6120 if (CONSP (elements
))
6125 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6126 Lisp_Object unmodified
;
6129 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6130 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6133 if (modifiers
& ~INTMASK
)
6135 XSETFASTINT (mask
, modifiers
);
6136 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6138 /* Cache the parsing results on SYMBOL. */
6139 Fput (symbol
, Qevent_symbol_element_mask
,
6141 Fput (symbol
, Qevent_symbol_elements
,
6142 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6144 /* Since we know that SYMBOL is modifiers applied to unmodified,
6145 it would be nice to put that in unmodified's cache.
6146 But we can't, since we're not sure that parse_modifiers is
6153 /* Apply the modifiers MODIFIERS to the symbol BASE.
6154 BASE must be unmodified.
6156 This is like apply_modifiers_uncached, but uses BASE's
6157 Qmodifier_cache property, if present. It also builds
6158 Qevent_symbol_elements properties, since it has that info anyway.
6160 apply_modifiers copies the value of BASE's Qevent_kind property to
6161 the modified symbol. */
6163 apply_modifiers (modifiers
, base
)
6167 Lisp_Object cache
, index
, entry
, new_symbol
;
6169 /* Mask out upper bits. We don't know where this value's been. */
6170 modifiers
&= INTMASK
;
6172 /* The click modifier never figures into cache indices. */
6173 cache
= Fget (base
, Qmodifier_cache
);
6174 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6175 entry
= assq_no_quit (index
, cache
);
6178 new_symbol
= XCDR (entry
);
6181 /* We have to create the symbol ourselves. */
6182 new_symbol
= apply_modifiers_uncached (modifiers
,
6183 SDATA (SYMBOL_NAME (base
)),
6184 SCHARS (SYMBOL_NAME (base
)),
6185 SBYTES (SYMBOL_NAME (base
)));
6187 /* Add the new symbol to the base's cache. */
6188 entry
= Fcons (index
, new_symbol
);
6189 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6191 /* We have the parsing info now for free, so we could add it to
6193 XSETFASTINT (index, modifiers);
6194 Fput (new_symbol, Qevent_symbol_element_mask,
6195 Fcons (base, Fcons (index, Qnil)));
6196 Fput (new_symbol, Qevent_symbol_elements,
6197 Fcons (base, lispy_modifier_list (modifiers)));
6198 Sadly, this is only correct if `base' is indeed a base event,
6199 which is not necessarily the case. -stef */
6202 /* Make sure this symbol is of the same kind as BASE.
6204 You'd think we could just set this once and for all when we
6205 intern the symbol above, but reorder_modifiers may call us when
6206 BASE's property isn't set right; we can't assume that just
6207 because it has a Qmodifier_cache property it must have its
6208 Qevent_kind set right as well. */
6209 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6213 kind
= Fget (base
, Qevent_kind
);
6215 Fput (new_symbol
, Qevent_kind
, kind
);
6222 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6223 return a symbol with the modifiers placed in the canonical order.
6224 Canonical order is alphabetical, except for down and drag, which
6225 always come last. The 'click' modifier is never written out.
6227 Fdefine_key calls this to make sure that (for example) C-M-foo
6228 and M-C-foo end up being equivalent in the keymap. */
6231 reorder_modifiers (symbol
)
6234 /* It's hopefully okay to write the code this way, since everything
6235 will soon be in caches, and no consing will be done at all. */
6238 parsed
= parse_modifiers (symbol
);
6239 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6244 /* For handling events, we often want to produce a symbol whose name
6245 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6246 to some base, like the name of a function key or mouse button.
6247 modify_event_symbol produces symbols of this sort.
6249 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6250 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6253 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6254 into symbol names, or a string specifying a name stem used to
6255 construct a symbol name or the form `STEM-N', where N is the decimal
6256 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6257 non-nil; otherwise NAME_TABLE is used.
6259 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6260 persist between calls to modify_event_symbol that it can use to
6261 store a cache of the symbols it's generated for this NAME_TABLE
6262 before. The object stored there may be a vector or an alist.
6264 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6266 MODIFIERS is a set of modifier bits (as given in struct input_events)
6267 whose prefixes should be applied to the symbol name.
6269 SYMBOL_KIND is the value to be placed in the event_kind property of
6270 the returned symbol.
6272 The symbols we create are supposed to have an
6273 `event-symbol-elements' property, which lists the modifiers present
6274 in the symbol's name. */
6277 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6278 name_table
, symbol_table
, table_size
)
6281 Lisp_Object symbol_kind
;
6282 Lisp_Object name_alist_or_stem
;
6284 Lisp_Object
*symbol_table
;
6285 unsigned int table_size
;
6288 Lisp_Object symbol_int
;
6290 /* Get rid of the "vendor-specific" bit here. */
6291 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6293 /* Is this a request for a valid symbol? */
6294 if (symbol_num
< 0 || symbol_num
>= table_size
)
6297 if (CONSP (*symbol_table
))
6298 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6300 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6301 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6302 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6303 we've never used that symbol before. */
6306 if (! VECTORP (*symbol_table
)
6307 || XVECTOR (*symbol_table
)->size
!= table_size
)
6311 XSETFASTINT (size
, table_size
);
6312 *symbol_table
= Fmake_vector (size
, Qnil
);
6315 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6318 /* Have we already used this symbol before? */
6321 /* No; let's create it. */
6322 if (CONSP (name_alist_or_stem
))
6323 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6324 else if (STRINGP (name_alist_or_stem
))
6326 int len
= SBYTES (name_alist_or_stem
);
6327 char *buf
= (char *) alloca (len
+ 50);
6328 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6329 (long) XINT (symbol_int
) + 1);
6330 value
= intern (buf
);
6332 else if (name_table
!= 0 && name_table
[symbol_num
])
6333 value
= intern (name_table
[symbol_num
]);
6335 #ifdef HAVE_WINDOW_SYSTEM
6338 char *name
= x_get_keysym_name (symbol_num
);
6340 value
= intern (name
);
6347 sprintf (buf
, "key-%d", symbol_num
);
6348 value
= intern (buf
);
6351 if (CONSP (*symbol_table
))
6352 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6354 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6356 /* Fill in the cache entries for this symbol; this also
6357 builds the Qevent_symbol_elements property, which the user
6359 apply_modifiers (modifiers
& click_modifier
, value
);
6360 Fput (value
, Qevent_kind
, symbol_kind
);
6363 /* Apply modifiers to that symbol. */
6364 return apply_modifiers (modifiers
, value
);
6367 /* Convert a list that represents an event type,
6368 such as (ctrl meta backspace), into the usual representation of that
6369 event type as a number or a symbol. */
6371 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6372 doc
: /* Convert the event description list EVENT-DESC to an event type.
6373 EVENT-DESC should contain one base event type (a character or symbol)
6374 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6375 drag, down, double or triple). The base must be last.
6376 The return value is an event type (a character or symbol) which
6377 has the same base event type and all the specified modifiers. */)
6379 Lisp_Object event_desc
;
6387 while (CONSP (rest
))
6395 /* Given a symbol, see if it is a modifier name. */
6396 if (SYMBOLP (elt
) && CONSP (rest
))
6397 this = parse_solitary_modifier (elt
);
6401 else if (!NILP (base
))
6402 error ("Two bases given in one event");
6408 /* Let the symbol A refer to the character A. */
6409 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6410 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6412 if (INTEGERP (base
))
6414 /* Turn (shift a) into A. */
6415 if ((modifiers
& shift_modifier
) != 0
6416 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6418 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6419 modifiers
&= ~shift_modifier
;
6422 /* Turn (control a) into C-a. */
6423 if (modifiers
& ctrl_modifier
)
6424 return make_number ((modifiers
& ~ctrl_modifier
)
6425 | make_ctrl_char (XINT (base
)));
6427 return make_number (modifiers
| XINT (base
));
6429 else if (SYMBOLP (base
))
6430 return apply_modifiers (modifiers
, base
);
6433 error ("Invalid base event");
6438 /* Try to recognize SYMBOL as a modifier name.
6439 Return the modifier flag bit, or 0 if not recognized. */
6442 parse_solitary_modifier (symbol
)
6445 Lisp_Object name
= SYMBOL_NAME (symbol
);
6447 switch (SREF (name
, 0))
6449 #define SINGLE_LETTER_MOD(BIT) \
6450 if (SBYTES (name) == 1) \
6453 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6454 if (LEN == SBYTES (name) \
6455 && ! strncmp (SDATA (name), NAME, LEN)) \
6459 SINGLE_LETTER_MOD (alt_modifier
);
6463 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6467 SINGLE_LETTER_MOD (ctrl_modifier
);
6471 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6472 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6476 SINGLE_LETTER_MOD (hyper_modifier
);
6480 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6484 SINGLE_LETTER_MOD (meta_modifier
);
6488 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6492 SINGLE_LETTER_MOD (shift_modifier
);
6496 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6497 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6498 SINGLE_LETTER_MOD (super_modifier
);
6502 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6503 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6504 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6508 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6511 #undef SINGLE_LETTER_MOD
6512 #undef MULTI_LETTER_MOD
6518 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6519 Such a list is not valid as an event,
6520 but it can be a Lucid-style event type list. */
6523 lucid_event_type_list_p (object
)
6528 if (! CONSP (object
))
6531 if (EQ (XCAR (object
), Qhelp_echo
)
6532 || EQ (XCAR (object
), Qvertical_line
)
6533 || EQ (XCAR (object
), Qmode_line
)
6534 || EQ (XCAR (object
), Qheader_line
))
6537 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6541 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6548 /* Store into *addr a value nonzero if terminal input chars are available.
6549 Serves the purpose of ioctl (0, FIONREAD, addr)
6550 but works even if FIONREAD does not exist.
6551 (In fact, this may actually read some input.)
6553 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6554 timer events that are ripe.
6555 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6556 events (FOCUS_IN_EVENT).
6557 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6558 movements and toolkit scroll bar thumb drags. */
6561 get_input_pending (addr
, flags
)
6565 /* First of all, have we already counted some input? */
6566 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6568 /* If input is being read as it arrives, and we have none, there is none. */
6569 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6572 /* Try to read some input and see how much we get. */
6574 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6577 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6580 gobble_input (expected
)
6585 if (interrupt_input
)
6588 mask
= sigblock (sigmask (SIGIO
));
6589 read_avail_input (expected
);
6593 #ifdef POLL_FOR_INPUT
6594 /* XXX This condition was (read_socket_hook && !interrupt_input),
6595 but read_socket_hook is not global anymore. Let's pretend that
6597 if (!interrupt_input
&& poll_suppress_count
== 0)
6600 mask
= sigblock (sigmask (SIGALRM
));
6601 read_avail_input (expected
);
6607 read_avail_input (expected
);
6611 /* Put a BUFFER_SWITCH_EVENT in the buffer
6612 so that read_key_sequence will notice the new current buffer. */
6615 record_asynch_buffer_change ()
6617 struct input_event event
;
6621 event
.kind
= BUFFER_SWITCH_EVENT
;
6622 event
.frame_or_window
= Qnil
;
6626 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6627 The purpose of the event is to make read_key_sequence look up the
6628 keymaps again. If we aren't in read_key_sequence, we don't need one,
6629 and the event could cause trouble by messing up (input-pending-p). */
6630 tem
= Fwaiting_for_user_input_p ();
6634 /* We never need these events if we have no asynchronous subprocesses. */
6638 /* Make sure no interrupt happens while storing the event. */
6640 if (interrupt_input
)
6643 mask
= sigblock (sigmask (SIGIO
));
6644 kbd_buffer_store_event (&event
);
6651 kbd_buffer_store_event (&event
);
6658 /* Read any terminal input already buffered up by the system
6659 into the kbd_buffer, but do not wait.
6661 EXPECTED should be nonzero if the caller knows there is some input.
6663 Except on VMS, all input is read by this function.
6664 If interrupt_input is nonzero, this function MUST be called
6665 only when SIGIO is blocked.
6667 Returns the number of keyboard chars read, or -1 meaning
6668 this is a bad time to try to read input. */
6671 read_avail_input (expected
)
6678 /* Loop through the available devices, and call their input hooks. */
6682 struct device
*next
= d
->next_device
;
6684 if (d
->read_socket_hook
)
6687 struct input_event hold_quit
;
6689 EVENT_INIT (hold_quit
);
6690 hold_quit
.kind
= NO_EVENT
;
6692 /* No need for FIONREAD or fcntl; just say don't wait. */
6693 while (nr
= (*d
->read_socket_hook
) (d
, expected
, &hold_quit
), nr
> 0)
6699 if (nr
== -1) /* Not OK to read input now. */
6703 else if (nr
== -2) /* Non-transient error. */
6705 /* The display device terminated; it should be closed. */
6707 /* Kill Emacs if this was our last display. */
6708 if (! device_list
->next_device
)
6709 /* Formerly simply reported no input, but that
6710 sometimes led to a failure of Emacs to terminate.
6711 SIGHUP seems appropriate if we can't reach the
6713 /* ??? Is it really right to send the signal just to
6714 this process rather than to the whole process
6715 group? Perhaps on systems with FIONREAD Emacs is
6716 alone in its group. */
6717 kill (getpid (), SIGHUP
);
6719 /* XXX Is calling delete_device safe here? It calls Fdelete_frame. */
6720 if (d
->delete_device_hook
)
6721 (*d
->delete_device_hook
) (d
);
6726 if (hold_quit
.kind
!= NO_EVENT
)
6727 kbd_buffer_store_event (&hold_quit
);
6739 /* This is the tty way of reading available input.
6741 Note that each terminal device has its own `struct device' object,
6742 and so this function is called once for each individual termcap
6743 display. The first parameter indicates which device to read from. */
6746 tty_read_avail_input (struct device
*device
,
6748 struct input_event
*hold_quit
)
6750 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6751 the kbd_buffer can really hold. That may prevent loss
6752 of characters on some systems when input is stuffed at us. */
6753 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6755 struct tty_display_info
*tty
= device
->display_info
.tty
;
6758 if (device
->type
!= output_termcap
)
6761 /* XXX I think the following code should be moved to separate hook
6762 functions in system-dependent files. */
6765 #else /* not WINDOWSNT */
6767 n_to_read
= dos_keysns ();
6771 cbuf
[0] = dos_keyread ();
6774 #else /* not MSDOS */
6776 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6780 return 0; /* The terminal is suspended. */
6782 /* Determine how many characters we should *try* to read. */
6784 /* Find out how much input is available. */
6785 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6787 if (! noninteractive
)
6788 return -2; /* Close this device. */
6794 if (n_to_read
> sizeof cbuf
)
6795 n_to_read
= sizeof cbuf
;
6796 #else /* no FIONREAD */
6797 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6798 /* Read some input if available, but don't wait. */
6799 n_to_read
= sizeof cbuf
;
6800 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6806 /* Now read; for one reason or another, this will not block.
6807 NREAD is set to the number of chars read. */
6810 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6811 /* POSIX infers that processes which are not in the session leader's
6812 process group won't get SIGHUP's at logout time. BSDI adheres to
6813 this part standard and returns -1 from read (0) with errno==EIO
6814 when the control tty is taken away.
6815 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6816 if (nread
== -1 && errno
== EIO
)
6817 return -2; /* Close this device. */
6818 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6819 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6820 This looks incorrect, but it isn't, because _BSD causes
6821 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6822 and that causes a value other than 0 when there is no input. */
6824 return -2; /* Close this device. */
6828 /* We used to retry the read if it was interrupted.
6829 But this does the wrong thing when O_NDELAY causes
6830 an EAGAIN error. Does anybody know of a situation
6831 where a retry is actually needed? */
6833 nread
< 0 && (errno
== EAGAIN
6847 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6848 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6849 #endif /* USG or DGUX or CYGWIN */
6850 #endif /* no FIONREAD */
6855 #endif /* not MSDOS */
6856 #endif /* not WINDOWSNT */
6858 for (i
= 0; i
< nread
; i
++)
6860 struct input_event buf
;
6862 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6864 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6865 buf
.modifiers
= meta_modifier
;
6866 if (tty
->meta_key
!= 2)
6870 /* Set the frame corresponding to the active tty. Note that the
6871 value of selected_frame is not reliable here, redisplay tends
6872 to temporarily change it. */
6873 buf
.frame_or_window
= tty
->top_frame
;
6876 kbd_buffer_store_event (&buf
);
6877 /* Don't look at input that follows a C-g too closely.
6878 This reduces lossage due to autorepeat on C-g. */
6879 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6880 && buf
.code
== quit_char
)
6886 #endif /* not VMS */
6889 handle_async_input ()
6892 extern int select_alarmed
;
6895 interrupt_input_pending
= 0;
6900 nread
= read_avail_input (1);
6901 /* -1 means it's not ok to read the input now.
6902 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6903 0 means there was no keyboard input available. */
6908 select_alarmed
= 1; /* Force the select emulator back to life */
6913 #ifdef SIGIO /* for entire page */
6914 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6917 input_available_signal (signo
)
6920 /* Must preserve main program's value of errno. */
6921 int old_errno
= errno
;
6922 #if defined (USG) && !defined (POSIX_SIGNALS)
6923 /* USG systems forget handlers when they are used;
6924 must reestablish each time */
6925 signal (signo
, input_available_signal
);
6933 interrupt_input_pending
= 1;
6935 SIGNAL_THREAD_CHECK (signo
);
6938 if (input_available_clear_time
)
6939 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6942 handle_async_input ();
6952 /* Send ourselves a SIGIO.
6954 This function exists so that the UNBLOCK_INPUT macro in
6955 blockinput.h can have some way to take care of input we put off
6956 dealing with, without assuming that every file which uses
6957 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6959 reinvoke_input_signal ()
6962 handle_async_input ();
6968 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6969 static Lisp_Object menu_bar_one_keymap_changed_items
;
6971 /* These variables hold the vector under construction within
6972 menu_bar_items and its subroutines, and the current index
6973 for storing into that vector. */
6974 static Lisp_Object menu_bar_items_vector
;
6975 static int menu_bar_items_index
;
6977 /* Return a vector of menu items for a menu bar, appropriate
6978 to the current buffer. Each item has three elements in the vector:
6981 OLD is an old vector we can optionally reuse, or nil. */
6984 menu_bar_items (old
)
6987 /* The number of keymaps we're scanning right now, and the number of
6988 keymaps we have allocated space for. */
6991 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6992 in the current keymaps, or nil where it is not a prefix. */
6995 Lisp_Object def
, tail
;
7004 struct gcpro gcpro1
;
7006 /* In order to build the menus, we need to call the keymap
7007 accessors. They all call QUIT. But this function is called
7008 during redisplay, during which a quit is fatal. So inhibit
7009 quitting while building the menus.
7010 We do this instead of specbind because (1) errors will clear it anyway
7011 and (2) this avoids risk of specpdl overflow. */
7012 oquit
= Vinhibit_quit
;
7016 menu_bar_items_vector
= old
;
7018 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7019 menu_bar_items_index
= 0;
7021 GCPRO1 (menu_bar_items_vector
);
7023 /* Build our list of keymaps.
7024 If we recognize a function key and replace its escape sequence in
7025 keybuf with its symbol, or if the sequence starts with a mouse
7026 click and we need to switch buffers, we jump back here to rebuild
7027 the initial keymaps from the current buffer. */
7031 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7032 if (!NILP (Voverriding_local_map_menu_flag
))
7034 /* Yes, use them (if non-nil) as well as the global map. */
7035 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7037 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7038 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7039 if (!NILP (Voverriding_local_map
))
7040 maps
[nmaps
++] = Voverriding_local_map
;
7044 /* No, so use major and minor mode keymaps and keymap property.
7045 Note that menu-bar bindings in the local-map and keymap
7046 properties may not work reliable, as they are only
7047 recognized when the menu-bar (or mode-line) is updated,
7048 which does not normally happen after every command. */
7051 nminor
= current_minor_maps (NULL
, &tmaps
);
7052 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7054 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7055 maps
[nmaps
++] = tem
;
7056 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7058 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7060 maps
[nmaps
++] = current_global_map
;
7063 /* Look up in each map the dummy prefix key `menu-bar'. */
7067 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7068 if (!NILP (maps
[mapno
]))
7070 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7074 menu_bar_one_keymap_changed_items
= Qnil
;
7075 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7079 /* Move to the end those items that should be at the end. */
7081 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7084 int end
= menu_bar_items_index
;
7086 for (i
= 0; i
< end
; i
+= 4)
7087 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7089 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7090 /* Move the item at index I to the end,
7091 shifting all the others forward. */
7092 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7093 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7094 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7095 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7097 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7098 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7099 (end
- i
- 4) * sizeof (Lisp_Object
));
7100 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7101 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7102 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7103 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7108 /* Add nil, nil, nil, nil at the end. */
7109 i
= menu_bar_items_index
;
7110 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7113 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7114 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7115 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7116 menu_bar_items_vector
= tem
;
7118 /* Add this item. */
7119 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7120 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7121 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7122 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7123 menu_bar_items_index
= i
;
7125 Vinhibit_quit
= oquit
;
7127 return menu_bar_items_vector
;
7130 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7131 If there's already an item for KEY, add this DEF to it. */
7133 Lisp_Object item_properties
;
7136 menu_bar_item (key
, item
, dummy1
, dummy2
)
7137 Lisp_Object key
, item
, dummy1
;
7140 struct gcpro gcpro1
;
7144 if (EQ (item
, Qundefined
))
7146 /* If a map has an explicit `undefined' as definition,
7147 discard any previously made menu bar item. */
7149 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7150 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7152 if (menu_bar_items_index
> i
+ 4)
7153 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7154 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7155 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7156 menu_bar_items_index
-= 4;
7160 /* If this keymap has already contributed to this KEY,
7161 don't contribute to it a second time. */
7162 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7163 if (!NILP (tem
) || NILP (item
))
7166 menu_bar_one_keymap_changed_items
7167 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7169 /* We add to menu_bar_one_keymap_changed_items before doing the
7170 parse_menu_item, so that if it turns out it wasn't a menu item,
7171 it still correctly hides any further menu item. */
7173 i
= parse_menu_item (item
, 0, 1);
7178 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7180 /* Find any existing item for this KEY. */
7181 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7182 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7185 /* If we did not find this KEY, add it at the end. */
7186 if (i
== menu_bar_items_index
)
7188 /* If vector is too small, get a bigger one. */
7189 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7192 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7193 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7194 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7195 menu_bar_items_vector
= tem
;
7198 /* Add this item. */
7199 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7200 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7201 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7202 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7203 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7204 menu_bar_items_index
= i
;
7206 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7210 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7211 /* If the new and the old items are not both keymaps,
7212 the lookup will only find `item'. */
7213 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7214 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7218 /* This is used as the handler when calling menu_item_eval_property. */
7220 menu_item_eval_property_1 (arg
)
7223 /* If we got a quit from within the menu computation,
7224 quit all the way out of it. This takes care of C-] in the debugger. */
7225 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7226 Fsignal (Qquit
, Qnil
);
7231 /* Evaluate an expression and return the result (or nil if something
7232 went wrong). Used to evaluate dynamic parts of menu items. */
7234 menu_item_eval_property (sexpr
)
7237 int count
= SPECPDL_INDEX ();
7239 specbind (Qinhibit_redisplay
, Qt
);
7240 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7241 menu_item_eval_property_1
);
7242 return unbind_to (count
, val
);
7245 /* This function parses a menu item and leaves the result in the
7246 vector item_properties.
7247 ITEM is a key binding, a possible menu item.
7248 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7249 evaluate dynamic expressions in the menu item.
7250 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7252 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7253 parse_menu_item returns true if the item is a menu item and false
7257 parse_menu_item (item
, notreal
, inmenubar
)
7259 int notreal
, inmenubar
;
7261 Lisp_Object def
, tem
, item_string
, start
;
7262 Lisp_Object cachelist
;
7264 Lisp_Object keyhint
;
7275 /* Create item_properties vector if necessary. */
7276 if (NILP (item_properties
))
7278 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7280 /* Initialize optional entries. */
7281 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7282 AREF (item_properties
, i
) = Qnil
;
7283 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7285 /* Save the item here to protect it from GC. */
7286 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7288 item_string
= XCAR (item
);
7292 if (STRINGP (item_string
))
7294 /* Old format menu item. */
7295 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7297 /* Maybe help string. */
7298 if (CONSP (item
) && STRINGP (XCAR (item
)))
7300 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7305 /* Maybe key binding cache. */
7306 if (CONSP (item
) && CONSP (XCAR (item
))
7307 && (NILP (XCAR (XCAR (item
)))
7308 || VECTORP (XCAR (XCAR (item
)))))
7310 cachelist
= XCAR (item
);
7314 /* This is the real definition--the function to run. */
7315 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7317 /* Get enable property, if any. */
7320 tem
= Fget (item
, Qmenu_enable
);
7322 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7325 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7327 /* New format menu item. */
7328 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7329 start
= XCDR (item
);
7332 /* We have a real binding. */
7333 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7335 item
= XCDR (start
);
7336 /* Is there a cache list with key equivalences. */
7337 if (CONSP (item
) && CONSP (XCAR (item
)))
7339 cachelist
= XCAR (item
);
7343 /* Parse properties. */
7344 while (CONSP (item
) && CONSP (XCDR (item
)))
7349 if (EQ (tem
, QCenable
))
7350 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7351 else if (EQ (tem
, QCvisible
) && !notreal
)
7353 /* If got a visible property and that evaluates to nil
7354 then ignore this item. */
7355 tem
= menu_item_eval_property (XCAR (item
));
7359 else if (EQ (tem
, QChelp
))
7360 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7361 else if (EQ (tem
, QCfilter
))
7363 else if (EQ (tem
, QCkey_sequence
))
7366 if (NILP (cachelist
)
7367 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7368 /* Be GC protected. Set keyhint to item instead of tem. */
7371 else if (EQ (tem
, QCkeys
))
7374 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7375 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7377 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7382 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7384 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7386 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7393 else if (inmenubar
|| !NILP (start
))
7397 return 0; /* not a menu item */
7399 /* If item string is not a string, evaluate it to get string.
7400 If we don't get a string, skip this item. */
7401 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7402 if (!(STRINGP (item_string
) || notreal
))
7404 item_string
= menu_item_eval_property (item_string
);
7405 if (!STRINGP (item_string
))
7407 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7410 /* If got a filter apply it on definition. */
7411 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7414 def
= menu_item_eval_property (list2 (XCAR (filter
),
7415 list2 (Qquote
, def
)));
7417 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7420 /* Enable or disable selection of item. */
7421 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7427 tem
= menu_item_eval_property (tem
);
7428 if (inmenubar
&& NILP (tem
))
7429 return 0; /* Ignore disabled items in menu bar. */
7430 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7433 /* If we got no definition, this item is just unselectable text which
7434 is OK in a submenu but not in the menubar. */
7436 return (inmenubar
? 0 : 1);
7438 /* See if this is a separate pane or a submenu. */
7439 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7440 tem
= get_keymap (def
, 0, 1);
7441 /* For a subkeymap, just record its details and exit. */
7444 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7445 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7449 /* At the top level in the menu bar, do likewise for commands also.
7450 The menu bar does not display equivalent key bindings anyway.
7451 ITEM_PROPERTY_DEF is already set up properly. */
7455 /* This is a command. See if there is an equivalent key binding. */
7456 if (NILP (cachelist
))
7458 /* We have to create a cachelist. */
7459 CHECK_IMPURE (start
);
7460 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7461 cachelist
= XCAR (XCDR (start
));
7463 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7464 if (!NILP (keyhint
))
7466 XSETCAR (cachelist
, XCAR (keyhint
));
7469 else if (STRINGP (tem
))
7471 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7472 XSETCAR (cachelist
, Qt
);
7476 tem
= XCAR (cachelist
);
7483 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7485 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7488 def
= XCAR (prefix
);
7489 prefix
= XCDR (prefix
);
7492 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7494 if (!update_menu_bindings
)
7496 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7498 if (newcache
/* Always check first time. */
7499 /* Should we check everything when precomputing key
7501 /* If something had no key binding before, don't recheck it
7502 because that is too slow--except if we have a list of
7503 rebound commands in Vdefine_key_rebound_commands, do
7504 recheck any command that appears in that list. */
7505 || (CONSP (Vdefine_key_rebound_commands
)
7506 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7509 /* We had a saved key. Is it still bound to the command? */
7512 /* If the command is an alias for another
7513 (such as lmenu.el set it up), check if the
7514 original command matches the cached command. */
7515 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7516 chkcache
= 1; /* Need to recompute key binding. */
7520 /* Recompute equivalent key binding. If the command is an alias
7521 for another (such as lmenu.el set it up), see if the original
7522 command name has equivalent keys. Otherwise look up the
7523 specified command itself. We don't try both, because that
7524 makes lmenu menus slow. */
7526 && SYMBOLP (XSYMBOL (def
)->function
)
7527 && ! NILP (Fget (def
, Qmenu_alias
)))
7528 def
= XSYMBOL (def
)->function
;
7529 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7530 XSETCAR (cachelist
, tem
);
7533 XSETCDR (cachelist
, Qnil
);
7537 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7539 tem
= XCAR (cachelist
);
7543 newcache
= chkcache
;
7546 tem
= Fkey_description (tem
, Qnil
);
7549 if (STRINGP (XCAR (prefix
)))
7550 tem
= concat2 (XCAR (prefix
), tem
);
7551 if (STRINGP (XCDR (prefix
)))
7552 tem
= concat2 (tem
, XCDR (prefix
));
7554 XSETCDR (cachelist
, tem
);
7558 tem
= XCDR (cachelist
);
7559 if (newcache
&& !NILP (tem
))
7561 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7562 XSETCDR (cachelist
, tem
);
7565 /* If we only want to precompute equivalent key bindings, stop here. */
7569 /* If we have an equivalent key binding, use that. */
7570 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7572 /* Include this when menu help is implemented.
7573 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7574 if (!(NILP (tem) || STRINGP (tem)))
7576 tem = menu_item_eval_property (tem);
7579 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7583 /* Handle radio buttons or toggle boxes. */
7584 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7586 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7587 = menu_item_eval_property (tem
);
7594 /***********************************************************************
7596 ***********************************************************************/
7598 /* A vector holding tool bar items while they are parsed in function
7599 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7602 static Lisp_Object tool_bar_items_vector
;
7604 /* A vector holding the result of parse_tool_bar_item. Layout is like
7605 the one for a single item in tool_bar_items_vector. */
7607 static Lisp_Object tool_bar_item_properties
;
7609 /* Next free index in tool_bar_items_vector. */
7611 static int ntool_bar_items
;
7613 /* The symbols `tool-bar', and `:image'. */
7615 extern Lisp_Object Qtool_bar
;
7616 Lisp_Object QCimage
;
7618 /* Function prototypes. */
7620 static void init_tool_bar_items
P_ ((Lisp_Object
));
7621 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7622 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7623 static void append_tool_bar_item
P_ ((void));
7626 /* Return a vector of tool bar items for keymaps currently in effect.
7627 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7628 tool bar items found. */
7631 tool_bar_items (reuse
, nitems
)
7642 /* In order to build the menus, we need to call the keymap
7643 accessors. They all call QUIT. But this function is called
7644 during redisplay, during which a quit is fatal. So inhibit
7645 quitting while building the menus. We do this instead of
7646 specbind because (1) errors will clear it anyway and (2) this
7647 avoids risk of specpdl overflow. */
7648 oquit
= Vinhibit_quit
;
7651 /* Initialize tool_bar_items_vector and protect it from GC. */
7652 init_tool_bar_items (reuse
);
7654 /* Build list of keymaps in maps. Set nmaps to the number of maps
7657 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7658 if (!NILP (Voverriding_local_map_menu_flag
))
7660 /* Yes, use them (if non-nil) as well as the global map. */
7661 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7663 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7664 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7665 if (!NILP (Voverriding_local_map
))
7666 maps
[nmaps
++] = Voverriding_local_map
;
7670 /* No, so use major and minor mode keymaps and keymap property.
7671 Note that tool-bar bindings in the local-map and keymap
7672 properties may not work reliable, as they are only
7673 recognized when the tool-bar (or mode-line) is updated,
7674 which does not normally happen after every command. */
7677 nminor
= current_minor_maps (NULL
, &tmaps
);
7678 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7680 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7681 maps
[nmaps
++] = tem
;
7682 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7684 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7687 /* Add global keymap at the end. */
7688 maps
[nmaps
++] = current_global_map
;
7690 /* Process maps in reverse order and look up in each map the prefix
7692 for (i
= nmaps
- 1; i
>= 0; --i
)
7693 if (!NILP (maps
[i
]))
7697 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7702 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7703 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7705 Lisp_Object keydef
= XCAR (tail
);
7707 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7712 Vinhibit_quit
= oquit
;
7713 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7714 return tool_bar_items_vector
;
7718 /* Process the definition of KEY which is DEF. */
7721 process_tool_bar_item (key
, def
)
7722 Lisp_Object key
, def
;
7725 extern Lisp_Object Qundefined
;
7726 struct gcpro gcpro1
, gcpro2
;
7728 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7732 if (EQ (def
, Qundefined
))
7734 /* If a map has an explicit `undefined' as definition,
7735 discard any previously made item. */
7736 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7738 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7740 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7742 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7743 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7744 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7745 * sizeof (Lisp_Object
)));
7746 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7751 else if (parse_tool_bar_item (key
, def
))
7752 /* Append a new tool bar item to tool_bar_items_vector. Accept
7753 more than one definition for the same key. */
7754 append_tool_bar_item ();
7760 /* Parse a tool bar item specification ITEM for key KEY and return the
7761 result in tool_bar_item_properties. Value is zero if ITEM is
7764 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7766 CAPTION is the caption of the item, If it's not a string, it is
7767 evaluated to get a string.
7769 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7770 as binding are currently ignored.
7772 The following properties are recognized:
7776 FORM is evaluated and specifies whether the tool bar item is
7777 enabled or disabled.
7781 FORM is evaluated and specifies whether the tool bar item is visible.
7783 - `:filter FUNCTION'
7785 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7786 result is stored as the new binding.
7788 - `:button (TYPE SELECTED)'
7790 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7791 and specifies whether the button is selected (pressed) or not.
7795 IMAGES is either a single image specification or a vector of four
7796 image specifications. See enum tool_bar_item_images.
7798 - `:help HELP-STRING'.
7800 Gives a help string to display for the tool bar item. */
7803 parse_tool_bar_item (key
, item
)
7804 Lisp_Object key
, item
;
7806 /* Access slot with index IDX of vector tool_bar_item_properties. */
7807 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7809 Lisp_Object filter
= Qnil
;
7810 Lisp_Object caption
;
7813 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7814 Rule out items that aren't lists, don't start with
7815 `menu-item' or whose rest following `tool-bar-item' is not a
7818 || !EQ (XCAR (item
), Qmenu_item
)
7819 || (item
= XCDR (item
),
7823 /* Create tool_bar_item_properties vector if necessary. Reset it to
7825 if (VECTORP (tool_bar_item_properties
))
7827 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7831 tool_bar_item_properties
7832 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7835 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7836 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7838 /* Get the caption of the item. If the caption is not a string,
7839 evaluate it to get a string. If we don't get a string, skip this
7841 caption
= XCAR (item
);
7842 if (!STRINGP (caption
))
7844 caption
= menu_item_eval_property (caption
);
7845 if (!STRINGP (caption
))
7848 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7850 /* Give up if rest following the caption is not a list. */
7855 /* Store the binding. */
7856 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7859 /* Ignore cached key binding, if any. */
7860 if (CONSP (item
) && CONSP (XCAR (item
)))
7863 /* Process the rest of the properties. */
7864 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7866 Lisp_Object key
, value
;
7869 value
= XCAR (XCDR (item
));
7871 if (EQ (key
, QCenable
))
7872 /* `:enable FORM'. */
7873 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7874 else if (EQ (key
, QCvisible
))
7876 /* `:visible FORM'. If got a visible property and that
7877 evaluates to nil then ignore this item. */
7878 if (NILP (menu_item_eval_property (value
)))
7881 else if (EQ (key
, QChelp
))
7882 /* `:help HELP-STRING'. */
7883 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7884 else if (EQ (key
, QCfilter
))
7885 /* ':filter FORM'. */
7887 else if (EQ (key
, QCbutton
) && CONSP (value
))
7889 /* `:button (TYPE . SELECTED)'. */
7890 Lisp_Object type
, selected
;
7892 type
= XCAR (value
);
7893 selected
= XCDR (value
);
7894 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7896 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7897 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7900 else if (EQ (key
, QCimage
)
7902 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7903 /* Value is either a single image specification or a vector
7904 of 4 such specifications for the different button states. */
7905 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7908 /* If got a filter apply it on binding. */
7910 PROP (TOOL_BAR_ITEM_BINDING
)
7911 = menu_item_eval_property (list2 (filter
,
7913 PROP (TOOL_BAR_ITEM_BINDING
))));
7915 /* See if the binding is a keymap. Give up if it is. */
7916 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7919 /* Enable or disable selection of item. */
7920 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7921 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7922 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7924 /* Handle radio buttons or toggle boxes. */
7925 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7926 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7927 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7935 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7936 that can be reused. */
7939 init_tool_bar_items (reuse
)
7942 if (VECTORP (reuse
))
7943 tool_bar_items_vector
= reuse
;
7945 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7946 ntool_bar_items
= 0;
7950 /* Append parsed tool bar item properties from
7951 tool_bar_item_properties */
7954 append_tool_bar_item ()
7956 Lisp_Object
*to
, *from
;
7958 /* Enlarge tool_bar_items_vector if necessary. */
7959 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7960 >= XVECTOR (tool_bar_items_vector
)->size
)
7962 Lisp_Object new_vector
;
7963 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7965 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7966 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7967 XVECTOR (new_vector
)->contents
,
7968 old_size
* sizeof (Lisp_Object
));
7969 tool_bar_items_vector
= new_vector
;
7972 /* Append entries from tool_bar_item_properties to the end of
7973 tool_bar_items_vector. */
7974 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7975 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7976 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7977 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7984 /* Read a character using menus based on maps in the array MAPS.
7985 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7986 Return t if we displayed a menu but the user rejected it.
7988 PREV_EVENT is the previous input event, or nil if we are reading
7989 the first event of a key sequence.
7991 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7992 if we used a mouse menu to read the input, or zero otherwise. If
7993 USED_MOUSE_MENU is null, we don't dereference it.
7995 The prompting is done based on the prompt-string of the map
7996 and the strings associated with various map elements.
7998 This can be done with X menus or with menus put in the minibuf.
7999 These are done in different ways, depending on how the input will be read.
8000 Menus using X are done after auto-saving in read-char, getting the input
8001 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8002 and do auto-saving in the inner call of read_char. */
8005 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8008 Lisp_Object prev_event
;
8009 int *used_mouse_menu
;
8012 register Lisp_Object name
= Qnil
;
8014 if (used_mouse_menu
)
8015 *used_mouse_menu
= 0;
8017 /* Use local over global Menu maps */
8019 if (! menu_prompting
)
8022 /* Optionally disregard all but the global map. */
8023 if (inhibit_local_menu_bar_menus
)
8025 maps
+= (nmaps
- 1);
8029 /* Get the menu name from the first map that has one (a prompt string). */
8030 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8032 name
= Fkeymap_prompt (maps
[mapno
]);
8037 /* If we don't have any menus, just read a character normally. */
8038 if (!STRINGP (name
))
8042 /* If we got to this point via a mouse click,
8043 use a real menu for mouse selection. */
8044 if (EVENT_HAS_PARAMETERS (prev_event
)
8045 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8046 && !EQ (XCAR (prev_event
), Qtool_bar
))
8048 /* Display the menu and get the selection. */
8049 Lisp_Object
*realmaps
8050 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8054 /* Use the maps that are not nil. */
8055 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8056 if (!NILP (maps
[mapno
]))
8057 realmaps
[nmaps1
++] = maps
[mapno
];
8059 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8064 record_menu_key (XCAR (value
));
8066 /* If we got multiple events, unread all but
8068 There is no way to prevent those unread events
8069 from showing up later in last_nonmenu_event.
8070 So turn symbol and integer events into lists,
8071 to indicate that they came from a mouse menu,
8072 so that when present in last_nonmenu_event
8073 they won't confuse things. */
8074 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8076 record_menu_key (XCAR (tem
));
8077 if (SYMBOLP (XCAR (tem
))
8078 || INTEGERP (XCAR (tem
)))
8079 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8082 /* If we got more than one event, put all but the first
8083 onto this list to be read later.
8084 Return just the first event now. */
8085 Vunread_command_events
8086 = nconc2 (XCDR (value
), Vunread_command_events
);
8087 value
= XCAR (value
);
8089 else if (NILP (value
))
8091 if (used_mouse_menu
)
8092 *used_mouse_menu
= 1;
8095 #endif /* HAVE_MENUS */
8099 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8100 We make this bigger when necessary, and never free it. */
8101 static char *read_char_minibuf_menu_text
;
8102 /* Size of that buffer. */
8103 static int read_char_minibuf_menu_width
;
8106 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8112 register Lisp_Object name
;
8114 /* FIXME: Use the minibuffer's frame width. */
8115 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8118 Lisp_Object rest
, vector
;
8124 if (! menu_prompting
)
8127 /* Make sure we have a big enough buffer for the menu text. */
8128 if (read_char_minibuf_menu_text
== 0)
8130 read_char_minibuf_menu_width
= width
+ 4;
8131 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8133 else if (width
+ 4 > read_char_minibuf_menu_width
)
8135 read_char_minibuf_menu_width
= width
+ 4;
8136 read_char_minibuf_menu_text
8137 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8139 menu
= read_char_minibuf_menu_text
;
8141 /* Get the menu name from the first map that has one (a prompt string). */
8142 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8144 name
= Fkeymap_prompt (maps
[mapno
]);
8149 /* If we don't have any menus, just read a character normally. */
8150 if (!STRINGP (name
))
8153 /* Prompt string always starts with map's prompt, and a space. */
8154 strcpy (menu
, SDATA (name
));
8155 nlength
= SBYTES (name
);
8156 menu
[nlength
++] = ':';
8157 menu
[nlength
++] = ' ';
8160 /* Start prompting at start of first map. */
8164 /* Present the documented bindings, a line at a time. */
8171 Lisp_Object orig_defn_macro
;
8173 /* Loop over elements of map. */
8178 /* If reached end of map, start at beginning of next map. */
8182 /* At end of last map, wrap around to first map if just starting,
8183 or end this line if already have something on it. */
8187 if (notfirst
|| nobindings
) break;
8192 /* Look at the next element of the map. */
8194 elt
= XVECTOR (vector
)->contents
[idx
];
8196 elt
= Fcar_safe (rest
);
8198 if (idx
< 0 && VECTORP (elt
))
8200 /* If we found a dense table in the keymap,
8201 advanced past it, but start scanning its contents. */
8202 rest
= Fcdr_safe (rest
);
8208 /* An ordinary element. */
8209 Lisp_Object event
, tem
;
8213 event
= Fcar_safe (elt
); /* alist */
8214 elt
= Fcdr_safe (elt
);
8218 XSETINT (event
, idx
); /* vector */
8221 /* Ignore the element if it has no prompt string. */
8222 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8224 /* 1 if the char to type matches the string. */
8226 Lisp_Object upcased_event
, downcased_event
;
8227 Lisp_Object desc
= Qnil
;
8229 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8231 upcased_event
= Fupcase (event
);
8232 downcased_event
= Fdowncase (event
);
8233 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8234 || XINT (downcased_event
) == SREF (s
, 0));
8236 desc
= Fsingle_key_description (event
, Qnil
);
8238 #if 0 /* It is redundant to list the equivalent key bindings because
8239 the prefix is what the user has already typed. */
8241 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8243 /* Insert equivalent keybinding. */
8244 s
= concat2 (s
, tem
);
8247 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8248 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8250 /* Insert button prefix. */
8251 Lisp_Object selected
8252 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8253 if (EQ (tem
, QCradio
))
8254 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8256 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8257 s
= concat2 (tem
, s
);
8261 /* If we have room for the prompt string, add it to this line.
8262 If this is the first on the line, always add it. */
8263 if ((SCHARS (s
) + i
+ 2
8264 + (char_matches
? 0 : SCHARS (desc
) + 3))
8270 /* Punctuate between strings. */
8273 strcpy (menu
+ i
, ", ");
8279 /* If the char to type doesn't match the string's
8280 first char, explicitly show what char to type. */
8283 /* Add as much of string as fits. */
8284 thiswidth
= SCHARS (desc
);
8285 if (thiswidth
+ i
> width
)
8286 thiswidth
= width
- i
;
8287 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8289 strcpy (menu
+ i
, " = ");
8293 /* Add as much of string as fits. */
8294 thiswidth
= SCHARS (s
);
8295 if (thiswidth
+ i
> width
)
8296 thiswidth
= width
- i
;
8297 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8303 /* If this element does not fit, end the line now,
8304 and save the element for the next line. */
8305 strcpy (menu
+ i
, "...");
8310 /* Move past this element. */
8311 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8312 /* Handle reaching end of dense table. */
8317 rest
= Fcdr_safe (rest
);
8321 /* Prompt with that and read response. */
8322 message2_nolog (menu
, strlen (menu
),
8323 ! NILP (current_buffer
->enable_multibyte_characters
));
8325 /* Make believe its not a keyboard macro in case the help char
8326 is pressed. Help characters are not recorded because menu prompting
8327 is not used on replay.
8329 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8330 current_kboard
->defining_kbd_macro
= Qnil
;
8332 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8333 while (BUFFERP (obj
));
8334 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8336 if (!INTEGERP (obj
))
8341 if (! EQ (obj
, menu_prompt_more_char
)
8342 && (!INTEGERP (menu_prompt_more_char
)
8343 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8345 if (!NILP (current_kboard
->defining_kbd_macro
))
8346 store_kbd_macro_char (obj
);
8349 /* Help char - go round again */
8353 /* Reading key sequences. */
8355 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8356 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8357 keymap, or nil otherwise. Return the index of the first keymap in
8358 which KEY has any binding, or NMAPS if no map has a binding.
8360 If KEY is a meta ASCII character, treat it like meta-prefix-char
8361 followed by the corresponding non-meta character. Keymaps in
8362 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8365 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8368 NEXT may be the same array as CURRENT. */
8371 follow_key (key
, nmaps
, current
, defs
, next
)
8373 Lisp_Object
*current
, *defs
, *next
;
8376 int i
, first_binding
;
8378 first_binding
= nmaps
;
8379 for (i
= nmaps
- 1; i
>= 0; i
--)
8381 if (! NILP (current
[i
]))
8383 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8384 if (! NILP (defs
[i
]))
8391 /* Given the set of bindings we've found, produce the next set of maps. */
8392 if (first_binding
< nmaps
)
8393 for (i
= 0; i
< nmaps
; i
++)
8394 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8396 return first_binding
;
8399 /* Structure used to keep track of partial application of key remapping
8400 such as Vfunction_key_map and Vkey_translation_map. */
8401 typedef struct keyremap
8403 Lisp_Object map
, parent
;
8407 /* Lookup KEY in MAP.
8408 MAP is a keymap mapping keys to key vectors or functions.
8409 If the mapping is a function and DO_FUNCTION is non-zero, then
8410 the function is called with PROMPT as parameter and its return
8411 value is used as the return value of this function (after checking
8412 that it is indeed a vector). */
8415 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8416 Lisp_Object map
, key
, prompt
;
8421 next
= access_keymap (map
, key
, 1, 0, 1);
8423 /* Handle symbol with autoload definition. */
8424 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8425 && CONSP (XSYMBOL (next
)->function
)
8426 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8427 do_autoload (XSYMBOL (next
)->function
, next
);
8429 /* Handle a symbol whose function definition is a keymap
8431 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8432 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8433 || KEYMAPP (XSYMBOL (next
)->function
)))
8434 next
= XSYMBOL (next
)->function
;
8436 /* If the keymap gives a function, not an
8437 array, then call the function with one arg and use
8438 its value instead. */
8439 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8444 next
= call1 (next
, prompt
);
8445 /* If the function returned something invalid,
8446 barf--don't ignore it.
8447 (To ignore it safely, we would need to gcpro a bunch of
8448 other variables.) */
8449 if (! (VECTORP (next
) || STRINGP (next
)))
8450 error ("Function %s returns invalid key sequence", tem
);
8455 /* Do one step of the key remapping used for function-key-map and
8456 key-translation-map:
8457 KEYBUF is the buffer holding the input events.
8458 BUFSIZE is its maximum size.
8459 FKEY is a pointer to the keyremap structure to use.
8460 INPUT is the index of the last element in KEYBUF.
8461 DOIT if non-zero says that the remapping can actually take place.
8462 DIFF is used to return the number of keys added/removed by the remapping.
8463 PARENT is the root of the keymap.
8464 PROMPT is the prompt to use if the remapping happens through a function.
8465 The return value is non-zero if the remapping actually took place. */
8468 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8469 Lisp_Object
*keybuf
, prompt
;
8471 int input
, doit
, *diff
, bufsize
;
8473 Lisp_Object next
, key
;
8475 key
= keybuf
[fkey
->end
++];
8476 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8478 /* If keybuf[fkey->start..fkey->end] is bound in the
8479 map and we're in a position to do the key remapping, replace it with
8480 the binding and restart with fkey->start at the end. */
8481 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8483 int len
= XFASTINT (Flength (next
));
8486 *diff
= len
- (fkey
->end
- fkey
->start
);
8488 if (input
+ *diff
>= bufsize
)
8489 error ("Key sequence too long");
8491 /* Shift the keys that follow fkey->end. */
8493 for (i
= fkey
->end
; i
< input
; i
++)
8494 keybuf
[i
+ *diff
] = keybuf
[i
];
8496 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8497 keybuf
[i
+ *diff
] = keybuf
[i
];
8498 /* Overwrite the old keys with the new ones. */
8499 for (i
= 0; i
< len
; i
++)
8500 keybuf
[fkey
->start
+ i
]
8501 = Faref (next
, make_number (i
));
8503 fkey
->start
= fkey
->end
+= *diff
;
8504 fkey
->map
= fkey
->parent
;
8509 fkey
->map
= get_keymap (next
, 0, 1);
8511 /* If we no longer have a bound suffix, try a new position for
8513 if (!CONSP (fkey
->map
))
8515 fkey
->end
= ++fkey
->start
;
8516 fkey
->map
= fkey
->parent
;
8521 /* Read a sequence of keys that ends with a non prefix character,
8522 storing it in KEYBUF, a buffer of size BUFSIZE.
8524 Return the length of the key sequence stored.
8525 Return -1 if the user rejected a command menu.
8527 Echo starting immediately unless `prompt' is 0.
8529 Where a key sequence ends depends on the currently active keymaps.
8530 These include any minor mode keymaps active in the current buffer,
8531 the current buffer's local map, and the global map.
8533 If a key sequence has no other bindings, we check Vfunction_key_map
8534 to see if some trailing subsequence might be the beginning of a
8535 function key's sequence. If so, we try to read the whole function
8536 key, and substitute its symbolic name into the key sequence.
8538 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8539 `double-' events into similar click events, if that would make them
8540 bound. We try to turn `triple-' events first into `double-' events,
8543 If we get a mouse click in a mode line, vertical divider, or other
8544 non-text area, we treat the click as if it were prefixed by the
8545 symbol denoting that area - `mode-line', `vertical-line', or
8548 If the sequence starts with a mouse click, we read the key sequence
8549 with respect to the buffer clicked on, not the current buffer.
8551 If the user switches frames in the midst of a key sequence, we put
8552 off the switch-frame event until later; the next call to
8553 read_char will return it.
8555 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8556 from the selected window's buffer. */
8559 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8560 can_return_switch_frame
, fix_current_buffer
)
8561 Lisp_Object
*keybuf
;
8564 int dont_downcase_last
;
8565 int can_return_switch_frame
;
8566 int fix_current_buffer
;
8568 volatile Lisp_Object from_string
;
8569 volatile int count
= SPECPDL_INDEX ();
8571 /* How many keys there are in the current key sequence. */
8574 /* The length of the echo buffer when we started reading, and
8575 the length of this_command_keys when we started reading. */
8576 volatile int echo_start
;
8577 volatile int keys_start
;
8579 /* The number of keymaps we're scanning right now, and the number of
8580 keymaps we have allocated space for. */
8582 volatile int nmaps_allocated
= 0;
8584 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8585 the current keymaps. */
8586 Lisp_Object
*volatile defs
= NULL
;
8588 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8589 in the current keymaps, or nil where it is not a prefix. */
8590 Lisp_Object
*volatile submaps
= NULL
;
8592 /* The local map to start out with at start of key sequence. */
8593 volatile Lisp_Object orig_local_map
;
8595 /* The map from the `keymap' property to start out with at start of
8597 volatile Lisp_Object orig_keymap
;
8599 /* 1 if we have already considered switching to the local-map property
8600 of the place where a mouse click occurred. */
8601 volatile int localized_local_map
= 0;
8603 /* The index in defs[] of the first keymap that has a binding for
8604 this key sequence. In other words, the lowest i such that
8605 defs[i] is non-nil. */
8606 volatile int first_binding
;
8607 /* Index of the first key that has no binding.
8608 It is useless to try fkey.start larger than that. */
8609 volatile int first_unbound
;
8611 /* If t < mock_input, then KEYBUF[t] should be read as the next
8614 We use this to recover after recognizing a function key. Once we
8615 realize that a suffix of the current key sequence is actually a
8616 function key's escape sequence, we replace the suffix with the
8617 function key's binding from Vfunction_key_map. Now keybuf
8618 contains a new and different key sequence, so the echo area,
8619 this_command_keys, and the submaps and defs arrays are wrong. In
8620 this situation, we set mock_input to t, set t to 0, and jump to
8621 restart_sequence; the loop will read keys from keybuf up until
8622 mock_input, thus rebuilding the state; and then it will resume
8623 reading characters from the keyboard. */
8624 volatile int mock_input
= 0;
8626 /* If the sequence is unbound in submaps[], then
8627 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8628 and fkey.map is its binding.
8630 These might be > t, indicating that all function key scanning
8631 should hold off until t reaches them. We do this when we've just
8632 recognized a function key, to avoid searching for the function
8633 key's again in Vfunction_key_map. */
8634 volatile keyremap fkey
;
8636 /* Likewise, for key_translation_map. */
8637 volatile keyremap keytran
;
8639 /* If we receive a `switch-frame' or `select-window' event in the middle of
8640 a key sequence, we put it off for later.
8641 While we're reading, we keep the event here. */
8642 volatile Lisp_Object delayed_switch_frame
;
8644 /* See the comment below... */
8645 #if defined (GOBBLE_FIRST_EVENT)
8646 Lisp_Object first_event
;
8649 volatile Lisp_Object original_uppercase
;
8650 volatile int original_uppercase_position
= -1;
8652 /* Gets around Microsoft compiler limitations. */
8655 struct buffer
*starting_buffer
;
8657 /* List of events for which a fake prefix key has been generated. */
8658 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8660 #if defined (GOBBLE_FIRST_EVENT)
8664 struct gcpro gcpro1
;
8666 GCPRO1 (fake_prefixed_keys
);
8667 raw_keybuf_count
= 0;
8669 last_nonmenu_event
= Qnil
;
8671 delayed_switch_frame
= Qnil
;
8672 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
8673 keytran
.map
= keytran
.parent
= current_kboard
->Vlocal_key_translation_map
;
8674 /* If there is no translation-map, turn off scanning. */
8675 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8676 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8681 echo_prompt (prompt
);
8682 else if (cursor_in_echo_area
8683 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8684 && NILP (Fzerop (Vecho_keystrokes
)))
8685 /* This doesn't put in a dash if the echo buffer is empty, so
8686 you don't always see a dash hanging out in the minibuffer. */
8690 /* Record the initial state of the echo area and this_command_keys;
8691 we will need to restore them if we replay a key sequence. */
8693 echo_start
= echo_length ();
8694 keys_start
= this_command_key_count
;
8695 this_single_command_key_start
= keys_start
;
8697 #if defined (GOBBLE_FIRST_EVENT)
8698 /* This doesn't quite work, because some of the things that read_char
8699 does cannot safely be bypassed. It seems too risky to try to make
8702 /* Read the first char of the sequence specially, before setting
8703 up any keymaps, in case a filter runs and switches buffers on us. */
8704 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8706 #endif /* GOBBLE_FIRST_EVENT */
8708 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8709 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8712 /* We jump here when the key sequence has been thoroughly changed, and
8713 we need to rescan it starting from the beginning. When we jump here,
8714 keybuf[0..mock_input] holds the sequence we should reread. */
8717 starting_buffer
= current_buffer
;
8718 first_unbound
= bufsize
+ 1;
8720 /* Build our list of keymaps.
8721 If we recognize a function key and replace its escape sequence in
8722 keybuf with its symbol, or if the sequence starts with a mouse
8723 click and we need to switch buffers, we jump back here to rebuild
8724 the initial keymaps from the current buffer. */
8727 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8728 || !NILP (Voverriding_local_map
))
8730 if (3 > nmaps_allocated
)
8732 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8733 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8734 nmaps_allocated
= 3;
8736 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8737 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8738 if (!NILP (Voverriding_local_map
))
8739 submaps
[nmaps
++] = Voverriding_local_map
;
8747 nminor
= current_minor_maps (0, &maps
);
8748 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8750 if (total
> nmaps_allocated
)
8752 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8753 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8754 nmaps_allocated
= total
;
8757 if (!NILP (orig_keymap
))
8758 submaps
[nmaps
++] = orig_keymap
;
8760 bcopy (maps
, (void *) (submaps
+ nmaps
),
8761 nminor
* sizeof (submaps
[0]));
8765 submaps
[nmaps
++] = orig_local_map
;
8767 submaps
[nmaps
++] = current_global_map
;
8769 /* Find an accurate initial value for first_binding. */
8770 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8771 if (! NILP (submaps
[first_binding
]))
8774 /* Start from the beginning in keybuf. */
8777 /* These are no-ops the first time through, but if we restart, they
8778 revert the echo area and this_command_keys to their original state. */
8779 this_command_key_count
= keys_start
;
8780 if (INTERACTIVE
&& t
< mock_input
)
8781 echo_truncate (echo_start
);
8783 /* If the best binding for the current key sequence is a keymap, or
8784 we may be looking at a function key's escape sequence, keep on
8786 while (first_binding
< nmaps
8787 /* Keep reading as long as there's a prefix binding. */
8788 ? !NILP (submaps
[first_binding
])
8789 /* Don't return in the middle of a possible function key sequence,
8790 if the only bindings we found were via case conversion.
8791 Thus, if ESC O a has a function-key-map translation
8792 and ESC o has a binding, don't return after ESC O,
8793 so that we can translate ESC O plus the next character. */
8794 : (fkey
.start
< t
|| keytran
.start
< t
))
8797 int used_mouse_menu
= 0;
8799 /* Where the last real key started. If we need to throw away a
8800 key that has expanded into more than one element of keybuf
8801 (say, a mouse click on the mode line which is being treated
8802 as [mode-line (mouse-...)], then we backtrack to this point
8804 volatile int last_real_key_start
;
8806 /* These variables are analogous to echo_start and keys_start;
8807 while those allow us to restart the entire key sequence,
8808 echo_local_start and keys_local_start allow us to throw away
8810 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8812 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8813 eassert (fkey
.start
<= fkey
.end
);
8814 eassert (keytran
.start
<= keytran
.end
);
8815 /* key-translation-map is applied *after* function-key-map. */
8816 eassert (keytran
.end
<= fkey
.start
);
8818 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8819 { /* The prefix upto first_unbound has no binding and has
8820 no translation left to do either, so we know it's unbound.
8821 If we don't stop now, we risk staying here indefinitely
8822 (if the user keeps entering fkey or keytran prefixes
8823 like C-c ESC ESC ESC ESC ...) */
8825 for (i
= first_unbound
+ 1; i
< t
; i
++)
8826 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8827 mock_input
= t
- first_unbound
- 1;
8828 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8829 fkey
.map
= fkey
.parent
;
8830 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8831 keytran
.map
= keytran
.parent
;
8832 goto replay_sequence
;
8836 error ("Key sequence too long");
8839 echo_local_start
= echo_length ();
8840 keys_local_start
= this_command_key_count
;
8841 local_first_binding
= first_binding
;
8844 /* These are no-ops, unless we throw away a keystroke below and
8845 jumped back up to replay_key; in that case, these restore the
8846 variables to their original state, allowing us to replay the
8848 if (INTERACTIVE
&& t
< mock_input
)
8849 echo_truncate (echo_local_start
);
8850 this_command_key_count
= keys_local_start
;
8851 first_binding
= local_first_binding
;
8853 /* By default, assume each event is "real". */
8854 last_real_key_start
= t
;
8856 /* Does mock_input indicate that we are re-reading a key sequence? */
8860 add_command_key (key
);
8861 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8862 && NILP (Fzerop (Vecho_keystrokes
)))
8866 /* If not, we should actually read a character. */
8871 KBOARD
*interrupted_kboard
= current_kboard
;
8872 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8873 if (setjmp (wrong_kboard_jmpbuf
))
8875 if (!NILP (delayed_switch_frame
))
8877 interrupted_kboard
->kbd_queue
8878 = Fcons (delayed_switch_frame
,
8879 interrupted_kboard
->kbd_queue
);
8880 delayed_switch_frame
= Qnil
;
8883 interrupted_kboard
->kbd_queue
8884 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8886 /* If the side queue is non-empty, ensure it begins with a
8887 switch-frame, so we'll replay it in the right context. */
8888 if (CONSP (interrupted_kboard
->kbd_queue
)
8889 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8890 !(EVENT_HAS_PARAMETERS (key
)
8891 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8895 XSETFRAME (frame
, interrupted_frame
);
8896 interrupted_kboard
->kbd_queue
8897 = Fcons (make_lispy_switch_frame (frame
),
8898 interrupted_kboard
->kbd_queue
);
8901 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8902 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8903 goto replay_sequence
;
8906 key
= read_char (NILP (prompt
), nmaps
,
8907 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8911 /* read_char returns t when it shows a menu and the user rejects it.
8915 unbind_to (count
, Qnil
);
8920 /* read_char returns -1 at the end of a macro.
8921 Emacs 18 handles this by returning immediately with a
8922 zero, so that's what we'll do. */
8923 if (INTEGERP (key
) && XINT (key
) == -1)
8926 /* The Microsoft C compiler can't handle the goto that
8932 /* If the current buffer has been changed from under us, the
8933 keymap may have changed, so replay the sequence. */
8936 timer_resume_idle ();
8939 /* Reset the current buffer from the selected window
8940 in case something changed the former and not the latter.
8941 This is to be more consistent with the behavior
8942 of the command_loop_1. */
8943 if (fix_current_buffer
)
8945 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8947 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8948 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8951 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8952 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8953 goto replay_sequence
;
8956 /* If we have a quit that was typed in another frame, and
8957 quit_throw_to_read_char switched buffers,
8958 replay to get the right keymap. */
8960 && XINT (key
) == quit_char
8961 && current_buffer
!= starting_buffer
)
8964 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8968 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8969 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8970 goto replay_sequence
;
8975 if (EVENT_HAS_PARAMETERS (key
)
8976 /* Either a `switch-frame' or a `select-window' event. */
8977 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8979 /* If we're at the beginning of a key sequence, and the caller
8980 says it's okay, go ahead and return this event. If we're
8981 in the midst of a key sequence, delay it until the end. */
8982 if (t
> 0 || !can_return_switch_frame
)
8984 delayed_switch_frame
= key
;
8990 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8993 /* Clicks in non-text areas get prefixed by the symbol
8994 in their CHAR-ADDRESS field. For example, a click on
8995 the mode line is prefixed by the symbol `mode-line'.
8997 Furthermore, key sequences beginning with mouse clicks
8998 are read using the keymaps of the buffer clicked on, not
8999 the current buffer. So we may have to switch the buffer
9002 When we turn one event into two events, we must make sure
9003 that neither of the two looks like the original--so that,
9004 if we replay the events, they won't be expanded again.
9005 If not for this, such reexpansion could happen either here
9006 or when user programs play with this-command-keys. */
9007 if (EVENT_HAS_PARAMETERS (key
))
9012 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9013 if (EQ (kind
, Qmouse_click
))
9015 Lisp_Object window
, posn
;
9017 window
= POSN_WINDOW (EVENT_START (key
));
9018 posn
= POSN_POSN (EVENT_START (key
));
9021 || (!NILP (fake_prefixed_keys
)
9022 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9024 /* We're looking a second time at an event for which
9025 we generated a fake prefix key. Set
9026 last_real_key_start appropriately. */
9028 last_real_key_start
= t
- 1;
9031 /* Key sequences beginning with mouse clicks are
9032 read using the keymaps in the buffer clicked on,
9033 not the current buffer. If we're at the
9034 beginning of a key sequence, switch buffers. */
9035 if (last_real_key_start
== 0
9037 && BUFFERP (XWINDOW (window
)->buffer
)
9038 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9040 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9044 /* Arrange to go back to the original buffer once we're
9045 done reading the key sequence. Note that we can't
9046 use save_excursion_{save,restore} here, because they
9047 save point as well as the current buffer; we don't
9048 want to save point, because redisplay may change it,
9049 to accommodate a Fset_window_start or something. We
9050 don't want to do this at the top of the function,
9051 because we may get input from a subprocess which
9052 wants to change the selected window and stuff (say,
9054 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9056 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9058 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9059 orig_local_map
= get_local_map (PT
, current_buffer
,
9061 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9062 goto replay_sequence
;
9065 /* For a mouse click, get the local text-property keymap
9066 of the place clicked on, rather than point. */
9067 if (last_real_key_start
== 0
9068 && CONSP (XCDR (key
))
9069 && ! localized_local_map
)
9071 Lisp_Object map_here
, start
, pos
;
9073 localized_local_map
= 1;
9074 start
= EVENT_START (key
);
9076 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9078 pos
= POSN_BUFFER_POSN (start
);
9080 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9082 map_here
= get_local_map (XINT (pos
),
9083 current_buffer
, Qlocal_map
);
9084 if (!EQ (map_here
, orig_local_map
))
9086 orig_local_map
= map_here
;
9090 goto replay_sequence
;
9092 map_here
= get_local_map (XINT (pos
),
9093 current_buffer
, Qkeymap
);
9094 if (!EQ (map_here
, orig_keymap
))
9096 orig_keymap
= map_here
;
9100 goto replay_sequence
;
9106 /* Expand mode-line and scroll-bar events into two events:
9107 use posn as a fake prefix key. */
9109 && (NILP (fake_prefixed_keys
)
9110 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9112 if (t
+ 1 >= bufsize
)
9113 error ("Key sequence too long");
9116 keybuf
[t
+ 1] = key
;
9119 /* Record that a fake prefix key has been generated
9120 for KEY. Don't modify the event; this would
9121 prevent proper action when the event is pushed
9122 back into unread-command-events. */
9123 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9125 /* If on a mode line string with a local keymap,
9126 reconsider the key sequence with that keymap. */
9127 if (string
= POSN_STRING (EVENT_START (key
)),
9128 (CONSP (string
) && STRINGP (XCAR (string
))))
9130 Lisp_Object pos
, map
, map2
;
9132 pos
= XCDR (string
);
9133 string
= XCAR (string
);
9135 && XINT (pos
) < SCHARS (string
))
9137 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9139 orig_local_map
= map
;
9140 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9143 if (!NILP (map
) || !NILP (map2
))
9144 goto replay_sequence
;
9150 else if (NILP (from_string
)
9151 && (string
= POSN_STRING (EVENT_START (key
)),
9152 (CONSP (string
) && STRINGP (XCAR (string
)))))
9154 /* For a click on a string, i.e. overlay string or a
9155 string displayed via the `display' property,
9156 consider `local-map' and `keymap' properties of
9158 Lisp_Object pos
, map
, map2
;
9160 pos
= XCDR (string
);
9161 string
= XCAR (string
);
9163 && XINT (pos
) < SCHARS (string
))
9165 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9167 orig_local_map
= map
;
9168 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9172 if (!NILP (map
) || !NILP (map2
))
9174 from_string
= string
;
9175 goto replay_sequence
;
9180 else if (CONSP (XCDR (key
))
9181 && CONSP (EVENT_START (key
))
9182 && CONSP (XCDR (EVENT_START (key
))))
9186 posn
= POSN_POSN (EVENT_START (key
));
9187 /* Handle menu-bar events:
9188 insert the dummy prefix event `menu-bar'. */
9189 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9191 if (t
+ 1 >= bufsize
)
9192 error ("Key sequence too long");
9196 /* Zap the position in key, so we know that we've
9197 expanded it, and don't try to do so again. */
9198 POSN_SET_POSN (EVENT_START (key
),
9199 Fcons (posn
, Qnil
));
9202 goto replay_sequence
;
9204 else if (CONSP (posn
))
9206 /* We're looking at the second event of a
9207 sequence which we expanded before. Set
9208 last_real_key_start appropriately. */
9209 if (last_real_key_start
== t
&& t
> 0)
9210 last_real_key_start
= t
- 1;
9215 /* We have finally decided that KEY is something we might want
9217 first_binding
= (follow_key (key
,
9218 nmaps
- first_binding
,
9219 submaps
+ first_binding
,
9220 defs
+ first_binding
,
9221 submaps
+ first_binding
)
9224 /* If KEY wasn't bound, we'll try some fallbacks. */
9225 if (first_binding
< nmaps
)
9226 /* This is needed for the following scenario:
9227 event 0: a down-event that gets dropped by calling replay_key.
9228 event 1: some normal prefix like C-h.
9229 After event 0, first_unbound is 0, after event 1 fkey.start
9230 and keytran.start are both 1, so when we see that C-h is bound,
9231 we need to update first_unbound. */
9232 first_unbound
= max (t
+ 1, first_unbound
);
9237 /* Remember the position to put an upper bound on fkey.start. */
9238 first_unbound
= min (t
, first_unbound
);
9240 head
= EVENT_HEAD (key
);
9241 if (help_char_p (head
) && t
> 0)
9243 read_key_sequence_cmd
= Vprefix_help_command
;
9245 last_nonmenu_event
= key
;
9246 /* The Microsoft C compiler can't handle the goto that
9254 Lisp_Object breakdown
;
9257 breakdown
= parse_modifiers (head
);
9258 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9259 /* Attempt to reduce an unbound mouse event to a simpler
9260 event that is bound:
9261 Drags reduce to clicks.
9262 Double-clicks reduce to clicks.
9263 Triple-clicks reduce to double-clicks, then to clicks.
9264 Down-clicks are eliminated.
9265 Double-downs reduce to downs, then are eliminated.
9266 Triple-downs reduce to double-downs, then to downs,
9267 then are eliminated. */
9268 if (modifiers
& (down_modifier
| drag_modifier
9269 | double_modifier
| triple_modifier
))
9271 while (modifiers
& (down_modifier
| drag_modifier
9272 | double_modifier
| triple_modifier
))
9274 Lisp_Object new_head
, new_click
;
9275 if (modifiers
& triple_modifier
)
9276 modifiers
^= (double_modifier
| triple_modifier
);
9277 else if (modifiers
& double_modifier
)
9278 modifiers
&= ~double_modifier
;
9279 else if (modifiers
& drag_modifier
)
9280 modifiers
&= ~drag_modifier
;
9283 /* Dispose of this `down' event by simply jumping
9284 back to replay_key, to get another event.
9286 Note that if this event came from mock input,
9287 then just jumping back to replay_key will just
9288 hand it to us again. So we have to wipe out any
9291 We could delete keybuf[t] and shift everything
9292 after that to the left by one spot, but we'd also
9293 have to fix up any variable that points into
9294 keybuf, and shifting isn't really necessary
9297 Adding prefixes for non-textual mouse clicks
9298 creates two characters of mock input, and both
9299 must be thrown away. If we're only looking at
9300 the prefix now, we can just jump back to
9301 replay_key. On the other hand, if we've already
9302 processed the prefix, and now the actual click
9303 itself is giving us trouble, then we've lost the
9304 state of the keymaps we want to backtrack to, and
9305 we need to replay the whole sequence to rebuild
9308 Beyond that, only function key expansion could
9309 create more than two keys, but that should never
9310 generate mouse events, so it's okay to zero
9311 mock_input in that case too.
9313 FIXME: The above paragraph seems just plain
9314 wrong, if you consider things like
9315 xterm-mouse-mode. -stef
9317 Isn't this just the most wonderful code ever? */
9319 /* If mock_input > t + 1, the above simplification
9320 will actually end up dropping keys on the floor.
9321 This is probably OK for now, but even
9322 if mock_input <= t + 1, we need to adjust fkey
9324 Typical case [header-line down-mouse-N]:
9325 mock_input = 2, t = 1, fkey.end = 1,
9326 last_real_key_start = 0. */
9327 if (fkey
.end
> last_real_key_start
)
9329 fkey
.end
= fkey
.start
9330 = min (last_real_key_start
, fkey
.start
);
9331 fkey
.map
= fkey
.parent
;
9332 if (keytran
.end
> last_real_key_start
)
9334 keytran
.end
= keytran
.start
9335 = min (last_real_key_start
, keytran
.start
);
9336 keytran
.map
= keytran
.parent
;
9339 if (t
== last_real_key_start
)
9346 mock_input
= last_real_key_start
;
9347 goto replay_sequence
;
9352 = apply_modifiers (modifiers
, XCAR (breakdown
));
9354 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9356 /* Look for a binding for this new key. follow_key
9357 promises that it didn't munge submaps the
9358 last time we called it, since key was unbound. */
9360 = (follow_key (new_click
,
9361 nmaps
- local_first_binding
,
9362 submaps
+ local_first_binding
,
9363 defs
+ local_first_binding
,
9364 submaps
+ local_first_binding
)
9365 + local_first_binding
);
9367 /* If that click is bound, go for it. */
9368 if (first_binding
< nmaps
)
9373 /* Otherwise, we'll leave key set to the drag event. */
9380 /* Normally, last_nonmenu_event gets the previous key we read.
9381 But when a mouse popup menu is being used,
9382 we don't update last_nonmenu_event; it continues to hold the mouse
9383 event that preceded the first level of menu. */
9384 if (!used_mouse_menu
)
9385 last_nonmenu_event
= key
;
9387 /* Record what part of this_command_keys is the current key sequence. */
9388 this_single_command_key_start
= this_command_key_count
- t
;
9390 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9391 /* There is a binding and it's not a prefix.
9392 There is thus no function-key in this sequence.
9393 Moving fkey.start is important in this case to allow keytran.start
9394 to go over the sequence before we return (since we keep the
9395 invariant that keytran.end <= fkey.start). */
9398 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9401 /* If the sequence is unbound, see if we can hang a function key
9402 off the end of it. */
9403 /* Continue scan from fkey.end until we find a bound suffix. */
9404 while (fkey
.end
< t
)
9406 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9409 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9410 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9411 max (t
, mock_input
),
9412 /* If there's a binding (i.e.
9413 first_binding >= nmaps) we don't want
9414 to apply this function-key-mapping. */
9415 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9420 mock_input
= diff
+ max (t
, mock_input
);
9421 goto replay_sequence
;
9425 /* Look for this sequence in key-translation-map.
9426 Scan from keytran.end until we find a bound suffix. */
9427 while (keytran
.end
< fkey
.start
)
9429 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9432 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9433 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9438 mock_input
= diff
+ max (t
, mock_input
);
9439 /* Adjust the function-key-map counters. */
9443 goto replay_sequence
;
9447 /* If KEY is not defined in any of the keymaps,
9448 and cannot be part of a function key or translation,
9449 and is an upper case letter
9450 use the corresponding lower-case letter instead. */
9451 if (first_binding
>= nmaps
9452 && fkey
.start
>= t
&& keytran
.start
>= t
9454 && ((((XINT (key
) & 0x3ffff)
9455 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9456 && UPPERCASEP (XINT (key
) & 0x3ffff))
9457 || (XINT (key
) & shift_modifier
)))
9459 Lisp_Object new_key
;
9461 original_uppercase
= key
;
9462 original_uppercase_position
= t
- 1;
9464 if (XINT (key
) & shift_modifier
)
9465 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9467 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9468 | (XINT (key
) & ~0x3ffff)));
9470 /* We have to do this unconditionally, regardless of whether
9471 the lower-case char is defined in the keymaps, because they
9472 might get translated through function-key-map. */
9473 keybuf
[t
- 1] = new_key
;
9474 mock_input
= max (t
, mock_input
);
9476 goto replay_sequence
;
9478 /* If KEY is not defined in any of the keymaps,
9479 and cannot be part of a function key or translation,
9480 and is a shifted function key,
9481 use the corresponding unshifted function key instead. */
9482 if (first_binding
>= nmaps
9483 && fkey
.start
>= t
&& keytran
.start
>= t
9486 Lisp_Object breakdown
;
9489 breakdown
= parse_modifiers (key
);
9490 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9491 if (modifiers
& shift_modifier
)
9493 Lisp_Object new_key
;
9495 original_uppercase
= key
;
9496 original_uppercase_position
= t
- 1;
9498 modifiers
&= ~shift_modifier
;
9499 new_key
= apply_modifiers (modifiers
,
9502 keybuf
[t
- 1] = new_key
;
9503 mock_input
= max (t
, mock_input
);
9504 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9505 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9507 goto replay_sequence
;
9513 read_key_sequence_cmd
= (first_binding
< nmaps
9514 ? defs
[first_binding
]
9517 unread_switch_frame
= delayed_switch_frame
;
9518 unbind_to (count
, Qnil
);
9520 /* Don't downcase the last character if the caller says don't.
9521 Don't downcase it if the result is undefined, either. */
9522 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9523 && t
- 1 == original_uppercase_position
)
9524 keybuf
[t
- 1] = original_uppercase
;
9526 /* Occasionally we fabricate events, perhaps by expanding something
9527 according to function-key-map, or by adding a prefix symbol to a
9528 mouse click in the scroll bar or modeline. In this cases, return
9529 the entire generated key sequence, even if we hit an unbound
9530 prefix or a definition before the end. This means that you will
9531 be able to push back the event properly, and also means that
9532 read-key-sequence will always return a logical unit.
9535 for (; t
< mock_input
; t
++)
9537 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9538 && NILP (Fzerop (Vecho_keystrokes
)))
9539 echo_char (keybuf
[t
]);
9540 add_command_key (keybuf
[t
]);
9549 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9550 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9551 The sequence is sufficient to specify a non-prefix command in the
9552 current local and global maps.
9554 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9555 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9556 as a continuation of the previous key.
9558 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9559 convert the last event to lower case. (Normally any upper case event
9560 is converted to lower case if the original event is undefined and the lower
9561 case equivalent is defined.) A non-nil value is appropriate for reading
9562 a key sequence to be defined.
9564 A C-g typed while in this function is treated like any other character,
9565 and `quit-flag' is not set.
9567 If the key sequence starts with a mouse click, then the sequence is read
9568 using the keymaps of the buffer of the window clicked in, not the buffer
9569 of the selected window as normal.
9571 `read-key-sequence' drops unbound button-down events, since you normally
9572 only care about the click or drag events which follow them. If a drag
9573 or multi-click event is unbound, but the corresponding click event would
9574 be bound, `read-key-sequence' turns the event into a click event at the
9575 drag's starting position. This means that you don't have to distinguish
9576 between click and drag, double, or triple events unless you want to.
9578 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9579 lines separating windows, and scroll bars with imaginary keys
9580 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9582 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9583 function will process a switch-frame event if the user switches frames
9584 before typing anything. If the user switches frames in the middle of a
9585 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9586 is nil, then the event will be put off until after the current key sequence.
9588 `read-key-sequence' checks `function-key-map' for function key
9589 sequences, where they wouldn't conflict with ordinary bindings. See
9590 `function-key-map' for more details.
9592 The optional fifth argument COMMAND-LOOP, if non-nil, means
9593 that this key sequence is being read by something that will
9594 read commands one after another. It should be nil if the caller
9595 will read just one key sequence. */)
9596 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9598 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9599 Lisp_Object can_return_switch_frame
, command_loop
;
9601 Lisp_Object keybuf
[30];
9603 struct gcpro gcpro1
;
9604 int count
= SPECPDL_INDEX ();
9607 CHECK_STRING (prompt
);
9610 specbind (Qinput_method_exit_on_first_char
,
9611 (NILP (command_loop
) ? Qt
: Qnil
));
9612 specbind (Qinput_method_use_echo_area
,
9613 (NILP (command_loop
) ? Qt
: Qnil
));
9615 bzero (keybuf
, sizeof keybuf
);
9617 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9619 if (NILP (continue_echo
))
9621 this_command_key_count
= 0;
9622 this_command_key_count_reset
= 0;
9623 this_single_command_key_start
= 0;
9626 #ifdef HAVE_X_WINDOWS
9627 if (display_hourglass_p
)
9628 cancel_hourglass ();
9631 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9632 prompt
, ! NILP (dont_downcase_last
),
9633 ! NILP (can_return_switch_frame
), 0);
9635 #if 0 /* The following is fine for code reading a key sequence and
9636 then proceeding with a lenghty computation, but it's not good
9637 for code reading keys in a loop, like an input method. */
9638 #ifdef HAVE_X_WINDOWS
9639 if (display_hourglass_p
)
9650 return unbind_to (count
, make_event_array (i
, keybuf
));
9653 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9654 Sread_key_sequence_vector
, 1, 5, 0,
9655 doc
: /* Like `read-key-sequence' but always return a vector. */)
9656 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9658 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9659 Lisp_Object can_return_switch_frame
, command_loop
;
9661 Lisp_Object keybuf
[30];
9663 struct gcpro gcpro1
;
9664 int count
= SPECPDL_INDEX ();
9667 CHECK_STRING (prompt
);
9670 specbind (Qinput_method_exit_on_first_char
,
9671 (NILP (command_loop
) ? Qt
: Qnil
));
9672 specbind (Qinput_method_use_echo_area
,
9673 (NILP (command_loop
) ? Qt
: Qnil
));
9675 bzero (keybuf
, sizeof keybuf
);
9677 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9679 if (NILP (continue_echo
))
9681 this_command_key_count
= 0;
9682 this_command_key_count_reset
= 0;
9683 this_single_command_key_start
= 0;
9686 #ifdef HAVE_X_WINDOWS
9687 if (display_hourglass_p
)
9688 cancel_hourglass ();
9691 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9692 prompt
, ! NILP (dont_downcase_last
),
9693 ! NILP (can_return_switch_frame
), 0);
9695 #ifdef HAVE_X_WINDOWS
9696 if (display_hourglass_p
)
9706 return unbind_to (count
, Fvector (i
, keybuf
));
9709 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9710 doc
: /* Execute CMD as an editor command.
9711 CMD must be a symbol that satisfies the `commandp' predicate.
9712 Optional second arg RECORD-FLAG non-nil
9713 means unconditionally put this command in `command-history'.
9714 Otherwise, that is done only if an arg is read using the minibuffer.
9715 The argument KEYS specifies the value to use instead of (this-command-keys)
9716 when reading the arguments; if it is nil, (this-command-keys) is used.
9717 The argument SPECIAL, if non-nil, means that this command is executing
9718 a special event, so ignore the prefix argument and don't clear it. */)
9719 (cmd
, record_flag
, keys
, special
)
9720 Lisp_Object cmd
, record_flag
, keys
, special
;
9722 register Lisp_Object final
;
9723 register Lisp_Object tem
;
9724 Lisp_Object prefixarg
;
9725 struct backtrace backtrace
;
9726 extern int debug_on_next_call
;
9728 debug_on_next_call
= 0;
9732 prefixarg
= current_kboard
->Vprefix_arg
;
9733 Vcurrent_prefix_arg
= prefixarg
;
9734 current_kboard
->Vprefix_arg
= Qnil
;
9741 tem
= Fget (cmd
, Qdisabled
);
9742 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9744 tem
= Fsymbol_value (Qdisabled_command_function
);
9746 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9752 final
= Findirect_function (cmd
);
9754 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9756 struct gcpro gcpro1
, gcpro2
;
9758 GCPRO2 (cmd
, prefixarg
);
9759 do_autoload (final
, cmd
);
9766 if (STRINGP (final
) || VECTORP (final
))
9768 /* If requested, place the macro in the command history. For
9769 other sorts of commands, call-interactively takes care of
9771 if (!NILP (record_flag
))
9774 = Fcons (Fcons (Qexecute_kbd_macro
,
9775 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9778 /* Don't keep command history around forever. */
9779 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9781 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9783 XSETCDR (tem
, Qnil
);
9787 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9790 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9792 backtrace
.next
= backtrace_list
;
9793 backtrace_list
= &backtrace
;
9794 backtrace
.function
= &Qcall_interactively
;
9795 backtrace
.args
= &cmd
;
9796 backtrace
.nargs
= 1;
9797 backtrace
.evalargs
= 0;
9798 backtrace
.debug_on_exit
= 0;
9800 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9802 backtrace_list
= backtrace
.next
;
9810 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9812 doc
: /* Read function name, then read its arguments and call it. */)
9814 Lisp_Object prefixarg
;
9816 Lisp_Object function
;
9818 int saved_last_point_position
;
9819 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9820 Lisp_Object bindings
, value
;
9821 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9822 #ifdef HAVE_X_WINDOWS
9823 /* The call to Fcompleting_read wil start and cancel the hourglass,
9824 but if the hourglass was already scheduled, this means that no
9825 hourglass will be shown for the actual M-x command itself.
9826 So we restart it if it is already scheduled. Note that checking
9827 hourglass_shown_p is not enough, normally the hourglass is not shown,
9828 just scheduled to be shown. */
9829 int hstarted
= hourglass_started ();
9832 saved_keys
= Fvector (this_command_key_count
,
9833 XVECTOR (this_command_keys
)->contents
);
9834 saved_last_point_position_buffer
= last_point_position_buffer
;
9835 saved_last_point_position
= last_point_position
;
9837 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9839 if (EQ (prefixarg
, Qminus
))
9841 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9842 strcpy (buf
, "C-u ");
9843 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9844 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9845 else if (INTEGERP (prefixarg
))
9846 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9848 /* This isn't strictly correct if execute-extended-command
9849 is bound to anything else. Perhaps it should use
9850 this_command_keys? */
9851 strcat (buf
, "M-x ");
9853 /* Prompt with buf, and then read a string, completing from and
9854 restricting to the set of all defined commands. Don't provide
9855 any initial input. Save the command read on the extended-command
9857 function
= Fcompleting_read (build_string (buf
),
9858 Vobarray
, Qcommandp
,
9859 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9862 #ifdef HAVE_X_WINDOWS
9863 if (hstarted
) start_hourglass ();
9866 if (STRINGP (function
) && SCHARS (function
) == 0)
9867 error ("No command name given");
9869 /* Set this_command_keys to the concatenation of saved_keys and
9870 function, followed by a RET. */
9875 this_command_key_count
= 0;
9876 this_command_key_count_reset
= 0;
9877 this_single_command_key_start
= 0;
9879 keys
= XVECTOR (saved_keys
)->contents
;
9880 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9881 add_command_key (keys
[i
]);
9883 for (i
= 0; i
< SCHARS (function
); i
++)
9884 add_command_key (Faref (function
, make_number (i
)));
9886 add_command_key (make_number ('\015'));
9889 last_point_position
= saved_last_point_position
;
9890 last_point_position_buffer
= saved_last_point_position_buffer
;
9894 function
= Fintern (function
, Qnil
);
9895 current_kboard
->Vprefix_arg
= prefixarg
;
9896 Vthis_command
= function
;
9897 real_this_command
= function
;
9899 /* If enabled, show which key runs this command. */
9900 if (!NILP (Vsuggest_key_bindings
)
9901 && NILP (Vexecuting_kbd_macro
)
9902 && SYMBOLP (function
))
9903 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9909 GCPRO2 (bindings
, value
);
9910 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9912 /* If the command has a key binding, print it now. */
9913 if (!NILP (bindings
)
9914 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9917 /* But first wait, and skip the message if there is input. */
9919 if (!NILP (echo_area_buffer
[0]))
9920 /* This command displayed something in the echo area;
9921 so wait a few seconds, then display our suggestion message. */
9922 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9923 ? XINT (Vsuggest_key_bindings
) : 2);
9925 /* This command left the echo area empty,
9926 so display our message immediately. */
9929 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9930 && ! CONSP (Vunread_command_events
))
9932 Lisp_Object binding
;
9934 int message_p
= push_message ();
9935 int count
= SPECPDL_INDEX ();
9937 record_unwind_protect (pop_message_unwind
, Qnil
);
9938 binding
= Fkey_description (bindings
, Qnil
);
9941 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9944 sprintf (newmessage
, "You can run the command `%s' with %s",
9945 SDATA (SYMBOL_NAME (function
)),
9947 message2_nolog (newmessage
,
9948 strlen (newmessage
),
9949 STRING_MULTIBYTE (binding
));
9950 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9951 ? Vsuggest_key_bindings
: make_number (2)),
9956 unbind_to (count
, Qnil
);
9960 RETURN_UNGCPRO (value
);
9964 /* Return nonzero if input events are pending. */
9967 detect_input_pending ()
9970 get_input_pending (&input_pending
, 0);
9972 return input_pending
;
9975 /* Return nonzero if input events other than mouse movements are
9979 detect_input_pending_ignore_squeezables ()
9982 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9984 return input_pending
;
9987 /* Return nonzero if input events are pending, and run any pending timers. */
9990 detect_input_pending_run_timers (do_display
)
9993 int old_timers_run
= timers_run
;
9996 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9998 if (old_timers_run
!= timers_run
&& do_display
)
10000 redisplay_preserve_echo_area (8);
10001 /* The following fixes a bug when using lazy-lock with
10002 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10003 from an idle timer function. The symptom of the bug is that
10004 the cursor sometimes doesn't become visible until the next X
10005 event is processed. --gerd. */
10007 Lisp_Object tail
, frame
;
10008 FOR_EACH_FRAME (tail
, frame
)
10009 if (FRAME_RIF (XFRAME (frame
)))
10010 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10014 return input_pending
;
10017 /* This is called in some cases before a possible quit.
10018 It cases the next call to detect_input_pending to recompute input_pending.
10019 So calling this function unnecessarily can't do any harm. */
10022 clear_input_pending ()
10027 /* Return nonzero if there are pending requeued events.
10028 This isn't used yet. The hope is to make wait_reading_process_output
10029 call it, and return if it runs Lisp code that unreads something.
10030 The problem is, kbd_buffer_get_event needs to be fixed to know what
10031 to do in that case. It isn't trivial. */
10034 requeued_events_pending_p ()
10036 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10040 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10041 doc
: /* Return t if command input is currently available with no wait.
10042 Actually, the value is nil only if we can be sure that no input is available;
10043 if there is a doubt, the value is t. */)
10046 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10049 get_input_pending (&input_pending
,
10050 READABLE_EVENTS_DO_TIMERS_NOW
10051 | READABLE_EVENTS_FILTER_EVENTS
);
10052 return input_pending
> 0 ? Qt
: Qnil
;
10055 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10056 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10059 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10062 if (total_keys
< NUM_RECENT_KEYS
)
10063 return Fvector (total_keys
, keys
);
10066 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10067 bcopy (keys
+ recent_keys_index
,
10068 XVECTOR (val
)->contents
,
10069 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10071 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10072 recent_keys_index
* sizeof (Lisp_Object
));
10077 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10078 doc
: /* Return the key sequence that invoked this command.
10079 However, if the command has called `read-key-sequence', it returns
10080 the last key sequence that has been read.
10081 The value is a string or a vector. */)
10084 return make_event_array (this_command_key_count
,
10085 XVECTOR (this_command_keys
)->contents
);
10088 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10089 doc
: /* Return the key sequence that invoked this command, as a vector.
10090 However, if the command has called `read-key-sequence', it returns
10091 the last key sequence that has been read. */)
10094 return Fvector (this_command_key_count
,
10095 XVECTOR (this_command_keys
)->contents
);
10098 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10099 Sthis_single_command_keys
, 0, 0, 0,
10100 doc
: /* Return the key sequence that invoked this command.
10101 More generally, it returns the last key sequence read, either by
10102 the command loop or by `read-key-sequence'.
10103 Unlike `this-command-keys', this function's value
10104 does not include prefix arguments.
10105 The value is always a vector. */)
10108 return Fvector (this_command_key_count
10109 - this_single_command_key_start
,
10110 (XVECTOR (this_command_keys
)->contents
10111 + this_single_command_key_start
));
10114 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10115 Sthis_single_command_raw_keys
, 0, 0, 0,
10116 doc
: /* Return the raw events that were read for this command.
10117 More generally, it returns the last key sequence read, either by
10118 the command loop or by `read-key-sequence'.
10119 Unlike `this-single-command-keys', this function's value
10120 shows the events before all translations (except for input methods).
10121 The value is always a vector. */)
10124 return Fvector (raw_keybuf_count
,
10125 (XVECTOR (raw_keybuf
)->contents
));
10128 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10129 Sreset_this_command_lengths
, 0, 0, 0,
10130 doc
: /* Make the unread events replace the last command and echo.
10131 Used in `universal-argument-other-key'.
10133 `universal-argument-other-key' rereads the event just typed.
10134 It then gets translated through `function-key-map'.
10135 The translated event has to replace the real events,
10136 both in the value of (this-command-keys) and in echoing.
10137 To achieve this, `universal-argument-other-key' calls
10138 `reset-this-command-lengths', which discards the record of reading
10139 these events the first time. */)
10142 this_command_key_count
= before_command_key_count
;
10143 if (this_command_key_count
< this_single_command_key_start
)
10144 this_single_command_key_start
= this_command_key_count
;
10146 echo_truncate (before_command_echo_length
);
10148 /* Cause whatever we put into unread-command-events
10149 to echo as if it were being freshly read from the keyboard. */
10150 this_command_key_count_reset
= 1;
10155 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10156 Sclear_this_command_keys
, 0, 1, 0,
10157 doc
: /* Clear out the vector that `this-command-keys' returns.
10158 Also clear the record of the last 100 events, unless optional arg
10159 KEEP-RECORD is non-nil. */)
10161 Lisp_Object keep_record
;
10165 this_command_key_count
= 0;
10166 this_command_key_count_reset
= 0;
10168 if (NILP (keep_record
))
10170 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10171 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10173 recent_keys_index
= 0;
10178 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10179 doc
: /* Return the current depth in recursive edits. */)
10183 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10187 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10188 "FOpen dribble file: ",
10189 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10190 If FILE is nil, close any open dribble file. */)
10201 file
= Fexpand_file_name (file
, Qnil
);
10202 dribble
= fopen (SDATA (file
), "w");
10204 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10209 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10210 doc
: /* Discard the contents of the terminal input buffer.
10211 Also end any kbd macro being defined. */)
10214 if (!NILP (current_kboard
->defining_kbd_macro
))
10216 /* Discard the last command from the macro. */
10217 Fcancel_kbd_macro_events ();
10221 update_mode_lines
++;
10223 Vunread_command_events
= Qnil
;
10224 unread_command_char
= -1;
10226 discard_tty_input ();
10228 kbd_fetch_ptr
= kbd_store_ptr
;
10234 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10235 doc
: /* Stop Emacs and return to superior process. You can resume later.
10236 If `cannot-suspend' is non-nil, or if the system doesn't support job
10237 control, run a subshell instead.
10239 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10240 to be read as terminal input by Emacs's parent, after suspension.
10242 Before suspending, run the normal hook `suspend-hook'.
10243 After resumption run the normal hook `suspend-resume-hook'.
10245 Some operating systems cannot stop the Emacs process and resume it later.
10246 On such systems, Emacs starts a subshell instead of suspending. */)
10248 Lisp_Object stuffstring
;
10250 int count
= SPECPDL_INDEX ();
10251 int old_height
, old_width
;
10253 struct gcpro gcpro1
;
10255 if (tty_list
&& tty_list
->next
)
10256 error ("There are other tty frames open; close them before suspending Emacs");
10258 if (!NILP (stuffstring
))
10259 CHECK_STRING (stuffstring
);
10261 /* Run the functions in suspend-hook. */
10262 if (!NILP (Vrun_hooks
))
10263 call1 (Vrun_hooks
, intern ("suspend-hook"));
10265 GCPRO1 (stuffstring
);
10266 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10267 reset_all_sys_modes ();
10268 /* sys_suspend can get an error if it tries to fork a subshell
10269 and the system resources aren't available for that. */
10270 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10272 stuff_buffered_input (stuffstring
);
10273 if (cannot_suspend
)
10277 unbind_to (count
, Qnil
);
10279 /* Check if terminal/window size has changed.
10280 Note that this is not useful when we are running directly
10281 with a window system; but suspend should be disabled in that case. */
10282 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10283 if (width
!= old_width
|| height
!= old_height
)
10284 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10286 /* Run suspend-resume-hook. */
10287 if (!NILP (Vrun_hooks
))
10288 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10294 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10295 Then in any case stuff anything Emacs has read ahead and not used. */
10298 stuff_buffered_input (stuffstring
)
10299 Lisp_Object stuffstring
;
10301 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10302 register unsigned char *p
;
10304 if (STRINGP (stuffstring
))
10306 register int count
;
10308 p
= SDATA (stuffstring
);
10309 count
= SBYTES (stuffstring
);
10310 while (count
-- > 0)
10315 /* Anything we have read ahead, put back for the shell to read. */
10316 /* ?? What should this do when we have multiple keyboards??
10317 Should we ignore anything that was typed in at the "wrong" kboard?
10319 rms: we should stuff everything back into the kboard
10321 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10324 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10325 kbd_fetch_ptr
= kbd_buffer
;
10326 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10327 stuff_char (kbd_fetch_ptr
->code
);
10329 clear_event (kbd_fetch_ptr
);
10333 #endif /* SIGTSTP */
10337 set_waiting_for_input (time_to_clear
)
10338 EMACS_TIME
*time_to_clear
;
10340 input_available_clear_time
= time_to_clear
;
10342 /* Tell handle_interrupt to throw back to read_char, */
10343 waiting_for_input
= 1;
10345 /* If handle_interrupt was called before and buffered a C-g,
10346 make it run again now, to avoid timing error. */
10347 if (!NILP (Vquit_flag
))
10348 quit_throw_to_read_char ();
10352 clear_waiting_for_input ()
10354 /* Tell handle_interrupt not to throw back to read_char, */
10355 waiting_for_input
= 0;
10356 input_available_clear_time
= 0;
10359 /* The SIGINT handler.
10361 If we have a frame on the controlling tty, we assume that the
10362 SIGINT was generated by C-g, so we call handle_interrupt.
10363 Otherwise, the handler kills Emacs. */
10366 interrupt_signal (signalnum
) /* If we don't have an argument, */
10367 int signalnum
; /* some compilers complain in signal calls. */
10369 /* Must preserve main program's value of errno. */
10370 int old_errno
= errno
;
10371 struct device
*device
;
10373 #if defined (USG) && !defined (POSIX_SIGNALS)
10374 /* USG systems forget handlers when they are used;
10375 must reestablish each time */
10376 signal (SIGINT
, interrupt_signal
);
10377 signal (SIGQUIT
, interrupt_signal
);
10380 SIGNAL_THREAD_CHECK (signalnum
);
10382 /* See if we have an active display on our controlling terminal. */
10383 device
= get_named_tty (NULL
);
10386 /* If there are no frames there, let's pretend that we are a
10387 well-behaving UN*X program and quit. */
10388 fatal_error_signal (SIGTERM
);
10392 /* Otherwise, the SIGINT was probably generated by C-g. */
10394 /* Set internal_last_event_frame to the top frame of the
10395 controlling tty, if we have a frame there. We disable the
10396 interrupt key on secondary ttys, so the SIGINT must have come
10397 from the controlling tty. */
10398 internal_last_event_frame
= device
->display_info
.tty
->top_frame
;
10400 handle_interrupt ();
10406 /* This routine is called at interrupt level in response to C-g.
10408 It is called from the SIGINT handler or kbd_buffer_store_event.
10410 If `waiting_for_input' is non zero, then unless `echoing' is
10411 nonzero, immediately throw back to read_char.
10413 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10414 eval to throw, when it gets a chance. If quit-flag is already
10415 non-nil, it stops the job right away. */
10418 handle_interrupt ()
10424 /* XXX This code needs to be revised for multi-tty support. */
10425 if (!NILP (Vquit_flag
)
10427 && get_named_tty (NULL
)
10431 /* If SIGINT isn't blocked, don't let us be interrupted by
10432 another SIGINT, it might be harmful due to non-reentrancy
10433 in I/O functions. */
10434 sigblock (sigmask (SIGINT
));
10437 reset_all_sys_modes ();
10439 #ifdef SIGTSTP /* Support possible in later USG versions */
10441 * On systems which can suspend the current process and return to the original
10442 * shell, this command causes the user to end up back at the shell.
10443 * The "Auto-save" and "Abort" questions are not asked until
10444 * the user elects to return to emacs, at which point he can save the current
10445 * job and either dump core or continue.
10450 if (sys_suspend () == -1)
10452 printf ("Not running as a subprocess;\n");
10453 printf ("you can continue or abort.\n");
10455 #else /* not VMS */
10456 /* Perhaps should really fork an inferior shell?
10457 But that would not provide any way to get back
10458 to the original shell, ever. */
10459 printf ("No support for stopping a process on this operating system;\n");
10460 printf ("you can continue or abort.\n");
10461 #endif /* not VMS */
10462 #endif /* not SIGTSTP */
10464 /* We must remain inside the screen area when the internal terminal
10465 is used. Note that [Enter] is not echoed by dos. */
10468 /* It doesn't work to autosave while GC is in progress;
10469 the code used for auto-saving doesn't cope with the mark bit. */
10470 if (!gc_in_progress
)
10472 printf ("Auto-save? (y or n) ");
10474 if (((c
= getchar ()) & ~040) == 'Y')
10476 Fdo_auto_save (Qt
, Qnil
);
10478 printf ("\r\nAuto-save done");
10479 #else /* not MSDOS */
10480 printf ("Auto-save done\n");
10481 #endif /* not MSDOS */
10483 while (c
!= '\n') c
= getchar ();
10487 /* During GC, it must be safe to reenable quitting again. */
10488 Vinhibit_quit
= Qnil
;
10491 #endif /* not MSDOS */
10492 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10493 printf ("but will instead do a real quit after garbage collection ends\r\n");
10498 printf ("\r\nAbort? (y or n) ");
10499 #else /* not MSDOS */
10501 printf ("Abort (and enter debugger)? (y or n) ");
10502 #else /* not VMS */
10503 printf ("Abort (and dump core)? (y or n) ");
10504 #endif /* not VMS */
10505 #endif /* not MSDOS */
10507 if (((c
= getchar ()) & ~040) == 'Y')
10509 while (c
!= '\n') c
= getchar ();
10511 printf ("\r\nContinuing...\r\n");
10512 #else /* not MSDOS */
10513 printf ("Continuing...\n");
10514 #endif /* not MSDOS */
10516 init_all_sys_modes ();
10521 /* If executing a function that wants to be interrupted out of
10522 and the user has not deferred quitting by binding `inhibit-quit'
10523 then quit right away. */
10524 if (immediate_quit
&& NILP (Vinhibit_quit
))
10526 struct gl_state_s saved
;
10527 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10529 immediate_quit
= 0;
10532 GCPRO4 (saved
.object
, saved
.global_code
,
10533 saved
.current_syntax_table
, saved
.old_prop
);
10534 Fsignal (Qquit
, Qnil
);
10539 /* Else request quit when it's safe */
10543 if (waiting_for_input
&& !echoing
)
10544 quit_throw_to_read_char ();
10547 /* Handle a C-g by making read_char return C-g. */
10550 quit_throw_to_read_char ()
10553 /* Prevent another signal from doing this before we finish. */
10554 clear_waiting_for_input ();
10557 Vunread_command_events
= Qnil
;
10558 unread_command_char
= -1;
10560 #if 0 /* Currently, sit_for is called from read_char without turning
10561 off polling. And that can call set_waiting_for_input.
10562 It seems to be harmless. */
10563 #ifdef POLL_FOR_INPUT
10564 /* May be > 1 if in recursive minibuffer. */
10565 if (poll_suppress_count
== 0)
10569 if (FRAMEP (internal_last_event_frame
)
10570 && !EQ (internal_last_event_frame
, selected_frame
))
10571 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10574 _longjmp (getcjmp
, 1);
10577 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10578 doc
: /* Set mode of reading keyboard input.
10579 First arg INTERRUPT non-nil means use input interrupts;
10580 nil means use CBREAK mode.
10581 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10582 (no effect except in CBREAK mode).
10583 Third arg META t means accept 8-bit input (for a Meta key).
10584 META nil means ignore the top bit, on the assumption it is parity.
10585 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10586 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10587 See also `current-input-mode'. */)
10588 (interrupt
, flow
, meta
, quit
)
10589 Lisp_Object interrupt
, flow
, meta
, quit
;
10591 /* XXX This function needs to be revised for multi-device support.
10592 Currently it compiles fine, but its semantics are wrong. It sets
10593 global parameters (e.g. interrupt_input) based on only the
10594 current frame's device. */
10597 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10598 error ("set-input-mode: QUIT must be an ASCII character");
10600 #ifdef POLL_FOR_INPUT
10605 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10606 /* this causes startup screen to be restored and messes with the mouse */
10607 reset_sys_modes (CURTTY ());
10611 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10612 if (FRAME_DEVICE (SELECTED_FRAME ())->read_socket_hook
)
10614 /* When using X, don't give the user a real choice,
10615 because we haven't implemented the mechanisms to support it. */
10616 #ifdef NO_SOCK_SIGIO
10617 interrupt_input
= 0;
10618 #else /* not NO_SOCK_SIGIO */
10619 interrupt_input
= 1;
10620 #endif /* NO_SOCK_SIGIO */
10623 interrupt_input
= !NILP (interrupt
);
10624 #else /* not SIGIO */
10625 interrupt_input
= 0;
10626 #endif /* not SIGIO */
10628 /* Our VMS input only works by interrupts, as of now. */
10630 interrupt_input
= 1;
10633 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10635 struct tty_display_info
*tty
= CURTTY ();
10636 tty
->flow_control
= !NILP (flow
);
10639 else if (EQ (meta
, Qt
))
10646 /* Don't let this value be out of range. */
10647 quit_char
= XINT (quit
) & (NILP (meta
) ? 0177 : 0377);
10650 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10651 init_sys_modes (CURTTY ());
10654 #ifdef POLL_FOR_INPUT
10655 poll_suppress_count
= 1;
10661 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10662 doc
: /* Return information about the way Emacs currently reads keyboard input.
10663 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10664 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10665 nil, Emacs is using CBREAK mode.
10666 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10667 terminal; this does not apply if Emacs uses interrupt-driven input.
10668 META is t if accepting 8-bit input with 8th bit as Meta flag.
10669 META nil means ignoring the top bit, on the assumption it is parity.
10670 META is neither t nor nil if accepting 8-bit input and using
10671 all 8 bits as the character code.
10672 QUIT is the character Emacs currently uses to quit.
10673 The elements of this list correspond to the arguments of
10674 `set-input-mode'. */)
10677 Lisp_Object val
[4];
10678 struct frame
*sf
= XFRAME (selected_frame
);
10680 val
[0] = interrupt_input
? Qt
: Qnil
;
10681 if (FRAME_TERMCAP_P (sf
))
10683 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10684 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10686 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10693 XSETFASTINT (val
[3], quit_char
);
10695 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10698 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10699 doc
: /* Return position information for pixel coordinates X and Y.
10700 By default, X and Y are relative to text area of the selected window.
10701 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10702 If optional fourth arg WHOLE is non-nil, X is relative to the left
10703 edge of the window.
10705 The return value is similar to a mouse click position:
10706 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10707 IMAGE (DX . DY) (WIDTH . HEIGHT))
10708 The `posn-' functions access elements of such lists. */)
10709 (x
, y
, frame_or_window
, whole
)
10710 Lisp_Object x
, y
, frame_or_window
, whole
;
10715 if (NILP (frame_or_window
))
10716 frame_or_window
= selected_window
;
10718 if (WINDOWP (frame_or_window
))
10722 CHECK_LIVE_WINDOW (frame_or_window
);
10724 w
= XWINDOW (frame_or_window
);
10725 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10727 ? window_box_left_offset (w
, TEXT_AREA
)
10728 : - (WINDOW_LEFT_SCROLL_BAR_COLS (w
)
10729 * WINDOW_FRAME_COLUMN_WIDTH (w
)))));
10730 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10731 frame_or_window
= w
->frame
;
10734 CHECK_LIVE_FRAME (frame_or_window
);
10736 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10739 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10740 doc
: /* Return position information for buffer POS in WINDOW.
10741 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10743 Return nil if position is not visible in window. Otherwise,
10744 the return value is similar to that returned by `event-start' for
10745 a mouse click at the upper left corner of the glyph corresponding
10746 to the given buffer position:
10747 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10748 IMAGE (DX . DY) (WIDTH . HEIGHT))
10749 The `posn-' functions access elements of such lists. */)
10751 Lisp_Object pos
, window
;
10755 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10757 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
, Qnil
);
10763 * Set up a new kboard object with reasonable initial values.
10769 kb
->Voverriding_terminal_local_map
= Qnil
;
10770 kb
->Vlast_command
= Qnil
;
10771 kb
->Vreal_last_command
= Qnil
;
10772 kb
->Vprefix_arg
= Qnil
;
10773 kb
->Vlast_prefix_arg
= Qnil
;
10774 kb
->kbd_queue
= Qnil
;
10775 kb
->kbd_queue_has_data
= 0;
10776 kb
->immediate_echo
= 0;
10777 kb
->echo_string
= Qnil
;
10778 kb
->echo_after_prompt
= -1;
10779 kb
->kbd_macro_buffer
= 0;
10780 kb
->kbd_macro_bufsize
= 0;
10781 kb
->defining_kbd_macro
= Qnil
;
10782 kb
->Vlast_kbd_macro
= Qnil
;
10783 kb
->reference_count
= 0;
10784 kb
->Vsystem_key_alist
= Qnil
;
10785 kb
->system_key_syms
= Qnil
;
10786 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
10787 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
10788 kb
->Vlocal_key_translation_map
= Fmake_sparse_keymap (Qnil
);
10789 Fset_keymap_parent (kb
->Vlocal_key_translation_map
, Vkey_translation_map
);
10790 kb
->Vdefault_minibuffer_frame
= Qnil
;
10794 * Destroy the contents of a kboard object, but not the object itself.
10795 * We use this just before deleting it, or if we're going to initialize
10796 * it a second time.
10802 if (kb
->kbd_macro_buffer
)
10803 xfree (kb
->kbd_macro_buffer
);
10806 #ifdef MULTI_KBOARD
10808 /* Free KB and memory referenced from it. */
10816 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10819 *kbp
= kb
->next_kboard
;
10821 /* Prevent a dangling reference to KB. */
10822 if (kb
== current_kboard
10823 && FRAMEP (selected_frame
)
10824 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10826 current_kboard
= XFRAME (selected_frame
)->device
->kboard
;
10827 if (current_kboard
== kb
)
10835 #endif /* MULTI_KBOARD */
10840 /* This is correct before outermost invocation of the editor loop */
10841 command_loop_level
= -1;
10842 immediate_quit
= 0;
10843 quit_char
= Ctl ('g');
10844 Vunread_command_events
= Qnil
;
10845 unread_command_char
= -1;
10846 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10848 recent_keys_index
= 0;
10849 kbd_fetch_ptr
= kbd_buffer
;
10850 kbd_store_ptr
= kbd_buffer
;
10852 do_mouse_tracking
= Qnil
;
10856 /* This means that command_loop_1 won't try to select anything the first
10858 internal_last_event_frame
= Qnil
;
10859 Vlast_event_frame
= internal_last_event_frame
;
10861 #ifdef MULTI_KBOARD
10862 current_kboard
= initial_kboard
;
10864 wipe_kboard (current_kboard
);
10865 init_kboard (current_kboard
);
10867 if (!noninteractive
)
10869 /* Before multi-tty support, these handlers used to be installed
10870 only if the current session was a tty session. Now an Emacs
10871 session may have multiple display types, so we always handle
10872 SIGINT. There is special code in interrupt_signal to exit
10873 Emacs on SIGINT when there are no termcap frames on the
10874 controlling terminal. */
10875 signal (SIGINT
, interrupt_signal
);
10876 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10877 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10878 SIGQUIT and we can't tell which one it will give us. */
10879 signal (SIGQUIT
, interrupt_signal
);
10880 #endif /* HAVE_TERMIO */
10882 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10884 if (!noninteractive
)
10885 signal (SIGIO
, input_available_signal
);
10888 /* Use interrupt input by default, if it works and noninterrupt input
10889 has deficiencies. */
10891 #ifdef INTERRUPT_INPUT
10892 interrupt_input
= 1;
10894 interrupt_input
= 0;
10897 /* Our VMS input only works by interrupts, as of now. */
10899 interrupt_input
= 1;
10905 if (keyboard_init_hook
)
10906 (*keyboard_init_hook
) ();
10908 #ifdef POLL_FOR_INPUT
10909 poll_suppress_count
= 1;
10914 /* At least provide an escape route since C-g doesn't work. */
10915 signal (SIGINT
, interrupt_signal
);
10919 /* This type's only use is in syms_of_keyboard, to initialize the
10920 event header symbols and put properties on them. */
10921 struct event_head
{
10927 struct event_head head_table
[] = {
10928 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10929 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10930 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10931 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10932 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10933 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10934 /* `select-window' should be handled just like `switch-frame'
10935 in read_key_sequence. */
10936 {&Qselect_window
, "select-window", &Qswitch_frame
}
10940 syms_of_keyboard ()
10942 Vpre_help_message
= Qnil
;
10943 staticpro (&Vpre_help_message
);
10945 Vlispy_mouse_stem
= build_string ("mouse");
10946 staticpro (&Vlispy_mouse_stem
);
10949 QCimage
= intern (":image");
10950 staticpro (&QCimage
);
10952 staticpro (&Qhelp_echo
);
10953 Qhelp_echo
= intern ("help-echo");
10955 staticpro (&item_properties
);
10956 item_properties
= Qnil
;
10958 staticpro (&tool_bar_item_properties
);
10959 tool_bar_item_properties
= Qnil
;
10960 staticpro (&tool_bar_items_vector
);
10961 tool_bar_items_vector
= Qnil
;
10963 staticpro (&real_this_command
);
10964 real_this_command
= Qnil
;
10966 Qtimer_event_handler
= intern ("timer-event-handler");
10967 staticpro (&Qtimer_event_handler
);
10969 Qdisabled_command_function
= intern ("disabled-command-function");
10970 staticpro (&Qdisabled_command_function
);
10972 Qself_insert_command
= intern ("self-insert-command");
10973 staticpro (&Qself_insert_command
);
10975 Qforward_char
= intern ("forward-char");
10976 staticpro (&Qforward_char
);
10978 Qbackward_char
= intern ("backward-char");
10979 staticpro (&Qbackward_char
);
10981 Qdisabled
= intern ("disabled");
10982 staticpro (&Qdisabled
);
10984 Qundefined
= intern ("undefined");
10985 staticpro (&Qundefined
);
10987 Qpre_command_hook
= intern ("pre-command-hook");
10988 staticpro (&Qpre_command_hook
);
10990 Qpost_command_hook
= intern ("post-command-hook");
10991 staticpro (&Qpost_command_hook
);
10993 Qdeferred_action_function
= intern ("deferred-action-function");
10994 staticpro (&Qdeferred_action_function
);
10996 Qcommand_hook_internal
= intern ("command-hook-internal");
10997 staticpro (&Qcommand_hook_internal
);
10999 Qfunction_key
= intern ("function-key");
11000 staticpro (&Qfunction_key
);
11001 Qmouse_click
= intern ("mouse-click");
11002 staticpro (&Qmouse_click
);
11003 #if defined (WINDOWSNT) || defined (MAC_OS)
11004 Qlanguage_change
= intern ("language-change");
11005 staticpro (&Qlanguage_change
);
11007 Qdrag_n_drop
= intern ("drag-n-drop");
11008 staticpro (&Qdrag_n_drop
);
11010 Qsave_session
= intern ("save-session");
11011 staticpro (&Qsave_session
);
11013 Qusr1_signal
= intern ("usr1-signal");
11014 staticpro (&Qusr1_signal
);
11015 Qusr2_signal
= intern ("usr2-signal");
11016 staticpro (&Qusr2_signal
);
11018 Qmenu_enable
= intern ("menu-enable");
11019 staticpro (&Qmenu_enable
);
11020 Qmenu_alias
= intern ("menu-alias");
11021 staticpro (&Qmenu_alias
);
11022 QCenable
= intern (":enable");
11023 staticpro (&QCenable
);
11024 QCvisible
= intern (":visible");
11025 staticpro (&QCvisible
);
11026 QChelp
= intern (":help");
11027 staticpro (&QChelp
);
11028 QCfilter
= intern (":filter");
11029 staticpro (&QCfilter
);
11030 QCbutton
= intern (":button");
11031 staticpro (&QCbutton
);
11032 QCkeys
= intern (":keys");
11033 staticpro (&QCkeys
);
11034 QCkey_sequence
= intern (":key-sequence");
11035 staticpro (&QCkey_sequence
);
11036 QCtoggle
= intern (":toggle");
11037 staticpro (&QCtoggle
);
11038 QCradio
= intern (":radio");
11039 staticpro (&QCradio
);
11041 Qmode_line
= intern ("mode-line");
11042 staticpro (&Qmode_line
);
11043 Qvertical_line
= intern ("vertical-line");
11044 staticpro (&Qvertical_line
);
11045 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11046 staticpro (&Qvertical_scroll_bar
);
11047 Qmenu_bar
= intern ("menu-bar");
11048 staticpro (&Qmenu_bar
);
11051 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11052 staticpro (&Qmouse_fixup_help_message
);
11055 Qabove_handle
= intern ("above-handle");
11056 staticpro (&Qabove_handle
);
11057 Qhandle
= intern ("handle");
11058 staticpro (&Qhandle
);
11059 Qbelow_handle
= intern ("below-handle");
11060 staticpro (&Qbelow_handle
);
11061 Qup
= intern ("up");
11063 Qdown
= intern ("down");
11064 staticpro (&Qdown
);
11065 Qtop
= intern ("top");
11067 Qbottom
= intern ("bottom");
11068 staticpro (&Qbottom
);
11069 Qend_scroll
= intern ("end-scroll");
11070 staticpro (&Qend_scroll
);
11071 Qratio
= intern ("ratio");
11072 staticpro (&Qratio
);
11074 Qevent_kind
= intern ("event-kind");
11075 staticpro (&Qevent_kind
);
11076 Qevent_symbol_elements
= intern ("event-symbol-elements");
11077 staticpro (&Qevent_symbol_elements
);
11078 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11079 staticpro (&Qevent_symbol_element_mask
);
11080 Qmodifier_cache
= intern ("modifier-cache");
11081 staticpro (&Qmodifier_cache
);
11083 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11084 staticpro (&Qrecompute_lucid_menubar
);
11085 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11086 staticpro (&Qactivate_menubar_hook
);
11088 Qpolling_period
= intern ("polling-period");
11089 staticpro (&Qpolling_period
);
11091 Qinput_method_function
= intern ("input-method-function");
11092 staticpro (&Qinput_method_function
);
11094 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11095 staticpro (&Qinput_method_exit_on_first_char
);
11096 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11097 staticpro (&Qinput_method_use_echo_area
);
11099 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11100 Fset (Qinput_method_use_echo_area
, Qnil
);
11102 last_point_position_buffer
= Qnil
;
11105 struct event_head
*p
;
11107 for (p
= head_table
;
11108 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11111 *p
->var
= intern (p
->name
);
11112 staticpro (p
->var
);
11113 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11114 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11118 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11119 staticpro (&button_down_location
);
11120 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11121 staticpro (&mouse_syms
);
11122 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11123 staticpro (&wheel_syms
);
11127 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11129 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11130 for (i
= 0; i
< len
; i
++)
11131 if (modifier_names
[i
])
11132 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11133 staticpro (&modifier_symbols
);
11136 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11137 staticpro (&recent_keys
);
11139 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11140 staticpro (&this_command_keys
);
11142 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11143 staticpro (&raw_keybuf
);
11145 Qextended_command_history
= intern ("extended-command-history");
11146 Fset (Qextended_command_history
, Qnil
);
11147 staticpro (&Qextended_command_history
);
11149 accent_key_syms
= Qnil
;
11150 staticpro (&accent_key_syms
);
11152 func_key_syms
= Qnil
;
11153 staticpro (&func_key_syms
);
11155 drag_n_drop_syms
= Qnil
;
11156 staticpro (&drag_n_drop_syms
);
11158 unread_switch_frame
= Qnil
;
11159 staticpro (&unread_switch_frame
);
11161 internal_last_event_frame
= Qnil
;
11162 staticpro (&internal_last_event_frame
);
11164 read_key_sequence_cmd
= Qnil
;
11165 staticpro (&read_key_sequence_cmd
);
11167 menu_bar_one_keymap_changed_items
= Qnil
;
11168 staticpro (&menu_bar_one_keymap_changed_items
);
11170 defsubr (&Sevent_convert_list
);
11171 defsubr (&Sread_key_sequence
);
11172 defsubr (&Sread_key_sequence_vector
);
11173 defsubr (&Srecursive_edit
);
11175 defsubr (&Strack_mouse
);
11177 defsubr (&Sinput_pending_p
);
11178 defsubr (&Scommand_execute
);
11179 defsubr (&Srecent_keys
);
11180 defsubr (&Sthis_command_keys
);
11181 defsubr (&Sthis_command_keys_vector
);
11182 defsubr (&Sthis_single_command_keys
);
11183 defsubr (&Sthis_single_command_raw_keys
);
11184 defsubr (&Sreset_this_command_lengths
);
11185 defsubr (&Sclear_this_command_keys
);
11186 defsubr (&Ssuspend_emacs
);
11187 defsubr (&Sabort_recursive_edit
);
11188 defsubr (&Sexit_recursive_edit
);
11189 defsubr (&Srecursion_depth
);
11190 defsubr (&Stop_level
);
11191 defsubr (&Sdiscard_input
);
11192 defsubr (&Sopen_dribble_file
);
11193 defsubr (&Sset_input_mode
);
11194 defsubr (&Scurrent_input_mode
);
11195 defsubr (&Sexecute_extended_command
);
11196 defsubr (&Sposn_at_point
);
11197 defsubr (&Sposn_at_x_y
);
11199 DEFVAR_LISP ("last-command-char", &last_command_char
,
11200 doc
: /* Last input event that was part of a command. */);
11202 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11203 doc
: /* Last input event that was part of a command. */);
11205 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11206 doc
: /* Last input event in a command, except for mouse menu events.
11207 Mouse menus give back keys that don't look like mouse events;
11208 this variable holds the actual mouse event that led to the menu,
11209 so that you can determine whether the command was run by mouse or not. */);
11211 DEFVAR_LISP ("last-input-char", &last_input_char
,
11212 doc
: /* Last input event. */);
11214 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11215 doc
: /* Last input event. */);
11217 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11218 doc
: /* List of events to be read as the command input.
11219 These events are processed first, before actual keyboard input. */);
11220 Vunread_command_events
= Qnil
;
11222 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11223 doc
: /* If not -1, an object to be read as next command input event. */);
11225 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11226 doc
: /* List of events to be processed as input by input methods.
11227 These events are processed after `unread-command-events', but
11228 before actual keyboard input. */);
11229 Vunread_post_input_method_events
= Qnil
;
11231 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11232 doc
: /* List of events to be processed as input by input methods.
11233 These events are processed after `unread-command-events', but
11234 before actual keyboard input. */);
11235 Vunread_input_method_events
= Qnil
;
11237 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11238 doc
: /* Meta-prefix character code.
11239 Meta-foo as command input turns into this character followed by foo. */);
11240 XSETINT (meta_prefix_char
, 033);
11242 DEFVAR_KBOARD ("last-command", Vlast_command
,
11243 doc
: /* The last command executed.
11244 Normally a symbol with a function definition, but can be whatever was found
11245 in the keymap, or whatever the variable `this-command' was set to by that
11248 The value `mode-exit' is special; it means that the previous command
11249 read an event that told it to exit, and it did so and unread that event.
11250 In other words, the present command is the event that made the previous
11253 The value `kill-region' is special; it means that the previous command
11254 was a kill command.
11256 `last-command' has a separate binding for each display device.
11257 See Info node `(elisp)Multiple displays'. */);
11259 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11260 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11262 DEFVAR_LISP ("this-command", &Vthis_command
,
11263 doc
: /* The command now being executed.
11264 The command can set this variable; whatever is put here
11265 will be in `last-command' during the following command. */);
11266 Vthis_command
= Qnil
;
11268 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11269 doc
: /* The command bound to the current key sequence before remapping.
11270 It equals `this-command' if the original command was not remapped through
11271 any of the active keymaps. Otherwise, the value of `this-command' is the
11272 result of looking up the original command in the active keymaps. */);
11273 Vthis_original_command
= Qnil
;
11275 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11276 doc
: /* *Number of input events between auto-saves.
11277 Zero means disable autosaving due to number of characters typed. */);
11278 auto_save_interval
= 300;
11280 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11281 doc
: /* *Number of seconds idle time before auto-save.
11282 Zero or nil means disable auto-saving due to idleness.
11283 After auto-saving due to this many seconds of idle time,
11284 Emacs also does a garbage collection if that seems to be warranted. */);
11285 XSETFASTINT (Vauto_save_timeout
, 30);
11287 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11288 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11289 The value may be integer or floating point. */);
11290 Vecho_keystrokes
= make_number (1);
11292 DEFVAR_INT ("polling-period", &polling_period
,
11293 doc
: /* *Interval between polling for input during Lisp execution.
11294 The reason for polling is to make C-g work to stop a running program.
11295 Polling is needed only when using X windows and SIGIO does not work.
11296 Polling is automatically disabled in all other cases. */);
11297 polling_period
= 2;
11299 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11300 doc
: /* *Maximum time between mouse clicks to make a double-click.
11301 Measured in milliseconds. nil means disable double-click recognition;
11302 t means double-clicks have no time limit and are detected
11303 by position only. */);
11304 Vdouble_click_time
= make_number (500);
11306 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11307 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11308 On window-system frames, value is the number of pixels the mouse may have
11309 moved horizontally or vertically between two clicks to make a double-click.
11310 On non window-system frames, value is interpreted in units of 1/8 characters
11313 This variable is also the threshold for motion of the mouse
11314 to count as a drag. */);
11315 double_click_fuzz
= 3;
11317 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11318 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11319 inhibit_local_menu_bar_menus
= 0;
11321 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11322 doc
: /* Number of complete key sequences read as input so far.
11323 This includes key sequences read from keyboard macros.
11324 The number is effectively the number of interactive command invocations. */);
11325 num_input_keys
= 0;
11327 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11328 doc
: /* Number of input events read from the keyboard so far.
11329 This does not include events generated by keyboard macros. */);
11330 num_nonmacro_input_events
= 0;
11332 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11333 doc
: /* The frame in which the most recently read event occurred.
11334 If the last event came from a keyboard macro, this is set to `macro'. */);
11335 Vlast_event_frame
= Qnil
;
11337 /* This variable is set up in sysdep.c. */
11338 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11339 doc
: /* The ERASE character as set by the user with stty. */);
11341 DEFVAR_LISP ("help-char", &Vhelp_char
,
11342 doc
: /* Character to recognize as meaning Help.
11343 When it is read, do `(eval help-form)', and display result if it's a string.
11344 If the value of `help-form' is nil, this char can be read normally. */);
11345 XSETINT (Vhelp_char
, Ctl ('H'));
11347 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11348 doc
: /* List of input events to recognize as meaning Help.
11349 These work just like the value of `help-char' (see that). */);
11350 Vhelp_event_list
= Qnil
;
11352 DEFVAR_LISP ("help-form", &Vhelp_form
,
11353 doc
: /* Form to execute when character `help-char' is read.
11354 If the form returns a string, that string is displayed.
11355 If `help-form' is nil, the help char is not recognized. */);
11358 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11359 doc
: /* Command to run when `help-char' character follows a prefix key.
11360 This command is used only when there is no actual binding
11361 for that character after that prefix key. */);
11362 Vprefix_help_command
= Qnil
;
11364 DEFVAR_LISP ("top-level", &Vtop_level
,
11365 doc
: /* Form to evaluate when Emacs starts up.
11366 Useful to set before you dump a modified Emacs. */);
11369 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11370 doc
: /* Translate table for keyboard input, or nil.
11371 If non-nil, the value should be a char-table. Each character read
11372 from the keyboard is looked up in this char-table. If the value found
11373 there is non-nil, then it is used instead of the actual input character.
11375 The value can also be a string or vector, but this is considered obsolete.
11376 If it is a string or vector of length N, character codes N and up are left
11377 untranslated. In a vector, an element which is nil means "no translation".
11379 This is applied to the characters supplied to input methods, not their
11380 output. See also `translation-table-for-input'. */);
11381 Vkeyboard_translate_table
= Qnil
;
11383 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11384 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11385 \(Even if the operating system has support for stopping a process.\) */);
11386 cannot_suspend
= 0;
11388 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11389 doc
: /* Non-nil means prompt with menus when appropriate.
11390 This is done when reading from a keymap that has a prompt string,
11391 for elements that have prompt strings.
11392 The menu is displayed on the screen
11393 if X menus were enabled at configuration
11394 time and the previous event was a mouse click prefix key.
11395 Otherwise, menu prompting uses the echo area. */);
11396 menu_prompting
= 1;
11398 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11399 doc
: /* Character to see next line of menu prompt.
11400 Type this character while in a menu prompt to rotate around the lines of it. */);
11401 XSETINT (menu_prompt_more_char
, ' ');
11403 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11404 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11405 Emacs applies the modifiers of the character stored here to each keyboard
11406 character it reads. For example, after evaluating the expression
11407 (setq extra-keyboard-modifiers ?\\C-x)
11408 all input characters will have the control modifier applied to them.
11410 Note that the character ?\\C-@, equivalent to the integer zero, does
11411 not count as a control character; rather, it counts as a character
11412 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11413 cancels any modification. */);
11414 extra_keyboard_modifiers
= 0;
11416 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11417 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11418 The command loop sets this to nil before each command,
11419 and tests the value when the command returns.
11420 Buffer modification stores t in this variable. */);
11421 Vdeactivate_mark
= Qnil
;
11423 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11424 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11425 Vcommand_hook_internal
= Qnil
;
11427 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11428 doc
: /* Normal hook run before each command is executed.
11429 If an unhandled error happens in running this hook,
11430 the hook value is set to nil, since otherwise the error
11431 might happen repeatedly and make Emacs nonfunctional. */);
11432 Vpre_command_hook
= Qnil
;
11434 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11435 doc
: /* Normal hook run after each command is executed.
11436 If an unhandled error happens in running this hook,
11437 the hook value is set to nil, since otherwise the error
11438 might happen repeatedly and make Emacs nonfunctional. */);
11439 Vpost_command_hook
= Qnil
;
11442 DEFVAR_LISP ("echo-area-clear-hook", ...,
11443 doc
: /* Normal hook run when clearing the echo area. */);
11445 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11446 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11448 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11449 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11450 Vlucid_menu_bar_dirty_flag
= Qnil
;
11452 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11453 doc
: /* List of menu bar items to move to the end of the menu bar.
11454 The elements of the list are event types that may have menu bar bindings. */);
11455 Vmenu_bar_final_items
= Qnil
;
11457 DEFVAR_KBOARD ("overriding-terminal-local-map",
11458 Voverriding_terminal_local_map
,
11459 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11460 If this variable is non-nil, it is used as a keymap instead of the
11461 buffer's local map, and the minor mode keymaps and text property keymaps.
11462 It also replaces `overriding-local-map'.
11464 This variable is intended to let commands such as `universal-argument'
11465 set up a different keymap for reading the next command.
11467 `overriding-terminal-local-map' has a separate binding for each display device.
11468 See Info node `(elisp)Multiple displays'. */);
11470 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11471 doc
: /* Keymap that overrides all other local keymaps.
11472 If this variable is non-nil, it is used as a keymap--replacing the
11473 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11474 Voverriding_local_map
= Qnil
;
11476 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11477 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11478 Otherwise, the menu bar continues to reflect the buffer's local map
11479 and the minor mode maps regardless of `overriding-local-map'. */);
11480 Voverriding_local_map_menu_flag
= Qnil
;
11482 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11483 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11484 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11486 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11487 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11489 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11490 doc
: /* Alist of system-specific X windows key symbols.
11491 Each element should have the form (N . SYMBOL) where N is the
11492 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11493 and SYMBOL is its name.
11495 `system-key-alist' has a separate binding for each display device.
11496 See Info node `(elisp)Multiple displays'.
11498 Note that the currently selected frame has very little to do with
11499 which binding of this variable is active at any given moment. If you
11500 need set or get the binding on a specific display, use
11501 `terminal-local-value' and `set-terminal-local-value'. */);
11503 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11504 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
11505 This allows Emacs to recognize function keys sent from ASCII
11506 terminals at any point in a key sequence.
11508 The `read-key-sequence' function replaces any subsequence bound by
11509 `function-key-map' with its binding. More precisely, when the active
11510 keymaps have no binding for the current key sequence but
11511 `function-key-map' binds a suffix of the sequence to a vector or string,
11512 `read-key-sequence' replaces the matching suffix with its binding, and
11513 continues with the new sequence.
11515 The events that come from bindings in `function-key-map' are not
11516 themselves looked up in `function-key-map'.
11518 For example, suppose `function-key-map' binds `ESC O P' to [f1].
11519 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11520 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
11521 key, typing `ESC O P x' would return [f1 x].
11523 `function-key-map' has a separate binding for each display device.
11524 See Info node `(elisp)Multiple displays'. If you need to define a
11525 binding on all display devices, change `global-function-key-map'
11528 Note that the currently selected frame has very little to do with
11529 which binding of this variable is active at any given moment. If you
11530 need set or get the binding on a specific display, use
11531 `terminal-local-value' and `set-terminal-local-value'. */);
11533 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
11534 doc
: /* The parent keymap of all `local-function-key-map' instances.
11535 Function key definitions that apply to all display devices should go
11537 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11539 DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map
,
11540 doc
: /* Keymap of key translations that can override keymaps.
11541 This keymap works like `function-key-map', but comes after that,
11542 and its non-prefix bindings override ordinary bindings.
11544 `key-translation-map' has a separate binding for each display device.
11545 (See Info node `(elisp)Multiple displays'.) If you need to set a key
11546 translation on all devices, change `global-key-translation-map' instead.
11548 Note that the currently selected frame has very little to do with
11549 which binding of this variable is active at any given moment. If you
11550 need set or get the binding on a specific display, use
11551 `terminal-local-value' and `set-terminal-local-value'. */);
11553 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
11554 doc
: /* The parent keymap of all `local-key-translation-map' instances.
11555 Key translations that apply to all display devices should go here. */);
11556 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11558 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11559 doc
: /* List of deferred actions to be performed at a later time.
11560 The precise format isn't relevant here; we just check whether it is nil. */);
11561 Vdeferred_action_list
= Qnil
;
11563 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11564 doc
: /* Function to call to handle deferred actions, after each command.
11565 This function is called with no arguments after each command
11566 whenever `deferred-action-list' is non-nil. */);
11567 Vdeferred_action_function
= Qnil
;
11569 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11570 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11571 The value can be a length of time to show the message for.
11572 If the value is non-nil and not a number, we wait 2 seconds. */);
11573 Vsuggest_key_bindings
= Qt
;
11575 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11576 doc
: /* List of active absolute time timers in order of increasing time. */);
11577 Vtimer_list
= Qnil
;
11579 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11580 doc
: /* List of active idle-time timers in order of increasing time. */);
11581 Vtimer_idle_list
= Qnil
;
11583 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11584 doc
: /* If non-nil, the function that implements the current input method.
11585 It's called with one argument, a printing character that was just read.
11586 \(That means a character with code 040...0176.)
11587 Typically this function uses `read-event' to read additional events.
11588 When it does so, it should first bind `input-method-function' to nil
11589 so it will not be called recursively.
11591 The function should return a list of zero or more events
11592 to be used as input. If it wants to put back some events
11593 to be reconsidered, separately, by the input method,
11594 it can add them to the beginning of `unread-command-events'.
11596 The input method function can find in `input-method-previous-method'
11597 the previous echo area message.
11599 The input method function should refer to the variables
11600 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11601 for guidance on what to do. */);
11602 Vinput_method_function
= Qnil
;
11604 DEFVAR_LISP ("input-method-previous-message",
11605 &Vinput_method_previous_message
,
11606 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11607 This variable exists because `read-event' clears the echo area
11608 before running the input method. It is nil if there was no message. */);
11609 Vinput_method_previous_message
= Qnil
;
11611 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11612 doc
: /* If non-nil, the function that implements the display of help.
11613 It's called with one argument, the help string to display. */);
11614 Vshow_help_function
= Qnil
;
11616 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11617 doc
: /* If non-nil, suppress point adjustment after executing a command.
11619 After a command is executed, if point is moved into a region that has
11620 special properties (e.g. composition, display), we adjust point to
11621 the boundary of the region. But, when a command sets this variable to
11622 non-nil, we suppress the point adjustment.
11624 This variable is set to nil before reading a command, and is checked
11625 just after executing the command. */);
11626 Vdisable_point_adjustment
= Qnil
;
11628 DEFVAR_LISP ("global-disable-point-adjustment",
11629 &Vglobal_disable_point_adjustment
,
11630 doc
: /* *If non-nil, always suppress point adjustment.
11632 The default value is nil, in which case, point adjustment are
11633 suppressed only after special commands that set
11634 `disable-point-adjustment' (which see) to non-nil. */);
11635 Vglobal_disable_point_adjustment
= Qnil
;
11637 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11638 doc
: /* Non-nil means updating menu bindings is allowed.
11639 A value of nil means menu bindings should not be updated.
11640 Used during Emacs' startup. */);
11641 update_menu_bindings
= 1;
11643 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11644 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11645 If the value is not a number, such messages don't time out. */);
11646 Vminibuffer_message_timeout
= make_number (2);
11648 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11649 doc
: /* If non-nil, any keyboard input throws to this symbol.
11650 The value of that variable is passed to `quit-flag' and later causes a
11651 peculiar kind of quitting. */);
11652 Vthrow_on_input
= Qnil
;
11656 keys_of_keyboard ()
11658 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11659 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11660 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11661 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11662 initial_define_key (meta_map
, 'x', "execute-extended-command");
11664 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11665 "handle-delete-frame");
11666 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11667 current-prefix-arg, as is done in `handle-switch-frame'.
11668 But `handle-switch-frame is not run from the special-map.
11669 Commands from that map are run in a special way that automatically
11670 preserves the prefix-arg. Restoring the prefix arg here is not just
11671 redundant but harmful:
11673 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11674 - after the first prompt, the exit-minibuffer-hook is run which may
11675 iconify a frame and thus push a `iconify-frame' event.
11676 - after running exit-minibuffer-hook, current-prefix-arg is
11677 restored to the non-nil value it had before the prompt.
11678 - we enter the second prompt.
11679 current-prefix-arg is non-nil, prefix-arg is nil.
11680 - before running the first real event, we run the special iconify-frame
11681 event, but we pass the `special' arg to execute-command so
11682 current-prefix-arg and prefix-arg are left untouched.
11683 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11684 - the next key event will have a spuriously non-nil current-prefix-arg. */
11685 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11687 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11689 /* Handling it at such a low-level causes read_key_sequence to get
11690 * confused because it doesn't realize that the current_buffer was
11691 * changed by read_char.
11693 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11694 * "handle-select-window"); */
11695 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11696 "handle-save-session");
11699 /* Mark the pointers in the kboard objects.
11700 Called by the Fgarbage_collector. */
11706 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11708 if (kb
->kbd_macro_buffer
)
11709 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11711 mark_object (kb
->Voverriding_terminal_local_map
);
11712 mark_object (kb
->Vlast_command
);
11713 mark_object (kb
->Vreal_last_command
);
11714 mark_object (kb
->Vprefix_arg
);
11715 mark_object (kb
->Vlast_prefix_arg
);
11716 mark_object (kb
->kbd_queue
);
11717 mark_object (kb
->defining_kbd_macro
);
11718 mark_object (kb
->Vlast_kbd_macro
);
11719 mark_object (kb
->Vsystem_key_alist
);
11720 mark_object (kb
->system_key_syms
);
11721 mark_object (kb
->Vlocal_function_key_map
);
11722 mark_object (kb
->Vlocal_key_translation_map
);
11723 mark_object (kb
->Vdefault_minibuffer_frame
);
11724 mark_object (kb
->echo_string
);
11727 struct input_event
*event
;
11728 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11730 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11731 event
= kbd_buffer
;
11732 if (event
->kind
!= SELECTION_REQUEST_EVENT
11733 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11735 mark_object (event
->x
);
11736 mark_object (event
->y
);
11738 mark_object (event
->frame_or_window
);
11739 mark_object (event
->arg
);
11744 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11745 (do not change this comment) */