1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
30 #include "termhooks.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
63 #include <sys/types.h>
72 /* This is to get the definitions of the XK_ symbols. */
79 #endif /* HAVE_NTGUI */
89 /* Variables for blockinput.h: */
91 /* Non-zero if interrupt input is blocked right now. */
92 int interrupt_input_blocked
;
94 /* Nonzero means an input interrupt has arrived
95 during the current critical section. */
96 int interrupt_input_pending
;
99 #ifdef HAVE_WINDOW_SYSTEM
100 /* Make all keyboard buffers much bigger when using X windows. */
102 /* But not too big (local data > 32K error) if on Mac OS Classic. */
103 #define KBD_BUFFER_SIZE 512
105 #define KBD_BUFFER_SIZE 4096
107 #else /* No X-windows, character input */
108 #define KBD_BUFFER_SIZE 4096
109 #endif /* No X-windows */
111 #define abs(x) ((x) >= 0 ? (x) : -(x))
113 /* Following definition copied from eval.c */
117 struct backtrace
*next
;
118 Lisp_Object
*function
;
119 Lisp_Object
*args
; /* Points to vector of args. */
120 int nargs
; /* length of vector. If nargs is UNEVALLED,
121 args points to slot holding list of
124 /* Nonzero means call value of debugger when done with this operation. */
129 KBOARD
*initial_kboard
;
130 KBOARD
*current_kboard
;
134 KBOARD the_only_kboard
;
137 /* Non-nil disable property on a command means
138 do not execute it; call disabled-command-function's value instead. */
139 Lisp_Object Qdisabled
, Qdisabled_command_function
;
141 #define NUM_RECENT_KEYS (100)
142 int recent_keys_index
; /* Index for storing next element into recent_keys */
143 int total_keys
; /* Total number of elements stored into recent_keys */
144 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
146 /* Vector holding the key sequence that invoked the current command.
147 It is reused for each command, and it may be longer than the current
148 sequence; this_command_key_count indicates how many elements
149 actually mean something.
150 It's easier to staticpro a single Lisp_Object than an array. */
151 Lisp_Object this_command_keys
;
152 int this_command_key_count
;
154 /* 1 after calling Freset_this_command_lengths.
156 int this_command_key_count_reset
;
158 /* This vector is used as a buffer to record the events that were actually read
159 by read_key_sequence. */
160 Lisp_Object raw_keybuf
;
161 int raw_keybuf_count
;
163 #define GROW_RAW_KEYBUF \
164 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
166 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
168 new = Fmake_vector (make_number (newsize), Qnil); \
169 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
170 raw_keybuf_count * sizeof (Lisp_Object)); \
174 /* Number of elements of this_command_keys
175 that precede this key sequence. */
176 int this_single_command_key_start
;
178 /* Record values of this_command_key_count and echo_length ()
179 before this command was read. */
180 static int before_command_key_count
;
181 static int before_command_echo_length
;
183 extern int minbuf_level
;
185 extern int message_enable_multibyte
;
187 extern struct backtrace
*backtrace_list
;
189 /* If non-nil, the function that implements the display of help.
190 It's called with one argument, the help string to display. */
192 Lisp_Object Vshow_help_function
;
194 /* If a string, the message displayed before displaying a help-echo
197 Lisp_Object Vpre_help_message
;
199 /* Nonzero means do menu prompting. */
201 static int menu_prompting
;
203 /* Character to see next line of menu prompt. */
205 static Lisp_Object menu_prompt_more_char
;
207 /* For longjmp to where kbd input is being done. */
209 static jmp_buf getcjmp
;
211 /* True while doing kbd input. */
212 int waiting_for_input
;
214 /* True while displaying for echoing. Delays C-g throwing. */
218 /* Non-null means we can start echoing at the next input pause even
219 though there is something in the echo area. */
221 static struct kboard
*ok_to_echo_at_next_pause
;
223 /* The kboard last echoing, or null for none. Reset to 0 in
224 cancel_echoing. If non-null, and a current echo area message
225 exists, and echo_message_buffer is eq to the current message
226 buffer, we know that the message comes from echo_kboard. */
228 struct kboard
*echo_kboard
;
230 /* The buffer used for echoing. Set in echo_now, reset in
233 Lisp_Object echo_message_buffer
;
235 /* Nonzero means disregard local maps for the menu bar. */
236 static int inhibit_local_menu_bar_menus
;
238 /* Nonzero means C-g should cause immediate error-signal. */
241 /* The user's ERASE setting. */
242 Lisp_Object Vtty_erase_char
;
244 /* Character to recognize as the help char. */
245 Lisp_Object Vhelp_char
;
247 /* List of other event types to recognize as meaning "help". */
248 Lisp_Object Vhelp_event_list
;
250 /* Form to execute when help char is typed. */
251 Lisp_Object Vhelp_form
;
253 /* Command to run when the help character follows a prefix key. */
254 Lisp_Object Vprefix_help_command
;
256 /* List of items that should move to the end of the menu bar. */
257 Lisp_Object Vmenu_bar_final_items
;
259 /* Non-nil means show the equivalent key-binding for
260 any M-x command that has one.
261 The value can be a length of time to show the message for.
262 If the value is non-nil and not a number, we wait 2 seconds. */
263 Lisp_Object Vsuggest_key_bindings
;
265 /* How long to display an echo-area message when the minibuffer is active.
266 If the value is not a number, such messages don't time out. */
267 Lisp_Object Vminibuffer_message_timeout
;
269 /* Character that causes a quit. Normally C-g.
271 If we are running on an ordinary terminal, this must be an ordinary
272 ASCII char, since we want to make it our interrupt character.
274 If we are not running on an ordinary terminal, it still needs to be
275 an ordinary ASCII char. This character needs to be recognized in
276 the input interrupt handler. At this point, the keystroke is
277 represented as a struct input_event, while the desired quit
278 character is specified as a lispy event. The mapping from struct
279 input_events to lispy events cannot run in an interrupt handler,
280 and the reverse mapping is difficult for anything but ASCII
283 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
287 extern Lisp_Object current_global_map
;
288 extern int minibuf_level
;
290 /* If non-nil, this is a map that overrides all other local maps. */
291 Lisp_Object Voverriding_local_map
;
293 /* If non-nil, Voverriding_local_map applies to the menu bar. */
294 Lisp_Object Voverriding_local_map_menu_flag
;
296 /* Keymap that defines special misc events that should
297 be processed immediately at a low level. */
298 Lisp_Object Vspecial_event_map
;
300 /* Current depth in recursive edits. */
301 int command_loop_level
;
303 /* Total number of times command_loop has read a key sequence. */
304 EMACS_INT num_input_keys
;
306 /* Last input character read as a command. */
307 Lisp_Object last_command_char
;
309 /* Last input character read as a command, not counting menus
310 reached by the mouse. */
311 Lisp_Object last_nonmenu_event
;
313 /* Last input character read for any purpose. */
314 Lisp_Object last_input_char
;
316 /* If not Qnil, a list of objects to be read as subsequent command input. */
317 Lisp_Object Vunread_command_events
;
319 /* If not Qnil, a list of objects to be read as subsequent command input
320 including input method processing. */
321 Lisp_Object Vunread_input_method_events
;
323 /* If not Qnil, a list of objects to be read as subsequent command input
324 but NOT including input method processing. */
325 Lisp_Object Vunread_post_input_method_events
;
327 /* If not -1, an event to be read as subsequent command input. */
328 EMACS_INT unread_command_char
;
330 /* If not Qnil, this is a switch-frame event which we decided to put
331 off until the end of a key sequence. This should be read as the
332 next command input, after any unread_command_events.
334 read_key_sequence uses this to delay switch-frame events until the
335 end of the key sequence; Fread_char uses it to put off switch-frame
336 events until a non-ASCII event is acceptable as input. */
337 Lisp_Object unread_switch_frame
;
339 /* A mask of extra modifier bits to put into every keyboard char. */
340 EMACS_INT extra_keyboard_modifiers
;
342 /* Char to use as prefix when a meta character is typed in.
343 This is bound on entry to minibuffer in case ESC is changed there. */
345 Lisp_Object meta_prefix_char
;
347 /* Last size recorded for a current buffer which is not a minibuffer. */
348 static int last_non_minibuf_size
;
350 /* Number of idle seconds before an auto-save and garbage collection. */
351 static Lisp_Object Vauto_save_timeout
;
353 /* Total number of times read_char has returned. */
354 int num_input_events
;
356 /* Total number of times read_char has returned, outside of macros. */
357 EMACS_INT num_nonmacro_input_events
;
359 /* Auto-save automatically when this many characters have been typed
360 since the last time. */
362 static EMACS_INT auto_save_interval
;
364 /* Value of num_nonmacro_input_events as of last auto save. */
368 /* The command being executed by the command loop.
369 Commands may set this, and the value set will be copied into
370 current_kboard->Vlast_command instead of the actual command. */
371 Lisp_Object Vthis_command
;
373 /* This is like Vthis_command, except that commands never set it. */
374 Lisp_Object real_this_command
;
376 /* If the lookup of the command returns a binding, the original
377 command is stored in this-original-command. It is nil otherwise. */
378 Lisp_Object Vthis_original_command
;
380 /* The value of point when the last command was executed. */
381 int last_point_position
;
383 /* The buffer that was current when the last command was started. */
384 Lisp_Object last_point_position_buffer
;
386 /* The frame in which the last input event occurred, or Qmacro if the
387 last event came from a macro. We use this to determine when to
388 generate switch-frame events. This may be cleared by functions
389 like Fselect_frame, to make sure that a switch-frame event is
390 generated by the next character. */
391 Lisp_Object internal_last_event_frame
;
393 /* A user-visible version of the above, intended to allow users to
394 figure out where the last event came from, if the event doesn't
395 carry that information itself (i.e. if it was a character). */
396 Lisp_Object Vlast_event_frame
;
398 /* The timestamp of the last input event we received from the X server.
399 X Windows wants this for selection ownership. */
400 unsigned long last_event_timestamp
;
402 Lisp_Object Qself_insert_command
;
403 Lisp_Object Qforward_char
;
404 Lisp_Object Qbackward_char
;
405 Lisp_Object Qundefined
;
406 Lisp_Object Qtimer_event_handler
;
408 /* read_key_sequence stores here the command definition of the
409 key sequence that it reads. */
410 Lisp_Object read_key_sequence_cmd
;
412 /* Echo unfinished commands after this many seconds of pause. */
413 Lisp_Object Vecho_keystrokes
;
415 /* Form to evaluate (if non-nil) when Emacs is started. */
416 Lisp_Object Vtop_level
;
418 /* User-supplied table to translate input characters. */
419 Lisp_Object Vkeyboard_translate_table
;
421 /* If non-nil, this implements the current input method. */
422 Lisp_Object Vinput_method_function
;
423 Lisp_Object Qinput_method_function
;
425 /* When we call Vinput_method_function,
426 this holds the echo area message that was just erased. */
427 Lisp_Object Vinput_method_previous_message
;
429 /* Non-nil means deactivate the mark at end of this command. */
430 Lisp_Object Vdeactivate_mark
;
432 /* Menu bar specified in Lucid Emacs fashion. */
434 Lisp_Object Vlucid_menu_bar_dirty_flag
;
435 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
437 Lisp_Object Qecho_area_clear_hook
;
439 /* Hooks to run before and after each command. */
440 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
441 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
442 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
444 /* Parent keymap of terminal-local function-key-map instances. */
445 Lisp_Object Vfunction_key_map
;
447 /* Parent keymap of terminal-local key-translation-map instances. */
448 Lisp_Object Vkey_translation_map
;
450 /* List of deferred actions to be performed at a later time.
451 The precise format isn't relevant here; we just check whether it is nil. */
452 Lisp_Object Vdeferred_action_list
;
454 /* Function to call to handle deferred actions, when there are any. */
455 Lisp_Object Vdeferred_action_function
;
456 Lisp_Object Qdeferred_action_function
;
458 Lisp_Object Qinput_method_exit_on_first_char
;
459 Lisp_Object Qinput_method_use_echo_area
;
461 /* File in which we write all commands we read. */
464 /* Nonzero if input is available. */
467 extern char *pending_malloc_warning
;
469 /* Circular buffer for pre-read keyboard input. */
471 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
473 /* Pointer to next available character in kbd_buffer.
474 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
475 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
476 next available char is in kbd_buffer[0]. */
477 static struct input_event
*kbd_fetch_ptr
;
479 /* Pointer to next place to store character in kbd_buffer. This
480 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
481 character should go in kbd_buffer[0]. */
482 static struct input_event
* volatile kbd_store_ptr
;
484 /* The above pair of variables forms a "queue empty" flag. When we
485 enqueue a non-hook event, we increment kbd_store_ptr. When we
486 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
487 there is input available iff the two pointers are not equal.
489 Why not just have a flag set and cleared by the enqueuing and
490 dequeuing functions? Such a flag could be screwed up by interrupts
491 at inopportune times. */
493 /* If this flag is non-nil, we check mouse_moved to see when the
494 mouse moves, and motion events will appear in the input stream.
495 Otherwise, mouse motion is ignored. */
496 Lisp_Object do_mouse_tracking
;
498 /* Symbols to head events. */
499 Lisp_Object Qmouse_movement
;
500 Lisp_Object Qscroll_bar_movement
;
501 Lisp_Object Qswitch_frame
;
502 Lisp_Object Qdelete_frame
;
503 Lisp_Object Qiconify_frame
;
504 Lisp_Object Qmake_frame_visible
;
505 Lisp_Object Qselect_window
;
506 Lisp_Object Qhelp_echo
;
509 Lisp_Object Qmouse_fixup_help_message
;
512 /* Symbols to denote kinds of events. */
513 Lisp_Object Qfunction_key
;
514 Lisp_Object Qmouse_click
;
515 #if defined (WINDOWSNT) || defined (MAC_OS)
516 Lisp_Object Qlanguage_change
;
518 Lisp_Object Qdrag_n_drop
;
519 Lisp_Object Qsave_session
;
521 /* Lisp_Object Qmouse_movement; - also an event header */
523 /* Properties of event headers. */
524 Lisp_Object Qevent_kind
;
525 Lisp_Object Qevent_symbol_elements
;
527 /* menu item parts */
528 Lisp_Object Qmenu_alias
;
529 Lisp_Object Qmenu_enable
;
530 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
531 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
532 extern Lisp_Object Vdefine_key_rebound_commands
;
533 extern Lisp_Object Qmenu_item
;
535 /* An event header symbol HEAD may have a property named
536 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
537 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
538 mask of modifiers applied to it. If present, this is used to help
539 speed up parse_modifiers. */
540 Lisp_Object Qevent_symbol_element_mask
;
542 /* An unmodified event header BASE may have a property named
543 Qmodifier_cache, which is an alist mapping modifier masks onto
544 modified versions of BASE. If present, this helps speed up
546 Lisp_Object Qmodifier_cache
;
548 /* Symbols to use for parts of windows. */
549 Lisp_Object Qmode_line
;
550 Lisp_Object Qvertical_line
;
551 Lisp_Object Qvertical_scroll_bar
;
552 Lisp_Object Qmenu_bar
;
553 extern Lisp_Object Qleft_margin
, Qright_margin
;
554 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
555 extern Lisp_Object QCmap
;
557 Lisp_Object
recursive_edit_unwind (), command_loop ();
558 Lisp_Object
Fthis_command_keys ();
559 Lisp_Object Qextended_command_history
;
560 EMACS_TIME
timer_check ();
562 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
564 extern char *x_get_keysym_name ();
566 static void record_menu_key ();
567 static int echo_length ();
569 Lisp_Object Qpolling_period
;
571 /* List of absolute timers. Appears in order of next scheduled event. */
572 Lisp_Object Vtimer_list
;
574 /* List of idle time timers. Appears in order of next scheduled event. */
575 Lisp_Object Vtimer_idle_list
;
577 /* Incremented whenever a timer is run. */
580 extern Lisp_Object Vprint_level
, Vprint_length
;
582 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
584 EMACS_TIME
*input_available_clear_time
;
586 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
587 Default is 1 if INTERRUPT_INPUT is defined. */
590 /* Nonzero while interrupts are temporarily deferred during redisplay. */
591 int interrupts_deferred
;
593 /* Allow m- file to inhibit use of FIONREAD. */
594 #ifdef BROKEN_FIONREAD
598 /* We are unable to use interrupts if FIONREAD is not available,
599 so flush SIGIO so we won't try. */
600 #if !defined (FIONREAD)
606 /* If we support a window system, turn on the code to poll periodically
607 to detect C-g. It isn't actually used when doing interrupt input. */
608 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
609 #define POLL_FOR_INPUT
612 /* After a command is executed, if point is moved into a region that
613 has specific properties (e.g. composition, display), we adjust
614 point to the boundary of the region. But, if a command sets this
615 variable to non-nil, we suppress this point adjustment. This
616 variable is set to nil before reading a command. */
618 Lisp_Object Vdisable_point_adjustment
;
620 /* If non-nil, always disable point adjustment. */
622 Lisp_Object Vglobal_disable_point_adjustment
;
624 /* The time when Emacs started being idle. */
626 static EMACS_TIME timer_idleness_start_time
;
628 /* After Emacs stops being idle, this saves the last value
629 of timer_idleness_start_time from when it was idle. */
631 static EMACS_TIME timer_last_idleness_start_time
;
634 /* Global variable declarations. */
636 /* Flags for readable_events. */
637 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
638 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
639 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
641 /* Function for init_keyboard to call with no args (if nonzero). */
642 void (*keyboard_init_hook
) ();
644 static int read_avail_input
P_ ((int));
645 static void get_input_pending
P_ ((int *, int));
646 static int readable_events
P_ ((int));
647 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
648 Lisp_Object
, int *));
649 static Lisp_Object
read_char_x_menu_prompt ();
650 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
652 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
654 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
655 enum scroll_bar_part
,
656 Lisp_Object
, Lisp_Object
,
659 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
660 Lisp_Object
, char **,
661 Lisp_Object
*, unsigned));
662 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
663 static int parse_solitary_modifier
P_ ((Lisp_Object
));
664 static int parse_solitary_modifier ();
665 static void save_getcjmp
P_ ((jmp_buf));
666 static void save_getcjmp ();
667 static void restore_getcjmp
P_ ((jmp_buf));
668 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
669 static void clear_event
P_ ((struct input_event
*));
670 static void any_kboard_state
P_ ((void));
671 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
672 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
673 static void handle_interrupt
P_ ((void));
674 static void timer_start_idle
P_ ((void));
675 static void timer_stop_idle
P_ ((void));
676 static void timer_resume_idle
P_ ((void));
678 /* Nonzero means don't try to suspend even if the operating system seems
680 static int cannot_suspend
;
682 extern Lisp_Object Qidentity
, Qonly
;
684 /* Install the string STR as the beginning of the string of echoing,
685 so that it serves as a prompt for the next character.
686 Also start echoing. */
692 current_kboard
->echo_string
= str
;
693 current_kboard
->echo_after_prompt
= SCHARS (str
);
697 /* Add C to the echo string, if echoing is going on.
698 C can be a character, which is printed prettily ("M-C-x" and all that
699 jazz), or a symbol, whose name is printed. */
705 if (current_kboard
->immediate_echo
)
707 int size
= KEY_DESCRIPTION_SIZE
+ 100;
708 char *buffer
= (char *) alloca (size
);
710 Lisp_Object echo_string
;
712 echo_string
= current_kboard
->echo_string
;
714 /* If someone has passed us a composite event, use its head symbol. */
719 ptr
= push_key_description (XINT (c
), ptr
, 1);
721 else if (SYMBOLP (c
))
723 Lisp_Object name
= SYMBOL_NAME (c
);
724 int nbytes
= SBYTES (name
);
726 if (size
- (ptr
- buffer
) < nbytes
)
728 int offset
= ptr
- buffer
;
729 size
= max (2 * size
, size
+ nbytes
);
730 buffer
= (char *) alloca (size
);
731 ptr
= buffer
+ offset
;
734 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
735 STRING_MULTIBYTE (name
), 1);
738 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
741 const char *text
= " (Type ? for further options)";
742 int len
= strlen (text
);
744 if (size
- (ptr
- buffer
) < len
)
746 int offset
= ptr
- buffer
;
748 buffer
= (char *) alloca (size
);
749 ptr
= buffer
+ offset
;
752 bcopy (text
, ptr
, len
);
756 /* Replace a dash from echo_dash with a space, otherwise
757 add a space at the end as a separator between keys. */
758 if (STRINGP (echo_string
)
759 && SCHARS (echo_string
) > 1)
761 Lisp_Object last_char
, prev_char
, idx
;
763 idx
= make_number (SCHARS (echo_string
) - 2);
764 prev_char
= Faref (echo_string
, idx
);
766 idx
= make_number (SCHARS (echo_string
) - 1);
767 last_char
= Faref (echo_string
, idx
);
769 /* We test PREV_CHAR to make sure this isn't the echoing
771 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
772 Faset (echo_string
, idx
, make_number (' '));
774 echo_string
= concat2 (echo_string
, build_string (" "));
777 current_kboard
->echo_string
778 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
784 /* Temporarily add a dash to the end of the echo string if it's not
785 empty, so that it serves as a mini-prompt for the very next character. */
790 /* Do nothing if not echoing at all. */
791 if (NILP (current_kboard
->echo_string
))
794 if (!current_kboard
->immediate_echo
795 && SCHARS (current_kboard
->echo_string
) == 0)
798 /* Do nothing if we just printed a prompt. */
799 if (current_kboard
->echo_after_prompt
800 == SCHARS (current_kboard
->echo_string
))
803 /* Do nothing if we have already put a dash at the end. */
804 if (SCHARS (current_kboard
->echo_string
) > 1)
806 Lisp_Object last_char
, prev_char
, idx
;
808 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
809 prev_char
= Faref (current_kboard
->echo_string
, idx
);
811 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
812 last_char
= Faref (current_kboard
->echo_string
, idx
);
814 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
818 /* Put a dash at the end of the buffer temporarily,
819 but make it go away when the next character is added. */
820 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
825 /* Display the current echo string, and begin echoing if not already
831 if (!current_kboard
->immediate_echo
)
834 current_kboard
->immediate_echo
= 1;
836 for (i
= 0; i
< this_command_key_count
; i
++)
840 /* Set before_command_echo_length to the value that would
841 have been saved before the start of this subcommand in
842 command_loop_1, if we had already been echoing then. */
843 if (i
== this_single_command_key_start
)
844 before_command_echo_length
= echo_length ();
846 c
= XVECTOR (this_command_keys
)->contents
[i
];
847 if (! (EVENT_HAS_PARAMETERS (c
)
848 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
852 /* Set before_command_echo_length to the value that would
853 have been saved before the start of this subcommand in
854 command_loop_1, if we had already been echoing then. */
855 if (this_command_key_count
== this_single_command_key_start
)
856 before_command_echo_length
= echo_length ();
858 /* Put a dash at the end to invite the user to type more. */
863 message3_nolog (current_kboard
->echo_string
,
864 SBYTES (current_kboard
->echo_string
),
865 STRING_MULTIBYTE (current_kboard
->echo_string
));
868 /* Record in what buffer we echoed, and from which kboard. */
869 echo_message_buffer
= echo_area_buffer
[0];
870 echo_kboard
= current_kboard
;
872 if (waiting_for_input
&& !NILP (Vquit_flag
))
873 quit_throw_to_read_char ();
876 /* Turn off echoing, for the start of a new command. */
881 current_kboard
->immediate_echo
= 0;
882 current_kboard
->echo_after_prompt
= -1;
883 current_kboard
->echo_string
= Qnil
;
884 ok_to_echo_at_next_pause
= NULL
;
886 echo_message_buffer
= Qnil
;
889 /* Return the length of the current echo string. */
894 return (STRINGP (current_kboard
->echo_string
)
895 ? SCHARS (current_kboard
->echo_string
)
899 /* Truncate the current echo message to its first LEN chars.
900 This and echo_char get used by read_key_sequence when the user
901 switches frames while entering a key sequence. */
904 echo_truncate (nchars
)
907 if (STRINGP (current_kboard
->echo_string
))
908 current_kboard
->echo_string
909 = Fsubstring (current_kboard
->echo_string
,
910 make_number (0), make_number (nchars
));
911 truncate_echo_area (nchars
);
915 /* Functions for manipulating this_command_keys. */
917 add_command_key (key
)
920 #if 0 /* Not needed after we made Freset_this_command_lengths
921 do the job immediately. */
922 /* If reset-this-command-length was called recently, obey it now.
923 See the doc string of that function for an explanation of why. */
924 if (before_command_restore_flag
)
926 this_command_key_count
= before_command_key_count_1
;
927 if (this_command_key_count
< this_single_command_key_start
)
928 this_single_command_key_start
= this_command_key_count
;
929 echo_truncate (before_command_echo_length_1
);
930 before_command_restore_flag
= 0;
934 if (this_command_key_count
>= ASIZE (this_command_keys
))
935 this_command_keys
= larger_vector (this_command_keys
,
936 2 * ASIZE (this_command_keys
),
939 AREF (this_command_keys
, this_command_key_count
) = key
;
940 ++this_command_key_count
;
947 int count
= SPECPDL_INDEX ();
950 if (command_loop_level
> 0)
952 specbind (Qstandard_output
, Qt
);
953 specbind (Qstandard_input
, Qt
);
956 #ifdef HAVE_X_WINDOWS
957 /* The command loop has started an hourglass timer, so we have to
958 cancel it here, otherwise it will fire because the recursive edit
959 can take some time. Do not check for display_hourglass_p here,
960 because it could already be nil. */
964 /* This function may have been called from a debugger called from
965 within redisplay, for instance by Edebugging a function called
966 from fontification-functions. We want to allow redisplay in
967 the debugging session.
969 The recursive edit is left with a `(throw exit ...)'. The `exit'
970 tag is not caught anywhere in redisplay, i.e. when we leave the
971 recursive edit, the original redisplay leading to the recursive
972 edit will be unwound. The outcome should therefore be safe. */
973 specbind (Qinhibit_redisplay
, Qnil
);
976 val
= command_loop ();
978 Fsignal (Qquit
, Qnil
);
979 /* Handle throw from read_minibuf when using minibuffer
980 while it's active but we're in another window. */
982 Fsignal (Qerror
, Fcons (val
, Qnil
));
984 return unbind_to (count
, Qnil
);
987 /* When an auto-save happens, record the "time", and don't do again soon. */
992 last_auto_save
= num_nonmacro_input_events
;
995 /* Make an auto save happen as soon as possible at command level. */
998 force_auto_save_soon ()
1000 last_auto_save
= - auto_save_interval
- 1;
1002 record_asynch_buffer_change ();
1005 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1006 doc
: /* Invoke the editor command loop recursively.
1007 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1008 that tells this function to return.
1009 Alternatively, `(throw 'exit t)' makes this function signal an error.
1010 This function is called by the editor initialization to begin editing. */)
1013 int count
= SPECPDL_INDEX ();
1016 /* If we enter while input is blocked, don't lock up here.
1017 This may happen through the debugger during redisplay. */
1018 if (INPUT_BLOCKED_P
)
1021 command_loop_level
++;
1022 update_mode_lines
= 1;
1024 if (command_loop_level
1025 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1026 buffer
= Fcurrent_buffer ();
1030 /* If we leave recursive_edit_1 below with a `throw' for instance,
1031 like it is done in the splash screen display, we have to
1032 make sure that we restore single_kboard as command_loop_1
1033 would have done if it were left normally. */
1034 temporarily_switch_to_single_kboard (FRAME_KBOARD (SELECTED_FRAME ()));
1035 record_unwind_protect (recursive_edit_unwind
, buffer
);
1037 recursive_edit_1 ();
1038 return unbind_to (count
, Qnil
);
1042 recursive_edit_unwind (buffer
)
1045 if (BUFFERP (buffer
))
1046 Fset_buffer (buffer
);
1048 command_loop_level
--;
1049 update_mode_lines
= 1;
1058 #if 0 /* Theory: if there's anything in Vunread_command_events,
1059 it will right away be read by read_key_sequence,
1060 and then if we do switch KBOARDS, it will go into the side
1061 queue then. So we don't need to do anything special here -- rms. */
1062 if (CONSP (Vunread_command_events
))
1064 current_kboard
->kbd_queue
1065 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1066 current_kboard
->kbd_queue_has_data
= 1;
1068 Vunread_command_events
= Qnil
;
1074 /* Switch to the single-kboard state, making current_kboard
1075 the only KBOARD from which further input is accepted. */
1078 single_kboard_state ()
1085 /* If we're in single_kboard state for kboard KBOARD,
1089 not_single_kboard_state (kboard
)
1093 if (kboard
== current_kboard
)
1098 /* Maintain a stack of kboards, so other parts of Emacs
1099 can switch temporarily to the kboard of a given frame
1100 and then revert to the previous status. */
1105 struct kboard_stack
*next
;
1108 static struct kboard_stack
*kboard_stack
;
1115 struct kboard_stack
*p
1116 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1118 p
->next
= kboard_stack
;
1119 p
->kboard
= current_kboard
;
1127 push_frame_kboard (f
)
1130 push_kboard (f
->device
->kboard
);
1138 struct kboard_stack
*p
= kboard_stack
;
1140 current_kboard
= NULL
;
1141 for (d
= device_list
; d
; d
= d
->next_device
)
1143 if (d
->kboard
== p
->kboard
)
1145 current_kboard
= p
->kboard
;
1149 if (current_kboard
== NULL
)
1151 /* The display we remembered has been deleted. */
1152 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1154 kboard_stack
= p
->next
;
1159 /* Switch to single_kboard mode. If K is non-nil, set it as the
1160 current keyboard. Use record_unwind_protect to return to the
1161 previous state later. */
1164 temporarily_switch_to_single_kboard (k
)
1168 int was_locked
= single_kboard
;
1172 push_kboard (current_kboard
);
1173 single_kboard_state ();
1174 record_unwind_protect (restore_kboard_configuration
,
1175 (was_locked
? Qt
: Qnil
));
1180 record_single_kboard_state ()
1182 push_kboard (current_kboard
);
1183 record_unwind_protect (restore_kboard_configuration
,
1184 (single_kboard
? Qt
: Qnil
));
1188 restore_kboard_configuration (was_locked
)
1189 Lisp_Object was_locked
;
1191 if (NILP (was_locked
))
1192 any_kboard_state ();
1194 single_kboard_state ();
1199 /* Handle errors that are not handled at inner levels
1200 by printing an error message and returning to the editor command loop. */
1206 Lisp_Object old_level
, old_length
;
1207 char macroerror
[50];
1209 #ifdef HAVE_X_WINDOWS
1210 if (display_hourglass_p
)
1211 cancel_hourglass ();
1214 if (!NILP (executing_kbd_macro
))
1216 if (executing_kbd_macro_iterations
== 1)
1217 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1219 sprintf (macroerror
, "After %d kbd macro iterations: ",
1220 executing_kbd_macro_iterations
);
1225 Vstandard_output
= Qt
;
1226 Vstandard_input
= Qt
;
1227 Vexecuting_kbd_macro
= Qnil
;
1228 executing_kbd_macro
= Qnil
;
1229 current_kboard
->Vprefix_arg
= Qnil
;
1230 current_kboard
->Vlast_prefix_arg
= Qnil
;
1233 /* Avoid unquittable loop if data contains a circular list. */
1234 old_level
= Vprint_level
;
1235 old_length
= Vprint_length
;
1236 XSETFASTINT (Vprint_level
, 10);
1237 XSETFASTINT (Vprint_length
, 10);
1238 cmd_error_internal (data
, macroerror
);
1239 Vprint_level
= old_level
;
1240 Vprint_length
= old_length
;
1244 Vinhibit_quit
= Qnil
;
1246 if (command_loop_level
== 0 && minibuf_level
== 0)
1247 any_kboard_state ();
1250 return make_number (0);
1253 /* Take actions on handling an error. DATA is the data that describes
1256 CONTEXT is a C-string containing ASCII characters only which
1257 describes the context in which the error happened. If we need to
1258 generalize CONTEXT to allow multibyte characters, make it a Lisp
1262 cmd_error_internal (data
, context
)
1267 int kill_emacs_p
= 0;
1268 struct frame
*sf
= SELECTED_FRAME ();
1272 clear_message (1, 0);
1274 /* If the window system or terminal frame hasn't been initialized
1275 yet, or we're not interactive, it's best to dump this message out
1276 to stderr and exit. */
1277 if (!sf
->glyphs_initialized_p
1278 || FRAME_INITIAL_P (sf
)
1281 stream
= Qexternal_debugging_output
;
1287 message_log_maybe_newline ();
1292 /* The immediate context is not interesting for Quits,
1293 since they are asyncronous. */
1294 if (EQ (XCAR (data
), Qquit
))
1295 Vsignaling_function
= Qnil
;
1297 print_error_message (data
, stream
, context
, Vsignaling_function
);
1299 Vsignaling_function
= Qnil
;
1301 /* If the window system or terminal frame hasn't been initialized
1302 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1306 Fkill_emacs (make_number (-1));
1310 Lisp_Object
command_loop_1 ();
1311 Lisp_Object
command_loop_2 ();
1312 Lisp_Object
top_level_1 ();
1314 /* Entry to editor-command-loop.
1315 This level has the catches for exiting/returning to editor command loop.
1316 It returns nil to exit recursive edit, t to abort it. */
1321 if (command_loop_level
> 0 || minibuf_level
> 0)
1324 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1325 executing_kbd_macro
= Qnil
;
1331 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1332 /* Reset single_kboard in case top-level set it while
1333 evaluating an -f option, or we are stuck there for some
1335 any_kboard_state ();
1336 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1337 executing_kbd_macro
= Qnil
;
1339 /* End of file in -batch run causes exit here. */
1345 /* Here we catch errors in execution of commands within the
1346 editing loop, and reenter the editing loop.
1347 When there is an error, cmd_error runs and returns a non-nil
1348 value to us. A value of nil means that command_loop_1 itself
1349 returned due to end of file (or end of kbd macro). */
1354 register Lisp_Object val
;
1357 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1358 while (!NILP (val
));
1366 return Feval (Vtop_level
);
1372 /* On entry to the outer level, run the startup file */
1373 if (!NILP (Vtop_level
))
1374 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1375 else if (!NILP (Vpurify_flag
))
1376 message ("Bare impure Emacs (standard Lisp code not loaded)");
1378 message ("Bare Emacs (standard Lisp code not loaded)");
1382 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1383 doc
: /* Exit all recursive editing levels. */)
1386 #ifdef HAVE_X_WINDOWS
1387 if (display_hourglass_p
)
1388 cancel_hourglass ();
1391 /* Unblock input if we enter with input blocked. This may happen if
1392 redisplay traps e.g. during tool-bar update with input blocked. */
1393 while (INPUT_BLOCKED_P
)
1396 return Fthrow (Qtop_level
, Qnil
);
1399 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1400 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1403 if (command_loop_level
> 0 || minibuf_level
> 0)
1404 Fthrow (Qexit
, Qnil
);
1406 error ("No recursive edit is in progress");
1410 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1411 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1414 if (command_loop_level
> 0 || minibuf_level
> 0)
1417 error ("No recursive edit is in progress");
1421 /* This is the actual command reading loop,
1422 sans error-handling encapsulation. */
1424 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1426 void safe_run_hooks
P_ ((Lisp_Object
));
1427 static void adjust_point_for_property
P_ ((int, int));
1429 /* Cancel hourglass from protect_unwind.
1431 #ifdef HAVE_X_WINDOWS
1433 cancel_hourglass_unwind (arg
)
1436 cancel_hourglass ();
1447 Lisp_Object keybuf
[30];
1450 int prev_modiff
= 0;
1451 struct buffer
*prev_buffer
= NULL
;
1453 int was_locked
= single_kboard
;
1455 int already_adjusted
= 0;
1457 current_kboard
->Vprefix_arg
= Qnil
;
1458 current_kboard
->Vlast_prefix_arg
= Qnil
;
1459 Vdeactivate_mark
= Qnil
;
1460 waiting_for_input
= 0;
1464 this_command_key_count
= 0;
1465 this_command_key_count_reset
= 0;
1466 this_single_command_key_start
= 0;
1468 if (NILP (Vmemory_full
))
1470 /* Make sure this hook runs after commands that get errors and
1471 throw to top level. */
1472 /* Note that the value cell will never directly contain nil
1473 if the symbol is a local variable. */
1474 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1475 safe_run_hooks (Qpost_command_hook
);
1477 /* If displaying a message, resize the echo area window to fit
1478 that message's size exactly. */
1479 if (!NILP (echo_area_buffer
[0]))
1480 resize_echo_area_exactly ();
1482 if (!NILP (Vdeferred_action_list
))
1483 safe_run_hooks (Qdeferred_action_function
);
1486 Vmemory_full
= Qnil
;
1488 /* Do this after running Vpost_command_hook, for consistency. */
1489 current_kboard
->Vlast_command
= Vthis_command
;
1490 current_kboard
->Vreal_last_command
= real_this_command
;
1494 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1497 /* Make sure the current window's buffer is selected. */
1498 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1499 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1501 /* Display any malloc warning that just came out. Use while because
1502 displaying one warning can cause another. */
1504 while (pending_malloc_warning
)
1505 display_malloc_warning ();
1509 Vdeactivate_mark
= Qnil
;
1511 /* If minibuffer on and echo area in use,
1512 wait a short time and redraw minibuffer. */
1515 && !NILP (echo_area_buffer
[0])
1516 && EQ (minibuf_window
, echo_area_window
)
1517 && NUMBERP (Vminibuffer_message_timeout
))
1519 /* Bind inhibit-quit to t so that C-g gets read in
1520 rather than quitting back to the minibuffer. */
1521 int count
= SPECPDL_INDEX ();
1522 specbind (Qinhibit_quit
, Qt
);
1524 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1525 /* Clear the echo area. */
1527 safe_run_hooks (Qecho_area_clear_hook
);
1529 unbind_to (count
, Qnil
);
1531 /* If a C-g came in before, treat it as input now. */
1532 if (!NILP (Vquit_flag
))
1535 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1540 alloca (0); /* Cause a garbage collection now */
1541 /* Since we can free the most stuff here. */
1542 #endif /* C_ALLOCA */
1545 /* Select the frame that the last event came from. Usually,
1546 switch-frame events will take care of this, but if some lisp
1547 code swallows a switch-frame event, we'll fix things up here.
1548 Is this a good idea? */
1549 if (FRAMEP (internal_last_event_frame
)
1550 && !EQ (internal_last_event_frame
, selected_frame
))
1551 Fselect_frame (internal_last_event_frame
);
1553 /* If it has changed current-menubar from previous value,
1554 really recompute the menubar from the value. */
1555 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1556 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1557 call0 (Qrecompute_lucid_menubar
);
1559 before_command_key_count
= this_command_key_count
;
1560 before_command_echo_length
= echo_length ();
1562 Vthis_command
= Qnil
;
1563 real_this_command
= Qnil
;
1564 Vthis_original_command
= Qnil
;
1566 /* Read next key sequence; i gets its length. */
1567 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1570 /* A filter may have run while we were reading the input. */
1571 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1573 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1574 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1578 /* Now we have read a key sequence of length I,
1579 or else I is 0 and we found end of file. */
1581 if (i
== 0) /* End of file -- happens only in */
1582 return Qnil
; /* a kbd macro, at the end. */
1583 /* -1 means read_key_sequence got a menu that was rejected.
1584 Just loop around and read another command. */
1588 this_command_key_count
= 0;
1589 this_command_key_count_reset
= 0;
1590 this_single_command_key_start
= 0;
1594 last_command_char
= keybuf
[i
- 1];
1596 /* If the previous command tried to force a specific window-start,
1597 forget about that, in case this command moves point far away
1598 from that position. But also throw away beg_unchanged and
1599 end_unchanged information in that case, so that redisplay will
1600 update the whole window properly. */
1601 if (!NILP (XWINDOW (selected_window
)->force_start
))
1604 XWINDOW (selected_window
)->force_start
= Qnil
;
1605 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1606 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1609 cmd
= read_key_sequence_cmd
;
1610 if (!NILP (Vexecuting_kbd_macro
))
1612 if (!NILP (Vquit_flag
))
1614 Vexecuting_kbd_macro
= Qt
;
1615 QUIT
; /* Make some noise. */
1616 /* Will return since macro now empty. */
1620 /* Do redisplay processing after this command except in special
1621 cases identified below. */
1622 prev_buffer
= current_buffer
;
1623 prev_modiff
= MODIFF
;
1624 last_point_position
= PT
;
1625 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1627 /* By default, we adjust point to a boundary of a region that
1628 has such a property that should be treated intangible
1629 (e.g. composition, display). But, some commands will set
1630 this variable differently. */
1631 Vdisable_point_adjustment
= Qnil
;
1633 /* Process filters and timers may have messed with deactivate-mark.
1634 reset it before we execute the command. */
1635 Vdeactivate_mark
= Qnil
;
1637 /* Remap command through active keymaps */
1638 Vthis_original_command
= cmd
;
1642 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1646 /* Execute the command. */
1648 Vthis_command
= cmd
;
1649 real_this_command
= cmd
;
1650 /* Note that the value cell will never directly contain nil
1651 if the symbol is a local variable. */
1652 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1653 safe_run_hooks (Qpre_command_hook
);
1655 already_adjusted
= 0;
1657 if (NILP (Vthis_command
))
1659 /* nil means key is undefined. */
1660 Lisp_Object keys
= Fvector (i
, keybuf
);
1661 keys
= Fkey_description (keys
, Qnil
);
1663 message_with_string ("%s is undefined", keys
, 0);
1664 current_kboard
->defining_kbd_macro
= Qnil
;
1665 update_mode_lines
= 1;
1666 current_kboard
->Vprefix_arg
= Qnil
;
1670 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1672 /* In case we jump to directly_done. */
1673 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1675 /* Recognize some common commands in common situations and
1676 do them directly. */
1677 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1679 struct Lisp_Char_Table
*dp
1680 = window_display_table (XWINDOW (selected_window
));
1681 lose
= FETCH_CHAR (PT_BYTE
);
1683 if (! NILP (Vpost_command_hook
))
1684 /* Put this before calling adjust_point_for_property
1685 so it will only get called once in any case. */
1687 if (current_buffer
== prev_buffer
1688 && last_point_position
!= PT
1689 && NILP (Vdisable_point_adjustment
)
1690 && NILP (Vglobal_disable_point_adjustment
))
1691 adjust_point_for_property (last_point_position
, 0);
1692 already_adjusted
= 1;
1693 if (PT
== last_point_position
+ 1
1695 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1696 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1697 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1698 && (lose
>= 0x20 && lose
< 0x7f)))
1699 : (lose
>= 0x20 && lose
< 0x7f))
1700 /* To extract the case of continuation on
1701 wide-column characters. */
1702 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1703 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1705 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1707 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1709 && !windows_or_buffers_changed
1710 && EQ (current_buffer
->selective_display
, Qnil
)
1711 && !detect_input_pending ()
1712 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1713 && NILP (Vexecuting_kbd_macro
))
1714 direct_output_forward_char (1);
1717 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1719 struct Lisp_Char_Table
*dp
1720 = window_display_table (XWINDOW (selected_window
));
1722 lose
= FETCH_CHAR (PT_BYTE
);
1723 if (! NILP (Vpost_command_hook
))
1725 if (current_buffer
== prev_buffer
1726 && last_point_position
!= PT
1727 && NILP (Vdisable_point_adjustment
)
1728 && NILP (Vglobal_disable_point_adjustment
))
1729 adjust_point_for_property (last_point_position
, 0);
1730 already_adjusted
= 1;
1731 if (PT
== last_point_position
- 1
1733 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1734 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1735 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1736 && (lose
>= 0x20 && lose
< 0x7f)))
1737 : (lose
>= 0x20 && lose
< 0x7f))
1738 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1740 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1742 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1744 && !windows_or_buffers_changed
1745 && EQ (current_buffer
->selective_display
, Qnil
)
1746 && !detect_input_pending ()
1747 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1748 && NILP (Vexecuting_kbd_macro
))
1749 direct_output_forward_char (-1);
1752 else if (EQ (Vthis_command
, Qself_insert_command
)
1753 /* Try this optimization only on char keystrokes. */
1754 && NATNUMP (last_command_char
)
1755 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1758 = translate_char (Vtranslation_table_for_input
,
1759 XFASTINT (last_command_char
), 0, 0, 0);
1761 if (NILP (Vexecuting_kbd_macro
)
1762 && !EQ (minibuf_window
, selected_window
))
1764 if (!nonundocount
|| nonundocount
>= 20)
1772 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1774 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1776 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1778 || MODIFF
<= SAVE_MODIFF
1779 || windows_or_buffers_changed
1780 || !EQ (current_buffer
->selective_display
, Qnil
)
1781 || detect_input_pending ()
1782 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1783 || !NILP (Vexecuting_kbd_macro
));
1785 value
= internal_self_insert (c
, 0);
1790 if (! NILP (Vpost_command_hook
))
1791 /* Put this before calling adjust_point_for_property
1792 so it will only get called once in any case. */
1795 /* VALUE == 1 when AFTER-CHANGE functions are
1796 installed which is the case most of the time
1797 because FONT-LOCK installs one. */
1798 if (!lose
&& !value
)
1799 direct_output_for_insert (c
);
1804 /* Here for a command that isn't executed directly */
1807 #ifdef HAVE_X_WINDOWS
1808 int scount
= SPECPDL_INDEX ();
1810 if (display_hourglass_p
1811 && NILP (Vexecuting_kbd_macro
))
1813 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1819 if (NILP (current_kboard
->Vprefix_arg
))
1821 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1823 #ifdef HAVE_X_WINDOWS
1824 /* Do not check display_hourglass_p here, because
1825 Fcommand_execute could change it, but we should cancel
1826 hourglass cursor anyway.
1827 But don't cancel the hourglass within a macro
1828 just because a command in the macro finishes. */
1829 if (NILP (Vexecuting_kbd_macro
))
1830 unbind_to (scount
, Qnil
);
1835 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1837 /* Note that the value cell will never directly contain nil
1838 if the symbol is a local variable. */
1839 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1840 safe_run_hooks (Qpost_command_hook
);
1842 /* If displaying a message, resize the echo area window to fit
1843 that message's size exactly. */
1844 if (!NILP (echo_area_buffer
[0]))
1845 resize_echo_area_exactly ();
1847 if (!NILP (Vdeferred_action_list
))
1848 safe_run_hooks (Qdeferred_action_function
);
1850 /* If there is a prefix argument,
1851 1) We don't want Vlast_command to be ``universal-argument''
1852 (that would be dumb), so don't set Vlast_command,
1853 2) we want to leave echoing on so that the prefix will be
1854 echoed as part of this key sequence, so don't call
1856 3) we want to leave this_command_key_count non-zero, so that
1857 read_char will realize that it is re-reading a character, and
1858 not echo it a second time.
1860 If the command didn't actually create a prefix arg,
1861 but is merely a frame event that is transparent to prefix args,
1862 then the above doesn't apply. */
1863 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1865 current_kboard
->Vlast_command
= Vthis_command
;
1866 current_kboard
->Vreal_last_command
= real_this_command
;
1868 this_command_key_count
= 0;
1869 this_command_key_count_reset
= 0;
1870 this_single_command_key_start
= 0;
1873 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1875 /* Setting transient-mark-mode to `only' is a way of
1876 turning it on for just one command. */
1878 if (EQ (Vtransient_mark_mode
, Qidentity
))
1879 Vtransient_mark_mode
= Qnil
;
1880 if (EQ (Vtransient_mark_mode
, Qonly
))
1881 Vtransient_mark_mode
= Qidentity
;
1883 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1885 /* We could also call `deactivate'mark'. */
1886 if (EQ (Vtransient_mark_mode
, Qlambda
))
1887 Vtransient_mark_mode
= Qnil
;
1890 current_buffer
->mark_active
= Qnil
;
1891 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1894 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1895 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1900 if (current_buffer
== prev_buffer
1901 && last_point_position
!= PT
1902 && NILP (Vdisable_point_adjustment
)
1903 && NILP (Vglobal_disable_point_adjustment
)
1904 && !already_adjusted
)
1905 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1907 /* Install chars successfully executed in kbd macro. */
1909 if (!NILP (current_kboard
->defining_kbd_macro
)
1910 && NILP (current_kboard
->Vprefix_arg
))
1911 finalize_kbd_macro_chars ();
1915 any_kboard_state ();
1920 extern Lisp_Object Qcomposition
, Qdisplay
;
1922 /* Adjust point to a boundary of a region that has such a property
1923 that should be treated intangible. For the moment, we check
1924 `composition', `display' and `invisible' properties.
1925 LAST_PT is the last position of point. */
1927 extern Lisp_Object Qafter_string
, Qbefore_string
;
1928 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1931 adjust_point_for_property (last_pt
, modified
)
1936 Lisp_Object val
, overlay
, tmp
;
1937 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1940 /* FIXME: cycling is probably not necessary because these properties
1941 can't be usefully combined anyway. */
1942 while (check_composition
|| check_display
|| check_invisible
)
1944 if (check_composition
1945 && PT
> BEGV
&& PT
< ZV
1946 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1947 && COMPOSITION_VALID_P (beg
, end
, val
)
1948 && beg
< PT
/* && end > PT <- It's always the case. */
1949 && (last_pt
<= beg
|| last_pt
>= end
))
1952 SET_PT (PT
< last_pt
? beg
: end
);
1953 check_display
= check_invisible
= 1;
1955 check_composition
= 0;
1957 && PT
> BEGV
&& PT
< ZV
1958 && !NILP (val
= get_char_property_and_overlay
1959 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1960 && display_prop_intangible_p (val
)
1961 && (!OVERLAYP (overlay
)
1962 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1963 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1964 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1965 && (beg
< PT
/* && end > PT <- It's always the case. */
1966 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1969 SET_PT (PT
< last_pt
1970 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1972 check_composition
= check_invisible
= 1;
1975 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1977 int inv
, ellipsis
= 0;
1980 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1982 && !NILP (val
= get_char_property_and_overlay
1983 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1984 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1986 ellipsis
= ellipsis
|| inv
> 1
1987 || (OVERLAYP (overlay
)
1988 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1989 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1990 tmp
= Fnext_single_char_property_change
1991 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1992 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1995 && !NILP (val
= get_char_property_and_overlay
1996 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1997 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1999 ellipsis
= ellipsis
|| inv
> 1
2000 || (OVERLAYP (overlay
)
2001 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2002 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2003 tmp
= Fprevious_single_char_property_change
2004 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2005 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2008 /* Move away from the inside area. */
2009 if (beg
< PT
&& end
> PT
)
2011 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2012 /* We haven't moved yet (so we don't need to fear
2013 infinite-looping) and we were outside the range
2014 before (so either end of the range still corresponds
2015 to a move in the right direction): pretend we moved
2016 less than we actually did, so that we still have
2017 more freedom below in choosing which end of the range
2019 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2020 /* We either have moved already or the last point
2021 was already in the range: we don't get to choose
2022 which end of the range we have to go to. */
2023 : (PT
< last_pt
? beg
: end
));
2024 check_composition
= check_display
= 1;
2026 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2027 the point to something other than its argument, due to
2028 point-motion hooks, intangibility, etc. */
2029 xassert (PT
== beg
|| PT
== end
);
2032 /* Pretend the area doesn't exist if the buffer is not
2034 if (!modified
&& !ellipsis
&& beg
< end
)
2036 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2037 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2038 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2039 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2040 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2041 /* We've already moved as far as we can. Trying to go
2042 to the other end would mean moving backwards and thus
2043 could lead to an infinite loop. */
2045 else if (val
= get_pos_property (make_number (PT
),
2047 TEXT_PROP_MEANS_INVISIBLE (val
)
2048 && (val
= get_pos_property
2049 (make_number (PT
== beg
? end
: beg
),
2051 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2052 (check_composition
= check_display
= 1,
2053 SET_PT (PT
== beg
? end
: beg
));
2056 check_invisible
= 0;
2060 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2063 safe_run_hooks_1 (hook
)
2066 return call1 (Vrun_hooks
, Vinhibit_quit
);
2069 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2072 safe_run_hooks_error (data
)
2075 Lisp_Object args
[3];
2076 args
[0] = build_string ("Error in %s: %s");
2077 args
[1] = Vinhibit_quit
;
2080 return Fset (Vinhibit_quit
, Qnil
);
2083 /* If we get an error while running the hook, cause the hook variable
2084 to be nil. Also inhibit quits, so that C-g won't cause the hook
2085 to mysteriously evaporate. */
2088 safe_run_hooks (hook
)
2091 int count
= SPECPDL_INDEX ();
2092 specbind (Qinhibit_quit
, hook
);
2094 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2096 unbind_to (count
, Qnil
);
2100 /* Number of seconds between polling for input. This is a Lisp
2101 variable that can be bound. */
2103 EMACS_INT polling_period
;
2105 /* Nonzero means polling for input is temporarily suppressed. */
2107 int poll_suppress_count
;
2109 /* Asynchronous timer for polling. */
2111 struct atimer
*poll_timer
;
2114 #ifdef POLL_FOR_INPUT
2116 /* Poll for input, so what we catch a C-g if it comes in. This
2117 function is called from x_make_frame_visible, see comment
2123 if (interrupt_input_blocked
== 0
2124 && !waiting_for_input
)
2125 read_avail_input (0);
2128 /* Timer callback function for poll_timer. TIMER is equal to
2132 poll_for_input (timer
)
2133 struct atimer
*timer
;
2135 if (poll_suppress_count
== 0)
2137 interrupt_input_pending
= 1;
2139 poll_for_input_1 ();
2143 #endif /* POLL_FOR_INPUT */
2145 /* Begin signals to poll for input, if they are appropriate.
2146 This function is called unconditionally from various places. */
2151 #ifdef POLL_FOR_INPUT
2152 /* XXX This condition was (read_socket_hook && !interrupt_input),
2153 but read_socket_hook is not global anymore. Let's pretend that
2155 if (!interrupt_input
)
2157 /* Turn alarm handling on unconditionally. It might have
2158 been turned off in process.c. */
2159 turn_on_atimers (1);
2161 /* If poll timer doesn't exist, are we need one with
2162 a different interval, start a new one. */
2163 if (poll_timer
== NULL
2164 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2166 EMACS_TIME interval
;
2169 cancel_atimer (poll_timer
);
2171 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2172 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2173 poll_for_input
, NULL
);
2176 /* Let the timer's callback function poll for input
2177 if this becomes zero. */
2178 --poll_suppress_count
;
2183 /* Nonzero if we are using polling to handle input asynchronously. */
2186 input_polling_used ()
2188 #ifdef POLL_FOR_INPUT
2189 /* XXX This condition was (read_socket_hook && !interrupt_input),
2190 but read_socket_hook is not global anymore. Let's pretend that
2192 return !interrupt_input
;
2198 /* Turn off polling. */
2203 #ifdef POLL_FOR_INPUT
2204 /* XXX This condition was (read_socket_hook && !interrupt_input),
2205 but read_socket_hook is not global anymore. Let's pretend that
2207 if (!interrupt_input
)
2208 ++poll_suppress_count
;
2212 /* Set the value of poll_suppress_count to COUNT
2213 and start or stop polling accordingly. */
2216 set_poll_suppress_count (count
)
2219 #ifdef POLL_FOR_INPUT
2220 if (count
== 0 && poll_suppress_count
!= 0)
2222 poll_suppress_count
= 1;
2225 else if (count
!= 0 && poll_suppress_count
== 0)
2229 poll_suppress_count
= count
;
2233 /* Bind polling_period to a value at least N.
2234 But don't decrease it. */
2237 bind_polling_period (n
)
2240 #ifdef POLL_FOR_INPUT
2241 int new = polling_period
;
2246 stop_other_atimers (poll_timer
);
2248 specbind (Qpolling_period
, make_number (new));
2249 /* Start a new alarm with the new period. */
2254 /* Apply the control modifier to CHARACTER. */
2260 /* Save the upper bits here. */
2261 int upper
= c
& ~0177;
2265 /* Everything in the columns containing the upper-case letters
2266 denotes a control character. */
2267 if (c
>= 0100 && c
< 0140)
2271 /* Set the shift modifier for a control char
2272 made from a shifted letter. But only for letters! */
2273 if (oc
>= 'A' && oc
<= 'Z')
2274 c
|= shift_modifier
;
2277 /* The lower-case letters denote control characters too. */
2278 else if (c
>= 'a' && c
<= 'z')
2281 /* Include the bits for control and shift
2282 only if the basic ASCII code can't indicate them. */
2286 /* Replace the high bits. */
2287 c
|= (upper
& ~ctrl_modifier
);
2292 /* Display the help-echo property of the character after the mouse pointer.
2293 Either show it in the echo area, or call show-help-function to display
2294 it by other means (maybe in a tooltip).
2296 If HELP is nil, that means clear the previous help echo.
2298 If HELP is a string, display that string. If HELP is a function,
2299 call it with OBJECT and POS as arguments; the function should
2300 return a help string or nil for none. For all other types of HELP,
2301 evaluate it to obtain a string.
2303 WINDOW is the window in which the help was generated, if any.
2304 It is nil if not in a window.
2306 If OBJECT is a buffer, POS is the position in the buffer where the
2307 `help-echo' text property was found.
2309 If OBJECT is an overlay, that overlay has a `help-echo' property,
2310 and POS is the position in the overlay's buffer under the mouse.
2312 If OBJECT is a string (an overlay string or a string displayed with
2313 the `display' property). POS is the position in that string under
2316 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2317 echo overwrites a keystroke echo currently displayed in the echo
2320 Note: this function may only be called with HELP nil or a string
2321 from X code running asynchronously. */
2324 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2325 Lisp_Object help
, window
, object
, pos
;
2326 int ok_to_overwrite_keystroke_echo
;
2328 if (!NILP (help
) && !STRINGP (help
))
2330 if (FUNCTIONP (help
))
2332 Lisp_Object args
[4];
2337 help
= safe_call (4, args
);
2340 help
= safe_eval (help
);
2342 if (!STRINGP (help
))
2347 if (!noninteractive
&& STRINGP (help
))
2348 help
= call1 (Qmouse_fixup_help_message
, help
);
2351 if (STRINGP (help
) || NILP (help
))
2353 if (!NILP (Vshow_help_function
))
2354 call1 (Vshow_help_function
, help
);
2355 else if (/* Don't overwrite minibuffer contents. */
2356 !MINI_WINDOW_P (XWINDOW (selected_window
))
2357 /* Don't overwrite a keystroke echo. */
2358 && (NILP (echo_message_buffer
)
2359 || ok_to_overwrite_keystroke_echo
)
2360 /* Don't overwrite a prompt. */
2361 && !cursor_in_echo_area
)
2365 int count
= SPECPDL_INDEX ();
2367 if (!help_echo_showing_p
)
2368 Vpre_help_message
= current_message ();
2370 specbind (Qmessage_truncate_lines
, Qt
);
2371 message3_nolog (help
, SBYTES (help
),
2372 STRING_MULTIBYTE (help
));
2373 unbind_to (count
, Qnil
);
2375 else if (STRINGP (Vpre_help_message
))
2377 message3_nolog (Vpre_help_message
,
2378 SBYTES (Vpre_help_message
),
2379 STRING_MULTIBYTE (Vpre_help_message
));
2380 Vpre_help_message
= Qnil
;
2386 help_echo_showing_p
= STRINGP (help
);
2392 /* Input of single characters from keyboard */
2394 Lisp_Object
print_help ();
2395 static Lisp_Object
kbd_buffer_get_event ();
2396 static void record_char ();
2399 static jmp_buf wrong_kboard_jmpbuf
;
2402 #define STOP_POLLING \
2403 do { if (! polling_stopped_here) stop_polling (); \
2404 polling_stopped_here = 1; } while (0)
2406 #define RESUME_POLLING \
2407 do { if (polling_stopped_here) start_polling (); \
2408 polling_stopped_here = 0; } while (0)
2410 /* read a character from the keyboard; call the redisplay if needed */
2411 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2412 -1 means do not do redisplay, but do do autosaving.
2415 /* The arguments MAPS and NMAPS are for menu prompting.
2416 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2418 PREV_EVENT is the previous input event, or nil if we are reading
2419 the first event of a key sequence (or not reading a key sequence).
2420 If PREV_EVENT is t, that is a "magic" value that says
2421 not to run input methods, but in other respects to act as if
2422 not reading a key sequence.
2424 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2425 if we used a mouse menu to read the input, or zero otherwise. If
2426 USED_MOUSE_MENU is null, we don't dereference it.
2428 Value is t if we showed a menu and the user rejected it. */
2431 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2435 Lisp_Object prev_event
;
2436 int *used_mouse_menu
;
2438 volatile Lisp_Object c
;
2440 jmp_buf local_getcjmp
;
2442 volatile int key_already_recorded
= 0;
2443 Lisp_Object tem
, save
;
2444 volatile Lisp_Object previous_echo_area_message
;
2445 volatile Lisp_Object also_record
;
2446 volatile int reread
;
2447 struct gcpro gcpro1
, gcpro2
;
2448 int polling_stopped_here
= 0;
2452 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2453 before_command_key_count
= this_command_key_count
;
2454 before_command_echo_length
= echo_length ();
2457 previous_echo_area_message
= Qnil
;
2459 GCPRO2 (c
, previous_echo_area_message
);
2464 if (CONSP (Vunread_post_input_method_events
))
2466 c
= XCAR (Vunread_post_input_method_events
);
2467 Vunread_post_input_method_events
2468 = XCDR (Vunread_post_input_method_events
);
2470 /* Undo what read_char_x_menu_prompt did when it unread
2471 additional keys returned by Fx_popup_menu. */
2473 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2481 if (unread_command_char
!= -1)
2483 XSETINT (c
, unread_command_char
);
2484 unread_command_char
= -1;
2490 if (CONSP (Vunread_command_events
))
2492 c
= XCAR (Vunread_command_events
);
2493 Vunread_command_events
= XCDR (Vunread_command_events
);
2495 /* Undo what read_char_x_menu_prompt did when it unread
2496 additional keys returned by Fx_popup_menu. */
2498 && EQ (XCDR (c
), Qdisabled
)
2499 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2502 /* If the queued event is something that used the mouse,
2503 set used_mouse_menu accordingly. */
2505 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2506 *used_mouse_menu
= 1;
2509 goto reread_for_input_method
;
2512 if (CONSP (Vunread_input_method_events
))
2514 c
= XCAR (Vunread_input_method_events
);
2515 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2517 /* Undo what read_char_x_menu_prompt did when it unread
2518 additional keys returned by Fx_popup_menu. */
2520 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2524 goto reread_for_input_method
;
2527 this_command_key_count_reset
= 0;
2529 if (!NILP (Vexecuting_kbd_macro
))
2531 /* We set this to Qmacro; since that's not a frame, nobody will
2532 try to switch frames on us, and the selected window will
2535 Since this event came from a macro, it would be misleading to
2536 leave internal_last_event_frame set to wherever the last
2537 real event came from. Normally, a switch-frame event selects
2538 internal_last_event_frame after each command is read, but
2539 events read from a macro should never cause a new frame to be
2541 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2543 /* Exit the macro if we are at the end.
2544 Also, some things replace the macro with t
2545 to force an early exit. */
2546 if (EQ (Vexecuting_kbd_macro
, Qt
)
2547 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2553 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2554 if (STRINGP (Vexecuting_kbd_macro
)
2555 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2556 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2558 executing_kbd_macro_index
++;
2563 if (!NILP (unread_switch_frame
))
2565 c
= unread_switch_frame
;
2566 unread_switch_frame
= Qnil
;
2568 /* This event should make it into this_command_keys, and get echoed
2569 again, so we do not set `reread'. */
2573 /* if redisplay was requested */
2574 if (commandflag
>= 0)
2576 /* If there is pending input, process any events which are not
2577 user-visible, such as X selection_request events. */
2579 || detect_input_pending_run_timers (0))
2580 swallow_events (0); /* may clear input_pending */
2582 /* Redisplay if no pending input. */
2583 while (!input_pending
)
2585 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2586 redisplay_preserve_echo_area (5);
2591 /* Normal case: no input arrived during redisplay. */
2594 /* Input arrived and pre-empted redisplay.
2595 Process any events which are not user-visible. */
2597 /* If that cleared input_pending, try again to redisplay. */
2601 /* Message turns off echoing unless more keystrokes turn it on again.
2603 The code in 20.x for the condition was
2605 1. echo_area_glyphs && *echo_area_glyphs
2606 2. && echo_area_glyphs != current_kboard->echobuf
2607 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2609 (1) means there's a current message displayed
2611 (2) means it's not the message from echoing from the current
2614 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2615 is set to a non-null value. This is done in read_char and it is
2616 set to echo_area_glyphs after a call to echo_char. That means
2617 ok_to_echo_at_next_pause is either null or
2618 current_kboard->echobuf with the appropriate current_kboard at
2621 So, condition (3) means in clear text ok_to_echo_at_next_pause
2622 must be either null, or the current message isn't from echoing at
2623 all, or it's from echoing from a different kboard than the
2626 if (/* There currently is something in the echo area. */
2627 !NILP (echo_area_buffer
[0])
2628 && (/* And it's either not from echoing. */
2629 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2630 /* Or it's an echo from a different kboard. */
2631 || echo_kboard
!= current_kboard
2632 /* Or we explicitly allow overwriting whatever there is. */
2633 || ok_to_echo_at_next_pause
== NULL
))
2638 /* Try reading a character via menu prompting in the minibuf.
2639 Try this before the sit-for, because the sit-for
2640 would do the wrong thing if we are supposed to do
2641 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2642 after a mouse event so don't try a minibuf menu. */
2644 if (nmaps
> 0 && INTERACTIVE
2645 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2646 /* Don't bring up a menu if we already have another event. */
2647 && NILP (Vunread_command_events
)
2648 && unread_command_char
< 0
2649 && !detect_input_pending_run_timers (0))
2651 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2654 key_already_recorded
= 1;
2659 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2660 We will do that below, temporarily for short sections of code,
2661 when appropriate. local_getcjmp must be in effect
2662 around any call to sit_for or kbd_buffer_get_event;
2663 it *must not* be in effect when we call redisplay. */
2665 if (_setjmp (local_getcjmp
))
2667 /* We must have saved the outer value of getcjmp here,
2668 so restore it now. */
2669 restore_getcjmp (save_jump
);
2670 XSETINT (c
, quit_char
);
2671 internal_last_event_frame
= selected_frame
;
2672 Vlast_event_frame
= internal_last_event_frame
;
2673 /* If we report the quit char as an event,
2674 don't do so more than once. */
2675 if (!NILP (Vinhibit_quit
))
2680 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2681 if (kb
!= current_kboard
)
2683 Lisp_Object link
= kb
->kbd_queue
;
2684 /* We shouldn't get here if we were in single-kboard mode! */
2689 while (CONSP (XCDR (link
)))
2691 if (!NILP (XCDR (link
)))
2695 kb
->kbd_queue
= Fcons (c
, Qnil
);
2697 XSETCDR (link
, Fcons (c
, Qnil
));
2698 kb
->kbd_queue_has_data
= 1;
2699 current_kboard
= kb
;
2700 /* This is going to exit from read_char
2701 so we had better get rid of this frame's stuff. */
2703 longjmp (wrong_kboard_jmpbuf
, 1);
2710 timer_start_idle ();
2712 /* If in middle of key sequence and minibuffer not active,
2713 start echoing if enough time elapses. */
2715 if (minibuf_level
== 0
2716 && !current_kboard
->immediate_echo
2717 && this_command_key_count
> 0
2719 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2720 && NILP (Fzerop (Vecho_keystrokes
))
2721 && (/* No message. */
2722 NILP (echo_area_buffer
[0])
2723 /* Or empty message. */
2724 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2725 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2726 /* Or already echoing from same kboard. */
2727 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2728 /* Or not echoing before and echoing allowed. */
2729 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2733 /* After a mouse event, start echoing right away.
2734 This is because we are probably about to display a menu,
2735 and we don't want to delay before doing so. */
2736 if (EVENT_HAS_PARAMETERS (prev_event
))
2741 double duration
= extract_float (Vecho_keystrokes
);
2742 sec
= (int) duration
;
2743 usec
= (duration
- sec
) * 1000000;
2744 save_getcjmp (save_jump
);
2745 restore_getcjmp (local_getcjmp
);
2746 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2747 restore_getcjmp (save_jump
);
2749 && ! CONSP (Vunread_command_events
))
2754 /* Maybe auto save due to number of keystrokes. */
2756 if (commandflag
!= 0
2757 && auto_save_interval
> 0
2758 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2759 && !detect_input_pending_run_timers (0))
2761 Fdo_auto_save (Qnil
, Qnil
);
2762 /* Hooks can actually change some buffers in auto save. */
2766 /* Try reading using an X menu.
2767 This is never confused with reading using the minibuf
2768 because the recursive call of read_char in read_char_minibuf_menu_prompt
2769 does not pass on any keymaps. */
2771 if (nmaps
> 0 && INTERACTIVE
2772 && !NILP (prev_event
)
2773 && EVENT_HAS_PARAMETERS (prev_event
)
2774 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2775 && !EQ (XCAR (prev_event
), Qtool_bar
)
2776 /* Don't bring up a menu if we already have another event. */
2777 && NILP (Vunread_command_events
)
2778 && unread_command_char
< 0)
2780 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2782 /* Now that we have read an event, Emacs is not idle. */
2788 /* Maybe autosave and/or garbage collect due to idleness. */
2790 if (INTERACTIVE
&& NILP (c
))
2792 int delay_level
, buffer_size
;
2794 /* Slow down auto saves logarithmically in size of current buffer,
2795 and garbage collect while we're at it. */
2796 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2797 last_non_minibuf_size
= Z
- BEG
;
2798 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2800 while (buffer_size
> 64)
2801 delay_level
++, buffer_size
-= buffer_size
>> 2;
2802 if (delay_level
< 4) delay_level
= 4;
2803 /* delay_level is 4 for files under around 50k, 7 at 100k,
2804 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2806 /* Auto save if enough time goes by without input. */
2807 if (commandflag
!= 0
2808 && num_nonmacro_input_events
> last_auto_save
2809 && INTEGERP (Vauto_save_timeout
)
2810 && XINT (Vauto_save_timeout
) > 0)
2814 save_getcjmp (save_jump
);
2815 restore_getcjmp (local_getcjmp
);
2816 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2818 restore_getcjmp (save_jump
);
2821 && ! CONSP (Vunread_command_events
))
2823 Fdo_auto_save (Qnil
, Qnil
);
2825 /* If we have auto-saved and there is still no input
2826 available, garbage collect if there has been enough
2827 consing going on to make it worthwhile. */
2828 if (!detect_input_pending_run_timers (0)
2829 && consing_since_gc
> gc_cons_threshold
/ 2)
2830 Fgarbage_collect ();
2837 /* If this has become non-nil here, it has been set by a timer
2838 or sentinel or filter. */
2839 if (CONSP (Vunread_command_events
))
2841 c
= XCAR (Vunread_command_events
);
2842 Vunread_command_events
= XCDR (Vunread_command_events
);
2845 /* Read something from current KBOARD's side queue, if possible. */
2849 if (current_kboard
->kbd_queue_has_data
)
2851 if (!CONSP (current_kboard
->kbd_queue
))
2853 c
= XCAR (current_kboard
->kbd_queue
);
2854 current_kboard
->kbd_queue
2855 = XCDR (current_kboard
->kbd_queue
);
2856 if (NILP (current_kboard
->kbd_queue
))
2857 current_kboard
->kbd_queue_has_data
= 0;
2858 input_pending
= readable_events (0);
2859 if (EVENT_HAS_PARAMETERS (c
)
2860 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2861 internal_last_event_frame
= XCAR (XCDR (c
));
2862 Vlast_event_frame
= internal_last_event_frame
;
2867 /* If current_kboard's side queue is empty check the other kboards.
2868 If one of them has data that we have not yet seen here,
2869 switch to it and process the data waiting for it.
2871 Note: if the events queued up for another kboard
2872 have already been seen here, and therefore are not a complete command,
2873 the kbd_queue_has_data field is 0, so we skip that kboard here.
2874 That's to avoid an infinite loop switching between kboards here. */
2875 if (NILP (c
) && !single_kboard
)
2878 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2879 if (kb
->kbd_queue_has_data
)
2881 current_kboard
= kb
;
2882 /* This is going to exit from read_char
2883 so we had better get rid of this frame's stuff. */
2885 longjmp (wrong_kboard_jmpbuf
, 1);
2894 /* Finally, we read from the main queue,
2895 and if that gives us something we can't use yet, we put it on the
2896 appropriate side queue and try again. */
2902 /* Actually read a character, waiting if necessary. */
2903 save_getcjmp (save_jump
);
2904 restore_getcjmp (local_getcjmp
);
2905 timer_start_idle ();
2906 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2907 restore_getcjmp (save_jump
);
2910 if (! NILP (c
) && (kb
!= current_kboard
))
2912 Lisp_Object link
= kb
->kbd_queue
;
2915 while (CONSP (XCDR (link
)))
2917 if (!NILP (XCDR (link
)))
2921 kb
->kbd_queue
= Fcons (c
, Qnil
);
2923 XSETCDR (link
, Fcons (c
, Qnil
));
2924 kb
->kbd_queue_has_data
= 1;
2928 current_kboard
= kb
;
2929 /* This is going to exit from read_char
2930 so we had better get rid of this frame's stuff. */
2932 longjmp (wrong_kboard_jmpbuf
, 1);
2937 /* Terminate Emacs in batch mode if at eof. */
2938 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2939 Fkill_emacs (make_number (1));
2943 /* Add in any extra modifiers, where appropriate. */
2944 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2945 || ((extra_keyboard_modifiers
& 0177) < ' '
2946 && (extra_keyboard_modifiers
& 0177) != 0))
2947 XSETINT (c
, make_ctrl_char (XINT (c
)));
2949 /* Transfer any other modifier bits directly from
2950 extra_keyboard_modifiers to c. Ignore the actual character code
2951 in the low 16 bits of extra_keyboard_modifiers. */
2952 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2962 if (commandflag
>= 0
2963 && !input_pending
&& !detect_input_pending_run_timers (0))
2971 /* Buffer switch events are only for internal wakeups
2972 so don't show them to the user.
2973 Also, don't record a key if we already did. */
2974 if (BUFFERP (c
) || key_already_recorded
)
2977 /* Process special events within read_char
2978 and loop around to read another event. */
2981 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2986 int was_locked
= single_kboard
;
2988 last_input_char
= c
;
2989 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2991 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2992 /* We stopped being idle for this event; undo that. This
2993 prevents automatic window selection (under
2994 mouse_autoselect_window from acting as a real input event, for
2995 example banishing the mouse under mouse-avoidance-mode. */
2996 timer_resume_idle ();
2998 /* Resume allowing input from any kboard, if that was true before. */
3000 any_kboard_state ();
3005 /* Handle things that only apply to characters. */
3008 /* If kbd_buffer_get_event gave us an EOF, return that. */
3012 if ((STRINGP (Vkeyboard_translate_table
)
3013 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3014 || (VECTORP (Vkeyboard_translate_table
)
3015 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3016 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
3017 && CHAR_VALID_P (XINT (c
), 0)))
3020 d
= Faref (Vkeyboard_translate_table
, c
);
3021 /* nil in keyboard-translate-table means no translation. */
3027 /* If this event is a mouse click in the menu bar,
3028 return just menu-bar for now. Modify the mouse click event
3029 so we won't do this twice, then queue it up. */
3030 if (EVENT_HAS_PARAMETERS (c
)
3032 && CONSP (EVENT_START (c
))
3033 && CONSP (XCDR (EVENT_START (c
))))
3037 posn
= POSN_POSN (EVENT_START (c
));
3038 /* Handle menu-bar events:
3039 insert the dummy prefix event `menu-bar'. */
3040 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3042 /* Change menu-bar to (menu-bar) as the event "position". */
3043 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3046 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3051 /* Store these characters into recent_keys, the dribble file if any,
3052 and the keyboard macro being defined, if any. */
3054 if (! NILP (also_record
))
3055 record_char (also_record
);
3057 /* Wipe the echo area.
3058 But first, if we are about to use an input method,
3059 save the echo area contents for it to refer to. */
3061 && ! NILP (Vinput_method_function
)
3062 && (unsigned) XINT (c
) >= ' '
3063 && (unsigned) XINT (c
) != 127
3064 && (unsigned) XINT (c
) < 256)
3066 previous_echo_area_message
= Fcurrent_message ();
3067 Vinput_method_previous_message
= previous_echo_area_message
;
3070 /* Now wipe the echo area, except for help events which do their
3071 own stuff with the echo area. */
3073 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3074 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3076 if (!NILP (echo_area_buffer
[0]))
3077 safe_run_hooks (Qecho_area_clear_hook
);
3078 clear_message (1, 0);
3081 reread_for_input_method
:
3083 /* Pass this to the input method, if appropriate. */
3085 && ! NILP (Vinput_method_function
)
3086 /* Don't run the input method within a key sequence,
3087 after the first event of the key sequence. */
3088 && NILP (prev_event
)
3089 && (unsigned) XINT (c
) >= ' '
3090 && (unsigned) XINT (c
) != 127
3091 && (unsigned) XINT (c
) < 256)
3094 int key_count
, key_count_reset
;
3095 struct gcpro gcpro1
;
3096 int count
= SPECPDL_INDEX ();
3098 /* Save the echo status. */
3099 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3100 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3101 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3102 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3105 if (before_command_restore_flag
)
3107 this_command_key_count
= before_command_key_count_1
;
3108 if (this_command_key_count
< this_single_command_key_start
)
3109 this_single_command_key_start
= this_command_key_count
;
3110 echo_truncate (before_command_echo_length_1
);
3111 before_command_restore_flag
= 0;
3115 /* Save the this_command_keys status. */
3116 key_count
= this_command_key_count
;
3117 key_count_reset
= this_command_key_count_reset
;
3120 keys
= Fcopy_sequence (this_command_keys
);
3125 /* Clear out this_command_keys. */
3126 this_command_key_count
= 0;
3127 this_command_key_count_reset
= 0;
3129 /* Now wipe the echo area. */
3130 if (!NILP (echo_area_buffer
[0]))
3131 safe_run_hooks (Qecho_area_clear_hook
);
3132 clear_message (1, 0);
3135 /* If we are not reading a key sequence,
3136 never use the echo area. */
3139 specbind (Qinput_method_use_echo_area
, Qt
);
3142 /* Call the input method. */
3143 tem
= call1 (Vinput_method_function
, c
);
3145 tem
= unbind_to (count
, tem
);
3147 /* Restore the saved echoing state
3148 and this_command_keys state. */
3149 this_command_key_count
= key_count
;
3150 this_command_key_count_reset
= key_count_reset
;
3152 this_command_keys
= keys
;
3155 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3156 current_kboard
->echo_string
= saved_echo_string
;
3157 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3158 if (saved_immediate_echo
)
3163 /* The input method can return no events. */
3166 /* Bring back the previous message, if any. */
3167 if (! NILP (previous_echo_area_message
))
3168 message_with_string ("%s", previous_echo_area_message
, 0);
3171 /* It returned one event or more. */
3173 Vunread_post_input_method_events
3174 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3179 /* Display help if not echoing. */
3180 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3182 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3183 Lisp_Object help
, object
, position
, window
, tem
;
3185 tem
= Fcdr (XCDR (c
));
3188 window
= Fcar (tem
);
3190 object
= Fcar (tem
);
3192 position
= Fcar (tem
);
3194 show_help_echo (help
, window
, object
, position
, 0);
3196 /* We stopped being idle for this event; undo that. */
3197 timer_resume_idle ();
3201 if (! reread
|| this_command_key_count
== 0
3202 || this_command_key_count_reset
)
3205 /* Don't echo mouse motion events. */
3206 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3207 && NILP (Fzerop (Vecho_keystrokes
))
3208 && ! (EVENT_HAS_PARAMETERS (c
)
3209 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3212 if (! NILP (also_record
))
3213 echo_char (also_record
);
3214 /* Once we reread a character, echoing can happen
3215 the next time we pause to read a new one. */
3216 ok_to_echo_at_next_pause
= current_kboard
;
3219 /* Record this character as part of the current key. */
3220 add_command_key (c
);
3221 if (! NILP (also_record
))
3222 add_command_key (also_record
);
3225 last_input_char
= c
;
3228 /* Process the help character specially if enabled */
3229 if (!NILP (Vhelp_form
) && help_char_p (c
))
3232 count
= SPECPDL_INDEX ();
3234 record_unwind_protect (Fset_window_configuration
,
3235 Fcurrent_window_configuration (Qnil
));
3237 tem0
= Feval (Vhelp_form
);
3239 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3243 c
= read_char (0, 0, 0, Qnil
, 0);
3244 while (BUFFERP (c
));
3245 /* Remove the help from the frame */
3246 unbind_to (count
, Qnil
);
3249 if (EQ (c
, make_number (040)))
3253 c
= read_char (0, 0, 0, Qnil
, 0);
3254 while (BUFFERP (c
));
3263 /* Record a key that came from a mouse menu.
3264 Record it for echoing, for this-command-keys, and so on. */
3270 /* Wipe the echo area. */
3271 clear_message (1, 0);
3276 before_command_key_count
= this_command_key_count
;
3277 before_command_echo_length
= echo_length ();
3280 /* Don't echo mouse motion events. */
3281 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3282 && NILP (Fzerop (Vecho_keystrokes
)))
3286 /* Once we reread a character, echoing can happen
3287 the next time we pause to read a new one. */
3288 ok_to_echo_at_next_pause
= 0;
3291 /* Record this character as part of the current key. */
3292 add_command_key (c
);
3294 /* Re-reading in the middle of a command */
3295 last_input_char
= c
;
3299 /* Return 1 if should recognize C as "the help character". */
3307 if (EQ (c
, Vhelp_char
))
3309 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3310 if (EQ (c
, XCAR (tail
)))
3315 /* Record the input event C in various ways. */
3323 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3325 /* To avoid filling recent_keys with help-echo and mouse-movement
3326 events, we filter out repeated help-echo events, only store the
3327 first and last in a series of mouse-movement events, and don't
3328 store repeated help-echo events which are only separated by
3329 mouse-movement events. */
3331 Lisp_Object ev1
, ev2
, ev3
;
3334 if ((ix1
= recent_keys_index
- 1) < 0)
3335 ix1
= NUM_RECENT_KEYS
- 1;
3336 ev1
= AREF (recent_keys
, ix1
);
3338 if ((ix2
= ix1
- 1) < 0)
3339 ix2
= NUM_RECENT_KEYS
- 1;
3340 ev2
= AREF (recent_keys
, ix2
);
3342 if ((ix3
= ix2
- 1) < 0)
3343 ix3
= NUM_RECENT_KEYS
- 1;
3344 ev3
= AREF (recent_keys
, ix3
);
3346 if (EQ (XCAR (c
), Qhelp_echo
))
3348 /* Don't record `help-echo' in recent_keys unless it shows some help
3349 message, and a different help than the previously recorded
3351 Lisp_Object help
, last_help
;
3353 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3354 if (!STRINGP (help
))
3356 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3357 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3359 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3360 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3361 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3363 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3364 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3365 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3366 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3369 else if (EQ (XCAR (c
), Qmouse_movement
))
3371 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3372 So additional mouse movement events replace the last element. */
3373 Lisp_Object last_window
, window
;
3375 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3376 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3377 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3378 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3379 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3381 ASET (recent_keys
, ix1
, c
);
3387 store_kbd_macro_char (c
);
3392 ASET (recent_keys
, recent_keys_index
, c
);
3393 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3394 recent_keys_index
= 0;
3396 else if (recorded
< 0)
3398 /* We need to remove one or two events from recent_keys.
3399 To do this, we simply put nil at those events and move the
3400 recent_keys_index backwards over those events. Usually,
3401 users will never see those nil events, as they will be
3402 overwritten by the command keys entered to see recent_keys
3405 while (recorded
++ < 0 && total_keys
> 0)
3407 if (total_keys
< NUM_RECENT_KEYS
)
3409 if (--recent_keys_index
< 0)
3410 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3411 ASET (recent_keys
, recent_keys_index
, Qnil
);
3415 num_nonmacro_input_events
++;
3417 /* Write c to the dribble file. If c is a lispy event, write
3418 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3419 If you, dear reader, have a better idea, you've got the source. :-) */
3424 if (XUINT (c
) < 0x100)
3425 putc (XINT (c
), dribble
);
3427 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3431 Lisp_Object dribblee
;
3433 /* If it's a structured event, take the event header. */
3434 dribblee
= EVENT_HEAD (c
);
3436 if (SYMBOLP (dribblee
))
3438 putc ('<', dribble
);
3439 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3440 SBYTES (SYMBOL_NAME (dribblee
)),
3442 putc ('>', dribble
);
3454 struct buffer
*old
= current_buffer
;
3455 Fprinc (object
, Qnil
);
3456 set_buffer_internal (XBUFFER (Vstandard_output
));
3457 call0 (intern ("help-mode"));
3458 set_buffer_internal (old
);
3462 /* Copy out or in the info on where C-g should throw to.
3463 This is used when running Lisp code from within get_char,
3464 in case get_char is called recursively.
3465 See read_process_output. */
3471 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3475 restore_getcjmp (temp
)
3478 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3483 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3484 of this function. */
3487 tracking_off (old_value
)
3488 Lisp_Object old_value
;
3490 do_mouse_tracking
= old_value
;
3491 if (NILP (old_value
))
3493 /* Redisplay may have been preempted because there was input
3494 available, and it assumes it will be called again after the
3495 input has been processed. If the only input available was
3496 the sort that we have just disabled, then we need to call
3498 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3500 redisplay_preserve_echo_area (6);
3501 get_input_pending (&input_pending
,
3502 READABLE_EVENTS_DO_TIMERS_NOW
);
3508 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3509 doc
: /* Evaluate BODY with mouse movement events enabled.
3510 Within a `track-mouse' form, mouse motion generates input events that
3511 you can read with `read-event'.
3512 Normally, mouse motion is ignored.
3513 usage: (track-mouse BODY ...) */)
3517 int count
= SPECPDL_INDEX ();
3520 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3522 do_mouse_tracking
= Qt
;
3524 val
= Fprogn (args
);
3525 return unbind_to (count
, val
);
3528 /* If mouse has moved on some frame, return one of those frames.
3529 Return 0 otherwise. */
3534 Lisp_Object tail
, frame
;
3536 FOR_EACH_FRAME (tail
, frame
)
3538 if (XFRAME (frame
)->mouse_moved
)
3539 return XFRAME (frame
);
3545 #endif /* HAVE_MOUSE */
3547 /* Low level keyboard/mouse input.
3548 kbd_buffer_store_event places events in kbd_buffer, and
3549 kbd_buffer_get_event retrieves them. */
3551 /* Return true iff there are any events in the queue that read-char
3552 would return. If this returns false, a read-char would block. */
3554 readable_events (flags
)
3557 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3560 /* If the buffer contains only FOCUS_IN_EVENT events, and
3561 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3562 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3564 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3565 #ifdef USE_TOOLKIT_SCROLL_BARS
3566 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3570 struct input_event
*event
;
3572 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3579 #ifdef USE_TOOLKIT_SCROLL_BARS
3580 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3582 event
->kind
== FOCUS_IN_EVENT
)
3583 #ifdef USE_TOOLKIT_SCROLL_BARS
3584 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3585 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3586 && event
->part
== scroll_bar_handle
3587 && event
->modifiers
== 0)
3592 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3595 while (event
!= kbd_store_ptr
);
3602 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3603 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3608 if (current_kboard
->kbd_queue_has_data
)
3614 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3615 if (kb
->kbd_queue_has_data
)
3621 /* Set this for debugging, to have a way to get out */
3626 event_to_kboard (event
)
3627 struct input_event
*event
;
3630 frame
= event
->frame_or_window
;
3632 frame
= XCAR (frame
);
3633 else if (WINDOWP (frame
))
3634 frame
= WINDOW_FRAME (XWINDOW (frame
));
3636 /* There are still some events that don't set this field.
3637 For now, just ignore the problem.
3638 Also ignore dead frames here. */
3639 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3642 return FRAME_KBOARD (XFRAME (frame
));
3647 Lisp_Object Vthrow_on_input
;
3649 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3652 kbd_buffer_store_event (event
)
3653 register struct input_event
*event
;
3655 kbd_buffer_store_event_hold (event
, 0);
3658 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3660 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3661 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3662 Else, if EVENT is a quit event, store the quit event
3663 in HOLD_QUIT, and return (thus ignoring further events).
3665 This is used in read_avail_input to postpone the processing
3666 of the quit event until all subsequent input events have been
3667 parsed (and discarded).
3671 kbd_buffer_store_event_hold (event
, hold_quit
)
3672 register struct input_event
*event
;
3673 struct input_event
*hold_quit
;
3675 if (event
->kind
== NO_EVENT
)
3678 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3681 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3683 register int c
= event
->code
& 0377;
3685 if (event
->modifiers
& ctrl_modifier
)
3686 c
= make_ctrl_char (c
);
3688 c
|= (event
->modifiers
3689 & (meta_modifier
| alt_modifier
3690 | hyper_modifier
| super_modifier
));
3696 struct input_event
*sp
;
3699 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3700 kb
!= current_kboard
))
3703 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3704 Fcons (make_number (c
), Qnil
));
3705 kb
->kbd_queue_has_data
= 1;
3706 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3708 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3711 if (event_to_kboard (sp
) == kb
)
3713 sp
->kind
= NO_EVENT
;
3714 sp
->frame_or_window
= Qnil
;
3724 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3728 /* If this results in a quit_char being returned to Emacs as
3729 input, set Vlast_event_frame properly. If this doesn't
3730 get returned to Emacs as an event, the next event read
3731 will set Vlast_event_frame again, so this is safe to do. */
3735 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3737 focus
= event
->frame_or_window
;
3738 internal_last_event_frame
= focus
;
3739 Vlast_event_frame
= focus
;
3742 last_event_timestamp
= event
->timestamp
;
3743 handle_interrupt ();
3747 if (c
&& c
== stop_character
)
3753 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3754 Just ignore the second one. */
3755 else if (event
->kind
== BUFFER_SWITCH_EVENT
3756 && kbd_fetch_ptr
!= kbd_store_ptr
3757 && ((kbd_store_ptr
== kbd_buffer
3758 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3759 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3762 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3763 kbd_store_ptr
= kbd_buffer
;
3765 /* Don't let the very last slot in the buffer become full,
3766 since that would make the two pointers equal,
3767 and that is indistinguishable from an empty buffer.
3768 Discard the event if it would fill the last slot. */
3769 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3771 *kbd_store_ptr
= *event
;
3775 /* If we're inside while-no-input, and this event qualifies
3776 as input, set quit-flag to cause an interrupt. */
3777 if (!NILP (Vthrow_on_input
)
3778 && event
->kind
!= FOCUS_IN_EVENT
3779 && event
->kind
!= HELP_EVENT
3780 && event
->kind
!= DEICONIFY_EVENT
)
3782 Vquit_flag
= Vthrow_on_input
;
3783 /* If we're inside a function that wants immediate quits,
3785 if (immediate_quit
&& NILP (Vinhibit_quit
))
3795 /* Put an input event back in the head of the event queue. */
3798 kbd_buffer_unget_event (event
)
3799 register struct input_event
*event
;
3801 if (kbd_fetch_ptr
== kbd_buffer
)
3802 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3804 /* Don't let the very last slot in the buffer become full, */
3805 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3808 *kbd_fetch_ptr
= *event
;
3813 /* Generate HELP_EVENT input_events in BUFP which has room for
3814 SIZE events. If there's not enough room in BUFP, ignore this
3817 HELP is the help form.
3819 FRAME is the frame on which the help is generated. OBJECT is the
3820 Lisp object where the help was found (a buffer, a string, an
3821 overlay, or nil if neither from a string nor from a buffer. POS is
3822 the position within OBJECT where the help was found.
3824 Value is the number of input_events generated. */
3827 gen_help_event (help
, frame
, window
, object
, pos
)
3828 Lisp_Object help
, frame
, object
, window
;
3831 struct input_event event
;
3835 event
.kind
= HELP_EVENT
;
3836 event
.frame_or_window
= frame
;
3838 event
.x
= WINDOWP (window
) ? window
: frame
;
3841 kbd_buffer_store_event (&event
);
3845 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3848 kbd_buffer_store_help_event (frame
, help
)
3849 Lisp_Object frame
, help
;
3851 struct input_event event
;
3853 event
.kind
= HELP_EVENT
;
3854 event
.frame_or_window
= frame
;
3859 kbd_buffer_store_event (&event
);
3863 /* Discard any mouse events in the event buffer by setting them to
3866 discard_mouse_events ()
3868 struct input_event
*sp
;
3869 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3871 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3874 if (sp
->kind
== MOUSE_CLICK_EVENT
3875 || sp
->kind
== WHEEL_EVENT
3877 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3879 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3881 sp
->kind
= NO_EVENT
;
3887 /* Return non-zero if there are any real events waiting in the event
3888 buffer, not counting `NO_EVENT's.
3890 If DISCARD is non-zero, discard NO_EVENT events at the front of
3891 the input queue, possibly leaving the input queue empty if there
3892 are no real input events. */
3895 kbd_buffer_events_waiting (discard
)
3898 struct input_event
*sp
;
3900 for (sp
= kbd_fetch_ptr
;
3901 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3904 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3911 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3915 /* Clear input event EVENT. */
3919 struct input_event
*event
;
3921 event
->kind
= NO_EVENT
;
3925 /* Read one event from the event buffer, waiting if necessary.
3926 The value is a Lisp object representing the event.
3927 The value is nil for an event that should be ignored,
3928 or that was handled here.
3929 We always read and discard one event. */
3932 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3934 int *used_mouse_menu
;
3943 *kbp
= current_kboard
;
3947 /* Wait until there is input available. */
3950 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3953 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3957 /* If the quit flag is set, then read_char will return
3958 quit_char, so that counts as "available input." */
3959 if (!NILP (Vquit_flag
))
3960 quit_throw_to_read_char ();
3962 /* One way or another, wait until input is available; then, if
3963 interrupt handlers have not read it, read it now. */
3966 wait_for_kbd_input ();
3968 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3972 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3975 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3979 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3981 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3982 /* Pass 1 for EXPECT since we just waited to have input. */
3983 read_avail_input (1);
3985 #endif /* not VMS */
3988 if (CONSP (Vunread_command_events
))
3991 first
= XCAR (Vunread_command_events
);
3992 Vunread_command_events
= XCDR (Vunread_command_events
);
3993 *kbp
= current_kboard
;
3997 /* At this point, we know that there is a readable event available
3998 somewhere. If the event queue is empty, then there must be a
3999 mouse movement enabled and available. */
4000 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4002 struct input_event
*event
;
4004 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4008 last_event_timestamp
= event
->timestamp
;
4011 *kbp
= event_to_kboard (event
);
4013 *kbp
= current_kboard
; /* Better than returning null ptr? */
4015 *kbp
= &the_only_kboard
;
4020 /* These two kinds of events get special handling
4021 and don't actually appear to the command loop.
4022 We return nil for them. */
4023 if (event
->kind
== SELECTION_REQUEST_EVENT
4024 || event
->kind
== SELECTION_CLEAR_EVENT
)
4027 struct input_event copy
;
4029 /* Remove it from the buffer before processing it,
4030 since otherwise swallow_events will see it
4031 and process it again. */
4033 kbd_fetch_ptr
= event
+ 1;
4034 input_pending
= readable_events (0);
4035 x_handle_selection_event (©
);
4037 /* We're getting selection request events, but we don't have
4043 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4044 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4046 /* Make an event (delete-frame (FRAME)). */
4047 obj
= Fcons (event
->frame_or_window
, Qnil
);
4048 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4049 kbd_fetch_ptr
= event
+ 1;
4052 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4053 else if (event
->kind
== ICONIFY_EVENT
)
4055 /* Make an event (iconify-frame (FRAME)). */
4056 obj
= Fcons (event
->frame_or_window
, Qnil
);
4057 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4058 kbd_fetch_ptr
= event
+ 1;
4060 else if (event
->kind
== DEICONIFY_EVENT
)
4062 /* Make an event (make-frame-visible (FRAME)). */
4063 obj
= Fcons (event
->frame_or_window
, Qnil
);
4064 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4065 kbd_fetch_ptr
= event
+ 1;
4068 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4070 /* The value doesn't matter here; only the type is tested. */
4071 XSETBUFFER (obj
, current_buffer
);
4072 kbd_fetch_ptr
= event
+ 1;
4074 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4075 || defined (USE_GTK)
4076 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4078 kbd_fetch_ptr
= event
+ 1;
4079 input_pending
= readable_events (0);
4080 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4081 x_activate_menubar (XFRAME (event
->frame_or_window
));
4084 #if defined (WINDOWSNT) || defined (MAC_OS)
4085 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4088 /* Make an event (language-change (KEY_SCRIPT)). */
4089 obj
= Fcons (make_number (event
->code
), Qnil
);
4091 /* Make an event (language-change (FRAME CHARSET LCID)). */
4092 obj
= Fcons (event
->frame_or_window
, Qnil
);
4094 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4095 kbd_fetch_ptr
= event
+ 1;
4098 else if (event
->kind
== SAVE_SESSION_EVENT
)
4100 obj
= Fcons (Qsave_session
, Qnil
);
4101 kbd_fetch_ptr
= event
+ 1;
4103 /* Just discard these, by returning nil.
4104 With MULTI_KBOARD, these events are used as placeholders
4105 when we need to randomly delete events from the queue.
4106 (They shouldn't otherwise be found in the buffer,
4107 but on some machines it appears they do show up
4108 even without MULTI_KBOARD.) */
4109 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4110 mouse events during a popup-menu call. */
4111 else if (event
->kind
== NO_EVENT
)
4112 kbd_fetch_ptr
= event
+ 1;
4113 else if (event
->kind
== HELP_EVENT
)
4115 Lisp_Object object
, position
, help
, frame
, window
;
4117 frame
= event
->frame_or_window
;
4118 object
= event
->arg
;
4119 position
= make_number (event
->code
);
4122 clear_event (event
);
4124 kbd_fetch_ptr
= event
+ 1;
4125 if (!WINDOWP (window
))
4127 obj
= Fcons (Qhelp_echo
,
4128 list5 (frame
, help
, window
, object
, position
));
4130 else if (event
->kind
== FOCUS_IN_EVENT
)
4132 /* Notification of a FocusIn event. The frame receiving the
4133 focus is in event->frame_or_window. Generate a
4134 switch-frame event if necessary. */
4135 Lisp_Object frame
, focus
;
4137 frame
= event
->frame_or_window
;
4138 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4142 if (!EQ (frame
, internal_last_event_frame
)
4143 && !EQ (frame
, selected_frame
))
4144 obj
= make_lispy_switch_frame (frame
);
4145 internal_last_event_frame
= frame
;
4146 kbd_fetch_ptr
= event
+ 1;
4150 /* If this event is on a different frame, return a switch-frame this
4151 time, and leave the event in the queue for next time. */
4155 frame
= event
->frame_or_window
;
4157 frame
= XCAR (frame
);
4158 else if (WINDOWP (frame
))
4159 frame
= WINDOW_FRAME (XWINDOW (frame
));
4161 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4165 if (! EQ (frame
, internal_last_event_frame
)
4166 && !EQ (frame
, selected_frame
))
4167 obj
= make_lispy_switch_frame (frame
);
4168 internal_last_event_frame
= frame
;
4170 /* If we didn't decide to make a switch-frame event, go ahead
4171 and build a real event from the queue entry. */
4175 obj
= make_lispy_event (event
);
4177 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4178 || defined (USE_GTK)
4179 /* If this was a menu selection, then set the flag to inhibit
4180 writing to last_nonmenu_event. Don't do this if the event
4181 we're returning is (menu-bar), though; that indicates the
4182 beginning of the menu sequence, and we might as well leave
4183 that as the `event with parameters' for this selection. */
4185 && !EQ (event
->frame_or_window
, event
->arg
)
4186 && (event
->kind
== MENU_BAR_EVENT
4187 || event
->kind
== TOOL_BAR_EVENT
))
4188 *used_mouse_menu
= 1;
4191 /* Wipe out this event, to catch bugs. */
4192 clear_event (event
);
4193 kbd_fetch_ptr
= event
+ 1;
4198 /* Try generating a mouse motion event. */
4199 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4201 FRAME_PTR f
= some_mouse_moved ();
4202 Lisp_Object bar_window
;
4203 enum scroll_bar_part part
;
4207 *kbp
= current_kboard
;
4208 /* Note that this uses F to determine which display to look at.
4209 If there is no valid info, it does not store anything
4210 so x remains nil. */
4213 /* XXX Can f or mouse_position_hook be NULL here? */
4214 if (f
&& FRAME_DEVICE (f
)->mouse_position_hook
)
4215 (*FRAME_DEVICE (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4216 &part
, &x
, &y
, &time
);
4220 /* Decide if we should generate a switch-frame event. Don't
4221 generate switch-frame events for motion outside of all Emacs
4227 frame
= FRAME_FOCUS_FRAME (f
);
4229 XSETFRAME (frame
, f
);
4231 if (! EQ (frame
, internal_last_event_frame
)
4232 && !EQ (frame
, selected_frame
))
4233 obj
= make_lispy_switch_frame (frame
);
4234 internal_last_event_frame
= frame
;
4237 /* If we didn't decide to make a switch-frame event, go ahead and
4238 return a mouse-motion event. */
4239 if (!NILP (x
) && NILP (obj
))
4240 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4242 #endif /* HAVE_MOUSE */
4244 /* We were promised by the above while loop that there was
4245 something for us to read! */
4248 input_pending
= readable_events (0);
4250 Vlast_event_frame
= internal_last_event_frame
;
4255 /* Process any events that are not user-visible,
4256 then return, without reading any user-visible events. */
4259 swallow_events (do_display
)
4264 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4266 struct input_event
*event
;
4268 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4272 last_event_timestamp
= event
->timestamp
;
4274 /* These two kinds of events get special handling
4275 and don't actually appear to the command loop. */
4276 if (event
->kind
== SELECTION_REQUEST_EVENT
4277 || event
->kind
== SELECTION_CLEAR_EVENT
)
4280 struct input_event copy
;
4282 /* Remove it from the buffer before processing it,
4283 since otherwise swallow_events called recursively could see it
4284 and process it again. */
4286 kbd_fetch_ptr
= event
+ 1;
4287 input_pending
= readable_events (0);
4288 x_handle_selection_event (©
);
4290 /* We're getting selection request events, but we don't have
4299 old_timers_run
= timers_run
;
4300 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4302 if (timers_run
!= old_timers_run
&& do_display
)
4303 redisplay_preserve_echo_area (7);
4306 /* Record the start of when Emacs is idle,
4307 for the sake of running idle-time timers. */
4314 /* If we are already in the idle state, do nothing. */
4315 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4318 EMACS_GET_TIME (timer_idleness_start_time
);
4320 timer_last_idleness_start_time
= timer_idleness_start_time
;
4322 /* Mark all idle-time timers as once again candidates for running. */
4323 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4327 timer
= XCAR (timers
);
4329 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4331 XVECTOR (timer
)->contents
[0] = Qnil
;
4335 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4340 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4343 /* Resume idle timer from last idle start time. */
4346 timer_resume_idle ()
4348 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4351 timer_idleness_start_time
= timer_last_idleness_start_time
;
4354 /* This is only for debugging. */
4355 struct input_event last_timer_event
;
4357 /* Check whether a timer has fired. To prevent larger problems we simply
4358 disregard elements that are not proper timers. Do not make a circular
4359 timer list for the time being.
4361 Returns the number of seconds to wait until the next timer fires. If a
4362 timer is triggering now, return zero seconds.
4363 If no timer is active, return -1 seconds.
4365 If a timer is ripe, we run it, with quitting turned off.
4367 DO_IT_NOW is now ignored. It used to mean that we should
4368 run the timer directly instead of queueing a timer-event.
4369 Now we always run timers directly. */
4372 timer_check (do_it_now
)
4375 EMACS_TIME nexttime
;
4376 EMACS_TIME now
, idleness_now
;
4377 Lisp_Object timers
, idle_timers
, chosen_timer
;
4378 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4380 EMACS_SET_SECS (nexttime
, -1);
4381 EMACS_SET_USECS (nexttime
, -1);
4383 /* Always consider the ordinary timers. */
4384 timers
= Vtimer_list
;
4385 /* Consider the idle timers only if Emacs is idle. */
4386 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4387 idle_timers
= Vtimer_idle_list
;
4390 chosen_timer
= Qnil
;
4391 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4393 if (CONSP (timers
) || CONSP (idle_timers
))
4395 EMACS_GET_TIME (now
);
4396 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4397 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4400 while (CONSP (timers
) || CONSP (idle_timers
))
4402 Lisp_Object
*vector
;
4403 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4404 EMACS_TIME timer_time
, idle_timer_time
;
4405 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4407 /* Skip past invalid timers and timers already handled. */
4410 timer
= XCAR (timers
);
4411 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4413 timers
= XCDR (timers
);
4416 vector
= XVECTOR (timer
)->contents
;
4418 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4419 || !INTEGERP (vector
[3])
4420 || ! NILP (vector
[0]))
4422 timers
= XCDR (timers
);
4426 if (!NILP (idle_timers
))
4428 timer
= XCAR (idle_timers
);
4429 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4431 idle_timers
= XCDR (idle_timers
);
4434 vector
= XVECTOR (timer
)->contents
;
4436 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4437 || !INTEGERP (vector
[3])
4438 || ! NILP (vector
[0]))
4440 idle_timers
= XCDR (idle_timers
);
4445 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4446 based on the next ordinary timer.
4447 TIMER_DIFFERENCE is the distance in time from NOW to when
4448 this timer becomes ripe (negative if it's already ripe). */
4451 timer
= XCAR (timers
);
4452 vector
= XVECTOR (timer
)->contents
;
4453 EMACS_SET_SECS (timer_time
,
4454 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4455 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4456 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4459 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4460 based on the next idle timer. */
4461 if (!NILP (idle_timers
))
4463 idle_timer
= XCAR (idle_timers
);
4464 vector
= XVECTOR (idle_timer
)->contents
;
4465 EMACS_SET_SECS (idle_timer_time
,
4466 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4467 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4468 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4471 /* Decide which timer is the next timer,
4472 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4473 Also step down the list where we found that timer. */
4475 if (! NILP (timers
) && ! NILP (idle_timers
))
4478 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4479 if (EMACS_TIME_NEG_P (temp
))
4481 chosen_timer
= timer
;
4482 timers
= XCDR (timers
);
4483 difference
= timer_difference
;
4487 chosen_timer
= idle_timer
;
4488 idle_timers
= XCDR (idle_timers
);
4489 difference
= idle_timer_difference
;
4492 else if (! NILP (timers
))
4494 chosen_timer
= timer
;
4495 timers
= XCDR (timers
);
4496 difference
= timer_difference
;
4500 chosen_timer
= idle_timer
;
4501 idle_timers
= XCDR (idle_timers
);
4502 difference
= idle_timer_difference
;
4504 vector
= XVECTOR (chosen_timer
)->contents
;
4506 /* If timer is ripe, run it if it hasn't been run. */
4507 if (EMACS_TIME_NEG_P (difference
)
4508 || (EMACS_SECS (difference
) == 0
4509 && EMACS_USECS (difference
) == 0))
4511 if (NILP (vector
[0]))
4513 int count
= SPECPDL_INDEX ();
4514 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4516 /* On unbind_to, resume allowing input from any kboard, if that
4518 record_single_kboard_state ();
4520 /* Mark the timer as triggered to prevent problems if the lisp
4521 code fails to reschedule it right. */
4524 specbind (Qinhibit_quit
, Qt
);
4526 call1 (Qtimer_event_handler
, chosen_timer
);
4527 Vdeactivate_mark
= old_deactivate_mark
;
4529 unbind_to (count
, Qnil
);
4531 /* Since we have handled the event,
4532 we don't need to tell the caller to wake up and do it. */
4536 /* When we encounter a timer that is still waiting,
4537 return the amount of time to wait before it is ripe. */
4544 /* No timers are pending in the future. */
4545 /* Return 0 if we generated an event, and -1 if not. */
4550 /* Caches for modify_event_symbol. */
4551 static Lisp_Object accent_key_syms
;
4552 static Lisp_Object func_key_syms
;
4553 static Lisp_Object mouse_syms
;
4554 static Lisp_Object wheel_syms
;
4555 static Lisp_Object drag_n_drop_syms
;
4557 /* This is a list of keysym codes for special "accent" characters.
4558 It parallels lispy_accent_keys. */
4560 static int lispy_accent_codes
[] =
4562 #ifdef XK_dead_circumflex
4567 #ifdef XK_dead_grave
4572 #ifdef XK_dead_tilde
4577 #ifdef XK_dead_diaeresis
4582 #ifdef XK_dead_macron
4587 #ifdef XK_dead_degree
4592 #ifdef XK_dead_acute
4597 #ifdef XK_dead_cedilla
4602 #ifdef XK_dead_breve
4607 #ifdef XK_dead_ogonek
4612 #ifdef XK_dead_caron
4617 #ifdef XK_dead_doubleacute
4618 XK_dead_doubleacute
,
4622 #ifdef XK_dead_abovedot
4627 #ifdef XK_dead_abovering
4637 #ifdef XK_dead_belowdot
4642 #ifdef XK_dead_voiced_sound
4643 XK_dead_voiced_sound
,
4647 #ifdef XK_dead_semivoiced_sound
4648 XK_dead_semivoiced_sound
,
4664 /* This is a list of Lisp names for special "accent" characters.
4665 It parallels lispy_accent_codes. */
4667 static char *lispy_accent_keys
[] =
4685 "dead-voiced-sound",
4686 "dead-semivoiced-sound",
4692 #define FUNCTION_KEY_OFFSET 0x0
4694 char *lispy_function_keys
[] =
4698 0, /* VK_LBUTTON 0x01 */
4699 0, /* VK_RBUTTON 0x02 */
4700 "cancel", /* VK_CANCEL 0x03 */
4701 0, /* VK_MBUTTON 0x04 */
4703 0, 0, 0, /* 0x05 .. 0x07 */
4705 "backspace", /* VK_BACK 0x08 */
4706 "tab", /* VK_TAB 0x09 */
4708 0, 0, /* 0x0A .. 0x0B */
4710 "clear", /* VK_CLEAR 0x0C */
4711 "return", /* VK_RETURN 0x0D */
4713 0, 0, /* 0x0E .. 0x0F */
4715 0, /* VK_SHIFT 0x10 */
4716 0, /* VK_CONTROL 0x11 */
4717 0, /* VK_MENU 0x12 */
4718 "pause", /* VK_PAUSE 0x13 */
4719 "capslock", /* VK_CAPITAL 0x14 */
4721 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4723 "escape", /* VK_ESCAPE 0x1B */
4725 0, 0, 0, 0, /* 0x1C .. 0x1F */
4727 0, /* VK_SPACE 0x20 */
4728 "prior", /* VK_PRIOR 0x21 */
4729 "next", /* VK_NEXT 0x22 */
4730 "end", /* VK_END 0x23 */
4731 "home", /* VK_HOME 0x24 */
4732 "left", /* VK_LEFT 0x25 */
4733 "up", /* VK_UP 0x26 */
4734 "right", /* VK_RIGHT 0x27 */
4735 "down", /* VK_DOWN 0x28 */
4736 "select", /* VK_SELECT 0x29 */
4737 "print", /* VK_PRINT 0x2A */
4738 "execute", /* VK_EXECUTE 0x2B */
4739 "snapshot", /* VK_SNAPSHOT 0x2C */
4740 "insert", /* VK_INSERT 0x2D */
4741 "delete", /* VK_DELETE 0x2E */
4742 "help", /* VK_HELP 0x2F */
4744 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4746 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4748 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4750 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4752 0, 0, 0, 0, 0, 0, 0, 0, 0,
4753 0, 0, 0, 0, 0, 0, 0, 0, 0,
4754 0, 0, 0, 0, 0, 0, 0, 0,
4756 "lwindow", /* VK_LWIN 0x5B */
4757 "rwindow", /* VK_RWIN 0x5C */
4758 "apps", /* VK_APPS 0x5D */
4760 0, 0, /* 0x5E .. 0x5F */
4762 "kp-0", /* VK_NUMPAD0 0x60 */
4763 "kp-1", /* VK_NUMPAD1 0x61 */
4764 "kp-2", /* VK_NUMPAD2 0x62 */
4765 "kp-3", /* VK_NUMPAD3 0x63 */
4766 "kp-4", /* VK_NUMPAD4 0x64 */
4767 "kp-5", /* VK_NUMPAD5 0x65 */
4768 "kp-6", /* VK_NUMPAD6 0x66 */
4769 "kp-7", /* VK_NUMPAD7 0x67 */
4770 "kp-8", /* VK_NUMPAD8 0x68 */
4771 "kp-9", /* VK_NUMPAD9 0x69 */
4772 "kp-multiply", /* VK_MULTIPLY 0x6A */
4773 "kp-add", /* VK_ADD 0x6B */
4774 "kp-separator", /* VK_SEPARATOR 0x6C */
4775 "kp-subtract", /* VK_SUBTRACT 0x6D */
4776 "kp-decimal", /* VK_DECIMAL 0x6E */
4777 "kp-divide", /* VK_DIVIDE 0x6F */
4778 "f1", /* VK_F1 0x70 */
4779 "f2", /* VK_F2 0x71 */
4780 "f3", /* VK_F3 0x72 */
4781 "f4", /* VK_F4 0x73 */
4782 "f5", /* VK_F5 0x74 */
4783 "f6", /* VK_F6 0x75 */
4784 "f7", /* VK_F7 0x76 */
4785 "f8", /* VK_F8 0x77 */
4786 "f9", /* VK_F9 0x78 */
4787 "f10", /* VK_F10 0x79 */
4788 "f11", /* VK_F11 0x7A */
4789 "f12", /* VK_F12 0x7B */
4790 "f13", /* VK_F13 0x7C */
4791 "f14", /* VK_F14 0x7D */
4792 "f15", /* VK_F15 0x7E */
4793 "f16", /* VK_F16 0x7F */
4794 "f17", /* VK_F17 0x80 */
4795 "f18", /* VK_F18 0x81 */
4796 "f19", /* VK_F19 0x82 */
4797 "f20", /* VK_F20 0x83 */
4798 "f21", /* VK_F21 0x84 */
4799 "f22", /* VK_F22 0x85 */
4800 "f23", /* VK_F23 0x86 */
4801 "f24", /* VK_F24 0x87 */
4803 0, 0, 0, 0, /* 0x88 .. 0x8B */
4804 0, 0, 0, 0, /* 0x8C .. 0x8F */
4806 "kp-numlock", /* VK_NUMLOCK 0x90 */
4807 "scroll", /* VK_SCROLL 0x91 */
4809 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4810 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4811 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4812 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4813 "kp-end", /* VK_NUMPAD_END 0x96 */
4814 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4815 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4816 "kp-up", /* VK_NUMPAD_UP 0x99 */
4817 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4818 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4819 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4820 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4822 0, 0, /* 0x9E .. 0x9F */
4825 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4826 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4827 * No other API or message will distinguish left and right keys this way.
4831 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4832 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4833 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4834 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4835 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4841 "attn", /* VK_ATTN 0xF6 */
4842 "crsel", /* VK_CRSEL 0xF7 */
4843 "exsel", /* VK_EXSEL 0xF8 */
4844 "ereof", /* VK_EREOF 0xF9 */
4845 "play", /* VK_PLAY 0xFA */
4846 "zoom", /* VK_ZOOM 0xFB */
4847 "noname", /* VK_NONAME 0xFC */
4848 "pa1", /* VK_PA1 0xFD */
4849 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4853 #else /* not HAVE_NTGUI */
4855 /* This should be dealt with in XTread_socket now, and that doesn't
4856 depend on the client system having the Kana syms defined. See also
4857 the XK_kana_A case below. */
4860 static char *lispy_kana_keys
[] =
4862 /* X Keysym value */
4863 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4864 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4865 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4866 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4867 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4868 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4869 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4870 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4871 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4872 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4873 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4874 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4875 "kana-i", "kana-u", "kana-e", "kana-o",
4876 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4877 "prolongedsound", "kana-A", "kana-I", "kana-U",
4878 "kana-E", "kana-O", "kana-KA", "kana-KI",
4879 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4880 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4881 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4882 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4883 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4884 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4885 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4886 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4887 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4888 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4889 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4890 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4892 #endif /* XK_kana_A */
4895 #define FUNCTION_KEY_OFFSET 0xff00
4897 /* You'll notice that this table is arranged to be conveniently
4898 indexed by X Windows keysym values. */
4899 static char *lispy_function_keys
[] =
4901 /* X Keysym value */
4903 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4904 "backspace", "tab", "linefeed", "clear",
4906 0, 0, 0, "pause", /* 0xff10...1f */
4907 0, 0, 0, 0, 0, 0, 0, "escape",
4909 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4910 "romaji", "hiragana", "katakana", "hiragana-katakana",
4911 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4912 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4913 "eisu-toggle", /* 0xff30...3f */
4914 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4915 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4917 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4918 "down", "prior", "next", "end",
4919 "begin", 0, 0, 0, 0, 0, 0, 0,
4920 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4931 "break", /* 0xff6b */
4934 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4935 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4936 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4937 0, 0, 0, 0, 0, 0, 0, 0,
4938 "kp-tab", /* 0xff89 */
4940 "kp-enter", /* 0xff8d */
4942 "kp-f1", /* 0xff91 */
4946 "kp-home", /* 0xff95 */
4951 "kp-prior", /* kp-page-up */
4952 "kp-next", /* kp-page-down */
4958 0, 0, 0, 0, 0, 0, 0, 0, 0,
4959 "kp-multiply", /* 0xffaa */
4964 "kp-divide", /* 0xffaf */
4965 "kp-0", /* 0xffb0 */
4966 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4969 "kp-equal", /* 0xffbd */
4970 "f1", /* 0xffbe */ /* IsFunctionKey */
4972 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4973 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4974 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4975 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4976 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4977 0, 0, 0, 0, 0, 0, 0, 0,
4978 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4979 0, 0, 0, 0, 0, 0, 0, "delete"
4982 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4983 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4985 static char *iso_lispy_function_keys
[] =
4987 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4988 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4989 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4990 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4991 "iso-lefttab", /* 0xfe20 */
4992 "iso-move-line-up", "iso-move-line-down",
4993 "iso-partial-line-up", "iso-partial-line-down",
4994 "iso-partial-space-left", "iso-partial-space-right",
4995 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4996 "iso-release-margin-left", "iso-release-margin-right",
4997 "iso-release-both-margins",
4998 "iso-fast-cursor-left", "iso-fast-cursor-right",
4999 "iso-fast-cursor-up", "iso-fast-cursor-down",
5000 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5001 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5004 #endif /* not HAVE_NTGUI */
5006 Lisp_Object Vlispy_mouse_stem
;
5008 static char *lispy_wheel_names
[] =
5010 "wheel-up", "wheel-down"
5013 /* drag-n-drop events are generated when a set of selected files are
5014 dragged from another application and dropped onto an Emacs window. */
5015 static char *lispy_drag_n_drop_names
[] =
5020 /* Scroll bar parts. */
5021 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5022 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5023 Lisp_Object Qtop
, Qratio
;
5025 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5026 Lisp_Object
*scroll_bar_parts
[] = {
5027 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5028 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5031 /* User signal events. */
5032 Lisp_Object Qusr1_signal
, Qusr2_signal
;
5034 Lisp_Object
*lispy_user_signals
[] =
5036 &Qusr1_signal
, &Qusr2_signal
5040 /* A vector, indexed by button number, giving the down-going location
5041 of currently depressed buttons, both scroll bar and non-scroll bar.
5043 The elements have the form
5044 (BUTTON-NUMBER MODIFIER-MASK . REST)
5045 where REST is the cdr of a position as it would be reported in the event.
5047 The make_lispy_event function stores positions here to tell the
5048 difference between click and drag events, and to store the starting
5049 location to be included in drag events. */
5051 static Lisp_Object button_down_location
;
5053 /* Information about the most recent up-going button event: Which
5054 button, what location, and what time. */
5056 static int last_mouse_button
;
5057 static int last_mouse_x
;
5058 static int last_mouse_y
;
5059 static unsigned long button_down_time
;
5061 /* The maximum time between clicks to make a double-click, or Qnil to
5062 disable double-click detection, or Qt for no time limit. */
5064 Lisp_Object Vdouble_click_time
;
5066 /* Maximum number of pixels the mouse may be moved between clicks
5067 to make a double-click. */
5069 EMACS_INT double_click_fuzz
;
5071 /* The number of clicks in this multiple-click. */
5073 int double_click_count
;
5075 /* Return position of a mouse click or wheel event */
5078 make_lispy_position (f
, x
, y
, time
)
5084 enum window_part part
;
5085 Lisp_Object posn
= Qnil
;
5086 Lisp_Object extra_info
= Qnil
;
5089 /* Set `window' to the window under frame pixel coordinates (x,y) */
5091 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5092 &part
, &wx
, &wy
, 0);
5096 if (WINDOWP (window
))
5098 /* It's a click in window window at frame coordinates (x,y) */
5099 struct window
*w
= XWINDOW (window
);
5100 Lisp_Object string_info
= Qnil
;
5101 int textpos
= -1, rx
= -1, ry
= -1;
5102 int dx
= -1, dy
= -1;
5103 int width
= -1, height
= -1;
5104 Lisp_Object object
= Qnil
;
5106 /* Set event coordinates to window-relative coordinates
5107 for constructing the Lisp event below. */
5111 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5113 /* Mode line or header line. Look for a string under
5114 the mouse that may have a `local-map' property. */
5118 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5120 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5121 &object
, &dx
, &dy
, &width
, &height
);
5122 if (STRINGP (string
))
5123 string_info
= Fcons (string
, make_number (charpos
));
5124 if (w
== XWINDOW (selected_window
))
5127 textpos
= XMARKER (w
->pointm
)->charpos
;
5129 else if (part
== ON_VERTICAL_BORDER
)
5131 posn
= Qvertical_line
;
5136 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5141 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5143 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5144 &object
, &dx
, &dy
, &width
, &height
);
5145 if (STRINGP (string
))
5146 string_info
= Fcons (string
, make_number (charpos
));
5148 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5150 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5153 if (part
== ON_RIGHT_FRINGE
)
5154 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5155 + window_box_width (w
, TEXT_AREA
)
5156 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5157 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5159 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5160 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5165 Lisp_Object string2
, object2
= Qnil
;
5166 struct display_pos p
;
5168 int width2
, height2
;
5169 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5170 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5171 &object2
, &dx2
, &dy2
,
5173 textpos
= CHARPOS (p
.pos
);
5174 if (rx
< 0) rx
= wx
;
5175 if (ry
< 0) ry
= wy
;
5176 if (dx
< 0) dx
= dx2
;
5177 if (dy
< 0) dy
= dy2
;
5178 if (width
< 0) width
= width2
;
5179 if (height
< 0) height
= height2
;
5183 posn
= make_number (textpos
);
5184 if (STRINGP (string2
))
5185 string_info
= Fcons (string2
,
5186 make_number (CHARPOS (p
.string_pos
)));
5192 #ifdef HAVE_WINDOW_SYSTEM
5193 if (IMAGEP (object
))
5195 Lisp_Object image_map
, hotspot
;
5196 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5198 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5200 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5201 posn
= XCAR (hotspot
);
5206 extra_info
= Fcons (object
,
5207 Fcons (Fcons (make_number (dx
),
5209 Fcons (Fcons (make_number (width
),
5210 make_number (height
)),
5214 extra_info
= Fcons (string_info
,
5215 Fcons (make_number (textpos
),
5216 Fcons (Fcons (make_number (rx
),
5222 XSETFRAME (window
, f
);
5227 XSETFASTINT (*x
, 0);
5228 XSETFASTINT (*y
, 0);
5231 return Fcons (window
,
5233 Fcons (Fcons (*x
, *y
),
5234 Fcons (make_number (time
),
5238 /* Given a struct input_event, build the lisp event which represents
5239 it. If EVENT is 0, build a mouse movement event from the mouse
5240 movement buffer, which should have a movement event in it.
5242 Note that events must be passed to this function in the order they
5243 are received; this function stores the location of button presses
5244 in order to build drag events when the button is released. */
5247 make_lispy_event (event
)
5248 struct input_event
*event
;
5252 switch (SWITCH_ENUM_CAST (event
->kind
))
5254 /* A simple keystroke. */
5255 case ASCII_KEYSTROKE_EVENT
:
5257 Lisp_Object lispy_c
;
5258 int c
= event
->code
& 0377;
5259 /* Turn ASCII characters into control characters
5261 if (event
->modifiers
& ctrl_modifier
)
5262 c
= make_ctrl_char (c
);
5264 /* Add in the other modifier bits. We took care of ctrl_modifier
5265 just above, and the shift key was taken care of by the X code,
5266 and applied to control characters by make_ctrl_char. */
5267 c
|= (event
->modifiers
5268 & (meta_modifier
| alt_modifier
5269 | hyper_modifier
| super_modifier
));
5270 /* Distinguish Shift-SPC from SPC. */
5271 if ((event
->code
& 0377) == 040
5272 && event
->modifiers
& shift_modifier
)
5273 c
|= shift_modifier
;
5274 button_down_time
= 0;
5275 XSETFASTINT (lispy_c
, c
);
5279 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5281 Lisp_Object lispy_c
;
5282 int c
= event
->code
;
5284 /* Add in the other modifier bits. We took care of ctrl_modifier
5285 just above, and the shift key was taken care of by the X code,
5286 and applied to control characters by make_ctrl_char. */
5287 c
|= (event
->modifiers
5288 & (meta_modifier
| alt_modifier
5289 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5290 /* What about the `shift' modifier ? */
5291 button_down_time
= 0;
5292 XSETFASTINT (lispy_c
, c
);
5296 /* A function key. The symbol may need to have modifier prefixes
5298 case NON_ASCII_KEYSTROKE_EVENT
:
5299 button_down_time
= 0;
5301 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5302 if (event
->code
== lispy_accent_codes
[i
])
5303 return modify_event_symbol (i
,
5305 Qfunction_key
, Qnil
,
5306 lispy_accent_keys
, &accent_key_syms
,
5307 (sizeof (lispy_accent_keys
)
5308 / sizeof (lispy_accent_keys
[0])));
5312 if (event
->code
>= 0x400 && event
->code
< 0x500)
5313 return modify_event_symbol (event
->code
- 0x400,
5314 event
->modifiers
& ~shift_modifier
,
5315 Qfunction_key
, Qnil
,
5316 lispy_kana_keys
, &func_key_syms
,
5317 (sizeof (lispy_kana_keys
)
5318 / sizeof (lispy_kana_keys
[0])));
5319 #endif /* XK_kana_A */
5322 #ifdef ISO_FUNCTION_KEY_OFFSET
5323 if (event
->code
< FUNCTION_KEY_OFFSET
5324 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5325 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5327 Qfunction_key
, Qnil
,
5328 iso_lispy_function_keys
, &func_key_syms
,
5329 (sizeof (iso_lispy_function_keys
)
5330 / sizeof (iso_lispy_function_keys
[0])));
5333 /* Handle system-specific or unknown keysyms. */
5334 if (event
->code
& (1 << 28)
5335 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5336 || (event
->code
- FUNCTION_KEY_OFFSET
5337 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5338 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5340 /* We need to use an alist rather than a vector as the cache
5341 since we can't make a vector long enuf. */
5342 if (NILP (current_kboard
->system_key_syms
))
5343 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5344 return modify_event_symbol (event
->code
,
5347 current_kboard
->Vsystem_key_alist
,
5348 0, ¤t_kboard
->system_key_syms
,
5352 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5354 Qfunction_key
, Qnil
,
5355 lispy_function_keys
, &func_key_syms
,
5356 (sizeof (lispy_function_keys
)
5357 / sizeof (lispy_function_keys
[0])));
5360 /* A mouse click. Figure out where it is, decide whether it's
5361 a press, click or drag, and build the appropriate structure. */
5362 case MOUSE_CLICK_EVENT
:
5363 #ifndef USE_TOOLKIT_SCROLL_BARS
5364 case SCROLL_BAR_CLICK_EVENT
:
5367 int button
= event
->code
;
5369 Lisp_Object position
;
5370 Lisp_Object
*start_pos_ptr
;
5371 Lisp_Object start_pos
;
5375 /* Build the position as appropriate for this mouse click. */
5376 if (event
->kind
== MOUSE_CLICK_EVENT
)
5378 struct frame
*f
= XFRAME (event
->frame_or_window
);
5379 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5383 /* Ignore mouse events that were made on frame that
5384 have been deleted. */
5385 if (! FRAME_LIVE_P (f
))
5388 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5389 /* EVENT->x and EVENT->y are frame-relative pixel
5390 coordinates at this place. Under old redisplay, COLUMN
5391 and ROW are set to frame relative glyph coordinates
5392 which are then used to determine whether this click is
5393 in a menu (non-toolkit version). */
5394 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5395 &column
, &row
, NULL
, 1);
5397 /* In the non-toolkit version, clicks on the menu bar
5398 are ordinary button events in the event buffer.
5399 Distinguish them, and invoke the menu.
5401 (In the toolkit version, the toolkit handles the menu bar
5402 and Emacs doesn't know about it until after the user
5403 makes a selection.) */
5404 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5405 && (event
->modifiers
& down_modifier
))
5407 Lisp_Object items
, item
;
5412 /* Activate the menu bar on the down event. If the
5413 up event comes in before the menu code can deal with it,
5415 if (! (event
->modifiers
& down_modifier
))
5419 /* Find the menu bar item under `column'. */
5421 items
= FRAME_MENU_BAR_ITEMS (f
);
5422 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5424 Lisp_Object pos
, string
;
5425 string
= AREF (items
, i
+ 1);
5426 pos
= AREF (items
, i
+ 3);
5429 if (column
>= XINT (pos
)
5430 && column
< XINT (pos
) + SCHARS (string
))
5432 item
= AREF (items
, i
);
5437 /* ELisp manual 2.4b says (x y) are window relative but
5438 code says they are frame-relative. */
5440 = Fcons (event
->frame_or_window
,
5442 Fcons (Fcons (event
->x
, event
->y
),
5443 Fcons (make_number (event
->timestamp
),
5446 return Fcons (item
, Fcons (position
, Qnil
));
5448 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5450 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5453 #ifndef USE_TOOLKIT_SCROLL_BARS
5456 /* It's a scrollbar click. */
5458 Lisp_Object portion_whole
;
5461 window
= event
->frame_or_window
;
5462 portion_whole
= Fcons (event
->x
, event
->y
);
5463 part
= *scroll_bar_parts
[(int) event
->part
];
5467 Fcons (Qvertical_scroll_bar
,
5468 Fcons (portion_whole
,
5469 Fcons (make_number (event
->timestamp
),
5470 Fcons (part
, Qnil
)))));
5472 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5474 if (button
>= ASIZE (button_down_location
))
5476 button_down_location
= larger_vector (button_down_location
,
5478 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5481 start_pos_ptr
= &AREF (button_down_location
, button
);
5482 start_pos
= *start_pos_ptr
;
5483 *start_pos_ptr
= Qnil
;
5486 /* On window-system frames, use the value of
5487 double-click-fuzz as is. On other frames, interpret it
5488 as a multiple of 1/8 characters. */
5492 if (WINDOWP (event
->frame_or_window
))
5493 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5494 else if (FRAMEP (event
->frame_or_window
))
5495 f
= XFRAME (event
->frame_or_window
);
5499 if (FRAME_WINDOW_P (f
))
5500 fuzz
= double_click_fuzz
;
5502 fuzz
= double_click_fuzz
/ 8;
5504 is_double
= (button
== last_mouse_button
5505 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5506 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5507 && button_down_time
!= 0
5508 && (EQ (Vdouble_click_time
, Qt
)
5509 || (INTEGERP (Vdouble_click_time
)
5510 && ((int)(event
->timestamp
- button_down_time
)
5511 < XINT (Vdouble_click_time
)))));
5514 last_mouse_button
= button
;
5515 last_mouse_x
= XINT (event
->x
);
5516 last_mouse_y
= XINT (event
->y
);
5518 /* If this is a button press, squirrel away the location, so
5519 we can decide later whether it was a click or a drag. */
5520 if (event
->modifiers
& down_modifier
)
5524 double_click_count
++;
5525 event
->modifiers
|= ((double_click_count
> 2)
5530 double_click_count
= 1;
5531 button_down_time
= event
->timestamp
;
5532 *start_pos_ptr
= Fcopy_alist (position
);
5535 /* Now we're releasing a button - check the co-ordinates to
5536 see if this was a click or a drag. */
5537 else if (event
->modifiers
& up_modifier
)
5539 /* If we did not see a down before this up, ignore the up.
5540 Probably this happened because the down event chose a
5541 menu item. It would be an annoyance to treat the
5542 release of the button that chose the menu item as a
5545 if (!CONSP (start_pos
))
5548 event
->modifiers
&= ~up_modifier
;
5549 #if 0 /* Formerly we treated an up with no down as a click event. */
5550 if (!CONSP (start_pos
))
5551 event
->modifiers
|= click_modifier
;
5556 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5558 /* The third element of every position
5559 should be the (x,y) pair. */
5560 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5562 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5564 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5565 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5568 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5569 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5570 /* Maybe the mouse has moved a lot, caused scrolling, and
5571 eventually ended up at the same screen position (but
5572 not buffer position) in which case it is a drag, not
5574 /* FIXME: OTOH if the buffer position has changed
5575 because of a timer or process filter rather than
5576 because of mouse movement, it should be considered as
5577 a click. But mouse-drag-region completely ignores
5578 this case and it hasn't caused any real problem, so
5579 it's probably OK to ignore it as well. */
5580 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5581 /* Mouse hasn't moved (much). */
5582 event
->modifiers
|= click_modifier
;
5585 button_down_time
= 0;
5586 event
->modifiers
|= drag_modifier
;
5589 /* Don't check is_double; treat this as multiple
5590 if the down-event was multiple. */
5591 if (double_click_count
> 1)
5592 event
->modifiers
|= ((double_click_count
> 2)
5598 /* Every mouse event should either have the down_modifier or
5599 the up_modifier set. */
5603 /* Get the symbol we should use for the mouse click. */
5606 head
= modify_event_symbol (button
,
5608 Qmouse_click
, Vlispy_mouse_stem
,
5611 XVECTOR (mouse_syms
)->size
);
5612 if (event
->modifiers
& drag_modifier
)
5617 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5620 Fcons (make_number (double_click_count
),
5631 Lisp_Object position
;
5634 /* Build the position as appropriate for this mouse click. */
5635 struct frame
*f
= XFRAME (event
->frame_or_window
);
5637 /* Ignore wheel events that were made on frame that have been
5639 if (! FRAME_LIVE_P (f
))
5642 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5645 /* Set double or triple modifiers to indicate the wheel speed. */
5647 /* On window-system frames, use the value of
5648 double-click-fuzz as is. On other frames, interpret it
5649 as a multiple of 1/8 characters. */
5654 if (WINDOWP (event
->frame_or_window
))
5655 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5656 else if (FRAMEP (event
->frame_or_window
))
5657 f
= XFRAME (event
->frame_or_window
);
5661 if (FRAME_WINDOW_P (f
))
5662 fuzz
= double_click_fuzz
;
5664 fuzz
= double_click_fuzz
/ 8;
5666 is_double
= (last_mouse_button
< 0
5667 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5668 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5669 && button_down_time
!= 0
5670 && (EQ (Vdouble_click_time
, Qt
)
5671 || (INTEGERP (Vdouble_click_time
)
5672 && ((int)(event
->timestamp
- button_down_time
)
5673 < XINT (Vdouble_click_time
)))));
5676 double_click_count
++;
5677 event
->modifiers
|= ((double_click_count
> 2)
5683 double_click_count
= 1;
5684 event
->modifiers
|= click_modifier
;
5687 button_down_time
= event
->timestamp
;
5688 /* Use a negative value to distinguish wheel from mouse button. */
5689 last_mouse_button
= -1;
5690 last_mouse_x
= XINT (event
->x
);
5691 last_mouse_y
= XINT (event
->y
);
5697 if (event
->modifiers
& up_modifier
)
5699 /* Emit a wheel-up event. */
5700 event
->modifiers
&= ~up_modifier
;
5703 else if (event
->modifiers
& down_modifier
)
5705 /* Emit a wheel-down event. */
5706 event
->modifiers
&= ~down_modifier
;
5710 /* Every wheel event should either have the down_modifier or
5711 the up_modifier set. */
5714 /* Get the symbol we should use for the wheel event. */
5715 head
= modify_event_symbol (symbol_num
,
5721 ASIZE (wheel_syms
));
5724 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5727 Fcons (make_number (double_click_count
),
5736 #ifdef USE_TOOLKIT_SCROLL_BARS
5738 /* We don't have down and up events if using toolkit scroll bars,
5739 so make this always a click event. Store in the `part' of
5740 the Lisp event a symbol which maps to the following actions:
5742 `above_handle' page up
5743 `below_handle' page down
5747 `bottom' bottom of buffer
5748 `handle' thumb has been dragged.
5749 `end-scroll' end of interaction with scroll bar
5751 The incoming input_event contains in its `part' member an
5752 index of type `enum scroll_bar_part' which we can use as an
5753 index in scroll_bar_parts to get the appropriate symbol. */
5755 case SCROLL_BAR_CLICK_EVENT
:
5757 Lisp_Object position
, head
, window
, portion_whole
, part
;
5759 window
= event
->frame_or_window
;
5760 portion_whole
= Fcons (event
->x
, event
->y
);
5761 part
= *scroll_bar_parts
[(int) event
->part
];
5765 Fcons (Qvertical_scroll_bar
,
5766 Fcons (portion_whole
,
5767 Fcons (make_number (event
->timestamp
),
5768 Fcons (part
, Qnil
)))));
5770 /* Always treat scroll bar events as clicks. */
5771 event
->modifiers
|= click_modifier
;
5772 event
->modifiers
&= ~up_modifier
;
5774 if (event
->code
>= ASIZE (mouse_syms
))
5775 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5777 /* Get the symbol we should use for the mouse click. */
5778 head
= modify_event_symbol (event
->code
,
5783 XVECTOR (mouse_syms
)->size
);
5784 return Fcons (head
, Fcons (position
, Qnil
));
5787 #endif /* USE_TOOLKIT_SCROLL_BARS */
5790 case W32_SCROLL_BAR_CLICK_EVENT
:
5792 int button
= event
->code
;
5794 Lisp_Object position
;
5795 Lisp_Object
*start_pos_ptr
;
5796 Lisp_Object start_pos
;
5800 Lisp_Object portion_whole
;
5803 window
= event
->frame_or_window
;
5804 portion_whole
= Fcons (event
->x
, event
->y
);
5805 part
= *scroll_bar_parts
[(int) event
->part
];
5809 Fcons (Qvertical_scroll_bar
,
5810 Fcons (portion_whole
,
5811 Fcons (make_number (event
->timestamp
),
5812 Fcons (part
, Qnil
)))));
5815 /* Always treat W32 scroll bar events as clicks. */
5816 event
->modifiers
|= click_modifier
;
5819 /* Get the symbol we should use for the mouse click. */
5822 head
= modify_event_symbol (button
,
5827 XVECTOR (mouse_syms
)->size
);
5833 #endif /* WINDOWSNT */
5835 case DRAG_N_DROP_EVENT
:
5838 Lisp_Object head
, position
;
5841 /* The frame_or_window field should be a cons of the frame in
5842 which the event occurred and a list of the filenames
5844 if (! CONSP (event
->frame_or_window
))
5847 f
= XFRAME (XCAR (event
->frame_or_window
));
5848 files
= XCDR (event
->frame_or_window
);
5850 /* Ignore mouse events that were made on frames that
5851 have been deleted. */
5852 if (! FRAME_LIVE_P (f
))
5855 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5858 head
= modify_event_symbol (0, event
->modifiers
,
5860 lispy_drag_n_drop_names
,
5861 &drag_n_drop_syms
, 1);
5867 #endif /* HAVE_MOUSE */
5869 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5870 || defined (USE_GTK)
5871 case MENU_BAR_EVENT
:
5872 if (EQ (event
->arg
, event
->frame_or_window
))
5873 /* This is the prefix key. We translate this to
5874 `(menu_bar)' because the code in keyboard.c for menu
5875 events, which we use, relies on this. */
5876 return Fcons (Qmenu_bar
, Qnil
);
5880 case SELECT_WINDOW_EVENT
:
5881 /* Make an event (select-window (WINDOW)). */
5882 return Fcons (Qselect_window
,
5883 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5886 case TOOL_BAR_EVENT
:
5887 if (EQ (event
->arg
, event
->frame_or_window
))
5888 /* This is the prefix key. We translate this to
5889 `(tool_bar)' because the code in keyboard.c for tool bar
5890 events, which we use, relies on this. */
5891 return Fcons (Qtool_bar
, Qnil
);
5892 else if (SYMBOLP (event
->arg
))
5893 return apply_modifiers (event
->modifiers
, event
->arg
);
5896 case USER_SIGNAL_EVENT
:
5897 /* A user signal. */
5898 return *lispy_user_signals
[event
->code
];
5900 case SAVE_SESSION_EVENT
:
5901 return Qsave_session
;
5903 /* The 'kind' field of the event is something we don't recognize. */
5912 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5914 Lisp_Object bar_window
;
5915 enum scroll_bar_part part
;
5919 /* Is it a scroll bar movement? */
5920 if (frame
&& ! NILP (bar_window
))
5922 Lisp_Object part_sym
;
5924 part_sym
= *scroll_bar_parts
[(int) part
];
5925 return Fcons (Qscroll_bar_movement
,
5926 (Fcons (Fcons (bar_window
,
5927 Fcons (Qvertical_scroll_bar
,
5928 Fcons (Fcons (x
, y
),
5929 Fcons (make_number (time
),
5935 /* Or is it an ordinary mouse movement? */
5938 Lisp_Object position
;
5940 position
= make_lispy_position (frame
, &x
, &y
, time
);
5942 return Fcons (Qmouse_movement
,
5948 #endif /* HAVE_MOUSE */
5950 /* Construct a switch frame event. */
5952 make_lispy_switch_frame (frame
)
5955 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5958 /* Manipulating modifiers. */
5960 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5962 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5963 SYMBOL's name of the end of the modifiers; the string from this
5964 position is the unmodified symbol name.
5966 This doesn't use any caches. */
5969 parse_modifiers_uncached (symbol
, modifier_end
)
5977 CHECK_SYMBOL (symbol
);
5980 name
= SYMBOL_NAME (symbol
);
5982 for (i
= 0; i
+2 <= SBYTES (name
); )
5984 int this_mod_end
= 0;
5987 /* See if the name continues with a modifier word.
5988 Check that the word appears, but don't check what follows it.
5989 Set this_mod and this_mod_end to record what we find. */
5991 switch (SREF (name
, i
))
5993 #define SINGLE_LETTER_MOD(BIT) \
5994 (this_mod_end = i + 1, this_mod = BIT)
5997 SINGLE_LETTER_MOD (alt_modifier
);
6001 SINGLE_LETTER_MOD (ctrl_modifier
);
6005 SINGLE_LETTER_MOD (hyper_modifier
);
6009 SINGLE_LETTER_MOD (meta_modifier
);
6013 SINGLE_LETTER_MOD (shift_modifier
);
6017 SINGLE_LETTER_MOD (super_modifier
);
6020 #undef SINGLE_LETTER_MOD
6022 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6023 if (i + LEN + 1 <= SBYTES (name) \
6024 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6026 this_mod_end = i + LEN; \
6031 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6032 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6033 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6037 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6039 #undef MULTI_LETTER_MOD
6043 /* If we found no modifier, stop looking for them. */
6044 if (this_mod_end
== 0)
6047 /* Check there is a dash after the modifier, so that it
6048 really is a modifier. */
6049 if (this_mod_end
>= SBYTES (name
)
6050 || SREF (name
, this_mod_end
) != '-')
6053 /* This modifier is real; look for another. */
6054 modifiers
|= this_mod
;
6055 i
= this_mod_end
+ 1;
6058 /* Should we include the `click' modifier? */
6059 if (! (modifiers
& (down_modifier
| drag_modifier
6060 | double_modifier
| triple_modifier
))
6061 && i
+ 7 == SBYTES (name
)
6062 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6063 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6064 modifiers
|= click_modifier
;
6072 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6073 prepended to the string BASE[0..BASE_LEN-1].
6074 This doesn't use any caches. */
6076 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6079 int base_len
, base_len_byte
;
6081 /* Since BASE could contain nulls, we can't use intern here; we have
6082 to use Fintern, which expects a genuine Lisp_String, and keeps a
6085 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6091 /* Only the event queue may use the `up' modifier; it should always
6092 be turned into a click or drag event before presented to lisp code. */
6093 if (modifiers
& up_modifier
)
6096 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6097 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6098 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6099 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6100 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6101 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6102 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6103 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6104 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6105 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6106 /* The click modifier is denoted by the absence of other modifiers. */
6110 mod_len
= p
- new_mods
;
6114 Lisp_Object new_name
;
6116 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6117 mod_len
+ base_len_byte
);
6118 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6119 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6121 return Fintern (new_name
, Qnil
);
6126 static char *modifier_names
[] =
6128 "up", "down", "drag", "click", "double", "triple", 0, 0,
6129 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6130 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6132 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6134 static Lisp_Object modifier_symbols
;
6136 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6138 lispy_modifier_list (modifiers
)
6141 Lisp_Object modifier_list
;
6144 modifier_list
= Qnil
;
6145 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6146 if (modifiers
& (1<<i
))
6147 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6150 return modifier_list
;
6154 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6155 where UNMODIFIED is the unmodified form of SYMBOL,
6156 MASK is the set of modifiers present in SYMBOL's name.
6157 This is similar to parse_modifiers_uncached, but uses the cache in
6158 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6159 Qevent_symbol_elements property. */
6162 parse_modifiers (symbol
)
6165 Lisp_Object elements
;
6167 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6168 if (CONSP (elements
))
6173 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6174 Lisp_Object unmodified
;
6177 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6178 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6181 if (modifiers
& ~INTMASK
)
6183 XSETFASTINT (mask
, modifiers
);
6184 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6186 /* Cache the parsing results on SYMBOL. */
6187 Fput (symbol
, Qevent_symbol_element_mask
,
6189 Fput (symbol
, Qevent_symbol_elements
,
6190 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6192 /* Since we know that SYMBOL is modifiers applied to unmodified,
6193 it would be nice to put that in unmodified's cache.
6194 But we can't, since we're not sure that parse_modifiers is
6201 /* Apply the modifiers MODIFIERS to the symbol BASE.
6202 BASE must be unmodified.
6204 This is like apply_modifiers_uncached, but uses BASE's
6205 Qmodifier_cache property, if present. It also builds
6206 Qevent_symbol_elements properties, since it has that info anyway.
6208 apply_modifiers copies the value of BASE's Qevent_kind property to
6209 the modified symbol. */
6211 apply_modifiers (modifiers
, base
)
6215 Lisp_Object cache
, index
, entry
, new_symbol
;
6217 /* Mask out upper bits. We don't know where this value's been. */
6218 modifiers
&= INTMASK
;
6220 /* The click modifier never figures into cache indices. */
6221 cache
= Fget (base
, Qmodifier_cache
);
6222 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6223 entry
= assq_no_quit (index
, cache
);
6226 new_symbol
= XCDR (entry
);
6229 /* We have to create the symbol ourselves. */
6230 new_symbol
= apply_modifiers_uncached (modifiers
,
6231 SDATA (SYMBOL_NAME (base
)),
6232 SCHARS (SYMBOL_NAME (base
)),
6233 SBYTES (SYMBOL_NAME (base
)));
6235 /* Add the new symbol to the base's cache. */
6236 entry
= Fcons (index
, new_symbol
);
6237 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6239 /* We have the parsing info now for free, so we could add it to
6241 XSETFASTINT (index, modifiers);
6242 Fput (new_symbol, Qevent_symbol_element_mask,
6243 Fcons (base, Fcons (index, Qnil)));
6244 Fput (new_symbol, Qevent_symbol_elements,
6245 Fcons (base, lispy_modifier_list (modifiers)));
6246 Sadly, this is only correct if `base' is indeed a base event,
6247 which is not necessarily the case. -stef */
6250 /* Make sure this symbol is of the same kind as BASE.
6252 You'd think we could just set this once and for all when we
6253 intern the symbol above, but reorder_modifiers may call us when
6254 BASE's property isn't set right; we can't assume that just
6255 because it has a Qmodifier_cache property it must have its
6256 Qevent_kind set right as well. */
6257 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6261 kind
= Fget (base
, Qevent_kind
);
6263 Fput (new_symbol
, Qevent_kind
, kind
);
6270 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6271 return a symbol with the modifiers placed in the canonical order.
6272 Canonical order is alphabetical, except for down and drag, which
6273 always come last. The 'click' modifier is never written out.
6275 Fdefine_key calls this to make sure that (for example) C-M-foo
6276 and M-C-foo end up being equivalent in the keymap. */
6279 reorder_modifiers (symbol
)
6282 /* It's hopefully okay to write the code this way, since everything
6283 will soon be in caches, and no consing will be done at all. */
6286 parsed
= parse_modifiers (symbol
);
6287 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6292 /* For handling events, we often want to produce a symbol whose name
6293 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6294 to some base, like the name of a function key or mouse button.
6295 modify_event_symbol produces symbols of this sort.
6297 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6298 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6301 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6302 into symbol names, or a string specifying a name stem used to
6303 construct a symbol name or the form `STEM-N', where N is the decimal
6304 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6305 non-nil; otherwise NAME_TABLE is used.
6307 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6308 persist between calls to modify_event_symbol that it can use to
6309 store a cache of the symbols it's generated for this NAME_TABLE
6310 before. The object stored there may be a vector or an alist.
6312 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6314 MODIFIERS is a set of modifier bits (as given in struct input_events)
6315 whose prefixes should be applied to the symbol name.
6317 SYMBOL_KIND is the value to be placed in the event_kind property of
6318 the returned symbol.
6320 The symbols we create are supposed to have an
6321 `event-symbol-elements' property, which lists the modifiers present
6322 in the symbol's name. */
6325 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6326 name_table
, symbol_table
, table_size
)
6329 Lisp_Object symbol_kind
;
6330 Lisp_Object name_alist_or_stem
;
6332 Lisp_Object
*symbol_table
;
6333 unsigned int table_size
;
6336 Lisp_Object symbol_int
;
6338 /* Get rid of the "vendor-specific" bit here. */
6339 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6341 /* Is this a request for a valid symbol? */
6342 if (symbol_num
< 0 || symbol_num
>= table_size
)
6345 if (CONSP (*symbol_table
))
6346 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6348 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6349 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6350 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6351 we've never used that symbol before. */
6354 if (! VECTORP (*symbol_table
)
6355 || XVECTOR (*symbol_table
)->size
!= table_size
)
6359 XSETFASTINT (size
, table_size
);
6360 *symbol_table
= Fmake_vector (size
, Qnil
);
6363 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6366 /* Have we already used this symbol before? */
6369 /* No; let's create it. */
6370 if (CONSP (name_alist_or_stem
))
6371 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6372 else if (STRINGP (name_alist_or_stem
))
6374 int len
= SBYTES (name_alist_or_stem
);
6375 char *buf
= (char *) alloca (len
+ 50);
6376 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6377 (long) XINT (symbol_int
) + 1);
6378 value
= intern (buf
);
6380 else if (name_table
!= 0 && name_table
[symbol_num
])
6381 value
= intern (name_table
[symbol_num
]);
6383 #ifdef HAVE_WINDOW_SYSTEM
6386 char *name
= x_get_keysym_name (symbol_num
);
6388 value
= intern (name
);
6395 sprintf (buf
, "key-%d", symbol_num
);
6396 value
= intern (buf
);
6399 if (CONSP (*symbol_table
))
6400 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6402 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6404 /* Fill in the cache entries for this symbol; this also
6405 builds the Qevent_symbol_elements property, which the user
6407 apply_modifiers (modifiers
& click_modifier
, value
);
6408 Fput (value
, Qevent_kind
, symbol_kind
);
6411 /* Apply modifiers to that symbol. */
6412 return apply_modifiers (modifiers
, value
);
6415 /* Convert a list that represents an event type,
6416 such as (ctrl meta backspace), into the usual representation of that
6417 event type as a number or a symbol. */
6419 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6420 doc
: /* Convert the event description list EVENT-DESC to an event type.
6421 EVENT-DESC should contain one base event type (a character or symbol)
6422 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6423 drag, down, double or triple). The base must be last.
6424 The return value is an event type (a character or symbol) which
6425 has the same base event type and all the specified modifiers. */)
6427 Lisp_Object event_desc
;
6435 while (CONSP (rest
))
6443 /* Given a symbol, see if it is a modifier name. */
6444 if (SYMBOLP (elt
) && CONSP (rest
))
6445 this = parse_solitary_modifier (elt
);
6449 else if (!NILP (base
))
6450 error ("Two bases given in one event");
6456 /* Let the symbol A refer to the character A. */
6457 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6458 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6460 if (INTEGERP (base
))
6462 /* Turn (shift a) into A. */
6463 if ((modifiers
& shift_modifier
) != 0
6464 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6466 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6467 modifiers
&= ~shift_modifier
;
6470 /* Turn (control a) into C-a. */
6471 if (modifiers
& ctrl_modifier
)
6472 return make_number ((modifiers
& ~ctrl_modifier
)
6473 | make_ctrl_char (XINT (base
)));
6475 return make_number (modifiers
| XINT (base
));
6477 else if (SYMBOLP (base
))
6478 return apply_modifiers (modifiers
, base
);
6481 error ("Invalid base event");
6486 /* Try to recognize SYMBOL as a modifier name.
6487 Return the modifier flag bit, or 0 if not recognized. */
6490 parse_solitary_modifier (symbol
)
6493 Lisp_Object name
= SYMBOL_NAME (symbol
);
6495 switch (SREF (name
, 0))
6497 #define SINGLE_LETTER_MOD(BIT) \
6498 if (SBYTES (name) == 1) \
6501 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6502 if (LEN == SBYTES (name) \
6503 && ! strncmp (SDATA (name), NAME, LEN)) \
6507 SINGLE_LETTER_MOD (alt_modifier
);
6511 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6515 SINGLE_LETTER_MOD (ctrl_modifier
);
6519 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6520 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6524 SINGLE_LETTER_MOD (hyper_modifier
);
6528 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6532 SINGLE_LETTER_MOD (meta_modifier
);
6536 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6540 SINGLE_LETTER_MOD (shift_modifier
);
6544 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6545 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6546 SINGLE_LETTER_MOD (super_modifier
);
6550 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6551 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6552 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6556 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6559 #undef SINGLE_LETTER_MOD
6560 #undef MULTI_LETTER_MOD
6566 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6567 Such a list is not valid as an event,
6568 but it can be a Lucid-style event type list. */
6571 lucid_event_type_list_p (object
)
6576 if (! CONSP (object
))
6579 if (EQ (XCAR (object
), Qhelp_echo
)
6580 || EQ (XCAR (object
), Qvertical_line
)
6581 || EQ (XCAR (object
), Qmode_line
)
6582 || EQ (XCAR (object
), Qheader_line
))
6585 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6589 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6596 /* Store into *addr a value nonzero if terminal input chars are available.
6597 Serves the purpose of ioctl (0, FIONREAD, addr)
6598 but works even if FIONREAD does not exist.
6599 (In fact, this may actually read some input.)
6601 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6602 timer events that are ripe.
6603 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6604 events (FOCUS_IN_EVENT).
6605 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6606 movements and toolkit scroll bar thumb drags. */
6609 get_input_pending (addr
, flags
)
6613 /* First of all, have we already counted some input? */
6614 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6616 /* If input is being read as it arrives, and we have none, there is none. */
6617 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6620 /* Try to read some input and see how much we get. */
6622 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6625 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6628 gobble_input (expected
)
6633 if (interrupt_input
)
6636 mask
= sigblock (sigmask (SIGIO
));
6637 read_avail_input (expected
);
6641 #ifdef POLL_FOR_INPUT
6642 /* XXX This condition was (read_socket_hook && !interrupt_input),
6643 but read_socket_hook is not global anymore. Let's pretend that
6645 if (!interrupt_input
&& poll_suppress_count
== 0)
6648 mask
= sigblock (sigmask (SIGALRM
));
6649 read_avail_input (expected
);
6655 read_avail_input (expected
);
6659 /* Put a BUFFER_SWITCH_EVENT in the buffer
6660 so that read_key_sequence will notice the new current buffer. */
6663 record_asynch_buffer_change ()
6665 struct input_event event
;
6669 event
.kind
= BUFFER_SWITCH_EVENT
;
6670 event
.frame_or_window
= Qnil
;
6674 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6675 The purpose of the event is to make read_key_sequence look up the
6676 keymaps again. If we aren't in read_key_sequence, we don't need one,
6677 and the event could cause trouble by messing up (input-pending-p). */
6678 tem
= Fwaiting_for_user_input_p ();
6682 /* We never need these events if we have no asynchronous subprocesses. */
6686 /* Make sure no interrupt happens while storing the event. */
6688 if (interrupt_input
)
6691 mask
= sigblock (sigmask (SIGIO
));
6692 kbd_buffer_store_event (&event
);
6699 kbd_buffer_store_event (&event
);
6706 /* Read any terminal input already buffered up by the system
6707 into the kbd_buffer, but do not wait.
6709 EXPECTED should be nonzero if the caller knows there is some input.
6711 Except on VMS, all input is read by this function.
6712 If interrupt_input is nonzero, this function MUST be called
6713 only when SIGIO is blocked.
6715 Returns the number of keyboard chars read, or -1 meaning
6716 this is a bad time to try to read input. */
6719 read_avail_input (expected
)
6726 /* Loop through the available devices, and call their input hooks. */
6730 struct device
*next
= d
->next_device
;
6732 if (d
->read_socket_hook
)
6735 struct input_event hold_quit
;
6737 EVENT_INIT (hold_quit
);
6738 hold_quit
.kind
= NO_EVENT
;
6740 /* No need for FIONREAD or fcntl; just say don't wait. */
6741 while (nr
= (*d
->read_socket_hook
) (d
, expected
, &hold_quit
), nr
> 0)
6747 if (nr
== -1) /* Not OK to read input now. */
6751 else if (nr
== -2) /* Non-transient error. */
6753 /* The display device terminated; it should be closed. */
6755 /* Kill Emacs if this was our last display. */
6756 if (! device_list
->next_device
)
6757 /* Formerly simply reported no input, but that
6758 sometimes led to a failure of Emacs to terminate.
6759 SIGHUP seems appropriate if we can't reach the
6761 /* ??? Is it really right to send the signal just to
6762 this process rather than to the whole process
6763 group? Perhaps on systems with FIONREAD Emacs is
6764 alone in its group. */
6765 kill (getpid (), SIGHUP
);
6767 /* XXX Is calling delete_device safe here? It calls Fdelete_frame. */
6768 if (d
->delete_device_hook
)
6769 (*d
->delete_device_hook
) (d
);
6774 if (hold_quit
.kind
!= NO_EVENT
)
6775 kbd_buffer_store_event (&hold_quit
);
6787 /* This is the tty way of reading available input.
6789 Note that each terminal device has its own `struct device' object,
6790 and so this function is called once for each individual termcap
6791 display. The first parameter indicates which device to read from. */
6794 tty_read_avail_input (struct device
*device
,
6796 struct input_event
*hold_quit
)
6798 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6799 the kbd_buffer can really hold. That may prevent loss
6800 of characters on some systems when input is stuffed at us. */
6801 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6803 struct tty_display_info
*tty
= device
->display_info
.tty
;
6806 if (device
->type
!= output_termcap
)
6809 /* XXX I think the following code should be moved to separate hook
6810 functions in system-dependent files. */
6813 #else /* not WINDOWSNT */
6815 n_to_read
= dos_keysns ();
6819 cbuf
[0] = dos_keyread ();
6822 #else /* not MSDOS */
6824 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6828 return 0; /* The terminal is suspended. */
6830 /* Determine how many characters we should *try* to read. */
6832 /* Find out how much input is available. */
6833 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6835 if (! noninteractive
)
6836 return -2; /* Close this device. */
6842 if (n_to_read
> sizeof cbuf
)
6843 n_to_read
= sizeof cbuf
;
6844 #else /* no FIONREAD */
6845 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6846 /* Read some input if available, but don't wait. */
6847 n_to_read
= sizeof cbuf
;
6848 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6854 /* Now read; for one reason or another, this will not block.
6855 NREAD is set to the number of chars read. */
6858 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6859 /* POSIX infers that processes which are not in the session leader's
6860 process group won't get SIGHUP's at logout time. BSDI adheres to
6861 this part standard and returns -1 from read (0) with errno==EIO
6862 when the control tty is taken away.
6863 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6864 if (nread
== -1 && errno
== EIO
)
6865 return -2; /* Close this device. */
6866 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6867 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6868 This looks incorrect, but it isn't, because _BSD causes
6869 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6870 and that causes a value other than 0 when there is no input. */
6872 return -2; /* Close this device. */
6876 /* We used to retry the read if it was interrupted.
6877 But this does the wrong thing when O_NDELAY causes
6878 an EAGAIN error. Does anybody know of a situation
6879 where a retry is actually needed? */
6881 nread
< 0 && (errno
== EAGAIN
6895 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6896 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6897 #endif /* USG or DGUX or CYGWIN */
6898 #endif /* no FIONREAD */
6903 #endif /* not MSDOS */
6904 #endif /* not WINDOWSNT */
6906 for (i
= 0; i
< nread
; i
++)
6908 struct input_event buf
;
6910 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6912 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6913 buf
.modifiers
= meta_modifier
;
6914 if (tty
->meta_key
!= 2)
6918 /* Set the frame corresponding to the active tty. Note that the
6919 value of selected_frame is not reliable here, redisplay tends
6920 to temporarily change it. */
6921 buf
.frame_or_window
= tty
->top_frame
;
6924 kbd_buffer_store_event (&buf
);
6925 /* Don't look at input that follows a C-g too closely.
6926 This reduces lossage due to autorepeat on C-g. */
6927 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6928 && buf
.code
== quit_char
)
6934 #endif /* not VMS */
6937 handle_async_input ()
6940 extern int select_alarmed
;
6943 interrupt_input_pending
= 0;
6948 nread
= read_avail_input (1);
6949 /* -1 means it's not ok to read the input now.
6950 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6951 0 means there was no keyboard input available. */
6956 select_alarmed
= 1; /* Force the select emulator back to life */
6961 #ifdef SIGIO /* for entire page */
6962 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6965 input_available_signal (signo
)
6968 /* Must preserve main program's value of errno. */
6969 int old_errno
= errno
;
6970 #if defined (USG) && !defined (POSIX_SIGNALS)
6971 /* USG systems forget handlers when they are used;
6972 must reestablish each time */
6973 signal (signo
, input_available_signal
);
6981 interrupt_input_pending
= 1;
6983 SIGNAL_THREAD_CHECK (signo
);
6986 if (input_available_clear_time
)
6987 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6990 handle_async_input ();
7000 /* Send ourselves a SIGIO.
7002 This function exists so that the UNBLOCK_INPUT macro in
7003 blockinput.h can have some way to take care of input we put off
7004 dealing with, without assuming that every file which uses
7005 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7007 reinvoke_input_signal ()
7010 handle_async_input ();
7016 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7017 static Lisp_Object menu_bar_one_keymap_changed_items
;
7019 /* These variables hold the vector under construction within
7020 menu_bar_items and its subroutines, and the current index
7021 for storing into that vector. */
7022 static Lisp_Object menu_bar_items_vector
;
7023 static int menu_bar_items_index
;
7025 /* Return a vector of menu items for a menu bar, appropriate
7026 to the current buffer. Each item has three elements in the vector:
7029 OLD is an old vector we can optionally reuse, or nil. */
7032 menu_bar_items (old
)
7035 /* The number of keymaps we're scanning right now, and the number of
7036 keymaps we have allocated space for. */
7039 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7040 in the current keymaps, or nil where it is not a prefix. */
7043 Lisp_Object def
, tail
;
7052 /* In order to build the menus, we need to call the keymap
7053 accessors. They all call QUIT. But this function is called
7054 during redisplay, during which a quit is fatal. So inhibit
7055 quitting while building the menus.
7056 We do this instead of specbind because (1) errors will clear it anyway
7057 and (2) this avoids risk of specpdl overflow. */
7058 oquit
= Vinhibit_quit
;
7062 menu_bar_items_vector
= old
;
7064 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7065 menu_bar_items_index
= 0;
7067 /* Build our list of keymaps.
7068 If we recognize a function key and replace its escape sequence in
7069 keybuf with its symbol, or if the sequence starts with a mouse
7070 click and we need to switch buffers, we jump back here to rebuild
7071 the initial keymaps from the current buffer. */
7075 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7076 if (!NILP (Voverriding_local_map_menu_flag
))
7078 /* Yes, use them (if non-nil) as well as the global map. */
7079 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7081 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7082 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7083 if (!NILP (Voverriding_local_map
))
7084 maps
[nmaps
++] = Voverriding_local_map
;
7088 /* No, so use major and minor mode keymaps and keymap property.
7089 Note that menu-bar bindings in the local-map and keymap
7090 properties may not work reliable, as they are only
7091 recognized when the menu-bar (or mode-line) is updated,
7092 which does not normally happen after every command. */
7095 nminor
= current_minor_maps (NULL
, &tmaps
);
7096 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7098 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7099 maps
[nmaps
++] = tem
;
7100 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7102 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7104 maps
[nmaps
++] = current_global_map
;
7107 /* Look up in each map the dummy prefix key `menu-bar'. */
7111 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7112 if (!NILP (maps
[mapno
]))
7114 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7118 menu_bar_one_keymap_changed_items
= Qnil
;
7119 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7123 /* Move to the end those items that should be at the end. */
7125 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7128 int end
= menu_bar_items_index
;
7130 for (i
= 0; i
< end
; i
+= 4)
7131 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7133 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7134 /* Move the item at index I to the end,
7135 shifting all the others forward. */
7136 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7137 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7138 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7139 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7141 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7142 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7143 (end
- i
- 4) * sizeof (Lisp_Object
));
7144 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7145 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7146 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7147 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7152 /* Add nil, nil, nil, nil at the end. */
7153 i
= menu_bar_items_index
;
7154 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7157 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7158 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7159 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7160 menu_bar_items_vector
= tem
;
7162 /* Add this item. */
7163 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7164 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7165 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7166 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7167 menu_bar_items_index
= i
;
7169 Vinhibit_quit
= oquit
;
7170 return menu_bar_items_vector
;
7173 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7174 If there's already an item for KEY, add this DEF to it. */
7176 Lisp_Object item_properties
;
7179 menu_bar_item (key
, item
, dummy1
, dummy2
)
7180 Lisp_Object key
, item
, dummy1
;
7183 struct gcpro gcpro1
;
7187 if (EQ (item
, Qundefined
))
7189 /* If a map has an explicit `undefined' as definition,
7190 discard any previously made menu bar item. */
7192 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7193 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7195 if (menu_bar_items_index
> i
+ 4)
7196 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7197 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7198 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7199 menu_bar_items_index
-= 4;
7203 /* If this keymap has already contributed to this KEY,
7204 don't contribute to it a second time. */
7205 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7206 if (!NILP (tem
) || NILP (item
))
7209 menu_bar_one_keymap_changed_items
7210 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7212 /* We add to menu_bar_one_keymap_changed_items before doing the
7213 parse_menu_item, so that if it turns out it wasn't a menu item,
7214 it still correctly hides any further menu item. */
7216 i
= parse_menu_item (item
, 0, 1);
7221 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7223 /* Find any existing item for this KEY. */
7224 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7225 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7228 /* If we did not find this KEY, add it at the end. */
7229 if (i
== menu_bar_items_index
)
7231 /* If vector is too small, get a bigger one. */
7232 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7235 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7236 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7237 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7238 menu_bar_items_vector
= tem
;
7241 /* Add this item. */
7242 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7243 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7244 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7245 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7246 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7247 menu_bar_items_index
= i
;
7249 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7253 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7254 /* If the new and the old items are not both keymaps,
7255 the lookup will only find `item'. */
7256 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7257 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7261 /* This is used as the handler when calling menu_item_eval_property. */
7263 menu_item_eval_property_1 (arg
)
7266 /* If we got a quit from within the menu computation,
7267 quit all the way out of it. This takes care of C-] in the debugger. */
7268 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7269 Fsignal (Qquit
, Qnil
);
7274 /* Evaluate an expression and return the result (or nil if something
7275 went wrong). Used to evaluate dynamic parts of menu items. */
7277 menu_item_eval_property (sexpr
)
7280 int count
= SPECPDL_INDEX ();
7282 specbind (Qinhibit_redisplay
, Qt
);
7283 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7284 menu_item_eval_property_1
);
7285 return unbind_to (count
, val
);
7288 /* This function parses a menu item and leaves the result in the
7289 vector item_properties.
7290 ITEM is a key binding, a possible menu item.
7291 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7292 evaluate dynamic expressions in the menu item.
7293 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7295 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7296 parse_menu_item returns true if the item is a menu item and false
7300 parse_menu_item (item
, notreal
, inmenubar
)
7302 int notreal
, inmenubar
;
7304 Lisp_Object def
, tem
, item_string
, start
;
7305 Lisp_Object cachelist
;
7307 Lisp_Object keyhint
;
7318 /* Create item_properties vector if necessary. */
7319 if (NILP (item_properties
))
7321 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7323 /* Initialize optional entries. */
7324 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7325 AREF (item_properties
, i
) = Qnil
;
7326 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7328 /* Save the item here to protect it from GC. */
7329 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7331 item_string
= XCAR (item
);
7335 if (STRINGP (item_string
))
7337 /* Old format menu item. */
7338 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7340 /* Maybe help string. */
7341 if (CONSP (item
) && STRINGP (XCAR (item
)))
7343 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7348 /* Maybe key binding cache. */
7349 if (CONSP (item
) && CONSP (XCAR (item
))
7350 && (NILP (XCAR (XCAR (item
)))
7351 || VECTORP (XCAR (XCAR (item
)))))
7353 cachelist
= XCAR (item
);
7357 /* This is the real definition--the function to run. */
7358 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7360 /* Get enable property, if any. */
7363 tem
= Fget (item
, Qmenu_enable
);
7365 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7368 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7370 /* New format menu item. */
7371 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7372 start
= XCDR (item
);
7375 /* We have a real binding. */
7376 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7378 item
= XCDR (start
);
7379 /* Is there a cache list with key equivalences. */
7380 if (CONSP (item
) && CONSP (XCAR (item
)))
7382 cachelist
= XCAR (item
);
7386 /* Parse properties. */
7387 while (CONSP (item
) && CONSP (XCDR (item
)))
7392 if (EQ (tem
, QCenable
))
7393 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7394 else if (EQ (tem
, QCvisible
) && !notreal
)
7396 /* If got a visible property and that evaluates to nil
7397 then ignore this item. */
7398 tem
= menu_item_eval_property (XCAR (item
));
7402 else if (EQ (tem
, QChelp
))
7403 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7404 else if (EQ (tem
, QCfilter
))
7406 else if (EQ (tem
, QCkey_sequence
))
7409 if (NILP (cachelist
)
7410 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7411 /* Be GC protected. Set keyhint to item instead of tem. */
7414 else if (EQ (tem
, QCkeys
))
7417 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7418 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7420 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7425 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7427 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7429 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7436 else if (inmenubar
|| !NILP (start
))
7440 return 0; /* not a menu item */
7442 /* If item string is not a string, evaluate it to get string.
7443 If we don't get a string, skip this item. */
7444 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7445 if (!(STRINGP (item_string
) || notreal
))
7447 item_string
= menu_item_eval_property (item_string
);
7448 if (!STRINGP (item_string
))
7450 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7453 /* If got a filter apply it on definition. */
7454 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7457 def
= menu_item_eval_property (list2 (XCAR (filter
),
7458 list2 (Qquote
, def
)));
7460 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7463 /* Enable or disable selection of item. */
7464 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7470 tem
= menu_item_eval_property (tem
);
7471 if (inmenubar
&& NILP (tem
))
7472 return 0; /* Ignore disabled items in menu bar. */
7473 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7476 /* If we got no definition, this item is just unselectable text which
7477 is OK in a submenu but not in the menubar. */
7479 return (inmenubar
? 0 : 1);
7481 /* See if this is a separate pane or a submenu. */
7482 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7483 tem
= get_keymap (def
, 0, 1);
7484 /* For a subkeymap, just record its details and exit. */
7487 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7488 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7492 /* At the top level in the menu bar, do likewise for commands also.
7493 The menu bar does not display equivalent key bindings anyway.
7494 ITEM_PROPERTY_DEF is already set up properly. */
7498 /* This is a command. See if there is an equivalent key binding. */
7499 if (NILP (cachelist
))
7501 /* We have to create a cachelist. */
7502 CHECK_IMPURE (start
);
7503 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7504 cachelist
= XCAR (XCDR (start
));
7506 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7507 if (!NILP (keyhint
))
7509 XSETCAR (cachelist
, XCAR (keyhint
));
7512 else if (STRINGP (tem
))
7514 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7515 XSETCAR (cachelist
, Qt
);
7519 tem
= XCAR (cachelist
);
7526 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7528 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7531 def
= XCAR (prefix
);
7532 prefix
= XCDR (prefix
);
7535 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7537 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7539 if (newcache
/* Always check first time. */
7540 /* Should we check everything when precomputing key
7542 /* If something had no key binding before, don't recheck it
7543 because that is too slow--except if we have a list of
7544 rebound commands in Vdefine_key_rebound_commands, do
7545 recheck any command that appears in that list. */
7546 || (CONSP (Vdefine_key_rebound_commands
)
7547 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7550 /* We had a saved key. Is it still bound to the command? */
7553 /* If the command is an alias for another
7554 (such as lmenu.el set it up), check if the
7555 original command matches the cached command. */
7556 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7557 chkcache
= 1; /* Need to recompute key binding. */
7561 /* Recompute equivalent key binding. If the command is an alias
7562 for another (such as lmenu.el set it up), see if the original
7563 command name has equivalent keys. Otherwise look up the
7564 specified command itself. We don't try both, because that
7565 makes lmenu menus slow. */
7567 && SYMBOLP (XSYMBOL (def
)->function
)
7568 && ! NILP (Fget (def
, Qmenu_alias
)))
7569 def
= XSYMBOL (def
)->function
;
7570 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7571 XSETCAR (cachelist
, tem
);
7574 XSETCDR (cachelist
, Qnil
);
7578 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7580 tem
= XCAR (cachelist
);
7584 newcache
= chkcache
;
7587 tem
= Fkey_description (tem
, Qnil
);
7590 if (STRINGP (XCAR (prefix
)))
7591 tem
= concat2 (XCAR (prefix
), tem
);
7592 if (STRINGP (XCDR (prefix
)))
7593 tem
= concat2 (tem
, XCDR (prefix
));
7595 XSETCDR (cachelist
, tem
);
7599 tem
= XCDR (cachelist
);
7600 if (newcache
&& !NILP (tem
))
7602 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7603 XSETCDR (cachelist
, tem
);
7606 /* If we only want to precompute equivalent key bindings, stop here. */
7610 /* If we have an equivalent key binding, use that. */
7611 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7613 /* Include this when menu help is implemented.
7614 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7615 if (!(NILP (tem) || STRINGP (tem)))
7617 tem = menu_item_eval_property (tem);
7620 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7624 /* Handle radio buttons or toggle boxes. */
7625 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7627 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7628 = menu_item_eval_property (tem
);
7635 /***********************************************************************
7637 ***********************************************************************/
7639 /* A vector holding tool bar items while they are parsed in function
7640 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7643 static Lisp_Object tool_bar_items_vector
;
7645 /* A vector holding the result of parse_tool_bar_item. Layout is like
7646 the one for a single item in tool_bar_items_vector. */
7648 static Lisp_Object tool_bar_item_properties
;
7650 /* Next free index in tool_bar_items_vector. */
7652 static int ntool_bar_items
;
7654 /* The symbols `tool-bar', and `:image'. */
7656 extern Lisp_Object Qtool_bar
;
7657 Lisp_Object QCimage
;
7659 /* Function prototypes. */
7661 static void init_tool_bar_items
P_ ((Lisp_Object
));
7662 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7663 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7664 static void append_tool_bar_item
P_ ((void));
7667 /* Return a vector of tool bar items for keymaps currently in effect.
7668 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7669 tool bar items found. */
7672 tool_bar_items (reuse
, nitems
)
7683 /* In order to build the menus, we need to call the keymap
7684 accessors. They all call QUIT. But this function is called
7685 during redisplay, during which a quit is fatal. So inhibit
7686 quitting while building the menus. We do this instead of
7687 specbind because (1) errors will clear it anyway and (2) this
7688 avoids risk of specpdl overflow. */
7689 oquit
= Vinhibit_quit
;
7692 /* Initialize tool_bar_items_vector and protect it from GC. */
7693 init_tool_bar_items (reuse
);
7695 /* Build list of keymaps in maps. Set nmaps to the number of maps
7698 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7699 if (!NILP (Voverriding_local_map_menu_flag
))
7701 /* Yes, use them (if non-nil) as well as the global map. */
7702 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7704 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7705 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7706 if (!NILP (Voverriding_local_map
))
7707 maps
[nmaps
++] = Voverriding_local_map
;
7711 /* No, so use major and minor mode keymaps and keymap property.
7712 Note that tool-bar bindings in the local-map and keymap
7713 properties may not work reliable, as they are only
7714 recognized when the tool-bar (or mode-line) is updated,
7715 which does not normally happen after every command. */
7718 nminor
= current_minor_maps (NULL
, &tmaps
);
7719 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7721 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7722 maps
[nmaps
++] = tem
;
7723 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7725 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7728 /* Add global keymap at the end. */
7729 maps
[nmaps
++] = current_global_map
;
7731 /* Process maps in reverse order and look up in each map the prefix
7733 for (i
= nmaps
- 1; i
>= 0; --i
)
7734 if (!NILP (maps
[i
]))
7738 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7743 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7744 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7746 Lisp_Object keydef
= XCAR (tail
);
7748 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7753 Vinhibit_quit
= oquit
;
7754 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7755 return tool_bar_items_vector
;
7759 /* Process the definition of KEY which is DEF. */
7762 process_tool_bar_item (key
, def
)
7763 Lisp_Object key
, def
;
7766 extern Lisp_Object Qundefined
;
7767 struct gcpro gcpro1
, gcpro2
;
7769 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7773 if (EQ (def
, Qundefined
))
7775 /* If a map has an explicit `undefined' as definition,
7776 discard any previously made item. */
7777 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7779 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7781 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7783 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7784 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7785 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7786 * sizeof (Lisp_Object
)));
7787 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7792 else if (parse_tool_bar_item (key
, def
))
7793 /* Append a new tool bar item to tool_bar_items_vector. Accept
7794 more than one definition for the same key. */
7795 append_tool_bar_item ();
7801 /* Parse a tool bar item specification ITEM for key KEY and return the
7802 result in tool_bar_item_properties. Value is zero if ITEM is
7805 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7807 CAPTION is the caption of the item, If it's not a string, it is
7808 evaluated to get a string.
7810 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7811 as binding are currently ignored.
7813 The following properties are recognized:
7817 FORM is evaluated and specifies whether the tool bar item is
7818 enabled or disabled.
7822 FORM is evaluated and specifies whether the tool bar item is visible.
7824 - `:filter FUNCTION'
7826 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7827 result is stored as the new binding.
7829 - `:button (TYPE SELECTED)'
7831 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7832 and specifies whether the button is selected (pressed) or not.
7836 IMAGES is either a single image specification or a vector of four
7837 image specifications. See enum tool_bar_item_images.
7839 - `:help HELP-STRING'.
7841 Gives a help string to display for the tool bar item. */
7844 parse_tool_bar_item (key
, item
)
7845 Lisp_Object key
, item
;
7847 /* Access slot with index IDX of vector tool_bar_item_properties. */
7848 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7850 Lisp_Object filter
= Qnil
;
7851 Lisp_Object caption
;
7854 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7855 Rule out items that aren't lists, don't start with
7856 `menu-item' or whose rest following `tool-bar-item' is not a
7859 || !EQ (XCAR (item
), Qmenu_item
)
7860 || (item
= XCDR (item
),
7864 /* Create tool_bar_item_properties vector if necessary. Reset it to
7866 if (VECTORP (tool_bar_item_properties
))
7868 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7872 tool_bar_item_properties
7873 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7876 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7877 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7879 /* Get the caption of the item. If the caption is not a string,
7880 evaluate it to get a string. If we don't get a string, skip this
7882 caption
= XCAR (item
);
7883 if (!STRINGP (caption
))
7885 caption
= menu_item_eval_property (caption
);
7886 if (!STRINGP (caption
))
7889 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7891 /* Give up if rest following the caption is not a list. */
7896 /* Store the binding. */
7897 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7900 /* Ignore cached key binding, if any. */
7901 if (CONSP (item
) && CONSP (XCAR (item
)))
7904 /* Process the rest of the properties. */
7905 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7907 Lisp_Object key
, value
;
7910 value
= XCAR (XCDR (item
));
7912 if (EQ (key
, QCenable
))
7913 /* `:enable FORM'. */
7914 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7915 else if (EQ (key
, QCvisible
))
7917 /* `:visible FORM'. If got a visible property and that
7918 evaluates to nil then ignore this item. */
7919 if (NILP (menu_item_eval_property (value
)))
7922 else if (EQ (key
, QChelp
))
7923 /* `:help HELP-STRING'. */
7924 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7925 else if (EQ (key
, QCfilter
))
7926 /* ':filter FORM'. */
7928 else if (EQ (key
, QCbutton
) && CONSP (value
))
7930 /* `:button (TYPE . SELECTED)'. */
7931 Lisp_Object type
, selected
;
7933 type
= XCAR (value
);
7934 selected
= XCDR (value
);
7935 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7937 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7938 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7941 else if (EQ (key
, QCimage
)
7943 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7944 /* Value is either a single image specification or a vector
7945 of 4 such specifications for the different button states. */
7946 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7949 /* If got a filter apply it on binding. */
7951 PROP (TOOL_BAR_ITEM_BINDING
)
7952 = menu_item_eval_property (list2 (filter
,
7954 PROP (TOOL_BAR_ITEM_BINDING
))));
7956 /* See if the binding is a keymap. Give up if it is. */
7957 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7960 /* Enable or disable selection of item. */
7961 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7962 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7963 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7965 /* Handle radio buttons or toggle boxes. */
7966 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7967 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7968 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7976 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7977 that can be reused. */
7980 init_tool_bar_items (reuse
)
7983 if (VECTORP (reuse
))
7984 tool_bar_items_vector
= reuse
;
7986 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7987 ntool_bar_items
= 0;
7991 /* Append parsed tool bar item properties from
7992 tool_bar_item_properties */
7995 append_tool_bar_item ()
7997 Lisp_Object
*to
, *from
;
7999 /* Enlarge tool_bar_items_vector if necessary. */
8000 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8001 >= XVECTOR (tool_bar_items_vector
)->size
)
8003 Lisp_Object new_vector
;
8004 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
8006 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
8007 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
8008 XVECTOR (new_vector
)->contents
,
8009 old_size
* sizeof (Lisp_Object
));
8010 tool_bar_items_vector
= new_vector
;
8013 /* Append entries from tool_bar_item_properties to the end of
8014 tool_bar_items_vector. */
8015 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8016 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8017 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8018 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8025 /* Read a character using menus based on maps in the array MAPS.
8026 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8027 Return t if we displayed a menu but the user rejected it.
8029 PREV_EVENT is the previous input event, or nil if we are reading
8030 the first event of a key sequence.
8032 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8033 if we used a mouse menu to read the input, or zero otherwise. If
8034 USED_MOUSE_MENU is null, we don't dereference it.
8036 The prompting is done based on the prompt-string of the map
8037 and the strings associated with various map elements.
8039 This can be done with X menus or with menus put in the minibuf.
8040 These are done in different ways, depending on how the input will be read.
8041 Menus using X are done after auto-saving in read-char, getting the input
8042 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8043 and do auto-saving in the inner call of read_char. */
8046 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8049 Lisp_Object prev_event
;
8050 int *used_mouse_menu
;
8053 register Lisp_Object name
= Qnil
;
8055 if (used_mouse_menu
)
8056 *used_mouse_menu
= 0;
8058 /* Use local over global Menu maps */
8060 if (! menu_prompting
)
8063 /* Optionally disregard all but the global map. */
8064 if (inhibit_local_menu_bar_menus
)
8066 maps
+= (nmaps
- 1);
8070 /* Get the menu name from the first map that has one (a prompt string). */
8071 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8073 name
= Fkeymap_prompt (maps
[mapno
]);
8078 /* If we don't have any menus, just read a character normally. */
8079 if (!STRINGP (name
))
8083 /* If we got to this point via a mouse click,
8084 use a real menu for mouse selection. */
8085 if (EVENT_HAS_PARAMETERS (prev_event
)
8086 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8087 && !EQ (XCAR (prev_event
), Qtool_bar
))
8089 /* Display the menu and get the selection. */
8090 Lisp_Object
*realmaps
8091 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8095 /* Use the maps that are not nil. */
8096 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8097 if (!NILP (maps
[mapno
]))
8098 realmaps
[nmaps1
++] = maps
[mapno
];
8100 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8105 record_menu_key (XCAR (value
));
8107 /* If we got multiple events, unread all but
8109 There is no way to prevent those unread events
8110 from showing up later in last_nonmenu_event.
8111 So turn symbol and integer events into lists,
8112 to indicate that they came from a mouse menu,
8113 so that when present in last_nonmenu_event
8114 they won't confuse things. */
8115 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8117 record_menu_key (XCAR (tem
));
8118 if (SYMBOLP (XCAR (tem
))
8119 || INTEGERP (XCAR (tem
)))
8120 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8123 /* If we got more than one event, put all but the first
8124 onto this list to be read later.
8125 Return just the first event now. */
8126 Vunread_command_events
8127 = nconc2 (XCDR (value
), Vunread_command_events
);
8128 value
= XCAR (value
);
8130 else if (NILP (value
))
8132 if (used_mouse_menu
)
8133 *used_mouse_menu
= 1;
8136 #endif /* HAVE_MENUS */
8140 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8141 We make this bigger when necessary, and never free it. */
8142 static char *read_char_minibuf_menu_text
;
8143 /* Size of that buffer. */
8144 static int read_char_minibuf_menu_width
;
8147 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8153 register Lisp_Object name
;
8155 /* FIXME: Use the minibuffer's frame width. */
8156 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8159 Lisp_Object rest
, vector
;
8165 if (! menu_prompting
)
8168 /* Make sure we have a big enough buffer for the menu text. */
8169 if (read_char_minibuf_menu_text
== 0)
8171 read_char_minibuf_menu_width
= width
+ 4;
8172 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8174 else if (width
+ 4 > read_char_minibuf_menu_width
)
8176 read_char_minibuf_menu_width
= width
+ 4;
8177 read_char_minibuf_menu_text
8178 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8180 menu
= read_char_minibuf_menu_text
;
8182 /* Get the menu name from the first map that has one (a prompt string). */
8183 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8185 name
= Fkeymap_prompt (maps
[mapno
]);
8190 /* If we don't have any menus, just read a character normally. */
8191 if (!STRINGP (name
))
8194 /* Prompt string always starts with map's prompt, and a space. */
8195 strcpy (menu
, SDATA (name
));
8196 nlength
= SBYTES (name
);
8197 menu
[nlength
++] = ':';
8198 menu
[nlength
++] = ' ';
8201 /* Start prompting at start of first map. */
8205 /* Present the documented bindings, a line at a time. */
8212 Lisp_Object orig_defn_macro
;
8214 /* Loop over elements of map. */
8219 /* If reached end of map, start at beginning of next map. */
8223 /* At end of last map, wrap around to first map if just starting,
8224 or end this line if already have something on it. */
8228 if (notfirst
|| nobindings
) break;
8233 /* Look at the next element of the map. */
8235 elt
= XVECTOR (vector
)->contents
[idx
];
8237 elt
= Fcar_safe (rest
);
8239 if (idx
< 0 && VECTORP (elt
))
8241 /* If we found a dense table in the keymap,
8242 advanced past it, but start scanning its contents. */
8243 rest
= Fcdr_safe (rest
);
8249 /* An ordinary element. */
8250 Lisp_Object event
, tem
;
8254 event
= Fcar_safe (elt
); /* alist */
8255 elt
= Fcdr_safe (elt
);
8259 XSETINT (event
, idx
); /* vector */
8262 /* Ignore the element if it has no prompt string. */
8263 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8265 /* 1 if the char to type matches the string. */
8267 Lisp_Object upcased_event
, downcased_event
;
8268 Lisp_Object desc
= Qnil
;
8270 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8272 upcased_event
= Fupcase (event
);
8273 downcased_event
= Fdowncase (event
);
8274 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8275 || XINT (downcased_event
) == SREF (s
, 0));
8277 desc
= Fsingle_key_description (event
, Qnil
);
8279 #if 0 /* It is redundant to list the equivalent key bindings because
8280 the prefix is what the user has already typed. */
8282 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8284 /* Insert equivalent keybinding. */
8285 s
= concat2 (s
, tem
);
8288 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8289 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8291 /* Insert button prefix. */
8292 Lisp_Object selected
8293 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8294 if (EQ (tem
, QCradio
))
8295 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8297 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8298 s
= concat2 (tem
, s
);
8302 /* If we have room for the prompt string, add it to this line.
8303 If this is the first on the line, always add it. */
8304 if ((SCHARS (s
) + i
+ 2
8305 + (char_matches
? 0 : SCHARS (desc
) + 3))
8311 /* Punctuate between strings. */
8314 strcpy (menu
+ i
, ", ");
8320 /* If the char to type doesn't match the string's
8321 first char, explicitly show what char to type. */
8324 /* Add as much of string as fits. */
8325 thiswidth
= SCHARS (desc
);
8326 if (thiswidth
+ i
> width
)
8327 thiswidth
= width
- i
;
8328 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8330 strcpy (menu
+ i
, " = ");
8334 /* Add as much of string as fits. */
8335 thiswidth
= SCHARS (s
);
8336 if (thiswidth
+ i
> width
)
8337 thiswidth
= width
- i
;
8338 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8344 /* If this element does not fit, end the line now,
8345 and save the element for the next line. */
8346 strcpy (menu
+ i
, "...");
8351 /* Move past this element. */
8352 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8353 /* Handle reaching end of dense table. */
8358 rest
= Fcdr_safe (rest
);
8362 /* Prompt with that and read response. */
8363 message2_nolog (menu
, strlen (menu
),
8364 ! NILP (current_buffer
->enable_multibyte_characters
));
8366 /* Make believe its not a keyboard macro in case the help char
8367 is pressed. Help characters are not recorded because menu prompting
8368 is not used on replay.
8370 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8371 current_kboard
->defining_kbd_macro
= Qnil
;
8373 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8374 while (BUFFERP (obj
));
8375 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8377 if (!INTEGERP (obj
))
8382 if (! EQ (obj
, menu_prompt_more_char
)
8383 && (!INTEGERP (menu_prompt_more_char
)
8384 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8386 if (!NILP (current_kboard
->defining_kbd_macro
))
8387 store_kbd_macro_char (obj
);
8390 /* Help char - go round again */
8394 /* Reading key sequences. */
8396 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8397 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8398 keymap, or nil otherwise. Return the index of the first keymap in
8399 which KEY has any binding, or NMAPS if no map has a binding.
8401 If KEY is a meta ASCII character, treat it like meta-prefix-char
8402 followed by the corresponding non-meta character. Keymaps in
8403 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8406 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8409 NEXT may be the same array as CURRENT. */
8412 follow_key (key
, nmaps
, current
, defs
, next
)
8414 Lisp_Object
*current
, *defs
, *next
;
8417 int i
, first_binding
;
8419 first_binding
= nmaps
;
8420 for (i
= nmaps
- 1; i
>= 0; i
--)
8422 if (! NILP (current
[i
]))
8424 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8425 if (! NILP (defs
[i
]))
8432 /* Given the set of bindings we've found, produce the next set of maps. */
8433 if (first_binding
< nmaps
)
8434 for (i
= 0; i
< nmaps
; i
++)
8435 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8437 return first_binding
;
8440 /* Structure used to keep track of partial application of key remapping
8441 such as Vfunction_key_map and Vkey_translation_map. */
8442 typedef struct keyremap
8444 Lisp_Object map
, parent
;
8448 /* Lookup KEY in MAP.
8449 MAP is a keymap mapping keys to key vectors or functions.
8450 If the mapping is a function and DO_FUNCTION is non-zero, then
8451 the function is called with PROMPT as parameter and its return
8452 value is used as the return value of this function (after checking
8453 that it is indeed a vector). */
8456 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8457 Lisp_Object map
, key
, prompt
;
8462 next
= access_keymap (map
, key
, 1, 0, 1);
8464 /* Handle symbol with autoload definition. */
8465 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8466 && CONSP (XSYMBOL (next
)->function
)
8467 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8468 do_autoload (XSYMBOL (next
)->function
, next
);
8470 /* Handle a symbol whose function definition is a keymap
8472 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8473 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8474 || KEYMAPP (XSYMBOL (next
)->function
)))
8475 next
= XSYMBOL (next
)->function
;
8477 /* If the keymap gives a function, not an
8478 array, then call the function with one arg and use
8479 its value instead. */
8480 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8485 next
= call1 (next
, prompt
);
8486 /* If the function returned something invalid,
8487 barf--don't ignore it.
8488 (To ignore it safely, we would need to gcpro a bunch of
8489 other variables.) */
8490 if (! (VECTORP (next
) || STRINGP (next
)))
8491 error ("Function %s returns invalid key sequence", tem
);
8496 /* Do one step of the key remapping used for function-key-map and
8497 key-translation-map:
8498 KEYBUF is the buffer holding the input events.
8499 BUFSIZE is its maximum size.
8500 FKEY is a pointer to the keyremap structure to use.
8501 INPUT is the index of the last element in KEYBUF.
8502 DOIT if non-zero says that the remapping can actually take place.
8503 DIFF is used to return the number of keys added/removed by the remapping.
8504 PARENT is the root of the keymap.
8505 PROMPT is the prompt to use if the remapping happens through a function.
8506 The return value is non-zero if the remapping actually took place. */
8509 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8510 Lisp_Object
*keybuf
, prompt
;
8512 int input
, doit
, *diff
, bufsize
;
8514 Lisp_Object next
, key
;
8516 key
= keybuf
[fkey
->end
++];
8517 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8519 /* If keybuf[fkey->start..fkey->end] is bound in the
8520 map and we're in a position to do the key remapping, replace it with
8521 the binding and restart with fkey->start at the end. */
8522 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8524 int len
= XFASTINT (Flength (next
));
8527 *diff
= len
- (fkey
->end
- fkey
->start
);
8529 if (input
+ *diff
>= bufsize
)
8530 error ("Key sequence too long");
8532 /* Shift the keys that follow fkey->end. */
8534 for (i
= fkey
->end
; i
< input
; i
++)
8535 keybuf
[i
+ *diff
] = keybuf
[i
];
8537 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8538 keybuf
[i
+ *diff
] = keybuf
[i
];
8539 /* Overwrite the old keys with the new ones. */
8540 for (i
= 0; i
< len
; i
++)
8541 keybuf
[fkey
->start
+ i
]
8542 = Faref (next
, make_number (i
));
8544 fkey
->start
= fkey
->end
+= *diff
;
8545 fkey
->map
= fkey
->parent
;
8550 fkey
->map
= get_keymap (next
, 0, 1);
8552 /* If we no longer have a bound suffix, try a new position for
8554 if (!CONSP (fkey
->map
))
8556 fkey
->end
= ++fkey
->start
;
8557 fkey
->map
= fkey
->parent
;
8562 /* Read a sequence of keys that ends with a non prefix character,
8563 storing it in KEYBUF, a buffer of size BUFSIZE.
8565 Return the length of the key sequence stored.
8566 Return -1 if the user rejected a command menu.
8568 Echo starting immediately unless `prompt' is 0.
8570 Where a key sequence ends depends on the currently active keymaps.
8571 These include any minor mode keymaps active in the current buffer,
8572 the current buffer's local map, and the global map.
8574 If a key sequence has no other bindings, we check Vfunction_key_map
8575 to see if some trailing subsequence might be the beginning of a
8576 function key's sequence. If so, we try to read the whole function
8577 key, and substitute its symbolic name into the key sequence.
8579 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8580 `double-' events into similar click events, if that would make them
8581 bound. We try to turn `triple-' events first into `double-' events,
8584 If we get a mouse click in a mode line, vertical divider, or other
8585 non-text area, we treat the click as if it were prefixed by the
8586 symbol denoting that area - `mode-line', `vertical-line', or
8589 If the sequence starts with a mouse click, we read the key sequence
8590 with respect to the buffer clicked on, not the current buffer.
8592 If the user switches frames in the midst of a key sequence, we put
8593 off the switch-frame event until later; the next call to
8594 read_char will return it.
8596 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8597 from the selected window's buffer. */
8600 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8601 can_return_switch_frame
, fix_current_buffer
)
8602 Lisp_Object
*keybuf
;
8605 int dont_downcase_last
;
8606 int can_return_switch_frame
;
8607 int fix_current_buffer
;
8609 volatile Lisp_Object from_string
;
8610 volatile int count
= SPECPDL_INDEX ();
8612 /* How many keys there are in the current key sequence. */
8615 /* The length of the echo buffer when we started reading, and
8616 the length of this_command_keys when we started reading. */
8617 volatile int echo_start
;
8618 volatile int keys_start
;
8620 /* The number of keymaps we're scanning right now, and the number of
8621 keymaps we have allocated space for. */
8623 volatile int nmaps_allocated
= 0;
8625 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8626 the current keymaps. */
8627 Lisp_Object
*volatile defs
= NULL
;
8629 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8630 in the current keymaps, or nil where it is not a prefix. */
8631 Lisp_Object
*volatile submaps
= NULL
;
8633 /* The local map to start out with at start of key sequence. */
8634 volatile Lisp_Object orig_local_map
;
8636 /* The map from the `keymap' property to start out with at start of
8638 volatile Lisp_Object orig_keymap
;
8640 /* 1 if we have already considered switching to the local-map property
8641 of the place where a mouse click occurred. */
8642 volatile int localized_local_map
= 0;
8644 /* The index in defs[] of the first keymap that has a binding for
8645 this key sequence. In other words, the lowest i such that
8646 defs[i] is non-nil. */
8647 volatile int first_binding
;
8648 /* Index of the first key that has no binding.
8649 It is useless to try fkey.start larger than that. */
8650 volatile int first_unbound
;
8652 /* If t < mock_input, then KEYBUF[t] should be read as the next
8655 We use this to recover after recognizing a function key. Once we
8656 realize that a suffix of the current key sequence is actually a
8657 function key's escape sequence, we replace the suffix with the
8658 function key's binding from Vfunction_key_map. Now keybuf
8659 contains a new and different key sequence, so the echo area,
8660 this_command_keys, and the submaps and defs arrays are wrong. In
8661 this situation, we set mock_input to t, set t to 0, and jump to
8662 restart_sequence; the loop will read keys from keybuf up until
8663 mock_input, thus rebuilding the state; and then it will resume
8664 reading characters from the keyboard. */
8665 volatile int mock_input
= 0;
8667 /* If the sequence is unbound in submaps[], then
8668 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8669 and fkey.map is its binding.
8671 These might be > t, indicating that all function key scanning
8672 should hold off until t reaches them. We do this when we've just
8673 recognized a function key, to avoid searching for the function
8674 key's again in Vfunction_key_map. */
8675 volatile keyremap fkey
;
8677 /* Likewise, for key_translation_map. */
8678 volatile keyremap keytran
;
8680 /* If we receive a `switch-frame' or `select-window' event in the middle of
8681 a key sequence, we put it off for later.
8682 While we're reading, we keep the event here. */
8683 volatile Lisp_Object delayed_switch_frame
;
8685 /* See the comment below... */
8686 #if defined (GOBBLE_FIRST_EVENT)
8687 Lisp_Object first_event
;
8690 volatile Lisp_Object original_uppercase
;
8691 volatile int original_uppercase_position
= -1;
8693 /* Gets around Microsoft compiler limitations. */
8696 struct buffer
*starting_buffer
;
8698 /* List of events for which a fake prefix key has been generated. */
8699 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8701 #if defined (GOBBLE_FIRST_EVENT)
8705 struct gcpro gcpro1
;
8707 GCPRO1 (fake_prefixed_keys
);
8708 raw_keybuf_count
= 0;
8710 last_nonmenu_event
= Qnil
;
8712 delayed_switch_frame
= Qnil
;
8713 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
8714 keytran
.map
= keytran
.parent
= current_kboard
->Vlocal_key_translation_map
;
8715 /* If there is no translation-map, turn off scanning. */
8716 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8717 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8722 echo_prompt (prompt
);
8723 else if (cursor_in_echo_area
8724 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8725 && NILP (Fzerop (Vecho_keystrokes
)))
8726 /* This doesn't put in a dash if the echo buffer is empty, so
8727 you don't always see a dash hanging out in the minibuffer. */
8731 /* Record the initial state of the echo area and this_command_keys;
8732 we will need to restore them if we replay a key sequence. */
8734 echo_start
= echo_length ();
8735 keys_start
= this_command_key_count
;
8736 this_single_command_key_start
= keys_start
;
8738 #if defined (GOBBLE_FIRST_EVENT)
8739 /* This doesn't quite work, because some of the things that read_char
8740 does cannot safely be bypassed. It seems too risky to try to make
8743 /* Read the first char of the sequence specially, before setting
8744 up any keymaps, in case a filter runs and switches buffers on us. */
8745 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8747 #endif /* GOBBLE_FIRST_EVENT */
8749 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8750 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8753 /* We jump here when the key sequence has been thoroughly changed, and
8754 we need to rescan it starting from the beginning. When we jump here,
8755 keybuf[0..mock_input] holds the sequence we should reread. */
8758 starting_buffer
= current_buffer
;
8759 first_unbound
= bufsize
+ 1;
8761 /* Build our list of keymaps.
8762 If we recognize a function key and replace its escape sequence in
8763 keybuf with its symbol, or if the sequence starts with a mouse
8764 click and we need to switch buffers, we jump back here to rebuild
8765 the initial keymaps from the current buffer. */
8768 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8769 || !NILP (Voverriding_local_map
))
8771 if (3 > nmaps_allocated
)
8773 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8774 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8775 nmaps_allocated
= 3;
8777 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8778 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8779 if (!NILP (Voverriding_local_map
))
8780 submaps
[nmaps
++] = Voverriding_local_map
;
8788 nminor
= current_minor_maps (0, &maps
);
8789 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8791 if (total
> nmaps_allocated
)
8793 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8794 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8795 nmaps_allocated
= total
;
8798 if (!NILP (orig_keymap
))
8799 submaps
[nmaps
++] = orig_keymap
;
8801 bcopy (maps
, (void *) (submaps
+ nmaps
),
8802 nminor
* sizeof (submaps
[0]));
8806 submaps
[nmaps
++] = orig_local_map
;
8808 submaps
[nmaps
++] = current_global_map
;
8810 /* Find an accurate initial value for first_binding. */
8811 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8812 if (! NILP (submaps
[first_binding
]))
8815 /* Start from the beginning in keybuf. */
8818 /* These are no-ops the first time through, but if we restart, they
8819 revert the echo area and this_command_keys to their original state. */
8820 this_command_key_count
= keys_start
;
8821 if (INTERACTIVE
&& t
< mock_input
)
8822 echo_truncate (echo_start
);
8824 /* If the best binding for the current key sequence is a keymap, or
8825 we may be looking at a function key's escape sequence, keep on
8827 while (first_binding
< nmaps
8828 /* Keep reading as long as there's a prefix binding. */
8829 ? !NILP (submaps
[first_binding
])
8830 /* Don't return in the middle of a possible function key sequence,
8831 if the only bindings we found were via case conversion.
8832 Thus, if ESC O a has a function-key-map translation
8833 and ESC o has a binding, don't return after ESC O,
8834 so that we can translate ESC O plus the next character. */
8835 : (fkey
.start
< t
|| keytran
.start
< t
))
8838 int used_mouse_menu
= 0;
8840 /* Where the last real key started. If we need to throw away a
8841 key that has expanded into more than one element of keybuf
8842 (say, a mouse click on the mode line which is being treated
8843 as [mode-line (mouse-...)], then we backtrack to this point
8845 volatile int last_real_key_start
;
8847 /* These variables are analogous to echo_start and keys_start;
8848 while those allow us to restart the entire key sequence,
8849 echo_local_start and keys_local_start allow us to throw away
8851 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8853 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8854 eassert (fkey
.start
<= fkey
.end
);
8855 eassert (keytran
.start
<= keytran
.end
);
8856 /* key-translation-map is applied *after* function-key-map. */
8857 eassert (keytran
.end
<= fkey
.start
);
8859 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8860 { /* The prefix upto first_unbound has no binding and has
8861 no translation left to do either, so we know it's unbound.
8862 If we don't stop now, we risk staying here indefinitely
8863 (if the user keeps entering fkey or keytran prefixes
8864 like C-c ESC ESC ESC ESC ...) */
8866 for (i
= first_unbound
+ 1; i
< t
; i
++)
8867 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8868 mock_input
= t
- first_unbound
- 1;
8869 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8870 fkey
.map
= fkey
.parent
;
8871 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8872 keytran
.map
= keytran
.parent
;
8873 goto replay_sequence
;
8877 error ("Key sequence too long");
8880 echo_local_start
= echo_length ();
8881 keys_local_start
= this_command_key_count
;
8882 local_first_binding
= first_binding
;
8885 /* These are no-ops, unless we throw away a keystroke below and
8886 jumped back up to replay_key; in that case, these restore the
8887 variables to their original state, allowing us to replay the
8889 if (INTERACTIVE
&& t
< mock_input
)
8890 echo_truncate (echo_local_start
);
8891 this_command_key_count
= keys_local_start
;
8892 first_binding
= local_first_binding
;
8894 /* By default, assume each event is "real". */
8895 last_real_key_start
= t
;
8897 /* Does mock_input indicate that we are re-reading a key sequence? */
8901 add_command_key (key
);
8902 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8903 && NILP (Fzerop (Vecho_keystrokes
)))
8907 /* If not, we should actually read a character. */
8912 KBOARD
*interrupted_kboard
= current_kboard
;
8913 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8914 if (setjmp (wrong_kboard_jmpbuf
))
8916 if (!NILP (delayed_switch_frame
))
8918 interrupted_kboard
->kbd_queue
8919 = Fcons (delayed_switch_frame
,
8920 interrupted_kboard
->kbd_queue
);
8921 delayed_switch_frame
= Qnil
;
8924 interrupted_kboard
->kbd_queue
8925 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8927 /* If the side queue is non-empty, ensure it begins with a
8928 switch-frame, so we'll replay it in the right context. */
8929 if (CONSP (interrupted_kboard
->kbd_queue
)
8930 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8931 !(EVENT_HAS_PARAMETERS (key
)
8932 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8936 XSETFRAME (frame
, interrupted_frame
);
8937 interrupted_kboard
->kbd_queue
8938 = Fcons (make_lispy_switch_frame (frame
),
8939 interrupted_kboard
->kbd_queue
);
8942 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8943 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8944 goto replay_sequence
;
8947 key
= read_char (NILP (prompt
), nmaps
,
8948 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8952 /* read_char returns t when it shows a menu and the user rejects it.
8956 unbind_to (count
, Qnil
);
8961 /* read_char returns -1 at the end of a macro.
8962 Emacs 18 handles this by returning immediately with a
8963 zero, so that's what we'll do. */
8964 if (INTEGERP (key
) && XINT (key
) == -1)
8967 /* The Microsoft C compiler can't handle the goto that
8973 /* If the current buffer has been changed from under us, the
8974 keymap may have changed, so replay the sequence. */
8977 timer_resume_idle ();
8980 /* Reset the current buffer from the selected window
8981 in case something changed the former and not the latter.
8982 This is to be more consistent with the behavior
8983 of the command_loop_1. */
8984 if (fix_current_buffer
)
8986 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8988 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8989 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8992 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8993 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8994 goto replay_sequence
;
8997 /* If we have a quit that was typed in another frame, and
8998 quit_throw_to_read_char switched buffers,
8999 replay to get the right keymap. */
9001 && XINT (key
) == quit_char
9002 && current_buffer
!= starting_buffer
)
9005 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9009 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9010 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9011 goto replay_sequence
;
9016 if (EVENT_HAS_PARAMETERS (key
)
9017 /* Either a `switch-frame' or a `select-window' event. */
9018 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9020 /* If we're at the beginning of a key sequence, and the caller
9021 says it's okay, go ahead and return this event. If we're
9022 in the midst of a key sequence, delay it until the end. */
9023 if (t
> 0 || !can_return_switch_frame
)
9025 delayed_switch_frame
= key
;
9031 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9034 /* Clicks in non-text areas get prefixed by the symbol
9035 in their CHAR-ADDRESS field. For example, a click on
9036 the mode line is prefixed by the symbol `mode-line'.
9038 Furthermore, key sequences beginning with mouse clicks
9039 are read using the keymaps of the buffer clicked on, not
9040 the current buffer. So we may have to switch the buffer
9043 When we turn one event into two events, we must make sure
9044 that neither of the two looks like the original--so that,
9045 if we replay the events, they won't be expanded again.
9046 If not for this, such reexpansion could happen either here
9047 or when user programs play with this-command-keys. */
9048 if (EVENT_HAS_PARAMETERS (key
))
9053 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9054 if (EQ (kind
, Qmouse_click
))
9056 Lisp_Object window
, posn
;
9058 window
= POSN_WINDOW (EVENT_START (key
));
9059 posn
= POSN_POSN (EVENT_START (key
));
9062 || (!NILP (fake_prefixed_keys
)
9063 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9065 /* We're looking a second time at an event for which
9066 we generated a fake prefix key. Set
9067 last_real_key_start appropriately. */
9069 last_real_key_start
= t
- 1;
9072 /* Key sequences beginning with mouse clicks are
9073 read using the keymaps in the buffer clicked on,
9074 not the current buffer. If we're at the
9075 beginning of a key sequence, switch buffers. */
9076 if (last_real_key_start
== 0
9078 && BUFFERP (XWINDOW (window
)->buffer
)
9079 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9081 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9085 /* Arrange to go back to the original buffer once we're
9086 done reading the key sequence. Note that we can't
9087 use save_excursion_{save,restore} here, because they
9088 save point as well as the current buffer; we don't
9089 want to save point, because redisplay may change it,
9090 to accommodate a Fset_window_start or something. We
9091 don't want to do this at the top of the function,
9092 because we may get input from a subprocess which
9093 wants to change the selected window and stuff (say,
9095 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9097 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9099 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9100 orig_local_map
= get_local_map (PT
, current_buffer
,
9102 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9103 goto replay_sequence
;
9106 /* For a mouse click, get the local text-property keymap
9107 of the place clicked on, rather than point. */
9108 if (last_real_key_start
== 0
9109 && CONSP (XCDR (key
))
9110 && ! localized_local_map
)
9112 Lisp_Object map_here
, start
, pos
;
9114 localized_local_map
= 1;
9115 start
= EVENT_START (key
);
9117 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9119 pos
= POSN_BUFFER_POSN (start
);
9121 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9123 map_here
= get_local_map (XINT (pos
),
9124 current_buffer
, Qlocal_map
);
9125 if (!EQ (map_here
, orig_local_map
))
9127 orig_local_map
= map_here
;
9131 goto replay_sequence
;
9133 map_here
= get_local_map (XINT (pos
),
9134 current_buffer
, Qkeymap
);
9135 if (!EQ (map_here
, orig_keymap
))
9137 orig_keymap
= map_here
;
9141 goto replay_sequence
;
9147 /* Expand mode-line and scroll-bar events into two events:
9148 use posn as a fake prefix key. */
9150 && (NILP (fake_prefixed_keys
)
9151 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9153 if (t
+ 1 >= bufsize
)
9154 error ("Key sequence too long");
9157 keybuf
[t
+ 1] = key
;
9160 /* Record that a fake prefix key has been generated
9161 for KEY. Don't modify the event; this would
9162 prevent proper action when the event is pushed
9163 back into unread-command-events. */
9164 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9166 /* If on a mode line string with a local keymap,
9167 reconsider the key sequence with that keymap. */
9168 if (string
= POSN_STRING (EVENT_START (key
)),
9169 (CONSP (string
) && STRINGP (XCAR (string
))))
9171 Lisp_Object pos
, map
, map2
;
9173 pos
= XCDR (string
);
9174 string
= XCAR (string
);
9176 && XINT (pos
) < SCHARS (string
))
9178 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9180 orig_local_map
= map
;
9181 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9184 if (!NILP (map
) || !NILP (map2
))
9185 goto replay_sequence
;
9191 else if (NILP (from_string
)
9192 && (string
= POSN_STRING (EVENT_START (key
)),
9193 (CONSP (string
) && STRINGP (XCAR (string
)))))
9195 /* For a click on a string, i.e. overlay string or a
9196 string displayed via the `display' property,
9197 consider `local-map' and `keymap' properties of
9199 Lisp_Object pos
, map
, map2
;
9201 pos
= XCDR (string
);
9202 string
= XCAR (string
);
9204 && XINT (pos
) < SCHARS (string
))
9206 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9208 orig_local_map
= map
;
9209 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9213 if (!NILP (map
) || !NILP (map2
))
9215 from_string
= string
;
9216 goto replay_sequence
;
9221 else if (CONSP (XCDR (key
))
9222 && CONSP (EVENT_START (key
))
9223 && CONSP (XCDR (EVENT_START (key
))))
9227 posn
= POSN_POSN (EVENT_START (key
));
9228 /* Handle menu-bar events:
9229 insert the dummy prefix event `menu-bar'. */
9230 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9232 if (t
+ 1 >= bufsize
)
9233 error ("Key sequence too long");
9237 /* Zap the position in key, so we know that we've
9238 expanded it, and don't try to do so again. */
9239 POSN_SET_POSN (EVENT_START (key
),
9240 Fcons (posn
, Qnil
));
9243 goto replay_sequence
;
9245 else if (CONSP (posn
))
9247 /* We're looking at the second event of a
9248 sequence which we expanded before. Set
9249 last_real_key_start appropriately. */
9250 if (last_real_key_start
== t
&& t
> 0)
9251 last_real_key_start
= t
- 1;
9256 /* We have finally decided that KEY is something we might want
9258 first_binding
= (follow_key (key
,
9259 nmaps
- first_binding
,
9260 submaps
+ first_binding
,
9261 defs
+ first_binding
,
9262 submaps
+ first_binding
)
9265 /* If KEY wasn't bound, we'll try some fallbacks. */
9266 if (first_binding
< nmaps
)
9267 /* This is needed for the following scenario:
9268 event 0: a down-event that gets dropped by calling replay_key.
9269 event 1: some normal prefix like C-h.
9270 After event 0, first_unbound is 0, after event 1 fkey.start
9271 and keytran.start are both 1, so when we see that C-h is bound,
9272 we need to update first_unbound. */
9273 first_unbound
= max (t
+ 1, first_unbound
);
9278 /* Remember the position to put an upper bound on fkey.start. */
9279 first_unbound
= min (t
, first_unbound
);
9281 head
= EVENT_HEAD (key
);
9282 if (help_char_p (head
) && t
> 0)
9284 read_key_sequence_cmd
= Vprefix_help_command
;
9286 last_nonmenu_event
= key
;
9287 /* The Microsoft C compiler can't handle the goto that
9295 Lisp_Object breakdown
;
9298 breakdown
= parse_modifiers (head
);
9299 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9300 /* Attempt to reduce an unbound mouse event to a simpler
9301 event that is bound:
9302 Drags reduce to clicks.
9303 Double-clicks reduce to clicks.
9304 Triple-clicks reduce to double-clicks, then to clicks.
9305 Down-clicks are eliminated.
9306 Double-downs reduce to downs, then are eliminated.
9307 Triple-downs reduce to double-downs, then to downs,
9308 then are eliminated. */
9309 if (modifiers
& (down_modifier
| drag_modifier
9310 | double_modifier
| triple_modifier
))
9312 while (modifiers
& (down_modifier
| drag_modifier
9313 | double_modifier
| triple_modifier
))
9315 Lisp_Object new_head
, new_click
;
9316 if (modifiers
& triple_modifier
)
9317 modifiers
^= (double_modifier
| triple_modifier
);
9318 else if (modifiers
& double_modifier
)
9319 modifiers
&= ~double_modifier
;
9320 else if (modifiers
& drag_modifier
)
9321 modifiers
&= ~drag_modifier
;
9324 /* Dispose of this `down' event by simply jumping
9325 back to replay_key, to get another event.
9327 Note that if this event came from mock input,
9328 then just jumping back to replay_key will just
9329 hand it to us again. So we have to wipe out any
9332 We could delete keybuf[t] and shift everything
9333 after that to the left by one spot, but we'd also
9334 have to fix up any variable that points into
9335 keybuf, and shifting isn't really necessary
9338 Adding prefixes for non-textual mouse clicks
9339 creates two characters of mock input, and both
9340 must be thrown away. If we're only looking at
9341 the prefix now, we can just jump back to
9342 replay_key. On the other hand, if we've already
9343 processed the prefix, and now the actual click
9344 itself is giving us trouble, then we've lost the
9345 state of the keymaps we want to backtrack to, and
9346 we need to replay the whole sequence to rebuild
9349 Beyond that, only function key expansion could
9350 create more than two keys, but that should never
9351 generate mouse events, so it's okay to zero
9352 mock_input in that case too.
9354 FIXME: The above paragraph seems just plain
9355 wrong, if you consider things like
9356 xterm-mouse-mode. -stef
9358 Isn't this just the most wonderful code ever? */
9360 /* If mock_input > t + 1, the above simplification
9361 will actually end up dropping keys on the floor.
9362 This is probably OK for now, but even
9363 if mock_input <= t + 1, we need to adjust fkey
9365 Typical case [header-line down-mouse-N]:
9366 mock_input = 2, t = 1, fkey.end = 1,
9367 last_real_key_start = 0. */
9368 if (fkey
.end
> last_real_key_start
)
9370 fkey
.end
= fkey
.start
9371 = min (last_real_key_start
, fkey
.start
);
9372 fkey
.map
= fkey
.parent
;
9373 if (keytran
.end
> last_real_key_start
)
9375 keytran
.end
= keytran
.start
9376 = min (last_real_key_start
, keytran
.start
);
9377 keytran
.map
= keytran
.parent
;
9380 if (t
== last_real_key_start
)
9387 mock_input
= last_real_key_start
;
9388 goto replay_sequence
;
9393 = apply_modifiers (modifiers
, XCAR (breakdown
));
9395 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9397 /* Look for a binding for this new key. follow_key
9398 promises that it didn't munge submaps the
9399 last time we called it, since key was unbound. */
9401 = (follow_key (new_click
,
9402 nmaps
- local_first_binding
,
9403 submaps
+ local_first_binding
,
9404 defs
+ local_first_binding
,
9405 submaps
+ local_first_binding
)
9406 + local_first_binding
);
9408 /* If that click is bound, go for it. */
9409 if (first_binding
< nmaps
)
9414 /* Otherwise, we'll leave key set to the drag event. */
9421 /* Normally, last_nonmenu_event gets the previous key we read.
9422 But when a mouse popup menu is being used,
9423 we don't update last_nonmenu_event; it continues to hold the mouse
9424 event that preceded the first level of menu. */
9425 if (!used_mouse_menu
)
9426 last_nonmenu_event
= key
;
9428 /* Record what part of this_command_keys is the current key sequence. */
9429 this_single_command_key_start
= this_command_key_count
- t
;
9431 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9432 /* There is a binding and it's not a prefix.
9433 There is thus no function-key in this sequence.
9434 Moving fkey.start is important in this case to allow keytran.start
9435 to go over the sequence before we return (since we keep the
9436 invariant that keytran.end <= fkey.start). */
9439 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9442 /* If the sequence is unbound, see if we can hang a function key
9443 off the end of it. */
9444 /* Continue scan from fkey.end until we find a bound suffix. */
9445 while (fkey
.end
< t
)
9447 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9450 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9451 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9452 max (t
, mock_input
),
9453 /* If there's a binding (i.e.
9454 first_binding >= nmaps) we don't want
9455 to apply this function-key-mapping. */
9456 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9461 mock_input
= diff
+ max (t
, mock_input
);
9462 goto replay_sequence
;
9466 /* Look for this sequence in key-translation-map.
9467 Scan from keytran.end until we find a bound suffix. */
9468 while (keytran
.end
< fkey
.start
)
9470 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9473 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9474 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9479 mock_input
= diff
+ max (t
, mock_input
);
9480 /* Adjust the function-key-map counters. */
9484 goto replay_sequence
;
9488 /* If KEY is not defined in any of the keymaps,
9489 and cannot be part of a function key or translation,
9490 and is an upper case letter
9491 use the corresponding lower-case letter instead. */
9492 if (first_binding
>= nmaps
9493 && fkey
.start
>= t
&& keytran
.start
>= t
9495 && ((((XINT (key
) & 0x3ffff)
9496 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9497 && UPPERCASEP (XINT (key
) & 0x3ffff))
9498 || (XINT (key
) & shift_modifier
)))
9500 Lisp_Object new_key
;
9502 original_uppercase
= key
;
9503 original_uppercase_position
= t
- 1;
9505 if (XINT (key
) & shift_modifier
)
9506 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9508 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9509 | (XINT (key
) & ~0x3ffff)));
9511 /* We have to do this unconditionally, regardless of whether
9512 the lower-case char is defined in the keymaps, because they
9513 might get translated through function-key-map. */
9514 keybuf
[t
- 1] = new_key
;
9515 mock_input
= max (t
, mock_input
);
9517 goto replay_sequence
;
9519 /* If KEY is not defined in any of the keymaps,
9520 and cannot be part of a function key or translation,
9521 and is a shifted function key,
9522 use the corresponding unshifted function key instead. */
9523 if (first_binding
>= nmaps
9524 && fkey
.start
>= t
&& keytran
.start
>= t
9527 Lisp_Object breakdown
;
9530 breakdown
= parse_modifiers (key
);
9531 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9532 if (modifiers
& shift_modifier
)
9534 Lisp_Object new_key
;
9536 original_uppercase
= key
;
9537 original_uppercase_position
= t
- 1;
9539 modifiers
&= ~shift_modifier
;
9540 new_key
= apply_modifiers (modifiers
,
9543 keybuf
[t
- 1] = new_key
;
9544 mock_input
= max (t
, mock_input
);
9545 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9546 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9548 goto replay_sequence
;
9554 read_key_sequence_cmd
= (first_binding
< nmaps
9555 ? defs
[first_binding
]
9558 unread_switch_frame
= delayed_switch_frame
;
9559 unbind_to (count
, Qnil
);
9561 /* Don't downcase the last character if the caller says don't.
9562 Don't downcase it if the result is undefined, either. */
9563 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9564 && t
- 1 == original_uppercase_position
)
9565 keybuf
[t
- 1] = original_uppercase
;
9567 /* Occasionally we fabricate events, perhaps by expanding something
9568 according to function-key-map, or by adding a prefix symbol to a
9569 mouse click in the scroll bar or modeline. In this cases, return
9570 the entire generated key sequence, even if we hit an unbound
9571 prefix or a definition before the end. This means that you will
9572 be able to push back the event properly, and also means that
9573 read-key-sequence will always return a logical unit.
9576 for (; t
< mock_input
; t
++)
9578 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9579 && NILP (Fzerop (Vecho_keystrokes
)))
9580 echo_char (keybuf
[t
]);
9581 add_command_key (keybuf
[t
]);
9590 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9591 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9592 The sequence is sufficient to specify a non-prefix command in the
9593 current local and global maps.
9595 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9596 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9597 as a continuation of the previous key.
9599 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9600 convert the last event to lower case. (Normally any upper case event
9601 is converted to lower case if the original event is undefined and the lower
9602 case equivalent is defined.) A non-nil value is appropriate for reading
9603 a key sequence to be defined.
9605 A C-g typed while in this function is treated like any other character,
9606 and `quit-flag' is not set.
9608 If the key sequence starts with a mouse click, then the sequence is read
9609 using the keymaps of the buffer of the window clicked in, not the buffer
9610 of the selected window as normal.
9612 `read-key-sequence' drops unbound button-down events, since you normally
9613 only care about the click or drag events which follow them. If a drag
9614 or multi-click event is unbound, but the corresponding click event would
9615 be bound, `read-key-sequence' turns the event into a click event at the
9616 drag's starting position. This means that you don't have to distinguish
9617 between click and drag, double, or triple events unless you want to.
9619 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9620 lines separating windows, and scroll bars with imaginary keys
9621 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9623 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9624 function will process a switch-frame event if the user switches frames
9625 before typing anything. If the user switches frames in the middle of a
9626 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9627 is nil, then the event will be put off until after the current key sequence.
9629 `read-key-sequence' checks `function-key-map' for function key
9630 sequences, where they wouldn't conflict with ordinary bindings. See
9631 `function-key-map' for more details.
9633 The optional fifth argument COMMAND-LOOP, if non-nil, means
9634 that this key sequence is being read by something that will
9635 read commands one after another. It should be nil if the caller
9636 will read just one key sequence. */)
9637 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9639 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9640 Lisp_Object can_return_switch_frame
, command_loop
;
9642 Lisp_Object keybuf
[30];
9644 struct gcpro gcpro1
;
9645 int count
= SPECPDL_INDEX ();
9648 CHECK_STRING (prompt
);
9651 specbind (Qinput_method_exit_on_first_char
,
9652 (NILP (command_loop
) ? Qt
: Qnil
));
9653 specbind (Qinput_method_use_echo_area
,
9654 (NILP (command_loop
) ? Qt
: Qnil
));
9656 bzero (keybuf
, sizeof keybuf
);
9658 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9660 if (NILP (continue_echo
))
9662 this_command_key_count
= 0;
9663 this_command_key_count_reset
= 0;
9664 this_single_command_key_start
= 0;
9667 #ifdef HAVE_X_WINDOWS
9668 if (display_hourglass_p
)
9669 cancel_hourglass ();
9672 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9673 prompt
, ! NILP (dont_downcase_last
),
9674 ! NILP (can_return_switch_frame
), 0);
9676 #if 0 /* The following is fine for code reading a key sequence and
9677 then proceeding with a lenghty computation, but it's not good
9678 for code reading keys in a loop, like an input method. */
9679 #ifdef HAVE_X_WINDOWS
9680 if (display_hourglass_p
)
9691 return unbind_to (count
, make_event_array (i
, keybuf
));
9694 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9695 Sread_key_sequence_vector
, 1, 5, 0,
9696 doc
: /* Like `read-key-sequence' but always return a vector. */)
9697 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9699 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9700 Lisp_Object can_return_switch_frame
, command_loop
;
9702 Lisp_Object keybuf
[30];
9704 struct gcpro gcpro1
;
9705 int count
= SPECPDL_INDEX ();
9708 CHECK_STRING (prompt
);
9711 specbind (Qinput_method_exit_on_first_char
,
9712 (NILP (command_loop
) ? Qt
: Qnil
));
9713 specbind (Qinput_method_use_echo_area
,
9714 (NILP (command_loop
) ? Qt
: Qnil
));
9716 bzero (keybuf
, sizeof keybuf
);
9718 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9720 if (NILP (continue_echo
))
9722 this_command_key_count
= 0;
9723 this_command_key_count_reset
= 0;
9724 this_single_command_key_start
= 0;
9727 #ifdef HAVE_X_WINDOWS
9728 if (display_hourglass_p
)
9729 cancel_hourglass ();
9732 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9733 prompt
, ! NILP (dont_downcase_last
),
9734 ! NILP (can_return_switch_frame
), 0);
9736 #ifdef HAVE_X_WINDOWS
9737 if (display_hourglass_p
)
9747 return unbind_to (count
, Fvector (i
, keybuf
));
9750 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9751 doc
: /* Execute CMD as an editor command.
9752 CMD must be a symbol that satisfies the `commandp' predicate.
9753 Optional second arg RECORD-FLAG non-nil
9754 means unconditionally put this command in `command-history'.
9755 Otherwise, that is done only if an arg is read using the minibuffer.
9756 The argument KEYS specifies the value to use instead of (this-command-keys)
9757 when reading the arguments; if it is nil, (this-command-keys) is used.
9758 The argument SPECIAL, if non-nil, means that this command is executing
9759 a special event, so ignore the prefix argument and don't clear it. */)
9760 (cmd
, record_flag
, keys
, special
)
9761 Lisp_Object cmd
, record_flag
, keys
, special
;
9763 register Lisp_Object final
;
9764 register Lisp_Object tem
;
9765 Lisp_Object prefixarg
;
9766 struct backtrace backtrace
;
9767 extern int debug_on_next_call
;
9769 debug_on_next_call
= 0;
9773 prefixarg
= current_kboard
->Vprefix_arg
;
9774 Vcurrent_prefix_arg
= prefixarg
;
9775 current_kboard
->Vprefix_arg
= Qnil
;
9782 tem
= Fget (cmd
, Qdisabled
);
9783 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9785 tem
= Fsymbol_value (Qdisabled_command_function
);
9787 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9793 final
= Findirect_function (cmd
);
9795 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9797 struct gcpro gcpro1
, gcpro2
;
9799 GCPRO2 (cmd
, prefixarg
);
9800 do_autoload (final
, cmd
);
9807 if (STRINGP (final
) || VECTORP (final
))
9809 /* If requested, place the macro in the command history. For
9810 other sorts of commands, call-interactively takes care of
9812 if (!NILP (record_flag
))
9815 = Fcons (Fcons (Qexecute_kbd_macro
,
9816 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9819 /* Don't keep command history around forever. */
9820 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9822 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9824 XSETCDR (tem
, Qnil
);
9828 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9831 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9833 backtrace
.next
= backtrace_list
;
9834 backtrace_list
= &backtrace
;
9835 backtrace
.function
= &Qcall_interactively
;
9836 backtrace
.args
= &cmd
;
9837 backtrace
.nargs
= 1;
9838 backtrace
.evalargs
= 0;
9839 backtrace
.debug_on_exit
= 0;
9841 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9843 backtrace_list
= backtrace
.next
;
9851 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9853 doc
: /* Read function name, then read its arguments and call it. */)
9855 Lisp_Object prefixarg
;
9857 Lisp_Object function
;
9859 int saved_last_point_position
;
9860 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9861 Lisp_Object bindings
, value
;
9862 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9863 #ifdef HAVE_X_WINDOWS
9864 /* The call to Fcompleting_read wil start and cancel the hourglass,
9865 but if the hourglass was already scheduled, this means that no
9866 hourglass will be shown for the actual M-x command itself.
9867 So we restart it if it is already scheduled. Note that checking
9868 hourglass_shown_p is not enough, normally the hourglass is not shown,
9869 just scheduled to be shown. */
9870 int hstarted
= hourglass_started ();
9873 saved_keys
= Fvector (this_command_key_count
,
9874 XVECTOR (this_command_keys
)->contents
);
9875 saved_last_point_position_buffer
= last_point_position_buffer
;
9876 saved_last_point_position
= last_point_position
;
9878 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9880 if (EQ (prefixarg
, Qminus
))
9882 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9883 strcpy (buf
, "C-u ");
9884 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9885 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9886 else if (INTEGERP (prefixarg
))
9887 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9889 /* This isn't strictly correct if execute-extended-command
9890 is bound to anything else. Perhaps it should use
9891 this_command_keys? */
9892 strcat (buf
, "M-x ");
9894 /* Prompt with buf, and then read a string, completing from and
9895 restricting to the set of all defined commands. Don't provide
9896 any initial input. Save the command read on the extended-command
9898 function
= Fcompleting_read (build_string (buf
),
9899 Vobarray
, Qcommandp
,
9900 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9903 #ifdef HAVE_X_WINDOWS
9904 if (hstarted
) start_hourglass ();
9907 if (STRINGP (function
) && SCHARS (function
) == 0)
9908 error ("No command name given");
9910 /* Set this_command_keys to the concatenation of saved_keys and
9911 function, followed by a RET. */
9916 this_command_key_count
= 0;
9917 this_command_key_count_reset
= 0;
9918 this_single_command_key_start
= 0;
9920 keys
= XVECTOR (saved_keys
)->contents
;
9921 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9922 add_command_key (keys
[i
]);
9924 for (i
= 0; i
< SCHARS (function
); i
++)
9925 add_command_key (Faref (function
, make_number (i
)));
9927 add_command_key (make_number ('\015'));
9930 last_point_position
= saved_last_point_position
;
9931 last_point_position_buffer
= saved_last_point_position_buffer
;
9935 function
= Fintern (function
, Qnil
);
9936 current_kboard
->Vprefix_arg
= prefixarg
;
9937 Vthis_command
= function
;
9938 real_this_command
= function
;
9940 /* If enabled, show which key runs this command. */
9941 if (!NILP (Vsuggest_key_bindings
)
9942 && NILP (Vexecuting_kbd_macro
)
9943 && SYMBOLP (function
))
9944 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9950 GCPRO2 (bindings
, value
);
9951 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9953 /* If the command has a key binding, print it now. */
9954 if (!NILP (bindings
)
9955 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9958 /* But first wait, and skip the message if there is input. */
9960 if (!NILP (echo_area_buffer
[0]))
9961 /* This command displayed something in the echo area;
9962 so wait a few seconds, then display our suggestion message. */
9963 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9964 ? XINT (Vsuggest_key_bindings
) : 2);
9966 /* This command left the echo area empty,
9967 so display our message immediately. */
9970 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9971 && ! CONSP (Vunread_command_events
))
9973 Lisp_Object binding
;
9975 int message_p
= push_message ();
9976 int count
= SPECPDL_INDEX ();
9978 record_unwind_protect (pop_message_unwind
, Qnil
);
9979 binding
= Fkey_description (bindings
, Qnil
);
9982 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9985 sprintf (newmessage
, "You can run the command `%s' with %s",
9986 SDATA (SYMBOL_NAME (function
)),
9988 message2_nolog (newmessage
,
9989 strlen (newmessage
),
9990 STRING_MULTIBYTE (binding
));
9991 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9992 ? Vsuggest_key_bindings
: make_number (2)),
9997 unbind_to (count
, Qnil
);
10001 RETURN_UNGCPRO (value
);
10005 /* Return nonzero if input events are pending. */
10008 detect_input_pending ()
10010 if (!input_pending
)
10011 get_input_pending (&input_pending
, 0);
10013 return input_pending
;
10016 /* Return nonzero if input events other than mouse movements are
10020 detect_input_pending_ignore_squeezables ()
10022 if (!input_pending
)
10023 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10025 return input_pending
;
10028 /* Return nonzero if input events are pending, and run any pending timers. */
10031 detect_input_pending_run_timers (do_display
)
10034 int old_timers_run
= timers_run
;
10036 if (!input_pending
)
10037 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10039 if (old_timers_run
!= timers_run
&& do_display
)
10041 redisplay_preserve_echo_area (8);
10042 /* The following fixes a bug when using lazy-lock with
10043 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10044 from an idle timer function. The symptom of the bug is that
10045 the cursor sometimes doesn't become visible until the next X
10046 event is processed. --gerd. */
10048 Lisp_Object tail
, frame
;
10049 FOR_EACH_FRAME (tail
, frame
)
10050 if (FRAME_RIF (XFRAME (frame
)))
10051 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10055 return input_pending
;
10058 /* This is called in some cases before a possible quit.
10059 It cases the next call to detect_input_pending to recompute input_pending.
10060 So calling this function unnecessarily can't do any harm. */
10063 clear_input_pending ()
10068 /* Return nonzero if there are pending requeued events.
10069 This isn't used yet. The hope is to make wait_reading_process_output
10070 call it, and return if it runs Lisp code that unreads something.
10071 The problem is, kbd_buffer_get_event needs to be fixed to know what
10072 to do in that case. It isn't trivial. */
10075 requeued_events_pending_p ()
10077 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10081 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10082 doc
: /* Return t if command input is currently available with no wait.
10083 Actually, the value is nil only if we can be sure that no input is available;
10084 if there is a doubt, the value is t. */)
10087 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10090 get_input_pending (&input_pending
,
10091 READABLE_EVENTS_DO_TIMERS_NOW
10092 | READABLE_EVENTS_FILTER_EVENTS
);
10093 return input_pending
> 0 ? Qt
: Qnil
;
10096 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10097 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10100 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10103 if (total_keys
< NUM_RECENT_KEYS
)
10104 return Fvector (total_keys
, keys
);
10107 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10108 bcopy (keys
+ recent_keys_index
,
10109 XVECTOR (val
)->contents
,
10110 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10112 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10113 recent_keys_index
* sizeof (Lisp_Object
));
10118 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10119 doc
: /* Return the key sequence that invoked this command.
10120 However, if the command has called `read-key-sequence', it returns
10121 the last key sequence that has been read.
10122 The value is a string or a vector. */)
10125 return make_event_array (this_command_key_count
,
10126 XVECTOR (this_command_keys
)->contents
);
10129 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10130 doc
: /* Return the key sequence that invoked this command, as a vector.
10131 However, if the command has called `read-key-sequence', it returns
10132 the last key sequence that has been read. */)
10135 return Fvector (this_command_key_count
,
10136 XVECTOR (this_command_keys
)->contents
);
10139 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10140 Sthis_single_command_keys
, 0, 0, 0,
10141 doc
: /* Return the key sequence that invoked this command.
10142 More generally, it returns the last key sequence read, either by
10143 the command loop or by `read-key-sequence'.
10144 Unlike `this-command-keys', this function's value
10145 does not include prefix arguments.
10146 The value is always a vector. */)
10149 return Fvector (this_command_key_count
10150 - this_single_command_key_start
,
10151 (XVECTOR (this_command_keys
)->contents
10152 + this_single_command_key_start
));
10155 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10156 Sthis_single_command_raw_keys
, 0, 0, 0,
10157 doc
: /* Return the raw events that were read for this command.
10158 More generally, it returns the last key sequence read, either by
10159 the command loop or by `read-key-sequence'.
10160 Unlike `this-single-command-keys', this function's value
10161 shows the events before all translations (except for input methods).
10162 The value is always a vector. */)
10165 return Fvector (raw_keybuf_count
,
10166 (XVECTOR (raw_keybuf
)->contents
));
10169 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10170 Sreset_this_command_lengths
, 0, 0, 0,
10171 doc
: /* Make the unread events replace the last command and echo.
10172 Used in `universal-argument-other-key'.
10174 `universal-argument-other-key' rereads the event just typed.
10175 It then gets translated through `function-key-map'.
10176 The translated event has to replace the real events,
10177 both in the value of (this-command-keys) and in echoing.
10178 To achieve this, `universal-argument-other-key' calls
10179 `reset-this-command-lengths', which discards the record of reading
10180 these events the first time. */)
10183 this_command_key_count
= before_command_key_count
;
10184 if (this_command_key_count
< this_single_command_key_start
)
10185 this_single_command_key_start
= this_command_key_count
;
10187 echo_truncate (before_command_echo_length
);
10189 /* Cause whatever we put into unread-command-events
10190 to echo as if it were being freshly read from the keyboard. */
10191 this_command_key_count_reset
= 1;
10196 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10197 Sclear_this_command_keys
, 0, 1, 0,
10198 doc
: /* Clear out the vector that `this-command-keys' returns.
10199 Also clear the record of the last 100 events, unless optional arg
10200 KEEP-RECORD is non-nil. */)
10202 Lisp_Object keep_record
;
10206 this_command_key_count
= 0;
10207 this_command_key_count_reset
= 0;
10209 if (NILP (keep_record
))
10211 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10212 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10214 recent_keys_index
= 0;
10219 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10220 doc
: /* Return the current depth in recursive edits. */)
10224 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10228 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10229 "FOpen dribble file: ",
10230 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10231 If FILE is nil, close any open dribble file. */)
10242 file
= Fexpand_file_name (file
, Qnil
);
10243 dribble
= fopen (SDATA (file
), "w");
10245 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10250 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10251 doc
: /* Discard the contents of the terminal input buffer.
10252 Also end any kbd macro being defined. */)
10255 if (!NILP (current_kboard
->defining_kbd_macro
))
10257 /* Discard the last command from the macro. */
10258 Fcancel_kbd_macro_events ();
10262 update_mode_lines
++;
10264 Vunread_command_events
= Qnil
;
10265 unread_command_char
= -1;
10267 discard_tty_input ();
10269 kbd_fetch_ptr
= kbd_store_ptr
;
10275 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10276 doc
: /* Stop Emacs and return to superior process. You can resume later.
10277 If `cannot-suspend' is non-nil, or if the system doesn't support job
10278 control, run a subshell instead.
10280 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10281 to be read as terminal input by Emacs's parent, after suspension.
10283 Before suspending, run the normal hook `suspend-hook'.
10284 After resumption run the normal hook `suspend-resume-hook'.
10286 Some operating systems cannot stop the Emacs process and resume it later.
10287 On such systems, Emacs starts a subshell instead of suspending. */)
10289 Lisp_Object stuffstring
;
10291 int count
= SPECPDL_INDEX ();
10292 int old_height
, old_width
;
10294 struct gcpro gcpro1
;
10296 if (tty_list
&& tty_list
->next
)
10297 error ("There are other tty frames open; close them before suspending Emacs");
10299 if (!NILP (stuffstring
))
10300 CHECK_STRING (stuffstring
);
10302 /* Run the functions in suspend-hook. */
10303 if (!NILP (Vrun_hooks
))
10304 call1 (Vrun_hooks
, intern ("suspend-hook"));
10306 GCPRO1 (stuffstring
);
10307 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10308 reset_all_sys_modes ();
10309 /* sys_suspend can get an error if it tries to fork a subshell
10310 and the system resources aren't available for that. */
10311 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10313 stuff_buffered_input (stuffstring
);
10314 if (cannot_suspend
)
10318 unbind_to (count
, Qnil
);
10320 /* Check if terminal/window size has changed.
10321 Note that this is not useful when we are running directly
10322 with a window system; but suspend should be disabled in that case. */
10323 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10324 if (width
!= old_width
|| height
!= old_height
)
10325 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10327 /* Run suspend-resume-hook. */
10328 if (!NILP (Vrun_hooks
))
10329 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10335 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10336 Then in any case stuff anything Emacs has read ahead and not used. */
10339 stuff_buffered_input (stuffstring
)
10340 Lisp_Object stuffstring
;
10342 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10343 register unsigned char *p
;
10345 if (STRINGP (stuffstring
))
10347 register int count
;
10349 p
= SDATA (stuffstring
);
10350 count
= SBYTES (stuffstring
);
10351 while (count
-- > 0)
10356 /* Anything we have read ahead, put back for the shell to read. */
10357 /* ?? What should this do when we have multiple keyboards??
10358 Should we ignore anything that was typed in at the "wrong" kboard?
10360 rms: we should stuff everything back into the kboard
10362 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10365 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10366 kbd_fetch_ptr
= kbd_buffer
;
10367 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10368 stuff_char (kbd_fetch_ptr
->code
);
10370 clear_event (kbd_fetch_ptr
);
10374 #endif /* SIGTSTP */
10378 set_waiting_for_input (time_to_clear
)
10379 EMACS_TIME
*time_to_clear
;
10381 input_available_clear_time
= time_to_clear
;
10383 /* Tell handle_interrupt to throw back to read_char, */
10384 waiting_for_input
= 1;
10386 /* If handle_interrupt was called before and buffered a C-g,
10387 make it run again now, to avoid timing error. */
10388 if (!NILP (Vquit_flag
))
10389 quit_throw_to_read_char ();
10393 clear_waiting_for_input ()
10395 /* Tell handle_interrupt not to throw back to read_char, */
10396 waiting_for_input
= 0;
10397 input_available_clear_time
= 0;
10400 /* The SIGINT handler.
10402 If we have a frame on the controlling tty, we assume that the
10403 SIGINT was generated by C-g, so we call handle_interrupt.
10404 Otherwise, the handler kills Emacs. */
10407 interrupt_signal (signalnum
) /* If we don't have an argument, */
10408 int signalnum
; /* some compilers complain in signal calls. */
10410 /* Must preserve main program's value of errno. */
10411 int old_errno
= errno
;
10412 struct device
*device
;
10414 #if defined (USG) && !defined (POSIX_SIGNALS)
10415 /* USG systems forget handlers when they are used;
10416 must reestablish each time */
10417 signal (SIGINT
, interrupt_signal
);
10418 signal (SIGQUIT
, interrupt_signal
);
10421 SIGNAL_THREAD_CHECK (signalnum
);
10423 /* See if we have an active display on our controlling terminal. */
10424 device
= get_named_tty (NULL
);
10427 /* If there are no frames there, let's pretend that we are a
10428 well-behaving UN*X program and quit. */
10429 fatal_error_signal (SIGTERM
);
10433 /* Otherwise, the SIGINT was probably generated by C-g. */
10435 /* Set internal_last_event_frame to the top frame of the
10436 controlling tty, if we have a frame there. We disable the
10437 interrupt key on secondary ttys, so the SIGINT must have come
10438 from the controlling tty. */
10439 internal_last_event_frame
= device
->display_info
.tty
->top_frame
;
10441 handle_interrupt ();
10447 /* This routine is called at interrupt level in response to C-g.
10449 It is called from the SIGINT handler or kbd_buffer_store_event.
10451 If `waiting_for_input' is non zero, then unless `echoing' is
10452 nonzero, immediately throw back to read_char.
10454 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10455 eval to throw, when it gets a chance. If quit-flag is already
10456 non-nil, it stops the job right away. */
10459 handle_interrupt ()
10465 /* XXX This code needs to be revised for multi-tty support. */
10466 if (!NILP (Vquit_flag
)
10468 && get_named_tty (NULL
)
10472 /* If SIGINT isn't blocked, don't let us be interrupted by
10473 another SIGINT, it might be harmful due to non-reentrancy
10474 in I/O functions. */
10475 sigblock (sigmask (SIGINT
));
10478 reset_all_sys_modes ();
10480 #ifdef SIGTSTP /* Support possible in later USG versions */
10482 * On systems which can suspend the current process and return to the original
10483 * shell, this command causes the user to end up back at the shell.
10484 * The "Auto-save" and "Abort" questions are not asked until
10485 * the user elects to return to emacs, at which point he can save the current
10486 * job and either dump core or continue.
10491 if (sys_suspend () == -1)
10493 printf ("Not running as a subprocess;\n");
10494 printf ("you can continue or abort.\n");
10496 #else /* not VMS */
10497 /* Perhaps should really fork an inferior shell?
10498 But that would not provide any way to get back
10499 to the original shell, ever. */
10500 printf ("No support for stopping a process on this operating system;\n");
10501 printf ("you can continue or abort.\n");
10502 #endif /* not VMS */
10503 #endif /* not SIGTSTP */
10505 /* We must remain inside the screen area when the internal terminal
10506 is used. Note that [Enter] is not echoed by dos. */
10509 /* It doesn't work to autosave while GC is in progress;
10510 the code used for auto-saving doesn't cope with the mark bit. */
10511 if (!gc_in_progress
)
10513 printf ("Auto-save? (y or n) ");
10515 if (((c
= getchar ()) & ~040) == 'Y')
10517 Fdo_auto_save (Qt
, Qnil
);
10519 printf ("\r\nAuto-save done");
10520 #else /* not MSDOS */
10521 printf ("Auto-save done\n");
10522 #endif /* not MSDOS */
10524 while (c
!= '\n') c
= getchar ();
10528 /* During GC, it must be safe to reenable quitting again. */
10529 Vinhibit_quit
= Qnil
;
10532 #endif /* not MSDOS */
10533 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10534 printf ("but will instead do a real quit after garbage collection ends\r\n");
10539 printf ("\r\nAbort? (y or n) ");
10540 #else /* not MSDOS */
10542 printf ("Abort (and enter debugger)? (y or n) ");
10543 #else /* not VMS */
10544 printf ("Abort (and dump core)? (y or n) ");
10545 #endif /* not VMS */
10546 #endif /* not MSDOS */
10548 if (((c
= getchar ()) & ~040) == 'Y')
10550 while (c
!= '\n') c
= getchar ();
10552 printf ("\r\nContinuing...\r\n");
10553 #else /* not MSDOS */
10554 printf ("Continuing...\n");
10555 #endif /* not MSDOS */
10557 init_all_sys_modes ();
10562 /* If executing a function that wants to be interrupted out of
10563 and the user has not deferred quitting by binding `inhibit-quit'
10564 then quit right away. */
10565 if (immediate_quit
&& NILP (Vinhibit_quit
))
10567 struct gl_state_s saved
;
10568 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10570 immediate_quit
= 0;
10573 GCPRO4 (saved
.object
, saved
.global_code
,
10574 saved
.current_syntax_table
, saved
.old_prop
);
10575 Fsignal (Qquit
, Qnil
);
10580 /* Else request quit when it's safe */
10584 if (waiting_for_input
&& !echoing
)
10585 quit_throw_to_read_char ();
10588 /* Handle a C-g by making read_char return C-g. */
10591 quit_throw_to_read_char ()
10594 /* Prevent another signal from doing this before we finish. */
10595 clear_waiting_for_input ();
10598 Vunread_command_events
= Qnil
;
10599 unread_command_char
= -1;
10601 #if 0 /* Currently, sit_for is called from read_char without turning
10602 off polling. And that can call set_waiting_for_input.
10603 It seems to be harmless. */
10604 #ifdef POLL_FOR_INPUT
10605 /* May be > 1 if in recursive minibuffer. */
10606 if (poll_suppress_count
== 0)
10610 if (FRAMEP (internal_last_event_frame
)
10611 && !EQ (internal_last_event_frame
, selected_frame
))
10612 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10615 _longjmp (getcjmp
, 1);
10618 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10619 doc
: /* Set mode of reading keyboard input.
10620 First arg INTERRUPT non-nil means use input interrupts;
10621 nil means use CBREAK mode.
10622 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10623 (no effect except in CBREAK mode).
10624 Third arg META t means accept 8-bit input (for a Meta key).
10625 META nil means ignore the top bit, on the assumption it is parity.
10626 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10627 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10628 See also `current-input-mode'. */)
10629 (interrupt
, flow
, meta
, quit
)
10630 Lisp_Object interrupt
, flow
, meta
, quit
;
10632 /* XXX This function needs to be revised for multi-device support.
10633 Currently it compiles fine, but its semantics are wrong. It sets
10634 global parameters (e.g. interrupt_input) based on only the
10635 current frame's device. */
10638 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10639 error ("set-input-mode: QUIT must be an ASCII character");
10641 #ifdef POLL_FOR_INPUT
10646 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10647 /* this causes startup screen to be restored and messes with the mouse */
10648 reset_sys_modes (CURTTY ());
10652 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10653 if (FRAME_DEVICE (SELECTED_FRAME ())->read_socket_hook
)
10655 /* When using X, don't give the user a real choice,
10656 because we haven't implemented the mechanisms to support it. */
10657 #ifdef NO_SOCK_SIGIO
10658 interrupt_input
= 0;
10659 #else /* not NO_SOCK_SIGIO */
10660 interrupt_input
= 1;
10661 #endif /* NO_SOCK_SIGIO */
10664 interrupt_input
= !NILP (interrupt
);
10665 #else /* not SIGIO */
10666 interrupt_input
= 0;
10667 #endif /* not SIGIO */
10669 /* Our VMS input only works by interrupts, as of now. */
10671 interrupt_input
= 1;
10674 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10676 struct tty_display_info
*tty
= CURTTY ();
10677 tty
->flow_control
= !NILP (flow
);
10680 else if (EQ (meta
, Qt
))
10687 /* Don't let this value be out of range. */
10688 quit_char
= XINT (quit
) & (NILP (meta
) ? 0177 : 0377);
10691 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10692 init_sys_modes (CURTTY ());
10695 #ifdef POLL_FOR_INPUT
10696 poll_suppress_count
= 1;
10702 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10703 doc
: /* Return information about the way Emacs currently reads keyboard input.
10704 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10705 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10706 nil, Emacs is using CBREAK mode.
10707 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10708 terminal; this does not apply if Emacs uses interrupt-driven input.
10709 META is t if accepting 8-bit input with 8th bit as Meta flag.
10710 META nil means ignoring the top bit, on the assumption it is parity.
10711 META is neither t nor nil if accepting 8-bit input and using
10712 all 8 bits as the character code.
10713 QUIT is the character Emacs currently uses to quit.
10714 The elements of this list correspond to the arguments of
10715 `set-input-mode'. */)
10718 Lisp_Object val
[4];
10719 struct frame
*sf
= XFRAME (selected_frame
);
10721 val
[0] = interrupt_input
? Qt
: Qnil
;
10722 if (FRAME_TERMCAP_P (sf
))
10724 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10725 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10727 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10734 XSETFASTINT (val
[3], quit_char
);
10736 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10739 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10740 doc
: /* Return position information for pixel coordinates X and Y.
10741 By default, X and Y are relative to text area of the selected window.
10742 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10743 If optional fourth arg WHOLE is non-nil, X is relative to the left
10744 edge of the window.
10746 The return value is similar to a mouse click 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. */)
10750 (x
, y
, frame_or_window
, whole
)
10751 Lisp_Object x
, y
, frame_or_window
, whole
;
10756 if (NILP (frame_or_window
))
10757 frame_or_window
= selected_window
;
10759 if (WINDOWP (frame_or_window
))
10763 CHECK_LIVE_WINDOW (frame_or_window
);
10765 w
= XWINDOW (frame_or_window
);
10766 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10768 ? window_box_left_offset (w
, TEXT_AREA
)
10769 : - (WINDOW_LEFT_SCROLL_BAR_COLS (w
)
10770 * WINDOW_FRAME_COLUMN_WIDTH (w
)))));
10771 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10772 frame_or_window
= w
->frame
;
10775 CHECK_LIVE_FRAME (frame_or_window
);
10777 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10780 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10781 doc
: /* Return position information for buffer POS in WINDOW.
10782 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10784 Return nil if position is not visible in window. Otherwise,
10785 the return value is similar to that returned by `event-start' for
10786 a mouse click at the upper left corner of the glyph corresponding
10787 to the given buffer position:
10788 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10789 IMAGE (DX . DY) (WIDTH . HEIGHT))
10790 The `posn-' functions access elements of such lists. */)
10792 Lisp_Object pos
, window
;
10796 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10798 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
, Qnil
);
10804 * Set up a new kboard object with reasonable initial values.
10810 kb
->Voverriding_terminal_local_map
= Qnil
;
10811 kb
->Vlast_command
= Qnil
;
10812 kb
->Vreal_last_command
= Qnil
;
10813 kb
->Vprefix_arg
= Qnil
;
10814 kb
->Vlast_prefix_arg
= Qnil
;
10815 kb
->kbd_queue
= Qnil
;
10816 kb
->kbd_queue_has_data
= 0;
10817 kb
->immediate_echo
= 0;
10818 kb
->echo_string
= Qnil
;
10819 kb
->echo_after_prompt
= -1;
10820 kb
->kbd_macro_buffer
= 0;
10821 kb
->kbd_macro_bufsize
= 0;
10822 kb
->defining_kbd_macro
= Qnil
;
10823 kb
->Vlast_kbd_macro
= Qnil
;
10824 kb
->reference_count
= 0;
10825 kb
->Vsystem_key_alist
= Qnil
;
10826 kb
->system_key_syms
= Qnil
;
10827 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
10828 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
10829 kb
->Vlocal_key_translation_map
= Fmake_sparse_keymap (Qnil
);
10830 Fset_keymap_parent (kb
->Vlocal_key_translation_map
, Vkey_translation_map
);
10831 kb
->Vdefault_minibuffer_frame
= Qnil
;
10835 * Destroy the contents of a kboard object, but not the object itself.
10836 * We use this just before deleting it, or if we're going to initialize
10837 * it a second time.
10843 if (kb
->kbd_macro_buffer
)
10844 xfree (kb
->kbd_macro_buffer
);
10847 #ifdef MULTI_KBOARD
10849 /* Free KB and memory referenced from it. */
10857 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10860 *kbp
= kb
->next_kboard
;
10862 /* Prevent a dangling reference to KB. */
10863 if (kb
== current_kboard
10864 && FRAMEP (selected_frame
)
10865 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10867 current_kboard
= XFRAME (selected_frame
)->device
->kboard
;
10868 if (current_kboard
== kb
)
10876 #endif /* MULTI_KBOARD */
10881 /* This is correct before outermost invocation of the editor loop */
10882 command_loop_level
= -1;
10883 immediate_quit
= 0;
10884 quit_char
= Ctl ('g');
10885 Vunread_command_events
= Qnil
;
10886 unread_command_char
= -1;
10887 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10889 recent_keys_index
= 0;
10890 kbd_fetch_ptr
= kbd_buffer
;
10891 kbd_store_ptr
= kbd_buffer
;
10893 do_mouse_tracking
= Qnil
;
10897 /* This means that command_loop_1 won't try to select anything the first
10899 internal_last_event_frame
= Qnil
;
10900 Vlast_event_frame
= internal_last_event_frame
;
10902 #ifdef MULTI_KBOARD
10903 current_kboard
= initial_kboard
;
10905 wipe_kboard (current_kboard
);
10906 init_kboard (current_kboard
);
10908 if (!noninteractive
)
10910 /* Before multi-tty support, these handlers used to be installed
10911 only if the current session was a tty session. Now an Emacs
10912 session may have multiple display types, so we always handle
10913 SIGINT. There is special code in interrupt_signal to exit
10914 Emacs on SIGINT when there are no termcap frames on the
10915 controlling terminal. */
10916 signal (SIGINT
, interrupt_signal
);
10917 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10918 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10919 SIGQUIT and we can't tell which one it will give us. */
10920 signal (SIGQUIT
, interrupt_signal
);
10921 #endif /* HAVE_TERMIO */
10923 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10925 if (!noninteractive
)
10926 signal (SIGIO
, input_available_signal
);
10929 /* Use interrupt input by default, if it works and noninterrupt input
10930 has deficiencies. */
10932 #ifdef INTERRUPT_INPUT
10933 interrupt_input
= 1;
10935 interrupt_input
= 0;
10938 /* Our VMS input only works by interrupts, as of now. */
10940 interrupt_input
= 1;
10946 if (keyboard_init_hook
)
10947 (*keyboard_init_hook
) ();
10949 #ifdef POLL_FOR_INPUT
10950 poll_suppress_count
= 1;
10955 /* This type's only use is in syms_of_keyboard, to initialize the
10956 event header symbols and put properties on them. */
10957 struct event_head
{
10963 struct event_head head_table
[] = {
10964 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10965 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10966 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10967 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10968 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10969 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10970 /* `select-window' should be handled just like `switch-frame'
10971 in read_key_sequence. */
10972 {&Qselect_window
, "select-window", &Qswitch_frame
}
10976 syms_of_keyboard ()
10978 Vpre_help_message
= Qnil
;
10979 staticpro (&Vpre_help_message
);
10981 Vlispy_mouse_stem
= build_string ("mouse");
10982 staticpro (&Vlispy_mouse_stem
);
10985 QCimage
= intern (":image");
10986 staticpro (&QCimage
);
10988 staticpro (&Qhelp_echo
);
10989 Qhelp_echo
= intern ("help-echo");
10991 staticpro (&item_properties
);
10992 item_properties
= Qnil
;
10994 staticpro (&tool_bar_item_properties
);
10995 tool_bar_item_properties
= Qnil
;
10996 staticpro (&tool_bar_items_vector
);
10997 tool_bar_items_vector
= Qnil
;
10999 staticpro (&real_this_command
);
11000 real_this_command
= Qnil
;
11002 Qtimer_event_handler
= intern ("timer-event-handler");
11003 staticpro (&Qtimer_event_handler
);
11005 Qdisabled_command_function
= intern ("disabled-command-function");
11006 staticpro (&Qdisabled_command_function
);
11008 Qself_insert_command
= intern ("self-insert-command");
11009 staticpro (&Qself_insert_command
);
11011 Qforward_char
= intern ("forward-char");
11012 staticpro (&Qforward_char
);
11014 Qbackward_char
= intern ("backward-char");
11015 staticpro (&Qbackward_char
);
11017 Qdisabled
= intern ("disabled");
11018 staticpro (&Qdisabled
);
11020 Qundefined
= intern ("undefined");
11021 staticpro (&Qundefined
);
11023 Qpre_command_hook
= intern ("pre-command-hook");
11024 staticpro (&Qpre_command_hook
);
11026 Qpost_command_hook
= intern ("post-command-hook");
11027 staticpro (&Qpost_command_hook
);
11029 Qdeferred_action_function
= intern ("deferred-action-function");
11030 staticpro (&Qdeferred_action_function
);
11032 Qcommand_hook_internal
= intern ("command-hook-internal");
11033 staticpro (&Qcommand_hook_internal
);
11035 Qfunction_key
= intern ("function-key");
11036 staticpro (&Qfunction_key
);
11037 Qmouse_click
= intern ("mouse-click");
11038 staticpro (&Qmouse_click
);
11039 #if defined (WINDOWSNT) || defined (MAC_OS)
11040 Qlanguage_change
= intern ("language-change");
11041 staticpro (&Qlanguage_change
);
11043 Qdrag_n_drop
= intern ("drag-n-drop");
11044 staticpro (&Qdrag_n_drop
);
11046 Qsave_session
= intern ("save-session");
11047 staticpro (&Qsave_session
);
11049 Qusr1_signal
= intern ("usr1-signal");
11050 staticpro (&Qusr1_signal
);
11051 Qusr2_signal
= intern ("usr2-signal");
11052 staticpro (&Qusr2_signal
);
11054 Qmenu_enable
= intern ("menu-enable");
11055 staticpro (&Qmenu_enable
);
11056 Qmenu_alias
= intern ("menu-alias");
11057 staticpro (&Qmenu_alias
);
11058 QCenable
= intern (":enable");
11059 staticpro (&QCenable
);
11060 QCvisible
= intern (":visible");
11061 staticpro (&QCvisible
);
11062 QChelp
= intern (":help");
11063 staticpro (&QChelp
);
11064 QCfilter
= intern (":filter");
11065 staticpro (&QCfilter
);
11066 QCbutton
= intern (":button");
11067 staticpro (&QCbutton
);
11068 QCkeys
= intern (":keys");
11069 staticpro (&QCkeys
);
11070 QCkey_sequence
= intern (":key-sequence");
11071 staticpro (&QCkey_sequence
);
11072 QCtoggle
= intern (":toggle");
11073 staticpro (&QCtoggle
);
11074 QCradio
= intern (":radio");
11075 staticpro (&QCradio
);
11077 Qmode_line
= intern ("mode-line");
11078 staticpro (&Qmode_line
);
11079 Qvertical_line
= intern ("vertical-line");
11080 staticpro (&Qvertical_line
);
11081 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11082 staticpro (&Qvertical_scroll_bar
);
11083 Qmenu_bar
= intern ("menu-bar");
11084 staticpro (&Qmenu_bar
);
11087 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11088 staticpro (&Qmouse_fixup_help_message
);
11091 Qabove_handle
= intern ("above-handle");
11092 staticpro (&Qabove_handle
);
11093 Qhandle
= intern ("handle");
11094 staticpro (&Qhandle
);
11095 Qbelow_handle
= intern ("below-handle");
11096 staticpro (&Qbelow_handle
);
11097 Qup
= intern ("up");
11099 Qdown
= intern ("down");
11100 staticpro (&Qdown
);
11101 Qtop
= intern ("top");
11103 Qbottom
= intern ("bottom");
11104 staticpro (&Qbottom
);
11105 Qend_scroll
= intern ("end-scroll");
11106 staticpro (&Qend_scroll
);
11107 Qratio
= intern ("ratio");
11108 staticpro (&Qratio
);
11110 Qevent_kind
= intern ("event-kind");
11111 staticpro (&Qevent_kind
);
11112 Qevent_symbol_elements
= intern ("event-symbol-elements");
11113 staticpro (&Qevent_symbol_elements
);
11114 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11115 staticpro (&Qevent_symbol_element_mask
);
11116 Qmodifier_cache
= intern ("modifier-cache");
11117 staticpro (&Qmodifier_cache
);
11119 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11120 staticpro (&Qrecompute_lucid_menubar
);
11121 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11122 staticpro (&Qactivate_menubar_hook
);
11124 Qpolling_period
= intern ("polling-period");
11125 staticpro (&Qpolling_period
);
11127 Qinput_method_function
= intern ("input-method-function");
11128 staticpro (&Qinput_method_function
);
11130 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11131 staticpro (&Qinput_method_exit_on_first_char
);
11132 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11133 staticpro (&Qinput_method_use_echo_area
);
11135 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11136 Fset (Qinput_method_use_echo_area
, Qnil
);
11138 last_point_position_buffer
= Qnil
;
11141 struct event_head
*p
;
11143 for (p
= head_table
;
11144 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11147 *p
->var
= intern (p
->name
);
11148 staticpro (p
->var
);
11149 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11150 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11154 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11155 staticpro (&button_down_location
);
11156 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11157 staticpro (&mouse_syms
);
11158 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11159 staticpro (&wheel_syms
);
11163 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11165 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11166 for (i
= 0; i
< len
; i
++)
11167 if (modifier_names
[i
])
11168 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11169 staticpro (&modifier_symbols
);
11172 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11173 staticpro (&recent_keys
);
11175 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11176 staticpro (&this_command_keys
);
11178 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11179 staticpro (&raw_keybuf
);
11181 Qextended_command_history
= intern ("extended-command-history");
11182 Fset (Qextended_command_history
, Qnil
);
11183 staticpro (&Qextended_command_history
);
11185 accent_key_syms
= Qnil
;
11186 staticpro (&accent_key_syms
);
11188 func_key_syms
= Qnil
;
11189 staticpro (&func_key_syms
);
11191 drag_n_drop_syms
= Qnil
;
11192 staticpro (&drag_n_drop_syms
);
11194 unread_switch_frame
= Qnil
;
11195 staticpro (&unread_switch_frame
);
11197 internal_last_event_frame
= Qnil
;
11198 staticpro (&internal_last_event_frame
);
11200 read_key_sequence_cmd
= Qnil
;
11201 staticpro (&read_key_sequence_cmd
);
11203 menu_bar_one_keymap_changed_items
= Qnil
;
11204 staticpro (&menu_bar_one_keymap_changed_items
);
11206 menu_bar_items_vector
= Qnil
;
11207 staticpro (&menu_bar_items_vector
);
11209 defsubr (&Sevent_convert_list
);
11210 defsubr (&Sread_key_sequence
);
11211 defsubr (&Sread_key_sequence_vector
);
11212 defsubr (&Srecursive_edit
);
11214 defsubr (&Strack_mouse
);
11216 defsubr (&Sinput_pending_p
);
11217 defsubr (&Scommand_execute
);
11218 defsubr (&Srecent_keys
);
11219 defsubr (&Sthis_command_keys
);
11220 defsubr (&Sthis_command_keys_vector
);
11221 defsubr (&Sthis_single_command_keys
);
11222 defsubr (&Sthis_single_command_raw_keys
);
11223 defsubr (&Sreset_this_command_lengths
);
11224 defsubr (&Sclear_this_command_keys
);
11225 defsubr (&Ssuspend_emacs
);
11226 defsubr (&Sabort_recursive_edit
);
11227 defsubr (&Sexit_recursive_edit
);
11228 defsubr (&Srecursion_depth
);
11229 defsubr (&Stop_level
);
11230 defsubr (&Sdiscard_input
);
11231 defsubr (&Sopen_dribble_file
);
11232 defsubr (&Sset_input_mode
);
11233 defsubr (&Scurrent_input_mode
);
11234 defsubr (&Sexecute_extended_command
);
11235 defsubr (&Sposn_at_point
);
11236 defsubr (&Sposn_at_x_y
);
11238 DEFVAR_LISP ("last-command-char", &last_command_char
,
11239 doc
: /* Last input event that was part of a command. */);
11241 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11242 doc
: /* Last input event that was part of a command. */);
11244 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11245 doc
: /* Last input event in a command, except for mouse menu events.
11246 Mouse menus give back keys that don't look like mouse events;
11247 this variable holds the actual mouse event that led to the menu,
11248 so that you can determine whether the command was run by mouse or not. */);
11250 DEFVAR_LISP ("last-input-char", &last_input_char
,
11251 doc
: /* Last input event. */);
11253 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11254 doc
: /* Last input event. */);
11256 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11257 doc
: /* List of events to be read as the command input.
11258 These events are processed first, before actual keyboard input. */);
11259 Vunread_command_events
= Qnil
;
11261 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11262 doc
: /* If not -1, an object to be read as next command input event. */);
11264 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11265 doc
: /* List of events to be processed as input by input methods.
11266 These events are processed after `unread-command-events', but
11267 before actual keyboard input. */);
11268 Vunread_post_input_method_events
= Qnil
;
11270 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11271 doc
: /* List of events to be processed as input by input methods.
11272 These events are processed after `unread-command-events', but
11273 before actual keyboard input. */);
11274 Vunread_input_method_events
= Qnil
;
11276 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11277 doc
: /* Meta-prefix character code.
11278 Meta-foo as command input turns into this character followed by foo. */);
11279 XSETINT (meta_prefix_char
, 033);
11281 DEFVAR_KBOARD ("last-command", Vlast_command
,
11282 doc
: /* The last command executed.
11283 Normally a symbol with a function definition, but can be whatever was found
11284 in the keymap, or whatever the variable `this-command' was set to by that
11287 The value `mode-exit' is special; it means that the previous command
11288 read an event that told it to exit, and it did so and unread that event.
11289 In other words, the present command is the event that made the previous
11292 The value `kill-region' is special; it means that the previous command
11293 was a kill command.
11295 `last-command' has a separate binding for each display device.
11296 See Info node `(elisp)Multiple displays'. */);
11298 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11299 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11301 DEFVAR_LISP ("this-command", &Vthis_command
,
11302 doc
: /* The command now being executed.
11303 The command can set this variable; whatever is put here
11304 will be in `last-command' during the following command. */);
11305 Vthis_command
= Qnil
;
11307 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11308 doc
: /* The command bound to the current key sequence before remapping.
11309 It equals `this-command' if the original command was not remapped through
11310 any of the active keymaps. Otherwise, the value of `this-command' is the
11311 result of looking up the original command in the active keymaps. */);
11312 Vthis_original_command
= Qnil
;
11314 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11315 doc
: /* *Number of input events between auto-saves.
11316 Zero means disable autosaving due to number of characters typed. */);
11317 auto_save_interval
= 300;
11319 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11320 doc
: /* *Number of seconds idle time before auto-save.
11321 Zero or nil means disable auto-saving due to idleness.
11322 After auto-saving due to this many seconds of idle time,
11323 Emacs also does a garbage collection if that seems to be warranted. */);
11324 XSETFASTINT (Vauto_save_timeout
, 30);
11326 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11327 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11328 The value may be integer or floating point. */);
11329 Vecho_keystrokes
= make_number (1);
11331 DEFVAR_INT ("polling-period", &polling_period
,
11332 doc
: /* *Interval between polling for input during Lisp execution.
11333 The reason for polling is to make C-g work to stop a running program.
11334 Polling is needed only when using X windows and SIGIO does not work.
11335 Polling is automatically disabled in all other cases. */);
11336 polling_period
= 2;
11338 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11339 doc
: /* *Maximum time between mouse clicks to make a double-click.
11340 Measured in milliseconds. nil means disable double-click recognition;
11341 t means double-clicks have no time limit and are detected
11342 by position only. */);
11343 Vdouble_click_time
= make_number (500);
11345 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11346 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11347 On window-system frames, value is the number of pixels the mouse may have
11348 moved horizontally or vertically between two clicks to make a double-click.
11349 On non window-system frames, value is interpreted in units of 1/8 characters
11352 This variable is also the threshold for motion of the mouse
11353 to count as a drag. */);
11354 double_click_fuzz
= 3;
11356 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11357 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11358 inhibit_local_menu_bar_menus
= 0;
11360 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11361 doc
: /* Number of complete key sequences read as input so far.
11362 This includes key sequences read from keyboard macros.
11363 The number is effectively the number of interactive command invocations. */);
11364 num_input_keys
= 0;
11366 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11367 doc
: /* Number of input events read from the keyboard so far.
11368 This does not include events generated by keyboard macros. */);
11369 num_nonmacro_input_events
= 0;
11371 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11372 doc
: /* The frame in which the most recently read event occurred.
11373 If the last event came from a keyboard macro, this is set to `macro'. */);
11374 Vlast_event_frame
= Qnil
;
11376 /* This variable is set up in sysdep.c. */
11377 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11378 doc
: /* The ERASE character as set by the user with stty. */);
11380 DEFVAR_LISP ("help-char", &Vhelp_char
,
11381 doc
: /* Character to recognize as meaning Help.
11382 When it is read, do `(eval help-form)', and display result if it's a string.
11383 If the value of `help-form' is nil, this char can be read normally. */);
11384 XSETINT (Vhelp_char
, Ctl ('H'));
11386 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11387 doc
: /* List of input events to recognize as meaning Help.
11388 These work just like the value of `help-char' (see that). */);
11389 Vhelp_event_list
= Qnil
;
11391 DEFVAR_LISP ("help-form", &Vhelp_form
,
11392 doc
: /* Form to execute when character `help-char' is read.
11393 If the form returns a string, that string is displayed.
11394 If `help-form' is nil, the help char is not recognized. */);
11397 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11398 doc
: /* Command to run when `help-char' character follows a prefix key.
11399 This command is used only when there is no actual binding
11400 for that character after that prefix key. */);
11401 Vprefix_help_command
= Qnil
;
11403 DEFVAR_LISP ("top-level", &Vtop_level
,
11404 doc
: /* Form to evaluate when Emacs starts up.
11405 Useful to set before you dump a modified Emacs. */);
11408 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11409 doc
: /* Translate table for keyboard input, or nil.
11410 If non-nil, the value should be a char-table. Each character read
11411 from the keyboard is looked up in this char-table. If the value found
11412 there is non-nil, then it is used instead of the actual input character.
11414 The value can also be a string or vector, but this is considered obsolete.
11415 If it is a string or vector of length N, character codes N and up are left
11416 untranslated. In a vector, an element which is nil means "no translation".
11418 This is applied to the characters supplied to input methods, not their
11419 output. See also `translation-table-for-input'. */);
11420 Vkeyboard_translate_table
= Qnil
;
11422 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11423 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11424 \(Even if the operating system has support for stopping a process.\) */);
11425 cannot_suspend
= 0;
11427 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11428 doc
: /* Non-nil means prompt with menus when appropriate.
11429 This is done when reading from a keymap that has a prompt string,
11430 for elements that have prompt strings.
11431 The menu is displayed on the screen
11432 if X menus were enabled at configuration
11433 time and the previous event was a mouse click prefix key.
11434 Otherwise, menu prompting uses the echo area. */);
11435 menu_prompting
= 1;
11437 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11438 doc
: /* Character to see next line of menu prompt.
11439 Type this character while in a menu prompt to rotate around the lines of it. */);
11440 XSETINT (menu_prompt_more_char
, ' ');
11442 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11443 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11444 Emacs applies the modifiers of the character stored here to each keyboard
11445 character it reads. For example, after evaluating the expression
11446 (setq extra-keyboard-modifiers ?\\C-x)
11447 all input characters will have the control modifier applied to them.
11449 Note that the character ?\\C-@, equivalent to the integer zero, does
11450 not count as a control character; rather, it counts as a character
11451 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11452 cancels any modification. */);
11453 extra_keyboard_modifiers
= 0;
11455 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11456 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11457 The command loop sets this to nil before each command,
11458 and tests the value when the command returns.
11459 Buffer modification stores t in this variable. */);
11460 Vdeactivate_mark
= Qnil
;
11462 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11463 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11464 Vcommand_hook_internal
= Qnil
;
11466 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11467 doc
: /* Normal hook run before each command is executed.
11468 If an unhandled error happens in running this hook,
11469 the hook value is set to nil, since otherwise the error
11470 might happen repeatedly and make Emacs nonfunctional. */);
11471 Vpre_command_hook
= Qnil
;
11473 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11474 doc
: /* Normal hook run after each command is executed.
11475 If an unhandled error happens in running this hook,
11476 the hook value is set to nil, since otherwise the error
11477 might happen repeatedly and make Emacs nonfunctional. */);
11478 Vpost_command_hook
= Qnil
;
11481 DEFVAR_LISP ("echo-area-clear-hook", ...,
11482 doc
: /* Normal hook run when clearing the echo area. */);
11484 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11485 staticpro (&Qecho_area_clear_hook
);
11486 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11488 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11489 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11490 Vlucid_menu_bar_dirty_flag
= Qnil
;
11492 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11493 doc
: /* List of menu bar items to move to the end of the menu bar.
11494 The elements of the list are event types that may have menu bar bindings. */);
11495 Vmenu_bar_final_items
= Qnil
;
11497 DEFVAR_KBOARD ("overriding-terminal-local-map",
11498 Voverriding_terminal_local_map
,
11499 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11500 If this variable is non-nil, it is used as a keymap instead of the
11501 buffer's local map, and the minor mode keymaps and text property keymaps.
11502 It also replaces `overriding-local-map'.
11504 This variable is intended to let commands such as `universal-argument'
11505 set up a different keymap for reading the next command.
11507 `overriding-terminal-local-map' has a separate binding for each display device.
11508 See Info node `(elisp)Multiple displays'. */);
11510 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11511 doc
: /* Keymap that overrides all other local keymaps.
11512 If this variable is non-nil, it is used as a keymap--replacing the
11513 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11514 Voverriding_local_map
= Qnil
;
11516 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11517 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11518 Otherwise, the menu bar continues to reflect the buffer's local map
11519 and the minor mode maps regardless of `overriding-local-map'. */);
11520 Voverriding_local_map_menu_flag
= Qnil
;
11522 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11523 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11524 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11526 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11527 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11529 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11530 doc
: /* Alist of system-specific X windows key symbols.
11531 Each element should have the form (N . SYMBOL) where N is the
11532 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11533 and SYMBOL is its name.
11535 `system-key-alist' has a separate binding for each display device.
11536 See Info node `(elisp)Multiple displays'.
11538 Note that the currently selected frame has very little to do with
11539 which binding of this variable is active at any given moment. If you
11540 need set or get the binding on a specific display, use
11541 `terminal-local-value' and `set-terminal-local-value'. */);
11543 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11544 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
11545 This allows Emacs to recognize function keys sent from ASCII
11546 terminals at any point in a key sequence.
11548 The `read-key-sequence' function replaces any subsequence bound by
11549 `function-key-map' with its binding. More precisely, when the active
11550 keymaps have no binding for the current key sequence but
11551 `function-key-map' binds a suffix of the sequence to a vector or string,
11552 `read-key-sequence' replaces the matching suffix with its binding, and
11553 continues with the new sequence.
11555 The events that come from bindings in `function-key-map' are not
11556 themselves looked up in `function-key-map'.
11558 For example, suppose `function-key-map' binds `ESC O P' to [f1].
11559 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11560 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
11561 key, typing `ESC O P x' would return [f1 x].
11563 `function-key-map' has a separate binding for each display device.
11564 See Info node `(elisp)Multiple displays'. If you need to define a
11565 binding on all display devices, change `global-function-key-map'
11568 Note that the currently selected frame has very little to do with
11569 which binding of this variable is active at any given moment. If you
11570 need set or get the binding on a specific display, use
11571 `terminal-local-value' and `set-terminal-local-value'. */);
11573 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
11574 doc
: /* The parent keymap of all `local-function-key-map' instances.
11575 Function key definitions that apply to all display devices should go
11577 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11579 DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map
,
11580 doc
: /* Keymap of key translations that can override keymaps.
11581 This keymap works like `function-key-map', but comes after that,
11582 and its non-prefix bindings override ordinary bindings.
11584 `key-translation-map' has a separate binding for each display device.
11585 (See Info node `(elisp)Multiple displays'.) If you need to set a key
11586 translation on all devices, change `global-key-translation-map' instead.
11588 Note that the currently selected frame has very little to do with
11589 which binding of this variable is active at any given moment. If you
11590 need set or get the binding on a specific display, use
11591 `terminal-local-value' and `set-terminal-local-value'. */);
11593 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
11594 doc
: /* The parent keymap of all `local-key-translation-map' instances.
11595 Key translations that apply to all display devices should go here. */);
11596 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11598 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11599 doc
: /* List of deferred actions to be performed at a later time.
11600 The precise format isn't relevant here; we just check whether it is nil. */);
11601 Vdeferred_action_list
= Qnil
;
11603 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11604 doc
: /* Function to call to handle deferred actions, after each command.
11605 This function is called with no arguments after each command
11606 whenever `deferred-action-list' is non-nil. */);
11607 Vdeferred_action_function
= Qnil
;
11609 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11610 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11611 The value can be a length of time to show the message for.
11612 If the value is non-nil and not a number, we wait 2 seconds. */);
11613 Vsuggest_key_bindings
= Qt
;
11615 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11616 doc
: /* List of active absolute time timers in order of increasing time. */);
11617 Vtimer_list
= Qnil
;
11619 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11620 doc
: /* List of active idle-time timers in order of increasing time. */);
11621 Vtimer_idle_list
= Qnil
;
11623 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11624 doc
: /* If non-nil, the function that implements the current input method.
11625 It's called with one argument, a printing character that was just read.
11626 \(That means a character with code 040...0176.)
11627 Typically this function uses `read-event' to read additional events.
11628 When it does so, it should first bind `input-method-function' to nil
11629 so it will not be called recursively.
11631 The function should return a list of zero or more events
11632 to be used as input. If it wants to put back some events
11633 to be reconsidered, separately, by the input method,
11634 it can add them to the beginning of `unread-command-events'.
11636 The input method function can find in `input-method-previous-method'
11637 the previous echo area message.
11639 The input method function should refer to the variables
11640 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11641 for guidance on what to do. */);
11642 Vinput_method_function
= Qnil
;
11644 DEFVAR_LISP ("input-method-previous-message",
11645 &Vinput_method_previous_message
,
11646 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11647 This variable exists because `read-event' clears the echo area
11648 before running the input method. It is nil if there was no message. */);
11649 Vinput_method_previous_message
= Qnil
;
11651 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11652 doc
: /* If non-nil, the function that implements the display of help.
11653 It's called with one argument, the help string to display. */);
11654 Vshow_help_function
= Qnil
;
11656 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11657 doc
: /* If non-nil, suppress point adjustment after executing a command.
11659 After a command is executed, if point is moved into a region that has
11660 special properties (e.g. composition, display), we adjust point to
11661 the boundary of the region. But, when a command sets this variable to
11662 non-nil, we suppress the point adjustment.
11664 This variable is set to nil before reading a command, and is checked
11665 just after executing the command. */);
11666 Vdisable_point_adjustment
= Qnil
;
11668 DEFVAR_LISP ("global-disable-point-adjustment",
11669 &Vglobal_disable_point_adjustment
,
11670 doc
: /* *If non-nil, always suppress point adjustment.
11672 The default value is nil, in which case, point adjustment are
11673 suppressed only after special commands that set
11674 `disable-point-adjustment' (which see) to non-nil. */);
11675 Vglobal_disable_point_adjustment
= Qnil
;
11677 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11678 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11679 If the value is not a number, such messages don't time out. */);
11680 Vminibuffer_message_timeout
= make_number (2);
11682 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11683 doc
: /* If non-nil, any keyboard input throws to this symbol.
11684 The value of that variable is passed to `quit-flag' and later causes a
11685 peculiar kind of quitting. */);
11686 Vthrow_on_input
= Qnil
;
11690 keys_of_keyboard ()
11692 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11693 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11694 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11695 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11696 initial_define_key (meta_map
, 'x', "execute-extended-command");
11698 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11699 "handle-delete-frame");
11700 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11701 current-prefix-arg, as is done in `handle-switch-frame'.
11702 But `handle-switch-frame is not run from the special-map.
11703 Commands from that map are run in a special way that automatically
11704 preserves the prefix-arg. Restoring the prefix arg here is not just
11705 redundant but harmful:
11707 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11708 - after the first prompt, the exit-minibuffer-hook is run which may
11709 iconify a frame and thus push a `iconify-frame' event.
11710 - after running exit-minibuffer-hook, current-prefix-arg is
11711 restored to the non-nil value it had before the prompt.
11712 - we enter the second prompt.
11713 current-prefix-arg is non-nil, prefix-arg is nil.
11714 - before running the first real event, we run the special iconify-frame
11715 event, but we pass the `special' arg to execute-command so
11716 current-prefix-arg and prefix-arg are left untouched.
11717 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11718 - the next key event will have a spuriously non-nil current-prefix-arg. */
11719 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11721 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11723 /* Handling it at such a low-level causes read_key_sequence to get
11724 * confused because it doesn't realize that the current_buffer was
11725 * changed by read_char.
11727 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11728 * "handle-select-window"); */
11729 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11730 "handle-save-session");
11733 /* Mark the pointers in the kboard objects.
11734 Called by the Fgarbage_collector. */
11740 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11742 if (kb
->kbd_macro_buffer
)
11743 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11745 mark_object (kb
->Voverriding_terminal_local_map
);
11746 mark_object (kb
->Vlast_command
);
11747 mark_object (kb
->Vreal_last_command
);
11748 mark_object (kb
->Vprefix_arg
);
11749 mark_object (kb
->Vlast_prefix_arg
);
11750 mark_object (kb
->kbd_queue
);
11751 mark_object (kb
->defining_kbd_macro
);
11752 mark_object (kb
->Vlast_kbd_macro
);
11753 mark_object (kb
->Vsystem_key_alist
);
11754 mark_object (kb
->system_key_syms
);
11755 mark_object (kb
->Vlocal_function_key_map
);
11756 mark_object (kb
->Vlocal_key_translation_map
);
11757 mark_object (kb
->Vdefault_minibuffer_frame
);
11758 mark_object (kb
->echo_string
);
11761 struct input_event
*event
;
11762 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11764 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11765 event
= kbd_buffer
;
11766 if (event
->kind
!= SELECTION_REQUEST_EVENT
11767 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11769 mark_object (event
->x
);
11770 mark_object (event
->y
);
11772 mark_object (event
->frame_or_window
);
11773 mark_object (event
->arg
);
11778 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11779 (do not change this comment) */