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 /* Non-zero means force key bindings update in parse_menu_item. */
469 int update_menu_bindings
;
471 extern char *pending_malloc_warning
;
473 /* Circular buffer for pre-read keyboard input. */
475 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
477 /* Pointer to next available character in kbd_buffer.
478 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
479 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
480 next available char is in kbd_buffer[0]. */
481 static struct input_event
*kbd_fetch_ptr
;
483 /* Pointer to next place to store character in kbd_buffer. This
484 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
485 character should go in kbd_buffer[0]. */
486 static struct input_event
* volatile kbd_store_ptr
;
488 /* The above pair of variables forms a "queue empty" flag. When we
489 enqueue a non-hook event, we increment kbd_store_ptr. When we
490 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
491 there is input available iff the two pointers are not equal.
493 Why not just have a flag set and cleared by the enqueuing and
494 dequeuing functions? Such a flag could be screwed up by interrupts
495 at inopportune times. */
497 /* If this flag is non-nil, we check mouse_moved to see when the
498 mouse moves, and motion events will appear in the input stream.
499 Otherwise, mouse motion is ignored. */
500 Lisp_Object do_mouse_tracking
;
502 /* Symbols to head events. */
503 Lisp_Object Qmouse_movement
;
504 Lisp_Object Qscroll_bar_movement
;
505 Lisp_Object Qswitch_frame
;
506 Lisp_Object Qdelete_frame
;
507 Lisp_Object Qiconify_frame
;
508 Lisp_Object Qmake_frame_visible
;
509 Lisp_Object Qselect_window
;
510 Lisp_Object Qhelp_echo
;
513 Lisp_Object Qmouse_fixup_help_message
;
516 /* Symbols to denote kinds of events. */
517 Lisp_Object Qfunction_key
;
518 Lisp_Object Qmouse_click
;
519 #if defined (WINDOWSNT) || defined (MAC_OS)
520 Lisp_Object Qlanguage_change
;
522 Lisp_Object Qdrag_n_drop
;
523 Lisp_Object Qsave_session
;
525 /* Lisp_Object Qmouse_movement; - also an event header */
527 /* Properties of event headers. */
528 Lisp_Object Qevent_kind
;
529 Lisp_Object Qevent_symbol_elements
;
531 /* menu item parts */
532 Lisp_Object Qmenu_alias
;
533 Lisp_Object Qmenu_enable
;
534 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
535 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
536 extern Lisp_Object Vdefine_key_rebound_commands
;
537 extern Lisp_Object Qmenu_item
;
539 /* An event header symbol HEAD may have a property named
540 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
541 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
542 mask of modifiers applied to it. If present, this is used to help
543 speed up parse_modifiers. */
544 Lisp_Object Qevent_symbol_element_mask
;
546 /* An unmodified event header BASE may have a property named
547 Qmodifier_cache, which is an alist mapping modifier masks onto
548 modified versions of BASE. If present, this helps speed up
550 Lisp_Object Qmodifier_cache
;
552 /* Symbols to use for parts of windows. */
553 Lisp_Object Qmode_line
;
554 Lisp_Object Qvertical_line
;
555 Lisp_Object Qvertical_scroll_bar
;
556 Lisp_Object Qmenu_bar
;
557 extern Lisp_Object Qleft_margin
, Qright_margin
;
558 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
559 extern Lisp_Object QCmap
;
561 Lisp_Object
recursive_edit_unwind (), command_loop ();
562 Lisp_Object
Fthis_command_keys ();
563 Lisp_Object Qextended_command_history
;
564 EMACS_TIME
timer_check ();
566 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
568 extern char *x_get_keysym_name ();
570 static void record_menu_key ();
571 static int echo_length ();
573 Lisp_Object Qpolling_period
;
575 /* List of absolute timers. Appears in order of next scheduled event. */
576 Lisp_Object Vtimer_list
;
578 /* List of idle time timers. Appears in order of next scheduled event. */
579 Lisp_Object Vtimer_idle_list
;
581 /* Incremented whenever a timer is run. */
584 extern Lisp_Object Vprint_level
, Vprint_length
;
586 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
588 EMACS_TIME
*input_available_clear_time
;
590 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
591 Default is 1 if INTERRUPT_INPUT is defined. */
594 /* Nonzero while interrupts are temporarily deferred during redisplay. */
595 int interrupts_deferred
;
597 /* Allow m- file to inhibit use of FIONREAD. */
598 #ifdef BROKEN_FIONREAD
602 /* We are unable to use interrupts if FIONREAD is not available,
603 so flush SIGIO so we won't try. */
604 #if !defined (FIONREAD)
610 /* If we support a window system, turn on the code to poll periodically
611 to detect C-g. It isn't actually used when doing interrupt input. */
612 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
613 #define POLL_FOR_INPUT
616 /* After a command is executed, if point is moved into a region that
617 has specific properties (e.g. composition, display), we adjust
618 point to the boundary of the region. But, if a command sets this
619 variable to non-nil, we suppress this point adjustment. This
620 variable is set to nil before reading a command. */
622 Lisp_Object Vdisable_point_adjustment
;
624 /* If non-nil, always disable point adjustment. */
626 Lisp_Object Vglobal_disable_point_adjustment
;
628 /* The time when Emacs started being idle. */
630 static EMACS_TIME timer_idleness_start_time
;
632 /* After Emacs stops being idle, this saves the last value
633 of timer_idleness_start_time from when it was idle. */
635 static EMACS_TIME timer_last_idleness_start_time
;
638 /* Global variable declarations. */
640 /* Flags for readable_events. */
641 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
642 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
643 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
645 /* Function for init_keyboard to call with no args (if nonzero). */
646 void (*keyboard_init_hook
) ();
648 static int read_avail_input
P_ ((int));
649 static void get_input_pending
P_ ((int *, int));
650 static int readable_events
P_ ((int));
651 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
652 Lisp_Object
, int *));
653 static Lisp_Object
read_char_x_menu_prompt ();
654 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
656 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
658 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
659 enum scroll_bar_part
,
660 Lisp_Object
, Lisp_Object
,
663 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
664 Lisp_Object
, char **,
665 Lisp_Object
*, unsigned));
666 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
667 static int parse_solitary_modifier
P_ ((Lisp_Object
));
668 static int parse_solitary_modifier ();
669 static void save_getcjmp
P_ ((jmp_buf));
670 static void save_getcjmp ();
671 static void restore_getcjmp
P_ ((jmp_buf));
672 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
673 static void clear_event
P_ ((struct input_event
*));
674 static void any_kboard_state
P_ ((void));
675 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
676 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
677 static void handle_interrupt
P_ ((void));
678 static void timer_start_idle
P_ ((void));
679 static void timer_stop_idle
P_ ((void));
680 static void timer_resume_idle
P_ ((void));
682 /* Nonzero means don't try to suspend even if the operating system seems
684 static int cannot_suspend
;
686 extern Lisp_Object Qidentity
, Qonly
;
688 /* Install the string STR as the beginning of the string of echoing,
689 so that it serves as a prompt for the next character.
690 Also start echoing. */
696 current_kboard
->echo_string
= str
;
697 current_kboard
->echo_after_prompt
= SCHARS (str
);
701 /* Add C to the echo string, if echoing is going on.
702 C can be a character, which is printed prettily ("M-C-x" and all that
703 jazz), or a symbol, whose name is printed. */
709 if (current_kboard
->immediate_echo
)
711 int size
= KEY_DESCRIPTION_SIZE
+ 100;
712 char *buffer
= (char *) alloca (size
);
714 Lisp_Object echo_string
;
716 echo_string
= current_kboard
->echo_string
;
718 /* If someone has passed us a composite event, use its head symbol. */
723 ptr
= push_key_description (XINT (c
), ptr
, 1);
725 else if (SYMBOLP (c
))
727 Lisp_Object name
= SYMBOL_NAME (c
);
728 int nbytes
= SBYTES (name
);
730 if (size
- (ptr
- buffer
) < nbytes
)
732 int offset
= ptr
- buffer
;
733 size
= max (2 * size
, size
+ nbytes
);
734 buffer
= (char *) alloca (size
);
735 ptr
= buffer
+ offset
;
738 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
739 STRING_MULTIBYTE (name
), 1);
742 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
745 const char *text
= " (Type ? for further options)";
746 int len
= strlen (text
);
748 if (size
- (ptr
- buffer
) < len
)
750 int offset
= ptr
- buffer
;
752 buffer
= (char *) alloca (size
);
753 ptr
= buffer
+ offset
;
756 bcopy (text
, ptr
, len
);
760 /* Replace a dash from echo_dash with a space, otherwise
761 add a space at the end as a separator between keys. */
762 if (STRINGP (echo_string
)
763 && SCHARS (echo_string
) > 1)
765 Lisp_Object last_char
, prev_char
, idx
;
767 idx
= make_number (SCHARS (echo_string
) - 2);
768 prev_char
= Faref (echo_string
, idx
);
770 idx
= make_number (SCHARS (echo_string
) - 1);
771 last_char
= Faref (echo_string
, idx
);
773 /* We test PREV_CHAR to make sure this isn't the echoing
775 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
776 Faset (echo_string
, idx
, make_number (' '));
778 echo_string
= concat2 (echo_string
, build_string (" "));
781 current_kboard
->echo_string
782 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
788 /* Temporarily add a dash to the end of the echo string if it's not
789 empty, so that it serves as a mini-prompt for the very next character. */
794 /* Do nothing if not echoing at all. */
795 if (NILP (current_kboard
->echo_string
))
798 if (!current_kboard
->immediate_echo
799 && SCHARS (current_kboard
->echo_string
) == 0)
802 /* Do nothing if we just printed a prompt. */
803 if (current_kboard
->echo_after_prompt
804 == SCHARS (current_kboard
->echo_string
))
807 /* Do nothing if we have already put a dash at the end. */
808 if (SCHARS (current_kboard
->echo_string
) > 1)
810 Lisp_Object last_char
, prev_char
, idx
;
812 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
813 prev_char
= Faref (current_kboard
->echo_string
, idx
);
815 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
816 last_char
= Faref (current_kboard
->echo_string
, idx
);
818 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
822 /* Put a dash at the end of the buffer temporarily,
823 but make it go away when the next character is added. */
824 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
829 /* Display the current echo string, and begin echoing if not already
835 if (!current_kboard
->immediate_echo
)
838 current_kboard
->immediate_echo
= 1;
840 for (i
= 0; i
< this_command_key_count
; i
++)
844 /* Set before_command_echo_length to the value that would
845 have been saved before the start of this subcommand in
846 command_loop_1, if we had already been echoing then. */
847 if (i
== this_single_command_key_start
)
848 before_command_echo_length
= echo_length ();
850 c
= XVECTOR (this_command_keys
)->contents
[i
];
851 if (! (EVENT_HAS_PARAMETERS (c
)
852 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
856 /* Set before_command_echo_length to the value that would
857 have been saved before the start of this subcommand in
858 command_loop_1, if we had already been echoing then. */
859 if (this_command_key_count
== this_single_command_key_start
)
860 before_command_echo_length
= echo_length ();
862 /* Put a dash at the end to invite the user to type more. */
867 message3_nolog (current_kboard
->echo_string
,
868 SBYTES (current_kboard
->echo_string
),
869 STRING_MULTIBYTE (current_kboard
->echo_string
));
872 /* Record in what buffer we echoed, and from which kboard. */
873 echo_message_buffer
= echo_area_buffer
[0];
874 echo_kboard
= current_kboard
;
876 if (waiting_for_input
&& !NILP (Vquit_flag
))
877 quit_throw_to_read_char ();
880 /* Turn off echoing, for the start of a new command. */
885 current_kboard
->immediate_echo
= 0;
886 current_kboard
->echo_after_prompt
= -1;
887 current_kboard
->echo_string
= Qnil
;
888 ok_to_echo_at_next_pause
= NULL
;
890 echo_message_buffer
= Qnil
;
893 /* Return the length of the current echo string. */
898 return (STRINGP (current_kboard
->echo_string
)
899 ? SCHARS (current_kboard
->echo_string
)
903 /* Truncate the current echo message to its first LEN chars.
904 This and echo_char get used by read_key_sequence when the user
905 switches frames while entering a key sequence. */
908 echo_truncate (nchars
)
911 if (STRINGP (current_kboard
->echo_string
))
912 current_kboard
->echo_string
913 = Fsubstring (current_kboard
->echo_string
,
914 make_number (0), make_number (nchars
));
915 truncate_echo_area (nchars
);
919 /* Functions for manipulating this_command_keys. */
921 add_command_key (key
)
924 #if 0 /* Not needed after we made Freset_this_command_lengths
925 do the job immediately. */
926 /* If reset-this-command-length was called recently, obey it now.
927 See the doc string of that function for an explanation of why. */
928 if (before_command_restore_flag
)
930 this_command_key_count
= before_command_key_count_1
;
931 if (this_command_key_count
< this_single_command_key_start
)
932 this_single_command_key_start
= this_command_key_count
;
933 echo_truncate (before_command_echo_length_1
);
934 before_command_restore_flag
= 0;
938 if (this_command_key_count
>= ASIZE (this_command_keys
))
939 this_command_keys
= larger_vector (this_command_keys
,
940 2 * ASIZE (this_command_keys
),
943 AREF (this_command_keys
, this_command_key_count
) = key
;
944 ++this_command_key_count
;
951 int count
= SPECPDL_INDEX ();
954 if (command_loop_level
> 0)
956 specbind (Qstandard_output
, Qt
);
957 specbind (Qstandard_input
, Qt
);
960 #ifdef HAVE_X_WINDOWS
961 /* The command loop has started an hourglass timer, so we have to
962 cancel it here, otherwise it will fire because the recursive edit
963 can take some time. Do not check for display_hourglass_p here,
964 because it could already be nil. */
968 /* This function may have been called from a debugger called from
969 within redisplay, for instance by Edebugging a function called
970 from fontification-functions. We want to allow redisplay in
971 the debugging session.
973 The recursive edit is left with a `(throw exit ...)'. The `exit'
974 tag is not caught anywhere in redisplay, i.e. when we leave the
975 recursive edit, the original redisplay leading to the recursive
976 edit will be unwound. The outcome should therefore be safe. */
977 specbind (Qinhibit_redisplay
, Qnil
);
980 val
= command_loop ();
982 Fsignal (Qquit
, Qnil
);
983 /* Handle throw from read_minibuf when using minibuffer
984 while it's active but we're in another window. */
986 Fsignal (Qerror
, Fcons (val
, Qnil
));
988 return unbind_to (count
, Qnil
);
991 /* When an auto-save happens, record the "time", and don't do again soon. */
996 last_auto_save
= num_nonmacro_input_events
;
999 /* Make an auto save happen as soon as possible at command level. */
1002 force_auto_save_soon ()
1004 last_auto_save
= - auto_save_interval
- 1;
1006 record_asynch_buffer_change ();
1009 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1010 doc
: /* Invoke the editor command loop recursively.
1011 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1012 that tells this function to return.
1013 Alternatively, `(throw 'exit t)' makes this function signal an error.
1014 This function is called by the editor initialization to begin editing. */)
1017 int count
= SPECPDL_INDEX ();
1020 /* If we enter while input is blocked, don't lock up here.
1021 This may happen through the debugger during redisplay. */
1022 if (INPUT_BLOCKED_P
)
1025 command_loop_level
++;
1026 update_mode_lines
= 1;
1028 if (command_loop_level
1029 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1030 buffer
= Fcurrent_buffer ();
1034 /* If we leave recursive_edit_1 below with a `throw' for instance,
1035 like it is done in the splash screen display, we have to
1036 make sure that we restore single_kboard as command_loop_1
1037 would have done if it were left normally. */
1038 temporarily_switch_to_single_kboard (FRAME_KBOARD (SELECTED_FRAME ()));
1039 record_unwind_protect (recursive_edit_unwind
, buffer
);
1041 recursive_edit_1 ();
1042 return unbind_to (count
, Qnil
);
1046 recursive_edit_unwind (buffer
)
1049 if (BUFFERP (buffer
))
1050 Fset_buffer (buffer
);
1052 command_loop_level
--;
1053 update_mode_lines
= 1;
1062 #if 0 /* Theory: if there's anything in Vunread_command_events,
1063 it will right away be read by read_key_sequence,
1064 and then if we do switch KBOARDS, it will go into the side
1065 queue then. So we don't need to do anything special here -- rms. */
1066 if (CONSP (Vunread_command_events
))
1068 current_kboard
->kbd_queue
1069 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1070 current_kboard
->kbd_queue_has_data
= 1;
1072 Vunread_command_events
= Qnil
;
1078 /* Switch to the single-kboard state, making current_kboard
1079 the only KBOARD from which further input is accepted. */
1082 single_kboard_state ()
1089 /* If we're in single_kboard state for kboard KBOARD,
1093 not_single_kboard_state (kboard
)
1097 if (kboard
== current_kboard
)
1102 /* Maintain a stack of kboards, so other parts of Emacs
1103 can switch temporarily to the kboard of a given frame
1104 and then revert to the previous status. */
1109 struct kboard_stack
*next
;
1112 static struct kboard_stack
*kboard_stack
;
1119 struct kboard_stack
*p
1120 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1122 p
->next
= kboard_stack
;
1123 p
->kboard
= current_kboard
;
1131 push_frame_kboard (f
)
1134 push_kboard (f
->device
->kboard
);
1142 struct kboard_stack
*p
= kboard_stack
;
1144 current_kboard
= NULL
;
1145 for (d
= device_list
; d
; d
= d
->next_device
)
1147 if (d
->kboard
== p
->kboard
)
1149 current_kboard
= p
->kboard
;
1153 if (current_kboard
== NULL
)
1155 /* The display we remembered has been deleted. */
1156 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1158 kboard_stack
= p
->next
;
1163 /* Switch to single_kboard mode. If K is non-nil, set it as the
1164 current keyboard. Use record_unwind_protect to return to the
1165 previous state later. */
1168 temporarily_switch_to_single_kboard (k
)
1172 int was_locked
= single_kboard
;
1176 push_kboard (current_kboard
);
1177 single_kboard_state ();
1178 record_unwind_protect (restore_kboard_configuration
,
1179 (was_locked
? Qt
: Qnil
));
1184 record_single_kboard_state ()
1186 push_kboard (current_kboard
);
1187 record_unwind_protect (restore_kboard_configuration
,
1188 (single_kboard
? Qt
: Qnil
));
1192 restore_kboard_configuration (was_locked
)
1193 Lisp_Object was_locked
;
1195 if (NILP (was_locked
))
1196 any_kboard_state ();
1198 single_kboard_state ();
1203 /* Handle errors that are not handled at inner levels
1204 by printing an error message and returning to the editor command loop. */
1210 Lisp_Object old_level
, old_length
;
1211 char macroerror
[50];
1213 #ifdef HAVE_X_WINDOWS
1214 if (display_hourglass_p
)
1215 cancel_hourglass ();
1218 if (!NILP (executing_kbd_macro
))
1220 if (executing_kbd_macro_iterations
== 1)
1221 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1223 sprintf (macroerror
, "After %d kbd macro iterations: ",
1224 executing_kbd_macro_iterations
);
1229 Vstandard_output
= Qt
;
1230 Vstandard_input
= Qt
;
1231 Vexecuting_kbd_macro
= Qnil
;
1232 executing_kbd_macro
= Qnil
;
1233 current_kboard
->Vprefix_arg
= Qnil
;
1234 current_kboard
->Vlast_prefix_arg
= Qnil
;
1237 /* Avoid unquittable loop if data contains a circular list. */
1238 old_level
= Vprint_level
;
1239 old_length
= Vprint_length
;
1240 XSETFASTINT (Vprint_level
, 10);
1241 XSETFASTINT (Vprint_length
, 10);
1242 cmd_error_internal (data
, macroerror
);
1243 Vprint_level
= old_level
;
1244 Vprint_length
= old_length
;
1248 Vinhibit_quit
= Qnil
;
1250 if (command_loop_level
== 0 && minibuf_level
== 0)
1251 any_kboard_state ();
1254 return make_number (0);
1257 /* Take actions on handling an error. DATA is the data that describes
1260 CONTEXT is a C-string containing ASCII characters only which
1261 describes the context in which the error happened. If we need to
1262 generalize CONTEXT to allow multibyte characters, make it a Lisp
1266 cmd_error_internal (data
, context
)
1271 int kill_emacs_p
= 0;
1272 struct frame
*sf
= SELECTED_FRAME ();
1276 clear_message (1, 0);
1278 /* If the window system or terminal frame hasn't been initialized
1279 yet, or we're not interactive, it's best to dump this message out
1280 to stderr and exit. */
1281 if (!sf
->glyphs_initialized_p
1282 || FRAME_INITIAL_P (sf
)
1285 stream
= Qexternal_debugging_output
;
1291 message_log_maybe_newline ();
1296 /* The immediate context is not interesting for Quits,
1297 since they are asyncronous. */
1298 if (EQ (XCAR (data
), Qquit
))
1299 Vsignaling_function
= Qnil
;
1301 print_error_message (data
, stream
, context
, Vsignaling_function
);
1303 Vsignaling_function
= Qnil
;
1305 /* If the window system or terminal frame hasn't been initialized
1306 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1310 Fkill_emacs (make_number (-1));
1314 Lisp_Object
command_loop_1 ();
1315 Lisp_Object
command_loop_2 ();
1316 Lisp_Object
top_level_1 ();
1318 /* Entry to editor-command-loop.
1319 This level has the catches for exiting/returning to editor command loop.
1320 It returns nil to exit recursive edit, t to abort it. */
1325 if (command_loop_level
> 0 || minibuf_level
> 0)
1328 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1329 executing_kbd_macro
= Qnil
;
1335 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1336 /* Reset single_kboard in case top-level set it while
1337 evaluating an -f option, or we are stuck there for some
1339 any_kboard_state ();
1340 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1341 executing_kbd_macro
= Qnil
;
1343 /* End of file in -batch run causes exit here. */
1349 /* Here we catch errors in execution of commands within the
1350 editing loop, and reenter the editing loop.
1351 When there is an error, cmd_error runs and returns a non-nil
1352 value to us. A value of nil means that command_loop_1 itself
1353 returned due to end of file (or end of kbd macro). */
1358 register Lisp_Object val
;
1361 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1362 while (!NILP (val
));
1370 return Feval (Vtop_level
);
1376 /* On entry to the outer level, run the startup file */
1377 if (!NILP (Vtop_level
))
1378 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1379 else if (!NILP (Vpurify_flag
))
1380 message ("Bare impure Emacs (standard Lisp code not loaded)");
1382 message ("Bare Emacs (standard Lisp code not loaded)");
1386 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1387 doc
: /* Exit all recursive editing levels. */)
1390 #ifdef HAVE_X_WINDOWS
1391 if (display_hourglass_p
)
1392 cancel_hourglass ();
1395 /* Unblock input if we enter with input blocked. This may happen if
1396 redisplay traps e.g. during tool-bar update with input blocked. */
1397 while (INPUT_BLOCKED_P
)
1400 return Fthrow (Qtop_level
, Qnil
);
1403 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1404 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1407 if (command_loop_level
> 0 || minibuf_level
> 0)
1408 Fthrow (Qexit
, Qnil
);
1410 error ("No recursive edit is in progress");
1414 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1415 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1418 if (command_loop_level
> 0 || minibuf_level
> 0)
1421 error ("No recursive edit is in progress");
1425 /* This is the actual command reading loop,
1426 sans error-handling encapsulation. */
1428 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1430 void safe_run_hooks
P_ ((Lisp_Object
));
1431 static void adjust_point_for_property
P_ ((int, int));
1433 /* Cancel hourglass from protect_unwind.
1435 #ifdef HAVE_X_WINDOWS
1437 cancel_hourglass_unwind (arg
)
1440 cancel_hourglass ();
1451 Lisp_Object keybuf
[30];
1454 int prev_modiff
= 0;
1455 struct buffer
*prev_buffer
= NULL
;
1457 int was_locked
= single_kboard
;
1459 int already_adjusted
= 0;
1461 current_kboard
->Vprefix_arg
= Qnil
;
1462 current_kboard
->Vlast_prefix_arg
= Qnil
;
1463 Vdeactivate_mark
= Qnil
;
1464 waiting_for_input
= 0;
1468 this_command_key_count
= 0;
1469 this_command_key_count_reset
= 0;
1470 this_single_command_key_start
= 0;
1472 if (NILP (Vmemory_full
))
1474 /* Make sure this hook runs after commands that get errors and
1475 throw to top level. */
1476 /* Note that the value cell will never directly contain nil
1477 if the symbol is a local variable. */
1478 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1479 safe_run_hooks (Qpost_command_hook
);
1481 /* If displaying a message, resize the echo area window to fit
1482 that message's size exactly. */
1483 if (!NILP (echo_area_buffer
[0]))
1484 resize_echo_area_exactly ();
1486 if (!NILP (Vdeferred_action_list
))
1487 safe_run_hooks (Qdeferred_action_function
);
1490 Vmemory_full
= Qnil
;
1492 /* Do this after running Vpost_command_hook, for consistency. */
1493 current_kboard
->Vlast_command
= Vthis_command
;
1494 current_kboard
->Vreal_last_command
= real_this_command
;
1498 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1501 /* Make sure the current window's buffer is selected. */
1502 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1503 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1505 /* Display any malloc warning that just came out. Use while because
1506 displaying one warning can cause another. */
1508 while (pending_malloc_warning
)
1509 display_malloc_warning ();
1513 Vdeactivate_mark
= Qnil
;
1515 /* If minibuffer on and echo area in use,
1516 wait a short time and redraw minibuffer. */
1519 && !NILP (echo_area_buffer
[0])
1520 && EQ (minibuf_window
, echo_area_window
)
1521 && NUMBERP (Vminibuffer_message_timeout
))
1523 /* Bind inhibit-quit to t so that C-g gets read in
1524 rather than quitting back to the minibuffer. */
1525 int count
= SPECPDL_INDEX ();
1526 specbind (Qinhibit_quit
, Qt
);
1528 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1529 /* Clear the echo area. */
1531 safe_run_hooks (Qecho_area_clear_hook
);
1533 unbind_to (count
, Qnil
);
1535 /* If a C-g came in before, treat it as input now. */
1536 if (!NILP (Vquit_flag
))
1539 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1544 alloca (0); /* Cause a garbage collection now */
1545 /* Since we can free the most stuff here. */
1546 #endif /* C_ALLOCA */
1549 /* Select the frame that the last event came from. Usually,
1550 switch-frame events will take care of this, but if some lisp
1551 code swallows a switch-frame event, we'll fix things up here.
1552 Is this a good idea? */
1553 if (FRAMEP (internal_last_event_frame
)
1554 && !EQ (internal_last_event_frame
, selected_frame
))
1555 Fselect_frame (internal_last_event_frame
);
1557 /* If it has changed current-menubar from previous value,
1558 really recompute the menubar from the value. */
1559 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1560 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1561 call0 (Qrecompute_lucid_menubar
);
1563 before_command_key_count
= this_command_key_count
;
1564 before_command_echo_length
= echo_length ();
1566 Vthis_command
= Qnil
;
1567 real_this_command
= Qnil
;
1568 Vthis_original_command
= Qnil
;
1570 /* Read next key sequence; i gets its length. */
1571 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1574 /* A filter may have run while we were reading the input. */
1575 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1577 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1578 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1582 /* Now we have read a key sequence of length I,
1583 or else I is 0 and we found end of file. */
1585 if (i
== 0) /* End of file -- happens only in */
1586 return Qnil
; /* a kbd macro, at the end. */
1587 /* -1 means read_key_sequence got a menu that was rejected.
1588 Just loop around and read another command. */
1592 this_command_key_count
= 0;
1593 this_command_key_count_reset
= 0;
1594 this_single_command_key_start
= 0;
1598 last_command_char
= keybuf
[i
- 1];
1600 /* If the previous command tried to force a specific window-start,
1601 forget about that, in case this command moves point far away
1602 from that position. But also throw away beg_unchanged and
1603 end_unchanged information in that case, so that redisplay will
1604 update the whole window properly. */
1605 if (!NILP (XWINDOW (selected_window
)->force_start
))
1608 XWINDOW (selected_window
)->force_start
= Qnil
;
1609 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1610 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1613 cmd
= read_key_sequence_cmd
;
1614 if (!NILP (Vexecuting_kbd_macro
))
1616 if (!NILP (Vquit_flag
))
1618 Vexecuting_kbd_macro
= Qt
;
1619 QUIT
; /* Make some noise. */
1620 /* Will return since macro now empty. */
1624 /* Do redisplay processing after this command except in special
1625 cases identified below. */
1626 prev_buffer
= current_buffer
;
1627 prev_modiff
= MODIFF
;
1628 last_point_position
= PT
;
1629 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1631 /* By default, we adjust point to a boundary of a region that
1632 has such a property that should be treated intangible
1633 (e.g. composition, display). But, some commands will set
1634 this variable differently. */
1635 Vdisable_point_adjustment
= Qnil
;
1637 /* Process filters and timers may have messed with deactivate-mark.
1638 reset it before we execute the command. */
1639 Vdeactivate_mark
= Qnil
;
1641 /* Remap command through active keymaps */
1642 Vthis_original_command
= cmd
;
1646 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1650 /* Execute the command. */
1652 Vthis_command
= cmd
;
1653 real_this_command
= cmd
;
1654 /* Note that the value cell will never directly contain nil
1655 if the symbol is a local variable. */
1656 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1657 safe_run_hooks (Qpre_command_hook
);
1659 already_adjusted
= 0;
1661 if (NILP (Vthis_command
))
1663 /* nil means key is undefined. */
1664 Lisp_Object keys
= Fvector (i
, keybuf
);
1665 keys
= Fkey_description (keys
, Qnil
);
1667 message_with_string ("%s is undefined", keys
, 0);
1668 current_kboard
->defining_kbd_macro
= Qnil
;
1669 update_mode_lines
= 1;
1670 current_kboard
->Vprefix_arg
= Qnil
;
1674 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1676 /* In case we jump to directly_done. */
1677 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1679 /* Recognize some common commands in common situations and
1680 do them directly. */
1681 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1683 struct Lisp_Char_Table
*dp
1684 = window_display_table (XWINDOW (selected_window
));
1685 lose
= FETCH_CHAR (PT_BYTE
);
1687 if (! NILP (Vpost_command_hook
))
1688 /* Put this before calling adjust_point_for_property
1689 so it will only get called once in any case. */
1691 if (current_buffer
== prev_buffer
1692 && last_point_position
!= PT
1693 && NILP (Vdisable_point_adjustment
)
1694 && NILP (Vglobal_disable_point_adjustment
))
1695 adjust_point_for_property (last_point_position
, 0);
1696 already_adjusted
= 1;
1697 if (PT
== last_point_position
+ 1
1699 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1700 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1701 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1702 && (lose
>= 0x20 && lose
< 0x7f)))
1703 : (lose
>= 0x20 && lose
< 0x7f))
1704 /* To extract the case of continuation on
1705 wide-column characters. */
1706 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1707 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1709 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1711 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1713 && !windows_or_buffers_changed
1714 && EQ (current_buffer
->selective_display
, Qnil
)
1715 && !detect_input_pending ()
1716 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1717 && NILP (Vexecuting_kbd_macro
))
1718 direct_output_forward_char (1);
1721 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1723 struct Lisp_Char_Table
*dp
1724 = window_display_table (XWINDOW (selected_window
));
1726 lose
= FETCH_CHAR (PT_BYTE
);
1727 if (! NILP (Vpost_command_hook
))
1729 if (current_buffer
== prev_buffer
1730 && last_point_position
!= PT
1731 && NILP (Vdisable_point_adjustment
)
1732 && NILP (Vglobal_disable_point_adjustment
))
1733 adjust_point_for_property (last_point_position
, 0);
1734 already_adjusted
= 1;
1735 if (PT
== last_point_position
- 1
1737 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1738 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1739 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1740 && (lose
>= 0x20 && lose
< 0x7f)))
1741 : (lose
>= 0x20 && lose
< 0x7f))
1742 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1744 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1746 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1748 && !windows_or_buffers_changed
1749 && EQ (current_buffer
->selective_display
, Qnil
)
1750 && !detect_input_pending ()
1751 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1752 && NILP (Vexecuting_kbd_macro
))
1753 direct_output_forward_char (-1);
1756 else if (EQ (Vthis_command
, Qself_insert_command
)
1757 /* Try this optimization only on char keystrokes. */
1758 && NATNUMP (last_command_char
)
1759 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1762 = translate_char (Vtranslation_table_for_input
,
1763 XFASTINT (last_command_char
), 0, 0, 0);
1765 if (NILP (Vexecuting_kbd_macro
)
1766 && !EQ (minibuf_window
, selected_window
))
1768 if (!nonundocount
|| nonundocount
>= 20)
1776 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1778 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1780 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1782 || MODIFF
<= SAVE_MODIFF
1783 || windows_or_buffers_changed
1784 || !EQ (current_buffer
->selective_display
, Qnil
)
1785 || detect_input_pending ()
1786 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1787 || !NILP (Vexecuting_kbd_macro
));
1789 value
= internal_self_insert (c
, 0);
1794 if (! NILP (Vpost_command_hook
))
1795 /* Put this before calling adjust_point_for_property
1796 so it will only get called once in any case. */
1799 /* VALUE == 1 when AFTER-CHANGE functions are
1800 installed which is the case most of the time
1801 because FONT-LOCK installs one. */
1802 if (!lose
&& !value
)
1803 direct_output_for_insert (c
);
1808 /* Here for a command that isn't executed directly */
1811 #ifdef HAVE_X_WINDOWS
1812 int scount
= SPECPDL_INDEX ();
1814 if (display_hourglass_p
1815 && NILP (Vexecuting_kbd_macro
))
1817 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1823 if (NILP (current_kboard
->Vprefix_arg
))
1825 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1827 #ifdef HAVE_X_WINDOWS
1828 /* Do not check display_hourglass_p here, because
1829 Fcommand_execute could change it, but we should cancel
1830 hourglass cursor anyway.
1831 But don't cancel the hourglass within a macro
1832 just because a command in the macro finishes. */
1833 if (NILP (Vexecuting_kbd_macro
))
1834 unbind_to (scount
, Qnil
);
1839 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1841 /* Note that the value cell will never directly contain nil
1842 if the symbol is a local variable. */
1843 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1844 safe_run_hooks (Qpost_command_hook
);
1846 /* If displaying a message, resize the echo area window to fit
1847 that message's size exactly. */
1848 if (!NILP (echo_area_buffer
[0]))
1849 resize_echo_area_exactly ();
1851 if (!NILP (Vdeferred_action_list
))
1852 safe_run_hooks (Qdeferred_action_function
);
1854 /* If there is a prefix argument,
1855 1) We don't want Vlast_command to be ``universal-argument''
1856 (that would be dumb), so don't set Vlast_command,
1857 2) we want to leave echoing on so that the prefix will be
1858 echoed as part of this key sequence, so don't call
1860 3) we want to leave this_command_key_count non-zero, so that
1861 read_char will realize that it is re-reading a character, and
1862 not echo it a second time.
1864 If the command didn't actually create a prefix arg,
1865 but is merely a frame event that is transparent to prefix args,
1866 then the above doesn't apply. */
1867 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1869 current_kboard
->Vlast_command
= Vthis_command
;
1870 current_kboard
->Vreal_last_command
= real_this_command
;
1872 this_command_key_count
= 0;
1873 this_command_key_count_reset
= 0;
1874 this_single_command_key_start
= 0;
1877 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1879 /* Setting transient-mark-mode to `only' is a way of
1880 turning it on for just one command. */
1882 if (EQ (Vtransient_mark_mode
, Qidentity
))
1883 Vtransient_mark_mode
= Qnil
;
1884 if (EQ (Vtransient_mark_mode
, Qonly
))
1885 Vtransient_mark_mode
= Qidentity
;
1887 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1889 /* We could also call `deactivate'mark'. */
1890 if (EQ (Vtransient_mark_mode
, Qlambda
))
1891 Vtransient_mark_mode
= Qnil
;
1894 current_buffer
->mark_active
= Qnil
;
1895 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1898 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1899 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1904 if (current_buffer
== prev_buffer
1905 && last_point_position
!= PT
1906 && NILP (Vdisable_point_adjustment
)
1907 && NILP (Vglobal_disable_point_adjustment
)
1908 && !already_adjusted
)
1909 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1911 /* Install chars successfully executed in kbd macro. */
1913 if (!NILP (current_kboard
->defining_kbd_macro
)
1914 && NILP (current_kboard
->Vprefix_arg
))
1915 finalize_kbd_macro_chars ();
1919 any_kboard_state ();
1924 extern Lisp_Object Qcomposition
, Qdisplay
;
1926 /* Adjust point to a boundary of a region that has such a property
1927 that should be treated intangible. For the moment, we check
1928 `composition', `display' and `invisible' properties.
1929 LAST_PT is the last position of point. */
1931 extern Lisp_Object Qafter_string
, Qbefore_string
;
1932 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1935 adjust_point_for_property (last_pt
, modified
)
1940 Lisp_Object val
, overlay
, tmp
;
1941 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1944 /* FIXME: cycling is probably not necessary because these properties
1945 can't be usefully combined anyway. */
1946 while (check_composition
|| check_display
|| check_invisible
)
1948 if (check_composition
1949 && PT
> BEGV
&& PT
< ZV
1950 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1951 && COMPOSITION_VALID_P (beg
, end
, val
)
1952 && beg
< PT
/* && end > PT <- It's always the case. */
1953 && (last_pt
<= beg
|| last_pt
>= end
))
1956 SET_PT (PT
< last_pt
? beg
: end
);
1957 check_display
= check_invisible
= 1;
1959 check_composition
= 0;
1961 && PT
> BEGV
&& PT
< ZV
1962 && !NILP (val
= get_char_property_and_overlay
1963 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1964 && display_prop_intangible_p (val
)
1965 && (!OVERLAYP (overlay
)
1966 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1967 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1968 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1969 && (beg
< PT
/* && end > PT <- It's always the case. */
1970 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1973 SET_PT (PT
< last_pt
1974 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1976 check_composition
= check_invisible
= 1;
1979 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1981 int inv
, ellipsis
= 0;
1984 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1986 && !NILP (val
= get_char_property_and_overlay
1987 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1988 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1990 ellipsis
= ellipsis
|| inv
> 1
1991 || (OVERLAYP (overlay
)
1992 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1993 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1994 tmp
= Fnext_single_char_property_change
1995 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1996 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1999 && !NILP (val
= get_char_property_and_overlay
2000 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
2001 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2003 ellipsis
= ellipsis
|| inv
> 1
2004 || (OVERLAYP (overlay
)
2005 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2006 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2007 tmp
= Fprevious_single_char_property_change
2008 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2009 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2012 /* Move away from the inside area. */
2013 if (beg
< PT
&& end
> PT
)
2015 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2016 /* We haven't moved yet (so we don't need to fear
2017 infinite-looping) and we were outside the range
2018 before (so either end of the range still corresponds
2019 to a move in the right direction): pretend we moved
2020 less than we actually did, so that we still have
2021 more freedom below in choosing which end of the range
2023 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2024 /* We either have moved already or the last point
2025 was already in the range: we don't get to choose
2026 which end of the range we have to go to. */
2027 : (PT
< last_pt
? beg
: end
));
2028 check_composition
= check_display
= 1;
2030 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2031 the point to something other than its argument, due to
2032 point-motion hooks, intangibility, etc. */
2033 xassert (PT
== beg
|| PT
== end
);
2036 /* Pretend the area doesn't exist if the buffer is not
2038 if (!modified
&& !ellipsis
&& beg
< end
)
2040 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2041 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2042 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2043 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2044 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2045 /* We've already moved as far as we can. Trying to go
2046 to the other end would mean moving backwards and thus
2047 could lead to an infinite loop. */
2049 else if (val
= get_pos_property (make_number (PT
),
2051 TEXT_PROP_MEANS_INVISIBLE (val
)
2052 && (val
= get_pos_property
2053 (make_number (PT
== beg
? end
: beg
),
2055 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2056 (check_composition
= check_display
= 1,
2057 SET_PT (PT
== beg
? end
: beg
));
2060 check_invisible
= 0;
2064 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2067 safe_run_hooks_1 (hook
)
2070 return call1 (Vrun_hooks
, Vinhibit_quit
);
2073 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2076 safe_run_hooks_error (data
)
2079 Lisp_Object args
[3];
2080 args
[0] = build_string ("Error in %s: %s");
2081 args
[1] = Vinhibit_quit
;
2084 return Fset (Vinhibit_quit
, Qnil
);
2087 /* If we get an error while running the hook, cause the hook variable
2088 to be nil. Also inhibit quits, so that C-g won't cause the hook
2089 to mysteriously evaporate. */
2092 safe_run_hooks (hook
)
2095 int count
= SPECPDL_INDEX ();
2096 specbind (Qinhibit_quit
, hook
);
2098 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2100 unbind_to (count
, Qnil
);
2104 /* Number of seconds between polling for input. This is a Lisp
2105 variable that can be bound. */
2107 EMACS_INT polling_period
;
2109 /* Nonzero means polling for input is temporarily suppressed. */
2111 int poll_suppress_count
;
2113 /* Asynchronous timer for polling. */
2115 struct atimer
*poll_timer
;
2118 #ifdef POLL_FOR_INPUT
2120 /* Poll for input, so what we catch a C-g if it comes in. This
2121 function is called from x_make_frame_visible, see comment
2127 if (interrupt_input_blocked
== 0
2128 && !waiting_for_input
)
2129 read_avail_input (0);
2132 /* Timer callback function for poll_timer. TIMER is equal to
2136 poll_for_input (timer
)
2137 struct atimer
*timer
;
2139 if (poll_suppress_count
== 0)
2141 interrupt_input_pending
= 1;
2143 poll_for_input_1 ();
2147 #endif /* POLL_FOR_INPUT */
2149 /* Begin signals to poll for input, if they are appropriate.
2150 This function is called unconditionally from various places. */
2155 #ifdef POLL_FOR_INPUT
2156 /* XXX This condition was (read_socket_hook && !interrupt_input),
2157 but read_socket_hook is not global anymore. Let's pretend that
2159 if (!interrupt_input
)
2161 /* Turn alarm handling on unconditionally. It might have
2162 been turned off in process.c. */
2163 turn_on_atimers (1);
2165 /* If poll timer doesn't exist, are we need one with
2166 a different interval, start a new one. */
2167 if (poll_timer
== NULL
2168 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2170 EMACS_TIME interval
;
2173 cancel_atimer (poll_timer
);
2175 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2176 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2177 poll_for_input
, NULL
);
2180 /* Let the timer's callback function poll for input
2181 if this becomes zero. */
2182 --poll_suppress_count
;
2187 /* Nonzero if we are using polling to handle input asynchronously. */
2190 input_polling_used ()
2192 #ifdef POLL_FOR_INPUT
2193 /* XXX This condition was (read_socket_hook && !interrupt_input),
2194 but read_socket_hook is not global anymore. Let's pretend that
2196 return !interrupt_input
;
2202 /* Turn off polling. */
2207 #ifdef POLL_FOR_INPUT
2208 /* XXX This condition was (read_socket_hook && !interrupt_input),
2209 but read_socket_hook is not global anymore. Let's pretend that
2211 if (!interrupt_input
)
2212 ++poll_suppress_count
;
2216 /* Set the value of poll_suppress_count to COUNT
2217 and start or stop polling accordingly. */
2220 set_poll_suppress_count (count
)
2223 #ifdef POLL_FOR_INPUT
2224 if (count
== 0 && poll_suppress_count
!= 0)
2226 poll_suppress_count
= 1;
2229 else if (count
!= 0 && poll_suppress_count
== 0)
2233 poll_suppress_count
= count
;
2237 /* Bind polling_period to a value at least N.
2238 But don't decrease it. */
2241 bind_polling_period (n
)
2244 #ifdef POLL_FOR_INPUT
2245 int new = polling_period
;
2250 stop_other_atimers (poll_timer
);
2252 specbind (Qpolling_period
, make_number (new));
2253 /* Start a new alarm with the new period. */
2258 /* Apply the control modifier to CHARACTER. */
2264 /* Save the upper bits here. */
2265 int upper
= c
& ~0177;
2269 /* Everything in the columns containing the upper-case letters
2270 denotes a control character. */
2271 if (c
>= 0100 && c
< 0140)
2275 /* Set the shift modifier for a control char
2276 made from a shifted letter. But only for letters! */
2277 if (oc
>= 'A' && oc
<= 'Z')
2278 c
|= shift_modifier
;
2281 /* The lower-case letters denote control characters too. */
2282 else if (c
>= 'a' && c
<= 'z')
2285 /* Include the bits for control and shift
2286 only if the basic ASCII code can't indicate them. */
2290 /* Replace the high bits. */
2291 c
|= (upper
& ~ctrl_modifier
);
2296 /* Display the help-echo property of the character after the mouse pointer.
2297 Either show it in the echo area, or call show-help-function to display
2298 it by other means (maybe in a tooltip).
2300 If HELP is nil, that means clear the previous help echo.
2302 If HELP is a string, display that string. If HELP is a function,
2303 call it with OBJECT and POS as arguments; the function should
2304 return a help string or nil for none. For all other types of HELP,
2305 evaluate it to obtain a string.
2307 WINDOW is the window in which the help was generated, if any.
2308 It is nil if not in a window.
2310 If OBJECT is a buffer, POS is the position in the buffer where the
2311 `help-echo' text property was found.
2313 If OBJECT is an overlay, that overlay has a `help-echo' property,
2314 and POS is the position in the overlay's buffer under the mouse.
2316 If OBJECT is a string (an overlay string or a string displayed with
2317 the `display' property). POS is the position in that string under
2320 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2321 echo overwrites a keystroke echo currently displayed in the echo
2324 Note: this function may only be called with HELP nil or a string
2325 from X code running asynchronously. */
2328 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2329 Lisp_Object help
, window
, object
, pos
;
2330 int ok_to_overwrite_keystroke_echo
;
2332 if (!NILP (help
) && !STRINGP (help
))
2334 if (FUNCTIONP (help
))
2336 Lisp_Object args
[4];
2341 help
= safe_call (4, args
);
2344 help
= safe_eval (help
);
2346 if (!STRINGP (help
))
2351 if (!noninteractive
&& STRINGP (help
))
2352 help
= call1 (Qmouse_fixup_help_message
, help
);
2355 if (STRINGP (help
) || NILP (help
))
2357 if (!NILP (Vshow_help_function
))
2358 call1 (Vshow_help_function
, help
);
2359 else if (/* Don't overwrite minibuffer contents. */
2360 !MINI_WINDOW_P (XWINDOW (selected_window
))
2361 /* Don't overwrite a keystroke echo. */
2362 && (NILP (echo_message_buffer
)
2363 || ok_to_overwrite_keystroke_echo
)
2364 /* Don't overwrite a prompt. */
2365 && !cursor_in_echo_area
)
2369 int count
= SPECPDL_INDEX ();
2371 if (!help_echo_showing_p
)
2372 Vpre_help_message
= current_message ();
2374 specbind (Qmessage_truncate_lines
, Qt
);
2375 message3_nolog (help
, SBYTES (help
),
2376 STRING_MULTIBYTE (help
));
2377 unbind_to (count
, Qnil
);
2379 else if (STRINGP (Vpre_help_message
))
2381 message3_nolog (Vpre_help_message
,
2382 SBYTES (Vpre_help_message
),
2383 STRING_MULTIBYTE (Vpre_help_message
));
2384 Vpre_help_message
= Qnil
;
2390 help_echo_showing_p
= STRINGP (help
);
2396 /* Input of single characters from keyboard */
2398 Lisp_Object
print_help ();
2399 static Lisp_Object
kbd_buffer_get_event ();
2400 static void record_char ();
2403 static jmp_buf wrong_kboard_jmpbuf
;
2406 #define STOP_POLLING \
2407 do { if (! polling_stopped_here) stop_polling (); \
2408 polling_stopped_here = 1; } while (0)
2410 #define RESUME_POLLING \
2411 do { if (polling_stopped_here) start_polling (); \
2412 polling_stopped_here = 0; } while (0)
2414 /* read a character from the keyboard; call the redisplay if needed */
2415 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2416 -1 means do not do redisplay, but do do autosaving.
2419 /* The arguments MAPS and NMAPS are for menu prompting.
2420 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2422 PREV_EVENT is the previous input event, or nil if we are reading
2423 the first event of a key sequence (or not reading a key sequence).
2424 If PREV_EVENT is t, that is a "magic" value that says
2425 not to run input methods, but in other respects to act as if
2426 not reading a key sequence.
2428 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2429 if we used a mouse menu to read the input, or zero otherwise. If
2430 USED_MOUSE_MENU is null, we don't dereference it.
2432 Value is t if we showed a menu and the user rejected it. */
2435 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2439 Lisp_Object prev_event
;
2440 int *used_mouse_menu
;
2442 volatile Lisp_Object c
;
2444 jmp_buf local_getcjmp
;
2446 volatile int key_already_recorded
= 0;
2447 Lisp_Object tem
, save
;
2448 volatile Lisp_Object previous_echo_area_message
;
2449 volatile Lisp_Object also_record
;
2450 volatile int reread
;
2451 struct gcpro gcpro1
, gcpro2
;
2452 int polling_stopped_here
= 0;
2456 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2457 before_command_key_count
= this_command_key_count
;
2458 before_command_echo_length
= echo_length ();
2461 previous_echo_area_message
= Qnil
;
2463 GCPRO2 (c
, previous_echo_area_message
);
2468 if (CONSP (Vunread_post_input_method_events
))
2470 c
= XCAR (Vunread_post_input_method_events
);
2471 Vunread_post_input_method_events
2472 = XCDR (Vunread_post_input_method_events
);
2474 /* Undo what read_char_x_menu_prompt did when it unread
2475 additional keys returned by Fx_popup_menu. */
2477 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2485 if (unread_command_char
!= -1)
2487 XSETINT (c
, unread_command_char
);
2488 unread_command_char
= -1;
2494 if (CONSP (Vunread_command_events
))
2496 c
= XCAR (Vunread_command_events
);
2497 Vunread_command_events
= XCDR (Vunread_command_events
);
2499 /* Undo what read_char_x_menu_prompt did when it unread
2500 additional keys returned by Fx_popup_menu. */
2502 && EQ (XCDR (c
), Qdisabled
)
2503 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2506 /* If the queued event is something that used the mouse,
2507 set used_mouse_menu accordingly. */
2509 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2510 *used_mouse_menu
= 1;
2513 goto reread_for_input_method
;
2516 if (CONSP (Vunread_input_method_events
))
2518 c
= XCAR (Vunread_input_method_events
);
2519 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2521 /* Undo what read_char_x_menu_prompt did when it unread
2522 additional keys returned by Fx_popup_menu. */
2524 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2528 goto reread_for_input_method
;
2531 this_command_key_count_reset
= 0;
2533 if (!NILP (Vexecuting_kbd_macro
))
2535 /* We set this to Qmacro; since that's not a frame, nobody will
2536 try to switch frames on us, and the selected window will
2539 Since this event came from a macro, it would be misleading to
2540 leave internal_last_event_frame set to wherever the last
2541 real event came from. Normally, a switch-frame event selects
2542 internal_last_event_frame after each command is read, but
2543 events read from a macro should never cause a new frame to be
2545 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2547 /* Exit the macro if we are at the end.
2548 Also, some things replace the macro with t
2549 to force an early exit. */
2550 if (EQ (Vexecuting_kbd_macro
, Qt
)
2551 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2557 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2558 if (STRINGP (Vexecuting_kbd_macro
)
2559 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2560 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2562 executing_kbd_macro_index
++;
2567 if (!NILP (unread_switch_frame
))
2569 c
= unread_switch_frame
;
2570 unread_switch_frame
= Qnil
;
2572 /* This event should make it into this_command_keys, and get echoed
2573 again, so we do not set `reread'. */
2577 /* if redisplay was requested */
2578 if (commandflag
>= 0)
2580 /* If there is pending input, process any events which are not
2581 user-visible, such as X selection_request events. */
2583 || detect_input_pending_run_timers (0))
2584 swallow_events (0); /* may clear input_pending */
2586 /* Redisplay if no pending input. */
2587 while (!input_pending
)
2589 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2590 redisplay_preserve_echo_area (5);
2595 /* Normal case: no input arrived during redisplay. */
2598 /* Input arrived and pre-empted redisplay.
2599 Process any events which are not user-visible. */
2601 /* If that cleared input_pending, try again to redisplay. */
2605 /* Message turns off echoing unless more keystrokes turn it on again.
2607 The code in 20.x for the condition was
2609 1. echo_area_glyphs && *echo_area_glyphs
2610 2. && echo_area_glyphs != current_kboard->echobuf
2611 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2613 (1) means there's a current message displayed
2615 (2) means it's not the message from echoing from the current
2618 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2619 is set to a non-null value. This is done in read_char and it is
2620 set to echo_area_glyphs after a call to echo_char. That means
2621 ok_to_echo_at_next_pause is either null or
2622 current_kboard->echobuf with the appropriate current_kboard at
2625 So, condition (3) means in clear text ok_to_echo_at_next_pause
2626 must be either null, or the current message isn't from echoing at
2627 all, or it's from echoing from a different kboard than the
2630 if (/* There currently is something in the echo area. */
2631 !NILP (echo_area_buffer
[0])
2632 && (/* And it's either not from echoing. */
2633 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2634 /* Or it's an echo from a different kboard. */
2635 || echo_kboard
!= current_kboard
2636 /* Or we explicitly allow overwriting whatever there is. */
2637 || ok_to_echo_at_next_pause
== NULL
))
2642 /* Try reading a character via menu prompting in the minibuf.
2643 Try this before the sit-for, because the sit-for
2644 would do the wrong thing if we are supposed to do
2645 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2646 after a mouse event so don't try a minibuf menu. */
2648 if (nmaps
> 0 && INTERACTIVE
2649 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2650 /* Don't bring up a menu if we already have another event. */
2651 && NILP (Vunread_command_events
)
2652 && unread_command_char
< 0
2653 && !detect_input_pending_run_timers (0))
2655 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2658 key_already_recorded
= 1;
2663 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2664 We will do that below, temporarily for short sections of code,
2665 when appropriate. local_getcjmp must be in effect
2666 around any call to sit_for or kbd_buffer_get_event;
2667 it *must not* be in effect when we call redisplay. */
2669 if (_setjmp (local_getcjmp
))
2671 /* We must have saved the outer value of getcjmp here,
2672 so restore it now. */
2673 restore_getcjmp (save_jump
);
2674 XSETINT (c
, quit_char
);
2675 internal_last_event_frame
= selected_frame
;
2676 Vlast_event_frame
= internal_last_event_frame
;
2677 /* If we report the quit char as an event,
2678 don't do so more than once. */
2679 if (!NILP (Vinhibit_quit
))
2684 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2685 if (kb
!= current_kboard
)
2687 Lisp_Object link
= kb
->kbd_queue
;
2688 /* We shouldn't get here if we were in single-kboard mode! */
2693 while (CONSP (XCDR (link
)))
2695 if (!NILP (XCDR (link
)))
2699 kb
->kbd_queue
= Fcons (c
, Qnil
);
2701 XSETCDR (link
, Fcons (c
, Qnil
));
2702 kb
->kbd_queue_has_data
= 1;
2703 current_kboard
= kb
;
2704 /* This is going to exit from read_char
2705 so we had better get rid of this frame's stuff. */
2707 longjmp (wrong_kboard_jmpbuf
, 1);
2714 timer_start_idle ();
2716 /* If in middle of key sequence and minibuffer not active,
2717 start echoing if enough time elapses. */
2719 if (minibuf_level
== 0
2720 && !current_kboard
->immediate_echo
2721 && this_command_key_count
> 0
2723 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2724 && NILP (Fzerop (Vecho_keystrokes
))
2725 && (/* No message. */
2726 NILP (echo_area_buffer
[0])
2727 /* Or empty message. */
2728 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2729 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2730 /* Or already echoing from same kboard. */
2731 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2732 /* Or not echoing before and echoing allowed. */
2733 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2737 /* After a mouse event, start echoing right away.
2738 This is because we are probably about to display a menu,
2739 and we don't want to delay before doing so. */
2740 if (EVENT_HAS_PARAMETERS (prev_event
))
2745 double duration
= extract_float (Vecho_keystrokes
);
2746 sec
= (int) duration
;
2747 usec
= (duration
- sec
) * 1000000;
2748 save_getcjmp (save_jump
);
2749 restore_getcjmp (local_getcjmp
);
2750 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2751 restore_getcjmp (save_jump
);
2753 && ! CONSP (Vunread_command_events
))
2758 /* Maybe auto save due to number of keystrokes. */
2760 if (commandflag
!= 0
2761 && auto_save_interval
> 0
2762 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2763 && !detect_input_pending_run_timers (0))
2765 Fdo_auto_save (Qnil
, Qnil
);
2766 /* Hooks can actually change some buffers in auto save. */
2770 /* Try reading using an X menu.
2771 This is never confused with reading using the minibuf
2772 because the recursive call of read_char in read_char_minibuf_menu_prompt
2773 does not pass on any keymaps. */
2775 if (nmaps
> 0 && INTERACTIVE
2776 && !NILP (prev_event
)
2777 && EVENT_HAS_PARAMETERS (prev_event
)
2778 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2779 && !EQ (XCAR (prev_event
), Qtool_bar
)
2780 /* Don't bring up a menu if we already have another event. */
2781 && NILP (Vunread_command_events
)
2782 && unread_command_char
< 0)
2784 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2786 /* Now that we have read an event, Emacs is not idle. */
2792 /* Maybe autosave and/or garbage collect due to idleness. */
2794 if (INTERACTIVE
&& NILP (c
))
2796 int delay_level
, buffer_size
;
2798 /* Slow down auto saves logarithmically in size of current buffer,
2799 and garbage collect while we're at it. */
2800 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2801 last_non_minibuf_size
= Z
- BEG
;
2802 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2804 while (buffer_size
> 64)
2805 delay_level
++, buffer_size
-= buffer_size
>> 2;
2806 if (delay_level
< 4) delay_level
= 4;
2807 /* delay_level is 4 for files under around 50k, 7 at 100k,
2808 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2810 /* Auto save if enough time goes by without input. */
2811 if (commandflag
!= 0
2812 && num_nonmacro_input_events
> last_auto_save
2813 && INTEGERP (Vauto_save_timeout
)
2814 && XINT (Vauto_save_timeout
) > 0)
2818 save_getcjmp (save_jump
);
2819 restore_getcjmp (local_getcjmp
);
2820 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2822 restore_getcjmp (save_jump
);
2825 && ! CONSP (Vunread_command_events
))
2827 Fdo_auto_save (Qnil
, Qnil
);
2829 /* If we have auto-saved and there is still no input
2830 available, garbage collect if there has been enough
2831 consing going on to make it worthwhile. */
2832 if (!detect_input_pending_run_timers (0)
2833 && consing_since_gc
> gc_cons_threshold
/ 2)
2834 Fgarbage_collect ();
2841 /* If this has become non-nil here, it has been set by a timer
2842 or sentinel or filter. */
2843 if (CONSP (Vunread_command_events
))
2845 c
= XCAR (Vunread_command_events
);
2846 Vunread_command_events
= XCDR (Vunread_command_events
);
2849 /* Read something from current KBOARD's side queue, if possible. */
2853 if (current_kboard
->kbd_queue_has_data
)
2855 if (!CONSP (current_kboard
->kbd_queue
))
2857 c
= XCAR (current_kboard
->kbd_queue
);
2858 current_kboard
->kbd_queue
2859 = XCDR (current_kboard
->kbd_queue
);
2860 if (NILP (current_kboard
->kbd_queue
))
2861 current_kboard
->kbd_queue_has_data
= 0;
2862 input_pending
= readable_events (0);
2863 if (EVENT_HAS_PARAMETERS (c
)
2864 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2865 internal_last_event_frame
= XCAR (XCDR (c
));
2866 Vlast_event_frame
= internal_last_event_frame
;
2871 /* If current_kboard's side queue is empty check the other kboards.
2872 If one of them has data that we have not yet seen here,
2873 switch to it and process the data waiting for it.
2875 Note: if the events queued up for another kboard
2876 have already been seen here, and therefore are not a complete command,
2877 the kbd_queue_has_data field is 0, so we skip that kboard here.
2878 That's to avoid an infinite loop switching between kboards here. */
2879 if (NILP (c
) && !single_kboard
)
2882 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2883 if (kb
->kbd_queue_has_data
)
2885 current_kboard
= kb
;
2886 /* This is going to exit from read_char
2887 so we had better get rid of this frame's stuff. */
2889 longjmp (wrong_kboard_jmpbuf
, 1);
2898 /* Finally, we read from the main queue,
2899 and if that gives us something we can't use yet, we put it on the
2900 appropriate side queue and try again. */
2906 /* Actually read a character, waiting if necessary. */
2907 save_getcjmp (save_jump
);
2908 restore_getcjmp (local_getcjmp
);
2909 timer_start_idle ();
2910 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2911 restore_getcjmp (save_jump
);
2914 if (! NILP (c
) && (kb
!= current_kboard
))
2916 Lisp_Object link
= kb
->kbd_queue
;
2919 while (CONSP (XCDR (link
)))
2921 if (!NILP (XCDR (link
)))
2925 kb
->kbd_queue
= Fcons (c
, Qnil
);
2927 XSETCDR (link
, Fcons (c
, Qnil
));
2928 kb
->kbd_queue_has_data
= 1;
2932 current_kboard
= kb
;
2933 /* This is going to exit from read_char
2934 so we had better get rid of this frame's stuff. */
2936 longjmp (wrong_kboard_jmpbuf
, 1);
2941 /* Terminate Emacs in batch mode if at eof. */
2942 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2943 Fkill_emacs (make_number (1));
2947 /* Add in any extra modifiers, where appropriate. */
2948 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2949 || ((extra_keyboard_modifiers
& 0177) < ' '
2950 && (extra_keyboard_modifiers
& 0177) != 0))
2951 XSETINT (c
, make_ctrl_char (XINT (c
)));
2953 /* Transfer any other modifier bits directly from
2954 extra_keyboard_modifiers to c. Ignore the actual character code
2955 in the low 16 bits of extra_keyboard_modifiers. */
2956 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2966 if (commandflag
>= 0
2967 && !input_pending
&& !detect_input_pending_run_timers (0))
2975 /* Buffer switch events are only for internal wakeups
2976 so don't show them to the user.
2977 Also, don't record a key if we already did. */
2978 if (BUFFERP (c
) || key_already_recorded
)
2981 /* Process special events within read_char
2982 and loop around to read another event. */
2985 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2990 int was_locked
= single_kboard
;
2992 last_input_char
= c
;
2993 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2995 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2996 /* We stopped being idle for this event; undo that. This
2997 prevents automatic window selection (under
2998 mouse_autoselect_window from acting as a real input event, for
2999 example banishing the mouse under mouse-avoidance-mode. */
3000 timer_resume_idle ();
3002 /* Resume allowing input from any kboard, if that was true before. */
3004 any_kboard_state ();
3009 /* Handle things that only apply to characters. */
3012 /* If kbd_buffer_get_event gave us an EOF, return that. */
3016 if ((STRINGP (Vkeyboard_translate_table
)
3017 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3018 || (VECTORP (Vkeyboard_translate_table
)
3019 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3020 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
3021 && CHAR_VALID_P (XINT (c
), 0)))
3024 d
= Faref (Vkeyboard_translate_table
, c
);
3025 /* nil in keyboard-translate-table means no translation. */
3031 /* If this event is a mouse click in the menu bar,
3032 return just menu-bar for now. Modify the mouse click event
3033 so we won't do this twice, then queue it up. */
3034 if (EVENT_HAS_PARAMETERS (c
)
3036 && CONSP (EVENT_START (c
))
3037 && CONSP (XCDR (EVENT_START (c
))))
3041 posn
= POSN_POSN (EVENT_START (c
));
3042 /* Handle menu-bar events:
3043 insert the dummy prefix event `menu-bar'. */
3044 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3046 /* Change menu-bar to (menu-bar) as the event "position". */
3047 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3050 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3055 /* Store these characters into recent_keys, the dribble file if any,
3056 and the keyboard macro being defined, if any. */
3058 if (! NILP (also_record
))
3059 record_char (also_record
);
3061 /* Wipe the echo area.
3062 But first, if we are about to use an input method,
3063 save the echo area contents for it to refer to. */
3065 && ! NILP (Vinput_method_function
)
3066 && (unsigned) XINT (c
) >= ' '
3067 && (unsigned) XINT (c
) != 127
3068 && (unsigned) XINT (c
) < 256)
3070 previous_echo_area_message
= Fcurrent_message ();
3071 Vinput_method_previous_message
= previous_echo_area_message
;
3074 /* Now wipe the echo area, except for help events which do their
3075 own stuff with the echo area. */
3077 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3078 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3080 if (!NILP (echo_area_buffer
[0]))
3081 safe_run_hooks (Qecho_area_clear_hook
);
3082 clear_message (1, 0);
3085 reread_for_input_method
:
3087 /* Pass this to the input method, if appropriate. */
3089 && ! NILP (Vinput_method_function
)
3090 /* Don't run the input method within a key sequence,
3091 after the first event of the key sequence. */
3092 && NILP (prev_event
)
3093 && (unsigned) XINT (c
) >= ' '
3094 && (unsigned) XINT (c
) != 127
3095 && (unsigned) XINT (c
) < 256)
3098 int key_count
, key_count_reset
;
3099 struct gcpro gcpro1
;
3100 int count
= SPECPDL_INDEX ();
3102 /* Save the echo status. */
3103 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3104 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3105 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3106 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3109 if (before_command_restore_flag
)
3111 this_command_key_count
= before_command_key_count_1
;
3112 if (this_command_key_count
< this_single_command_key_start
)
3113 this_single_command_key_start
= this_command_key_count
;
3114 echo_truncate (before_command_echo_length_1
);
3115 before_command_restore_flag
= 0;
3119 /* Save the this_command_keys status. */
3120 key_count
= this_command_key_count
;
3121 key_count_reset
= this_command_key_count_reset
;
3124 keys
= Fcopy_sequence (this_command_keys
);
3129 /* Clear out this_command_keys. */
3130 this_command_key_count
= 0;
3131 this_command_key_count_reset
= 0;
3133 /* Now wipe the echo area. */
3134 if (!NILP (echo_area_buffer
[0]))
3135 safe_run_hooks (Qecho_area_clear_hook
);
3136 clear_message (1, 0);
3139 /* If we are not reading a key sequence,
3140 never use the echo area. */
3143 specbind (Qinput_method_use_echo_area
, Qt
);
3146 /* Call the input method. */
3147 tem
= call1 (Vinput_method_function
, c
);
3149 tem
= unbind_to (count
, tem
);
3151 /* Restore the saved echoing state
3152 and this_command_keys state. */
3153 this_command_key_count
= key_count
;
3154 this_command_key_count_reset
= key_count_reset
;
3156 this_command_keys
= keys
;
3159 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3160 current_kboard
->echo_string
= saved_echo_string
;
3161 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3162 if (saved_immediate_echo
)
3167 /* The input method can return no events. */
3170 /* Bring back the previous message, if any. */
3171 if (! NILP (previous_echo_area_message
))
3172 message_with_string ("%s", previous_echo_area_message
, 0);
3175 /* It returned one event or more. */
3177 Vunread_post_input_method_events
3178 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3183 /* Display help if not echoing. */
3184 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3186 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3187 Lisp_Object help
, object
, position
, window
, tem
;
3189 tem
= Fcdr (XCDR (c
));
3192 window
= Fcar (tem
);
3194 object
= Fcar (tem
);
3196 position
= Fcar (tem
);
3198 show_help_echo (help
, window
, object
, position
, 0);
3200 /* We stopped being idle for this event; undo that. */
3201 timer_resume_idle ();
3205 if (! reread
|| this_command_key_count
== 0
3206 || this_command_key_count_reset
)
3209 /* Don't echo mouse motion events. */
3210 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3211 && NILP (Fzerop (Vecho_keystrokes
))
3212 && ! (EVENT_HAS_PARAMETERS (c
)
3213 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3216 if (! NILP (also_record
))
3217 echo_char (also_record
);
3218 /* Once we reread a character, echoing can happen
3219 the next time we pause to read a new one. */
3220 ok_to_echo_at_next_pause
= current_kboard
;
3223 /* Record this character as part of the current key. */
3224 add_command_key (c
);
3225 if (! NILP (also_record
))
3226 add_command_key (also_record
);
3229 last_input_char
= c
;
3232 /* Process the help character specially if enabled */
3233 if (!NILP (Vhelp_form
) && help_char_p (c
))
3236 count
= SPECPDL_INDEX ();
3238 record_unwind_protect (Fset_window_configuration
,
3239 Fcurrent_window_configuration (Qnil
));
3241 tem0
= Feval (Vhelp_form
);
3243 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3247 c
= read_char (0, 0, 0, Qnil
, 0);
3248 while (BUFFERP (c
));
3249 /* Remove the help from the frame */
3250 unbind_to (count
, Qnil
);
3253 if (EQ (c
, make_number (040)))
3257 c
= read_char (0, 0, 0, Qnil
, 0);
3258 while (BUFFERP (c
));
3267 /* Record a key that came from a mouse menu.
3268 Record it for echoing, for this-command-keys, and so on. */
3274 /* Wipe the echo area. */
3275 clear_message (1, 0);
3280 before_command_key_count
= this_command_key_count
;
3281 before_command_echo_length
= echo_length ();
3284 /* Don't echo mouse motion events. */
3285 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3286 && NILP (Fzerop (Vecho_keystrokes
)))
3290 /* Once we reread a character, echoing can happen
3291 the next time we pause to read a new one. */
3292 ok_to_echo_at_next_pause
= 0;
3295 /* Record this character as part of the current key. */
3296 add_command_key (c
);
3298 /* Re-reading in the middle of a command */
3299 last_input_char
= c
;
3303 /* Return 1 if should recognize C as "the help character". */
3311 if (EQ (c
, Vhelp_char
))
3313 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3314 if (EQ (c
, XCAR (tail
)))
3319 /* Record the input event C in various ways. */
3327 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3329 /* To avoid filling recent_keys with help-echo and mouse-movement
3330 events, we filter out repeated help-echo events, only store the
3331 first and last in a series of mouse-movement events, and don't
3332 store repeated help-echo events which are only separated by
3333 mouse-movement events. */
3335 Lisp_Object ev1
, ev2
, ev3
;
3338 if ((ix1
= recent_keys_index
- 1) < 0)
3339 ix1
= NUM_RECENT_KEYS
- 1;
3340 ev1
= AREF (recent_keys
, ix1
);
3342 if ((ix2
= ix1
- 1) < 0)
3343 ix2
= NUM_RECENT_KEYS
- 1;
3344 ev2
= AREF (recent_keys
, ix2
);
3346 if ((ix3
= ix2
- 1) < 0)
3347 ix3
= NUM_RECENT_KEYS
- 1;
3348 ev3
= AREF (recent_keys
, ix3
);
3350 if (EQ (XCAR (c
), Qhelp_echo
))
3352 /* Don't record `help-echo' in recent_keys unless it shows some help
3353 message, and a different help than the previously recorded
3355 Lisp_Object help
, last_help
;
3357 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3358 if (!STRINGP (help
))
3360 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3361 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3363 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3364 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3365 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3367 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3368 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3369 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3370 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3373 else if (EQ (XCAR (c
), Qmouse_movement
))
3375 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3376 So additional mouse movement events replace the last element. */
3377 Lisp_Object last_window
, window
;
3379 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3380 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3381 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3382 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3383 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3385 ASET (recent_keys
, ix1
, c
);
3391 store_kbd_macro_char (c
);
3396 ASET (recent_keys
, recent_keys_index
, c
);
3397 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3398 recent_keys_index
= 0;
3400 else if (recorded
< 0)
3402 /* We need to remove one or two events from recent_keys.
3403 To do this, we simply put nil at those events and move the
3404 recent_keys_index backwards over those events. Usually,
3405 users will never see those nil events, as they will be
3406 overwritten by the command keys entered to see recent_keys
3409 while (recorded
++ < 0 && total_keys
> 0)
3411 if (total_keys
< NUM_RECENT_KEYS
)
3413 if (--recent_keys_index
< 0)
3414 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3415 ASET (recent_keys
, recent_keys_index
, Qnil
);
3419 num_nonmacro_input_events
++;
3421 /* Write c to the dribble file. If c is a lispy event, write
3422 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3423 If you, dear reader, have a better idea, you've got the source. :-) */
3428 if (XUINT (c
) < 0x100)
3429 putc (XINT (c
), dribble
);
3431 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3435 Lisp_Object dribblee
;
3437 /* If it's a structured event, take the event header. */
3438 dribblee
= EVENT_HEAD (c
);
3440 if (SYMBOLP (dribblee
))
3442 putc ('<', dribble
);
3443 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3444 SBYTES (SYMBOL_NAME (dribblee
)),
3446 putc ('>', dribble
);
3458 struct buffer
*old
= current_buffer
;
3459 Fprinc (object
, Qnil
);
3460 set_buffer_internal (XBUFFER (Vstandard_output
));
3461 call0 (intern ("help-mode"));
3462 set_buffer_internal (old
);
3466 /* Copy out or in the info on where C-g should throw to.
3467 This is used when running Lisp code from within get_char,
3468 in case get_char is called recursively.
3469 See read_process_output. */
3475 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3479 restore_getcjmp (temp
)
3482 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3487 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3488 of this function. */
3491 tracking_off (old_value
)
3492 Lisp_Object old_value
;
3494 do_mouse_tracking
= old_value
;
3495 if (NILP (old_value
))
3497 /* Redisplay may have been preempted because there was input
3498 available, and it assumes it will be called again after the
3499 input has been processed. If the only input available was
3500 the sort that we have just disabled, then we need to call
3502 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3504 redisplay_preserve_echo_area (6);
3505 get_input_pending (&input_pending
,
3506 READABLE_EVENTS_DO_TIMERS_NOW
);
3512 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3513 doc
: /* Evaluate BODY with mouse movement events enabled.
3514 Within a `track-mouse' form, mouse motion generates input events that
3515 you can read with `read-event'.
3516 Normally, mouse motion is ignored.
3517 usage: (track-mouse BODY ...) */)
3521 int count
= SPECPDL_INDEX ();
3524 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3526 do_mouse_tracking
= Qt
;
3528 val
= Fprogn (args
);
3529 return unbind_to (count
, val
);
3532 /* If mouse has moved on some frame, return one of those frames.
3533 Return 0 otherwise. */
3538 Lisp_Object tail
, frame
;
3540 FOR_EACH_FRAME (tail
, frame
)
3542 if (XFRAME (frame
)->mouse_moved
)
3543 return XFRAME (frame
);
3549 #endif /* HAVE_MOUSE */
3551 /* Low level keyboard/mouse input.
3552 kbd_buffer_store_event places events in kbd_buffer, and
3553 kbd_buffer_get_event retrieves them. */
3555 /* Return true iff there are any events in the queue that read-char
3556 would return. If this returns false, a read-char would block. */
3558 readable_events (flags
)
3561 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3564 /* If the buffer contains only FOCUS_IN_EVENT events, and
3565 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3566 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3568 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3569 #ifdef USE_TOOLKIT_SCROLL_BARS
3570 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3574 struct input_event
*event
;
3576 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3583 #ifdef USE_TOOLKIT_SCROLL_BARS
3584 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3586 event
->kind
== FOCUS_IN_EVENT
)
3587 #ifdef USE_TOOLKIT_SCROLL_BARS
3588 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3589 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3590 && event
->part
== scroll_bar_handle
3591 && event
->modifiers
== 0)
3596 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3599 while (event
!= kbd_store_ptr
);
3606 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3607 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3612 if (current_kboard
->kbd_queue_has_data
)
3618 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3619 if (kb
->kbd_queue_has_data
)
3625 /* Set this for debugging, to have a way to get out */
3630 event_to_kboard (event
)
3631 struct input_event
*event
;
3634 frame
= event
->frame_or_window
;
3636 frame
= XCAR (frame
);
3637 else if (WINDOWP (frame
))
3638 frame
= WINDOW_FRAME (XWINDOW (frame
));
3640 /* There are still some events that don't set this field.
3641 For now, just ignore the problem.
3642 Also ignore dead frames here. */
3643 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3646 return FRAME_KBOARD (XFRAME (frame
));
3651 Lisp_Object Vthrow_on_input
;
3653 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3656 kbd_buffer_store_event (event
)
3657 register struct input_event
*event
;
3659 kbd_buffer_store_event_hold (event
, 0);
3662 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3664 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3665 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3666 Else, if EVENT is a quit event, store the quit event
3667 in HOLD_QUIT, and return (thus ignoring further events).
3669 This is used in read_avail_input to postpone the processing
3670 of the quit event until all subsequent input events have been
3671 parsed (and discarded).
3675 kbd_buffer_store_event_hold (event
, hold_quit
)
3676 register struct input_event
*event
;
3677 struct input_event
*hold_quit
;
3679 if (event
->kind
== NO_EVENT
)
3682 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3685 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3687 register int c
= event
->code
& 0377;
3689 if (event
->modifiers
& ctrl_modifier
)
3690 c
= make_ctrl_char (c
);
3692 c
|= (event
->modifiers
3693 & (meta_modifier
| alt_modifier
3694 | hyper_modifier
| super_modifier
));
3700 struct input_event
*sp
;
3703 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3704 kb
!= current_kboard
))
3707 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3708 Fcons (make_number (c
), Qnil
));
3709 kb
->kbd_queue_has_data
= 1;
3710 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3712 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3715 if (event_to_kboard (sp
) == kb
)
3717 sp
->kind
= NO_EVENT
;
3718 sp
->frame_or_window
= Qnil
;
3728 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3732 /* If this results in a quit_char being returned to Emacs as
3733 input, set Vlast_event_frame properly. If this doesn't
3734 get returned to Emacs as an event, the next event read
3735 will set Vlast_event_frame again, so this is safe to do. */
3739 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3741 focus
= event
->frame_or_window
;
3742 internal_last_event_frame
= focus
;
3743 Vlast_event_frame
= focus
;
3746 last_event_timestamp
= event
->timestamp
;
3747 handle_interrupt ();
3751 if (c
&& c
== stop_character
)
3757 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3758 Just ignore the second one. */
3759 else if (event
->kind
== BUFFER_SWITCH_EVENT
3760 && kbd_fetch_ptr
!= kbd_store_ptr
3761 && ((kbd_store_ptr
== kbd_buffer
3762 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3763 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3766 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3767 kbd_store_ptr
= kbd_buffer
;
3769 /* Don't let the very last slot in the buffer become full,
3770 since that would make the two pointers equal,
3771 and that is indistinguishable from an empty buffer.
3772 Discard the event if it would fill the last slot. */
3773 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3775 *kbd_store_ptr
= *event
;
3779 /* If we're inside while-no-input, and this event qualifies
3780 as input, set quit-flag to cause an interrupt. */
3781 if (!NILP (Vthrow_on_input
)
3782 && event
->kind
!= FOCUS_IN_EVENT
3783 && event
->kind
!= HELP_EVENT
3784 && event
->kind
!= DEICONIFY_EVENT
)
3786 Vquit_flag
= Vthrow_on_input
;
3787 /* If we're inside a function that wants immediate quits,
3789 if (immediate_quit
&& NILP (Vinhibit_quit
))
3799 /* Put an input event back in the head of the event queue. */
3802 kbd_buffer_unget_event (event
)
3803 register struct input_event
*event
;
3805 if (kbd_fetch_ptr
== kbd_buffer
)
3806 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3808 /* Don't let the very last slot in the buffer become full, */
3809 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3812 *kbd_fetch_ptr
= *event
;
3817 /* Generate HELP_EVENT input_events in BUFP which has room for
3818 SIZE events. If there's not enough room in BUFP, ignore this
3821 HELP is the help form.
3823 FRAME is the frame on which the help is generated. OBJECT is the
3824 Lisp object where the help was found (a buffer, a string, an
3825 overlay, or nil if neither from a string nor from a buffer. POS is
3826 the position within OBJECT where the help was found.
3828 Value is the number of input_events generated. */
3831 gen_help_event (help
, frame
, window
, object
, pos
)
3832 Lisp_Object help
, frame
, object
, window
;
3835 struct input_event event
;
3839 event
.kind
= HELP_EVENT
;
3840 event
.frame_or_window
= frame
;
3842 event
.x
= WINDOWP (window
) ? window
: frame
;
3845 kbd_buffer_store_event (&event
);
3849 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3852 kbd_buffer_store_help_event (frame
, help
)
3853 Lisp_Object frame
, help
;
3855 struct input_event event
;
3857 event
.kind
= HELP_EVENT
;
3858 event
.frame_or_window
= frame
;
3863 kbd_buffer_store_event (&event
);
3867 /* Discard any mouse events in the event buffer by setting them to
3870 discard_mouse_events ()
3872 struct input_event
*sp
;
3873 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3875 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3878 if (sp
->kind
== MOUSE_CLICK_EVENT
3879 || sp
->kind
== WHEEL_EVENT
3881 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3883 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3885 sp
->kind
= NO_EVENT
;
3891 /* Return non-zero if there are any real events waiting in the event
3892 buffer, not counting `NO_EVENT's.
3894 If DISCARD is non-zero, discard NO_EVENT events at the front of
3895 the input queue, possibly leaving the input queue empty if there
3896 are no real input events. */
3899 kbd_buffer_events_waiting (discard
)
3902 struct input_event
*sp
;
3904 for (sp
= kbd_fetch_ptr
;
3905 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3908 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3915 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3919 /* Clear input event EVENT. */
3923 struct input_event
*event
;
3925 event
->kind
= NO_EVENT
;
3929 /* Read one event from the event buffer, waiting if necessary.
3930 The value is a Lisp object representing the event.
3931 The value is nil for an event that should be ignored,
3932 or that was handled here.
3933 We always read and discard one event. */
3936 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3938 int *used_mouse_menu
;
3947 *kbp
= current_kboard
;
3951 /* Wait until there is input available. */
3954 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3957 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3961 /* If the quit flag is set, then read_char will return
3962 quit_char, so that counts as "available input." */
3963 if (!NILP (Vquit_flag
))
3964 quit_throw_to_read_char ();
3966 /* One way or another, wait until input is available; then, if
3967 interrupt handlers have not read it, read it now. */
3970 wait_for_kbd_input ();
3972 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3976 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3979 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3983 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3985 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3986 /* Pass 1 for EXPECT since we just waited to have input. */
3987 read_avail_input (1);
3989 #endif /* not VMS */
3992 if (CONSP (Vunread_command_events
))
3995 first
= XCAR (Vunread_command_events
);
3996 Vunread_command_events
= XCDR (Vunread_command_events
);
3997 *kbp
= current_kboard
;
4001 /* At this point, we know that there is a readable event available
4002 somewhere. If the event queue is empty, then there must be a
4003 mouse movement enabled and available. */
4004 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4006 struct input_event
*event
;
4008 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4012 last_event_timestamp
= event
->timestamp
;
4015 *kbp
= event_to_kboard (event
);
4017 *kbp
= current_kboard
; /* Better than returning null ptr? */
4019 *kbp
= &the_only_kboard
;
4024 /* These two kinds of events get special handling
4025 and don't actually appear to the command loop.
4026 We return nil for them. */
4027 if (event
->kind
== SELECTION_REQUEST_EVENT
4028 || event
->kind
== SELECTION_CLEAR_EVENT
)
4031 struct input_event copy
;
4033 /* Remove it from the buffer before processing it,
4034 since otherwise swallow_events will see it
4035 and process it again. */
4037 kbd_fetch_ptr
= event
+ 1;
4038 input_pending
= readable_events (0);
4039 x_handle_selection_event (©
);
4041 /* We're getting selection request events, but we don't have
4047 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4048 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4050 /* Make an event (delete-frame (FRAME)). */
4051 obj
= Fcons (event
->frame_or_window
, Qnil
);
4052 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4053 kbd_fetch_ptr
= event
+ 1;
4056 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4057 else if (event
->kind
== ICONIFY_EVENT
)
4059 /* Make an event (iconify-frame (FRAME)). */
4060 obj
= Fcons (event
->frame_or_window
, Qnil
);
4061 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4062 kbd_fetch_ptr
= event
+ 1;
4064 else if (event
->kind
== DEICONIFY_EVENT
)
4066 /* Make an event (make-frame-visible (FRAME)). */
4067 obj
= Fcons (event
->frame_or_window
, Qnil
);
4068 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4069 kbd_fetch_ptr
= event
+ 1;
4072 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4074 /* The value doesn't matter here; only the type is tested. */
4075 XSETBUFFER (obj
, current_buffer
);
4076 kbd_fetch_ptr
= event
+ 1;
4078 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4079 || defined (USE_GTK)
4080 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4082 kbd_fetch_ptr
= event
+ 1;
4083 input_pending
= readable_events (0);
4084 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4085 x_activate_menubar (XFRAME (event
->frame_or_window
));
4088 #if defined (WINDOWSNT) || defined (MAC_OS)
4089 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4092 /* Make an event (language-change (KEY_SCRIPT)). */
4093 obj
= Fcons (make_number (event
->code
), Qnil
);
4095 /* Make an event (language-change (FRAME CHARSET LCID)). */
4096 obj
= Fcons (event
->frame_or_window
, Qnil
);
4098 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4099 kbd_fetch_ptr
= event
+ 1;
4102 else if (event
->kind
== SAVE_SESSION_EVENT
)
4104 obj
= Fcons (Qsave_session
, Qnil
);
4105 kbd_fetch_ptr
= event
+ 1;
4107 /* Just discard these, by returning nil.
4108 With MULTI_KBOARD, these events are used as placeholders
4109 when we need to randomly delete events from the queue.
4110 (They shouldn't otherwise be found in the buffer,
4111 but on some machines it appears they do show up
4112 even without MULTI_KBOARD.) */
4113 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4114 mouse events during a popup-menu call. */
4115 else if (event
->kind
== NO_EVENT
)
4116 kbd_fetch_ptr
= event
+ 1;
4117 else if (event
->kind
== HELP_EVENT
)
4119 Lisp_Object object
, position
, help
, frame
, window
;
4121 frame
= event
->frame_or_window
;
4122 object
= event
->arg
;
4123 position
= make_number (event
->code
);
4126 clear_event (event
);
4128 kbd_fetch_ptr
= event
+ 1;
4129 if (!WINDOWP (window
))
4131 obj
= Fcons (Qhelp_echo
,
4132 list5 (frame
, help
, window
, object
, position
));
4134 else if (event
->kind
== FOCUS_IN_EVENT
)
4136 /* Notification of a FocusIn event. The frame receiving the
4137 focus is in event->frame_or_window. Generate a
4138 switch-frame event if necessary. */
4139 Lisp_Object frame
, focus
;
4141 frame
= event
->frame_or_window
;
4142 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4146 if (!EQ (frame
, internal_last_event_frame
)
4147 && !EQ (frame
, selected_frame
))
4148 obj
= make_lispy_switch_frame (frame
);
4149 internal_last_event_frame
= frame
;
4150 kbd_fetch_ptr
= event
+ 1;
4154 /* If this event is on a different frame, return a switch-frame this
4155 time, and leave the event in the queue for next time. */
4159 frame
= event
->frame_or_window
;
4161 frame
= XCAR (frame
);
4162 else if (WINDOWP (frame
))
4163 frame
= WINDOW_FRAME (XWINDOW (frame
));
4165 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4169 if (! EQ (frame
, internal_last_event_frame
)
4170 && !EQ (frame
, selected_frame
))
4171 obj
= make_lispy_switch_frame (frame
);
4172 internal_last_event_frame
= frame
;
4174 /* If we didn't decide to make a switch-frame event, go ahead
4175 and build a real event from the queue entry. */
4179 obj
= make_lispy_event (event
);
4181 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4182 || defined (USE_GTK)
4183 /* If this was a menu selection, then set the flag to inhibit
4184 writing to last_nonmenu_event. Don't do this if the event
4185 we're returning is (menu-bar), though; that indicates the
4186 beginning of the menu sequence, and we might as well leave
4187 that as the `event with parameters' for this selection. */
4189 && !EQ (event
->frame_or_window
, event
->arg
)
4190 && (event
->kind
== MENU_BAR_EVENT
4191 || event
->kind
== TOOL_BAR_EVENT
))
4192 *used_mouse_menu
= 1;
4195 /* Wipe out this event, to catch bugs. */
4196 clear_event (event
);
4197 kbd_fetch_ptr
= event
+ 1;
4202 /* Try generating a mouse motion event. */
4203 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4205 FRAME_PTR f
= some_mouse_moved ();
4206 Lisp_Object bar_window
;
4207 enum scroll_bar_part part
;
4211 *kbp
= current_kboard
;
4212 /* Note that this uses F to determine which display to look at.
4213 If there is no valid info, it does not store anything
4214 so x remains nil. */
4217 /* XXX Can f or mouse_position_hook be NULL here? */
4218 if (f
&& FRAME_DEVICE (f
)->mouse_position_hook
)
4219 (*FRAME_DEVICE (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4220 &part
, &x
, &y
, &time
);
4224 /* Decide if we should generate a switch-frame event. Don't
4225 generate switch-frame events for motion outside of all Emacs
4231 frame
= FRAME_FOCUS_FRAME (f
);
4233 XSETFRAME (frame
, f
);
4235 if (! EQ (frame
, internal_last_event_frame
)
4236 && !EQ (frame
, selected_frame
))
4237 obj
= make_lispy_switch_frame (frame
);
4238 internal_last_event_frame
= frame
;
4241 /* If we didn't decide to make a switch-frame event, go ahead and
4242 return a mouse-motion event. */
4243 if (!NILP (x
) && NILP (obj
))
4244 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4246 #endif /* HAVE_MOUSE */
4248 /* We were promised by the above while loop that there was
4249 something for us to read! */
4252 input_pending
= readable_events (0);
4254 Vlast_event_frame
= internal_last_event_frame
;
4259 /* Process any events that are not user-visible,
4260 then return, without reading any user-visible events. */
4263 swallow_events (do_display
)
4268 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4270 struct input_event
*event
;
4272 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4276 last_event_timestamp
= event
->timestamp
;
4278 /* These two kinds of events get special handling
4279 and don't actually appear to the command loop. */
4280 if (event
->kind
== SELECTION_REQUEST_EVENT
4281 || event
->kind
== SELECTION_CLEAR_EVENT
)
4284 struct input_event copy
;
4286 /* Remove it from the buffer before processing it,
4287 since otherwise swallow_events called recursively could see it
4288 and process it again. */
4290 kbd_fetch_ptr
= event
+ 1;
4291 input_pending
= readable_events (0);
4292 x_handle_selection_event (©
);
4294 /* We're getting selection request events, but we don't have
4303 old_timers_run
= timers_run
;
4304 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4306 if (timers_run
!= old_timers_run
&& do_display
)
4307 redisplay_preserve_echo_area (7);
4310 /* Record the start of when Emacs is idle,
4311 for the sake of running idle-time timers. */
4318 /* If we are already in the idle state, do nothing. */
4319 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4322 EMACS_GET_TIME (timer_idleness_start_time
);
4324 timer_last_idleness_start_time
= timer_idleness_start_time
;
4326 /* Mark all idle-time timers as once again candidates for running. */
4327 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4331 timer
= XCAR (timers
);
4333 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4335 XVECTOR (timer
)->contents
[0] = Qnil
;
4339 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4344 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4347 /* Resume idle timer from last idle start time. */
4350 timer_resume_idle ()
4352 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4355 timer_idleness_start_time
= timer_last_idleness_start_time
;
4358 /* This is only for debugging. */
4359 struct input_event last_timer_event
;
4361 /* Check whether a timer has fired. To prevent larger problems we simply
4362 disregard elements that are not proper timers. Do not make a circular
4363 timer list for the time being.
4365 Returns the number of seconds to wait until the next timer fires. If a
4366 timer is triggering now, return zero seconds.
4367 If no timer is active, return -1 seconds.
4369 If a timer is ripe, we run it, with quitting turned off.
4371 DO_IT_NOW is now ignored. It used to mean that we should
4372 run the timer directly instead of queueing a timer-event.
4373 Now we always run timers directly. */
4376 timer_check (do_it_now
)
4379 EMACS_TIME nexttime
;
4380 EMACS_TIME now
, idleness_now
;
4381 Lisp_Object timers
, idle_timers
, chosen_timer
;
4382 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4384 EMACS_SET_SECS (nexttime
, -1);
4385 EMACS_SET_USECS (nexttime
, -1);
4387 /* Always consider the ordinary timers. */
4388 timers
= Vtimer_list
;
4389 /* Consider the idle timers only if Emacs is idle. */
4390 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4391 idle_timers
= Vtimer_idle_list
;
4394 chosen_timer
= Qnil
;
4395 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4397 if (CONSP (timers
) || CONSP (idle_timers
))
4399 EMACS_GET_TIME (now
);
4400 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4401 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4404 while (CONSP (timers
) || CONSP (idle_timers
))
4406 Lisp_Object
*vector
;
4407 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4408 EMACS_TIME timer_time
, idle_timer_time
;
4409 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4411 /* Skip past invalid timers and timers already handled. */
4414 timer
= XCAR (timers
);
4415 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4417 timers
= XCDR (timers
);
4420 vector
= XVECTOR (timer
)->contents
;
4422 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4423 || !INTEGERP (vector
[3])
4424 || ! NILP (vector
[0]))
4426 timers
= XCDR (timers
);
4430 if (!NILP (idle_timers
))
4432 timer
= XCAR (idle_timers
);
4433 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4435 idle_timers
= XCDR (idle_timers
);
4438 vector
= XVECTOR (timer
)->contents
;
4440 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4441 || !INTEGERP (vector
[3])
4442 || ! NILP (vector
[0]))
4444 idle_timers
= XCDR (idle_timers
);
4449 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4450 based on the next ordinary timer.
4451 TIMER_DIFFERENCE is the distance in time from NOW to when
4452 this timer becomes ripe (negative if it's already ripe). */
4455 timer
= XCAR (timers
);
4456 vector
= XVECTOR (timer
)->contents
;
4457 EMACS_SET_SECS (timer_time
,
4458 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4459 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4460 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4463 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4464 based on the next idle timer. */
4465 if (!NILP (idle_timers
))
4467 idle_timer
= XCAR (idle_timers
);
4468 vector
= XVECTOR (idle_timer
)->contents
;
4469 EMACS_SET_SECS (idle_timer_time
,
4470 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4471 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4472 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4475 /* Decide which timer is the next timer,
4476 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4477 Also step down the list where we found that timer. */
4479 if (! NILP (timers
) && ! NILP (idle_timers
))
4482 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4483 if (EMACS_TIME_NEG_P (temp
))
4485 chosen_timer
= timer
;
4486 timers
= XCDR (timers
);
4487 difference
= timer_difference
;
4491 chosen_timer
= idle_timer
;
4492 idle_timers
= XCDR (idle_timers
);
4493 difference
= idle_timer_difference
;
4496 else if (! NILP (timers
))
4498 chosen_timer
= timer
;
4499 timers
= XCDR (timers
);
4500 difference
= timer_difference
;
4504 chosen_timer
= idle_timer
;
4505 idle_timers
= XCDR (idle_timers
);
4506 difference
= idle_timer_difference
;
4508 vector
= XVECTOR (chosen_timer
)->contents
;
4510 /* If timer is ripe, run it if it hasn't been run. */
4511 if (EMACS_TIME_NEG_P (difference
)
4512 || (EMACS_SECS (difference
) == 0
4513 && EMACS_USECS (difference
) == 0))
4515 if (NILP (vector
[0]))
4517 int count
= SPECPDL_INDEX ();
4518 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4520 /* On unbind_to, resume allowing input from any kboard, if that
4522 record_single_kboard_state ();
4524 /* Mark the timer as triggered to prevent problems if the lisp
4525 code fails to reschedule it right. */
4528 specbind (Qinhibit_quit
, Qt
);
4530 call1 (Qtimer_event_handler
, chosen_timer
);
4531 Vdeactivate_mark
= old_deactivate_mark
;
4533 unbind_to (count
, Qnil
);
4535 /* Since we have handled the event,
4536 we don't need to tell the caller to wake up and do it. */
4540 /* When we encounter a timer that is still waiting,
4541 return the amount of time to wait before it is ripe. */
4548 /* No timers are pending in the future. */
4549 /* Return 0 if we generated an event, and -1 if not. */
4554 /* Caches for modify_event_symbol. */
4555 static Lisp_Object accent_key_syms
;
4556 static Lisp_Object func_key_syms
;
4557 static Lisp_Object mouse_syms
;
4558 static Lisp_Object wheel_syms
;
4559 static Lisp_Object drag_n_drop_syms
;
4561 /* This is a list of keysym codes for special "accent" characters.
4562 It parallels lispy_accent_keys. */
4564 static int lispy_accent_codes
[] =
4566 #ifdef XK_dead_circumflex
4571 #ifdef XK_dead_grave
4576 #ifdef XK_dead_tilde
4581 #ifdef XK_dead_diaeresis
4586 #ifdef XK_dead_macron
4591 #ifdef XK_dead_degree
4596 #ifdef XK_dead_acute
4601 #ifdef XK_dead_cedilla
4606 #ifdef XK_dead_breve
4611 #ifdef XK_dead_ogonek
4616 #ifdef XK_dead_caron
4621 #ifdef XK_dead_doubleacute
4622 XK_dead_doubleacute
,
4626 #ifdef XK_dead_abovedot
4631 #ifdef XK_dead_abovering
4641 #ifdef XK_dead_belowdot
4646 #ifdef XK_dead_voiced_sound
4647 XK_dead_voiced_sound
,
4651 #ifdef XK_dead_semivoiced_sound
4652 XK_dead_semivoiced_sound
,
4668 /* This is a list of Lisp names for special "accent" characters.
4669 It parallels lispy_accent_codes. */
4671 static char *lispy_accent_keys
[] =
4689 "dead-voiced-sound",
4690 "dead-semivoiced-sound",
4696 #define FUNCTION_KEY_OFFSET 0x0
4698 char *lispy_function_keys
[] =
4702 0, /* VK_LBUTTON 0x01 */
4703 0, /* VK_RBUTTON 0x02 */
4704 "cancel", /* VK_CANCEL 0x03 */
4705 0, /* VK_MBUTTON 0x04 */
4707 0, 0, 0, /* 0x05 .. 0x07 */
4709 "backspace", /* VK_BACK 0x08 */
4710 "tab", /* VK_TAB 0x09 */
4712 0, 0, /* 0x0A .. 0x0B */
4714 "clear", /* VK_CLEAR 0x0C */
4715 "return", /* VK_RETURN 0x0D */
4717 0, 0, /* 0x0E .. 0x0F */
4719 0, /* VK_SHIFT 0x10 */
4720 0, /* VK_CONTROL 0x11 */
4721 0, /* VK_MENU 0x12 */
4722 "pause", /* VK_PAUSE 0x13 */
4723 "capslock", /* VK_CAPITAL 0x14 */
4725 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4727 "escape", /* VK_ESCAPE 0x1B */
4729 0, 0, 0, 0, /* 0x1C .. 0x1F */
4731 0, /* VK_SPACE 0x20 */
4732 "prior", /* VK_PRIOR 0x21 */
4733 "next", /* VK_NEXT 0x22 */
4734 "end", /* VK_END 0x23 */
4735 "home", /* VK_HOME 0x24 */
4736 "left", /* VK_LEFT 0x25 */
4737 "up", /* VK_UP 0x26 */
4738 "right", /* VK_RIGHT 0x27 */
4739 "down", /* VK_DOWN 0x28 */
4740 "select", /* VK_SELECT 0x29 */
4741 "print", /* VK_PRINT 0x2A */
4742 "execute", /* VK_EXECUTE 0x2B */
4743 "snapshot", /* VK_SNAPSHOT 0x2C */
4744 "insert", /* VK_INSERT 0x2D */
4745 "delete", /* VK_DELETE 0x2E */
4746 "help", /* VK_HELP 0x2F */
4748 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4750 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4752 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4754 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4756 0, 0, 0, 0, 0, 0, 0, 0, 0,
4757 0, 0, 0, 0, 0, 0, 0, 0, 0,
4758 0, 0, 0, 0, 0, 0, 0, 0,
4760 "lwindow", /* VK_LWIN 0x5B */
4761 "rwindow", /* VK_RWIN 0x5C */
4762 "apps", /* VK_APPS 0x5D */
4764 0, 0, /* 0x5E .. 0x5F */
4766 "kp-0", /* VK_NUMPAD0 0x60 */
4767 "kp-1", /* VK_NUMPAD1 0x61 */
4768 "kp-2", /* VK_NUMPAD2 0x62 */
4769 "kp-3", /* VK_NUMPAD3 0x63 */
4770 "kp-4", /* VK_NUMPAD4 0x64 */
4771 "kp-5", /* VK_NUMPAD5 0x65 */
4772 "kp-6", /* VK_NUMPAD6 0x66 */
4773 "kp-7", /* VK_NUMPAD7 0x67 */
4774 "kp-8", /* VK_NUMPAD8 0x68 */
4775 "kp-9", /* VK_NUMPAD9 0x69 */
4776 "kp-multiply", /* VK_MULTIPLY 0x6A */
4777 "kp-add", /* VK_ADD 0x6B */
4778 "kp-separator", /* VK_SEPARATOR 0x6C */
4779 "kp-subtract", /* VK_SUBTRACT 0x6D */
4780 "kp-decimal", /* VK_DECIMAL 0x6E */
4781 "kp-divide", /* VK_DIVIDE 0x6F */
4782 "f1", /* VK_F1 0x70 */
4783 "f2", /* VK_F2 0x71 */
4784 "f3", /* VK_F3 0x72 */
4785 "f4", /* VK_F4 0x73 */
4786 "f5", /* VK_F5 0x74 */
4787 "f6", /* VK_F6 0x75 */
4788 "f7", /* VK_F7 0x76 */
4789 "f8", /* VK_F8 0x77 */
4790 "f9", /* VK_F9 0x78 */
4791 "f10", /* VK_F10 0x79 */
4792 "f11", /* VK_F11 0x7A */
4793 "f12", /* VK_F12 0x7B */
4794 "f13", /* VK_F13 0x7C */
4795 "f14", /* VK_F14 0x7D */
4796 "f15", /* VK_F15 0x7E */
4797 "f16", /* VK_F16 0x7F */
4798 "f17", /* VK_F17 0x80 */
4799 "f18", /* VK_F18 0x81 */
4800 "f19", /* VK_F19 0x82 */
4801 "f20", /* VK_F20 0x83 */
4802 "f21", /* VK_F21 0x84 */
4803 "f22", /* VK_F22 0x85 */
4804 "f23", /* VK_F23 0x86 */
4805 "f24", /* VK_F24 0x87 */
4807 0, 0, 0, 0, /* 0x88 .. 0x8B */
4808 0, 0, 0, 0, /* 0x8C .. 0x8F */
4810 "kp-numlock", /* VK_NUMLOCK 0x90 */
4811 "scroll", /* VK_SCROLL 0x91 */
4813 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4814 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4815 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4816 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4817 "kp-end", /* VK_NUMPAD_END 0x96 */
4818 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4819 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4820 "kp-up", /* VK_NUMPAD_UP 0x99 */
4821 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4822 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4823 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4824 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4826 0, 0, /* 0x9E .. 0x9F */
4829 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4830 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4831 * No other API or message will distinguish left and right keys this way.
4835 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4836 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4837 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4838 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4839 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4845 "attn", /* VK_ATTN 0xF6 */
4846 "crsel", /* VK_CRSEL 0xF7 */
4847 "exsel", /* VK_EXSEL 0xF8 */
4848 "ereof", /* VK_EREOF 0xF9 */
4849 "play", /* VK_PLAY 0xFA */
4850 "zoom", /* VK_ZOOM 0xFB */
4851 "noname", /* VK_NONAME 0xFC */
4852 "pa1", /* VK_PA1 0xFD */
4853 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4857 #else /* not HAVE_NTGUI */
4859 /* This should be dealt with in XTread_socket now, and that doesn't
4860 depend on the client system having the Kana syms defined. See also
4861 the XK_kana_A case below. */
4864 static char *lispy_kana_keys
[] =
4866 /* X Keysym value */
4867 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4868 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4869 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4870 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4871 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4872 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4873 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4874 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4875 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4876 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4877 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4878 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4879 "kana-i", "kana-u", "kana-e", "kana-o",
4880 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4881 "prolongedsound", "kana-A", "kana-I", "kana-U",
4882 "kana-E", "kana-O", "kana-KA", "kana-KI",
4883 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4884 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4885 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4886 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4887 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4888 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4889 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4890 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4891 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4892 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4893 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4894 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4896 #endif /* XK_kana_A */
4899 #define FUNCTION_KEY_OFFSET 0xff00
4901 /* You'll notice that this table is arranged to be conveniently
4902 indexed by X Windows keysym values. */
4903 static char *lispy_function_keys
[] =
4905 /* X Keysym value */
4907 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4908 "backspace", "tab", "linefeed", "clear",
4910 0, 0, 0, "pause", /* 0xff10...1f */
4911 0, 0, 0, 0, 0, 0, 0, "escape",
4913 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4914 "romaji", "hiragana", "katakana", "hiragana-katakana",
4915 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4916 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4917 "eisu-toggle", /* 0xff30...3f */
4918 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4919 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4921 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4922 "down", "prior", "next", "end",
4923 "begin", 0, 0, 0, 0, 0, 0, 0,
4924 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4935 "break", /* 0xff6b */
4938 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4939 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4940 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4941 0, 0, 0, 0, 0, 0, 0, 0,
4942 "kp-tab", /* 0xff89 */
4944 "kp-enter", /* 0xff8d */
4946 "kp-f1", /* 0xff91 */
4950 "kp-home", /* 0xff95 */
4955 "kp-prior", /* kp-page-up */
4956 "kp-next", /* kp-page-down */
4962 0, 0, 0, 0, 0, 0, 0, 0, 0,
4963 "kp-multiply", /* 0xffaa */
4968 "kp-divide", /* 0xffaf */
4969 "kp-0", /* 0xffb0 */
4970 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4973 "kp-equal", /* 0xffbd */
4974 "f1", /* 0xffbe */ /* IsFunctionKey */
4976 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4977 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4978 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4979 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4980 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4981 0, 0, 0, 0, 0, 0, 0, 0,
4982 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4983 0, 0, 0, 0, 0, 0, 0, "delete"
4986 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4987 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4989 static char *iso_lispy_function_keys
[] =
4991 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4992 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4993 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4994 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4995 "iso-lefttab", /* 0xfe20 */
4996 "iso-move-line-up", "iso-move-line-down",
4997 "iso-partial-line-up", "iso-partial-line-down",
4998 "iso-partial-space-left", "iso-partial-space-right",
4999 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5000 "iso-release-margin-left", "iso-release-margin-right",
5001 "iso-release-both-margins",
5002 "iso-fast-cursor-left", "iso-fast-cursor-right",
5003 "iso-fast-cursor-up", "iso-fast-cursor-down",
5004 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5005 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5008 #endif /* not HAVE_NTGUI */
5010 Lisp_Object Vlispy_mouse_stem
;
5012 static char *lispy_wheel_names
[] =
5014 "wheel-up", "wheel-down"
5017 /* drag-n-drop events are generated when a set of selected files are
5018 dragged from another application and dropped onto an Emacs window. */
5019 static char *lispy_drag_n_drop_names
[] =
5024 /* Scroll bar parts. */
5025 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5026 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5027 Lisp_Object Qtop
, Qratio
;
5029 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5030 Lisp_Object
*scroll_bar_parts
[] = {
5031 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5032 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5035 /* User signal events. */
5036 Lisp_Object Qusr1_signal
, Qusr2_signal
;
5038 Lisp_Object
*lispy_user_signals
[] =
5040 &Qusr1_signal
, &Qusr2_signal
5044 /* A vector, indexed by button number, giving the down-going location
5045 of currently depressed buttons, both scroll bar and non-scroll bar.
5047 The elements have the form
5048 (BUTTON-NUMBER MODIFIER-MASK . REST)
5049 where REST is the cdr of a position as it would be reported in the event.
5051 The make_lispy_event function stores positions here to tell the
5052 difference between click and drag events, and to store the starting
5053 location to be included in drag events. */
5055 static Lisp_Object button_down_location
;
5057 /* Information about the most recent up-going button event: Which
5058 button, what location, and what time. */
5060 static int last_mouse_button
;
5061 static int last_mouse_x
;
5062 static int last_mouse_y
;
5063 static unsigned long button_down_time
;
5065 /* The maximum time between clicks to make a double-click, or Qnil to
5066 disable double-click detection, or Qt for no time limit. */
5068 Lisp_Object Vdouble_click_time
;
5070 /* Maximum number of pixels the mouse may be moved between clicks
5071 to make a double-click. */
5073 EMACS_INT double_click_fuzz
;
5075 /* The number of clicks in this multiple-click. */
5077 int double_click_count
;
5079 /* Return position of a mouse click or wheel event */
5082 make_lispy_position (f
, x
, y
, time
)
5088 enum window_part part
;
5089 Lisp_Object posn
= Qnil
;
5090 Lisp_Object extra_info
= Qnil
;
5093 /* Set `window' to the window under frame pixel coordinates (x,y) */
5095 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5096 &part
, &wx
, &wy
, 0);
5100 if (WINDOWP (window
))
5102 /* It's a click in window window at frame coordinates (x,y) */
5103 struct window
*w
= XWINDOW (window
);
5104 Lisp_Object string_info
= Qnil
;
5105 int textpos
= -1, rx
= -1, ry
= -1;
5106 int dx
= -1, dy
= -1;
5107 int width
= -1, height
= -1;
5108 Lisp_Object object
= Qnil
;
5110 /* Set event coordinates to window-relative coordinates
5111 for constructing the Lisp event below. */
5115 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5117 /* Mode line or header line. Look for a string under
5118 the mouse that may have a `local-map' property. */
5122 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5124 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5125 &object
, &dx
, &dy
, &width
, &height
);
5126 if (STRINGP (string
))
5127 string_info
= Fcons (string
, make_number (charpos
));
5128 if (w
== XWINDOW (selected_window
))
5131 textpos
= XMARKER (w
->pointm
)->charpos
;
5133 else if (part
== ON_VERTICAL_BORDER
)
5135 posn
= Qvertical_line
;
5140 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5145 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5147 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5148 &object
, &dx
, &dy
, &width
, &height
);
5149 if (STRINGP (string
))
5150 string_info
= Fcons (string
, make_number (charpos
));
5152 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5154 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5157 if (part
== ON_RIGHT_FRINGE
)
5158 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5159 + window_box_width (w
, TEXT_AREA
)
5160 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5161 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5163 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5164 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5169 Lisp_Object string2
, object2
= Qnil
;
5170 struct display_pos p
;
5172 int width2
, height2
;
5173 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5174 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5175 &object2
, &dx2
, &dy2
,
5177 textpos
= CHARPOS (p
.pos
);
5178 if (rx
< 0) rx
= wx
;
5179 if (ry
< 0) ry
= wy
;
5180 if (dx
< 0) dx
= dx2
;
5181 if (dy
< 0) dy
= dy2
;
5182 if (width
< 0) width
= width2
;
5183 if (height
< 0) height
= height2
;
5187 posn
= make_number (textpos
);
5188 if (STRINGP (string2
))
5189 string_info
= Fcons (string2
,
5190 make_number (CHARPOS (p
.string_pos
)));
5196 #ifdef HAVE_WINDOW_SYSTEM
5197 if (IMAGEP (object
))
5199 Lisp_Object image_map
, hotspot
;
5200 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5202 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5204 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5205 posn
= XCAR (hotspot
);
5210 extra_info
= Fcons (object
,
5211 Fcons (Fcons (make_number (dx
),
5213 Fcons (Fcons (make_number (width
),
5214 make_number (height
)),
5218 extra_info
= Fcons (string_info
,
5219 Fcons (make_number (textpos
),
5220 Fcons (Fcons (make_number (rx
),
5226 XSETFRAME (window
, f
);
5231 XSETFASTINT (*x
, 0);
5232 XSETFASTINT (*y
, 0);
5235 return Fcons (window
,
5237 Fcons (Fcons (*x
, *y
),
5238 Fcons (make_number (time
),
5242 /* Given a struct input_event, build the lisp event which represents
5243 it. If EVENT is 0, build a mouse movement event from the mouse
5244 movement buffer, which should have a movement event in it.
5246 Note that events must be passed to this function in the order they
5247 are received; this function stores the location of button presses
5248 in order to build drag events when the button is released. */
5251 make_lispy_event (event
)
5252 struct input_event
*event
;
5256 switch (SWITCH_ENUM_CAST (event
->kind
))
5258 /* A simple keystroke. */
5259 case ASCII_KEYSTROKE_EVENT
:
5261 Lisp_Object lispy_c
;
5262 int c
= event
->code
& 0377;
5263 /* Turn ASCII characters into control characters
5265 if (event
->modifiers
& ctrl_modifier
)
5266 c
= make_ctrl_char (c
);
5268 /* Add in the other modifier bits. We took care of ctrl_modifier
5269 just above, and the shift key was taken care of by the X code,
5270 and applied to control characters by make_ctrl_char. */
5271 c
|= (event
->modifiers
5272 & (meta_modifier
| alt_modifier
5273 | hyper_modifier
| super_modifier
));
5274 /* Distinguish Shift-SPC from SPC. */
5275 if ((event
->code
& 0377) == 040
5276 && event
->modifiers
& shift_modifier
)
5277 c
|= shift_modifier
;
5278 button_down_time
= 0;
5279 XSETFASTINT (lispy_c
, c
);
5283 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5285 Lisp_Object lispy_c
;
5286 int c
= event
->code
;
5288 /* Add in the other modifier bits. We took care of ctrl_modifier
5289 just above, and the shift key was taken care of by the X code,
5290 and applied to control characters by make_ctrl_char. */
5291 c
|= (event
->modifiers
5292 & (meta_modifier
| alt_modifier
5293 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5294 /* What about the `shift' modifier ? */
5295 button_down_time
= 0;
5296 XSETFASTINT (lispy_c
, c
);
5300 /* A function key. The symbol may need to have modifier prefixes
5302 case NON_ASCII_KEYSTROKE_EVENT
:
5303 button_down_time
= 0;
5305 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5306 if (event
->code
== lispy_accent_codes
[i
])
5307 return modify_event_symbol (i
,
5309 Qfunction_key
, Qnil
,
5310 lispy_accent_keys
, &accent_key_syms
,
5311 (sizeof (lispy_accent_keys
)
5312 / sizeof (lispy_accent_keys
[0])));
5316 if (event
->code
>= 0x400 && event
->code
< 0x500)
5317 return modify_event_symbol (event
->code
- 0x400,
5318 event
->modifiers
& ~shift_modifier
,
5319 Qfunction_key
, Qnil
,
5320 lispy_kana_keys
, &func_key_syms
,
5321 (sizeof (lispy_kana_keys
)
5322 / sizeof (lispy_kana_keys
[0])));
5323 #endif /* XK_kana_A */
5326 #ifdef ISO_FUNCTION_KEY_OFFSET
5327 if (event
->code
< FUNCTION_KEY_OFFSET
5328 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5329 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5331 Qfunction_key
, Qnil
,
5332 iso_lispy_function_keys
, &func_key_syms
,
5333 (sizeof (iso_lispy_function_keys
)
5334 / sizeof (iso_lispy_function_keys
[0])));
5337 /* Handle system-specific or unknown keysyms. */
5338 if (event
->code
& (1 << 28)
5339 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5340 || (event
->code
- FUNCTION_KEY_OFFSET
5341 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5342 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5344 /* We need to use an alist rather than a vector as the cache
5345 since we can't make a vector long enuf. */
5346 if (NILP (current_kboard
->system_key_syms
))
5347 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5348 return modify_event_symbol (event
->code
,
5351 current_kboard
->Vsystem_key_alist
,
5352 0, ¤t_kboard
->system_key_syms
,
5356 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5358 Qfunction_key
, Qnil
,
5359 lispy_function_keys
, &func_key_syms
,
5360 (sizeof (lispy_function_keys
)
5361 / sizeof (lispy_function_keys
[0])));
5364 /* A mouse click. Figure out where it is, decide whether it's
5365 a press, click or drag, and build the appropriate structure. */
5366 case MOUSE_CLICK_EVENT
:
5367 #ifndef USE_TOOLKIT_SCROLL_BARS
5368 case SCROLL_BAR_CLICK_EVENT
:
5371 int button
= event
->code
;
5373 Lisp_Object position
;
5374 Lisp_Object
*start_pos_ptr
;
5375 Lisp_Object start_pos
;
5379 /* Build the position as appropriate for this mouse click. */
5380 if (event
->kind
== MOUSE_CLICK_EVENT
)
5382 struct frame
*f
= XFRAME (event
->frame_or_window
);
5383 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5387 /* Ignore mouse events that were made on frame that
5388 have been deleted. */
5389 if (! FRAME_LIVE_P (f
))
5392 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5393 /* EVENT->x and EVENT->y are frame-relative pixel
5394 coordinates at this place. Under old redisplay, COLUMN
5395 and ROW are set to frame relative glyph coordinates
5396 which are then used to determine whether this click is
5397 in a menu (non-toolkit version). */
5398 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5399 &column
, &row
, NULL
, 1);
5401 /* In the non-toolkit version, clicks on the menu bar
5402 are ordinary button events in the event buffer.
5403 Distinguish them, and invoke the menu.
5405 (In the toolkit version, the toolkit handles the menu bar
5406 and Emacs doesn't know about it until after the user
5407 makes a selection.) */
5408 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5409 && (event
->modifiers
& down_modifier
))
5411 Lisp_Object items
, item
;
5416 /* Activate the menu bar on the down event. If the
5417 up event comes in before the menu code can deal with it,
5419 if (! (event
->modifiers
& down_modifier
))
5423 /* Find the menu bar item under `column'. */
5425 items
= FRAME_MENU_BAR_ITEMS (f
);
5426 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5428 Lisp_Object pos
, string
;
5429 string
= AREF (items
, i
+ 1);
5430 pos
= AREF (items
, i
+ 3);
5433 if (column
>= XINT (pos
)
5434 && column
< XINT (pos
) + SCHARS (string
))
5436 item
= AREF (items
, i
);
5441 /* ELisp manual 2.4b says (x y) are window relative but
5442 code says they are frame-relative. */
5444 = Fcons (event
->frame_or_window
,
5446 Fcons (Fcons (event
->x
, event
->y
),
5447 Fcons (make_number (event
->timestamp
),
5450 return Fcons (item
, Fcons (position
, Qnil
));
5452 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5454 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5457 #ifndef USE_TOOLKIT_SCROLL_BARS
5460 /* It's a scrollbar click. */
5462 Lisp_Object portion_whole
;
5465 window
= event
->frame_or_window
;
5466 portion_whole
= Fcons (event
->x
, event
->y
);
5467 part
= *scroll_bar_parts
[(int) event
->part
];
5471 Fcons (Qvertical_scroll_bar
,
5472 Fcons (portion_whole
,
5473 Fcons (make_number (event
->timestamp
),
5474 Fcons (part
, Qnil
)))));
5476 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5478 if (button
>= ASIZE (button_down_location
))
5480 button_down_location
= larger_vector (button_down_location
,
5482 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5485 start_pos_ptr
= &AREF (button_down_location
, button
);
5486 start_pos
= *start_pos_ptr
;
5487 *start_pos_ptr
= Qnil
;
5490 /* On window-system frames, use the value of
5491 double-click-fuzz as is. On other frames, interpret it
5492 as a multiple of 1/8 characters. */
5496 if (WINDOWP (event
->frame_or_window
))
5497 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5498 else if (FRAMEP (event
->frame_or_window
))
5499 f
= XFRAME (event
->frame_or_window
);
5503 if (FRAME_WINDOW_P (f
))
5504 fuzz
= double_click_fuzz
;
5506 fuzz
= double_click_fuzz
/ 8;
5508 is_double
= (button
== last_mouse_button
5509 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5510 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5511 && button_down_time
!= 0
5512 && (EQ (Vdouble_click_time
, Qt
)
5513 || (INTEGERP (Vdouble_click_time
)
5514 && ((int)(event
->timestamp
- button_down_time
)
5515 < XINT (Vdouble_click_time
)))));
5518 last_mouse_button
= button
;
5519 last_mouse_x
= XINT (event
->x
);
5520 last_mouse_y
= XINT (event
->y
);
5522 /* If this is a button press, squirrel away the location, so
5523 we can decide later whether it was a click or a drag. */
5524 if (event
->modifiers
& down_modifier
)
5528 double_click_count
++;
5529 event
->modifiers
|= ((double_click_count
> 2)
5534 double_click_count
= 1;
5535 button_down_time
= event
->timestamp
;
5536 *start_pos_ptr
= Fcopy_alist (position
);
5539 /* Now we're releasing a button - check the co-ordinates to
5540 see if this was a click or a drag. */
5541 else if (event
->modifiers
& up_modifier
)
5543 /* If we did not see a down before this up, ignore the up.
5544 Probably this happened because the down event chose a
5545 menu item. It would be an annoyance to treat the
5546 release of the button that chose the menu item as a
5549 if (!CONSP (start_pos
))
5552 event
->modifiers
&= ~up_modifier
;
5553 #if 0 /* Formerly we treated an up with no down as a click event. */
5554 if (!CONSP (start_pos
))
5555 event
->modifiers
|= click_modifier
;
5560 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5562 /* The third element of every position
5563 should be the (x,y) pair. */
5564 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5566 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5568 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5569 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5572 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5573 && ydiff
< double_click_fuzz
5574 && ydiff
> - double_click_fuzz
)
5575 /* Mouse hasn't moved (much). */
5576 event
->modifiers
|= click_modifier
;
5579 button_down_time
= 0;
5580 event
->modifiers
|= drag_modifier
;
5583 /* Don't check is_double; treat this as multiple
5584 if the down-event was multiple. */
5585 if (double_click_count
> 1)
5586 event
->modifiers
|= ((double_click_count
> 2)
5592 /* Every mouse event should either have the down_modifier or
5593 the up_modifier set. */
5597 /* Get the symbol we should use for the mouse click. */
5600 head
= modify_event_symbol (button
,
5602 Qmouse_click
, Vlispy_mouse_stem
,
5605 XVECTOR (mouse_syms
)->size
);
5606 if (event
->modifiers
& drag_modifier
)
5611 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5614 Fcons (make_number (double_click_count
),
5625 Lisp_Object position
;
5628 /* Build the position as appropriate for this mouse click. */
5629 struct frame
*f
= XFRAME (event
->frame_or_window
);
5631 /* Ignore wheel events that were made on frame that have been
5633 if (! FRAME_LIVE_P (f
))
5636 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5639 /* Set double or triple modifiers to indicate the wheel speed. */
5641 /* On window-system frames, use the value of
5642 double-click-fuzz as is. On other frames, interpret it
5643 as a multiple of 1/8 characters. */
5648 if (WINDOWP (event
->frame_or_window
))
5649 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5650 else if (FRAMEP (event
->frame_or_window
))
5651 f
= XFRAME (event
->frame_or_window
);
5655 if (FRAME_WINDOW_P (f
))
5656 fuzz
= double_click_fuzz
;
5658 fuzz
= double_click_fuzz
/ 8;
5660 is_double
= (last_mouse_button
< 0
5661 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5662 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5663 && button_down_time
!= 0
5664 && (EQ (Vdouble_click_time
, Qt
)
5665 || (INTEGERP (Vdouble_click_time
)
5666 && ((int)(event
->timestamp
- button_down_time
)
5667 < XINT (Vdouble_click_time
)))));
5670 double_click_count
++;
5671 event
->modifiers
|= ((double_click_count
> 2)
5677 double_click_count
= 1;
5678 event
->modifiers
|= click_modifier
;
5681 button_down_time
= event
->timestamp
;
5682 /* Use a negative value to distinguish wheel from mouse button. */
5683 last_mouse_button
= -1;
5684 last_mouse_x
= XINT (event
->x
);
5685 last_mouse_y
= XINT (event
->y
);
5691 if (event
->modifiers
& up_modifier
)
5693 /* Emit a wheel-up event. */
5694 event
->modifiers
&= ~up_modifier
;
5697 else if (event
->modifiers
& down_modifier
)
5699 /* Emit a wheel-down event. */
5700 event
->modifiers
&= ~down_modifier
;
5704 /* Every wheel event should either have the down_modifier or
5705 the up_modifier set. */
5708 /* Get the symbol we should use for the wheel event. */
5709 head
= modify_event_symbol (symbol_num
,
5715 ASIZE (wheel_syms
));
5718 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5721 Fcons (make_number (double_click_count
),
5730 #ifdef USE_TOOLKIT_SCROLL_BARS
5732 /* We don't have down and up events if using toolkit scroll bars,
5733 so make this always a click event. Store in the `part' of
5734 the Lisp event a symbol which maps to the following actions:
5736 `above_handle' page up
5737 `below_handle' page down
5741 `bottom' bottom of buffer
5742 `handle' thumb has been dragged.
5743 `end-scroll' end of interaction with scroll bar
5745 The incoming input_event contains in its `part' member an
5746 index of type `enum scroll_bar_part' which we can use as an
5747 index in scroll_bar_parts to get the appropriate symbol. */
5749 case SCROLL_BAR_CLICK_EVENT
:
5751 Lisp_Object position
, head
, window
, portion_whole
, part
;
5753 window
= event
->frame_or_window
;
5754 portion_whole
= Fcons (event
->x
, event
->y
);
5755 part
= *scroll_bar_parts
[(int) event
->part
];
5759 Fcons (Qvertical_scroll_bar
,
5760 Fcons (portion_whole
,
5761 Fcons (make_number (event
->timestamp
),
5762 Fcons (part
, Qnil
)))));
5764 /* Always treat scroll bar events as clicks. */
5765 event
->modifiers
|= click_modifier
;
5766 event
->modifiers
&= ~up_modifier
;
5768 if (event
->code
>= ASIZE (mouse_syms
))
5769 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5771 /* Get the symbol we should use for the mouse click. */
5772 head
= modify_event_symbol (event
->code
,
5777 XVECTOR (mouse_syms
)->size
);
5778 return Fcons (head
, Fcons (position
, Qnil
));
5781 #endif /* USE_TOOLKIT_SCROLL_BARS */
5784 case W32_SCROLL_BAR_CLICK_EVENT
:
5786 int button
= event
->code
;
5788 Lisp_Object position
;
5789 Lisp_Object
*start_pos_ptr
;
5790 Lisp_Object start_pos
;
5794 Lisp_Object portion_whole
;
5797 window
= event
->frame_or_window
;
5798 portion_whole
= Fcons (event
->x
, event
->y
);
5799 part
= *scroll_bar_parts
[(int) event
->part
];
5803 Fcons (Qvertical_scroll_bar
,
5804 Fcons (portion_whole
,
5805 Fcons (make_number (event
->timestamp
),
5806 Fcons (part
, Qnil
)))));
5809 /* Always treat W32 scroll bar events as clicks. */
5810 event
->modifiers
|= click_modifier
;
5813 /* Get the symbol we should use for the mouse click. */
5816 head
= modify_event_symbol (button
,
5821 XVECTOR (mouse_syms
)->size
);
5827 #endif /* WINDOWSNT */
5829 case DRAG_N_DROP_EVENT
:
5832 Lisp_Object head
, position
;
5835 /* The frame_or_window field should be a cons of the frame in
5836 which the event occurred and a list of the filenames
5838 if (! CONSP (event
->frame_or_window
))
5841 f
= XFRAME (XCAR (event
->frame_or_window
));
5842 files
= XCDR (event
->frame_or_window
);
5844 /* Ignore mouse events that were made on frames that
5845 have been deleted. */
5846 if (! FRAME_LIVE_P (f
))
5849 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5852 head
= modify_event_symbol (0, event
->modifiers
,
5854 lispy_drag_n_drop_names
,
5855 &drag_n_drop_syms
, 1);
5861 #endif /* HAVE_MOUSE */
5863 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5864 || defined (USE_GTK)
5865 case MENU_BAR_EVENT
:
5866 if (EQ (event
->arg
, event
->frame_or_window
))
5867 /* This is the prefix key. We translate this to
5868 `(menu_bar)' because the code in keyboard.c for menu
5869 events, which we use, relies on this. */
5870 return Fcons (Qmenu_bar
, Qnil
);
5874 case SELECT_WINDOW_EVENT
:
5875 /* Make an event (select-window (WINDOW)). */
5876 return Fcons (Qselect_window
,
5877 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5880 case TOOL_BAR_EVENT
:
5881 if (EQ (event
->arg
, event
->frame_or_window
))
5882 /* This is the prefix key. We translate this to
5883 `(tool_bar)' because the code in keyboard.c for tool bar
5884 events, which we use, relies on this. */
5885 return Fcons (Qtool_bar
, Qnil
);
5886 else if (SYMBOLP (event
->arg
))
5887 return apply_modifiers (event
->modifiers
, event
->arg
);
5890 case USER_SIGNAL_EVENT
:
5891 /* A user signal. */
5892 return *lispy_user_signals
[event
->code
];
5894 case SAVE_SESSION_EVENT
:
5895 return Qsave_session
;
5897 /* The 'kind' field of the event is something we don't recognize. */
5906 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5908 Lisp_Object bar_window
;
5909 enum scroll_bar_part part
;
5913 /* Is it a scroll bar movement? */
5914 if (frame
&& ! NILP (bar_window
))
5916 Lisp_Object part_sym
;
5918 part_sym
= *scroll_bar_parts
[(int) part
];
5919 return Fcons (Qscroll_bar_movement
,
5920 (Fcons (Fcons (bar_window
,
5921 Fcons (Qvertical_scroll_bar
,
5922 Fcons (Fcons (x
, y
),
5923 Fcons (make_number (time
),
5929 /* Or is it an ordinary mouse movement? */
5932 Lisp_Object position
;
5934 position
= make_lispy_position (frame
, &x
, &y
, time
);
5936 return Fcons (Qmouse_movement
,
5942 #endif /* HAVE_MOUSE */
5944 /* Construct a switch frame event. */
5946 make_lispy_switch_frame (frame
)
5949 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5952 /* Manipulating modifiers. */
5954 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5956 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5957 SYMBOL's name of the end of the modifiers; the string from this
5958 position is the unmodified symbol name.
5960 This doesn't use any caches. */
5963 parse_modifiers_uncached (symbol
, modifier_end
)
5971 CHECK_SYMBOL (symbol
);
5974 name
= SYMBOL_NAME (symbol
);
5976 for (i
= 0; i
+2 <= SBYTES (name
); )
5978 int this_mod_end
= 0;
5981 /* See if the name continues with a modifier word.
5982 Check that the word appears, but don't check what follows it.
5983 Set this_mod and this_mod_end to record what we find. */
5985 switch (SREF (name
, i
))
5987 #define SINGLE_LETTER_MOD(BIT) \
5988 (this_mod_end = i + 1, this_mod = BIT)
5991 SINGLE_LETTER_MOD (alt_modifier
);
5995 SINGLE_LETTER_MOD (ctrl_modifier
);
5999 SINGLE_LETTER_MOD (hyper_modifier
);
6003 SINGLE_LETTER_MOD (meta_modifier
);
6007 SINGLE_LETTER_MOD (shift_modifier
);
6011 SINGLE_LETTER_MOD (super_modifier
);
6014 #undef SINGLE_LETTER_MOD
6016 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6017 if (i + LEN + 1 <= SBYTES (name) \
6018 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6020 this_mod_end = i + LEN; \
6025 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6026 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6027 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6031 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6033 #undef MULTI_LETTER_MOD
6037 /* If we found no modifier, stop looking for them. */
6038 if (this_mod_end
== 0)
6041 /* Check there is a dash after the modifier, so that it
6042 really is a modifier. */
6043 if (this_mod_end
>= SBYTES (name
)
6044 || SREF (name
, this_mod_end
) != '-')
6047 /* This modifier is real; look for another. */
6048 modifiers
|= this_mod
;
6049 i
= this_mod_end
+ 1;
6052 /* Should we include the `click' modifier? */
6053 if (! (modifiers
& (down_modifier
| drag_modifier
6054 | double_modifier
| triple_modifier
))
6055 && i
+ 7 == SBYTES (name
)
6056 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6057 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6058 modifiers
|= click_modifier
;
6066 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6067 prepended to the string BASE[0..BASE_LEN-1].
6068 This doesn't use any caches. */
6070 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6073 int base_len
, base_len_byte
;
6075 /* Since BASE could contain nulls, we can't use intern here; we have
6076 to use Fintern, which expects a genuine Lisp_String, and keeps a
6079 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6085 /* Only the event queue may use the `up' modifier; it should always
6086 be turned into a click or drag event before presented to lisp code. */
6087 if (modifiers
& up_modifier
)
6090 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6091 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6092 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6093 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6094 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6095 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6096 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6097 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6098 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6099 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6100 /* The click modifier is denoted by the absence of other modifiers. */
6104 mod_len
= p
- new_mods
;
6108 Lisp_Object new_name
;
6110 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6111 mod_len
+ base_len_byte
);
6112 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6113 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6115 return Fintern (new_name
, Qnil
);
6120 static char *modifier_names
[] =
6122 "up", "down", "drag", "click", "double", "triple", 0, 0,
6123 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6124 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6126 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6128 static Lisp_Object modifier_symbols
;
6130 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6132 lispy_modifier_list (modifiers
)
6135 Lisp_Object modifier_list
;
6138 modifier_list
= Qnil
;
6139 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6140 if (modifiers
& (1<<i
))
6141 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6144 return modifier_list
;
6148 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6149 where UNMODIFIED is the unmodified form of SYMBOL,
6150 MASK is the set of modifiers present in SYMBOL's name.
6151 This is similar to parse_modifiers_uncached, but uses the cache in
6152 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6153 Qevent_symbol_elements property. */
6156 parse_modifiers (symbol
)
6159 Lisp_Object elements
;
6161 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6162 if (CONSP (elements
))
6167 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6168 Lisp_Object unmodified
;
6171 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6172 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6175 if (modifiers
& ~INTMASK
)
6177 XSETFASTINT (mask
, modifiers
);
6178 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6180 /* Cache the parsing results on SYMBOL. */
6181 Fput (symbol
, Qevent_symbol_element_mask
,
6183 Fput (symbol
, Qevent_symbol_elements
,
6184 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6186 /* Since we know that SYMBOL is modifiers applied to unmodified,
6187 it would be nice to put that in unmodified's cache.
6188 But we can't, since we're not sure that parse_modifiers is
6195 /* Apply the modifiers MODIFIERS to the symbol BASE.
6196 BASE must be unmodified.
6198 This is like apply_modifiers_uncached, but uses BASE's
6199 Qmodifier_cache property, if present. It also builds
6200 Qevent_symbol_elements properties, since it has that info anyway.
6202 apply_modifiers copies the value of BASE's Qevent_kind property to
6203 the modified symbol. */
6205 apply_modifiers (modifiers
, base
)
6209 Lisp_Object cache
, index
, entry
, new_symbol
;
6211 /* Mask out upper bits. We don't know where this value's been. */
6212 modifiers
&= INTMASK
;
6214 /* The click modifier never figures into cache indices. */
6215 cache
= Fget (base
, Qmodifier_cache
);
6216 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6217 entry
= assq_no_quit (index
, cache
);
6220 new_symbol
= XCDR (entry
);
6223 /* We have to create the symbol ourselves. */
6224 new_symbol
= apply_modifiers_uncached (modifiers
,
6225 SDATA (SYMBOL_NAME (base
)),
6226 SCHARS (SYMBOL_NAME (base
)),
6227 SBYTES (SYMBOL_NAME (base
)));
6229 /* Add the new symbol to the base's cache. */
6230 entry
= Fcons (index
, new_symbol
);
6231 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6233 /* We have the parsing info now for free, so we could add it to
6235 XSETFASTINT (index, modifiers);
6236 Fput (new_symbol, Qevent_symbol_element_mask,
6237 Fcons (base, Fcons (index, Qnil)));
6238 Fput (new_symbol, Qevent_symbol_elements,
6239 Fcons (base, lispy_modifier_list (modifiers)));
6240 Sadly, this is only correct if `base' is indeed a base event,
6241 which is not necessarily the case. -stef */
6244 /* Make sure this symbol is of the same kind as BASE.
6246 You'd think we could just set this once and for all when we
6247 intern the symbol above, but reorder_modifiers may call us when
6248 BASE's property isn't set right; we can't assume that just
6249 because it has a Qmodifier_cache property it must have its
6250 Qevent_kind set right as well. */
6251 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6255 kind
= Fget (base
, Qevent_kind
);
6257 Fput (new_symbol
, Qevent_kind
, kind
);
6264 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6265 return a symbol with the modifiers placed in the canonical order.
6266 Canonical order is alphabetical, except for down and drag, which
6267 always come last. The 'click' modifier is never written out.
6269 Fdefine_key calls this to make sure that (for example) C-M-foo
6270 and M-C-foo end up being equivalent in the keymap. */
6273 reorder_modifiers (symbol
)
6276 /* It's hopefully okay to write the code this way, since everything
6277 will soon be in caches, and no consing will be done at all. */
6280 parsed
= parse_modifiers (symbol
);
6281 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6286 /* For handling events, we often want to produce a symbol whose name
6287 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6288 to some base, like the name of a function key or mouse button.
6289 modify_event_symbol produces symbols of this sort.
6291 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6292 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6295 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6296 into symbol names, or a string specifying a name stem used to
6297 construct a symbol name or the form `STEM-N', where N is the decimal
6298 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6299 non-nil; otherwise NAME_TABLE is used.
6301 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6302 persist between calls to modify_event_symbol that it can use to
6303 store a cache of the symbols it's generated for this NAME_TABLE
6304 before. The object stored there may be a vector or an alist.
6306 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6308 MODIFIERS is a set of modifier bits (as given in struct input_events)
6309 whose prefixes should be applied to the symbol name.
6311 SYMBOL_KIND is the value to be placed in the event_kind property of
6312 the returned symbol.
6314 The symbols we create are supposed to have an
6315 `event-symbol-elements' property, which lists the modifiers present
6316 in the symbol's name. */
6319 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6320 name_table
, symbol_table
, table_size
)
6323 Lisp_Object symbol_kind
;
6324 Lisp_Object name_alist_or_stem
;
6326 Lisp_Object
*symbol_table
;
6327 unsigned int table_size
;
6330 Lisp_Object symbol_int
;
6332 /* Get rid of the "vendor-specific" bit here. */
6333 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6335 /* Is this a request for a valid symbol? */
6336 if (symbol_num
< 0 || symbol_num
>= table_size
)
6339 if (CONSP (*symbol_table
))
6340 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6342 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6343 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6344 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6345 we've never used that symbol before. */
6348 if (! VECTORP (*symbol_table
)
6349 || XVECTOR (*symbol_table
)->size
!= table_size
)
6353 XSETFASTINT (size
, table_size
);
6354 *symbol_table
= Fmake_vector (size
, Qnil
);
6357 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6360 /* Have we already used this symbol before? */
6363 /* No; let's create it. */
6364 if (CONSP (name_alist_or_stem
))
6365 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6366 else if (STRINGP (name_alist_or_stem
))
6368 int len
= SBYTES (name_alist_or_stem
);
6369 char *buf
= (char *) alloca (len
+ 50);
6370 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6371 (long) XINT (symbol_int
) + 1);
6372 value
= intern (buf
);
6374 else if (name_table
!= 0 && name_table
[symbol_num
])
6375 value
= intern (name_table
[symbol_num
]);
6377 #ifdef HAVE_WINDOW_SYSTEM
6380 char *name
= x_get_keysym_name (symbol_num
);
6382 value
= intern (name
);
6389 sprintf (buf
, "key-%d", symbol_num
);
6390 value
= intern (buf
);
6393 if (CONSP (*symbol_table
))
6394 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6396 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6398 /* Fill in the cache entries for this symbol; this also
6399 builds the Qevent_symbol_elements property, which the user
6401 apply_modifiers (modifiers
& click_modifier
, value
);
6402 Fput (value
, Qevent_kind
, symbol_kind
);
6405 /* Apply modifiers to that symbol. */
6406 return apply_modifiers (modifiers
, value
);
6409 /* Convert a list that represents an event type,
6410 such as (ctrl meta backspace), into the usual representation of that
6411 event type as a number or a symbol. */
6413 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6414 doc
: /* Convert the event description list EVENT-DESC to an event type.
6415 EVENT-DESC should contain one base event type (a character or symbol)
6416 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6417 drag, down, double or triple). The base must be last.
6418 The return value is an event type (a character or symbol) which
6419 has the same base event type and all the specified modifiers. */)
6421 Lisp_Object event_desc
;
6429 while (CONSP (rest
))
6437 /* Given a symbol, see if it is a modifier name. */
6438 if (SYMBOLP (elt
) && CONSP (rest
))
6439 this = parse_solitary_modifier (elt
);
6443 else if (!NILP (base
))
6444 error ("Two bases given in one event");
6450 /* Let the symbol A refer to the character A. */
6451 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6452 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6454 if (INTEGERP (base
))
6456 /* Turn (shift a) into A. */
6457 if ((modifiers
& shift_modifier
) != 0
6458 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6460 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6461 modifiers
&= ~shift_modifier
;
6464 /* Turn (control a) into C-a. */
6465 if (modifiers
& ctrl_modifier
)
6466 return make_number ((modifiers
& ~ctrl_modifier
)
6467 | make_ctrl_char (XINT (base
)));
6469 return make_number (modifiers
| XINT (base
));
6471 else if (SYMBOLP (base
))
6472 return apply_modifiers (modifiers
, base
);
6475 error ("Invalid base event");
6480 /* Try to recognize SYMBOL as a modifier name.
6481 Return the modifier flag bit, or 0 if not recognized. */
6484 parse_solitary_modifier (symbol
)
6487 Lisp_Object name
= SYMBOL_NAME (symbol
);
6489 switch (SREF (name
, 0))
6491 #define SINGLE_LETTER_MOD(BIT) \
6492 if (SBYTES (name) == 1) \
6495 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6496 if (LEN == SBYTES (name) \
6497 && ! strncmp (SDATA (name), NAME, LEN)) \
6501 SINGLE_LETTER_MOD (alt_modifier
);
6505 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6509 SINGLE_LETTER_MOD (ctrl_modifier
);
6513 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6514 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6518 SINGLE_LETTER_MOD (hyper_modifier
);
6522 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6526 SINGLE_LETTER_MOD (meta_modifier
);
6530 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6534 SINGLE_LETTER_MOD (shift_modifier
);
6538 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6539 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6540 SINGLE_LETTER_MOD (super_modifier
);
6544 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6545 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6546 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6550 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6553 #undef SINGLE_LETTER_MOD
6554 #undef MULTI_LETTER_MOD
6560 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6561 Such a list is not valid as an event,
6562 but it can be a Lucid-style event type list. */
6565 lucid_event_type_list_p (object
)
6570 if (! CONSP (object
))
6573 if (EQ (XCAR (object
), Qhelp_echo
)
6574 || EQ (XCAR (object
), Qvertical_line
)
6575 || EQ (XCAR (object
), Qmode_line
)
6576 || EQ (XCAR (object
), Qheader_line
))
6579 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6583 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6590 /* Store into *addr a value nonzero if terminal input chars are available.
6591 Serves the purpose of ioctl (0, FIONREAD, addr)
6592 but works even if FIONREAD does not exist.
6593 (In fact, this may actually read some input.)
6595 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6596 timer events that are ripe.
6597 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6598 events (FOCUS_IN_EVENT).
6599 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6600 movements and toolkit scroll bar thumb drags. */
6603 get_input_pending (addr
, flags
)
6607 /* First of all, have we already counted some input? */
6608 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6610 /* If input is being read as it arrives, and we have none, there is none. */
6611 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6614 /* Try to read some input and see how much we get. */
6616 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6619 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6622 gobble_input (expected
)
6627 if (interrupt_input
)
6630 mask
= sigblock (sigmask (SIGIO
));
6631 read_avail_input (expected
);
6635 #ifdef POLL_FOR_INPUT
6636 /* XXX This condition was (read_socket_hook && !interrupt_input),
6637 but read_socket_hook is not global anymore. Let's pretend that
6639 if (!interrupt_input
&& poll_suppress_count
== 0)
6642 mask
= sigblock (sigmask (SIGALRM
));
6643 read_avail_input (expected
);
6649 read_avail_input (expected
);
6653 /* Put a BUFFER_SWITCH_EVENT in the buffer
6654 so that read_key_sequence will notice the new current buffer. */
6657 record_asynch_buffer_change ()
6659 struct input_event event
;
6663 event
.kind
= BUFFER_SWITCH_EVENT
;
6664 event
.frame_or_window
= Qnil
;
6668 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6669 The purpose of the event is to make read_key_sequence look up the
6670 keymaps again. If we aren't in read_key_sequence, we don't need one,
6671 and the event could cause trouble by messing up (input-pending-p). */
6672 tem
= Fwaiting_for_user_input_p ();
6676 /* We never need these events if we have no asynchronous subprocesses. */
6680 /* Make sure no interrupt happens while storing the event. */
6682 if (interrupt_input
)
6685 mask
= sigblock (sigmask (SIGIO
));
6686 kbd_buffer_store_event (&event
);
6693 kbd_buffer_store_event (&event
);
6700 /* Read any terminal input already buffered up by the system
6701 into the kbd_buffer, but do not wait.
6703 EXPECTED should be nonzero if the caller knows there is some input.
6705 Except on VMS, all input is read by this function.
6706 If interrupt_input is nonzero, this function MUST be called
6707 only when SIGIO is blocked.
6709 Returns the number of keyboard chars read, or -1 meaning
6710 this is a bad time to try to read input. */
6713 read_avail_input (expected
)
6720 /* Loop through the available devices, and call their input hooks. */
6724 struct device
*next
= d
->next_device
;
6726 if (d
->read_socket_hook
)
6729 struct input_event hold_quit
;
6731 EVENT_INIT (hold_quit
);
6732 hold_quit
.kind
= NO_EVENT
;
6734 /* No need for FIONREAD or fcntl; just say don't wait. */
6735 while (nr
= (*d
->read_socket_hook
) (d
, expected
, &hold_quit
), nr
> 0)
6741 if (nr
== -1) /* Not OK to read input now. */
6745 else if (nr
== -2) /* Non-transient error. */
6747 /* The display device terminated; it should be closed. */
6749 /* Kill Emacs if this was our last display. */
6750 if (! device_list
->next_device
)
6751 /* Formerly simply reported no input, but that
6752 sometimes led to a failure of Emacs to terminate.
6753 SIGHUP seems appropriate if we can't reach the
6755 /* ??? Is it really right to send the signal just to
6756 this process rather than to the whole process
6757 group? Perhaps on systems with FIONREAD Emacs is
6758 alone in its group. */
6759 kill (getpid (), SIGHUP
);
6761 /* XXX Is calling delete_device safe here? It calls Fdelete_frame. */
6762 if (d
->delete_device_hook
)
6763 (*d
->delete_device_hook
) (d
);
6768 if (hold_quit
.kind
!= NO_EVENT
)
6769 kbd_buffer_store_event (&hold_quit
);
6781 /* This is the tty way of reading available input.
6783 Note that each terminal device has its own `struct device' object,
6784 and so this function is called once for each individual termcap
6785 display. The first parameter indicates which device to read from. */
6788 tty_read_avail_input (struct device
*device
,
6790 struct input_event
*hold_quit
)
6792 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6793 the kbd_buffer can really hold. That may prevent loss
6794 of characters on some systems when input is stuffed at us. */
6795 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6797 struct tty_display_info
*tty
= device
->display_info
.tty
;
6800 if (device
->type
!= output_termcap
)
6803 /* XXX I think the following code should be moved to separate hook
6804 functions in system-dependent files. */
6807 #else /* not WINDOWSNT */
6809 n_to_read
= dos_keysns ();
6813 cbuf
[0] = dos_keyread ();
6816 #else /* not MSDOS */
6818 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6822 return 0; /* The terminal is suspended. */
6824 /* Determine how many characters we should *try* to read. */
6826 /* Find out how much input is available. */
6827 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6829 if (! noninteractive
)
6830 return -2; /* Close this device. */
6836 if (n_to_read
> sizeof cbuf
)
6837 n_to_read
= sizeof cbuf
;
6838 #else /* no FIONREAD */
6839 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6840 /* Read some input if available, but don't wait. */
6841 n_to_read
= sizeof cbuf
;
6842 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6848 /* Now read; for one reason or another, this will not block.
6849 NREAD is set to the number of chars read. */
6852 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6853 /* POSIX infers that processes which are not in the session leader's
6854 process group won't get SIGHUP's at logout time. BSDI adheres to
6855 this part standard and returns -1 from read (0) with errno==EIO
6856 when the control tty is taken away.
6857 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6858 if (nread
== -1 && errno
== EIO
)
6859 return -2; /* Close this device. */
6860 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6861 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6862 This looks incorrect, but it isn't, because _BSD causes
6863 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6864 and that causes a value other than 0 when there is no input. */
6866 return -2; /* Close this device. */
6870 /* We used to retry the read if it was interrupted.
6871 But this does the wrong thing when O_NDELAY causes
6872 an EAGAIN error. Does anybody know of a situation
6873 where a retry is actually needed? */
6875 nread
< 0 && (errno
== EAGAIN
6889 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6890 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6891 #endif /* USG or DGUX or CYGWIN */
6892 #endif /* no FIONREAD */
6897 #endif /* not MSDOS */
6898 #endif /* not WINDOWSNT */
6900 for (i
= 0; i
< nread
; i
++)
6902 struct input_event buf
;
6904 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6906 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6907 buf
.modifiers
= meta_modifier
;
6908 if (tty
->meta_key
!= 2)
6912 /* Set the frame corresponding to the active tty. Note that the
6913 value of selected_frame is not reliable here, redisplay tends
6914 to temporarily change it. */
6915 buf
.frame_or_window
= tty
->top_frame
;
6918 kbd_buffer_store_event (&buf
);
6919 /* Don't look at input that follows a C-g too closely.
6920 This reduces lossage due to autorepeat on C-g. */
6921 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6922 && buf
.code
== quit_char
)
6928 #endif /* not VMS */
6931 handle_async_input ()
6934 extern int select_alarmed
;
6937 interrupt_input_pending
= 0;
6942 nread
= read_avail_input (1);
6943 /* -1 means it's not ok to read the input now.
6944 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6945 0 means there was no keyboard input available. */
6950 select_alarmed
= 1; /* Force the select emulator back to life */
6955 #ifdef SIGIO /* for entire page */
6956 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6959 input_available_signal (signo
)
6962 /* Must preserve main program's value of errno. */
6963 int old_errno
= errno
;
6964 #if defined (USG) && !defined (POSIX_SIGNALS)
6965 /* USG systems forget handlers when they are used;
6966 must reestablish each time */
6967 signal (signo
, input_available_signal
);
6975 interrupt_input_pending
= 1;
6977 SIGNAL_THREAD_CHECK (signo
);
6980 if (input_available_clear_time
)
6981 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6984 handle_async_input ();
6994 /* Send ourselves a SIGIO.
6996 This function exists so that the UNBLOCK_INPUT macro in
6997 blockinput.h can have some way to take care of input we put off
6998 dealing with, without assuming that every file which uses
6999 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7001 reinvoke_input_signal ()
7004 handle_async_input ();
7010 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7011 static Lisp_Object menu_bar_one_keymap_changed_items
;
7013 /* These variables hold the vector under construction within
7014 menu_bar_items and its subroutines, and the current index
7015 for storing into that vector. */
7016 static Lisp_Object menu_bar_items_vector
;
7017 static int menu_bar_items_index
;
7019 /* Return a vector of menu items for a menu bar, appropriate
7020 to the current buffer. Each item has three elements in the vector:
7023 OLD is an old vector we can optionally reuse, or nil. */
7026 menu_bar_items (old
)
7029 /* The number of keymaps we're scanning right now, and the number of
7030 keymaps we have allocated space for. */
7033 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7034 in the current keymaps, or nil where it is not a prefix. */
7037 Lisp_Object def
, tail
;
7046 /* In order to build the menus, we need to call the keymap
7047 accessors. They all call QUIT. But this function is called
7048 during redisplay, during which a quit is fatal. So inhibit
7049 quitting while building the menus.
7050 We do this instead of specbind because (1) errors will clear it anyway
7051 and (2) this avoids risk of specpdl overflow. */
7052 oquit
= Vinhibit_quit
;
7056 menu_bar_items_vector
= old
;
7058 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7059 menu_bar_items_index
= 0;
7061 /* Build our list of keymaps.
7062 If we recognize a function key and replace its escape sequence in
7063 keybuf with its symbol, or if the sequence starts with a mouse
7064 click and we need to switch buffers, we jump back here to rebuild
7065 the initial keymaps from the current buffer. */
7069 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7070 if (!NILP (Voverriding_local_map_menu_flag
))
7072 /* Yes, use them (if non-nil) as well as the global map. */
7073 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7075 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7076 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7077 if (!NILP (Voverriding_local_map
))
7078 maps
[nmaps
++] = Voverriding_local_map
;
7082 /* No, so use major and minor mode keymaps and keymap property.
7083 Note that menu-bar bindings in the local-map and keymap
7084 properties may not work reliable, as they are only
7085 recognized when the menu-bar (or mode-line) is updated,
7086 which does not normally happen after every command. */
7089 nminor
= current_minor_maps (NULL
, &tmaps
);
7090 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7092 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7093 maps
[nmaps
++] = tem
;
7094 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7096 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7098 maps
[nmaps
++] = current_global_map
;
7101 /* Look up in each map the dummy prefix key `menu-bar'. */
7105 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7106 if (!NILP (maps
[mapno
]))
7108 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7112 menu_bar_one_keymap_changed_items
= Qnil
;
7113 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7117 /* Move to the end those items that should be at the end. */
7119 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7122 int end
= menu_bar_items_index
;
7124 for (i
= 0; i
< end
; i
+= 4)
7125 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7127 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7128 /* Move the item at index I to the end,
7129 shifting all the others forward. */
7130 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7131 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7132 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7133 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7135 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7136 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7137 (end
- i
- 4) * sizeof (Lisp_Object
));
7138 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7139 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7140 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7141 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7146 /* Add nil, nil, nil, nil at the end. */
7147 i
= menu_bar_items_index
;
7148 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7151 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7152 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7153 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7154 menu_bar_items_vector
= tem
;
7156 /* Add this item. */
7157 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7158 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7159 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7160 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7161 menu_bar_items_index
= i
;
7163 Vinhibit_quit
= oquit
;
7164 return menu_bar_items_vector
;
7167 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7168 If there's already an item for KEY, add this DEF to it. */
7170 Lisp_Object item_properties
;
7173 menu_bar_item (key
, item
, dummy1
, dummy2
)
7174 Lisp_Object key
, item
, dummy1
;
7177 struct gcpro gcpro1
;
7181 if (EQ (item
, Qundefined
))
7183 /* If a map has an explicit `undefined' as definition,
7184 discard any previously made menu bar item. */
7186 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7187 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7189 if (menu_bar_items_index
> i
+ 4)
7190 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7191 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7192 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7193 menu_bar_items_index
-= 4;
7197 /* If this keymap has already contributed to this KEY,
7198 don't contribute to it a second time. */
7199 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7200 if (!NILP (tem
) || NILP (item
))
7203 menu_bar_one_keymap_changed_items
7204 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7206 /* We add to menu_bar_one_keymap_changed_items before doing the
7207 parse_menu_item, so that if it turns out it wasn't a menu item,
7208 it still correctly hides any further menu item. */
7210 i
= parse_menu_item (item
, 0, 1);
7215 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7217 /* Find any existing item for this KEY. */
7218 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7219 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7222 /* If we did not find this KEY, add it at the end. */
7223 if (i
== menu_bar_items_index
)
7225 /* If vector is too small, get a bigger one. */
7226 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7229 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7230 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7231 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7232 menu_bar_items_vector
= tem
;
7235 /* Add this item. */
7236 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7237 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7238 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7239 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7240 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7241 menu_bar_items_index
= i
;
7243 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7247 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7248 /* If the new and the old items are not both keymaps,
7249 the lookup will only find `item'. */
7250 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7251 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7255 /* This is used as the handler when calling menu_item_eval_property. */
7257 menu_item_eval_property_1 (arg
)
7260 /* If we got a quit from within the menu computation,
7261 quit all the way out of it. This takes care of C-] in the debugger. */
7262 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7263 Fsignal (Qquit
, Qnil
);
7268 /* Evaluate an expression and return the result (or nil if something
7269 went wrong). Used to evaluate dynamic parts of menu items. */
7271 menu_item_eval_property (sexpr
)
7274 int count
= SPECPDL_INDEX ();
7276 specbind (Qinhibit_redisplay
, Qt
);
7277 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7278 menu_item_eval_property_1
);
7279 return unbind_to (count
, val
);
7282 /* This function parses a menu item and leaves the result in the
7283 vector item_properties.
7284 ITEM is a key binding, a possible menu item.
7285 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7286 evaluate dynamic expressions in the menu item.
7287 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7289 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7290 parse_menu_item returns true if the item is a menu item and false
7294 parse_menu_item (item
, notreal
, inmenubar
)
7296 int notreal
, inmenubar
;
7298 Lisp_Object def
, tem
, item_string
, start
;
7299 Lisp_Object cachelist
;
7301 Lisp_Object keyhint
;
7312 /* Create item_properties vector if necessary. */
7313 if (NILP (item_properties
))
7315 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7317 /* Initialize optional entries. */
7318 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7319 AREF (item_properties
, i
) = Qnil
;
7320 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7322 /* Save the item here to protect it from GC. */
7323 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7325 item_string
= XCAR (item
);
7329 if (STRINGP (item_string
))
7331 /* Old format menu item. */
7332 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7334 /* Maybe help string. */
7335 if (CONSP (item
) && STRINGP (XCAR (item
)))
7337 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7342 /* Maybe key binding cache. */
7343 if (CONSP (item
) && CONSP (XCAR (item
))
7344 && (NILP (XCAR (XCAR (item
)))
7345 || VECTORP (XCAR (XCAR (item
)))))
7347 cachelist
= XCAR (item
);
7351 /* This is the real definition--the function to run. */
7352 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7354 /* Get enable property, if any. */
7357 tem
= Fget (item
, Qmenu_enable
);
7359 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7362 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7364 /* New format menu item. */
7365 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7366 start
= XCDR (item
);
7369 /* We have a real binding. */
7370 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7372 item
= XCDR (start
);
7373 /* Is there a cache list with key equivalences. */
7374 if (CONSP (item
) && CONSP (XCAR (item
)))
7376 cachelist
= XCAR (item
);
7380 /* Parse properties. */
7381 while (CONSP (item
) && CONSP (XCDR (item
)))
7386 if (EQ (tem
, QCenable
))
7387 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7388 else if (EQ (tem
, QCvisible
) && !notreal
)
7390 /* If got a visible property and that evaluates to nil
7391 then ignore this item. */
7392 tem
= menu_item_eval_property (XCAR (item
));
7396 else if (EQ (tem
, QChelp
))
7397 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7398 else if (EQ (tem
, QCfilter
))
7400 else if (EQ (tem
, QCkey_sequence
))
7403 if (NILP (cachelist
)
7404 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7405 /* Be GC protected. Set keyhint to item instead of tem. */
7408 else if (EQ (tem
, QCkeys
))
7411 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7412 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7414 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7419 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7421 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7423 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7430 else if (inmenubar
|| !NILP (start
))
7434 return 0; /* not a menu item */
7436 /* If item string is not a string, evaluate it to get string.
7437 If we don't get a string, skip this item. */
7438 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7439 if (!(STRINGP (item_string
) || notreal
))
7441 item_string
= menu_item_eval_property (item_string
);
7442 if (!STRINGP (item_string
))
7444 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7447 /* If got a filter apply it on definition. */
7448 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7451 def
= menu_item_eval_property (list2 (XCAR (filter
),
7452 list2 (Qquote
, def
)));
7454 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7457 /* Enable or disable selection of item. */
7458 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7464 tem
= menu_item_eval_property (tem
);
7465 if (inmenubar
&& NILP (tem
))
7466 return 0; /* Ignore disabled items in menu bar. */
7467 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7470 /* If we got no definition, this item is just unselectable text which
7471 is OK in a submenu but not in the menubar. */
7473 return (inmenubar
? 0 : 1);
7475 /* See if this is a separate pane or a submenu. */
7476 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7477 tem
= get_keymap (def
, 0, 1);
7478 /* For a subkeymap, just record its details and exit. */
7481 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7482 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7486 /* At the top level in the menu bar, do likewise for commands also.
7487 The menu bar does not display equivalent key bindings anyway.
7488 ITEM_PROPERTY_DEF is already set up properly. */
7492 /* This is a command. See if there is an equivalent key binding. */
7493 if (NILP (cachelist
))
7495 /* We have to create a cachelist. */
7496 CHECK_IMPURE (start
);
7497 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7498 cachelist
= XCAR (XCDR (start
));
7500 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7501 if (!NILP (keyhint
))
7503 XSETCAR (cachelist
, XCAR (keyhint
));
7506 else if (STRINGP (tem
))
7508 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7509 XSETCAR (cachelist
, Qt
);
7513 tem
= XCAR (cachelist
);
7520 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7522 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7525 def
= XCAR (prefix
);
7526 prefix
= XCDR (prefix
);
7529 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7531 if (!update_menu_bindings
)
7533 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7535 if (newcache
/* Always check first time. */
7536 /* Should we check everything when precomputing key
7538 /* If something had no key binding before, don't recheck it
7539 because that is too slow--except if we have a list of
7540 rebound commands in Vdefine_key_rebound_commands, do
7541 recheck any command that appears in that list. */
7542 || (CONSP (Vdefine_key_rebound_commands
)
7543 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7546 /* We had a saved key. Is it still bound to the command? */
7549 /* If the command is an alias for another
7550 (such as lmenu.el set it up), check if the
7551 original command matches the cached command. */
7552 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7553 chkcache
= 1; /* Need to recompute key binding. */
7557 /* Recompute equivalent key binding. If the command is an alias
7558 for another (such as lmenu.el set it up), see if the original
7559 command name has equivalent keys. Otherwise look up the
7560 specified command itself. We don't try both, because that
7561 makes lmenu menus slow. */
7563 && SYMBOLP (XSYMBOL (def
)->function
)
7564 && ! NILP (Fget (def
, Qmenu_alias
)))
7565 def
= XSYMBOL (def
)->function
;
7566 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7567 XSETCAR (cachelist
, tem
);
7570 XSETCDR (cachelist
, Qnil
);
7574 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7576 tem
= XCAR (cachelist
);
7580 newcache
= chkcache
;
7583 tem
= Fkey_description (tem
, Qnil
);
7586 if (STRINGP (XCAR (prefix
)))
7587 tem
= concat2 (XCAR (prefix
), tem
);
7588 if (STRINGP (XCDR (prefix
)))
7589 tem
= concat2 (tem
, XCDR (prefix
));
7591 XSETCDR (cachelist
, tem
);
7595 tem
= XCDR (cachelist
);
7596 if (newcache
&& !NILP (tem
))
7598 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7599 XSETCDR (cachelist
, tem
);
7602 /* If we only want to precompute equivalent key bindings, stop here. */
7606 /* If we have an equivalent key binding, use that. */
7607 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7609 /* Include this when menu help is implemented.
7610 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7611 if (!(NILP (tem) || STRINGP (tem)))
7613 tem = menu_item_eval_property (tem);
7616 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7620 /* Handle radio buttons or toggle boxes. */
7621 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7623 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7624 = menu_item_eval_property (tem
);
7631 /***********************************************************************
7633 ***********************************************************************/
7635 /* A vector holding tool bar items while they are parsed in function
7636 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7639 static Lisp_Object tool_bar_items_vector
;
7641 /* A vector holding the result of parse_tool_bar_item. Layout is like
7642 the one for a single item in tool_bar_items_vector. */
7644 static Lisp_Object tool_bar_item_properties
;
7646 /* Next free index in tool_bar_items_vector. */
7648 static int ntool_bar_items
;
7650 /* The symbols `tool-bar', and `:image'. */
7652 extern Lisp_Object Qtool_bar
;
7653 Lisp_Object QCimage
;
7655 /* Function prototypes. */
7657 static void init_tool_bar_items
P_ ((Lisp_Object
));
7658 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7659 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7660 static void append_tool_bar_item
P_ ((void));
7663 /* Return a vector of tool bar items for keymaps currently in effect.
7664 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7665 tool bar items found. */
7668 tool_bar_items (reuse
, nitems
)
7679 /* In order to build the menus, we need to call the keymap
7680 accessors. They all call QUIT. But this function is called
7681 during redisplay, during which a quit is fatal. So inhibit
7682 quitting while building the menus. We do this instead of
7683 specbind because (1) errors will clear it anyway and (2) this
7684 avoids risk of specpdl overflow. */
7685 oquit
= Vinhibit_quit
;
7688 /* Initialize tool_bar_items_vector and protect it from GC. */
7689 init_tool_bar_items (reuse
);
7691 /* Build list of keymaps in maps. Set nmaps to the number of maps
7694 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7695 if (!NILP (Voverriding_local_map_menu_flag
))
7697 /* Yes, use them (if non-nil) as well as the global map. */
7698 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7700 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7701 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7702 if (!NILP (Voverriding_local_map
))
7703 maps
[nmaps
++] = Voverriding_local_map
;
7707 /* No, so use major and minor mode keymaps and keymap property.
7708 Note that tool-bar bindings in the local-map and keymap
7709 properties may not work reliable, as they are only
7710 recognized when the tool-bar (or mode-line) is updated,
7711 which does not normally happen after every command. */
7714 nminor
= current_minor_maps (NULL
, &tmaps
);
7715 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7717 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7718 maps
[nmaps
++] = tem
;
7719 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7721 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7724 /* Add global keymap at the end. */
7725 maps
[nmaps
++] = current_global_map
;
7727 /* Process maps in reverse order and look up in each map the prefix
7729 for (i
= nmaps
- 1; i
>= 0; --i
)
7730 if (!NILP (maps
[i
]))
7734 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7739 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7740 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7742 Lisp_Object keydef
= XCAR (tail
);
7744 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7749 Vinhibit_quit
= oquit
;
7750 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7751 return tool_bar_items_vector
;
7755 /* Process the definition of KEY which is DEF. */
7758 process_tool_bar_item (key
, def
)
7759 Lisp_Object key
, def
;
7762 extern Lisp_Object Qundefined
;
7763 struct gcpro gcpro1
, gcpro2
;
7765 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7769 if (EQ (def
, Qundefined
))
7771 /* If a map has an explicit `undefined' as definition,
7772 discard any previously made item. */
7773 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7775 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7777 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7779 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7780 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7781 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7782 * sizeof (Lisp_Object
)));
7783 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7788 else if (parse_tool_bar_item (key
, def
))
7789 /* Append a new tool bar item to tool_bar_items_vector. Accept
7790 more than one definition for the same key. */
7791 append_tool_bar_item ();
7797 /* Parse a tool bar item specification ITEM for key KEY and return the
7798 result in tool_bar_item_properties. Value is zero if ITEM is
7801 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7803 CAPTION is the caption of the item, If it's not a string, it is
7804 evaluated to get a string.
7806 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7807 as binding are currently ignored.
7809 The following properties are recognized:
7813 FORM is evaluated and specifies whether the tool bar item is
7814 enabled or disabled.
7818 FORM is evaluated and specifies whether the tool bar item is visible.
7820 - `:filter FUNCTION'
7822 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7823 result is stored as the new binding.
7825 - `:button (TYPE SELECTED)'
7827 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7828 and specifies whether the button is selected (pressed) or not.
7832 IMAGES is either a single image specification or a vector of four
7833 image specifications. See enum tool_bar_item_images.
7835 - `:help HELP-STRING'.
7837 Gives a help string to display for the tool bar item. */
7840 parse_tool_bar_item (key
, item
)
7841 Lisp_Object key
, item
;
7843 /* Access slot with index IDX of vector tool_bar_item_properties. */
7844 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7846 Lisp_Object filter
= Qnil
;
7847 Lisp_Object caption
;
7850 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7851 Rule out items that aren't lists, don't start with
7852 `menu-item' or whose rest following `tool-bar-item' is not a
7855 || !EQ (XCAR (item
), Qmenu_item
)
7856 || (item
= XCDR (item
),
7860 /* Create tool_bar_item_properties vector if necessary. Reset it to
7862 if (VECTORP (tool_bar_item_properties
))
7864 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7868 tool_bar_item_properties
7869 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7872 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7873 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7875 /* Get the caption of the item. If the caption is not a string,
7876 evaluate it to get a string. If we don't get a string, skip this
7878 caption
= XCAR (item
);
7879 if (!STRINGP (caption
))
7881 caption
= menu_item_eval_property (caption
);
7882 if (!STRINGP (caption
))
7885 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7887 /* Give up if rest following the caption is not a list. */
7892 /* Store the binding. */
7893 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7896 /* Ignore cached key binding, if any. */
7897 if (CONSP (item
) && CONSP (XCAR (item
)))
7900 /* Process the rest of the properties. */
7901 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7903 Lisp_Object key
, value
;
7906 value
= XCAR (XCDR (item
));
7908 if (EQ (key
, QCenable
))
7909 /* `:enable FORM'. */
7910 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7911 else if (EQ (key
, QCvisible
))
7913 /* `:visible FORM'. If got a visible property and that
7914 evaluates to nil then ignore this item. */
7915 if (NILP (menu_item_eval_property (value
)))
7918 else if (EQ (key
, QChelp
))
7919 /* `:help HELP-STRING'. */
7920 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7921 else if (EQ (key
, QCfilter
))
7922 /* ':filter FORM'. */
7924 else if (EQ (key
, QCbutton
) && CONSP (value
))
7926 /* `:button (TYPE . SELECTED)'. */
7927 Lisp_Object type
, selected
;
7929 type
= XCAR (value
);
7930 selected
= XCDR (value
);
7931 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7933 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7934 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7937 else if (EQ (key
, QCimage
)
7939 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7940 /* Value is either a single image specification or a vector
7941 of 4 such specifications for the different button states. */
7942 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7945 /* If got a filter apply it on binding. */
7947 PROP (TOOL_BAR_ITEM_BINDING
)
7948 = menu_item_eval_property (list2 (filter
,
7950 PROP (TOOL_BAR_ITEM_BINDING
))));
7952 /* See if the binding is a keymap. Give up if it is. */
7953 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7956 /* Enable or disable selection of item. */
7957 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7958 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7959 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7961 /* Handle radio buttons or toggle boxes. */
7962 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7963 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7964 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7972 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7973 that can be reused. */
7976 init_tool_bar_items (reuse
)
7979 if (VECTORP (reuse
))
7980 tool_bar_items_vector
= reuse
;
7982 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7983 ntool_bar_items
= 0;
7987 /* Append parsed tool bar item properties from
7988 tool_bar_item_properties */
7991 append_tool_bar_item ()
7993 Lisp_Object
*to
, *from
;
7995 /* Enlarge tool_bar_items_vector if necessary. */
7996 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7997 >= XVECTOR (tool_bar_items_vector
)->size
)
7999 Lisp_Object new_vector
;
8000 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
8002 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
8003 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
8004 XVECTOR (new_vector
)->contents
,
8005 old_size
* sizeof (Lisp_Object
));
8006 tool_bar_items_vector
= new_vector
;
8009 /* Append entries from tool_bar_item_properties to the end of
8010 tool_bar_items_vector. */
8011 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8012 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8013 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8014 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8021 /* Read a character using menus based on maps in the array MAPS.
8022 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8023 Return t if we displayed a menu but the user rejected it.
8025 PREV_EVENT is the previous input event, or nil if we are reading
8026 the first event of a key sequence.
8028 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8029 if we used a mouse menu to read the input, or zero otherwise. If
8030 USED_MOUSE_MENU is null, we don't dereference it.
8032 The prompting is done based on the prompt-string of the map
8033 and the strings associated with various map elements.
8035 This can be done with X menus or with menus put in the minibuf.
8036 These are done in different ways, depending on how the input will be read.
8037 Menus using X are done after auto-saving in read-char, getting the input
8038 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8039 and do auto-saving in the inner call of read_char. */
8042 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8045 Lisp_Object prev_event
;
8046 int *used_mouse_menu
;
8049 register Lisp_Object name
= Qnil
;
8051 if (used_mouse_menu
)
8052 *used_mouse_menu
= 0;
8054 /* Use local over global Menu maps */
8056 if (! menu_prompting
)
8059 /* Optionally disregard all but the global map. */
8060 if (inhibit_local_menu_bar_menus
)
8062 maps
+= (nmaps
- 1);
8066 /* Get the menu name from the first map that has one (a prompt string). */
8067 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8069 name
= Fkeymap_prompt (maps
[mapno
]);
8074 /* If we don't have any menus, just read a character normally. */
8075 if (!STRINGP (name
))
8079 /* If we got to this point via a mouse click,
8080 use a real menu for mouse selection. */
8081 if (EVENT_HAS_PARAMETERS (prev_event
)
8082 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8083 && !EQ (XCAR (prev_event
), Qtool_bar
))
8085 /* Display the menu and get the selection. */
8086 Lisp_Object
*realmaps
8087 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8091 /* Use the maps that are not nil. */
8092 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8093 if (!NILP (maps
[mapno
]))
8094 realmaps
[nmaps1
++] = maps
[mapno
];
8096 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8101 record_menu_key (XCAR (value
));
8103 /* If we got multiple events, unread all but
8105 There is no way to prevent those unread events
8106 from showing up later in last_nonmenu_event.
8107 So turn symbol and integer events into lists,
8108 to indicate that they came from a mouse menu,
8109 so that when present in last_nonmenu_event
8110 they won't confuse things. */
8111 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8113 record_menu_key (XCAR (tem
));
8114 if (SYMBOLP (XCAR (tem
))
8115 || INTEGERP (XCAR (tem
)))
8116 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8119 /* If we got more than one event, put all but the first
8120 onto this list to be read later.
8121 Return just the first event now. */
8122 Vunread_command_events
8123 = nconc2 (XCDR (value
), Vunread_command_events
);
8124 value
= XCAR (value
);
8126 else if (NILP (value
))
8128 if (used_mouse_menu
)
8129 *used_mouse_menu
= 1;
8132 #endif /* HAVE_MENUS */
8136 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8137 We make this bigger when necessary, and never free it. */
8138 static char *read_char_minibuf_menu_text
;
8139 /* Size of that buffer. */
8140 static int read_char_minibuf_menu_width
;
8143 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8149 register Lisp_Object name
;
8151 /* FIXME: Use the minibuffer's frame width. */
8152 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8155 Lisp_Object rest
, vector
;
8161 if (! menu_prompting
)
8164 /* Make sure we have a big enough buffer for the menu text. */
8165 if (read_char_minibuf_menu_text
== 0)
8167 read_char_minibuf_menu_width
= width
+ 4;
8168 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8170 else if (width
+ 4 > read_char_minibuf_menu_width
)
8172 read_char_minibuf_menu_width
= width
+ 4;
8173 read_char_minibuf_menu_text
8174 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8176 menu
= read_char_minibuf_menu_text
;
8178 /* Get the menu name from the first map that has one (a prompt string). */
8179 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8181 name
= Fkeymap_prompt (maps
[mapno
]);
8186 /* If we don't have any menus, just read a character normally. */
8187 if (!STRINGP (name
))
8190 /* Prompt string always starts with map's prompt, and a space. */
8191 strcpy (menu
, SDATA (name
));
8192 nlength
= SBYTES (name
);
8193 menu
[nlength
++] = ':';
8194 menu
[nlength
++] = ' ';
8197 /* Start prompting at start of first map. */
8201 /* Present the documented bindings, a line at a time. */
8208 Lisp_Object orig_defn_macro
;
8210 /* Loop over elements of map. */
8215 /* If reached end of map, start at beginning of next map. */
8219 /* At end of last map, wrap around to first map if just starting,
8220 or end this line if already have something on it. */
8224 if (notfirst
|| nobindings
) break;
8229 /* Look at the next element of the map. */
8231 elt
= XVECTOR (vector
)->contents
[idx
];
8233 elt
= Fcar_safe (rest
);
8235 if (idx
< 0 && VECTORP (elt
))
8237 /* If we found a dense table in the keymap,
8238 advanced past it, but start scanning its contents. */
8239 rest
= Fcdr_safe (rest
);
8245 /* An ordinary element. */
8246 Lisp_Object event
, tem
;
8250 event
= Fcar_safe (elt
); /* alist */
8251 elt
= Fcdr_safe (elt
);
8255 XSETINT (event
, idx
); /* vector */
8258 /* Ignore the element if it has no prompt string. */
8259 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8261 /* 1 if the char to type matches the string. */
8263 Lisp_Object upcased_event
, downcased_event
;
8264 Lisp_Object desc
= Qnil
;
8266 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8268 upcased_event
= Fupcase (event
);
8269 downcased_event
= Fdowncase (event
);
8270 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8271 || XINT (downcased_event
) == SREF (s
, 0));
8273 desc
= Fsingle_key_description (event
, Qnil
);
8275 #if 0 /* It is redundant to list the equivalent key bindings because
8276 the prefix is what the user has already typed. */
8278 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8280 /* Insert equivalent keybinding. */
8281 s
= concat2 (s
, tem
);
8284 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8285 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8287 /* Insert button prefix. */
8288 Lisp_Object selected
8289 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8290 if (EQ (tem
, QCradio
))
8291 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8293 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8294 s
= concat2 (tem
, s
);
8298 /* If we have room for the prompt string, add it to this line.
8299 If this is the first on the line, always add it. */
8300 if ((SCHARS (s
) + i
+ 2
8301 + (char_matches
? 0 : SCHARS (desc
) + 3))
8307 /* Punctuate between strings. */
8310 strcpy (menu
+ i
, ", ");
8316 /* If the char to type doesn't match the string's
8317 first char, explicitly show what char to type. */
8320 /* Add as much of string as fits. */
8321 thiswidth
= SCHARS (desc
);
8322 if (thiswidth
+ i
> width
)
8323 thiswidth
= width
- i
;
8324 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8326 strcpy (menu
+ i
, " = ");
8330 /* Add as much of string as fits. */
8331 thiswidth
= SCHARS (s
);
8332 if (thiswidth
+ i
> width
)
8333 thiswidth
= width
- i
;
8334 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8340 /* If this element does not fit, end the line now,
8341 and save the element for the next line. */
8342 strcpy (menu
+ i
, "...");
8347 /* Move past this element. */
8348 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8349 /* Handle reaching end of dense table. */
8354 rest
= Fcdr_safe (rest
);
8358 /* Prompt with that and read response. */
8359 message2_nolog (menu
, strlen (menu
),
8360 ! NILP (current_buffer
->enable_multibyte_characters
));
8362 /* Make believe its not a keyboard macro in case the help char
8363 is pressed. Help characters are not recorded because menu prompting
8364 is not used on replay.
8366 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8367 current_kboard
->defining_kbd_macro
= Qnil
;
8369 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8370 while (BUFFERP (obj
));
8371 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8373 if (!INTEGERP (obj
))
8378 if (! EQ (obj
, menu_prompt_more_char
)
8379 && (!INTEGERP (menu_prompt_more_char
)
8380 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8382 if (!NILP (current_kboard
->defining_kbd_macro
))
8383 store_kbd_macro_char (obj
);
8386 /* Help char - go round again */
8390 /* Reading key sequences. */
8392 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8393 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8394 keymap, or nil otherwise. Return the index of the first keymap in
8395 which KEY has any binding, or NMAPS if no map has a binding.
8397 If KEY is a meta ASCII character, treat it like meta-prefix-char
8398 followed by the corresponding non-meta character. Keymaps in
8399 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8402 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8405 NEXT may be the same array as CURRENT. */
8408 follow_key (key
, nmaps
, current
, defs
, next
)
8410 Lisp_Object
*current
, *defs
, *next
;
8413 int i
, first_binding
;
8415 first_binding
= nmaps
;
8416 for (i
= nmaps
- 1; i
>= 0; i
--)
8418 if (! NILP (current
[i
]))
8420 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8421 if (! NILP (defs
[i
]))
8428 /* Given the set of bindings we've found, produce the next set of maps. */
8429 if (first_binding
< nmaps
)
8430 for (i
= 0; i
< nmaps
; i
++)
8431 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8433 return first_binding
;
8436 /* Structure used to keep track of partial application of key remapping
8437 such as Vfunction_key_map and Vkey_translation_map. */
8438 typedef struct keyremap
8440 Lisp_Object map
, parent
;
8444 /* Lookup KEY in MAP.
8445 MAP is a keymap mapping keys to key vectors or functions.
8446 If the mapping is a function and DO_FUNCTION is non-zero, then
8447 the function is called with PROMPT as parameter and its return
8448 value is used as the return value of this function (after checking
8449 that it is indeed a vector). */
8452 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8453 Lisp_Object map
, key
, prompt
;
8458 next
= access_keymap (map
, key
, 1, 0, 1);
8460 /* Handle symbol with autoload definition. */
8461 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8462 && CONSP (XSYMBOL (next
)->function
)
8463 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8464 do_autoload (XSYMBOL (next
)->function
, next
);
8466 /* Handle a symbol whose function definition is a keymap
8468 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8469 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8470 || KEYMAPP (XSYMBOL (next
)->function
)))
8471 next
= XSYMBOL (next
)->function
;
8473 /* If the keymap gives a function, not an
8474 array, then call the function with one arg and use
8475 its value instead. */
8476 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8481 next
= call1 (next
, prompt
);
8482 /* If the function returned something invalid,
8483 barf--don't ignore it.
8484 (To ignore it safely, we would need to gcpro a bunch of
8485 other variables.) */
8486 if (! (VECTORP (next
) || STRINGP (next
)))
8487 error ("Function %s returns invalid key sequence", tem
);
8492 /* Do one step of the key remapping used for function-key-map and
8493 key-translation-map:
8494 KEYBUF is the buffer holding the input events.
8495 BUFSIZE is its maximum size.
8496 FKEY is a pointer to the keyremap structure to use.
8497 INPUT is the index of the last element in KEYBUF.
8498 DOIT if non-zero says that the remapping can actually take place.
8499 DIFF is used to return the number of keys added/removed by the remapping.
8500 PARENT is the root of the keymap.
8501 PROMPT is the prompt to use if the remapping happens through a function.
8502 The return value is non-zero if the remapping actually took place. */
8505 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8506 Lisp_Object
*keybuf
, prompt
;
8508 int input
, doit
, *diff
, bufsize
;
8510 Lisp_Object next
, key
;
8512 key
= keybuf
[fkey
->end
++];
8513 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8515 /* If keybuf[fkey->start..fkey->end] is bound in the
8516 map and we're in a position to do the key remapping, replace it with
8517 the binding and restart with fkey->start at the end. */
8518 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8520 int len
= XFASTINT (Flength (next
));
8523 *diff
= len
- (fkey
->end
- fkey
->start
);
8525 if (input
+ *diff
>= bufsize
)
8526 error ("Key sequence too long");
8528 /* Shift the keys that follow fkey->end. */
8530 for (i
= fkey
->end
; i
< input
; i
++)
8531 keybuf
[i
+ *diff
] = keybuf
[i
];
8533 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8534 keybuf
[i
+ *diff
] = keybuf
[i
];
8535 /* Overwrite the old keys with the new ones. */
8536 for (i
= 0; i
< len
; i
++)
8537 keybuf
[fkey
->start
+ i
]
8538 = Faref (next
, make_number (i
));
8540 fkey
->start
= fkey
->end
+= *diff
;
8541 fkey
->map
= fkey
->parent
;
8546 fkey
->map
= get_keymap (next
, 0, 1);
8548 /* If we no longer have a bound suffix, try a new position for
8550 if (!CONSP (fkey
->map
))
8552 fkey
->end
= ++fkey
->start
;
8553 fkey
->map
= fkey
->parent
;
8558 /* Read a sequence of keys that ends with a non prefix character,
8559 storing it in KEYBUF, a buffer of size BUFSIZE.
8561 Return the length of the key sequence stored.
8562 Return -1 if the user rejected a command menu.
8564 Echo starting immediately unless `prompt' is 0.
8566 Where a key sequence ends depends on the currently active keymaps.
8567 These include any minor mode keymaps active in the current buffer,
8568 the current buffer's local map, and the global map.
8570 If a key sequence has no other bindings, we check Vfunction_key_map
8571 to see if some trailing subsequence might be the beginning of a
8572 function key's sequence. If so, we try to read the whole function
8573 key, and substitute its symbolic name into the key sequence.
8575 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8576 `double-' events into similar click events, if that would make them
8577 bound. We try to turn `triple-' events first into `double-' events,
8580 If we get a mouse click in a mode line, vertical divider, or other
8581 non-text area, we treat the click as if it were prefixed by the
8582 symbol denoting that area - `mode-line', `vertical-line', or
8585 If the sequence starts with a mouse click, we read the key sequence
8586 with respect to the buffer clicked on, not the current buffer.
8588 If the user switches frames in the midst of a key sequence, we put
8589 off the switch-frame event until later; the next call to
8590 read_char will return it.
8592 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8593 from the selected window's buffer. */
8596 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8597 can_return_switch_frame
, fix_current_buffer
)
8598 Lisp_Object
*keybuf
;
8601 int dont_downcase_last
;
8602 int can_return_switch_frame
;
8603 int fix_current_buffer
;
8605 volatile Lisp_Object from_string
;
8606 volatile int count
= SPECPDL_INDEX ();
8608 /* How many keys there are in the current key sequence. */
8611 /* The length of the echo buffer when we started reading, and
8612 the length of this_command_keys when we started reading. */
8613 volatile int echo_start
;
8614 volatile int keys_start
;
8616 /* The number of keymaps we're scanning right now, and the number of
8617 keymaps we have allocated space for. */
8619 volatile int nmaps_allocated
= 0;
8621 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8622 the current keymaps. */
8623 Lisp_Object
*volatile defs
= NULL
;
8625 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8626 in the current keymaps, or nil where it is not a prefix. */
8627 Lisp_Object
*volatile submaps
= NULL
;
8629 /* The local map to start out with at start of key sequence. */
8630 volatile Lisp_Object orig_local_map
;
8632 /* The map from the `keymap' property to start out with at start of
8634 volatile Lisp_Object orig_keymap
;
8636 /* 1 if we have already considered switching to the local-map property
8637 of the place where a mouse click occurred. */
8638 volatile int localized_local_map
= 0;
8640 /* The index in defs[] of the first keymap that has a binding for
8641 this key sequence. In other words, the lowest i such that
8642 defs[i] is non-nil. */
8643 volatile int first_binding
;
8644 /* Index of the first key that has no binding.
8645 It is useless to try fkey.start larger than that. */
8646 volatile int first_unbound
;
8648 /* If t < mock_input, then KEYBUF[t] should be read as the next
8651 We use this to recover after recognizing a function key. Once we
8652 realize that a suffix of the current key sequence is actually a
8653 function key's escape sequence, we replace the suffix with the
8654 function key's binding from Vfunction_key_map. Now keybuf
8655 contains a new and different key sequence, so the echo area,
8656 this_command_keys, and the submaps and defs arrays are wrong. In
8657 this situation, we set mock_input to t, set t to 0, and jump to
8658 restart_sequence; the loop will read keys from keybuf up until
8659 mock_input, thus rebuilding the state; and then it will resume
8660 reading characters from the keyboard. */
8661 volatile int mock_input
= 0;
8663 /* If the sequence is unbound in submaps[], then
8664 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8665 and fkey.map is its binding.
8667 These might be > t, indicating that all function key scanning
8668 should hold off until t reaches them. We do this when we've just
8669 recognized a function key, to avoid searching for the function
8670 key's again in Vfunction_key_map. */
8671 volatile keyremap fkey
;
8673 /* Likewise, for key_translation_map. */
8674 volatile keyremap keytran
;
8676 /* If we receive a `switch-frame' or `select-window' event in the middle of
8677 a key sequence, we put it off for later.
8678 While we're reading, we keep the event here. */
8679 volatile Lisp_Object delayed_switch_frame
;
8681 /* See the comment below... */
8682 #if defined (GOBBLE_FIRST_EVENT)
8683 Lisp_Object first_event
;
8686 volatile Lisp_Object original_uppercase
;
8687 volatile int original_uppercase_position
= -1;
8689 /* Gets around Microsoft compiler limitations. */
8692 struct buffer
*starting_buffer
;
8694 /* List of events for which a fake prefix key has been generated. */
8695 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8697 #if defined (GOBBLE_FIRST_EVENT)
8701 struct gcpro gcpro1
;
8703 GCPRO1 (fake_prefixed_keys
);
8704 raw_keybuf_count
= 0;
8706 last_nonmenu_event
= Qnil
;
8708 delayed_switch_frame
= Qnil
;
8709 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
8710 keytran
.map
= keytran
.parent
= current_kboard
->Vlocal_key_translation_map
;
8711 /* If there is no translation-map, turn off scanning. */
8712 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8713 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8718 echo_prompt (prompt
);
8719 else if (cursor_in_echo_area
8720 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8721 && NILP (Fzerop (Vecho_keystrokes
)))
8722 /* This doesn't put in a dash if the echo buffer is empty, so
8723 you don't always see a dash hanging out in the minibuffer. */
8727 /* Record the initial state of the echo area and this_command_keys;
8728 we will need to restore them if we replay a key sequence. */
8730 echo_start
= echo_length ();
8731 keys_start
= this_command_key_count
;
8732 this_single_command_key_start
= keys_start
;
8734 #if defined (GOBBLE_FIRST_EVENT)
8735 /* This doesn't quite work, because some of the things that read_char
8736 does cannot safely be bypassed. It seems too risky to try to make
8739 /* Read the first char of the sequence specially, before setting
8740 up any keymaps, in case a filter runs and switches buffers on us. */
8741 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8743 #endif /* GOBBLE_FIRST_EVENT */
8745 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8746 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8749 /* We jump here when the key sequence has been thoroughly changed, and
8750 we need to rescan it starting from the beginning. When we jump here,
8751 keybuf[0..mock_input] holds the sequence we should reread. */
8754 starting_buffer
= current_buffer
;
8755 first_unbound
= bufsize
+ 1;
8757 /* Build our list of keymaps.
8758 If we recognize a function key and replace its escape sequence in
8759 keybuf with its symbol, or if the sequence starts with a mouse
8760 click and we need to switch buffers, we jump back here to rebuild
8761 the initial keymaps from the current buffer. */
8764 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8765 || !NILP (Voverriding_local_map
))
8767 if (3 > nmaps_allocated
)
8769 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8770 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8771 nmaps_allocated
= 3;
8773 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8774 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8775 if (!NILP (Voverriding_local_map
))
8776 submaps
[nmaps
++] = Voverriding_local_map
;
8784 nminor
= current_minor_maps (0, &maps
);
8785 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8787 if (total
> nmaps_allocated
)
8789 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8790 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8791 nmaps_allocated
= total
;
8794 if (!NILP (orig_keymap
))
8795 submaps
[nmaps
++] = orig_keymap
;
8797 bcopy (maps
, (void *) (submaps
+ nmaps
),
8798 nminor
* sizeof (submaps
[0]));
8802 submaps
[nmaps
++] = orig_local_map
;
8804 submaps
[nmaps
++] = current_global_map
;
8806 /* Find an accurate initial value for first_binding. */
8807 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8808 if (! NILP (submaps
[first_binding
]))
8811 /* Start from the beginning in keybuf. */
8814 /* These are no-ops the first time through, but if we restart, they
8815 revert the echo area and this_command_keys to their original state. */
8816 this_command_key_count
= keys_start
;
8817 if (INTERACTIVE
&& t
< mock_input
)
8818 echo_truncate (echo_start
);
8820 /* If the best binding for the current key sequence is a keymap, or
8821 we may be looking at a function key's escape sequence, keep on
8823 while (first_binding
< nmaps
8824 /* Keep reading as long as there's a prefix binding. */
8825 ? !NILP (submaps
[first_binding
])
8826 /* Don't return in the middle of a possible function key sequence,
8827 if the only bindings we found were via case conversion.
8828 Thus, if ESC O a has a function-key-map translation
8829 and ESC o has a binding, don't return after ESC O,
8830 so that we can translate ESC O plus the next character. */
8831 : (fkey
.start
< t
|| keytran
.start
< t
))
8834 int used_mouse_menu
= 0;
8836 /* Where the last real key started. If we need to throw away a
8837 key that has expanded into more than one element of keybuf
8838 (say, a mouse click on the mode line which is being treated
8839 as [mode-line (mouse-...)], then we backtrack to this point
8841 volatile int last_real_key_start
;
8843 /* These variables are analogous to echo_start and keys_start;
8844 while those allow us to restart the entire key sequence,
8845 echo_local_start and keys_local_start allow us to throw away
8847 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8849 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8850 eassert (fkey
.start
<= fkey
.end
);
8851 eassert (keytran
.start
<= keytran
.end
);
8852 /* key-translation-map is applied *after* function-key-map. */
8853 eassert (keytran
.end
<= fkey
.start
);
8855 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8856 { /* The prefix upto first_unbound has no binding and has
8857 no translation left to do either, so we know it's unbound.
8858 If we don't stop now, we risk staying here indefinitely
8859 (if the user keeps entering fkey or keytran prefixes
8860 like C-c ESC ESC ESC ESC ...) */
8862 for (i
= first_unbound
+ 1; i
< t
; i
++)
8863 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8864 mock_input
= t
- first_unbound
- 1;
8865 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8866 fkey
.map
= fkey
.parent
;
8867 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8868 keytran
.map
= keytran
.parent
;
8869 goto replay_sequence
;
8873 error ("Key sequence too long");
8876 echo_local_start
= echo_length ();
8877 keys_local_start
= this_command_key_count
;
8878 local_first_binding
= first_binding
;
8881 /* These are no-ops, unless we throw away a keystroke below and
8882 jumped back up to replay_key; in that case, these restore the
8883 variables to their original state, allowing us to replay the
8885 if (INTERACTIVE
&& t
< mock_input
)
8886 echo_truncate (echo_local_start
);
8887 this_command_key_count
= keys_local_start
;
8888 first_binding
= local_first_binding
;
8890 /* By default, assume each event is "real". */
8891 last_real_key_start
= t
;
8893 /* Does mock_input indicate that we are re-reading a key sequence? */
8897 add_command_key (key
);
8898 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8899 && NILP (Fzerop (Vecho_keystrokes
)))
8903 /* If not, we should actually read a character. */
8908 KBOARD
*interrupted_kboard
= current_kboard
;
8909 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8910 if (setjmp (wrong_kboard_jmpbuf
))
8912 if (!NILP (delayed_switch_frame
))
8914 interrupted_kboard
->kbd_queue
8915 = Fcons (delayed_switch_frame
,
8916 interrupted_kboard
->kbd_queue
);
8917 delayed_switch_frame
= Qnil
;
8920 interrupted_kboard
->kbd_queue
8921 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8923 /* If the side queue is non-empty, ensure it begins with a
8924 switch-frame, so we'll replay it in the right context. */
8925 if (CONSP (interrupted_kboard
->kbd_queue
)
8926 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8927 !(EVENT_HAS_PARAMETERS (key
)
8928 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8932 XSETFRAME (frame
, interrupted_frame
);
8933 interrupted_kboard
->kbd_queue
8934 = Fcons (make_lispy_switch_frame (frame
),
8935 interrupted_kboard
->kbd_queue
);
8938 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8939 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8940 goto replay_sequence
;
8943 key
= read_char (NILP (prompt
), nmaps
,
8944 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8948 /* read_char returns t when it shows a menu and the user rejects it.
8952 unbind_to (count
, Qnil
);
8957 /* read_char returns -1 at the end of a macro.
8958 Emacs 18 handles this by returning immediately with a
8959 zero, so that's what we'll do. */
8960 if (INTEGERP (key
) && XINT (key
) == -1)
8963 /* The Microsoft C compiler can't handle the goto that
8969 /* If the current buffer has been changed from under us, the
8970 keymap may have changed, so replay the sequence. */
8973 timer_resume_idle ();
8976 /* Reset the current buffer from the selected window
8977 in case something changed the former and not the latter.
8978 This is to be more consistent with the behavior
8979 of the command_loop_1. */
8980 if (fix_current_buffer
)
8982 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8984 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8985 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8988 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8989 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8990 goto replay_sequence
;
8993 /* If we have a quit that was typed in another frame, and
8994 quit_throw_to_read_char switched buffers,
8995 replay to get the right keymap. */
8997 && XINT (key
) == quit_char
8998 && current_buffer
!= starting_buffer
)
9001 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9005 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9006 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9007 goto replay_sequence
;
9012 if (EVENT_HAS_PARAMETERS (key
)
9013 /* Either a `switch-frame' or a `select-window' event. */
9014 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9016 /* If we're at the beginning of a key sequence, and the caller
9017 says it's okay, go ahead and return this event. If we're
9018 in the midst of a key sequence, delay it until the end. */
9019 if (t
> 0 || !can_return_switch_frame
)
9021 delayed_switch_frame
= key
;
9027 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9030 /* Clicks in non-text areas get prefixed by the symbol
9031 in their CHAR-ADDRESS field. For example, a click on
9032 the mode line is prefixed by the symbol `mode-line'.
9034 Furthermore, key sequences beginning with mouse clicks
9035 are read using the keymaps of the buffer clicked on, not
9036 the current buffer. So we may have to switch the buffer
9039 When we turn one event into two events, we must make sure
9040 that neither of the two looks like the original--so that,
9041 if we replay the events, they won't be expanded again.
9042 If not for this, such reexpansion could happen either here
9043 or when user programs play with this-command-keys. */
9044 if (EVENT_HAS_PARAMETERS (key
))
9049 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9050 if (EQ (kind
, Qmouse_click
))
9052 Lisp_Object window
, posn
;
9054 window
= POSN_WINDOW (EVENT_START (key
));
9055 posn
= POSN_POSN (EVENT_START (key
));
9058 || (!NILP (fake_prefixed_keys
)
9059 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9061 /* We're looking a second time at an event for which
9062 we generated a fake prefix key. Set
9063 last_real_key_start appropriately. */
9065 last_real_key_start
= t
- 1;
9068 /* Key sequences beginning with mouse clicks are
9069 read using the keymaps in the buffer clicked on,
9070 not the current buffer. If we're at the
9071 beginning of a key sequence, switch buffers. */
9072 if (last_real_key_start
== 0
9074 && BUFFERP (XWINDOW (window
)->buffer
)
9075 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9077 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9081 /* Arrange to go back to the original buffer once we're
9082 done reading the key sequence. Note that we can't
9083 use save_excursion_{save,restore} here, because they
9084 save point as well as the current buffer; we don't
9085 want to save point, because redisplay may change it,
9086 to accommodate a Fset_window_start or something. We
9087 don't want to do this at the top of the function,
9088 because we may get input from a subprocess which
9089 wants to change the selected window and stuff (say,
9091 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9093 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9095 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9096 orig_local_map
= get_local_map (PT
, current_buffer
,
9098 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9099 goto replay_sequence
;
9102 /* For a mouse click, get the local text-property keymap
9103 of the place clicked on, rather than point. */
9104 if (last_real_key_start
== 0
9105 && CONSP (XCDR (key
))
9106 && ! localized_local_map
)
9108 Lisp_Object map_here
, start
, pos
;
9110 localized_local_map
= 1;
9111 start
= EVENT_START (key
);
9113 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9115 pos
= POSN_BUFFER_POSN (start
);
9117 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9119 map_here
= get_local_map (XINT (pos
),
9120 current_buffer
, Qlocal_map
);
9121 if (!EQ (map_here
, orig_local_map
))
9123 orig_local_map
= map_here
;
9127 goto replay_sequence
;
9129 map_here
= get_local_map (XINT (pos
),
9130 current_buffer
, Qkeymap
);
9131 if (!EQ (map_here
, orig_keymap
))
9133 orig_keymap
= map_here
;
9137 goto replay_sequence
;
9143 /* Expand mode-line and scroll-bar events into two events:
9144 use posn as a fake prefix key. */
9146 && (NILP (fake_prefixed_keys
)
9147 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9149 if (t
+ 1 >= bufsize
)
9150 error ("Key sequence too long");
9153 keybuf
[t
+ 1] = key
;
9156 /* Record that a fake prefix key has been generated
9157 for KEY. Don't modify the event; this would
9158 prevent proper action when the event is pushed
9159 back into unread-command-events. */
9160 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9162 /* If on a mode line string with a local keymap,
9163 reconsider the key sequence with that keymap. */
9164 if (string
= POSN_STRING (EVENT_START (key
)),
9165 (CONSP (string
) && STRINGP (XCAR (string
))))
9167 Lisp_Object pos
, map
, map2
;
9169 pos
= XCDR (string
);
9170 string
= XCAR (string
);
9172 && XINT (pos
) < SCHARS (string
))
9174 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9176 orig_local_map
= map
;
9177 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9180 if (!NILP (map
) || !NILP (map2
))
9181 goto replay_sequence
;
9187 else if (NILP (from_string
)
9188 && (string
= POSN_STRING (EVENT_START (key
)),
9189 (CONSP (string
) && STRINGP (XCAR (string
)))))
9191 /* For a click on a string, i.e. overlay string or a
9192 string displayed via the `display' property,
9193 consider `local-map' and `keymap' properties of
9195 Lisp_Object pos
, map
, map2
;
9197 pos
= XCDR (string
);
9198 string
= XCAR (string
);
9200 && XINT (pos
) < SCHARS (string
))
9202 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9204 orig_local_map
= map
;
9205 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9209 if (!NILP (map
) || !NILP (map2
))
9211 from_string
= string
;
9212 goto replay_sequence
;
9217 else if (CONSP (XCDR (key
))
9218 && CONSP (EVENT_START (key
))
9219 && CONSP (XCDR (EVENT_START (key
))))
9223 posn
= POSN_POSN (EVENT_START (key
));
9224 /* Handle menu-bar events:
9225 insert the dummy prefix event `menu-bar'. */
9226 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9228 if (t
+ 1 >= bufsize
)
9229 error ("Key sequence too long");
9233 /* Zap the position in key, so we know that we've
9234 expanded it, and don't try to do so again. */
9235 POSN_SET_POSN (EVENT_START (key
),
9236 Fcons (posn
, Qnil
));
9239 goto replay_sequence
;
9241 else if (CONSP (posn
))
9243 /* We're looking at the second event of a
9244 sequence which we expanded before. Set
9245 last_real_key_start appropriately. */
9246 if (last_real_key_start
== t
&& t
> 0)
9247 last_real_key_start
= t
- 1;
9252 /* We have finally decided that KEY is something we might want
9254 first_binding
= (follow_key (key
,
9255 nmaps
- first_binding
,
9256 submaps
+ first_binding
,
9257 defs
+ first_binding
,
9258 submaps
+ first_binding
)
9261 /* If KEY wasn't bound, we'll try some fallbacks. */
9262 if (first_binding
< nmaps
)
9263 /* This is needed for the following scenario:
9264 event 0: a down-event that gets dropped by calling replay_key.
9265 event 1: some normal prefix like C-h.
9266 After event 0, first_unbound is 0, after event 1 fkey.start
9267 and keytran.start are both 1, so when we see that C-h is bound,
9268 we need to update first_unbound. */
9269 first_unbound
= max (t
+ 1, first_unbound
);
9274 /* Remember the position to put an upper bound on fkey.start. */
9275 first_unbound
= min (t
, first_unbound
);
9277 head
= EVENT_HEAD (key
);
9278 if (help_char_p (head
) && t
> 0)
9280 read_key_sequence_cmd
= Vprefix_help_command
;
9282 last_nonmenu_event
= key
;
9283 /* The Microsoft C compiler can't handle the goto that
9291 Lisp_Object breakdown
;
9294 breakdown
= parse_modifiers (head
);
9295 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9296 /* Attempt to reduce an unbound mouse event to a simpler
9297 event that is bound:
9298 Drags reduce to clicks.
9299 Double-clicks reduce to clicks.
9300 Triple-clicks reduce to double-clicks, then to clicks.
9301 Down-clicks are eliminated.
9302 Double-downs reduce to downs, then are eliminated.
9303 Triple-downs reduce to double-downs, then to downs,
9304 then are eliminated. */
9305 if (modifiers
& (down_modifier
| drag_modifier
9306 | double_modifier
| triple_modifier
))
9308 while (modifiers
& (down_modifier
| drag_modifier
9309 | double_modifier
| triple_modifier
))
9311 Lisp_Object new_head
, new_click
;
9312 if (modifiers
& triple_modifier
)
9313 modifiers
^= (double_modifier
| triple_modifier
);
9314 else if (modifiers
& double_modifier
)
9315 modifiers
&= ~double_modifier
;
9316 else if (modifiers
& drag_modifier
)
9317 modifiers
&= ~drag_modifier
;
9320 /* Dispose of this `down' event by simply jumping
9321 back to replay_key, to get another event.
9323 Note that if this event came from mock input,
9324 then just jumping back to replay_key will just
9325 hand it to us again. So we have to wipe out any
9328 We could delete keybuf[t] and shift everything
9329 after that to the left by one spot, but we'd also
9330 have to fix up any variable that points into
9331 keybuf, and shifting isn't really necessary
9334 Adding prefixes for non-textual mouse clicks
9335 creates two characters of mock input, and both
9336 must be thrown away. If we're only looking at
9337 the prefix now, we can just jump back to
9338 replay_key. On the other hand, if we've already
9339 processed the prefix, and now the actual click
9340 itself is giving us trouble, then we've lost the
9341 state of the keymaps we want to backtrack to, and
9342 we need to replay the whole sequence to rebuild
9345 Beyond that, only function key expansion could
9346 create more than two keys, but that should never
9347 generate mouse events, so it's okay to zero
9348 mock_input in that case too.
9350 FIXME: The above paragraph seems just plain
9351 wrong, if you consider things like
9352 xterm-mouse-mode. -stef
9354 Isn't this just the most wonderful code ever? */
9356 /* If mock_input > t + 1, the above simplification
9357 will actually end up dropping keys on the floor.
9358 This is probably OK for now, but even
9359 if mock_input <= t + 1, we need to adjust fkey
9361 Typical case [header-line down-mouse-N]:
9362 mock_input = 2, t = 1, fkey.end = 1,
9363 last_real_key_start = 0. */
9364 if (fkey
.end
> last_real_key_start
)
9366 fkey
.end
= fkey
.start
9367 = min (last_real_key_start
, fkey
.start
);
9368 fkey
.map
= fkey
.parent
;
9369 if (keytran
.end
> last_real_key_start
)
9371 keytran
.end
= keytran
.start
9372 = min (last_real_key_start
, keytran
.start
);
9373 keytran
.map
= keytran
.parent
;
9376 if (t
== last_real_key_start
)
9383 mock_input
= last_real_key_start
;
9384 goto replay_sequence
;
9389 = apply_modifiers (modifiers
, XCAR (breakdown
));
9391 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9393 /* Look for a binding for this new key. follow_key
9394 promises that it didn't munge submaps the
9395 last time we called it, since key was unbound. */
9397 = (follow_key (new_click
,
9398 nmaps
- local_first_binding
,
9399 submaps
+ local_first_binding
,
9400 defs
+ local_first_binding
,
9401 submaps
+ local_first_binding
)
9402 + local_first_binding
);
9404 /* If that click is bound, go for it. */
9405 if (first_binding
< nmaps
)
9410 /* Otherwise, we'll leave key set to the drag event. */
9417 /* Normally, last_nonmenu_event gets the previous key we read.
9418 But when a mouse popup menu is being used,
9419 we don't update last_nonmenu_event; it continues to hold the mouse
9420 event that preceded the first level of menu. */
9421 if (!used_mouse_menu
)
9422 last_nonmenu_event
= key
;
9424 /* Record what part of this_command_keys is the current key sequence. */
9425 this_single_command_key_start
= this_command_key_count
- t
;
9427 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9428 /* There is a binding and it's not a prefix.
9429 There is thus no function-key in this sequence.
9430 Moving fkey.start is important in this case to allow keytran.start
9431 to go over the sequence before we return (since we keep the
9432 invariant that keytran.end <= fkey.start). */
9435 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9438 /* If the sequence is unbound, see if we can hang a function key
9439 off the end of it. */
9440 /* Continue scan from fkey.end until we find a bound suffix. */
9441 while (fkey
.end
< t
)
9443 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9446 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9447 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9448 max (t
, mock_input
),
9449 /* If there's a binding (i.e.
9450 first_binding >= nmaps) we don't want
9451 to apply this function-key-mapping. */
9452 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9457 mock_input
= diff
+ max (t
, mock_input
);
9458 goto replay_sequence
;
9462 /* Look for this sequence in key-translation-map.
9463 Scan from keytran.end until we find a bound suffix. */
9464 while (keytran
.end
< fkey
.start
)
9466 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9469 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9470 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9475 mock_input
= diff
+ max (t
, mock_input
);
9476 /* Adjust the function-key-map counters. */
9480 goto replay_sequence
;
9484 /* If KEY is not defined in any of the keymaps,
9485 and cannot be part of a function key or translation,
9486 and is an upper case letter
9487 use the corresponding lower-case letter instead. */
9488 if (first_binding
>= nmaps
9489 && fkey
.start
>= t
&& keytran
.start
>= t
9491 && ((((XINT (key
) & 0x3ffff)
9492 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9493 && UPPERCASEP (XINT (key
) & 0x3ffff))
9494 || (XINT (key
) & shift_modifier
)))
9496 Lisp_Object new_key
;
9498 original_uppercase
= key
;
9499 original_uppercase_position
= t
- 1;
9501 if (XINT (key
) & shift_modifier
)
9502 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9504 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9505 | (XINT (key
) & ~0x3ffff)));
9507 /* We have to do this unconditionally, regardless of whether
9508 the lower-case char is defined in the keymaps, because they
9509 might get translated through function-key-map. */
9510 keybuf
[t
- 1] = new_key
;
9511 mock_input
= max (t
, mock_input
);
9513 goto replay_sequence
;
9515 /* If KEY is not defined in any of the keymaps,
9516 and cannot be part of a function key or translation,
9517 and is a shifted function key,
9518 use the corresponding unshifted function key instead. */
9519 if (first_binding
>= nmaps
9520 && fkey
.start
>= t
&& keytran
.start
>= t
9523 Lisp_Object breakdown
;
9526 breakdown
= parse_modifiers (key
);
9527 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9528 if (modifiers
& shift_modifier
)
9530 Lisp_Object new_key
;
9532 original_uppercase
= key
;
9533 original_uppercase_position
= t
- 1;
9535 modifiers
&= ~shift_modifier
;
9536 new_key
= apply_modifiers (modifiers
,
9539 keybuf
[t
- 1] = new_key
;
9540 mock_input
= max (t
, mock_input
);
9541 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9542 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9544 goto replay_sequence
;
9550 read_key_sequence_cmd
= (first_binding
< nmaps
9551 ? defs
[first_binding
]
9554 unread_switch_frame
= delayed_switch_frame
;
9555 unbind_to (count
, Qnil
);
9557 /* Don't downcase the last character if the caller says don't.
9558 Don't downcase it if the result is undefined, either. */
9559 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9560 && t
- 1 == original_uppercase_position
)
9561 keybuf
[t
- 1] = original_uppercase
;
9563 /* Occasionally we fabricate events, perhaps by expanding something
9564 according to function-key-map, or by adding a prefix symbol to a
9565 mouse click in the scroll bar or modeline. In this cases, return
9566 the entire generated key sequence, even if we hit an unbound
9567 prefix or a definition before the end. This means that you will
9568 be able to push back the event properly, and also means that
9569 read-key-sequence will always return a logical unit.
9572 for (; t
< mock_input
; t
++)
9574 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9575 && NILP (Fzerop (Vecho_keystrokes
)))
9576 echo_char (keybuf
[t
]);
9577 add_command_key (keybuf
[t
]);
9586 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9587 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9588 The sequence is sufficient to specify a non-prefix command in the
9589 current local and global maps.
9591 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9592 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9593 as a continuation of the previous key.
9595 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9596 convert the last event to lower case. (Normally any upper case event
9597 is converted to lower case if the original event is undefined and the lower
9598 case equivalent is defined.) A non-nil value is appropriate for reading
9599 a key sequence to be defined.
9601 A C-g typed while in this function is treated like any other character,
9602 and `quit-flag' is not set.
9604 If the key sequence starts with a mouse click, then the sequence is read
9605 using the keymaps of the buffer of the window clicked in, not the buffer
9606 of the selected window as normal.
9608 `read-key-sequence' drops unbound button-down events, since you normally
9609 only care about the click or drag events which follow them. If a drag
9610 or multi-click event is unbound, but the corresponding click event would
9611 be bound, `read-key-sequence' turns the event into a click event at the
9612 drag's starting position. This means that you don't have to distinguish
9613 between click and drag, double, or triple events unless you want to.
9615 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9616 lines separating windows, and scroll bars with imaginary keys
9617 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9619 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9620 function will process a switch-frame event if the user switches frames
9621 before typing anything. If the user switches frames in the middle of a
9622 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9623 is nil, then the event will be put off until after the current key sequence.
9625 `read-key-sequence' checks `function-key-map' for function key
9626 sequences, where they wouldn't conflict with ordinary bindings. See
9627 `function-key-map' for more details.
9629 The optional fifth argument COMMAND-LOOP, if non-nil, means
9630 that this key sequence is being read by something that will
9631 read commands one after another. It should be nil if the caller
9632 will read just one key sequence. */)
9633 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9635 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9636 Lisp_Object can_return_switch_frame
, command_loop
;
9638 Lisp_Object keybuf
[30];
9640 struct gcpro gcpro1
;
9641 int count
= SPECPDL_INDEX ();
9644 CHECK_STRING (prompt
);
9647 specbind (Qinput_method_exit_on_first_char
,
9648 (NILP (command_loop
) ? Qt
: Qnil
));
9649 specbind (Qinput_method_use_echo_area
,
9650 (NILP (command_loop
) ? Qt
: Qnil
));
9652 bzero (keybuf
, sizeof keybuf
);
9654 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9656 if (NILP (continue_echo
))
9658 this_command_key_count
= 0;
9659 this_command_key_count_reset
= 0;
9660 this_single_command_key_start
= 0;
9663 #ifdef HAVE_X_WINDOWS
9664 if (display_hourglass_p
)
9665 cancel_hourglass ();
9668 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9669 prompt
, ! NILP (dont_downcase_last
),
9670 ! NILP (can_return_switch_frame
), 0);
9672 #if 0 /* The following is fine for code reading a key sequence and
9673 then proceeding with a lenghty computation, but it's not good
9674 for code reading keys in a loop, like an input method. */
9675 #ifdef HAVE_X_WINDOWS
9676 if (display_hourglass_p
)
9687 return unbind_to (count
, make_event_array (i
, keybuf
));
9690 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9691 Sread_key_sequence_vector
, 1, 5, 0,
9692 doc
: /* Like `read-key-sequence' but always return a vector. */)
9693 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9695 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9696 Lisp_Object can_return_switch_frame
, command_loop
;
9698 Lisp_Object keybuf
[30];
9700 struct gcpro gcpro1
;
9701 int count
= SPECPDL_INDEX ();
9704 CHECK_STRING (prompt
);
9707 specbind (Qinput_method_exit_on_first_char
,
9708 (NILP (command_loop
) ? Qt
: Qnil
));
9709 specbind (Qinput_method_use_echo_area
,
9710 (NILP (command_loop
) ? Qt
: Qnil
));
9712 bzero (keybuf
, sizeof keybuf
);
9714 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9716 if (NILP (continue_echo
))
9718 this_command_key_count
= 0;
9719 this_command_key_count_reset
= 0;
9720 this_single_command_key_start
= 0;
9723 #ifdef HAVE_X_WINDOWS
9724 if (display_hourglass_p
)
9725 cancel_hourglass ();
9728 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9729 prompt
, ! NILP (dont_downcase_last
),
9730 ! NILP (can_return_switch_frame
), 0);
9732 #ifdef HAVE_X_WINDOWS
9733 if (display_hourglass_p
)
9743 return unbind_to (count
, Fvector (i
, keybuf
));
9746 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9747 doc
: /* Execute CMD as an editor command.
9748 CMD must be a symbol that satisfies the `commandp' predicate.
9749 Optional second arg RECORD-FLAG non-nil
9750 means unconditionally put this command in `command-history'.
9751 Otherwise, that is done only if an arg is read using the minibuffer.
9752 The argument KEYS specifies the value to use instead of (this-command-keys)
9753 when reading the arguments; if it is nil, (this-command-keys) is used.
9754 The argument SPECIAL, if non-nil, means that this command is executing
9755 a special event, so ignore the prefix argument and don't clear it. */)
9756 (cmd
, record_flag
, keys
, special
)
9757 Lisp_Object cmd
, record_flag
, keys
, special
;
9759 register Lisp_Object final
;
9760 register Lisp_Object tem
;
9761 Lisp_Object prefixarg
;
9762 struct backtrace backtrace
;
9763 extern int debug_on_next_call
;
9765 debug_on_next_call
= 0;
9769 prefixarg
= current_kboard
->Vprefix_arg
;
9770 Vcurrent_prefix_arg
= prefixarg
;
9771 current_kboard
->Vprefix_arg
= Qnil
;
9778 tem
= Fget (cmd
, Qdisabled
);
9779 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9781 tem
= Fsymbol_value (Qdisabled_command_function
);
9783 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9789 final
= Findirect_function (cmd
);
9791 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9793 struct gcpro gcpro1
, gcpro2
;
9795 GCPRO2 (cmd
, prefixarg
);
9796 do_autoload (final
, cmd
);
9803 if (STRINGP (final
) || VECTORP (final
))
9805 /* If requested, place the macro in the command history. For
9806 other sorts of commands, call-interactively takes care of
9808 if (!NILP (record_flag
))
9811 = Fcons (Fcons (Qexecute_kbd_macro
,
9812 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9815 /* Don't keep command history around forever. */
9816 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9818 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9820 XSETCDR (tem
, Qnil
);
9824 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9827 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9829 backtrace
.next
= backtrace_list
;
9830 backtrace_list
= &backtrace
;
9831 backtrace
.function
= &Qcall_interactively
;
9832 backtrace
.args
= &cmd
;
9833 backtrace
.nargs
= 1;
9834 backtrace
.evalargs
= 0;
9835 backtrace
.debug_on_exit
= 0;
9837 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9839 backtrace_list
= backtrace
.next
;
9847 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9849 doc
: /* Read function name, then read its arguments and call it. */)
9851 Lisp_Object prefixarg
;
9853 Lisp_Object function
;
9855 int saved_last_point_position
;
9856 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9857 Lisp_Object bindings
, value
;
9858 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9859 #ifdef HAVE_X_WINDOWS
9860 /* The call to Fcompleting_read wil start and cancel the hourglass,
9861 but if the hourglass was already scheduled, this means that no
9862 hourglass will be shown for the actual M-x command itself.
9863 So we restart it if it is already scheduled. Note that checking
9864 hourglass_shown_p is not enough, normally the hourglass is not shown,
9865 just scheduled to be shown. */
9866 int hstarted
= hourglass_started ();
9869 saved_keys
= Fvector (this_command_key_count
,
9870 XVECTOR (this_command_keys
)->contents
);
9871 saved_last_point_position_buffer
= last_point_position_buffer
;
9872 saved_last_point_position
= last_point_position
;
9874 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9876 if (EQ (prefixarg
, Qminus
))
9878 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9879 strcpy (buf
, "C-u ");
9880 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9881 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9882 else if (INTEGERP (prefixarg
))
9883 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9885 /* This isn't strictly correct if execute-extended-command
9886 is bound to anything else. Perhaps it should use
9887 this_command_keys? */
9888 strcat (buf
, "M-x ");
9890 /* Prompt with buf, and then read a string, completing from and
9891 restricting to the set of all defined commands. Don't provide
9892 any initial input. Save the command read on the extended-command
9894 function
= Fcompleting_read (build_string (buf
),
9895 Vobarray
, Qcommandp
,
9896 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9899 #ifdef HAVE_X_WINDOWS
9900 if (hstarted
) start_hourglass ();
9903 if (STRINGP (function
) && SCHARS (function
) == 0)
9904 error ("No command name given");
9906 /* Set this_command_keys to the concatenation of saved_keys and
9907 function, followed by a RET. */
9912 this_command_key_count
= 0;
9913 this_command_key_count_reset
= 0;
9914 this_single_command_key_start
= 0;
9916 keys
= XVECTOR (saved_keys
)->contents
;
9917 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9918 add_command_key (keys
[i
]);
9920 for (i
= 0; i
< SCHARS (function
); i
++)
9921 add_command_key (Faref (function
, make_number (i
)));
9923 add_command_key (make_number ('\015'));
9926 last_point_position
= saved_last_point_position
;
9927 last_point_position_buffer
= saved_last_point_position_buffer
;
9931 function
= Fintern (function
, Qnil
);
9932 current_kboard
->Vprefix_arg
= prefixarg
;
9933 Vthis_command
= function
;
9934 real_this_command
= function
;
9936 /* If enabled, show which key runs this command. */
9937 if (!NILP (Vsuggest_key_bindings
)
9938 && NILP (Vexecuting_kbd_macro
)
9939 && SYMBOLP (function
))
9940 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9946 GCPRO2 (bindings
, value
);
9947 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9949 /* If the command has a key binding, print it now. */
9950 if (!NILP (bindings
)
9951 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9954 /* But first wait, and skip the message if there is input. */
9956 if (!NILP (echo_area_buffer
[0]))
9957 /* This command displayed something in the echo area;
9958 so wait a few seconds, then display our suggestion message. */
9959 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9960 ? XINT (Vsuggest_key_bindings
) : 2);
9962 /* This command left the echo area empty,
9963 so display our message immediately. */
9966 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9967 && ! CONSP (Vunread_command_events
))
9969 Lisp_Object binding
;
9971 int message_p
= push_message ();
9972 int count
= SPECPDL_INDEX ();
9974 record_unwind_protect (pop_message_unwind
, Qnil
);
9975 binding
= Fkey_description (bindings
, Qnil
);
9978 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9981 sprintf (newmessage
, "You can run the command `%s' with %s",
9982 SDATA (SYMBOL_NAME (function
)),
9984 message2_nolog (newmessage
,
9985 strlen (newmessage
),
9986 STRING_MULTIBYTE (binding
));
9987 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9988 ? Vsuggest_key_bindings
: make_number (2)),
9993 unbind_to (count
, Qnil
);
9997 RETURN_UNGCPRO (value
);
10001 /* Return nonzero if input events are pending. */
10004 detect_input_pending ()
10006 if (!input_pending
)
10007 get_input_pending (&input_pending
, 0);
10009 return input_pending
;
10012 /* Return nonzero if input events other than mouse movements are
10016 detect_input_pending_ignore_squeezables ()
10018 if (!input_pending
)
10019 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10021 return input_pending
;
10024 /* Return nonzero if input events are pending, and run any pending timers. */
10027 detect_input_pending_run_timers (do_display
)
10030 int old_timers_run
= timers_run
;
10032 if (!input_pending
)
10033 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10035 if (old_timers_run
!= timers_run
&& do_display
)
10037 redisplay_preserve_echo_area (8);
10038 /* The following fixes a bug when using lazy-lock with
10039 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10040 from an idle timer function. The symptom of the bug is that
10041 the cursor sometimes doesn't become visible until the next X
10042 event is processed. --gerd. */
10044 Lisp_Object tail
, frame
;
10045 FOR_EACH_FRAME (tail
, frame
)
10046 if (FRAME_RIF (XFRAME (frame
)))
10047 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10051 return input_pending
;
10054 /* This is called in some cases before a possible quit.
10055 It cases the next call to detect_input_pending to recompute input_pending.
10056 So calling this function unnecessarily can't do any harm. */
10059 clear_input_pending ()
10064 /* Return nonzero if there are pending requeued events.
10065 This isn't used yet. The hope is to make wait_reading_process_output
10066 call it, and return if it runs Lisp code that unreads something.
10067 The problem is, kbd_buffer_get_event needs to be fixed to know what
10068 to do in that case. It isn't trivial. */
10071 requeued_events_pending_p ()
10073 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10077 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10078 doc
: /* Return t if command input is currently available with no wait.
10079 Actually, the value is nil only if we can be sure that no input is available;
10080 if there is a doubt, the value is t. */)
10083 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10086 get_input_pending (&input_pending
,
10087 READABLE_EVENTS_DO_TIMERS_NOW
10088 | READABLE_EVENTS_FILTER_EVENTS
);
10089 return input_pending
> 0 ? Qt
: Qnil
;
10092 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10093 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10096 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10099 if (total_keys
< NUM_RECENT_KEYS
)
10100 return Fvector (total_keys
, keys
);
10103 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10104 bcopy (keys
+ recent_keys_index
,
10105 XVECTOR (val
)->contents
,
10106 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10108 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10109 recent_keys_index
* sizeof (Lisp_Object
));
10114 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10115 doc
: /* Return the key sequence that invoked this command.
10116 However, if the command has called `read-key-sequence', it returns
10117 the last key sequence that has been read.
10118 The value is a string or a vector. */)
10121 return make_event_array (this_command_key_count
,
10122 XVECTOR (this_command_keys
)->contents
);
10125 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10126 doc
: /* Return the key sequence that invoked this command, as a vector.
10127 However, if the command has called `read-key-sequence', it returns
10128 the last key sequence that has been read. */)
10131 return Fvector (this_command_key_count
,
10132 XVECTOR (this_command_keys
)->contents
);
10135 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10136 Sthis_single_command_keys
, 0, 0, 0,
10137 doc
: /* Return the key sequence that invoked this command.
10138 More generally, it returns the last key sequence read, either by
10139 the command loop or by `read-key-sequence'.
10140 Unlike `this-command-keys', this function's value
10141 does not include prefix arguments.
10142 The value is always a vector. */)
10145 return Fvector (this_command_key_count
10146 - this_single_command_key_start
,
10147 (XVECTOR (this_command_keys
)->contents
10148 + this_single_command_key_start
));
10151 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10152 Sthis_single_command_raw_keys
, 0, 0, 0,
10153 doc
: /* Return the raw events that were read for this command.
10154 More generally, it returns the last key sequence read, either by
10155 the command loop or by `read-key-sequence'.
10156 Unlike `this-single-command-keys', this function's value
10157 shows the events before all translations (except for input methods).
10158 The value is always a vector. */)
10161 return Fvector (raw_keybuf_count
,
10162 (XVECTOR (raw_keybuf
)->contents
));
10165 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10166 Sreset_this_command_lengths
, 0, 0, 0,
10167 doc
: /* Make the unread events replace the last command and echo.
10168 Used in `universal-argument-other-key'.
10170 `universal-argument-other-key' rereads the event just typed.
10171 It then gets translated through `function-key-map'.
10172 The translated event has to replace the real events,
10173 both in the value of (this-command-keys) and in echoing.
10174 To achieve this, `universal-argument-other-key' calls
10175 `reset-this-command-lengths', which discards the record of reading
10176 these events the first time. */)
10179 this_command_key_count
= before_command_key_count
;
10180 if (this_command_key_count
< this_single_command_key_start
)
10181 this_single_command_key_start
= this_command_key_count
;
10183 echo_truncate (before_command_echo_length
);
10185 /* Cause whatever we put into unread-command-events
10186 to echo as if it were being freshly read from the keyboard. */
10187 this_command_key_count_reset
= 1;
10192 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10193 Sclear_this_command_keys
, 0, 1, 0,
10194 doc
: /* Clear out the vector that `this-command-keys' returns.
10195 Also clear the record of the last 100 events, unless optional arg
10196 KEEP-RECORD is non-nil. */)
10198 Lisp_Object keep_record
;
10202 this_command_key_count
= 0;
10203 this_command_key_count_reset
= 0;
10205 if (NILP (keep_record
))
10207 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10208 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10210 recent_keys_index
= 0;
10215 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10216 doc
: /* Return the current depth in recursive edits. */)
10220 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10224 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10225 "FOpen dribble file: ",
10226 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10227 If FILE is nil, close any open dribble file. */)
10238 file
= Fexpand_file_name (file
, Qnil
);
10239 dribble
= fopen (SDATA (file
), "w");
10241 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10246 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10247 doc
: /* Discard the contents of the terminal input buffer.
10248 Also end any kbd macro being defined. */)
10251 if (!NILP (current_kboard
->defining_kbd_macro
))
10253 /* Discard the last command from the macro. */
10254 Fcancel_kbd_macro_events ();
10258 update_mode_lines
++;
10260 Vunread_command_events
= Qnil
;
10261 unread_command_char
= -1;
10263 discard_tty_input ();
10265 kbd_fetch_ptr
= kbd_store_ptr
;
10271 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10272 doc
: /* Stop Emacs and return to superior process. You can resume later.
10273 If `cannot-suspend' is non-nil, or if the system doesn't support job
10274 control, run a subshell instead.
10276 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10277 to be read as terminal input by Emacs's parent, after suspension.
10279 Before suspending, run the normal hook `suspend-hook'.
10280 After resumption run the normal hook `suspend-resume-hook'.
10282 Some operating systems cannot stop the Emacs process and resume it later.
10283 On such systems, Emacs starts a subshell instead of suspending. */)
10285 Lisp_Object stuffstring
;
10287 int count
= SPECPDL_INDEX ();
10288 int old_height
, old_width
;
10290 struct gcpro gcpro1
;
10292 if (tty_list
&& tty_list
->next
)
10293 error ("There are other tty frames open; close them before suspending Emacs");
10295 if (!NILP (stuffstring
))
10296 CHECK_STRING (stuffstring
);
10298 /* Run the functions in suspend-hook. */
10299 if (!NILP (Vrun_hooks
))
10300 call1 (Vrun_hooks
, intern ("suspend-hook"));
10302 GCPRO1 (stuffstring
);
10303 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10304 reset_all_sys_modes ();
10305 /* sys_suspend can get an error if it tries to fork a subshell
10306 and the system resources aren't available for that. */
10307 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10309 stuff_buffered_input (stuffstring
);
10310 if (cannot_suspend
)
10314 unbind_to (count
, Qnil
);
10316 /* Check if terminal/window size has changed.
10317 Note that this is not useful when we are running directly
10318 with a window system; but suspend should be disabled in that case. */
10319 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10320 if (width
!= old_width
|| height
!= old_height
)
10321 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10323 /* Run suspend-resume-hook. */
10324 if (!NILP (Vrun_hooks
))
10325 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10331 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10332 Then in any case stuff anything Emacs has read ahead and not used. */
10335 stuff_buffered_input (stuffstring
)
10336 Lisp_Object stuffstring
;
10338 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10339 register unsigned char *p
;
10341 if (STRINGP (stuffstring
))
10343 register int count
;
10345 p
= SDATA (stuffstring
);
10346 count
= SBYTES (stuffstring
);
10347 while (count
-- > 0)
10352 /* Anything we have read ahead, put back for the shell to read. */
10353 /* ?? What should this do when we have multiple keyboards??
10354 Should we ignore anything that was typed in at the "wrong" kboard?
10356 rms: we should stuff everything back into the kboard
10358 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10361 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10362 kbd_fetch_ptr
= kbd_buffer
;
10363 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10364 stuff_char (kbd_fetch_ptr
->code
);
10366 clear_event (kbd_fetch_ptr
);
10370 #endif /* SIGTSTP */
10374 set_waiting_for_input (time_to_clear
)
10375 EMACS_TIME
*time_to_clear
;
10377 input_available_clear_time
= time_to_clear
;
10379 /* Tell handle_interrupt to throw back to read_char, */
10380 waiting_for_input
= 1;
10382 /* If handle_interrupt was called before and buffered a C-g,
10383 make it run again now, to avoid timing error. */
10384 if (!NILP (Vquit_flag
))
10385 quit_throw_to_read_char ();
10389 clear_waiting_for_input ()
10391 /* Tell handle_interrupt not to throw back to read_char, */
10392 waiting_for_input
= 0;
10393 input_available_clear_time
= 0;
10396 /* The SIGINT handler.
10398 If we have a frame on the controlling tty, we assume that the
10399 SIGINT was generated by C-g, so we call handle_interrupt.
10400 Otherwise, the handler kills Emacs. */
10403 interrupt_signal (signalnum
) /* If we don't have an argument, */
10404 int signalnum
; /* some compilers complain in signal calls. */
10406 /* Must preserve main program's value of errno. */
10407 int old_errno
= errno
;
10408 struct device
*device
;
10410 #if defined (USG) && !defined (POSIX_SIGNALS)
10411 /* USG systems forget handlers when they are used;
10412 must reestablish each time */
10413 signal (SIGINT
, interrupt_signal
);
10414 signal (SIGQUIT
, interrupt_signal
);
10417 SIGNAL_THREAD_CHECK (signalnum
);
10419 /* See if we have an active display on our controlling terminal. */
10420 device
= get_named_tty (NULL
);
10423 /* If there are no frames there, let's pretend that we are a
10424 well-behaving UN*X program and quit. */
10425 fatal_error_signal (SIGTERM
);
10429 /* Otherwise, the SIGINT was probably generated by C-g. */
10431 /* Set internal_last_event_frame to the top frame of the
10432 controlling tty, if we have a frame there. We disable the
10433 interrupt key on secondary ttys, so the SIGINT must have come
10434 from the controlling tty. */
10435 internal_last_event_frame
= device
->display_info
.tty
->top_frame
;
10437 handle_interrupt ();
10443 /* This routine is called at interrupt level in response to C-g.
10445 It is called from the SIGINT handler or kbd_buffer_store_event.
10447 If `waiting_for_input' is non zero, then unless `echoing' is
10448 nonzero, immediately throw back to read_char.
10450 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10451 eval to throw, when it gets a chance. If quit-flag is already
10452 non-nil, it stops the job right away. */
10455 handle_interrupt ()
10461 /* XXX This code needs to be revised for multi-tty support. */
10462 if (!NILP (Vquit_flag
)
10464 && get_named_tty (NULL
)
10468 /* If SIGINT isn't blocked, don't let us be interrupted by
10469 another SIGINT, it might be harmful due to non-reentrancy
10470 in I/O functions. */
10471 sigblock (sigmask (SIGINT
));
10474 reset_all_sys_modes ();
10476 #ifdef SIGTSTP /* Support possible in later USG versions */
10478 * On systems which can suspend the current process and return to the original
10479 * shell, this command causes the user to end up back at the shell.
10480 * The "Auto-save" and "Abort" questions are not asked until
10481 * the user elects to return to emacs, at which point he can save the current
10482 * job and either dump core or continue.
10487 if (sys_suspend () == -1)
10489 printf ("Not running as a subprocess;\n");
10490 printf ("you can continue or abort.\n");
10492 #else /* not VMS */
10493 /* Perhaps should really fork an inferior shell?
10494 But that would not provide any way to get back
10495 to the original shell, ever. */
10496 printf ("No support for stopping a process on this operating system;\n");
10497 printf ("you can continue or abort.\n");
10498 #endif /* not VMS */
10499 #endif /* not SIGTSTP */
10501 /* We must remain inside the screen area when the internal terminal
10502 is used. Note that [Enter] is not echoed by dos. */
10505 /* It doesn't work to autosave while GC is in progress;
10506 the code used for auto-saving doesn't cope with the mark bit. */
10507 if (!gc_in_progress
)
10509 printf ("Auto-save? (y or n) ");
10511 if (((c
= getchar ()) & ~040) == 'Y')
10513 Fdo_auto_save (Qt
, Qnil
);
10515 printf ("\r\nAuto-save done");
10516 #else /* not MSDOS */
10517 printf ("Auto-save done\n");
10518 #endif /* not MSDOS */
10520 while (c
!= '\n') c
= getchar ();
10524 /* During GC, it must be safe to reenable quitting again. */
10525 Vinhibit_quit
= Qnil
;
10528 #endif /* not MSDOS */
10529 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10530 printf ("but will instead do a real quit after garbage collection ends\r\n");
10535 printf ("\r\nAbort? (y or n) ");
10536 #else /* not MSDOS */
10538 printf ("Abort (and enter debugger)? (y or n) ");
10539 #else /* not VMS */
10540 printf ("Abort (and dump core)? (y or n) ");
10541 #endif /* not VMS */
10542 #endif /* not MSDOS */
10544 if (((c
= getchar ()) & ~040) == 'Y')
10546 while (c
!= '\n') c
= getchar ();
10548 printf ("\r\nContinuing...\r\n");
10549 #else /* not MSDOS */
10550 printf ("Continuing...\n");
10551 #endif /* not MSDOS */
10553 init_all_sys_modes ();
10558 /* If executing a function that wants to be interrupted out of
10559 and the user has not deferred quitting by binding `inhibit-quit'
10560 then quit right away. */
10561 if (immediate_quit
&& NILP (Vinhibit_quit
))
10563 struct gl_state_s saved
;
10564 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10566 immediate_quit
= 0;
10569 GCPRO4 (saved
.object
, saved
.global_code
,
10570 saved
.current_syntax_table
, saved
.old_prop
);
10571 Fsignal (Qquit
, Qnil
);
10576 /* Else request quit when it's safe */
10580 if (waiting_for_input
&& !echoing
)
10581 quit_throw_to_read_char ();
10584 /* Handle a C-g by making read_char return C-g. */
10587 quit_throw_to_read_char ()
10590 /* Prevent another signal from doing this before we finish. */
10591 clear_waiting_for_input ();
10594 Vunread_command_events
= Qnil
;
10595 unread_command_char
= -1;
10597 #if 0 /* Currently, sit_for is called from read_char without turning
10598 off polling. And that can call set_waiting_for_input.
10599 It seems to be harmless. */
10600 #ifdef POLL_FOR_INPUT
10601 /* May be > 1 if in recursive minibuffer. */
10602 if (poll_suppress_count
== 0)
10606 if (FRAMEP (internal_last_event_frame
)
10607 && !EQ (internal_last_event_frame
, selected_frame
))
10608 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10611 _longjmp (getcjmp
, 1);
10614 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10615 doc
: /* Set mode of reading keyboard input.
10616 First arg INTERRUPT non-nil means use input interrupts;
10617 nil means use CBREAK mode.
10618 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10619 (no effect except in CBREAK mode).
10620 Third arg META t means accept 8-bit input (for a Meta key).
10621 META nil means ignore the top bit, on the assumption it is parity.
10622 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10623 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10624 See also `current-input-mode'. */)
10625 (interrupt
, flow
, meta
, quit
)
10626 Lisp_Object interrupt
, flow
, meta
, quit
;
10628 /* XXX This function needs to be revised for multi-device support.
10629 Currently it compiles fine, but its semantics are wrong. It sets
10630 global parameters (e.g. interrupt_input) based on only the
10631 current frame's device. */
10634 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10635 error ("set-input-mode: QUIT must be an ASCII character");
10637 #ifdef POLL_FOR_INPUT
10642 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10643 /* this causes startup screen to be restored and messes with the mouse */
10644 reset_sys_modes (CURTTY ());
10648 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10649 if (FRAME_DEVICE (SELECTED_FRAME ())->read_socket_hook
)
10651 /* When using X, don't give the user a real choice,
10652 because we haven't implemented the mechanisms to support it. */
10653 #ifdef NO_SOCK_SIGIO
10654 interrupt_input
= 0;
10655 #else /* not NO_SOCK_SIGIO */
10656 interrupt_input
= 1;
10657 #endif /* NO_SOCK_SIGIO */
10660 interrupt_input
= !NILP (interrupt
);
10661 #else /* not SIGIO */
10662 interrupt_input
= 0;
10663 #endif /* not SIGIO */
10665 /* Our VMS input only works by interrupts, as of now. */
10667 interrupt_input
= 1;
10670 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10672 struct tty_display_info
*tty
= CURTTY ();
10673 tty
->flow_control
= !NILP (flow
);
10676 else if (EQ (meta
, Qt
))
10683 /* Don't let this value be out of range. */
10684 quit_char
= XINT (quit
) & (NILP (meta
) ? 0177 : 0377);
10687 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10688 init_sys_modes (CURTTY ());
10691 #ifdef POLL_FOR_INPUT
10692 poll_suppress_count
= 1;
10698 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10699 doc
: /* Return information about the way Emacs currently reads keyboard input.
10700 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10701 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10702 nil, Emacs is using CBREAK mode.
10703 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10704 terminal; this does not apply if Emacs uses interrupt-driven input.
10705 META is t if accepting 8-bit input with 8th bit as Meta flag.
10706 META nil means ignoring the top bit, on the assumption it is parity.
10707 META is neither t nor nil if accepting 8-bit input and using
10708 all 8 bits as the character code.
10709 QUIT is the character Emacs currently uses to quit.
10710 The elements of this list correspond to the arguments of
10711 `set-input-mode'. */)
10714 Lisp_Object val
[4];
10715 struct frame
*sf
= XFRAME (selected_frame
);
10717 val
[0] = interrupt_input
? Qt
: Qnil
;
10718 if (FRAME_TERMCAP_P (sf
))
10720 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10721 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10723 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10730 XSETFASTINT (val
[3], quit_char
);
10732 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10735 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10736 doc
: /* Return position information for pixel coordinates X and Y.
10737 By default, X and Y are relative to text area of the selected window.
10738 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10739 If optional fourth arg WHOLE is non-nil, X is relative to the left
10740 edge of the window.
10742 The return value is similar to a mouse click position:
10743 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10744 IMAGE (DX . DY) (WIDTH . HEIGHT))
10745 The `posn-' functions access elements of such lists. */)
10746 (x
, y
, frame_or_window
, whole
)
10747 Lisp_Object x
, y
, frame_or_window
, whole
;
10752 if (NILP (frame_or_window
))
10753 frame_or_window
= selected_window
;
10755 if (WINDOWP (frame_or_window
))
10759 CHECK_LIVE_WINDOW (frame_or_window
);
10761 w
= XWINDOW (frame_or_window
);
10762 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10764 ? window_box_left_offset (w
, TEXT_AREA
)
10765 : - (WINDOW_LEFT_SCROLL_BAR_COLS (w
)
10766 * WINDOW_FRAME_COLUMN_WIDTH (w
)))));
10767 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10768 frame_or_window
= w
->frame
;
10771 CHECK_LIVE_FRAME (frame_or_window
);
10773 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10776 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10777 doc
: /* Return position information for buffer POS in WINDOW.
10778 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10780 Return nil if position is not visible in window. Otherwise,
10781 the return value is similar to that returned by `event-start' for
10782 a mouse click at the upper left corner of the glyph corresponding
10783 to the given buffer position:
10784 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10785 IMAGE (DX . DY) (WIDTH . HEIGHT))
10786 The `posn-' functions access elements of such lists. */)
10788 Lisp_Object pos
, window
;
10792 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10794 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
, Qnil
);
10800 * Set up a new kboard object with reasonable initial values.
10806 kb
->Voverriding_terminal_local_map
= Qnil
;
10807 kb
->Vlast_command
= Qnil
;
10808 kb
->Vreal_last_command
= Qnil
;
10809 kb
->Vprefix_arg
= Qnil
;
10810 kb
->Vlast_prefix_arg
= Qnil
;
10811 kb
->kbd_queue
= Qnil
;
10812 kb
->kbd_queue_has_data
= 0;
10813 kb
->immediate_echo
= 0;
10814 kb
->echo_string
= Qnil
;
10815 kb
->echo_after_prompt
= -1;
10816 kb
->kbd_macro_buffer
= 0;
10817 kb
->kbd_macro_bufsize
= 0;
10818 kb
->defining_kbd_macro
= Qnil
;
10819 kb
->Vlast_kbd_macro
= Qnil
;
10820 kb
->reference_count
= 0;
10821 kb
->Vsystem_key_alist
= Qnil
;
10822 kb
->system_key_syms
= Qnil
;
10823 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
10824 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
10825 kb
->Vlocal_key_translation_map
= Fmake_sparse_keymap (Qnil
);
10826 Fset_keymap_parent (kb
->Vlocal_key_translation_map
, Vkey_translation_map
);
10827 kb
->Vdefault_minibuffer_frame
= Qnil
;
10831 * Destroy the contents of a kboard object, but not the object itself.
10832 * We use this just before deleting it, or if we're going to initialize
10833 * it a second time.
10839 if (kb
->kbd_macro_buffer
)
10840 xfree (kb
->kbd_macro_buffer
);
10843 #ifdef MULTI_KBOARD
10845 /* Free KB and memory referenced from it. */
10853 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10856 *kbp
= kb
->next_kboard
;
10858 /* Prevent a dangling reference to KB. */
10859 if (kb
== current_kboard
10860 && FRAMEP (selected_frame
)
10861 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10863 current_kboard
= XFRAME (selected_frame
)->device
->kboard
;
10864 if (current_kboard
== kb
)
10872 #endif /* MULTI_KBOARD */
10877 /* This is correct before outermost invocation of the editor loop */
10878 command_loop_level
= -1;
10879 immediate_quit
= 0;
10880 quit_char
= Ctl ('g');
10881 Vunread_command_events
= Qnil
;
10882 unread_command_char
= -1;
10883 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10885 recent_keys_index
= 0;
10886 kbd_fetch_ptr
= kbd_buffer
;
10887 kbd_store_ptr
= kbd_buffer
;
10889 do_mouse_tracking
= Qnil
;
10893 /* This means that command_loop_1 won't try to select anything the first
10895 internal_last_event_frame
= Qnil
;
10896 Vlast_event_frame
= internal_last_event_frame
;
10898 #ifdef MULTI_KBOARD
10899 current_kboard
= initial_kboard
;
10901 wipe_kboard (current_kboard
);
10902 init_kboard (current_kboard
);
10904 if (!noninteractive
)
10906 /* Before multi-tty support, these handlers used to be installed
10907 only if the current session was a tty session. Now an Emacs
10908 session may have multiple display types, so we always handle
10909 SIGINT. There is special code in interrupt_signal to exit
10910 Emacs on SIGINT when there are no termcap frames on the
10911 controlling terminal. */
10912 signal (SIGINT
, interrupt_signal
);
10913 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10914 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10915 SIGQUIT and we can't tell which one it will give us. */
10916 signal (SIGQUIT
, interrupt_signal
);
10917 #endif /* HAVE_TERMIO */
10919 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10921 if (!noninteractive
)
10922 signal (SIGIO
, input_available_signal
);
10925 /* Use interrupt input by default, if it works and noninterrupt input
10926 has deficiencies. */
10928 #ifdef INTERRUPT_INPUT
10929 interrupt_input
= 1;
10931 interrupt_input
= 0;
10934 /* Our VMS input only works by interrupts, as of now. */
10936 interrupt_input
= 1;
10942 if (keyboard_init_hook
)
10943 (*keyboard_init_hook
) ();
10945 #ifdef POLL_FOR_INPUT
10946 poll_suppress_count
= 1;
10951 /* At least provide an escape route since C-g doesn't work. */
10952 signal (SIGINT
, interrupt_signal
);
10956 /* This type's only use is in syms_of_keyboard, to initialize the
10957 event header symbols and put properties on them. */
10958 struct event_head
{
10964 struct event_head head_table
[] = {
10965 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10966 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10967 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10968 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10969 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10970 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10971 /* `select-window' should be handled just like `switch-frame'
10972 in read_key_sequence. */
10973 {&Qselect_window
, "select-window", &Qswitch_frame
}
10977 syms_of_keyboard ()
10979 Vpre_help_message
= Qnil
;
10980 staticpro (&Vpre_help_message
);
10982 Vlispy_mouse_stem
= build_string ("mouse");
10983 staticpro (&Vlispy_mouse_stem
);
10986 QCimage
= intern (":image");
10987 staticpro (&QCimage
);
10989 staticpro (&Qhelp_echo
);
10990 Qhelp_echo
= intern ("help-echo");
10992 staticpro (&item_properties
);
10993 item_properties
= Qnil
;
10995 staticpro (&tool_bar_item_properties
);
10996 tool_bar_item_properties
= Qnil
;
10997 staticpro (&tool_bar_items_vector
);
10998 tool_bar_items_vector
= Qnil
;
11000 staticpro (&real_this_command
);
11001 real_this_command
= Qnil
;
11003 Qtimer_event_handler
= intern ("timer-event-handler");
11004 staticpro (&Qtimer_event_handler
);
11006 Qdisabled_command_function
= intern ("disabled-command-function");
11007 staticpro (&Qdisabled_command_function
);
11009 Qself_insert_command
= intern ("self-insert-command");
11010 staticpro (&Qself_insert_command
);
11012 Qforward_char
= intern ("forward-char");
11013 staticpro (&Qforward_char
);
11015 Qbackward_char
= intern ("backward-char");
11016 staticpro (&Qbackward_char
);
11018 Qdisabled
= intern ("disabled");
11019 staticpro (&Qdisabled
);
11021 Qundefined
= intern ("undefined");
11022 staticpro (&Qundefined
);
11024 Qpre_command_hook
= intern ("pre-command-hook");
11025 staticpro (&Qpre_command_hook
);
11027 Qpost_command_hook
= intern ("post-command-hook");
11028 staticpro (&Qpost_command_hook
);
11030 Qdeferred_action_function
= intern ("deferred-action-function");
11031 staticpro (&Qdeferred_action_function
);
11033 Qcommand_hook_internal
= intern ("command-hook-internal");
11034 staticpro (&Qcommand_hook_internal
);
11036 Qfunction_key
= intern ("function-key");
11037 staticpro (&Qfunction_key
);
11038 Qmouse_click
= intern ("mouse-click");
11039 staticpro (&Qmouse_click
);
11040 #if defined (WINDOWSNT) || defined (MAC_OS)
11041 Qlanguage_change
= intern ("language-change");
11042 staticpro (&Qlanguage_change
);
11044 Qdrag_n_drop
= intern ("drag-n-drop");
11045 staticpro (&Qdrag_n_drop
);
11047 Qsave_session
= intern ("save-session");
11048 staticpro (&Qsave_session
);
11050 Qusr1_signal
= intern ("usr1-signal");
11051 staticpro (&Qusr1_signal
);
11052 Qusr2_signal
= intern ("usr2-signal");
11053 staticpro (&Qusr2_signal
);
11055 Qmenu_enable
= intern ("menu-enable");
11056 staticpro (&Qmenu_enable
);
11057 Qmenu_alias
= intern ("menu-alias");
11058 staticpro (&Qmenu_alias
);
11059 QCenable
= intern (":enable");
11060 staticpro (&QCenable
);
11061 QCvisible
= intern (":visible");
11062 staticpro (&QCvisible
);
11063 QChelp
= intern (":help");
11064 staticpro (&QChelp
);
11065 QCfilter
= intern (":filter");
11066 staticpro (&QCfilter
);
11067 QCbutton
= intern (":button");
11068 staticpro (&QCbutton
);
11069 QCkeys
= intern (":keys");
11070 staticpro (&QCkeys
);
11071 QCkey_sequence
= intern (":key-sequence");
11072 staticpro (&QCkey_sequence
);
11073 QCtoggle
= intern (":toggle");
11074 staticpro (&QCtoggle
);
11075 QCradio
= intern (":radio");
11076 staticpro (&QCradio
);
11078 Qmode_line
= intern ("mode-line");
11079 staticpro (&Qmode_line
);
11080 Qvertical_line
= intern ("vertical-line");
11081 staticpro (&Qvertical_line
);
11082 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11083 staticpro (&Qvertical_scroll_bar
);
11084 Qmenu_bar
= intern ("menu-bar");
11085 staticpro (&Qmenu_bar
);
11088 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11089 staticpro (&Qmouse_fixup_help_message
);
11092 Qabove_handle
= intern ("above-handle");
11093 staticpro (&Qabove_handle
);
11094 Qhandle
= intern ("handle");
11095 staticpro (&Qhandle
);
11096 Qbelow_handle
= intern ("below-handle");
11097 staticpro (&Qbelow_handle
);
11098 Qup
= intern ("up");
11100 Qdown
= intern ("down");
11101 staticpro (&Qdown
);
11102 Qtop
= intern ("top");
11104 Qbottom
= intern ("bottom");
11105 staticpro (&Qbottom
);
11106 Qend_scroll
= intern ("end-scroll");
11107 staticpro (&Qend_scroll
);
11108 Qratio
= intern ("ratio");
11109 staticpro (&Qratio
);
11111 Qevent_kind
= intern ("event-kind");
11112 staticpro (&Qevent_kind
);
11113 Qevent_symbol_elements
= intern ("event-symbol-elements");
11114 staticpro (&Qevent_symbol_elements
);
11115 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11116 staticpro (&Qevent_symbol_element_mask
);
11117 Qmodifier_cache
= intern ("modifier-cache");
11118 staticpro (&Qmodifier_cache
);
11120 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11121 staticpro (&Qrecompute_lucid_menubar
);
11122 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11123 staticpro (&Qactivate_menubar_hook
);
11125 Qpolling_period
= intern ("polling-period");
11126 staticpro (&Qpolling_period
);
11128 Qinput_method_function
= intern ("input-method-function");
11129 staticpro (&Qinput_method_function
);
11131 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11132 staticpro (&Qinput_method_exit_on_first_char
);
11133 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11134 staticpro (&Qinput_method_use_echo_area
);
11136 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11137 Fset (Qinput_method_use_echo_area
, Qnil
);
11139 last_point_position_buffer
= Qnil
;
11142 struct event_head
*p
;
11144 for (p
= head_table
;
11145 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11148 *p
->var
= intern (p
->name
);
11149 staticpro (p
->var
);
11150 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11151 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11155 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11156 staticpro (&button_down_location
);
11157 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11158 staticpro (&mouse_syms
);
11159 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11160 staticpro (&wheel_syms
);
11164 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11166 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11167 for (i
= 0; i
< len
; i
++)
11168 if (modifier_names
[i
])
11169 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11170 staticpro (&modifier_symbols
);
11173 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11174 staticpro (&recent_keys
);
11176 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11177 staticpro (&this_command_keys
);
11179 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11180 staticpro (&raw_keybuf
);
11182 Qextended_command_history
= intern ("extended-command-history");
11183 Fset (Qextended_command_history
, Qnil
);
11184 staticpro (&Qextended_command_history
);
11186 accent_key_syms
= Qnil
;
11187 staticpro (&accent_key_syms
);
11189 func_key_syms
= Qnil
;
11190 staticpro (&func_key_syms
);
11192 drag_n_drop_syms
= Qnil
;
11193 staticpro (&drag_n_drop_syms
);
11195 unread_switch_frame
= Qnil
;
11196 staticpro (&unread_switch_frame
);
11198 internal_last_event_frame
= Qnil
;
11199 staticpro (&internal_last_event_frame
);
11201 read_key_sequence_cmd
= Qnil
;
11202 staticpro (&read_key_sequence_cmd
);
11204 menu_bar_one_keymap_changed_items
= Qnil
;
11205 staticpro (&menu_bar_one_keymap_changed_items
);
11207 menu_bar_items_vector
= Qnil
;
11208 staticpro (&menu_bar_items_vector
);
11210 defsubr (&Sevent_convert_list
);
11211 defsubr (&Sread_key_sequence
);
11212 defsubr (&Sread_key_sequence_vector
);
11213 defsubr (&Srecursive_edit
);
11215 defsubr (&Strack_mouse
);
11217 defsubr (&Sinput_pending_p
);
11218 defsubr (&Scommand_execute
);
11219 defsubr (&Srecent_keys
);
11220 defsubr (&Sthis_command_keys
);
11221 defsubr (&Sthis_command_keys_vector
);
11222 defsubr (&Sthis_single_command_keys
);
11223 defsubr (&Sthis_single_command_raw_keys
);
11224 defsubr (&Sreset_this_command_lengths
);
11225 defsubr (&Sclear_this_command_keys
);
11226 defsubr (&Ssuspend_emacs
);
11227 defsubr (&Sabort_recursive_edit
);
11228 defsubr (&Sexit_recursive_edit
);
11229 defsubr (&Srecursion_depth
);
11230 defsubr (&Stop_level
);
11231 defsubr (&Sdiscard_input
);
11232 defsubr (&Sopen_dribble_file
);
11233 defsubr (&Sset_input_mode
);
11234 defsubr (&Scurrent_input_mode
);
11235 defsubr (&Sexecute_extended_command
);
11236 defsubr (&Sposn_at_point
);
11237 defsubr (&Sposn_at_x_y
);
11239 DEFVAR_LISP ("last-command-char", &last_command_char
,
11240 doc
: /* Last input event that was part of a command. */);
11242 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11243 doc
: /* Last input event that was part of a command. */);
11245 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11246 doc
: /* Last input event in a command, except for mouse menu events.
11247 Mouse menus give back keys that don't look like mouse events;
11248 this variable holds the actual mouse event that led to the menu,
11249 so that you can determine whether the command was run by mouse or not. */);
11251 DEFVAR_LISP ("last-input-char", &last_input_char
,
11252 doc
: /* Last input event. */);
11254 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11255 doc
: /* Last input event. */);
11257 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11258 doc
: /* List of events to be read as the command input.
11259 These events are processed first, before actual keyboard input. */);
11260 Vunread_command_events
= Qnil
;
11262 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11263 doc
: /* If not -1, an object to be read as next command input event. */);
11265 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11266 doc
: /* List of events to be processed as input by input methods.
11267 These events are processed after `unread-command-events', but
11268 before actual keyboard input. */);
11269 Vunread_post_input_method_events
= Qnil
;
11271 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11272 doc
: /* List of events to be processed as input by input methods.
11273 These events are processed after `unread-command-events', but
11274 before actual keyboard input. */);
11275 Vunread_input_method_events
= Qnil
;
11277 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11278 doc
: /* Meta-prefix character code.
11279 Meta-foo as command input turns into this character followed by foo. */);
11280 XSETINT (meta_prefix_char
, 033);
11282 DEFVAR_KBOARD ("last-command", Vlast_command
,
11283 doc
: /* The last command executed.
11284 Normally a symbol with a function definition, but can be whatever was found
11285 in the keymap, or whatever the variable `this-command' was set to by that
11288 The value `mode-exit' is special; it means that the previous command
11289 read an event that told it to exit, and it did so and unread that event.
11290 In other words, the present command is the event that made the previous
11293 The value `kill-region' is special; it means that the previous command
11294 was a kill command.
11296 `last-command' has a separate binding for each display device.
11297 See Info node `(elisp)Multiple displays'. */);
11299 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11300 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11302 DEFVAR_LISP ("this-command", &Vthis_command
,
11303 doc
: /* The command now being executed.
11304 The command can set this variable; whatever is put here
11305 will be in `last-command' during the following command. */);
11306 Vthis_command
= Qnil
;
11308 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11309 doc
: /* The command bound to the current key sequence before remapping.
11310 It equals `this-command' if the original command was not remapped through
11311 any of the active keymaps. Otherwise, the value of `this-command' is the
11312 result of looking up the original command in the active keymaps. */);
11313 Vthis_original_command
= Qnil
;
11315 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11316 doc
: /* *Number of input events between auto-saves.
11317 Zero means disable autosaving due to number of characters typed. */);
11318 auto_save_interval
= 300;
11320 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11321 doc
: /* *Number of seconds idle time before auto-save.
11322 Zero or nil means disable auto-saving due to idleness.
11323 After auto-saving due to this many seconds of idle time,
11324 Emacs also does a garbage collection if that seems to be warranted. */);
11325 XSETFASTINT (Vauto_save_timeout
, 30);
11327 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11328 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11329 The value may be integer or floating point. */);
11330 Vecho_keystrokes
= make_number (1);
11332 DEFVAR_INT ("polling-period", &polling_period
,
11333 doc
: /* *Interval between polling for input during Lisp execution.
11334 The reason for polling is to make C-g work to stop a running program.
11335 Polling is needed only when using X windows and SIGIO does not work.
11336 Polling is automatically disabled in all other cases. */);
11337 polling_period
= 2;
11339 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11340 doc
: /* *Maximum time between mouse clicks to make a double-click.
11341 Measured in milliseconds. nil means disable double-click recognition;
11342 t means double-clicks have no time limit and are detected
11343 by position only. */);
11344 Vdouble_click_time
= make_number (500);
11346 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11347 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11348 On window-system frames, value is the number of pixels the mouse may have
11349 moved horizontally or vertically between two clicks to make a double-click.
11350 On non window-system frames, value is interpreted in units of 1/8 characters
11353 This variable is also the threshold for motion of the mouse
11354 to count as a drag. */);
11355 double_click_fuzz
= 3;
11357 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11358 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11359 inhibit_local_menu_bar_menus
= 0;
11361 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11362 doc
: /* Number of complete key sequences read as input so far.
11363 This includes key sequences read from keyboard macros.
11364 The number is effectively the number of interactive command invocations. */);
11365 num_input_keys
= 0;
11367 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11368 doc
: /* Number of input events read from the keyboard so far.
11369 This does not include events generated by keyboard macros. */);
11370 num_nonmacro_input_events
= 0;
11372 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11373 doc
: /* The frame in which the most recently read event occurred.
11374 If the last event came from a keyboard macro, this is set to `macro'. */);
11375 Vlast_event_frame
= Qnil
;
11377 /* This variable is set up in sysdep.c. */
11378 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11379 doc
: /* The ERASE character as set by the user with stty. */);
11381 DEFVAR_LISP ("help-char", &Vhelp_char
,
11382 doc
: /* Character to recognize as meaning Help.
11383 When it is read, do `(eval help-form)', and display result if it's a string.
11384 If the value of `help-form' is nil, this char can be read normally. */);
11385 XSETINT (Vhelp_char
, Ctl ('H'));
11387 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11388 doc
: /* List of input events to recognize as meaning Help.
11389 These work just like the value of `help-char' (see that). */);
11390 Vhelp_event_list
= Qnil
;
11392 DEFVAR_LISP ("help-form", &Vhelp_form
,
11393 doc
: /* Form to execute when character `help-char' is read.
11394 If the form returns a string, that string is displayed.
11395 If `help-form' is nil, the help char is not recognized. */);
11398 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11399 doc
: /* Command to run when `help-char' character follows a prefix key.
11400 This command is used only when there is no actual binding
11401 for that character after that prefix key. */);
11402 Vprefix_help_command
= Qnil
;
11404 DEFVAR_LISP ("top-level", &Vtop_level
,
11405 doc
: /* Form to evaluate when Emacs starts up.
11406 Useful to set before you dump a modified Emacs. */);
11409 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11410 doc
: /* Translate table for keyboard input, or nil.
11411 If non-nil, the value should be a char-table. Each character read
11412 from the keyboard is looked up in this char-table. If the value found
11413 there is non-nil, then it is used instead of the actual input character.
11415 The value can also be a string or vector, but this is considered obsolete.
11416 If it is a string or vector of length N, character codes N and up are left
11417 untranslated. In a vector, an element which is nil means "no translation".
11419 This is applied to the characters supplied to input methods, not their
11420 output. See also `translation-table-for-input'. */);
11421 Vkeyboard_translate_table
= Qnil
;
11423 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11424 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11425 \(Even if the operating system has support for stopping a process.\) */);
11426 cannot_suspend
= 0;
11428 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11429 doc
: /* Non-nil means prompt with menus when appropriate.
11430 This is done when reading from a keymap that has a prompt string,
11431 for elements that have prompt strings.
11432 The menu is displayed on the screen
11433 if X menus were enabled at configuration
11434 time and the previous event was a mouse click prefix key.
11435 Otherwise, menu prompting uses the echo area. */);
11436 menu_prompting
= 1;
11438 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11439 doc
: /* Character to see next line of menu prompt.
11440 Type this character while in a menu prompt to rotate around the lines of it. */);
11441 XSETINT (menu_prompt_more_char
, ' ');
11443 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11444 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11445 Emacs applies the modifiers of the character stored here to each keyboard
11446 character it reads. For example, after evaluating the expression
11447 (setq extra-keyboard-modifiers ?\\C-x)
11448 all input characters will have the control modifier applied to them.
11450 Note that the character ?\\C-@, equivalent to the integer zero, does
11451 not count as a control character; rather, it counts as a character
11452 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11453 cancels any modification. */);
11454 extra_keyboard_modifiers
= 0;
11456 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11457 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11458 The command loop sets this to nil before each command,
11459 and tests the value when the command returns.
11460 Buffer modification stores t in this variable. */);
11461 Vdeactivate_mark
= Qnil
;
11463 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11464 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11465 Vcommand_hook_internal
= Qnil
;
11467 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11468 doc
: /* Normal hook run before each command is executed.
11469 If an unhandled error happens in running this hook,
11470 the hook value is set to nil, since otherwise the error
11471 might happen repeatedly and make Emacs nonfunctional. */);
11472 Vpre_command_hook
= Qnil
;
11474 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11475 doc
: /* Normal hook run after each command is executed.
11476 If an unhandled error happens in running this hook,
11477 the hook value is set to nil, since otherwise the error
11478 might happen repeatedly and make Emacs nonfunctional. */);
11479 Vpost_command_hook
= Qnil
;
11482 DEFVAR_LISP ("echo-area-clear-hook", ...,
11483 doc
: /* Normal hook run when clearing the echo area. */);
11485 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11486 staticpro (&Qecho_area_clear_hook
);
11487 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11489 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11490 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11491 Vlucid_menu_bar_dirty_flag
= Qnil
;
11493 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11494 doc
: /* List of menu bar items to move to the end of the menu bar.
11495 The elements of the list are event types that may have menu bar bindings. */);
11496 Vmenu_bar_final_items
= Qnil
;
11498 DEFVAR_KBOARD ("overriding-terminal-local-map",
11499 Voverriding_terminal_local_map
,
11500 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11501 If this variable is non-nil, it is used as a keymap instead of the
11502 buffer's local map, and the minor mode keymaps and text property keymaps.
11503 It also replaces `overriding-local-map'.
11505 This variable is intended to let commands such as `universal-argument'
11506 set up a different keymap for reading the next command.
11508 `overriding-terminal-local-map' has a separate binding for each display device.
11509 See Info node `(elisp)Multiple displays'. */);
11511 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11512 doc
: /* Keymap that overrides all other local keymaps.
11513 If this variable is non-nil, it is used as a keymap--replacing the
11514 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11515 Voverriding_local_map
= Qnil
;
11517 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11518 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11519 Otherwise, the menu bar continues to reflect the buffer's local map
11520 and the minor mode maps regardless of `overriding-local-map'. */);
11521 Voverriding_local_map_menu_flag
= Qnil
;
11523 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11524 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11525 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11527 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11528 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11530 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11531 doc
: /* Alist of system-specific X windows key symbols.
11532 Each element should have the form (N . SYMBOL) where N is the
11533 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11534 and SYMBOL is its name.
11536 `system-key-alist' has a separate binding for each display device.
11537 See Info node `(elisp)Multiple displays'.
11539 Note that the currently selected frame has very little to do with
11540 which binding of this variable is active at any given moment. If you
11541 need set or get the binding on a specific display, use
11542 `terminal-local-value' and `set-terminal-local-value'. */);
11544 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11545 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
11546 This allows Emacs to recognize function keys sent from ASCII
11547 terminals at any point in a key sequence.
11549 The `read-key-sequence' function replaces any subsequence bound by
11550 `function-key-map' with its binding. More precisely, when the active
11551 keymaps have no binding for the current key sequence but
11552 `function-key-map' binds a suffix of the sequence to a vector or string,
11553 `read-key-sequence' replaces the matching suffix with its binding, and
11554 continues with the new sequence.
11556 The events that come from bindings in `function-key-map' are not
11557 themselves looked up in `function-key-map'.
11559 For example, suppose `function-key-map' binds `ESC O P' to [f1].
11560 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11561 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
11562 key, typing `ESC O P x' would return [f1 x].
11564 `function-key-map' has a separate binding for each display device.
11565 See Info node `(elisp)Multiple displays'. If you need to define a
11566 binding on all display devices, change `global-function-key-map'
11569 Note that the currently selected frame has very little to do with
11570 which binding of this variable is active at any given moment. If you
11571 need set or get the binding on a specific display, use
11572 `terminal-local-value' and `set-terminal-local-value'. */);
11574 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
11575 doc
: /* The parent keymap of all `local-function-key-map' instances.
11576 Function key definitions that apply to all display devices should go
11578 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11580 DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map
,
11581 doc
: /* Keymap of key translations that can override keymaps.
11582 This keymap works like `function-key-map', but comes after that,
11583 and its non-prefix bindings override ordinary bindings.
11585 `key-translation-map' has a separate binding for each display device.
11586 (See Info node `(elisp)Multiple displays'.) If you need to set a key
11587 translation on all devices, change `global-key-translation-map' instead.
11589 Note that the currently selected frame has very little to do with
11590 which binding of this variable is active at any given moment. If you
11591 need set or get the binding on a specific display, use
11592 `terminal-local-value' and `set-terminal-local-value'. */);
11594 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
11595 doc
: /* The parent keymap of all `local-key-translation-map' instances.
11596 Key translations that apply to all display devices should go here. */);
11597 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11599 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11600 doc
: /* List of deferred actions to be performed at a later time.
11601 The precise format isn't relevant here; we just check whether it is nil. */);
11602 Vdeferred_action_list
= Qnil
;
11604 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11605 doc
: /* Function to call to handle deferred actions, after each command.
11606 This function is called with no arguments after each command
11607 whenever `deferred-action-list' is non-nil. */);
11608 Vdeferred_action_function
= Qnil
;
11610 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11611 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11612 The value can be a length of time to show the message for.
11613 If the value is non-nil and not a number, we wait 2 seconds. */);
11614 Vsuggest_key_bindings
= Qt
;
11616 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11617 doc
: /* List of active absolute time timers in order of increasing time. */);
11618 Vtimer_list
= Qnil
;
11620 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11621 doc
: /* List of active idle-time timers in order of increasing time. */);
11622 Vtimer_idle_list
= Qnil
;
11624 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11625 doc
: /* If non-nil, the function that implements the current input method.
11626 It's called with one argument, a printing character that was just read.
11627 \(That means a character with code 040...0176.)
11628 Typically this function uses `read-event' to read additional events.
11629 When it does so, it should first bind `input-method-function' to nil
11630 so it will not be called recursively.
11632 The function should return a list of zero or more events
11633 to be used as input. If it wants to put back some events
11634 to be reconsidered, separately, by the input method,
11635 it can add them to the beginning of `unread-command-events'.
11637 The input method function can find in `input-method-previous-method'
11638 the previous echo area message.
11640 The input method function should refer to the variables
11641 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11642 for guidance on what to do. */);
11643 Vinput_method_function
= Qnil
;
11645 DEFVAR_LISP ("input-method-previous-message",
11646 &Vinput_method_previous_message
,
11647 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11648 This variable exists because `read-event' clears the echo area
11649 before running the input method. It is nil if there was no message. */);
11650 Vinput_method_previous_message
= Qnil
;
11652 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11653 doc
: /* If non-nil, the function that implements the display of help.
11654 It's called with one argument, the help string to display. */);
11655 Vshow_help_function
= Qnil
;
11657 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11658 doc
: /* If non-nil, suppress point adjustment after executing a command.
11660 After a command is executed, if point is moved into a region that has
11661 special properties (e.g. composition, display), we adjust point to
11662 the boundary of the region. But, when a command sets this variable to
11663 non-nil, we suppress the point adjustment.
11665 This variable is set to nil before reading a command, and is checked
11666 just after executing the command. */);
11667 Vdisable_point_adjustment
= Qnil
;
11669 DEFVAR_LISP ("global-disable-point-adjustment",
11670 &Vglobal_disable_point_adjustment
,
11671 doc
: /* *If non-nil, always suppress point adjustment.
11673 The default value is nil, in which case, point adjustment are
11674 suppressed only after special commands that set
11675 `disable-point-adjustment' (which see) to non-nil. */);
11676 Vglobal_disable_point_adjustment
= Qnil
;
11678 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11679 doc
: /* Non-nil means updating menu bindings is allowed.
11680 A value of nil means menu bindings should not be updated.
11681 Used during Emacs' startup. */);
11682 update_menu_bindings
= 1;
11684 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11685 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11686 If the value is not a number, such messages don't time out. */);
11687 Vminibuffer_message_timeout
= make_number (2);
11689 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11690 doc
: /* If non-nil, any keyboard input throws to this symbol.
11691 The value of that variable is passed to `quit-flag' and later causes a
11692 peculiar kind of quitting. */);
11693 Vthrow_on_input
= Qnil
;
11697 keys_of_keyboard ()
11699 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11700 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11701 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11702 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11703 initial_define_key (meta_map
, 'x', "execute-extended-command");
11705 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11706 "handle-delete-frame");
11707 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11708 current-prefix-arg, as is done in `handle-switch-frame'.
11709 But `handle-switch-frame is not run from the special-map.
11710 Commands from that map are run in a special way that automatically
11711 preserves the prefix-arg. Restoring the prefix arg here is not just
11712 redundant but harmful:
11714 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11715 - after the first prompt, the exit-minibuffer-hook is run which may
11716 iconify a frame and thus push a `iconify-frame' event.
11717 - after running exit-minibuffer-hook, current-prefix-arg is
11718 restored to the non-nil value it had before the prompt.
11719 - we enter the second prompt.
11720 current-prefix-arg is non-nil, prefix-arg is nil.
11721 - before running the first real event, we run the special iconify-frame
11722 event, but we pass the `special' arg to execute-command so
11723 current-prefix-arg and prefix-arg are left untouched.
11724 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11725 - the next key event will have a spuriously non-nil current-prefix-arg. */
11726 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11728 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11730 /* Handling it at such a low-level causes read_key_sequence to get
11731 * confused because it doesn't realize that the current_buffer was
11732 * changed by read_char.
11734 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11735 * "handle-select-window"); */
11736 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11737 "handle-save-session");
11740 /* Mark the pointers in the kboard objects.
11741 Called by the Fgarbage_collector. */
11747 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11749 if (kb
->kbd_macro_buffer
)
11750 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11752 mark_object (kb
->Voverriding_terminal_local_map
);
11753 mark_object (kb
->Vlast_command
);
11754 mark_object (kb
->Vreal_last_command
);
11755 mark_object (kb
->Vprefix_arg
);
11756 mark_object (kb
->Vlast_prefix_arg
);
11757 mark_object (kb
->kbd_queue
);
11758 mark_object (kb
->defining_kbd_macro
);
11759 mark_object (kb
->Vlast_kbd_macro
);
11760 mark_object (kb
->Vsystem_key_alist
);
11761 mark_object (kb
->system_key_syms
);
11762 mark_object (kb
->Vlocal_function_key_map
);
11763 mark_object (kb
->Vlocal_key_translation_map
);
11764 mark_object (kb
->Vdefault_minibuffer_frame
);
11765 mark_object (kb
->echo_string
);
11768 struct input_event
*event
;
11769 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11771 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11772 event
= kbd_buffer
;
11773 if (event
->kind
!= SELECTION_REQUEST_EVENT
11774 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11776 mark_object (event
->x
);
11777 mark_object (event
->y
);
11779 mark_object (event
->frame_or_window
);
11780 mark_object (event
->arg
);
11785 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11786 (do not change this comment) */