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 /* If non-nil, this implements the current input method. */
419 Lisp_Object Vinput_method_function
;
420 Lisp_Object Qinput_method_function
;
422 /* When we call Vinput_method_function,
423 this holds the echo area message that was just erased. */
424 Lisp_Object Vinput_method_previous_message
;
426 /* Non-nil means deactivate the mark at end of this command. */
427 Lisp_Object Vdeactivate_mark
;
429 /* Menu bar specified in Lucid Emacs fashion. */
431 Lisp_Object Vlucid_menu_bar_dirty_flag
;
432 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
434 Lisp_Object Qecho_area_clear_hook
;
436 /* Hooks to run before and after each command. */
437 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
438 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
439 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
441 /* Parent keymap of terminal-local function-key-map instances. */
442 Lisp_Object Vfunction_key_map
;
444 /* Parent keymap of terminal-local key-translation-map instances. */
445 Lisp_Object Vkey_translation_map
;
447 /* List of deferred actions to be performed at a later time.
448 The precise format isn't relevant here; we just check whether it is nil. */
449 Lisp_Object Vdeferred_action_list
;
451 /* Function to call to handle deferred actions, when there are any. */
452 Lisp_Object Vdeferred_action_function
;
453 Lisp_Object Qdeferred_action_function
;
455 Lisp_Object Qinput_method_exit_on_first_char
;
456 Lisp_Object Qinput_method_use_echo_area
;
458 /* File in which we write all commands we read. */
461 /* Nonzero if input is available. */
464 extern char *pending_malloc_warning
;
466 /* Circular buffer for pre-read keyboard input. */
468 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
470 /* Pointer to next available character in kbd_buffer.
471 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
472 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
473 next available char is in kbd_buffer[0]. */
474 static struct input_event
*kbd_fetch_ptr
;
476 /* Pointer to next place to store character in kbd_buffer. This
477 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
478 character should go in kbd_buffer[0]. */
479 static struct input_event
* volatile kbd_store_ptr
;
481 /* The above pair of variables forms a "queue empty" flag. When we
482 enqueue a non-hook event, we increment kbd_store_ptr. When we
483 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
484 there is input available iff the two pointers are not equal.
486 Why not just have a flag set and cleared by the enqueuing and
487 dequeuing functions? Such a flag could be screwed up by interrupts
488 at inopportune times. */
490 /* If this flag is non-nil, we check mouse_moved to see when the
491 mouse moves, and motion events will appear in the input stream.
492 Otherwise, mouse motion is ignored. */
493 Lisp_Object do_mouse_tracking
;
495 /* Symbols to head events. */
496 Lisp_Object Qmouse_movement
;
497 Lisp_Object Qscroll_bar_movement
;
498 Lisp_Object Qswitch_frame
;
499 Lisp_Object Qdelete_frame
;
500 Lisp_Object Qiconify_frame
;
501 Lisp_Object Qmake_frame_visible
;
502 Lisp_Object Qselect_window
;
503 Lisp_Object Qhelp_echo
;
506 Lisp_Object Qmouse_fixup_help_message
;
509 /* Symbols to denote kinds of events. */
510 Lisp_Object Qfunction_key
;
511 Lisp_Object Qmouse_click
;
512 #if defined (WINDOWSNT) || defined (MAC_OS)
513 Lisp_Object Qlanguage_change
;
515 Lisp_Object Qdrag_n_drop
;
516 Lisp_Object Qsave_session
;
518 Lisp_Object Qmac_apple_event
;
521 /* Lisp_Object Qmouse_movement; - also an event header */
523 /* Properties of event headers. */
524 Lisp_Object Qevent_kind
;
525 Lisp_Object Qevent_symbol_elements
;
527 /* menu item parts */
528 Lisp_Object Qmenu_alias
;
529 Lisp_Object Qmenu_enable
;
530 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
531 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
532 extern Lisp_Object Vdefine_key_rebound_commands
;
533 extern Lisp_Object Qmenu_item
;
535 /* An event header symbol HEAD may have a property named
536 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
537 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
538 mask of modifiers applied to it. If present, this is used to help
539 speed up parse_modifiers. */
540 Lisp_Object Qevent_symbol_element_mask
;
542 /* An unmodified event header BASE may have a property named
543 Qmodifier_cache, which is an alist mapping modifier masks onto
544 modified versions of BASE. If present, this helps speed up
546 Lisp_Object Qmodifier_cache
;
548 /* Symbols to use for parts of windows. */
549 Lisp_Object Qmode_line
;
550 Lisp_Object Qvertical_line
;
551 Lisp_Object Qvertical_scroll_bar
;
552 Lisp_Object Qmenu_bar
;
553 extern Lisp_Object Qleft_margin
, Qright_margin
;
554 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
555 extern Lisp_Object QCmap
;
557 Lisp_Object
recursive_edit_unwind (), command_loop ();
558 Lisp_Object
Fthis_command_keys ();
559 Lisp_Object Qextended_command_history
;
560 EMACS_TIME
timer_check ();
562 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
564 extern char *x_get_keysym_name ();
566 static void record_menu_key ();
567 static int echo_length ();
569 Lisp_Object Qpolling_period
;
571 /* List of absolute timers. Appears in order of next scheduled event. */
572 Lisp_Object Vtimer_list
;
574 /* List of idle time timers. Appears in order of next scheduled event. */
575 Lisp_Object Vtimer_idle_list
;
577 /* Incremented whenever a timer is run. */
580 extern Lisp_Object Vprint_level
, Vprint_length
;
582 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
584 EMACS_TIME
*input_available_clear_time
;
586 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
587 Default is 1 if INTERRUPT_INPUT is defined. */
590 /* Nonzero while interrupts are temporarily deferred during redisplay. */
591 int interrupts_deferred
;
593 /* Allow m- file to inhibit use of FIONREAD. */
594 #ifdef BROKEN_FIONREAD
598 /* We are unable to use interrupts if FIONREAD is not available,
599 so flush SIGIO so we won't try. */
600 #if !defined (FIONREAD)
606 /* If we support a window system, turn on the code to poll periodically
607 to detect C-g. It isn't actually used when doing interrupt input. */
608 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
609 #define POLL_FOR_INPUT
612 /* After a command is executed, if point is moved into a region that
613 has specific properties (e.g. composition, display), we adjust
614 point to the boundary of the region. But, if a command sets this
615 variable to non-nil, we suppress this point adjustment. This
616 variable is set to nil before reading a command. */
618 Lisp_Object Vdisable_point_adjustment
;
620 /* If non-nil, always disable point adjustment. */
622 Lisp_Object Vglobal_disable_point_adjustment
;
624 /* The time when Emacs started being idle. */
626 static EMACS_TIME timer_idleness_start_time
;
628 /* After Emacs stops being idle, this saves the last value
629 of timer_idleness_start_time from when it was idle. */
631 static EMACS_TIME timer_last_idleness_start_time
;
634 /* Global variable declarations. */
636 /* Flags for readable_events. */
637 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
638 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
639 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
641 /* Function for init_keyboard to call with no args (if nonzero). */
642 void (*keyboard_init_hook
) ();
644 static int read_avail_input
P_ ((int));
645 static void get_input_pending
P_ ((int *, int));
646 static int readable_events
P_ ((int));
647 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
648 Lisp_Object
, int *));
649 static Lisp_Object
read_char_x_menu_prompt ();
650 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
652 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
654 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
655 enum scroll_bar_part
,
656 Lisp_Object
, Lisp_Object
,
659 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
660 Lisp_Object
, char **,
661 Lisp_Object
*, unsigned));
662 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
663 static int parse_solitary_modifier
P_ ((Lisp_Object
));
664 static int parse_solitary_modifier ();
665 static void save_getcjmp
P_ ((jmp_buf));
666 static void save_getcjmp ();
667 static void restore_getcjmp
P_ ((jmp_buf));
668 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
669 static void clear_event
P_ ((struct input_event
*));
670 static void any_kboard_state
P_ ((void));
671 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
672 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
673 static void handle_interrupt
P_ ((void));
674 static void timer_start_idle
P_ ((void));
675 static void timer_stop_idle
P_ ((void));
676 static void timer_resume_idle
P_ ((void));
678 /* Nonzero means don't try to suspend even if the operating system seems
680 static int cannot_suspend
;
682 extern Lisp_Object Qidentity
, Qonly
;
684 /* Install the string STR as the beginning of the string of echoing,
685 so that it serves as a prompt for the next character.
686 Also start echoing. */
692 current_kboard
->echo_string
= str
;
693 current_kboard
->echo_after_prompt
= SCHARS (str
);
697 /* Add C to the echo string, if echoing is going on.
698 C can be a character, which is printed prettily ("M-C-x" and all that
699 jazz), or a symbol, whose name is printed. */
705 if (current_kboard
->immediate_echo
)
707 int size
= KEY_DESCRIPTION_SIZE
+ 100;
708 char *buffer
= (char *) alloca (size
);
710 Lisp_Object echo_string
;
712 echo_string
= current_kboard
->echo_string
;
714 /* If someone has passed us a composite event, use its head symbol. */
719 ptr
= push_key_description (XINT (c
), ptr
, 1);
721 else if (SYMBOLP (c
))
723 Lisp_Object name
= SYMBOL_NAME (c
);
724 int nbytes
= SBYTES (name
);
726 if (size
- (ptr
- buffer
) < nbytes
)
728 int offset
= ptr
- buffer
;
729 size
= max (2 * size
, size
+ nbytes
);
730 buffer
= (char *) alloca (size
);
731 ptr
= buffer
+ offset
;
734 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
735 STRING_MULTIBYTE (name
), 1);
738 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
741 const char *text
= " (Type ? for further options)";
742 int len
= strlen (text
);
744 if (size
- (ptr
- buffer
) < len
)
746 int offset
= ptr
- buffer
;
748 buffer
= (char *) alloca (size
);
749 ptr
= buffer
+ offset
;
752 bcopy (text
, ptr
, len
);
756 /* Replace a dash from echo_dash with a space, otherwise
757 add a space at the end as a separator between keys. */
758 if (STRINGP (echo_string
)
759 && SCHARS (echo_string
) > 1)
761 Lisp_Object last_char
, prev_char
, idx
;
763 idx
= make_number (SCHARS (echo_string
) - 2);
764 prev_char
= Faref (echo_string
, idx
);
766 idx
= make_number (SCHARS (echo_string
) - 1);
767 last_char
= Faref (echo_string
, idx
);
769 /* We test PREV_CHAR to make sure this isn't the echoing
771 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
772 Faset (echo_string
, idx
, make_number (' '));
774 echo_string
= concat2 (echo_string
, build_string (" "));
777 current_kboard
->echo_string
778 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
784 /* Temporarily add a dash to the end of the echo string if it's not
785 empty, so that it serves as a mini-prompt for the very next character. */
790 /* Do nothing if not echoing at all. */
791 if (NILP (current_kboard
->echo_string
))
794 if (!current_kboard
->immediate_echo
795 && SCHARS (current_kboard
->echo_string
) == 0)
798 /* Do nothing if we just printed a prompt. */
799 if (current_kboard
->echo_after_prompt
800 == SCHARS (current_kboard
->echo_string
))
803 /* Do nothing if we have already put a dash at the end. */
804 if (SCHARS (current_kboard
->echo_string
) > 1)
806 Lisp_Object last_char
, prev_char
, idx
;
808 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
809 prev_char
= Faref (current_kboard
->echo_string
, idx
);
811 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
812 last_char
= Faref (current_kboard
->echo_string
, idx
);
814 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
818 /* Put a dash at the end of the buffer temporarily,
819 but make it go away when the next character is added. */
820 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
825 /* Display the current echo string, and begin echoing if not already
831 if (!current_kboard
->immediate_echo
)
834 current_kboard
->immediate_echo
= 1;
836 for (i
= 0; i
< this_command_key_count
; i
++)
840 /* Set before_command_echo_length to the value that would
841 have been saved before the start of this subcommand in
842 command_loop_1, if we had already been echoing then. */
843 if (i
== this_single_command_key_start
)
844 before_command_echo_length
= echo_length ();
846 c
= XVECTOR (this_command_keys
)->contents
[i
];
847 if (! (EVENT_HAS_PARAMETERS (c
)
848 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
852 /* Set before_command_echo_length to the value that would
853 have been saved before the start of this subcommand in
854 command_loop_1, if we had already been echoing then. */
855 if (this_command_key_count
== this_single_command_key_start
)
856 before_command_echo_length
= echo_length ();
858 /* Put a dash at the end to invite the user to type more. */
863 message3_nolog (current_kboard
->echo_string
,
864 SBYTES (current_kboard
->echo_string
),
865 STRING_MULTIBYTE (current_kboard
->echo_string
));
868 /* Record in what buffer we echoed, and from which kboard. */
869 echo_message_buffer
= echo_area_buffer
[0];
870 echo_kboard
= current_kboard
;
872 if (waiting_for_input
&& !NILP (Vquit_flag
))
873 quit_throw_to_read_char ();
876 /* Turn off echoing, for the start of a new command. */
881 current_kboard
->immediate_echo
= 0;
882 current_kboard
->echo_after_prompt
= -1;
883 current_kboard
->echo_string
= Qnil
;
884 ok_to_echo_at_next_pause
= NULL
;
886 echo_message_buffer
= Qnil
;
889 /* Return the length of the current echo string. */
894 return (STRINGP (current_kboard
->echo_string
)
895 ? SCHARS (current_kboard
->echo_string
)
899 /* Truncate the current echo message to its first LEN chars.
900 This and echo_char get used by read_key_sequence when the user
901 switches frames while entering a key sequence. */
904 echo_truncate (nchars
)
907 if (STRINGP (current_kboard
->echo_string
))
908 current_kboard
->echo_string
909 = Fsubstring (current_kboard
->echo_string
,
910 make_number (0), make_number (nchars
));
911 truncate_echo_area (nchars
);
915 /* Functions for manipulating this_command_keys. */
917 add_command_key (key
)
920 #if 0 /* Not needed after we made Freset_this_command_lengths
921 do the job immediately. */
922 /* If reset-this-command-length was called recently, obey it now.
923 See the doc string of that function for an explanation of why. */
924 if (before_command_restore_flag
)
926 this_command_key_count
= before_command_key_count_1
;
927 if (this_command_key_count
< this_single_command_key_start
)
928 this_single_command_key_start
= this_command_key_count
;
929 echo_truncate (before_command_echo_length_1
);
930 before_command_restore_flag
= 0;
934 if (this_command_key_count
>= ASIZE (this_command_keys
))
935 this_command_keys
= larger_vector (this_command_keys
,
936 2 * ASIZE (this_command_keys
),
939 AREF (this_command_keys
, this_command_key_count
) = key
;
940 ++this_command_key_count
;
947 int count
= SPECPDL_INDEX ();
950 if (command_loop_level
> 0)
952 specbind (Qstandard_output
, Qt
);
953 specbind (Qstandard_input
, Qt
);
956 #ifdef HAVE_X_WINDOWS
957 /* The command loop has started an hourglass timer, so we have to
958 cancel it here, otherwise it will fire because the recursive edit
959 can take some time. Do not check for display_hourglass_p here,
960 because it could already be nil. */
964 /* This function may have been called from a debugger called from
965 within redisplay, for instance by Edebugging a function called
966 from fontification-functions. We want to allow redisplay in
967 the debugging session.
969 The recursive edit is left with a `(throw exit ...)'. The `exit'
970 tag is not caught anywhere in redisplay, i.e. when we leave the
971 recursive edit, the original redisplay leading to the recursive
972 edit will be unwound. The outcome should therefore be safe. */
973 specbind (Qinhibit_redisplay
, Qnil
);
976 val
= command_loop ();
978 Fsignal (Qquit
, Qnil
);
979 /* Handle throw from read_minibuf when using minibuffer
980 while it's active but we're in another window. */
982 Fsignal (Qerror
, Fcons (val
, Qnil
));
984 return unbind_to (count
, Qnil
);
987 /* When an auto-save happens, record the "time", and don't do again soon. */
992 last_auto_save
= num_nonmacro_input_events
;
995 /* Make an auto save happen as soon as possible at command level. */
998 force_auto_save_soon ()
1000 last_auto_save
= - auto_save_interval
- 1;
1002 record_asynch_buffer_change ();
1005 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1006 doc
: /* Invoke the editor command loop recursively.
1007 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1008 that tells this function to return.
1009 Alternatively, `(throw 'exit t)' makes this function signal an error.
1010 This function is called by the editor initialization to begin editing. */)
1013 int count
= SPECPDL_INDEX ();
1016 /* If we enter while input is blocked, don't lock up here.
1017 This may happen through the debugger during redisplay. */
1018 if (INPUT_BLOCKED_P
)
1021 command_loop_level
++;
1022 update_mode_lines
= 1;
1024 if (command_loop_level
1025 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1026 buffer
= Fcurrent_buffer ();
1030 /* If we leave recursive_edit_1 below with a `throw' for instance,
1031 like it is done in the splash screen display, we have to
1032 make sure that we restore single_kboard as command_loop_1
1033 would have done if it were left normally. */
1034 temporarily_switch_to_single_kboard (FRAME_KBOARD (SELECTED_FRAME ()));
1035 record_unwind_protect (recursive_edit_unwind
, buffer
);
1037 recursive_edit_1 ();
1038 return unbind_to (count
, Qnil
);
1042 recursive_edit_unwind (buffer
)
1045 if (BUFFERP (buffer
))
1046 Fset_buffer (buffer
);
1048 command_loop_level
--;
1049 update_mode_lines
= 1;
1058 #if 0 /* Theory: if there's anything in Vunread_command_events,
1059 it will right away be read by read_key_sequence,
1060 and then if we do switch KBOARDS, it will go into the side
1061 queue then. So we don't need to do anything special here -- rms. */
1062 if (CONSP (Vunread_command_events
))
1064 current_kboard
->kbd_queue
1065 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1066 current_kboard
->kbd_queue_has_data
= 1;
1068 Vunread_command_events
= Qnil
;
1074 /* Switch to the single-kboard state, making current_kboard
1075 the only KBOARD from which further input is accepted. */
1078 single_kboard_state ()
1085 /* If we're in single_kboard state for kboard KBOARD,
1089 not_single_kboard_state (kboard
)
1093 if (kboard
== current_kboard
)
1098 /* Maintain a stack of kboards, so other parts of Emacs
1099 can switch temporarily to the kboard of a given frame
1100 and then revert to the previous status. */
1105 struct kboard_stack
*next
;
1108 static struct kboard_stack
*kboard_stack
;
1115 struct kboard_stack
*p
1116 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1118 p
->next
= kboard_stack
;
1119 p
->kboard
= current_kboard
;
1127 push_frame_kboard (f
)
1130 push_kboard (f
->device
->kboard
);
1138 struct kboard_stack
*p
= kboard_stack
;
1139 current_kboard
= NULL
;
1140 for (d
= device_list
; d
; d
= d
->next_device
)
1142 if (d
->kboard
== p
->kboard
)
1144 current_kboard
= p
->kboard
;
1148 if (current_kboard
== NULL
)
1150 /* The display we remembered has been deleted. */
1151 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1153 kboard_stack
= p
->next
;
1158 /* Switch to single_kboard mode. If K is non-nil, set it as the
1159 current keyboard. Use record_unwind_protect to return to the
1160 previous state later. */
1163 temporarily_switch_to_single_kboard (k
)
1167 int was_locked
= single_kboard
;
1171 push_kboard (current_kboard
);
1172 single_kboard_state ();
1173 record_unwind_protect (restore_kboard_configuration
,
1174 (was_locked
? Qt
: Qnil
));
1179 record_single_kboard_state ()
1181 push_kboard (current_kboard
);
1182 record_unwind_protect (restore_kboard_configuration
,
1183 (single_kboard
? Qt
: Qnil
));
1187 restore_kboard_configuration (was_locked
)
1188 Lisp_Object was_locked
;
1190 if (NILP (was_locked
))
1191 any_kboard_state ();
1193 single_kboard_state ();
1198 /* Handle errors that are not handled at inner levels
1199 by printing an error message and returning to the editor command loop. */
1205 Lisp_Object old_level
, old_length
;
1206 char macroerror
[50];
1208 #ifdef HAVE_X_WINDOWS
1209 if (display_hourglass_p
)
1210 cancel_hourglass ();
1213 if (!NILP (executing_kbd_macro
))
1215 if (executing_kbd_macro_iterations
== 1)
1216 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1218 sprintf (macroerror
, "After %d kbd macro iterations: ",
1219 executing_kbd_macro_iterations
);
1224 Vstandard_output
= Qt
;
1225 Vstandard_input
= Qt
;
1226 Vexecuting_kbd_macro
= Qnil
;
1227 executing_kbd_macro
= Qnil
;
1228 current_kboard
->Vprefix_arg
= Qnil
;
1229 current_kboard
->Vlast_prefix_arg
= Qnil
;
1232 /* Avoid unquittable loop if data contains a circular list. */
1233 old_level
= Vprint_level
;
1234 old_length
= Vprint_length
;
1235 XSETFASTINT (Vprint_level
, 10);
1236 XSETFASTINT (Vprint_length
, 10);
1237 cmd_error_internal (data
, macroerror
);
1238 Vprint_level
= old_level
;
1239 Vprint_length
= old_length
;
1243 Vinhibit_quit
= Qnil
;
1245 if (command_loop_level
== 0 && minibuf_level
== 0)
1246 any_kboard_state ();
1249 return make_number (0);
1252 /* Take actions on handling an error. DATA is the data that describes
1255 CONTEXT is a C-string containing ASCII characters only which
1256 describes the context in which the error happened. If we need to
1257 generalize CONTEXT to allow multibyte characters, make it a Lisp
1261 cmd_error_internal (data
, context
)
1266 int kill_emacs_p
= 0;
1267 struct frame
*sf
= SELECTED_FRAME ();
1271 clear_message (1, 0);
1273 /* If the window system or terminal frame hasn't been initialized
1274 yet, or we're not interactive, it's best to dump this message out
1275 to stderr and exit. */
1276 if (!sf
->glyphs_initialized_p
1277 || FRAME_INITIAL_P (sf
)
1280 stream
= Qexternal_debugging_output
;
1286 message_log_maybe_newline ();
1291 /* The immediate context is not interesting for Quits,
1292 since they are asyncronous. */
1293 if (EQ (XCAR (data
), Qquit
))
1294 Vsignaling_function
= Qnil
;
1296 print_error_message (data
, stream
, context
, Vsignaling_function
);
1298 Vsignaling_function
= Qnil
;
1300 /* If the window system or terminal frame hasn't been initialized
1301 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1305 Fkill_emacs (make_number (-1));
1309 Lisp_Object
command_loop_1 ();
1310 Lisp_Object
command_loop_2 ();
1311 Lisp_Object
top_level_1 ();
1313 /* Entry to editor-command-loop.
1314 This level has the catches for exiting/returning to editor command loop.
1315 It returns nil to exit recursive edit, t to abort it. */
1320 if (command_loop_level
> 0 || minibuf_level
> 0)
1323 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1324 executing_kbd_macro
= Qnil
;
1330 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1331 /* Reset single_kboard in case top-level set it while
1332 evaluating an -f option, or we are stuck there for some
1334 any_kboard_state ();
1335 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1336 executing_kbd_macro
= Qnil
;
1338 /* End of file in -batch run causes exit here. */
1344 /* Here we catch errors in execution of commands within the
1345 editing loop, and reenter the editing loop.
1346 When there is an error, cmd_error runs and returns a non-nil
1347 value to us. A value of nil means that command_loop_1 itself
1348 returned due to end of file (or end of kbd macro). */
1353 register Lisp_Object val
;
1356 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1357 while (!NILP (val
));
1365 return Feval (Vtop_level
);
1371 /* On entry to the outer level, run the startup file */
1372 if (!NILP (Vtop_level
))
1373 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1374 else if (!NILP (Vpurify_flag
))
1375 message ("Bare impure Emacs (standard Lisp code not loaded)");
1377 message ("Bare Emacs (standard Lisp code not loaded)");
1381 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1382 doc
: /* Exit all recursive editing levels. */)
1385 #ifdef HAVE_X_WINDOWS
1386 if (display_hourglass_p
)
1387 cancel_hourglass ();
1390 /* Unblock input if we enter with input blocked. This may happen if
1391 redisplay traps e.g. during tool-bar update with input blocked. */
1392 while (INPUT_BLOCKED_P
)
1395 return Fthrow (Qtop_level
, Qnil
);
1398 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1399 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1402 if (command_loop_level
> 0 || minibuf_level
> 0)
1403 Fthrow (Qexit
, Qnil
);
1405 error ("No recursive edit is in progress");
1409 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1410 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1413 if (command_loop_level
> 0 || minibuf_level
> 0)
1416 error ("No recursive edit is in progress");
1420 /* This is the actual command reading loop,
1421 sans error-handling encapsulation. */
1423 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1425 void safe_run_hooks
P_ ((Lisp_Object
));
1426 static void adjust_point_for_property
P_ ((int, int));
1428 /* Cancel hourglass from protect_unwind.
1430 #ifdef HAVE_X_WINDOWS
1432 cancel_hourglass_unwind (arg
)
1435 cancel_hourglass ();
1446 Lisp_Object keybuf
[30];
1449 int prev_modiff
= 0;
1450 struct buffer
*prev_buffer
= NULL
;
1452 int was_locked
= single_kboard
;
1454 int already_adjusted
= 0;
1456 current_kboard
->Vprefix_arg
= Qnil
;
1457 current_kboard
->Vlast_prefix_arg
= Qnil
;
1458 Vdeactivate_mark
= Qnil
;
1459 waiting_for_input
= 0;
1463 this_command_key_count
= 0;
1464 this_command_key_count_reset
= 0;
1465 this_single_command_key_start
= 0;
1467 if (NILP (Vmemory_full
))
1469 /* Make sure this hook runs after commands that get errors and
1470 throw to top level. */
1471 /* Note that the value cell will never directly contain nil
1472 if the symbol is a local variable. */
1473 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1474 safe_run_hooks (Qpost_command_hook
);
1476 /* If displaying a message, resize the echo area window to fit
1477 that message's size exactly. */
1478 if (!NILP (echo_area_buffer
[0]))
1479 resize_echo_area_exactly ();
1481 if (!NILP (Vdeferred_action_list
))
1482 safe_run_hooks (Qdeferred_action_function
);
1485 /* Do this after running Vpost_command_hook, for consistency. */
1486 current_kboard
->Vlast_command
= Vthis_command
;
1487 current_kboard
->Vreal_last_command
= real_this_command
;
1491 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1494 /* Make sure the current window's buffer is selected. */
1495 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1496 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1498 /* Display any malloc warning that just came out. Use while because
1499 displaying one warning can cause another. */
1501 while (pending_malloc_warning
)
1502 display_malloc_warning ();
1506 Vdeactivate_mark
= Qnil
;
1508 /* If minibuffer on and echo area in use,
1509 wait a short time and redraw minibuffer. */
1512 && !NILP (echo_area_buffer
[0])
1513 && EQ (minibuf_window
, echo_area_window
)
1514 && NUMBERP (Vminibuffer_message_timeout
))
1516 /* Bind inhibit-quit to t so that C-g gets read in
1517 rather than quitting back to the minibuffer. */
1518 int count
= SPECPDL_INDEX ();
1519 specbind (Qinhibit_quit
, Qt
);
1521 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1522 /* Clear the echo area. */
1524 safe_run_hooks (Qecho_area_clear_hook
);
1526 unbind_to (count
, Qnil
);
1528 /* If a C-g came in before, treat it as input now. */
1529 if (!NILP (Vquit_flag
))
1532 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1537 alloca (0); /* Cause a garbage collection now */
1538 /* Since we can free the most stuff here. */
1539 #endif /* C_ALLOCA */
1542 /* Select the frame that the last event came from. Usually,
1543 switch-frame events will take care of this, but if some lisp
1544 code swallows a switch-frame event, we'll fix things up here.
1545 Is this a good idea? */
1546 if (FRAMEP (internal_last_event_frame
)
1547 && !EQ (internal_last_event_frame
, selected_frame
))
1548 Fselect_frame (internal_last_event_frame
);
1550 /* If it has changed current-menubar from previous value,
1551 really recompute the menubar from the value. */
1552 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1553 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1554 call0 (Qrecompute_lucid_menubar
);
1556 before_command_key_count
= this_command_key_count
;
1557 before_command_echo_length
= echo_length ();
1559 Vthis_command
= Qnil
;
1560 real_this_command
= Qnil
;
1561 Vthis_original_command
= Qnil
;
1563 /* Read next key sequence; i gets its length. */
1564 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1567 /* A filter may have run while we were reading the input. */
1568 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1570 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1571 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1575 /* Now we have read a key sequence of length I,
1576 or else I is 0 and we found end of file. */
1578 if (i
== 0) /* End of file -- happens only in */
1579 return Qnil
; /* a kbd macro, at the end. */
1580 /* -1 means read_key_sequence got a menu that was rejected.
1581 Just loop around and read another command. */
1585 this_command_key_count
= 0;
1586 this_command_key_count_reset
= 0;
1587 this_single_command_key_start
= 0;
1591 last_command_char
= keybuf
[i
- 1];
1593 /* If the previous command tried to force a specific window-start,
1594 forget about that, in case this command moves point far away
1595 from that position. But also throw away beg_unchanged and
1596 end_unchanged information in that case, so that redisplay will
1597 update the whole window properly. */
1598 if (!NILP (XWINDOW (selected_window
)->force_start
))
1601 XWINDOW (selected_window
)->force_start
= Qnil
;
1602 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1603 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1606 cmd
= read_key_sequence_cmd
;
1607 if (!NILP (Vexecuting_kbd_macro
))
1609 if (!NILP (Vquit_flag
))
1611 Vexecuting_kbd_macro
= Qt
;
1612 QUIT
; /* Make some noise. */
1613 /* Will return since macro now empty. */
1617 /* Do redisplay processing after this command except in special
1618 cases identified below. */
1619 prev_buffer
= current_buffer
;
1620 prev_modiff
= MODIFF
;
1621 last_point_position
= PT
;
1622 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1624 /* By default, we adjust point to a boundary of a region that
1625 has such a property that should be treated intangible
1626 (e.g. composition, display). But, some commands will set
1627 this variable differently. */
1628 Vdisable_point_adjustment
= Qnil
;
1630 /* Process filters and timers may have messed with deactivate-mark.
1631 reset it before we execute the command. */
1632 Vdeactivate_mark
= Qnil
;
1634 /* Remap command through active keymaps */
1635 Vthis_original_command
= cmd
;
1639 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1643 /* Execute the command. */
1645 Vthis_command
= cmd
;
1646 real_this_command
= cmd
;
1647 /* Note that the value cell will never directly contain nil
1648 if the symbol is a local variable. */
1649 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1650 safe_run_hooks (Qpre_command_hook
);
1652 already_adjusted
= 0;
1654 if (NILP (Vthis_command
))
1656 /* nil means key is undefined. */
1657 Lisp_Object keys
= Fvector (i
, keybuf
);
1658 keys
= Fkey_description (keys
, Qnil
);
1660 message_with_string ("%s is undefined", keys
, 0);
1661 current_kboard
->defining_kbd_macro
= Qnil
;
1662 update_mode_lines
= 1;
1663 current_kboard
->Vprefix_arg
= Qnil
;
1667 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1669 /* In case we jump to directly_done. */
1670 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1672 /* Recognize some common commands in common situations and
1673 do them directly. */
1674 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1676 struct Lisp_Char_Table
*dp
1677 = window_display_table (XWINDOW (selected_window
));
1678 lose
= FETCH_CHAR (PT_BYTE
);
1680 if (! NILP (Vpost_command_hook
))
1681 /* Put this before calling adjust_point_for_property
1682 so it will only get called once in any case. */
1684 if (current_buffer
== prev_buffer
1685 && last_point_position
!= PT
1686 && NILP (Vdisable_point_adjustment
)
1687 && NILP (Vglobal_disable_point_adjustment
))
1688 adjust_point_for_property (last_point_position
, 0);
1689 already_adjusted
= 1;
1690 if (PT
== last_point_position
+ 1
1692 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1693 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1694 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1695 && (lose
>= 0x20 && lose
< 0x7f)))
1696 : (lose
>= 0x20 && lose
< 0x7f))
1697 /* To extract the case of continuation on
1698 wide-column characters. */
1699 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1700 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1702 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1704 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1706 && !windows_or_buffers_changed
1707 && EQ (current_buffer
->selective_display
, Qnil
)
1708 && !detect_input_pending ()
1709 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1710 && NILP (Vexecuting_kbd_macro
))
1711 direct_output_forward_char (1);
1714 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1716 struct Lisp_Char_Table
*dp
1717 = window_display_table (XWINDOW (selected_window
));
1719 lose
= FETCH_CHAR (PT_BYTE
);
1720 if (! NILP (Vpost_command_hook
))
1722 if (current_buffer
== prev_buffer
1723 && last_point_position
!= PT
1724 && NILP (Vdisable_point_adjustment
)
1725 && NILP (Vglobal_disable_point_adjustment
))
1726 adjust_point_for_property (last_point_position
, 0);
1727 already_adjusted
= 1;
1728 if (PT
== last_point_position
- 1
1730 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1731 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1732 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1733 && (lose
>= 0x20 && lose
< 0x7f)))
1734 : (lose
>= 0x20 && lose
< 0x7f))
1735 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1737 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1739 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1741 && !windows_or_buffers_changed
1742 && EQ (current_buffer
->selective_display
, Qnil
)
1743 && !detect_input_pending ()
1744 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1745 && NILP (Vexecuting_kbd_macro
))
1746 direct_output_forward_char (-1);
1749 else if (EQ (Vthis_command
, Qself_insert_command
)
1750 /* Try this optimization only on char keystrokes. */
1751 && NATNUMP (last_command_char
)
1752 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1755 = translate_char (Vtranslation_table_for_input
,
1756 XFASTINT (last_command_char
), 0, 0, 0);
1758 if (NILP (Vexecuting_kbd_macro
)
1759 && !EQ (minibuf_window
, selected_window
))
1761 if (!nonundocount
|| nonundocount
>= 20)
1769 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1771 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1773 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1775 || MODIFF
<= SAVE_MODIFF
1776 || windows_or_buffers_changed
1777 || !EQ (current_buffer
->selective_display
, Qnil
)
1778 || detect_input_pending ()
1779 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1780 || !NILP (Vexecuting_kbd_macro
));
1782 value
= internal_self_insert (c
, 0);
1787 if (! NILP (Vpost_command_hook
))
1788 /* Put this before calling adjust_point_for_property
1789 so it will only get called once in any case. */
1792 /* VALUE == 1 when AFTER-CHANGE functions are
1793 installed which is the case most of the time
1794 because FONT-LOCK installs one. */
1795 if (!lose
&& !value
)
1796 direct_output_for_insert (c
);
1801 /* Here for a command that isn't executed directly */
1804 #ifdef HAVE_X_WINDOWS
1805 int scount
= SPECPDL_INDEX ();
1807 if (display_hourglass_p
1808 && NILP (Vexecuting_kbd_macro
))
1810 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1816 if (NILP (current_kboard
->Vprefix_arg
))
1818 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1820 #ifdef HAVE_X_WINDOWS
1821 /* Do not check display_hourglass_p here, because
1822 Fcommand_execute could change it, but we should cancel
1823 hourglass cursor anyway.
1824 But don't cancel the hourglass within a macro
1825 just because a command in the macro finishes. */
1826 if (NILP (Vexecuting_kbd_macro
))
1827 unbind_to (scount
, Qnil
);
1832 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1834 /* Note that the value cell will never directly contain nil
1835 if the symbol is a local variable. */
1836 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1837 safe_run_hooks (Qpost_command_hook
);
1839 /* If displaying a message, resize the echo area window to fit
1840 that message's size exactly. */
1841 if (!NILP (echo_area_buffer
[0]))
1842 resize_echo_area_exactly ();
1844 if (!NILP (Vdeferred_action_list
))
1845 safe_run_hooks (Qdeferred_action_function
);
1847 /* If there is a prefix argument,
1848 1) We don't want Vlast_command to be ``universal-argument''
1849 (that would be dumb), so don't set Vlast_command,
1850 2) we want to leave echoing on so that the prefix will be
1851 echoed as part of this key sequence, so don't call
1853 3) we want to leave this_command_key_count non-zero, so that
1854 read_char will realize that it is re-reading a character, and
1855 not echo it a second time.
1857 If the command didn't actually create a prefix arg,
1858 but is merely a frame event that is transparent to prefix args,
1859 then the above doesn't apply. */
1860 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1862 current_kboard
->Vlast_command
= Vthis_command
;
1863 current_kboard
->Vreal_last_command
= real_this_command
;
1865 this_command_key_count
= 0;
1866 this_command_key_count_reset
= 0;
1867 this_single_command_key_start
= 0;
1870 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1872 /* Setting transient-mark-mode to `only' is a way of
1873 turning it on for just one command. */
1875 if (EQ (Vtransient_mark_mode
, Qidentity
))
1876 Vtransient_mark_mode
= Qnil
;
1877 if (EQ (Vtransient_mark_mode
, Qonly
))
1878 Vtransient_mark_mode
= Qidentity
;
1880 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1882 /* We could also call `deactivate'mark'. */
1883 if (EQ (Vtransient_mark_mode
, Qlambda
))
1884 Vtransient_mark_mode
= Qnil
;
1887 current_buffer
->mark_active
= Qnil
;
1888 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1891 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1892 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1897 if (current_buffer
== prev_buffer
1898 && last_point_position
!= PT
1899 && NILP (Vdisable_point_adjustment
)
1900 && NILP (Vglobal_disable_point_adjustment
)
1901 && !already_adjusted
)
1902 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1904 /* Install chars successfully executed in kbd macro. */
1906 if (!NILP (current_kboard
->defining_kbd_macro
)
1907 && NILP (current_kboard
->Vprefix_arg
))
1908 finalize_kbd_macro_chars ();
1912 any_kboard_state ();
1917 extern Lisp_Object Qcomposition
, Qdisplay
;
1919 /* Adjust point to a boundary of a region that has such a property
1920 that should be treated intangible. For the moment, we check
1921 `composition', `display' and `invisible' properties.
1922 LAST_PT is the last position of point. */
1924 extern Lisp_Object Qafter_string
, Qbefore_string
;
1925 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1928 adjust_point_for_property (last_pt
, modified
)
1933 Lisp_Object val
, overlay
, tmp
;
1934 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1937 /* FIXME: cycling is probably not necessary because these properties
1938 can't be usefully combined anyway. */
1939 while (check_composition
|| check_display
|| check_invisible
)
1941 if (check_composition
1942 && PT
> BEGV
&& PT
< ZV
1943 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1944 && COMPOSITION_VALID_P (beg
, end
, val
)
1945 && beg
< PT
/* && end > PT <- It's always the case. */
1946 && (last_pt
<= beg
|| last_pt
>= end
))
1949 SET_PT (PT
< last_pt
? beg
: end
);
1950 check_display
= check_invisible
= 1;
1952 check_composition
= 0;
1954 && PT
> BEGV
&& PT
< ZV
1955 && !NILP (val
= get_char_property_and_overlay
1956 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1957 && display_prop_intangible_p (val
)
1958 && (!OVERLAYP (overlay
)
1959 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1960 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1961 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1962 && (beg
< PT
/* && end > PT <- It's always the case. */
1963 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1966 SET_PT (PT
< last_pt
1967 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1969 check_composition
= check_invisible
= 1;
1972 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1974 int inv
, ellipsis
= 0;
1977 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1979 && !NILP (val
= get_char_property_and_overlay
1980 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1981 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1983 ellipsis
= ellipsis
|| inv
> 1
1984 || (OVERLAYP (overlay
)
1985 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1986 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1987 tmp
= Fnext_single_char_property_change
1988 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1989 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1992 && !NILP (val
= get_char_property_and_overlay
1993 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1994 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1996 ellipsis
= ellipsis
|| inv
> 1
1997 || (OVERLAYP (overlay
)
1998 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1999 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2000 tmp
= Fprevious_single_char_property_change
2001 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2002 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2005 /* Move away from the inside area. */
2006 if (beg
< PT
&& end
> PT
)
2008 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2009 /* We haven't moved yet (so we don't need to fear
2010 infinite-looping) and we were outside the range
2011 before (so either end of the range still corresponds
2012 to a move in the right direction): pretend we moved
2013 less than we actually did, so that we still have
2014 more freedom below in choosing which end of the range
2016 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2017 /* We either have moved already or the last point
2018 was already in the range: we don't get to choose
2019 which end of the range we have to go to. */
2020 : (PT
< last_pt
? beg
: end
));
2021 check_composition
= check_display
= 1;
2023 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2024 the point to something other than its argument, due to
2025 point-motion hooks, intangibility, etc. */
2026 xassert (PT
== beg
|| PT
== end
);
2029 /* Pretend the area doesn't exist if the buffer is not
2031 if (!modified
&& !ellipsis
&& beg
< end
)
2033 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2034 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2035 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2036 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2037 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2038 /* We've already moved as far as we can. Trying to go
2039 to the other end would mean moving backwards and thus
2040 could lead to an infinite loop. */
2042 else if (val
= get_pos_property (make_number (PT
),
2044 TEXT_PROP_MEANS_INVISIBLE (val
)
2045 && (val
= get_pos_property
2046 (make_number (PT
== beg
? end
: beg
),
2048 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2049 (check_composition
= check_display
= 1,
2050 SET_PT (PT
== beg
? end
: beg
));
2053 check_invisible
= 0;
2057 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2060 safe_run_hooks_1 (hook
)
2063 return call1 (Vrun_hooks
, Vinhibit_quit
);
2066 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2069 safe_run_hooks_error (data
)
2072 Lisp_Object args
[3];
2073 args
[0] = build_string ("Error in %s: %s");
2074 args
[1] = Vinhibit_quit
;
2077 return Fset (Vinhibit_quit
, Qnil
);
2080 /* If we get an error while running the hook, cause the hook variable
2081 to be nil. Also inhibit quits, so that C-g won't cause the hook
2082 to mysteriously evaporate. */
2085 safe_run_hooks (hook
)
2088 int count
= SPECPDL_INDEX ();
2089 specbind (Qinhibit_quit
, hook
);
2091 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2093 unbind_to (count
, Qnil
);
2097 /* Number of seconds between polling for input. This is a Lisp
2098 variable that can be bound. */
2100 EMACS_INT polling_period
;
2102 /* Nonzero means polling for input is temporarily suppressed. */
2104 int poll_suppress_count
;
2106 /* Asynchronous timer for polling. */
2108 struct atimer
*poll_timer
;
2111 #ifdef POLL_FOR_INPUT
2113 /* Poll for input, so what we catch a C-g if it comes in. This
2114 function is called from x_make_frame_visible, see comment
2120 if (interrupt_input_blocked
== 0
2121 && !waiting_for_input
)
2122 read_avail_input (0);
2125 /* Timer callback function for poll_timer. TIMER is equal to
2129 poll_for_input (timer
)
2130 struct atimer
*timer
;
2132 if (poll_suppress_count
== 0)
2134 interrupt_input_pending
= 1;
2136 poll_for_input_1 ();
2140 #endif /* POLL_FOR_INPUT */
2142 /* Begin signals to poll for input, if they are appropriate.
2143 This function is called unconditionally from various places. */
2148 #ifdef POLL_FOR_INPUT
2149 /* XXX This condition was (read_socket_hook && !interrupt_input),
2150 but read_socket_hook is not global anymore. Let's pretend that
2152 if (!interrupt_input
)
2154 /* Turn alarm handling on unconditionally. It might have
2155 been turned off in process.c. */
2156 turn_on_atimers (1);
2158 /* If poll timer doesn't exist, are we need one with
2159 a different interval, start a new one. */
2160 if (poll_timer
== NULL
2161 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2163 EMACS_TIME interval
;
2166 cancel_atimer (poll_timer
);
2168 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2169 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2170 poll_for_input
, NULL
);
2173 /* Let the timer's callback function poll for input
2174 if this becomes zero. */
2175 --poll_suppress_count
;
2180 /* Nonzero if we are using polling to handle input asynchronously. */
2183 input_polling_used ()
2185 #ifdef POLL_FOR_INPUT
2186 /* XXX This condition was (read_socket_hook && !interrupt_input),
2187 but read_socket_hook is not global anymore. Let's pretend that
2189 return !interrupt_input
;
2195 /* Turn off polling. */
2200 #ifdef POLL_FOR_INPUT
2201 /* XXX This condition was (read_socket_hook && !interrupt_input),
2202 but read_socket_hook is not global anymore. Let's pretend that
2204 if (!interrupt_input
)
2205 ++poll_suppress_count
;
2209 /* Set the value of poll_suppress_count to COUNT
2210 and start or stop polling accordingly. */
2213 set_poll_suppress_count (count
)
2216 #ifdef POLL_FOR_INPUT
2217 if (count
== 0 && poll_suppress_count
!= 0)
2219 poll_suppress_count
= 1;
2222 else if (count
!= 0 && poll_suppress_count
== 0)
2226 poll_suppress_count
= count
;
2230 /* Bind polling_period to a value at least N.
2231 But don't decrease it. */
2234 bind_polling_period (n
)
2237 #ifdef POLL_FOR_INPUT
2238 int new = polling_period
;
2243 stop_other_atimers (poll_timer
);
2245 specbind (Qpolling_period
, make_number (new));
2246 /* Start a new alarm with the new period. */
2251 /* Apply the control modifier to CHARACTER. */
2257 /* Save the upper bits here. */
2258 int upper
= c
& ~0177;
2262 /* Everything in the columns containing the upper-case letters
2263 denotes a control character. */
2264 if (c
>= 0100 && c
< 0140)
2268 /* Set the shift modifier for a control char
2269 made from a shifted letter. But only for letters! */
2270 if (oc
>= 'A' && oc
<= 'Z')
2271 c
|= shift_modifier
;
2274 /* The lower-case letters denote control characters too. */
2275 else if (c
>= 'a' && c
<= 'z')
2278 /* Include the bits for control and shift
2279 only if the basic ASCII code can't indicate them. */
2283 /* Replace the high bits. */
2284 c
|= (upper
& ~ctrl_modifier
);
2289 /* Display the help-echo property of the character after the mouse pointer.
2290 Either show it in the echo area, or call show-help-function to display
2291 it by other means (maybe in a tooltip).
2293 If HELP is nil, that means clear the previous help echo.
2295 If HELP is a string, display that string. If HELP is a function,
2296 call it with OBJECT and POS as arguments; the function should
2297 return a help string or nil for none. For all other types of HELP,
2298 evaluate it to obtain a string.
2300 WINDOW is the window in which the help was generated, if any.
2301 It is nil if not in a window.
2303 If OBJECT is a buffer, POS is the position in the buffer where the
2304 `help-echo' text property was found.
2306 If OBJECT is an overlay, that overlay has a `help-echo' property,
2307 and POS is the position in the overlay's buffer under the mouse.
2309 If OBJECT is a string (an overlay string or a string displayed with
2310 the `display' property). POS is the position in that string under
2313 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2314 echo overwrites a keystroke echo currently displayed in the echo
2317 Note: this function may only be called with HELP nil or a string
2318 from X code running asynchronously. */
2321 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2322 Lisp_Object help
, window
, object
, pos
;
2323 int ok_to_overwrite_keystroke_echo
;
2325 if (!NILP (help
) && !STRINGP (help
))
2327 if (FUNCTIONP (help
))
2329 Lisp_Object args
[4];
2334 help
= safe_call (4, args
);
2337 help
= safe_eval (help
);
2339 if (!STRINGP (help
))
2344 if (!noninteractive
&& STRINGP (help
))
2345 help
= call1 (Qmouse_fixup_help_message
, help
);
2348 if (STRINGP (help
) || NILP (help
))
2350 if (!NILP (Vshow_help_function
))
2351 call1 (Vshow_help_function
, help
);
2352 else if (/* Don't overwrite minibuffer contents. */
2353 !MINI_WINDOW_P (XWINDOW (selected_window
))
2354 /* Don't overwrite a keystroke echo. */
2355 && (NILP (echo_message_buffer
)
2356 || ok_to_overwrite_keystroke_echo
)
2357 /* Don't overwrite a prompt. */
2358 && !cursor_in_echo_area
)
2362 int count
= SPECPDL_INDEX ();
2364 if (!help_echo_showing_p
)
2365 Vpre_help_message
= current_message ();
2367 specbind (Qmessage_truncate_lines
, Qt
);
2368 message3_nolog (help
, SBYTES (help
),
2369 STRING_MULTIBYTE (help
));
2370 unbind_to (count
, Qnil
);
2372 else if (STRINGP (Vpre_help_message
))
2374 message3_nolog (Vpre_help_message
,
2375 SBYTES (Vpre_help_message
),
2376 STRING_MULTIBYTE (Vpre_help_message
));
2377 Vpre_help_message
= Qnil
;
2383 help_echo_showing_p
= STRINGP (help
);
2389 /* Input of single characters from keyboard */
2391 Lisp_Object
print_help ();
2392 static Lisp_Object
kbd_buffer_get_event ();
2393 static void record_char ();
2396 static jmp_buf wrong_kboard_jmpbuf
;
2399 #define STOP_POLLING \
2400 do { if (! polling_stopped_here) stop_polling (); \
2401 polling_stopped_here = 1; } while (0)
2403 #define RESUME_POLLING \
2404 do { if (polling_stopped_here) start_polling (); \
2405 polling_stopped_here = 0; } while (0)
2407 /* read a character from the keyboard; call the redisplay if needed */
2408 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2409 -1 means do not do redisplay, but do do autosaving.
2412 /* The arguments MAPS and NMAPS are for menu prompting.
2413 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2415 PREV_EVENT is the previous input event, or nil if we are reading
2416 the first event of a key sequence (or not reading a key sequence).
2417 If PREV_EVENT is t, that is a "magic" value that says
2418 not to run input methods, but in other respects to act as if
2419 not reading a key sequence.
2421 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2422 if we used a mouse menu to read the input, or zero otherwise. If
2423 USED_MOUSE_MENU is null, we don't dereference it.
2425 Value is t if we showed a menu and the user rejected it. */
2428 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2432 Lisp_Object prev_event
;
2433 int *used_mouse_menu
;
2435 volatile Lisp_Object c
;
2437 jmp_buf local_getcjmp
;
2439 volatile int key_already_recorded
= 0;
2440 Lisp_Object tem
, save
;
2441 volatile Lisp_Object previous_echo_area_message
;
2442 volatile Lisp_Object also_record
;
2443 volatile int reread
;
2444 struct gcpro gcpro1
, gcpro2
;
2445 int polling_stopped_here
= 0;
2449 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2450 before_command_key_count
= this_command_key_count
;
2451 before_command_echo_length
= echo_length ();
2454 previous_echo_area_message
= Qnil
;
2456 GCPRO2 (c
, previous_echo_area_message
);
2461 if (CONSP (Vunread_post_input_method_events
))
2463 c
= XCAR (Vunread_post_input_method_events
);
2464 Vunread_post_input_method_events
2465 = XCDR (Vunread_post_input_method_events
);
2467 /* Undo what read_char_x_menu_prompt did when it unread
2468 additional keys returned by Fx_popup_menu. */
2470 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2478 if (unread_command_char
!= -1)
2480 XSETINT (c
, unread_command_char
);
2481 unread_command_char
= -1;
2487 if (CONSP (Vunread_command_events
))
2489 c
= XCAR (Vunread_command_events
);
2490 Vunread_command_events
= XCDR (Vunread_command_events
);
2492 /* Undo what read_char_x_menu_prompt did when it unread
2493 additional keys returned by Fx_popup_menu. */
2495 && EQ (XCDR (c
), Qdisabled
)
2496 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2499 /* If the queued event is something that used the mouse,
2500 set used_mouse_menu accordingly. */
2502 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2503 *used_mouse_menu
= 1;
2506 goto reread_for_input_method
;
2509 if (CONSP (Vunread_input_method_events
))
2511 c
= XCAR (Vunread_input_method_events
);
2512 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2514 /* Undo what read_char_x_menu_prompt did when it unread
2515 additional keys returned by Fx_popup_menu. */
2517 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2521 goto reread_for_input_method
;
2524 this_command_key_count_reset
= 0;
2526 if (!NILP (Vexecuting_kbd_macro
))
2528 /* We set this to Qmacro; since that's not a frame, nobody will
2529 try to switch frames on us, and the selected window will
2532 Since this event came from a macro, it would be misleading to
2533 leave internal_last_event_frame set to wherever the last
2534 real event came from. Normally, a switch-frame event selects
2535 internal_last_event_frame after each command is read, but
2536 events read from a macro should never cause a new frame to be
2538 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2540 /* Exit the macro if we are at the end.
2541 Also, some things replace the macro with t
2542 to force an early exit. */
2543 if (EQ (Vexecuting_kbd_macro
, Qt
)
2544 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2550 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2551 if (STRINGP (Vexecuting_kbd_macro
)
2552 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2553 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2555 executing_kbd_macro_index
++;
2560 if (!NILP (unread_switch_frame
))
2562 c
= unread_switch_frame
;
2563 unread_switch_frame
= Qnil
;
2565 /* This event should make it into this_command_keys, and get echoed
2566 again, so we do not set `reread'. */
2570 /* if redisplay was requested */
2571 if (commandflag
>= 0)
2573 /* If there is pending input, process any events which are not
2574 user-visible, such as X selection_request events. */
2576 || detect_input_pending_run_timers (0))
2577 swallow_events (0); /* may clear input_pending */
2579 /* Redisplay if no pending input. */
2580 while (!input_pending
)
2582 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2583 redisplay_preserve_echo_area (5);
2588 /* Normal case: no input arrived during redisplay. */
2591 /* Input arrived and pre-empted redisplay.
2592 Process any events which are not user-visible. */
2594 /* If that cleared input_pending, try again to redisplay. */
2598 /* Message turns off echoing unless more keystrokes turn it on again.
2600 The code in 20.x for the condition was
2602 1. echo_area_glyphs && *echo_area_glyphs
2603 2. && echo_area_glyphs != current_kboard->echobuf
2604 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2606 (1) means there's a current message displayed
2608 (2) means it's not the message from echoing from the current
2611 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2612 is set to a non-null value. This is done in read_char and it is
2613 set to echo_area_glyphs after a call to echo_char. That means
2614 ok_to_echo_at_next_pause is either null or
2615 current_kboard->echobuf with the appropriate current_kboard at
2618 So, condition (3) means in clear text ok_to_echo_at_next_pause
2619 must be either null, or the current message isn't from echoing at
2620 all, or it's from echoing from a different kboard than the
2623 if (/* There currently is something in the echo area. */
2624 !NILP (echo_area_buffer
[0])
2625 && (/* And it's either not from echoing. */
2626 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2627 /* Or it's an echo from a different kboard. */
2628 || echo_kboard
!= current_kboard
2629 /* Or we explicitly allow overwriting whatever there is. */
2630 || ok_to_echo_at_next_pause
== NULL
))
2635 /* Try reading a character via menu prompting in the minibuf.
2636 Try this before the sit-for, because the sit-for
2637 would do the wrong thing if we are supposed to do
2638 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2639 after a mouse event so don't try a minibuf menu. */
2641 if (nmaps
> 0 && INTERACTIVE
2642 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2643 /* Don't bring up a menu if we already have another event. */
2644 && NILP (Vunread_command_events
)
2645 && unread_command_char
< 0
2646 && !detect_input_pending_run_timers (0))
2648 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2651 key_already_recorded
= 1;
2656 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2657 We will do that below, temporarily for short sections of code,
2658 when appropriate. local_getcjmp must be in effect
2659 around any call to sit_for or kbd_buffer_get_event;
2660 it *must not* be in effect when we call redisplay. */
2662 if (_setjmp (local_getcjmp
))
2664 /* Handle quits while reading the keyboard. */
2665 /* We must have saved the outer value of getcjmp here,
2666 so restore it now. */
2667 restore_getcjmp (save_jump
);
2668 XSETINT (c
, quit_char
);
2669 internal_last_event_frame
= selected_frame
;
2670 Vlast_event_frame
= internal_last_event_frame
;
2671 /* If we report the quit char as an event,
2672 don't do so more than once. */
2673 if (!NILP (Vinhibit_quit
))
2678 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2679 if (kb
!= current_kboard
)
2681 Lisp_Object link
= kb
->kbd_queue
;
2682 /* We shouldn't get here if we were in single-kboard mode! */
2687 while (CONSP (XCDR (link
)))
2689 if (!NILP (XCDR (link
)))
2693 kb
->kbd_queue
= Fcons (c
, Qnil
);
2695 XSETCDR (link
, Fcons (c
, Qnil
));
2696 kb
->kbd_queue_has_data
= 1;
2697 current_kboard
= kb
;
2698 /* This is going to exit from read_char
2699 so we had better get rid of this frame's stuff. */
2701 longjmp (wrong_kboard_jmpbuf
, 1);
2708 timer_start_idle ();
2710 /* If in middle of key sequence and minibuffer not active,
2711 start echoing if enough time elapses. */
2713 if (minibuf_level
== 0
2714 && !current_kboard
->immediate_echo
2715 && this_command_key_count
> 0
2717 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2718 && NILP (Fzerop (Vecho_keystrokes
))
2719 && (/* No message. */
2720 NILP (echo_area_buffer
[0])
2721 /* Or empty message. */
2722 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2723 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2724 /* Or already echoing from same kboard. */
2725 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2726 /* Or not echoing before and echoing allowed. */
2727 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2731 /* After a mouse event, start echoing right away.
2732 This is because we are probably about to display a menu,
2733 and we don't want to delay before doing so. */
2734 if (EVENT_HAS_PARAMETERS (prev_event
))
2739 double duration
= extract_float (Vecho_keystrokes
);
2740 sec
= (int) duration
;
2741 usec
= (duration
- sec
) * 1000000;
2742 save_getcjmp (save_jump
);
2743 restore_getcjmp (local_getcjmp
);
2744 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2745 restore_getcjmp (save_jump
);
2747 && ! CONSP (Vunread_command_events
))
2752 /* Maybe auto save due to number of keystrokes. */
2754 if (commandflag
!= 0
2755 && auto_save_interval
> 0
2756 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2757 && !detect_input_pending_run_timers (0))
2759 Fdo_auto_save (Qnil
, Qnil
);
2760 /* Hooks can actually change some buffers in auto save. */
2764 /* Try reading using an X menu.
2765 This is never confused with reading using the minibuf
2766 because the recursive call of read_char in read_char_minibuf_menu_prompt
2767 does not pass on any keymaps. */
2769 if (nmaps
> 0 && INTERACTIVE
2770 && !NILP (prev_event
)
2771 && EVENT_HAS_PARAMETERS (prev_event
)
2772 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2773 && !EQ (XCAR (prev_event
), Qtool_bar
)
2774 /* Don't bring up a menu if we already have another event. */
2775 && NILP (Vunread_command_events
)
2776 && unread_command_char
< 0)
2778 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2780 /* Now that we have read an event, Emacs is not idle. */
2786 /* Maybe autosave and/or garbage collect due to idleness. */
2788 if (INTERACTIVE
&& NILP (c
))
2790 int delay_level
, buffer_size
;
2792 /* Slow down auto saves logarithmically in size of current buffer,
2793 and garbage collect while we're at it. */
2794 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2795 last_non_minibuf_size
= Z
- BEG
;
2796 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2798 while (buffer_size
> 64)
2799 delay_level
++, buffer_size
-= buffer_size
>> 2;
2800 if (delay_level
< 4) delay_level
= 4;
2801 /* delay_level is 4 for files under around 50k, 7 at 100k,
2802 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2804 /* Auto save if enough time goes by without input. */
2805 if (commandflag
!= 0
2806 && num_nonmacro_input_events
> last_auto_save
2807 && INTEGERP (Vauto_save_timeout
)
2808 && XINT (Vauto_save_timeout
) > 0)
2812 save_getcjmp (save_jump
);
2813 restore_getcjmp (local_getcjmp
);
2814 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2816 restore_getcjmp (save_jump
);
2819 && ! CONSP (Vunread_command_events
))
2821 Fdo_auto_save (Qnil
, Qnil
);
2823 /* If we have auto-saved and there is still no input
2824 available, garbage collect if there has been enough
2825 consing going on to make it worthwhile. */
2826 if (!detect_input_pending_run_timers (0)
2827 && consing_since_gc
> gc_cons_threshold
/ 2)
2828 Fgarbage_collect ();
2835 /* If this has become non-nil here, it has been set by a timer
2836 or sentinel or filter. */
2837 if (CONSP (Vunread_command_events
))
2839 c
= XCAR (Vunread_command_events
);
2840 Vunread_command_events
= XCDR (Vunread_command_events
);
2843 /* Read something from current KBOARD's side queue, if possible. */
2847 if (current_kboard
->kbd_queue_has_data
)
2849 if (!CONSP (current_kboard
->kbd_queue
))
2851 c
= XCAR (current_kboard
->kbd_queue
);
2852 current_kboard
->kbd_queue
2853 = XCDR (current_kboard
->kbd_queue
);
2854 if (NILP (current_kboard
->kbd_queue
))
2855 current_kboard
->kbd_queue_has_data
= 0;
2856 input_pending
= readable_events (0);
2857 if (EVENT_HAS_PARAMETERS (c
)
2858 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2859 internal_last_event_frame
= XCAR (XCDR (c
));
2860 Vlast_event_frame
= internal_last_event_frame
;
2865 /* If current_kboard's side queue is empty check the other kboards.
2866 If one of them has data that we have not yet seen here,
2867 switch to it and process the data waiting for it.
2869 Note: if the events queued up for another kboard
2870 have already been seen here, and therefore are not a complete command,
2871 the kbd_queue_has_data field is 0, so we skip that kboard here.
2872 That's to avoid an infinite loop switching between kboards here. */
2873 if (NILP (c
) && !single_kboard
)
2876 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2877 if (kb
->kbd_queue_has_data
)
2879 current_kboard
= kb
;
2880 /* This is going to exit from read_char
2881 so we had better get rid of this frame's stuff. */
2883 longjmp (wrong_kboard_jmpbuf
, 1);
2892 /* Finally, we read from the main queue,
2893 and if that gives us something we can't use yet, we put it on the
2894 appropriate side queue and try again. */
2900 /* Actually read a character, waiting if necessary. */
2901 save_getcjmp (save_jump
);
2902 restore_getcjmp (local_getcjmp
);
2903 timer_start_idle ();
2904 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2905 restore_getcjmp (save_jump
);
2908 if (! NILP (c
) && (kb
!= current_kboard
))
2910 Lisp_Object link
= kb
->kbd_queue
;
2913 while (CONSP (XCDR (link
)))
2915 if (!NILP (XCDR (link
)))
2919 kb
->kbd_queue
= Fcons (c
, Qnil
);
2921 XSETCDR (link
, Fcons (c
, Qnil
));
2922 kb
->kbd_queue_has_data
= 1;
2926 current_kboard
= kb
;
2927 /* This is going to exit from read_char
2928 so we had better get rid of this frame's stuff. */
2930 longjmp (wrong_kboard_jmpbuf
, 1);
2935 /* Terminate Emacs in batch mode if at eof. */
2936 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2937 Fkill_emacs (make_number (1));
2941 /* Add in any extra modifiers, where appropriate. */
2942 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2943 || ((extra_keyboard_modifiers
& 0177) < ' '
2944 && (extra_keyboard_modifiers
& 0177) != 0))
2945 XSETINT (c
, make_ctrl_char (XINT (c
)));
2947 /* Transfer any other modifier bits directly from
2948 extra_keyboard_modifiers to c. Ignore the actual character code
2949 in the low 16 bits of extra_keyboard_modifiers. */
2950 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2960 if (commandflag
>= 0
2961 && !input_pending
&& !detect_input_pending_run_timers (0))
2969 /* Buffer switch events are only for internal wakeups
2970 so don't show them to the user.
2971 Also, don't record a key if we already did. */
2972 if (BUFFERP (c
) || key_already_recorded
)
2975 /* Process special events within read_char
2976 and loop around to read another event. */
2979 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2984 int was_locked
= single_kboard
;
2986 last_input_char
= c
;
2987 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2989 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2990 /* We stopped being idle for this event; undo that. This
2991 prevents automatic window selection (under
2992 mouse_autoselect_window from acting as a real input event, for
2993 example banishing the mouse under mouse-avoidance-mode. */
2994 timer_resume_idle ();
2996 /* Resume allowing input from any kboard, if that was true before. */
2998 any_kboard_state ();
3003 /* Handle things that only apply to characters. */
3006 /* If kbd_buffer_get_event gave us an EOF, return that. */
3010 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3011 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3012 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3013 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3014 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3015 && CHAR_VALID_P (XINT (c
), 0)))
3018 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3019 /* nil in keyboard-translate-table means no translation. */
3025 /* If this event is a mouse click in the menu bar,
3026 return just menu-bar for now. Modify the mouse click event
3027 so we won't do this twice, then queue it up. */
3028 if (EVENT_HAS_PARAMETERS (c
)
3030 && CONSP (EVENT_START (c
))
3031 && CONSP (XCDR (EVENT_START (c
))))
3035 posn
= POSN_POSN (EVENT_START (c
));
3036 /* Handle menu-bar events:
3037 insert the dummy prefix event `menu-bar'. */
3038 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3040 /* Change menu-bar to (menu-bar) as the event "position". */
3041 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3044 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3049 /* Store these characters into recent_keys, the dribble file if any,
3050 and the keyboard macro being defined, if any. */
3052 if (! NILP (also_record
))
3053 record_char (also_record
);
3055 /* Wipe the echo area.
3056 But first, if we are about to use an input method,
3057 save the echo area contents for it to refer to. */
3059 && ! NILP (Vinput_method_function
)
3060 && (unsigned) XINT (c
) >= ' '
3061 && (unsigned) XINT (c
) != 127
3062 && (unsigned) XINT (c
) < 256)
3064 previous_echo_area_message
= Fcurrent_message ();
3065 Vinput_method_previous_message
= previous_echo_area_message
;
3068 /* Now wipe the echo area, except for help events which do their
3069 own stuff with the echo area. */
3071 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3072 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3074 if (!NILP (echo_area_buffer
[0]))
3075 safe_run_hooks (Qecho_area_clear_hook
);
3076 clear_message (1, 0);
3079 reread_for_input_method
:
3081 /* Pass this to the input method, if appropriate. */
3083 && ! NILP (Vinput_method_function
)
3084 /* Don't run the input method within a key sequence,
3085 after the first event of the key sequence. */
3086 && NILP (prev_event
)
3087 && (unsigned) XINT (c
) >= ' '
3088 && (unsigned) XINT (c
) != 127
3089 && (unsigned) XINT (c
) < 256)
3092 int key_count
, key_count_reset
;
3093 struct gcpro gcpro1
;
3094 int count
= SPECPDL_INDEX ();
3096 /* Save the echo status. */
3097 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3098 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3099 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3100 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3103 if (before_command_restore_flag
)
3105 this_command_key_count
= before_command_key_count_1
;
3106 if (this_command_key_count
< this_single_command_key_start
)
3107 this_single_command_key_start
= this_command_key_count
;
3108 echo_truncate (before_command_echo_length_1
);
3109 before_command_restore_flag
= 0;
3113 /* Save the this_command_keys status. */
3114 key_count
= this_command_key_count
;
3115 key_count_reset
= this_command_key_count_reset
;
3118 keys
= Fcopy_sequence (this_command_keys
);
3123 /* Clear out this_command_keys. */
3124 this_command_key_count
= 0;
3125 this_command_key_count_reset
= 0;
3127 /* Now wipe the echo area. */
3128 if (!NILP (echo_area_buffer
[0]))
3129 safe_run_hooks (Qecho_area_clear_hook
);
3130 clear_message (1, 0);
3133 /* If we are not reading a key sequence,
3134 never use the echo area. */
3137 specbind (Qinput_method_use_echo_area
, Qt
);
3140 /* Call the input method. */
3141 tem
= call1 (Vinput_method_function
, c
);
3143 tem
= unbind_to (count
, tem
);
3145 /* Restore the saved echoing state
3146 and this_command_keys state. */
3147 this_command_key_count
= key_count
;
3148 this_command_key_count_reset
= key_count_reset
;
3150 this_command_keys
= keys
;
3153 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3154 current_kboard
->echo_string
= saved_echo_string
;
3155 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3156 if (saved_immediate_echo
)
3161 /* The input method can return no events. */
3164 /* Bring back the previous message, if any. */
3165 if (! NILP (previous_echo_area_message
))
3166 message_with_string ("%s", previous_echo_area_message
, 0);
3169 /* It returned one event or more. */
3171 Vunread_post_input_method_events
3172 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3177 /* Display help if not echoing. */
3178 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3180 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3181 Lisp_Object help
, object
, position
, window
, tem
;
3183 tem
= Fcdr (XCDR (c
));
3186 window
= Fcar (tem
);
3188 object
= Fcar (tem
);
3190 position
= Fcar (tem
);
3192 show_help_echo (help
, window
, object
, position
, 0);
3194 /* We stopped being idle for this event; undo that. */
3195 timer_resume_idle ();
3199 if (! reread
|| this_command_key_count
== 0
3200 || this_command_key_count_reset
)
3203 /* Don't echo mouse motion events. */
3204 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3205 && NILP (Fzerop (Vecho_keystrokes
))
3206 && ! (EVENT_HAS_PARAMETERS (c
)
3207 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3210 if (! NILP (also_record
))
3211 echo_char (also_record
);
3212 /* Once we reread a character, echoing can happen
3213 the next time we pause to read a new one. */
3214 ok_to_echo_at_next_pause
= current_kboard
;
3217 /* Record this character as part of the current key. */
3218 add_command_key (c
);
3219 if (! NILP (also_record
))
3220 add_command_key (also_record
);
3223 last_input_char
= c
;
3226 /* Process the help character specially if enabled */
3227 if (!NILP (Vhelp_form
) && help_char_p (c
))
3230 count
= SPECPDL_INDEX ();
3232 record_unwind_protect (Fset_window_configuration
,
3233 Fcurrent_window_configuration (Qnil
));
3235 tem0
= Feval (Vhelp_form
);
3237 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3241 c
= read_char (0, 0, 0, Qnil
, 0);
3242 while (BUFFERP (c
));
3243 /* Remove the help from the frame */
3244 unbind_to (count
, Qnil
);
3247 if (EQ (c
, make_number (040)))
3251 c
= read_char (0, 0, 0, Qnil
, 0);
3252 while (BUFFERP (c
));
3261 /* Record a key that came from a mouse menu.
3262 Record it for echoing, for this-command-keys, and so on. */
3268 /* Wipe the echo area. */
3269 clear_message (1, 0);
3274 before_command_key_count
= this_command_key_count
;
3275 before_command_echo_length
= echo_length ();
3278 /* Don't echo mouse motion events. */
3279 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3280 && NILP (Fzerop (Vecho_keystrokes
)))
3284 /* Once we reread a character, echoing can happen
3285 the next time we pause to read a new one. */
3286 ok_to_echo_at_next_pause
= 0;
3289 /* Record this character as part of the current key. */
3290 add_command_key (c
);
3292 /* Re-reading in the middle of a command */
3293 last_input_char
= c
;
3297 /* Return 1 if should recognize C as "the help character". */
3305 if (EQ (c
, Vhelp_char
))
3307 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3308 if (EQ (c
, XCAR (tail
)))
3313 /* Record the input event C in various ways. */
3321 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3323 /* To avoid filling recent_keys with help-echo and mouse-movement
3324 events, we filter out repeated help-echo events, only store the
3325 first and last in a series of mouse-movement events, and don't
3326 store repeated help-echo events which are only separated by
3327 mouse-movement events. */
3329 Lisp_Object ev1
, ev2
, ev3
;
3332 if ((ix1
= recent_keys_index
- 1) < 0)
3333 ix1
= NUM_RECENT_KEYS
- 1;
3334 ev1
= AREF (recent_keys
, ix1
);
3336 if ((ix2
= ix1
- 1) < 0)
3337 ix2
= NUM_RECENT_KEYS
- 1;
3338 ev2
= AREF (recent_keys
, ix2
);
3340 if ((ix3
= ix2
- 1) < 0)
3341 ix3
= NUM_RECENT_KEYS
- 1;
3342 ev3
= AREF (recent_keys
, ix3
);
3344 if (EQ (XCAR (c
), Qhelp_echo
))
3346 /* Don't record `help-echo' in recent_keys unless it shows some help
3347 message, and a different help than the previously recorded
3349 Lisp_Object help
, last_help
;
3351 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3352 if (!STRINGP (help
))
3354 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3355 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3357 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3358 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3359 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3361 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3362 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3363 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3364 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3367 else if (EQ (XCAR (c
), Qmouse_movement
))
3369 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3370 So additional mouse movement events replace the last element. */
3371 Lisp_Object last_window
, window
;
3373 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3374 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3375 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3376 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3377 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3379 ASET (recent_keys
, ix1
, c
);
3385 store_kbd_macro_char (c
);
3390 ASET (recent_keys
, recent_keys_index
, c
);
3391 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3392 recent_keys_index
= 0;
3394 else if (recorded
< 0)
3396 /* We need to remove one or two events from recent_keys.
3397 To do this, we simply put nil at those events and move the
3398 recent_keys_index backwards over those events. Usually,
3399 users will never see those nil events, as they will be
3400 overwritten by the command keys entered to see recent_keys
3403 while (recorded
++ < 0 && total_keys
> 0)
3405 if (total_keys
< NUM_RECENT_KEYS
)
3407 if (--recent_keys_index
< 0)
3408 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3409 ASET (recent_keys
, recent_keys_index
, Qnil
);
3413 num_nonmacro_input_events
++;
3415 /* Write c to the dribble file. If c is a lispy event, write
3416 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3417 If you, dear reader, have a better idea, you've got the source. :-) */
3422 if (XUINT (c
) < 0x100)
3423 putc (XINT (c
), dribble
);
3425 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3429 Lisp_Object dribblee
;
3431 /* If it's a structured event, take the event header. */
3432 dribblee
= EVENT_HEAD (c
);
3434 if (SYMBOLP (dribblee
))
3436 putc ('<', dribble
);
3437 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3438 SBYTES (SYMBOL_NAME (dribblee
)),
3440 putc ('>', dribble
);
3452 struct buffer
*old
= current_buffer
;
3453 Fprinc (object
, Qnil
);
3454 set_buffer_internal (XBUFFER (Vstandard_output
));
3455 call0 (intern ("help-mode"));
3456 set_buffer_internal (old
);
3460 /* Copy out or in the info on where C-g should throw to.
3461 This is used when running Lisp code from within get_char,
3462 in case get_char is called recursively.
3463 See read_process_output. */
3469 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3473 restore_getcjmp (temp
)
3476 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3481 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3482 of this function. */
3485 tracking_off (old_value
)
3486 Lisp_Object old_value
;
3488 do_mouse_tracking
= old_value
;
3489 if (NILP (old_value
))
3491 /* Redisplay may have been preempted because there was input
3492 available, and it assumes it will be called again after the
3493 input has been processed. If the only input available was
3494 the sort that we have just disabled, then we need to call
3496 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3498 redisplay_preserve_echo_area (6);
3499 get_input_pending (&input_pending
,
3500 READABLE_EVENTS_DO_TIMERS_NOW
);
3506 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3507 doc
: /* Evaluate BODY with mouse movement events enabled.
3508 Within a `track-mouse' form, mouse motion generates input events that
3509 you can read with `read-event'.
3510 Normally, mouse motion is ignored.
3511 usage: (track-mouse BODY ...) */)
3515 int count
= SPECPDL_INDEX ();
3518 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3520 do_mouse_tracking
= Qt
;
3522 val
= Fprogn (args
);
3523 return unbind_to (count
, val
);
3526 /* If mouse has moved on some frame, return one of those frames.
3527 Return 0 otherwise. */
3532 Lisp_Object tail
, frame
;
3534 FOR_EACH_FRAME (tail
, frame
)
3536 if (XFRAME (frame
)->mouse_moved
)
3537 return XFRAME (frame
);
3543 #endif /* HAVE_MOUSE */
3545 /* Low level keyboard/mouse input.
3546 kbd_buffer_store_event places events in kbd_buffer, and
3547 kbd_buffer_get_event retrieves them. */
3549 /* Return true iff there are any events in the queue that read-char
3550 would return. If this returns false, a read-char would block. */
3552 readable_events (flags
)
3555 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3558 /* If the buffer contains only FOCUS_IN_EVENT events, and
3559 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3560 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3562 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3563 #ifdef USE_TOOLKIT_SCROLL_BARS
3564 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3568 struct input_event
*event
;
3570 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3577 #ifdef USE_TOOLKIT_SCROLL_BARS
3578 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3580 event
->kind
== FOCUS_IN_EVENT
)
3581 #ifdef USE_TOOLKIT_SCROLL_BARS
3582 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3583 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3584 && event
->part
== scroll_bar_handle
3585 && event
->modifiers
== 0)
3590 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3593 while (event
!= kbd_store_ptr
);
3600 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3601 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3606 if (current_kboard
->kbd_queue_has_data
)
3612 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3613 if (kb
->kbd_queue_has_data
)
3619 /* Set this for debugging, to have a way to get out */
3624 event_to_kboard (event
)
3625 struct input_event
*event
;
3628 frame
= event
->frame_or_window
;
3630 frame
= XCAR (frame
);
3631 else if (WINDOWP (frame
))
3632 frame
= WINDOW_FRAME (XWINDOW (frame
));
3634 /* There are still some events that don't set this field.
3635 For now, just ignore the problem.
3636 Also ignore dead frames here. */
3637 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3640 return FRAME_KBOARD (XFRAME (frame
));
3645 Lisp_Object Vthrow_on_input
;
3647 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3650 kbd_buffer_store_event (event
)
3651 register struct input_event
*event
;
3653 kbd_buffer_store_event_hold (event
, 0);
3656 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3658 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3659 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3660 Else, if EVENT is a quit event, store the quit event
3661 in HOLD_QUIT, and return (thus ignoring further events).
3663 This is used in read_avail_input to postpone the processing
3664 of the quit event until all subsequent input events have been
3665 parsed (and discarded).
3669 kbd_buffer_store_event_hold (event
, hold_quit
)
3670 register struct input_event
*event
;
3671 struct input_event
*hold_quit
;
3673 if (event
->kind
== NO_EVENT
)
3676 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3679 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3681 register int c
= event
->code
& 0377;
3683 if (event
->modifiers
& ctrl_modifier
)
3684 c
= make_ctrl_char (c
);
3686 c
|= (event
->modifiers
3687 & (meta_modifier
| alt_modifier
3688 | hyper_modifier
| super_modifier
));
3693 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3694 struct input_event
*sp
;
3696 if (single_kboard
&& kb
!= current_kboard
)
3699 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3700 Fcons (make_number (c
), Qnil
));
3701 kb
->kbd_queue_has_data
= 1;
3702 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3704 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3707 if (event_to_kboard (sp
) == kb
)
3709 sp
->kind
= NO_EVENT
;
3710 sp
->frame_or_window
= Qnil
;
3720 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3724 /* If this results in a quit_char being returned to Emacs as
3725 input, set Vlast_event_frame properly. If this doesn't
3726 get returned to Emacs as an event, the next event read
3727 will set Vlast_event_frame again, so this is safe to do. */
3731 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3733 focus
= event
->frame_or_window
;
3734 internal_last_event_frame
= focus
;
3735 Vlast_event_frame
= focus
;
3738 last_event_timestamp
= event
->timestamp
;
3739 handle_interrupt ();
3743 if (c
&& c
== stop_character
)
3749 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3750 Just ignore the second one. */
3751 else if (event
->kind
== BUFFER_SWITCH_EVENT
3752 && kbd_fetch_ptr
!= kbd_store_ptr
3753 && ((kbd_store_ptr
== kbd_buffer
3754 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3755 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3758 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3759 kbd_store_ptr
= kbd_buffer
;
3761 /* Don't let the very last slot in the buffer become full,
3762 since that would make the two pointers equal,
3763 and that is indistinguishable from an empty buffer.
3764 Discard the event if it would fill the last slot. */
3765 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3767 *kbd_store_ptr
= *event
;
3771 /* If we're inside while-no-input, and this event qualifies
3772 as input, set quit-flag to cause an interrupt. */
3773 if (!NILP (Vthrow_on_input
)
3774 && event
->kind
!= FOCUS_IN_EVENT
3775 && event
->kind
!= HELP_EVENT
3776 && event
->kind
!= DEICONIFY_EVENT
)
3778 Vquit_flag
= Vthrow_on_input
;
3779 /* If we're inside a function that wants immediate quits,
3781 if (immediate_quit
&& NILP (Vinhibit_quit
))
3791 /* Put an input event back in the head of the event queue. */
3794 kbd_buffer_unget_event (event
)
3795 register struct input_event
*event
;
3797 if (kbd_fetch_ptr
== kbd_buffer
)
3798 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3800 /* Don't let the very last slot in the buffer become full, */
3801 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3804 *kbd_fetch_ptr
= *event
;
3809 /* Generate HELP_EVENT input_events in BUFP which has room for
3810 SIZE events. If there's not enough room in BUFP, ignore this
3813 HELP is the help form.
3815 FRAME is the frame on which the help is generated. OBJECT is the
3816 Lisp object where the help was found (a buffer, a string, an
3817 overlay, or nil if neither from a string nor from a buffer. POS is
3818 the position within OBJECT where the help was found.
3820 Value is the number of input_events generated. */
3823 gen_help_event (help
, frame
, window
, object
, pos
)
3824 Lisp_Object help
, frame
, object
, window
;
3827 struct input_event event
;
3831 event
.kind
= HELP_EVENT
;
3832 event
.frame_or_window
= frame
;
3834 event
.x
= WINDOWP (window
) ? window
: frame
;
3837 kbd_buffer_store_event (&event
);
3841 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3844 kbd_buffer_store_help_event (frame
, help
)
3845 Lisp_Object frame
, help
;
3847 struct input_event event
;
3849 event
.kind
= HELP_EVENT
;
3850 event
.frame_or_window
= frame
;
3855 kbd_buffer_store_event (&event
);
3859 /* Discard any mouse events in the event buffer by setting them to
3862 discard_mouse_events ()
3864 struct input_event
*sp
;
3865 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3867 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3870 if (sp
->kind
== MOUSE_CLICK_EVENT
3871 || sp
->kind
== WHEEL_EVENT
3873 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3875 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3877 sp
->kind
= NO_EVENT
;
3883 /* Return non-zero if there are any real events waiting in the event
3884 buffer, not counting `NO_EVENT's.
3886 If DISCARD is non-zero, discard NO_EVENT events at the front of
3887 the input queue, possibly leaving the input queue empty if there
3888 are no real input events. */
3891 kbd_buffer_events_waiting (discard
)
3894 struct input_event
*sp
;
3896 for (sp
= kbd_fetch_ptr
;
3897 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3900 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3907 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3911 /* Clear input event EVENT. */
3915 struct input_event
*event
;
3917 event
->kind
= NO_EVENT
;
3921 /* Read one event from the event buffer, waiting if necessary.
3922 The value is a Lisp object representing the event.
3923 The value is nil for an event that should be ignored,
3924 or that was handled here.
3925 We always read and discard one event. */
3928 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3930 int *used_mouse_menu
;
3939 *kbp
= current_kboard
;
3943 /* Wait until there is input available. */
3946 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3949 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3953 /* If the quit flag is set, then read_char will return
3954 quit_char, so that counts as "available input." */
3955 if (!NILP (Vquit_flag
))
3956 quit_throw_to_read_char ();
3958 /* One way or another, wait until input is available; then, if
3959 interrupt handlers have not read it, read it now. */
3962 wait_for_kbd_input ();
3964 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3968 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3971 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3975 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3977 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3978 /* Pass 1 for EXPECT since we just waited to have input. */
3979 read_avail_input (1);
3981 #endif /* not VMS */
3984 if (CONSP (Vunread_command_events
))
3987 first
= XCAR (Vunread_command_events
);
3988 Vunread_command_events
= XCDR (Vunread_command_events
);
3989 *kbp
= current_kboard
;
3993 /* At this point, we know that there is a readable event available
3994 somewhere. If the event queue is empty, then there must be a
3995 mouse movement enabled and available. */
3996 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3998 struct input_event
*event
;
4000 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4004 last_event_timestamp
= event
->timestamp
;
4007 *kbp
= event_to_kboard (event
);
4009 *kbp
= current_kboard
; /* Better than returning null ptr? */
4011 *kbp
= &the_only_kboard
;
4016 /* These two kinds of events get special handling
4017 and don't actually appear to the command loop.
4018 We return nil for them. */
4019 if (event
->kind
== SELECTION_REQUEST_EVENT
4020 || event
->kind
== SELECTION_CLEAR_EVENT
)
4023 struct input_event copy
;
4025 /* Remove it from the buffer before processing it,
4026 since otherwise swallow_events will see it
4027 and process it again. */
4029 kbd_fetch_ptr
= event
+ 1;
4030 input_pending
= readable_events (0);
4031 x_handle_selection_event (©
);
4033 /* We're getting selection request events, but we don't have
4039 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4040 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4042 /* Make an event (delete-frame (FRAME)). */
4043 obj
= Fcons (event
->frame_or_window
, Qnil
);
4044 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4045 kbd_fetch_ptr
= event
+ 1;
4048 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4049 else if (event
->kind
== ICONIFY_EVENT
)
4051 /* Make an event (iconify-frame (FRAME)). */
4052 obj
= Fcons (event
->frame_or_window
, Qnil
);
4053 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4054 kbd_fetch_ptr
= event
+ 1;
4056 else if (event
->kind
== DEICONIFY_EVENT
)
4058 /* Make an event (make-frame-visible (FRAME)). */
4059 obj
= Fcons (event
->frame_or_window
, Qnil
);
4060 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4061 kbd_fetch_ptr
= event
+ 1;
4064 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4066 /* The value doesn't matter here; only the type is tested. */
4067 XSETBUFFER (obj
, current_buffer
);
4068 kbd_fetch_ptr
= event
+ 1;
4070 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4071 || defined (USE_GTK)
4072 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4074 kbd_fetch_ptr
= event
+ 1;
4075 input_pending
= readable_events (0);
4076 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4077 x_activate_menubar (XFRAME (event
->frame_or_window
));
4080 #if defined (WINDOWSNT) || defined (MAC_OS)
4081 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4084 /* Make an event (language-change (KEY_SCRIPT)). */
4085 obj
= Fcons (make_number (event
->code
), Qnil
);
4087 /* Make an event (language-change (FRAME CHARSET LCID)). */
4088 obj
= Fcons (event
->frame_or_window
, Qnil
);
4090 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4091 kbd_fetch_ptr
= event
+ 1;
4094 else if (event
->kind
== SAVE_SESSION_EVENT
)
4096 obj
= Fcons (Qsave_session
, Qnil
);
4097 kbd_fetch_ptr
= event
+ 1;
4099 /* Just discard these, by returning nil.
4100 With MULTI_KBOARD, these events are used as placeholders
4101 when we need to randomly delete events from the queue.
4102 (They shouldn't otherwise be found in the buffer,
4103 but on some machines it appears they do show up
4104 even without MULTI_KBOARD.) */
4105 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4106 mouse events during a popup-menu call. */
4107 else if (event
->kind
== NO_EVENT
)
4108 kbd_fetch_ptr
= event
+ 1;
4109 else if (event
->kind
== HELP_EVENT
)
4111 Lisp_Object object
, position
, help
, frame
, window
;
4113 frame
= event
->frame_or_window
;
4114 object
= event
->arg
;
4115 position
= make_number (event
->code
);
4118 clear_event (event
);
4120 kbd_fetch_ptr
= event
+ 1;
4121 if (!WINDOWP (window
))
4123 obj
= Fcons (Qhelp_echo
,
4124 list5 (frame
, help
, window
, object
, position
));
4126 else if (event
->kind
== FOCUS_IN_EVENT
)
4128 /* Notification of a FocusIn event. The frame receiving the
4129 focus is in event->frame_or_window. Generate a
4130 switch-frame event if necessary. */
4131 Lisp_Object frame
, focus
;
4133 frame
= event
->frame_or_window
;
4134 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4138 if (!EQ (frame
, internal_last_event_frame
)
4139 && !EQ (frame
, selected_frame
))
4140 obj
= make_lispy_switch_frame (frame
);
4141 internal_last_event_frame
= frame
;
4142 kbd_fetch_ptr
= event
+ 1;
4146 /* If this event is on a different frame, return a switch-frame this
4147 time, and leave the event in the queue for next time. */
4151 frame
= event
->frame_or_window
;
4153 frame
= XCAR (frame
);
4154 else if (WINDOWP (frame
))
4155 frame
= WINDOW_FRAME (XWINDOW (frame
));
4157 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4161 if (! EQ (frame
, internal_last_event_frame
)
4162 && !EQ (frame
, selected_frame
))
4163 obj
= make_lispy_switch_frame (frame
);
4164 internal_last_event_frame
= frame
;
4166 /* If we didn't decide to make a switch-frame event, go ahead
4167 and build a real event from the queue entry. */
4171 obj
= make_lispy_event (event
);
4173 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4174 || defined (USE_GTK)
4175 /* If this was a menu selection, then set the flag to inhibit
4176 writing to last_nonmenu_event. Don't do this if the event
4177 we're returning is (menu-bar), though; that indicates the
4178 beginning of the menu sequence, and we might as well leave
4179 that as the `event with parameters' for this selection. */
4181 && !EQ (event
->frame_or_window
, event
->arg
)
4182 && (event
->kind
== MENU_BAR_EVENT
4183 || event
->kind
== TOOL_BAR_EVENT
))
4184 *used_mouse_menu
= 1;
4187 /* Wipe out this event, to catch bugs. */
4188 clear_event (event
);
4189 kbd_fetch_ptr
= event
+ 1;
4194 /* Try generating a mouse motion event. */
4195 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4197 FRAME_PTR f
= some_mouse_moved ();
4198 Lisp_Object bar_window
;
4199 enum scroll_bar_part part
;
4203 *kbp
= current_kboard
;
4204 /* Note that this uses F to determine which display to look at.
4205 If there is no valid info, it does not store anything
4206 so x remains nil. */
4209 /* XXX Can f or mouse_position_hook be NULL here? */
4210 if (f
&& FRAME_DEVICE (f
)->mouse_position_hook
)
4211 (*FRAME_DEVICE (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4212 &part
, &x
, &y
, &time
);
4216 /* Decide if we should generate a switch-frame event. Don't
4217 generate switch-frame events for motion outside of all Emacs
4223 frame
= FRAME_FOCUS_FRAME (f
);
4225 XSETFRAME (frame
, f
);
4227 if (! EQ (frame
, internal_last_event_frame
)
4228 && !EQ (frame
, selected_frame
))
4229 obj
= make_lispy_switch_frame (frame
);
4230 internal_last_event_frame
= frame
;
4233 /* If we didn't decide to make a switch-frame event, go ahead and
4234 return a mouse-motion event. */
4235 if (!NILP (x
) && NILP (obj
))
4236 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4238 #endif /* HAVE_MOUSE */
4240 /* We were promised by the above while loop that there was
4241 something for us to read! */
4244 input_pending
= readable_events (0);
4246 Vlast_event_frame
= internal_last_event_frame
;
4251 /* Process any events that are not user-visible,
4252 then return, without reading any user-visible events. */
4255 swallow_events (do_display
)
4260 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4262 struct input_event
*event
;
4264 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4268 last_event_timestamp
= event
->timestamp
;
4270 /* These two kinds of events get special handling
4271 and don't actually appear to the command loop. */
4272 if (event
->kind
== SELECTION_REQUEST_EVENT
4273 || event
->kind
== SELECTION_CLEAR_EVENT
)
4276 struct input_event copy
;
4278 /* Remove it from the buffer before processing it,
4279 since otherwise swallow_events called recursively could see it
4280 and process it again. */
4282 kbd_fetch_ptr
= event
+ 1;
4283 input_pending
= readable_events (0);
4284 x_handle_selection_event (©
);
4286 /* We're getting selection request events, but we don't have
4295 old_timers_run
= timers_run
;
4296 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4298 if (timers_run
!= old_timers_run
&& do_display
)
4299 redisplay_preserve_echo_area (7);
4302 /* Record the start of when Emacs is idle,
4303 for the sake of running idle-time timers. */
4310 /* If we are already in the idle state, do nothing. */
4311 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4314 EMACS_GET_TIME (timer_idleness_start_time
);
4316 timer_last_idleness_start_time
= timer_idleness_start_time
;
4318 /* Mark all idle-time timers as once again candidates for running. */
4319 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4323 timer
= XCAR (timers
);
4325 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4327 XVECTOR (timer
)->contents
[0] = Qnil
;
4331 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4336 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4339 /* Resume idle timer from last idle start time. */
4342 timer_resume_idle ()
4344 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4347 timer_idleness_start_time
= timer_last_idleness_start_time
;
4350 /* This is only for debugging. */
4351 struct input_event last_timer_event
;
4353 /* Check whether a timer has fired. To prevent larger problems we simply
4354 disregard elements that are not proper timers. Do not make a circular
4355 timer list for the time being.
4357 Returns the number of seconds to wait until the next timer fires. If a
4358 timer is triggering now, return zero seconds.
4359 If no timer is active, return -1 seconds.
4361 If a timer is ripe, we run it, with quitting turned off.
4363 DO_IT_NOW is now ignored. It used to mean that we should
4364 run the timer directly instead of queueing a timer-event.
4365 Now we always run timers directly. */
4368 timer_check (do_it_now
)
4371 EMACS_TIME nexttime
;
4372 EMACS_TIME now
, idleness_now
;
4373 Lisp_Object timers
, idle_timers
, chosen_timer
;
4374 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4376 EMACS_SET_SECS (nexttime
, -1);
4377 EMACS_SET_USECS (nexttime
, -1);
4379 /* Always consider the ordinary timers. */
4380 timers
= Vtimer_list
;
4381 /* Consider the idle timers only if Emacs is idle. */
4382 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4383 idle_timers
= Vtimer_idle_list
;
4386 chosen_timer
= Qnil
;
4387 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4389 if (CONSP (timers
) || CONSP (idle_timers
))
4391 EMACS_GET_TIME (now
);
4392 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4393 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4396 while (CONSP (timers
) || CONSP (idle_timers
))
4398 Lisp_Object
*vector
;
4399 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4400 EMACS_TIME timer_time
, idle_timer_time
;
4401 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4403 /* Skip past invalid timers and timers already handled. */
4406 timer
= XCAR (timers
);
4407 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4409 timers
= XCDR (timers
);
4412 vector
= XVECTOR (timer
)->contents
;
4414 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4415 || !INTEGERP (vector
[3])
4416 || ! NILP (vector
[0]))
4418 timers
= XCDR (timers
);
4422 if (!NILP (idle_timers
))
4424 timer
= XCAR (idle_timers
);
4425 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4427 idle_timers
= XCDR (idle_timers
);
4430 vector
= XVECTOR (timer
)->contents
;
4432 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4433 || !INTEGERP (vector
[3])
4434 || ! NILP (vector
[0]))
4436 idle_timers
= XCDR (idle_timers
);
4441 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4442 based on the next ordinary timer.
4443 TIMER_DIFFERENCE is the distance in time from NOW to when
4444 this timer becomes ripe (negative if it's already ripe). */
4447 timer
= XCAR (timers
);
4448 vector
= XVECTOR (timer
)->contents
;
4449 EMACS_SET_SECS (timer_time
,
4450 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4451 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4452 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4455 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4456 based on the next idle timer. */
4457 if (!NILP (idle_timers
))
4459 idle_timer
= XCAR (idle_timers
);
4460 vector
= XVECTOR (idle_timer
)->contents
;
4461 EMACS_SET_SECS (idle_timer_time
,
4462 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4463 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4464 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4467 /* Decide which timer is the next timer,
4468 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4469 Also step down the list where we found that timer. */
4471 if (! NILP (timers
) && ! NILP (idle_timers
))
4474 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4475 if (EMACS_TIME_NEG_P (temp
))
4477 chosen_timer
= timer
;
4478 timers
= XCDR (timers
);
4479 difference
= timer_difference
;
4483 chosen_timer
= idle_timer
;
4484 idle_timers
= XCDR (idle_timers
);
4485 difference
= idle_timer_difference
;
4488 else if (! NILP (timers
))
4490 chosen_timer
= timer
;
4491 timers
= XCDR (timers
);
4492 difference
= timer_difference
;
4496 chosen_timer
= idle_timer
;
4497 idle_timers
= XCDR (idle_timers
);
4498 difference
= idle_timer_difference
;
4500 vector
= XVECTOR (chosen_timer
)->contents
;
4502 /* If timer is ripe, run it if it hasn't been run. */
4503 if (EMACS_TIME_NEG_P (difference
)
4504 || (EMACS_SECS (difference
) == 0
4505 && EMACS_USECS (difference
) == 0))
4507 if (NILP (vector
[0]))
4509 int count
= SPECPDL_INDEX ();
4510 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4512 /* On unbind_to, resume allowing input from any kboard, if that
4514 record_single_kboard_state ();
4516 /* Mark the timer as triggered to prevent problems if the lisp
4517 code fails to reschedule it right. */
4520 specbind (Qinhibit_quit
, Qt
);
4522 call1 (Qtimer_event_handler
, chosen_timer
);
4523 Vdeactivate_mark
= old_deactivate_mark
;
4525 unbind_to (count
, Qnil
);
4527 /* Since we have handled the event,
4528 we don't need to tell the caller to wake up and do it. */
4532 /* When we encounter a timer that is still waiting,
4533 return the amount of time to wait before it is ripe. */
4540 /* No timers are pending in the future. */
4541 /* Return 0 if we generated an event, and -1 if not. */
4546 /* Caches for modify_event_symbol. */
4547 static Lisp_Object accent_key_syms
;
4548 static Lisp_Object func_key_syms
;
4549 static Lisp_Object mouse_syms
;
4550 static Lisp_Object wheel_syms
;
4551 static Lisp_Object drag_n_drop_syms
;
4553 /* This is a list of keysym codes for special "accent" characters.
4554 It parallels lispy_accent_keys. */
4556 static int lispy_accent_codes
[] =
4558 #ifdef XK_dead_circumflex
4563 #ifdef XK_dead_grave
4568 #ifdef XK_dead_tilde
4573 #ifdef XK_dead_diaeresis
4578 #ifdef XK_dead_macron
4583 #ifdef XK_dead_degree
4588 #ifdef XK_dead_acute
4593 #ifdef XK_dead_cedilla
4598 #ifdef XK_dead_breve
4603 #ifdef XK_dead_ogonek
4608 #ifdef XK_dead_caron
4613 #ifdef XK_dead_doubleacute
4614 XK_dead_doubleacute
,
4618 #ifdef XK_dead_abovedot
4623 #ifdef XK_dead_abovering
4633 #ifdef XK_dead_belowdot
4638 #ifdef XK_dead_voiced_sound
4639 XK_dead_voiced_sound
,
4643 #ifdef XK_dead_semivoiced_sound
4644 XK_dead_semivoiced_sound
,
4660 /* This is a list of Lisp names for special "accent" characters.
4661 It parallels lispy_accent_codes. */
4663 static char *lispy_accent_keys
[] =
4681 "dead-voiced-sound",
4682 "dead-semivoiced-sound",
4688 #define FUNCTION_KEY_OFFSET 0x0
4690 char *lispy_function_keys
[] =
4694 0, /* VK_LBUTTON 0x01 */
4695 0, /* VK_RBUTTON 0x02 */
4696 "cancel", /* VK_CANCEL 0x03 */
4697 0, /* VK_MBUTTON 0x04 */
4699 0, 0, 0, /* 0x05 .. 0x07 */
4701 "backspace", /* VK_BACK 0x08 */
4702 "tab", /* VK_TAB 0x09 */
4704 0, 0, /* 0x0A .. 0x0B */
4706 "clear", /* VK_CLEAR 0x0C */
4707 "return", /* VK_RETURN 0x0D */
4709 0, 0, /* 0x0E .. 0x0F */
4711 0, /* VK_SHIFT 0x10 */
4712 0, /* VK_CONTROL 0x11 */
4713 0, /* VK_MENU 0x12 */
4714 "pause", /* VK_PAUSE 0x13 */
4715 "capslock", /* VK_CAPITAL 0x14 */
4717 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4719 "escape", /* VK_ESCAPE 0x1B */
4721 0, 0, 0, 0, /* 0x1C .. 0x1F */
4723 0, /* VK_SPACE 0x20 */
4724 "prior", /* VK_PRIOR 0x21 */
4725 "next", /* VK_NEXT 0x22 */
4726 "end", /* VK_END 0x23 */
4727 "home", /* VK_HOME 0x24 */
4728 "left", /* VK_LEFT 0x25 */
4729 "up", /* VK_UP 0x26 */
4730 "right", /* VK_RIGHT 0x27 */
4731 "down", /* VK_DOWN 0x28 */
4732 "select", /* VK_SELECT 0x29 */
4733 "print", /* VK_PRINT 0x2A */
4734 "execute", /* VK_EXECUTE 0x2B */
4735 "snapshot", /* VK_SNAPSHOT 0x2C */
4736 "insert", /* VK_INSERT 0x2D */
4737 "delete", /* VK_DELETE 0x2E */
4738 "help", /* VK_HELP 0x2F */
4740 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4742 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4744 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4746 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4748 0, 0, 0, 0, 0, 0, 0, 0, 0,
4749 0, 0, 0, 0, 0, 0, 0, 0, 0,
4750 0, 0, 0, 0, 0, 0, 0, 0,
4752 "lwindow", /* VK_LWIN 0x5B */
4753 "rwindow", /* VK_RWIN 0x5C */
4754 "apps", /* VK_APPS 0x5D */
4756 0, 0, /* 0x5E .. 0x5F */
4758 "kp-0", /* VK_NUMPAD0 0x60 */
4759 "kp-1", /* VK_NUMPAD1 0x61 */
4760 "kp-2", /* VK_NUMPAD2 0x62 */
4761 "kp-3", /* VK_NUMPAD3 0x63 */
4762 "kp-4", /* VK_NUMPAD4 0x64 */
4763 "kp-5", /* VK_NUMPAD5 0x65 */
4764 "kp-6", /* VK_NUMPAD6 0x66 */
4765 "kp-7", /* VK_NUMPAD7 0x67 */
4766 "kp-8", /* VK_NUMPAD8 0x68 */
4767 "kp-9", /* VK_NUMPAD9 0x69 */
4768 "kp-multiply", /* VK_MULTIPLY 0x6A */
4769 "kp-add", /* VK_ADD 0x6B */
4770 "kp-separator", /* VK_SEPARATOR 0x6C */
4771 "kp-subtract", /* VK_SUBTRACT 0x6D */
4772 "kp-decimal", /* VK_DECIMAL 0x6E */
4773 "kp-divide", /* VK_DIVIDE 0x6F */
4774 "f1", /* VK_F1 0x70 */
4775 "f2", /* VK_F2 0x71 */
4776 "f3", /* VK_F3 0x72 */
4777 "f4", /* VK_F4 0x73 */
4778 "f5", /* VK_F5 0x74 */
4779 "f6", /* VK_F6 0x75 */
4780 "f7", /* VK_F7 0x76 */
4781 "f8", /* VK_F8 0x77 */
4782 "f9", /* VK_F9 0x78 */
4783 "f10", /* VK_F10 0x79 */
4784 "f11", /* VK_F11 0x7A */
4785 "f12", /* VK_F12 0x7B */
4786 "f13", /* VK_F13 0x7C */
4787 "f14", /* VK_F14 0x7D */
4788 "f15", /* VK_F15 0x7E */
4789 "f16", /* VK_F16 0x7F */
4790 "f17", /* VK_F17 0x80 */
4791 "f18", /* VK_F18 0x81 */
4792 "f19", /* VK_F19 0x82 */
4793 "f20", /* VK_F20 0x83 */
4794 "f21", /* VK_F21 0x84 */
4795 "f22", /* VK_F22 0x85 */
4796 "f23", /* VK_F23 0x86 */
4797 "f24", /* VK_F24 0x87 */
4799 0, 0, 0, 0, /* 0x88 .. 0x8B */
4800 0, 0, 0, 0, /* 0x8C .. 0x8F */
4802 "kp-numlock", /* VK_NUMLOCK 0x90 */
4803 "scroll", /* VK_SCROLL 0x91 */
4805 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4806 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4807 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4808 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4809 "kp-end", /* VK_NUMPAD_END 0x96 */
4810 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4811 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4812 "kp-up", /* VK_NUMPAD_UP 0x99 */
4813 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4814 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4815 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4816 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4818 0, 0, /* 0x9E .. 0x9F */
4821 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4822 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4823 * No other API or message will distinguish left and right keys this way.
4827 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4828 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4829 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4830 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4831 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4837 "attn", /* VK_ATTN 0xF6 */
4838 "crsel", /* VK_CRSEL 0xF7 */
4839 "exsel", /* VK_EXSEL 0xF8 */
4840 "ereof", /* VK_EREOF 0xF9 */
4841 "play", /* VK_PLAY 0xFA */
4842 "zoom", /* VK_ZOOM 0xFB */
4843 "noname", /* VK_NONAME 0xFC */
4844 "pa1", /* VK_PA1 0xFD */
4845 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4849 #else /* not HAVE_NTGUI */
4851 /* This should be dealt with in XTread_socket now, and that doesn't
4852 depend on the client system having the Kana syms defined. See also
4853 the XK_kana_A case below. */
4856 static char *lispy_kana_keys
[] =
4858 /* X Keysym value */
4859 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4860 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4861 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4862 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4863 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4864 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4865 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4866 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4867 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4868 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4869 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4870 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4871 "kana-i", "kana-u", "kana-e", "kana-o",
4872 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4873 "prolongedsound", "kana-A", "kana-I", "kana-U",
4874 "kana-E", "kana-O", "kana-KA", "kana-KI",
4875 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4876 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4877 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4878 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4879 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4880 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4881 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4882 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4883 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4884 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4885 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4886 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4888 #endif /* XK_kana_A */
4891 #define FUNCTION_KEY_OFFSET 0xff00
4893 /* You'll notice that this table is arranged to be conveniently
4894 indexed by X Windows keysym values. */
4895 static char *lispy_function_keys
[] =
4897 /* X Keysym value */
4899 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4900 "backspace", "tab", "linefeed", "clear",
4902 0, 0, 0, "pause", /* 0xff10...1f */
4903 0, 0, 0, 0, 0, 0, 0, "escape",
4905 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4906 "romaji", "hiragana", "katakana", "hiragana-katakana",
4907 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4908 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4909 "eisu-toggle", /* 0xff30...3f */
4910 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4911 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4913 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4914 "down", "prior", "next", "end",
4915 "begin", 0, 0, 0, 0, 0, 0, 0,
4916 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4927 "break", /* 0xff6b */
4930 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4931 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4932 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4933 0, 0, 0, 0, 0, 0, 0, 0,
4934 "kp-tab", /* 0xff89 */
4936 "kp-enter", /* 0xff8d */
4938 "kp-f1", /* 0xff91 */
4942 "kp-home", /* 0xff95 */
4947 "kp-prior", /* kp-page-up */
4948 "kp-next", /* kp-page-down */
4954 0, 0, 0, 0, 0, 0, 0, 0, 0,
4955 "kp-multiply", /* 0xffaa */
4960 "kp-divide", /* 0xffaf */
4961 "kp-0", /* 0xffb0 */
4962 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4965 "kp-equal", /* 0xffbd */
4966 "f1", /* 0xffbe */ /* IsFunctionKey */
4968 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4969 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4970 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4971 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4972 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4973 0, 0, 0, 0, 0, 0, 0, 0,
4974 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4975 0, 0, 0, 0, 0, 0, 0, "delete"
4978 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4979 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4981 static char *iso_lispy_function_keys
[] =
4983 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4984 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4985 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4986 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4987 "iso-lefttab", /* 0xfe20 */
4988 "iso-move-line-up", "iso-move-line-down",
4989 "iso-partial-line-up", "iso-partial-line-down",
4990 "iso-partial-space-left", "iso-partial-space-right",
4991 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4992 "iso-release-margin-left", "iso-release-margin-right",
4993 "iso-release-both-margins",
4994 "iso-fast-cursor-left", "iso-fast-cursor-right",
4995 "iso-fast-cursor-up", "iso-fast-cursor-down",
4996 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4997 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5000 #endif /* not HAVE_NTGUI */
5002 Lisp_Object Vlispy_mouse_stem
;
5004 static char *lispy_wheel_names
[] =
5006 "wheel-up", "wheel-down"
5009 /* drag-n-drop events are generated when a set of selected files are
5010 dragged from another application and dropped onto an Emacs window. */
5011 static char *lispy_drag_n_drop_names
[] =
5016 /* Scroll bar parts. */
5017 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5018 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5019 Lisp_Object Qtop
, Qratio
;
5021 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5022 Lisp_Object
*scroll_bar_parts
[] = {
5023 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5024 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5027 /* User signal events. */
5028 Lisp_Object Qusr1_signal
, Qusr2_signal
;
5030 Lisp_Object
*lispy_user_signals
[] =
5032 &Qusr1_signal
, &Qusr2_signal
5036 /* A vector, indexed by button number, giving the down-going location
5037 of currently depressed buttons, both scroll bar and non-scroll bar.
5039 The elements have the form
5040 (BUTTON-NUMBER MODIFIER-MASK . REST)
5041 where REST is the cdr of a position as it would be reported in the event.
5043 The make_lispy_event function stores positions here to tell the
5044 difference between click and drag events, and to store the starting
5045 location to be included in drag events. */
5047 static Lisp_Object button_down_location
;
5049 /* Information about the most recent up-going button event: Which
5050 button, what location, and what time. */
5052 static int last_mouse_button
;
5053 static int last_mouse_x
;
5054 static int last_mouse_y
;
5055 static unsigned long button_down_time
;
5057 /* The maximum time between clicks to make a double-click, or Qnil to
5058 disable double-click detection, or Qt for no time limit. */
5060 Lisp_Object Vdouble_click_time
;
5062 /* Maximum number of pixels the mouse may be moved between clicks
5063 to make a double-click. */
5065 EMACS_INT double_click_fuzz
;
5067 /* The number of clicks in this multiple-click. */
5069 int double_click_count
;
5071 /* Return position of a mouse click or wheel event */
5074 make_lispy_position (f
, x
, y
, time
)
5080 enum window_part part
;
5081 Lisp_Object posn
= Qnil
;
5082 Lisp_Object extra_info
= Qnil
;
5085 /* Set `window' to the window under frame pixel coordinates (x,y) */
5087 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5088 &part
, &wx
, &wy
, 0);
5092 if (WINDOWP (window
))
5094 /* It's a click in window window at frame coordinates (x,y) */
5095 struct window
*w
= XWINDOW (window
);
5096 Lisp_Object string_info
= Qnil
;
5097 int textpos
= -1, rx
= -1, ry
= -1;
5098 int dx
= -1, dy
= -1;
5099 int width
= -1, height
= -1;
5100 Lisp_Object object
= Qnil
;
5102 /* Set event coordinates to window-relative coordinates
5103 for constructing the Lisp event below. */
5107 if (part
== ON_TEXT
)
5109 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5111 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5113 /* Mode line or header line. Look for a string under
5114 the mouse that may have a `local-map' property. */
5118 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5120 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5121 &object
, &dx
, &dy
, &width
, &height
);
5122 if (STRINGP (string
))
5123 string_info
= Fcons (string
, make_number (charpos
));
5124 if (w
== XWINDOW (selected_window
))
5127 textpos
= XMARKER (w
->pointm
)->charpos
;
5129 else if (part
== ON_VERTICAL_BORDER
)
5131 posn
= Qvertical_line
;
5136 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5141 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5143 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5144 &object
, &dx
, &dy
, &width
, &height
);
5145 if (STRINGP (string
))
5146 string_info
= Fcons (string
, make_number (charpos
));
5147 if (part
== ON_LEFT_MARGIN
)
5150 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5152 else if (part
== ON_LEFT_FRINGE
)
5154 posn
= Qleft_fringe
;
5157 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5159 : window_box_width (w
, LEFT_MARGIN_AREA
));
5162 else if (part
== ON_RIGHT_FRINGE
)
5164 posn
= Qright_fringe
;
5167 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5168 + window_box_width (w
, TEXT_AREA
)
5169 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5170 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5176 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5177 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5182 Lisp_Object string2
, object2
= Qnil
;
5183 struct display_pos p
;
5185 int width2
, height2
;
5186 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5187 &object2
, &dx2
, &dy2
,
5189 textpos
= CHARPOS (p
.pos
);
5190 if (rx
< 0) rx
= wx
;
5191 if (ry
< 0) ry
= wy
;
5192 if (dx
< 0) dx
= dx2
;
5193 if (dy
< 0) dy
= dy2
;
5194 if (width
< 0) width
= width2
;
5195 if (height
< 0) height
= height2
;
5199 posn
= make_number (textpos
);
5200 if (STRINGP (string2
))
5201 string_info
= Fcons (string2
,
5202 make_number (CHARPOS (p
.string_pos
)));
5208 #ifdef HAVE_WINDOW_SYSTEM
5209 if (IMAGEP (object
))
5211 Lisp_Object image_map
, hotspot
;
5212 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5214 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5216 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5217 posn
= XCAR (hotspot
);
5222 extra_info
= Fcons (object
,
5223 Fcons (Fcons (make_number (dx
),
5225 Fcons (Fcons (make_number (width
),
5226 make_number (height
)),
5230 extra_info
= Fcons (string_info
,
5231 Fcons (make_number (textpos
),
5232 Fcons (Fcons (make_number (rx
),
5238 XSETFRAME (window
, f
);
5243 XSETFASTINT (*x
, 0);
5244 XSETFASTINT (*y
, 0);
5247 return Fcons (window
,
5249 Fcons (Fcons (*x
, *y
),
5250 Fcons (make_number (time
),
5254 /* Given a struct input_event, build the lisp event which represents
5255 it. If EVENT is 0, build a mouse movement event from the mouse
5256 movement buffer, which should have a movement event in it.
5258 Note that events must be passed to this function in the order they
5259 are received; this function stores the location of button presses
5260 in order to build drag events when the button is released. */
5263 make_lispy_event (event
)
5264 struct input_event
*event
;
5268 switch (SWITCH_ENUM_CAST (event
->kind
))
5270 /* A simple keystroke. */
5271 case ASCII_KEYSTROKE_EVENT
:
5273 Lisp_Object lispy_c
;
5274 int c
= event
->code
& 0377;
5275 /* Turn ASCII characters into control characters
5277 if (event
->modifiers
& ctrl_modifier
)
5278 c
= make_ctrl_char (c
);
5280 /* Add in the other modifier bits. We took care of ctrl_modifier
5281 just above, and the shift key was taken care of by the X code,
5282 and applied to control characters by make_ctrl_char. */
5283 c
|= (event
->modifiers
5284 & (meta_modifier
| alt_modifier
5285 | hyper_modifier
| super_modifier
));
5286 /* Distinguish Shift-SPC from SPC. */
5287 if ((event
->code
& 0377) == 040
5288 && event
->modifiers
& shift_modifier
)
5289 c
|= shift_modifier
;
5290 button_down_time
= 0;
5291 XSETFASTINT (lispy_c
, c
);
5295 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5297 Lisp_Object lispy_c
;
5298 int c
= event
->code
;
5300 /* Add in the other modifier bits. We took care of ctrl_modifier
5301 just above, and the shift key was taken care of by the X code,
5302 and applied to control characters by make_ctrl_char. */
5303 c
|= (event
->modifiers
5304 & (meta_modifier
| alt_modifier
5305 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5306 /* What about the `shift' modifier ? */
5307 button_down_time
= 0;
5308 XSETFASTINT (lispy_c
, c
);
5312 /* A function key. The symbol may need to have modifier prefixes
5314 case NON_ASCII_KEYSTROKE_EVENT
:
5315 button_down_time
= 0;
5317 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5318 if (event
->code
== lispy_accent_codes
[i
])
5319 return modify_event_symbol (i
,
5321 Qfunction_key
, Qnil
,
5322 lispy_accent_keys
, &accent_key_syms
,
5323 (sizeof (lispy_accent_keys
)
5324 / sizeof (lispy_accent_keys
[0])));
5328 if (event
->code
>= 0x400 && event
->code
< 0x500)
5329 return modify_event_symbol (event
->code
- 0x400,
5330 event
->modifiers
& ~shift_modifier
,
5331 Qfunction_key
, Qnil
,
5332 lispy_kana_keys
, &func_key_syms
,
5333 (sizeof (lispy_kana_keys
)
5334 / sizeof (lispy_kana_keys
[0])));
5335 #endif /* XK_kana_A */
5338 #ifdef ISO_FUNCTION_KEY_OFFSET
5339 if (event
->code
< FUNCTION_KEY_OFFSET
5340 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5341 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5343 Qfunction_key
, Qnil
,
5344 iso_lispy_function_keys
, &func_key_syms
,
5345 (sizeof (iso_lispy_function_keys
)
5346 / sizeof (iso_lispy_function_keys
[0])));
5349 /* Handle system-specific or unknown keysyms. */
5350 if (event
->code
& (1 << 28)
5351 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5352 || (event
->code
- FUNCTION_KEY_OFFSET
5353 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5354 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5356 /* We need to use an alist rather than a vector as the cache
5357 since we can't make a vector long enuf. */
5358 if (NILP (current_kboard
->system_key_syms
))
5359 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5360 return modify_event_symbol (event
->code
,
5363 current_kboard
->Vsystem_key_alist
,
5364 0, ¤t_kboard
->system_key_syms
,
5368 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5370 Qfunction_key
, Qnil
,
5371 lispy_function_keys
, &func_key_syms
,
5372 (sizeof (lispy_function_keys
)
5373 / sizeof (lispy_function_keys
[0])));
5376 /* A mouse click. Figure out where it is, decide whether it's
5377 a press, click or drag, and build the appropriate structure. */
5378 case MOUSE_CLICK_EVENT
:
5379 #ifndef USE_TOOLKIT_SCROLL_BARS
5380 case SCROLL_BAR_CLICK_EVENT
:
5383 int button
= event
->code
;
5385 Lisp_Object position
;
5386 Lisp_Object
*start_pos_ptr
;
5387 Lisp_Object start_pos
;
5391 /* Build the position as appropriate for this mouse click. */
5392 if (event
->kind
== MOUSE_CLICK_EVENT
)
5394 struct frame
*f
= XFRAME (event
->frame_or_window
);
5395 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5399 /* Ignore mouse events that were made on frame that
5400 have been deleted. */
5401 if (! FRAME_LIVE_P (f
))
5404 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5405 /* EVENT->x and EVENT->y are frame-relative pixel
5406 coordinates at this place. Under old redisplay, COLUMN
5407 and ROW are set to frame relative glyph coordinates
5408 which are then used to determine whether this click is
5409 in a menu (non-toolkit version). */
5410 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5411 &column
, &row
, NULL
, 1);
5413 /* In the non-toolkit version, clicks on the menu bar
5414 are ordinary button events in the event buffer.
5415 Distinguish them, and invoke the menu.
5417 (In the toolkit version, the toolkit handles the menu bar
5418 and Emacs doesn't know about it until after the user
5419 makes a selection.) */
5420 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5421 && (event
->modifiers
& down_modifier
))
5423 Lisp_Object items
, item
;
5428 /* Activate the menu bar on the down event. If the
5429 up event comes in before the menu code can deal with it,
5431 if (! (event
->modifiers
& down_modifier
))
5435 /* Find the menu bar item under `column'. */
5437 items
= FRAME_MENU_BAR_ITEMS (f
);
5438 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5440 Lisp_Object pos
, string
;
5441 string
= AREF (items
, i
+ 1);
5442 pos
= AREF (items
, i
+ 3);
5445 if (column
>= XINT (pos
)
5446 && column
< XINT (pos
) + SCHARS (string
))
5448 item
= AREF (items
, i
);
5453 /* ELisp manual 2.4b says (x y) are window relative but
5454 code says they are frame-relative. */
5456 = Fcons (event
->frame_or_window
,
5458 Fcons (Fcons (event
->x
, event
->y
),
5459 Fcons (make_number (event
->timestamp
),
5462 return Fcons (item
, Fcons (position
, Qnil
));
5464 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5466 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5469 #ifndef USE_TOOLKIT_SCROLL_BARS
5472 /* It's a scrollbar click. */
5474 Lisp_Object portion_whole
;
5477 window
= event
->frame_or_window
;
5478 portion_whole
= Fcons (event
->x
, event
->y
);
5479 part
= *scroll_bar_parts
[(int) event
->part
];
5483 Fcons (Qvertical_scroll_bar
,
5484 Fcons (portion_whole
,
5485 Fcons (make_number (event
->timestamp
),
5486 Fcons (part
, Qnil
)))));
5488 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5490 if (button
>= ASIZE (button_down_location
))
5492 button_down_location
= larger_vector (button_down_location
,
5494 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5497 start_pos_ptr
= &AREF (button_down_location
, button
);
5498 start_pos
= *start_pos_ptr
;
5499 *start_pos_ptr
= Qnil
;
5502 /* On window-system frames, use the value of
5503 double-click-fuzz as is. On other frames, interpret it
5504 as a multiple of 1/8 characters. */
5508 if (WINDOWP (event
->frame_or_window
))
5509 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5510 else if (FRAMEP (event
->frame_or_window
))
5511 f
= XFRAME (event
->frame_or_window
);
5515 if (FRAME_WINDOW_P (f
))
5516 fuzz
= double_click_fuzz
;
5518 fuzz
= double_click_fuzz
/ 8;
5520 is_double
= (button
== last_mouse_button
5521 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5522 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5523 && button_down_time
!= 0
5524 && (EQ (Vdouble_click_time
, Qt
)
5525 || (INTEGERP (Vdouble_click_time
)
5526 && ((int)(event
->timestamp
- button_down_time
)
5527 < XINT (Vdouble_click_time
)))));
5530 last_mouse_button
= button
;
5531 last_mouse_x
= XINT (event
->x
);
5532 last_mouse_y
= XINT (event
->y
);
5534 /* If this is a button press, squirrel away the location, so
5535 we can decide later whether it was a click or a drag. */
5536 if (event
->modifiers
& down_modifier
)
5540 double_click_count
++;
5541 event
->modifiers
|= ((double_click_count
> 2)
5546 double_click_count
= 1;
5547 button_down_time
= event
->timestamp
;
5548 *start_pos_ptr
= Fcopy_alist (position
);
5551 /* Now we're releasing a button - check the co-ordinates to
5552 see if this was a click or a drag. */
5553 else if (event
->modifiers
& up_modifier
)
5555 /* If we did not see a down before this up, ignore the up.
5556 Probably this happened because the down event chose a
5557 menu item. It would be an annoyance to treat the
5558 release of the button that chose the menu item as a
5561 if (!CONSP (start_pos
))
5564 event
->modifiers
&= ~up_modifier
;
5565 #if 0 /* Formerly we treated an up with no down as a click event. */
5566 if (!CONSP (start_pos
))
5567 event
->modifiers
|= click_modifier
;
5572 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5574 /* The third element of every position
5575 should be the (x,y) pair. */
5576 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5578 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5580 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5581 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5584 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5585 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5586 /* Maybe the mouse has moved a lot, caused scrolling, and
5587 eventually ended up at the same screen position (but
5588 not buffer position) in which case it is a drag, not
5590 /* FIXME: OTOH if the buffer position has changed
5591 because of a timer or process filter rather than
5592 because of mouse movement, it should be considered as
5593 a click. But mouse-drag-region completely ignores
5594 this case and it hasn't caused any real problem, so
5595 it's probably OK to ignore it as well. */
5596 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5597 /* Mouse hasn't moved (much). */
5598 event
->modifiers
|= click_modifier
;
5601 button_down_time
= 0;
5602 event
->modifiers
|= drag_modifier
;
5605 /* Don't check is_double; treat this as multiple
5606 if the down-event was multiple. */
5607 if (double_click_count
> 1)
5608 event
->modifiers
|= ((double_click_count
> 2)
5614 /* Every mouse event should either have the down_modifier or
5615 the up_modifier set. */
5619 /* Get the symbol we should use for the mouse click. */
5622 head
= modify_event_symbol (button
,
5624 Qmouse_click
, Vlispy_mouse_stem
,
5627 XVECTOR (mouse_syms
)->size
);
5628 if (event
->modifiers
& drag_modifier
)
5633 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5636 Fcons (make_number (double_click_count
),
5647 Lisp_Object position
;
5650 /* Build the position as appropriate for this mouse click. */
5651 struct frame
*f
= XFRAME (event
->frame_or_window
);
5653 /* Ignore wheel events that were made on frame that have been
5655 if (! FRAME_LIVE_P (f
))
5658 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5661 /* Set double or triple modifiers to indicate the wheel speed. */
5663 /* On window-system frames, use the value of
5664 double-click-fuzz as is. On other frames, interpret it
5665 as a multiple of 1/8 characters. */
5670 if (WINDOWP (event
->frame_or_window
))
5671 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5672 else if (FRAMEP (event
->frame_or_window
))
5673 f
= XFRAME (event
->frame_or_window
);
5677 if (FRAME_WINDOW_P (f
))
5678 fuzz
= double_click_fuzz
;
5680 fuzz
= double_click_fuzz
/ 8;
5682 is_double
= (last_mouse_button
< 0
5683 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5684 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5685 && button_down_time
!= 0
5686 && (EQ (Vdouble_click_time
, Qt
)
5687 || (INTEGERP (Vdouble_click_time
)
5688 && ((int)(event
->timestamp
- button_down_time
)
5689 < XINT (Vdouble_click_time
)))));
5692 double_click_count
++;
5693 event
->modifiers
|= ((double_click_count
> 2)
5699 double_click_count
= 1;
5700 event
->modifiers
|= click_modifier
;
5703 button_down_time
= event
->timestamp
;
5704 /* Use a negative value to distinguish wheel from mouse button. */
5705 last_mouse_button
= -1;
5706 last_mouse_x
= XINT (event
->x
);
5707 last_mouse_y
= XINT (event
->y
);
5713 if (event
->modifiers
& up_modifier
)
5715 /* Emit a wheel-up event. */
5716 event
->modifiers
&= ~up_modifier
;
5719 else if (event
->modifiers
& down_modifier
)
5721 /* Emit a wheel-down event. */
5722 event
->modifiers
&= ~down_modifier
;
5726 /* Every wheel event should either have the down_modifier or
5727 the up_modifier set. */
5730 /* Get the symbol we should use for the wheel event. */
5731 head
= modify_event_symbol (symbol_num
,
5737 ASIZE (wheel_syms
));
5740 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5743 Fcons (make_number (double_click_count
),
5752 #ifdef USE_TOOLKIT_SCROLL_BARS
5754 /* We don't have down and up events if using toolkit scroll bars,
5755 so make this always a click event. Store in the `part' of
5756 the Lisp event a symbol which maps to the following actions:
5758 `above_handle' page up
5759 `below_handle' page down
5763 `bottom' bottom of buffer
5764 `handle' thumb has been dragged.
5765 `end-scroll' end of interaction with scroll bar
5767 The incoming input_event contains in its `part' member an
5768 index of type `enum scroll_bar_part' which we can use as an
5769 index in scroll_bar_parts to get the appropriate symbol. */
5771 case SCROLL_BAR_CLICK_EVENT
:
5773 Lisp_Object position
, head
, window
, portion_whole
, part
;
5775 window
= event
->frame_or_window
;
5776 portion_whole
= Fcons (event
->x
, event
->y
);
5777 part
= *scroll_bar_parts
[(int) event
->part
];
5781 Fcons (Qvertical_scroll_bar
,
5782 Fcons (portion_whole
,
5783 Fcons (make_number (event
->timestamp
),
5784 Fcons (part
, Qnil
)))));
5786 /* Always treat scroll bar events as clicks. */
5787 event
->modifiers
|= click_modifier
;
5788 event
->modifiers
&= ~up_modifier
;
5790 if (event
->code
>= ASIZE (mouse_syms
))
5791 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5793 /* Get the symbol we should use for the mouse click. */
5794 head
= modify_event_symbol (event
->code
,
5799 XVECTOR (mouse_syms
)->size
);
5800 return Fcons (head
, Fcons (position
, Qnil
));
5803 #endif /* USE_TOOLKIT_SCROLL_BARS */
5806 case W32_SCROLL_BAR_CLICK_EVENT
:
5808 int button
= event
->code
;
5810 Lisp_Object position
;
5811 Lisp_Object
*start_pos_ptr
;
5812 Lisp_Object start_pos
;
5816 Lisp_Object portion_whole
;
5819 window
= event
->frame_or_window
;
5820 portion_whole
= Fcons (event
->x
, event
->y
);
5821 part
= *scroll_bar_parts
[(int) event
->part
];
5825 Fcons (Qvertical_scroll_bar
,
5826 Fcons (portion_whole
,
5827 Fcons (make_number (event
->timestamp
),
5828 Fcons (part
, Qnil
)))));
5831 /* Always treat W32 scroll bar events as clicks. */
5832 event
->modifiers
|= click_modifier
;
5835 /* Get the symbol we should use for the mouse click. */
5838 head
= modify_event_symbol (button
,
5843 XVECTOR (mouse_syms
)->size
);
5849 #endif /* WINDOWSNT */
5851 case DRAG_N_DROP_EVENT
:
5854 Lisp_Object head
, position
;
5857 /* The frame_or_window field should be a cons of the frame in
5858 which the event occurred and a list of the filenames
5860 if (! CONSP (event
->frame_or_window
))
5863 f
= XFRAME (XCAR (event
->frame_or_window
));
5864 files
= XCDR (event
->frame_or_window
);
5866 /* Ignore mouse events that were made on frames that
5867 have been deleted. */
5868 if (! FRAME_LIVE_P (f
))
5871 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5874 head
= modify_event_symbol (0, event
->modifiers
,
5876 lispy_drag_n_drop_names
,
5877 &drag_n_drop_syms
, 1);
5883 #endif /* HAVE_MOUSE */
5885 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5886 || defined (USE_GTK)
5887 case MENU_BAR_EVENT
:
5888 if (EQ (event
->arg
, event
->frame_or_window
))
5889 /* This is the prefix key. We translate this to
5890 `(menu_bar)' because the code in keyboard.c for menu
5891 events, which we use, relies on this. */
5892 return Fcons (Qmenu_bar
, Qnil
);
5896 case SELECT_WINDOW_EVENT
:
5897 /* Make an event (select-window (WINDOW)). */
5898 return Fcons (Qselect_window
,
5899 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5902 case TOOL_BAR_EVENT
:
5903 if (EQ (event
->arg
, event
->frame_or_window
))
5904 /* This is the prefix key. We translate this to
5905 `(tool_bar)' because the code in keyboard.c for tool bar
5906 events, which we use, relies on this. */
5907 return Fcons (Qtool_bar
, Qnil
);
5908 else if (SYMBOLP (event
->arg
))
5909 return apply_modifiers (event
->modifiers
, event
->arg
);
5912 case USER_SIGNAL_EVENT
:
5913 /* A user signal. */
5914 return *lispy_user_signals
[event
->code
];
5916 case SAVE_SESSION_EVENT
:
5917 return Qsave_session
;
5920 case MAC_APPLE_EVENT
:
5922 Lisp_Object spec
[2];
5926 return Fcons (Qmac_apple_event
,
5927 Fcons (Fvector (2, spec
),
5928 Fcons (mac_make_lispy_event_code (event
->code
),
5933 /* The 'kind' field of the event is something we don't recognize. */
5942 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5944 Lisp_Object bar_window
;
5945 enum scroll_bar_part part
;
5949 /* Is it a scroll bar movement? */
5950 if (frame
&& ! NILP (bar_window
))
5952 Lisp_Object part_sym
;
5954 part_sym
= *scroll_bar_parts
[(int) part
];
5955 return Fcons (Qscroll_bar_movement
,
5956 (Fcons (Fcons (bar_window
,
5957 Fcons (Qvertical_scroll_bar
,
5958 Fcons (Fcons (x
, y
),
5959 Fcons (make_number (time
),
5965 /* Or is it an ordinary mouse movement? */
5968 Lisp_Object position
;
5970 position
= make_lispy_position (frame
, &x
, &y
, time
);
5972 return Fcons (Qmouse_movement
,
5978 #endif /* HAVE_MOUSE */
5980 /* Construct a switch frame event. */
5982 make_lispy_switch_frame (frame
)
5985 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5988 /* Manipulating modifiers. */
5990 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5992 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5993 SYMBOL's name of the end of the modifiers; the string from this
5994 position is the unmodified symbol name.
5996 This doesn't use any caches. */
5999 parse_modifiers_uncached (symbol
, modifier_end
)
6007 CHECK_SYMBOL (symbol
);
6010 name
= SYMBOL_NAME (symbol
);
6012 for (i
= 0; i
+2 <= SBYTES (name
); )
6014 int this_mod_end
= 0;
6017 /* See if the name continues with a modifier word.
6018 Check that the word appears, but don't check what follows it.
6019 Set this_mod and this_mod_end to record what we find. */
6021 switch (SREF (name
, i
))
6023 #define SINGLE_LETTER_MOD(BIT) \
6024 (this_mod_end = i + 1, this_mod = BIT)
6027 SINGLE_LETTER_MOD (alt_modifier
);
6031 SINGLE_LETTER_MOD (ctrl_modifier
);
6035 SINGLE_LETTER_MOD (hyper_modifier
);
6039 SINGLE_LETTER_MOD (meta_modifier
);
6043 SINGLE_LETTER_MOD (shift_modifier
);
6047 SINGLE_LETTER_MOD (super_modifier
);
6050 #undef SINGLE_LETTER_MOD
6052 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6053 if (i + LEN + 1 <= SBYTES (name) \
6054 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6056 this_mod_end = i + LEN; \
6061 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6062 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6063 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6067 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6069 #undef MULTI_LETTER_MOD
6073 /* If we found no modifier, stop looking for them. */
6074 if (this_mod_end
== 0)
6077 /* Check there is a dash after the modifier, so that it
6078 really is a modifier. */
6079 if (this_mod_end
>= SBYTES (name
)
6080 || SREF (name
, this_mod_end
) != '-')
6083 /* This modifier is real; look for another. */
6084 modifiers
|= this_mod
;
6085 i
= this_mod_end
+ 1;
6088 /* Should we include the `click' modifier? */
6089 if (! (modifiers
& (down_modifier
| drag_modifier
6090 | double_modifier
| triple_modifier
))
6091 && i
+ 7 == SBYTES (name
)
6092 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6093 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6094 modifiers
|= click_modifier
;
6102 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6103 prepended to the string BASE[0..BASE_LEN-1].
6104 This doesn't use any caches. */
6106 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6109 int base_len
, base_len_byte
;
6111 /* Since BASE could contain nulls, we can't use intern here; we have
6112 to use Fintern, which expects a genuine Lisp_String, and keeps a
6115 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6121 /* Only the event queue may use the `up' modifier; it should always
6122 be turned into a click or drag event before presented to lisp code. */
6123 if (modifiers
& up_modifier
)
6126 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6127 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6128 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6129 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6130 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6131 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6132 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6133 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6134 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6135 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6136 /* The click modifier is denoted by the absence of other modifiers. */
6140 mod_len
= p
- new_mods
;
6144 Lisp_Object new_name
;
6146 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6147 mod_len
+ base_len_byte
);
6148 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6149 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6151 return Fintern (new_name
, Qnil
);
6156 static char *modifier_names
[] =
6158 "up", "down", "drag", "click", "double", "triple", 0, 0,
6159 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6160 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6162 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6164 static Lisp_Object modifier_symbols
;
6166 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6168 lispy_modifier_list (modifiers
)
6171 Lisp_Object modifier_list
;
6174 modifier_list
= Qnil
;
6175 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6176 if (modifiers
& (1<<i
))
6177 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6180 return modifier_list
;
6184 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6185 where UNMODIFIED is the unmodified form of SYMBOL,
6186 MASK is the set of modifiers present in SYMBOL's name.
6187 This is similar to parse_modifiers_uncached, but uses the cache in
6188 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6189 Qevent_symbol_elements property. */
6192 parse_modifiers (symbol
)
6195 Lisp_Object elements
;
6197 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6198 if (CONSP (elements
))
6203 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6204 Lisp_Object unmodified
;
6207 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6208 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6211 if (modifiers
& ~INTMASK
)
6213 XSETFASTINT (mask
, modifiers
);
6214 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6216 /* Cache the parsing results on SYMBOL. */
6217 Fput (symbol
, Qevent_symbol_element_mask
,
6219 Fput (symbol
, Qevent_symbol_elements
,
6220 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6222 /* Since we know that SYMBOL is modifiers applied to unmodified,
6223 it would be nice to put that in unmodified's cache.
6224 But we can't, since we're not sure that parse_modifiers is
6231 /* Apply the modifiers MODIFIERS to the symbol BASE.
6232 BASE must be unmodified.
6234 This is like apply_modifiers_uncached, but uses BASE's
6235 Qmodifier_cache property, if present. It also builds
6236 Qevent_symbol_elements properties, since it has that info anyway.
6238 apply_modifiers copies the value of BASE's Qevent_kind property to
6239 the modified symbol. */
6241 apply_modifiers (modifiers
, base
)
6245 Lisp_Object cache
, index
, entry
, new_symbol
;
6247 /* Mask out upper bits. We don't know where this value's been. */
6248 modifiers
&= INTMASK
;
6250 /* The click modifier never figures into cache indices. */
6251 cache
= Fget (base
, Qmodifier_cache
);
6252 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6253 entry
= assq_no_quit (index
, cache
);
6256 new_symbol
= XCDR (entry
);
6259 /* We have to create the symbol ourselves. */
6260 new_symbol
= apply_modifiers_uncached (modifiers
,
6261 SDATA (SYMBOL_NAME (base
)),
6262 SCHARS (SYMBOL_NAME (base
)),
6263 SBYTES (SYMBOL_NAME (base
)));
6265 /* Add the new symbol to the base's cache. */
6266 entry
= Fcons (index
, new_symbol
);
6267 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6269 /* We have the parsing info now for free, so we could add it to
6271 XSETFASTINT (index, modifiers);
6272 Fput (new_symbol, Qevent_symbol_element_mask,
6273 Fcons (base, Fcons (index, Qnil)));
6274 Fput (new_symbol, Qevent_symbol_elements,
6275 Fcons (base, lispy_modifier_list (modifiers)));
6276 Sadly, this is only correct if `base' is indeed a base event,
6277 which is not necessarily the case. -stef */
6280 /* Make sure this symbol is of the same kind as BASE.
6282 You'd think we could just set this once and for all when we
6283 intern the symbol above, but reorder_modifiers may call us when
6284 BASE's property isn't set right; we can't assume that just
6285 because it has a Qmodifier_cache property it must have its
6286 Qevent_kind set right as well. */
6287 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6291 kind
= Fget (base
, Qevent_kind
);
6293 Fput (new_symbol
, Qevent_kind
, kind
);
6300 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6301 return a symbol with the modifiers placed in the canonical order.
6302 Canonical order is alphabetical, except for down and drag, which
6303 always come last. The 'click' modifier is never written out.
6305 Fdefine_key calls this to make sure that (for example) C-M-foo
6306 and M-C-foo end up being equivalent in the keymap. */
6309 reorder_modifiers (symbol
)
6312 /* It's hopefully okay to write the code this way, since everything
6313 will soon be in caches, and no consing will be done at all. */
6316 parsed
= parse_modifiers (symbol
);
6317 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6322 /* For handling events, we often want to produce a symbol whose name
6323 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6324 to some base, like the name of a function key or mouse button.
6325 modify_event_symbol produces symbols of this sort.
6327 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6328 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6331 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6332 into symbol names, or a string specifying a name stem used to
6333 construct a symbol name or the form `STEM-N', where N is the decimal
6334 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6335 non-nil; otherwise NAME_TABLE is used.
6337 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6338 persist between calls to modify_event_symbol that it can use to
6339 store a cache of the symbols it's generated for this NAME_TABLE
6340 before. The object stored there may be a vector or an alist.
6342 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6344 MODIFIERS is a set of modifier bits (as given in struct input_events)
6345 whose prefixes should be applied to the symbol name.
6347 SYMBOL_KIND is the value to be placed in the event_kind property of
6348 the returned symbol.
6350 The symbols we create are supposed to have an
6351 `event-symbol-elements' property, which lists the modifiers present
6352 in the symbol's name. */
6355 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6356 name_table
, symbol_table
, table_size
)
6359 Lisp_Object symbol_kind
;
6360 Lisp_Object name_alist_or_stem
;
6362 Lisp_Object
*symbol_table
;
6363 unsigned int table_size
;
6366 Lisp_Object symbol_int
;
6368 /* Get rid of the "vendor-specific" bit here. */
6369 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6371 /* Is this a request for a valid symbol? */
6372 if (symbol_num
< 0 || symbol_num
>= table_size
)
6375 if (CONSP (*symbol_table
))
6376 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6378 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6379 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6380 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6381 we've never used that symbol before. */
6384 if (! VECTORP (*symbol_table
)
6385 || XVECTOR (*symbol_table
)->size
!= table_size
)
6389 XSETFASTINT (size
, table_size
);
6390 *symbol_table
= Fmake_vector (size
, Qnil
);
6393 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6396 /* Have we already used this symbol before? */
6399 /* No; let's create it. */
6400 if (CONSP (name_alist_or_stem
))
6401 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6402 else if (STRINGP (name_alist_or_stem
))
6404 int len
= SBYTES (name_alist_or_stem
);
6405 char *buf
= (char *) alloca (len
+ 50);
6406 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6407 (long) XINT (symbol_int
) + 1);
6408 value
= intern (buf
);
6410 else if (name_table
!= 0 && name_table
[symbol_num
])
6411 value
= intern (name_table
[symbol_num
]);
6413 #ifdef HAVE_WINDOW_SYSTEM
6416 char *name
= x_get_keysym_name (symbol_num
);
6418 value
= intern (name
);
6425 sprintf (buf
, "key-%d", symbol_num
);
6426 value
= intern (buf
);
6429 if (CONSP (*symbol_table
))
6430 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6432 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6434 /* Fill in the cache entries for this symbol; this also
6435 builds the Qevent_symbol_elements property, which the user
6437 apply_modifiers (modifiers
& click_modifier
, value
);
6438 Fput (value
, Qevent_kind
, symbol_kind
);
6441 /* Apply modifiers to that symbol. */
6442 return apply_modifiers (modifiers
, value
);
6445 /* Convert a list that represents an event type,
6446 such as (ctrl meta backspace), into the usual representation of that
6447 event type as a number or a symbol. */
6449 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6450 doc
: /* Convert the event description list EVENT-DESC to an event type.
6451 EVENT-DESC should contain one base event type (a character or symbol)
6452 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6453 drag, down, double or triple). The base must be last.
6454 The return value is an event type (a character or symbol) which
6455 has the same base event type and all the specified modifiers. */)
6457 Lisp_Object event_desc
;
6465 while (CONSP (rest
))
6473 /* Given a symbol, see if it is a modifier name. */
6474 if (SYMBOLP (elt
) && CONSP (rest
))
6475 this = parse_solitary_modifier (elt
);
6479 else if (!NILP (base
))
6480 error ("Two bases given in one event");
6486 /* Let the symbol A refer to the character A. */
6487 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6488 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6490 if (INTEGERP (base
))
6492 /* Turn (shift a) into A. */
6493 if ((modifiers
& shift_modifier
) != 0
6494 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6496 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6497 modifiers
&= ~shift_modifier
;
6500 /* Turn (control a) into C-a. */
6501 if (modifiers
& ctrl_modifier
)
6502 return make_number ((modifiers
& ~ctrl_modifier
)
6503 | make_ctrl_char (XINT (base
)));
6505 return make_number (modifiers
| XINT (base
));
6507 else if (SYMBOLP (base
))
6508 return apply_modifiers (modifiers
, base
);
6511 error ("Invalid base event");
6516 /* Try to recognize SYMBOL as a modifier name.
6517 Return the modifier flag bit, or 0 if not recognized. */
6520 parse_solitary_modifier (symbol
)
6523 Lisp_Object name
= SYMBOL_NAME (symbol
);
6525 switch (SREF (name
, 0))
6527 #define SINGLE_LETTER_MOD(BIT) \
6528 if (SBYTES (name) == 1) \
6531 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6532 if (LEN == SBYTES (name) \
6533 && ! strncmp (SDATA (name), NAME, LEN)) \
6537 SINGLE_LETTER_MOD (alt_modifier
);
6541 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6545 SINGLE_LETTER_MOD (ctrl_modifier
);
6549 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6550 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6554 SINGLE_LETTER_MOD (hyper_modifier
);
6558 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6562 SINGLE_LETTER_MOD (meta_modifier
);
6566 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6570 SINGLE_LETTER_MOD (shift_modifier
);
6574 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6575 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6576 SINGLE_LETTER_MOD (super_modifier
);
6580 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6581 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6582 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6586 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6589 #undef SINGLE_LETTER_MOD
6590 #undef MULTI_LETTER_MOD
6596 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6597 Such a list is not valid as an event,
6598 but it can be a Lucid-style event type list. */
6601 lucid_event_type_list_p (object
)
6606 if (! CONSP (object
))
6609 if (EQ (XCAR (object
), Qhelp_echo
)
6610 || EQ (XCAR (object
), Qvertical_line
)
6611 || EQ (XCAR (object
), Qmode_line
)
6612 || EQ (XCAR (object
), Qheader_line
))
6615 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6619 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6626 /* Store into *addr a value nonzero if terminal input chars are available.
6627 Serves the purpose of ioctl (0, FIONREAD, addr)
6628 but works even if FIONREAD does not exist.
6629 (In fact, this may actually read some input.)
6631 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6632 timer events that are ripe.
6633 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6634 events (FOCUS_IN_EVENT).
6635 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6636 movements and toolkit scroll bar thumb drags. */
6639 get_input_pending (addr
, flags
)
6643 /* First of all, have we already counted some input? */
6644 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6646 /* If input is being read as it arrives, and we have none, there is none. */
6647 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6650 /* Try to read some input and see how much we get. */
6652 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6655 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6658 gobble_input (expected
)
6663 if (interrupt_input
)
6666 mask
= sigblock (sigmask (SIGIO
));
6667 read_avail_input (expected
);
6671 #ifdef POLL_FOR_INPUT
6672 /* XXX This condition was (read_socket_hook && !interrupt_input),
6673 but read_socket_hook is not global anymore. Let's pretend that
6675 if (!interrupt_input
&& poll_suppress_count
== 0)
6678 mask
= sigblock (sigmask (SIGALRM
));
6679 read_avail_input (expected
);
6685 read_avail_input (expected
);
6689 /* Put a BUFFER_SWITCH_EVENT in the buffer
6690 so that read_key_sequence will notice the new current buffer. */
6693 record_asynch_buffer_change ()
6695 struct input_event event
;
6699 event
.kind
= BUFFER_SWITCH_EVENT
;
6700 event
.frame_or_window
= Qnil
;
6704 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6705 The purpose of the event is to make read_key_sequence look up the
6706 keymaps again. If we aren't in read_key_sequence, we don't need one,
6707 and the event could cause trouble by messing up (input-pending-p). */
6708 tem
= Fwaiting_for_user_input_p ();
6712 /* We never need these events if we have no asynchronous subprocesses. */
6716 /* Make sure no interrupt happens while storing the event. */
6718 if (interrupt_input
)
6721 mask
= sigblock (sigmask (SIGIO
));
6722 kbd_buffer_store_event (&event
);
6729 kbd_buffer_store_event (&event
);
6736 /* Read any terminal input already buffered up by the system
6737 into the kbd_buffer, but do not wait.
6739 EXPECTED should be nonzero if the caller knows there is some input.
6741 Except on VMS, all input is read by this function.
6742 If interrupt_input is nonzero, this function MUST be called
6743 only when SIGIO is blocked.
6745 Returns the number of keyboard chars read, or -1 meaning
6746 this is a bad time to try to read input. */
6749 read_avail_input (expected
)
6756 /* Loop through the available devices, and call their input hooks. */
6760 struct device
*next
= d
->next_device
;
6762 if (d
->read_socket_hook
)
6765 struct input_event hold_quit
;
6767 EVENT_INIT (hold_quit
);
6768 hold_quit
.kind
= NO_EVENT
;
6770 /* No need for FIONREAD or fcntl; just say don't wait. */
6771 while (nr
= (*d
->read_socket_hook
) (d
, expected
, &hold_quit
), nr
> 0)
6777 if (nr
== -1) /* Not OK to read input now. */
6781 else if (nr
== -2) /* Non-transient error. */
6783 /* The display device terminated; it should be closed. */
6785 /* Kill Emacs if this was our last display. */
6786 if (! device_list
->next_device
)
6787 /* Formerly simply reported no input, but that
6788 sometimes led to a failure of Emacs to terminate.
6789 SIGHUP seems appropriate if we can't reach the
6791 /* ??? Is it really right to send the signal just to
6792 this process rather than to the whole process
6793 group? Perhaps on systems with FIONREAD Emacs is
6794 alone in its group. */
6795 kill (getpid (), SIGHUP
);
6797 /* XXX Is calling delete_device safe here? It calls Fdelete_frame. */
6798 if (d
->delete_device_hook
)
6799 (*d
->delete_device_hook
) (d
);
6804 if (hold_quit
.kind
!= NO_EVENT
)
6805 kbd_buffer_store_event (&hold_quit
);
6817 /* This is the tty way of reading available input.
6819 Note that each terminal device has its own `struct device' object,
6820 and so this function is called once for each individual termcap
6821 display. The first parameter indicates which device to read from. */
6824 tty_read_avail_input (struct device
*device
,
6826 struct input_event
*hold_quit
)
6828 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6829 the kbd_buffer can really hold. That may prevent loss
6830 of characters on some systems when input is stuffed at us. */
6831 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6833 struct tty_display_info
*tty
= device
->display_info
.tty
;
6836 if (device
->type
!= output_termcap
)
6839 /* XXX I think the following code should be moved to separate hook
6840 functions in system-dependent files. */
6843 #else /* not WINDOWSNT */
6845 n_to_read
= dos_keysns ();
6849 cbuf
[0] = dos_keyread ();
6852 #else /* not MSDOS */
6854 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6858 return 0; /* The terminal is suspended. */
6860 /* Determine how many characters we should *try* to read. */
6862 /* Find out how much input is available. */
6863 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6865 if (! noninteractive
)
6866 return -2; /* Close this device. */
6872 if (n_to_read
> sizeof cbuf
)
6873 n_to_read
= sizeof cbuf
;
6874 #else /* no FIONREAD */
6875 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6876 /* Read some input if available, but don't wait. */
6877 n_to_read
= sizeof cbuf
;
6878 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6884 /* Now read; for one reason or another, this will not block.
6885 NREAD is set to the number of chars read. */
6888 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6889 /* POSIX infers that processes which are not in the session leader's
6890 process group won't get SIGHUP's at logout time. BSDI adheres to
6891 this part standard and returns -1 from read (0) with errno==EIO
6892 when the control tty is taken away.
6893 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6894 if (nread
== -1 && errno
== EIO
)
6895 return -2; /* Close this device. */
6896 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6897 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6898 This looks incorrect, but it isn't, because _BSD causes
6899 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6900 and that causes a value other than 0 when there is no input. */
6902 return -2; /* Close this device. */
6906 /* We used to retry the read if it was interrupted.
6907 But this does the wrong thing when O_NDELAY causes
6908 an EAGAIN error. Does anybody know of a situation
6909 where a retry is actually needed? */
6911 nread
< 0 && (errno
== EAGAIN
6925 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6926 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6927 #endif /* USG or DGUX or CYGWIN */
6928 #endif /* no FIONREAD */
6933 #endif /* not MSDOS */
6934 #endif /* not WINDOWSNT */
6936 for (i
= 0; i
< nread
; i
++)
6938 struct input_event buf
;
6940 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6942 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6943 buf
.modifiers
= meta_modifier
;
6944 if (tty
->meta_key
!= 2)
6948 /* Set the frame corresponding to the active tty. Note that the
6949 value of selected_frame is not reliable here, redisplay tends
6950 to temporarily change it. */
6951 buf
.frame_or_window
= tty
->top_frame
;
6954 kbd_buffer_store_event (&buf
);
6955 /* Don't look at input that follows a C-g too closely.
6956 This reduces lossage due to autorepeat on C-g. */
6957 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6958 && buf
.code
== quit_char
)
6964 #endif /* not VMS */
6967 handle_async_input ()
6970 extern int select_alarmed
;
6973 interrupt_input_pending
= 0;
6978 nread
= read_avail_input (1);
6979 /* -1 means it's not ok to read the input now.
6980 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6981 0 means there was no keyboard input available. */
6986 select_alarmed
= 1; /* Force the select emulator back to life */
6991 #ifdef SIGIO /* for entire page */
6992 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6995 input_available_signal (signo
)
6998 /* Must preserve main program's value of errno. */
6999 int old_errno
= errno
;
7000 #if defined (USG) && !defined (POSIX_SIGNALS)
7001 /* USG systems forget handlers when they are used;
7002 must reestablish each time */
7003 signal (signo
, input_available_signal
);
7011 interrupt_input_pending
= 1;
7013 SIGNAL_THREAD_CHECK (signo
);
7016 if (input_available_clear_time
)
7017 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7020 handle_async_input ();
7030 /* Send ourselves a SIGIO.
7032 This function exists so that the UNBLOCK_INPUT macro in
7033 blockinput.h can have some way to take care of input we put off
7034 dealing with, without assuming that every file which uses
7035 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7037 reinvoke_input_signal ()
7040 handle_async_input ();
7046 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7047 static Lisp_Object menu_bar_one_keymap_changed_items
;
7049 /* These variables hold the vector under construction within
7050 menu_bar_items and its subroutines, and the current index
7051 for storing into that vector. */
7052 static Lisp_Object menu_bar_items_vector
;
7053 static int menu_bar_items_index
;
7055 /* Return a vector of menu items for a menu bar, appropriate
7056 to the current buffer. Each item has three elements in the vector:
7059 OLD is an old vector we can optionally reuse, or nil. */
7062 menu_bar_items (old
)
7065 /* The number of keymaps we're scanning right now, and the number of
7066 keymaps we have allocated space for. */
7069 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7070 in the current keymaps, or nil where it is not a prefix. */
7073 Lisp_Object def
, tail
;
7082 /* In order to build the menus, we need to call the keymap
7083 accessors. They all call QUIT. But this function is called
7084 during redisplay, during which a quit is fatal. So inhibit
7085 quitting while building the menus.
7086 We do this instead of specbind because (1) errors will clear it anyway
7087 and (2) this avoids risk of specpdl overflow. */
7088 oquit
= Vinhibit_quit
;
7092 menu_bar_items_vector
= old
;
7094 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7095 menu_bar_items_index
= 0;
7097 /* Build our list of keymaps.
7098 If we recognize a function key and replace its escape sequence in
7099 keybuf with its symbol, or if the sequence starts with a mouse
7100 click and we need to switch buffers, we jump back here to rebuild
7101 the initial keymaps from the current buffer. */
7105 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7106 if (!NILP (Voverriding_local_map_menu_flag
))
7108 /* Yes, use them (if non-nil) as well as the global map. */
7109 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7111 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7112 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7113 if (!NILP (Voverriding_local_map
))
7114 maps
[nmaps
++] = Voverriding_local_map
;
7118 /* No, so use major and minor mode keymaps and keymap property.
7119 Note that menu-bar bindings in the local-map and keymap
7120 properties may not work reliable, as they are only
7121 recognized when the menu-bar (or mode-line) is updated,
7122 which does not normally happen after every command. */
7125 nminor
= current_minor_maps (NULL
, &tmaps
);
7126 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7128 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7129 maps
[nmaps
++] = tem
;
7130 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7132 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7134 maps
[nmaps
++] = current_global_map
;
7137 /* Look up in each map the dummy prefix key `menu-bar'. */
7141 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7142 if (!NILP (maps
[mapno
]))
7144 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7148 menu_bar_one_keymap_changed_items
= Qnil
;
7149 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7153 /* Move to the end those items that should be at the end. */
7155 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7158 int end
= menu_bar_items_index
;
7160 for (i
= 0; i
< end
; i
+= 4)
7161 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7163 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7164 /* Move the item at index I to the end,
7165 shifting all the others forward. */
7166 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7167 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7168 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7169 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7171 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7172 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7173 (end
- i
- 4) * sizeof (Lisp_Object
));
7174 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7175 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7176 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7177 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7182 /* Add nil, nil, nil, nil at the end. */
7183 i
= menu_bar_items_index
;
7184 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7187 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7188 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7189 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7190 menu_bar_items_vector
= tem
;
7192 /* Add this item. */
7193 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7194 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7195 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7196 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7197 menu_bar_items_index
= i
;
7199 Vinhibit_quit
= oquit
;
7200 return menu_bar_items_vector
;
7203 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7204 If there's already an item for KEY, add this DEF to it. */
7206 Lisp_Object item_properties
;
7209 menu_bar_item (key
, item
, dummy1
, dummy2
)
7210 Lisp_Object key
, item
, dummy1
;
7213 struct gcpro gcpro1
;
7217 if (EQ (item
, Qundefined
))
7219 /* If a map has an explicit `undefined' as definition,
7220 discard any previously made menu bar item. */
7222 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7223 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7225 if (menu_bar_items_index
> i
+ 4)
7226 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7227 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7228 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7229 menu_bar_items_index
-= 4;
7233 /* If this keymap has already contributed to this KEY,
7234 don't contribute to it a second time. */
7235 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7236 if (!NILP (tem
) || NILP (item
))
7239 menu_bar_one_keymap_changed_items
7240 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7242 /* We add to menu_bar_one_keymap_changed_items before doing the
7243 parse_menu_item, so that if it turns out it wasn't a menu item,
7244 it still correctly hides any further menu item. */
7246 i
= parse_menu_item (item
, 0, 1);
7251 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7253 /* Find any existing item for this KEY. */
7254 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7255 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7258 /* If we did not find this KEY, add it at the end. */
7259 if (i
== menu_bar_items_index
)
7261 /* If vector is too small, get a bigger one. */
7262 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7265 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7266 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7267 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7268 menu_bar_items_vector
= tem
;
7271 /* Add this item. */
7272 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7273 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7274 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7275 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7276 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7277 menu_bar_items_index
= i
;
7279 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7283 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7284 /* If the new and the old items are not both keymaps,
7285 the lookup will only find `item'. */
7286 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7287 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7291 /* This is used as the handler when calling menu_item_eval_property. */
7293 menu_item_eval_property_1 (arg
)
7296 /* If we got a quit from within the menu computation,
7297 quit all the way out of it. This takes care of C-] in the debugger. */
7298 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7299 Fsignal (Qquit
, Qnil
);
7304 /* Evaluate an expression and return the result (or nil if something
7305 went wrong). Used to evaluate dynamic parts of menu items. */
7307 menu_item_eval_property (sexpr
)
7310 int count
= SPECPDL_INDEX ();
7312 specbind (Qinhibit_redisplay
, Qt
);
7313 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7314 menu_item_eval_property_1
);
7315 return unbind_to (count
, val
);
7318 /* This function parses a menu item and leaves the result in the
7319 vector item_properties.
7320 ITEM is a key binding, a possible menu item.
7321 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7322 evaluate dynamic expressions in the menu item.
7323 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7325 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7326 parse_menu_item returns true if the item is a menu item and false
7330 parse_menu_item (item
, notreal
, inmenubar
)
7332 int notreal
, inmenubar
;
7334 Lisp_Object def
, tem
, item_string
, start
;
7335 Lisp_Object cachelist
;
7337 Lisp_Object keyhint
;
7348 /* Create item_properties vector if necessary. */
7349 if (NILP (item_properties
))
7351 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7353 /* Initialize optional entries. */
7354 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7355 AREF (item_properties
, i
) = Qnil
;
7356 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7358 /* Save the item here to protect it from GC. */
7359 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7361 item_string
= XCAR (item
);
7365 if (STRINGP (item_string
))
7367 /* Old format menu item. */
7368 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7370 /* Maybe help string. */
7371 if (CONSP (item
) && STRINGP (XCAR (item
)))
7373 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7378 /* Maybe key binding cache. */
7379 if (CONSP (item
) && CONSP (XCAR (item
))
7380 && (NILP (XCAR (XCAR (item
)))
7381 || VECTORP (XCAR (XCAR (item
)))))
7383 cachelist
= XCAR (item
);
7387 /* This is the real definition--the function to run. */
7388 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7390 /* Get enable property, if any. */
7393 tem
= Fget (item
, Qmenu_enable
);
7395 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7398 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7400 /* New format menu item. */
7401 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7402 start
= XCDR (item
);
7405 /* We have a real binding. */
7406 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7408 item
= XCDR (start
);
7409 /* Is there a cache list with key equivalences. */
7410 if (CONSP (item
) && CONSP (XCAR (item
)))
7412 cachelist
= XCAR (item
);
7416 /* Parse properties. */
7417 while (CONSP (item
) && CONSP (XCDR (item
)))
7422 if (EQ (tem
, QCenable
))
7423 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7424 else if (EQ (tem
, QCvisible
) && !notreal
)
7426 /* If got a visible property and that evaluates to nil
7427 then ignore this item. */
7428 tem
= menu_item_eval_property (XCAR (item
));
7432 else if (EQ (tem
, QChelp
))
7433 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7434 else if (EQ (tem
, QCfilter
))
7436 else if (EQ (tem
, QCkey_sequence
))
7439 if (NILP (cachelist
)
7440 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7441 /* Be GC protected. Set keyhint to item instead of tem. */
7444 else if (EQ (tem
, QCkeys
))
7447 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7448 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7450 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7455 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7457 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7459 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7466 else if (inmenubar
|| !NILP (start
))
7470 return 0; /* not a menu item */
7472 /* If item string is not a string, evaluate it to get string.
7473 If we don't get a string, skip this item. */
7474 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7475 if (!(STRINGP (item_string
) || notreal
))
7477 item_string
= menu_item_eval_property (item_string
);
7478 if (!STRINGP (item_string
))
7480 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7483 /* If got a filter apply it on definition. */
7484 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7487 def
= menu_item_eval_property (list2 (XCAR (filter
),
7488 list2 (Qquote
, def
)));
7490 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7493 /* Enable or disable selection of item. */
7494 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7500 tem
= menu_item_eval_property (tem
);
7501 if (inmenubar
&& NILP (tem
))
7502 return 0; /* Ignore disabled items in menu bar. */
7503 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7506 /* If we got no definition, this item is just unselectable text which
7507 is OK in a submenu but not in the menubar. */
7509 return (inmenubar
? 0 : 1);
7511 /* See if this is a separate pane or a submenu. */
7512 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7513 tem
= get_keymap (def
, 0, 1);
7514 /* For a subkeymap, just record its details and exit. */
7517 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7518 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7522 /* At the top level in the menu bar, do likewise for commands also.
7523 The menu bar does not display equivalent key bindings anyway.
7524 ITEM_PROPERTY_DEF is already set up properly. */
7528 /* This is a command. See if there is an equivalent key binding. */
7529 if (NILP (cachelist
))
7531 /* We have to create a cachelist. */
7532 CHECK_IMPURE (start
);
7533 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7534 cachelist
= XCAR (XCDR (start
));
7536 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7537 if (!NILP (keyhint
))
7539 XSETCAR (cachelist
, XCAR (keyhint
));
7542 else if (STRINGP (tem
))
7544 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7545 XSETCAR (cachelist
, Qt
);
7549 tem
= XCAR (cachelist
);
7556 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7558 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7561 def
= XCAR (prefix
);
7562 prefix
= XCDR (prefix
);
7565 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7567 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7569 if (newcache
/* Always check first time. */
7570 /* Should we check everything when precomputing key
7572 /* If something had no key binding before, don't recheck it
7573 because that is too slow--except if we have a list of
7574 rebound commands in Vdefine_key_rebound_commands, do
7575 recheck any command that appears in that list. */
7576 || (CONSP (Vdefine_key_rebound_commands
)
7577 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7580 /* We had a saved key. Is it still bound to the command? */
7583 /* If the command is an alias for another
7584 (such as lmenu.el set it up), check if the
7585 original command matches the cached command. */
7586 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7587 chkcache
= 1; /* Need to recompute key binding. */
7591 /* Recompute equivalent key binding. If the command is an alias
7592 for another (such as lmenu.el set it up), see if the original
7593 command name has equivalent keys. Otherwise look up the
7594 specified command itself. We don't try both, because that
7595 makes lmenu menus slow. */
7597 && SYMBOLP (XSYMBOL (def
)->function
)
7598 && ! NILP (Fget (def
, Qmenu_alias
)))
7599 def
= XSYMBOL (def
)->function
;
7600 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7601 XSETCAR (cachelist
, tem
);
7604 XSETCDR (cachelist
, Qnil
);
7608 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7610 tem
= XCAR (cachelist
);
7614 newcache
= chkcache
;
7617 tem
= Fkey_description (tem
, Qnil
);
7620 if (STRINGP (XCAR (prefix
)))
7621 tem
= concat2 (XCAR (prefix
), tem
);
7622 if (STRINGP (XCDR (prefix
)))
7623 tem
= concat2 (tem
, XCDR (prefix
));
7625 XSETCDR (cachelist
, tem
);
7629 tem
= XCDR (cachelist
);
7630 if (newcache
&& !NILP (tem
))
7632 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7633 XSETCDR (cachelist
, tem
);
7636 /* If we only want to precompute equivalent key bindings, stop here. */
7640 /* If we have an equivalent key binding, use that. */
7641 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7643 /* Include this when menu help is implemented.
7644 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7645 if (!(NILP (tem) || STRINGP (tem)))
7647 tem = menu_item_eval_property (tem);
7650 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7654 /* Handle radio buttons or toggle boxes. */
7655 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7657 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7658 = menu_item_eval_property (tem
);
7665 /***********************************************************************
7667 ***********************************************************************/
7669 /* A vector holding tool bar items while they are parsed in function
7670 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7673 static Lisp_Object tool_bar_items_vector
;
7675 /* A vector holding the result of parse_tool_bar_item. Layout is like
7676 the one for a single item in tool_bar_items_vector. */
7678 static Lisp_Object tool_bar_item_properties
;
7680 /* Next free index in tool_bar_items_vector. */
7682 static int ntool_bar_items
;
7684 /* The symbols `tool-bar', and `:image'. */
7686 extern Lisp_Object Qtool_bar
;
7687 Lisp_Object QCimage
;
7689 /* Function prototypes. */
7691 static void init_tool_bar_items
P_ ((Lisp_Object
));
7692 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7693 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7694 static void append_tool_bar_item
P_ ((void));
7697 /* Return a vector of tool bar items for keymaps currently in effect.
7698 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7699 tool bar items found. */
7702 tool_bar_items (reuse
, nitems
)
7713 /* In order to build the menus, we need to call the keymap
7714 accessors. They all call QUIT. But this function is called
7715 during redisplay, during which a quit is fatal. So inhibit
7716 quitting while building the menus. We do this instead of
7717 specbind because (1) errors will clear it anyway and (2) this
7718 avoids risk of specpdl overflow. */
7719 oquit
= Vinhibit_quit
;
7722 /* Initialize tool_bar_items_vector and protect it from GC. */
7723 init_tool_bar_items (reuse
);
7725 /* Build list of keymaps in maps. Set nmaps to the number of maps
7728 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7729 if (!NILP (Voverriding_local_map_menu_flag
))
7731 /* Yes, use them (if non-nil) as well as the global map. */
7732 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7734 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7735 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7736 if (!NILP (Voverriding_local_map
))
7737 maps
[nmaps
++] = Voverriding_local_map
;
7741 /* No, so use major and minor mode keymaps and keymap property.
7742 Note that tool-bar bindings in the local-map and keymap
7743 properties may not work reliable, as they are only
7744 recognized when the tool-bar (or mode-line) is updated,
7745 which does not normally happen after every command. */
7748 nminor
= current_minor_maps (NULL
, &tmaps
);
7749 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7751 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7752 maps
[nmaps
++] = tem
;
7753 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7755 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7758 /* Add global keymap at the end. */
7759 maps
[nmaps
++] = current_global_map
;
7761 /* Process maps in reverse order and look up in each map the prefix
7763 for (i
= nmaps
- 1; i
>= 0; --i
)
7764 if (!NILP (maps
[i
]))
7768 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7773 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7774 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7776 Lisp_Object keydef
= XCAR (tail
);
7778 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7783 Vinhibit_quit
= oquit
;
7784 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7785 return tool_bar_items_vector
;
7789 /* Process the definition of KEY which is DEF. */
7792 process_tool_bar_item (key
, def
)
7793 Lisp_Object key
, def
;
7796 extern Lisp_Object Qundefined
;
7797 struct gcpro gcpro1
, gcpro2
;
7799 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7803 if (EQ (def
, Qundefined
))
7805 /* If a map has an explicit `undefined' as definition,
7806 discard any previously made item. */
7807 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7809 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7811 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7813 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7814 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7815 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7816 * sizeof (Lisp_Object
)));
7817 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7822 else if (parse_tool_bar_item (key
, def
))
7823 /* Append a new tool bar item to tool_bar_items_vector. Accept
7824 more than one definition for the same key. */
7825 append_tool_bar_item ();
7831 /* Parse a tool bar item specification ITEM for key KEY and return the
7832 result in tool_bar_item_properties. Value is zero if ITEM is
7835 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7837 CAPTION is the caption of the item, If it's not a string, it is
7838 evaluated to get a string.
7840 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7841 as binding are currently ignored.
7843 The following properties are recognized:
7847 FORM is evaluated and specifies whether the tool bar item is
7848 enabled or disabled.
7852 FORM is evaluated and specifies whether the tool bar item is visible.
7854 - `:filter FUNCTION'
7856 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7857 result is stored as the new binding.
7859 - `:button (TYPE SELECTED)'
7861 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7862 and specifies whether the button is selected (pressed) or not.
7866 IMAGES is either a single image specification or a vector of four
7867 image specifications. See enum tool_bar_item_images.
7869 - `:help HELP-STRING'.
7871 Gives a help string to display for the tool bar item. */
7874 parse_tool_bar_item (key
, item
)
7875 Lisp_Object key
, item
;
7877 /* Access slot with index IDX of vector tool_bar_item_properties. */
7878 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7880 Lisp_Object filter
= Qnil
;
7881 Lisp_Object caption
;
7884 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7885 Rule out items that aren't lists, don't start with
7886 `menu-item' or whose rest following `tool-bar-item' is not a
7889 || !EQ (XCAR (item
), Qmenu_item
)
7890 || (item
= XCDR (item
),
7894 /* Create tool_bar_item_properties vector if necessary. Reset it to
7896 if (VECTORP (tool_bar_item_properties
))
7898 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7902 tool_bar_item_properties
7903 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7906 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7907 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7909 /* Get the caption of the item. If the caption is not a string,
7910 evaluate it to get a string. If we don't get a string, skip this
7912 caption
= XCAR (item
);
7913 if (!STRINGP (caption
))
7915 caption
= menu_item_eval_property (caption
);
7916 if (!STRINGP (caption
))
7919 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7921 /* Give up if rest following the caption is not a list. */
7926 /* Store the binding. */
7927 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7930 /* Ignore cached key binding, if any. */
7931 if (CONSP (item
) && CONSP (XCAR (item
)))
7934 /* Process the rest of the properties. */
7935 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7937 Lisp_Object key
, value
;
7940 value
= XCAR (XCDR (item
));
7942 if (EQ (key
, QCenable
))
7943 /* `:enable FORM'. */
7944 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7945 else if (EQ (key
, QCvisible
))
7947 /* `:visible FORM'. If got a visible property and that
7948 evaluates to nil then ignore this item. */
7949 if (NILP (menu_item_eval_property (value
)))
7952 else if (EQ (key
, QChelp
))
7953 /* `:help HELP-STRING'. */
7954 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7955 else if (EQ (key
, QCfilter
))
7956 /* ':filter FORM'. */
7958 else if (EQ (key
, QCbutton
) && CONSP (value
))
7960 /* `:button (TYPE . SELECTED)'. */
7961 Lisp_Object type
, selected
;
7963 type
= XCAR (value
);
7964 selected
= XCDR (value
);
7965 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7967 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7968 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7971 else if (EQ (key
, QCimage
)
7973 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7974 /* Value is either a single image specification or a vector
7975 of 4 such specifications for the different button states. */
7976 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7979 /* If got a filter apply it on binding. */
7981 PROP (TOOL_BAR_ITEM_BINDING
)
7982 = menu_item_eval_property (list2 (filter
,
7984 PROP (TOOL_BAR_ITEM_BINDING
))));
7986 /* See if the binding is a keymap. Give up if it is. */
7987 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7990 /* Enable or disable selection of item. */
7991 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7992 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7993 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7995 /* Handle radio buttons or toggle boxes. */
7996 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7997 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7998 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8006 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8007 that can be reused. */
8010 init_tool_bar_items (reuse
)
8013 if (VECTORP (reuse
))
8014 tool_bar_items_vector
= reuse
;
8016 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8017 ntool_bar_items
= 0;
8021 /* Append parsed tool bar item properties from
8022 tool_bar_item_properties */
8025 append_tool_bar_item ()
8027 Lisp_Object
*to
, *from
;
8029 /* Enlarge tool_bar_items_vector if necessary. */
8030 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8031 >= XVECTOR (tool_bar_items_vector
)->size
)
8033 Lisp_Object new_vector
;
8034 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
8036 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
8037 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
8038 XVECTOR (new_vector
)->contents
,
8039 old_size
* sizeof (Lisp_Object
));
8040 tool_bar_items_vector
= new_vector
;
8043 /* Append entries from tool_bar_item_properties to the end of
8044 tool_bar_items_vector. */
8045 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8046 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8047 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8048 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8055 /* Read a character using menus based on maps in the array MAPS.
8056 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8057 Return t if we displayed a menu but the user rejected it.
8059 PREV_EVENT is the previous input event, or nil if we are reading
8060 the first event of a key sequence.
8062 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8063 if we used a mouse menu to read the input, or zero otherwise. If
8064 USED_MOUSE_MENU is null, we don't dereference it.
8066 The prompting is done based on the prompt-string of the map
8067 and the strings associated with various map elements.
8069 This can be done with X menus or with menus put in the minibuf.
8070 These are done in different ways, depending on how the input will be read.
8071 Menus using X are done after auto-saving in read-char, getting the input
8072 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8073 and do auto-saving in the inner call of read_char. */
8076 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8079 Lisp_Object prev_event
;
8080 int *used_mouse_menu
;
8083 register Lisp_Object name
= Qnil
;
8085 if (used_mouse_menu
)
8086 *used_mouse_menu
= 0;
8088 /* Use local over global Menu maps */
8090 if (! menu_prompting
)
8093 /* Optionally disregard all but the global map. */
8094 if (inhibit_local_menu_bar_menus
)
8096 maps
+= (nmaps
- 1);
8100 /* Get the menu name from the first map that has one (a prompt string). */
8101 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8103 name
= Fkeymap_prompt (maps
[mapno
]);
8108 /* If we don't have any menus, just read a character normally. */
8109 if (!STRINGP (name
))
8113 /* If we got to this point via a mouse click,
8114 use a real menu for mouse selection. */
8115 if (EVENT_HAS_PARAMETERS (prev_event
)
8116 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8117 && !EQ (XCAR (prev_event
), Qtool_bar
))
8119 /* Display the menu and get the selection. */
8120 Lisp_Object
*realmaps
8121 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8125 /* Use the maps that are not nil. */
8126 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8127 if (!NILP (maps
[mapno
]))
8128 realmaps
[nmaps1
++] = maps
[mapno
];
8130 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8135 record_menu_key (XCAR (value
));
8137 /* If we got multiple events, unread all but
8139 There is no way to prevent those unread events
8140 from showing up later in last_nonmenu_event.
8141 So turn symbol and integer events into lists,
8142 to indicate that they came from a mouse menu,
8143 so that when present in last_nonmenu_event
8144 they won't confuse things. */
8145 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8147 record_menu_key (XCAR (tem
));
8148 if (SYMBOLP (XCAR (tem
))
8149 || INTEGERP (XCAR (tem
)))
8150 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8153 /* If we got more than one event, put all but the first
8154 onto this list to be read later.
8155 Return just the first event now. */
8156 Vunread_command_events
8157 = nconc2 (XCDR (value
), Vunread_command_events
);
8158 value
= XCAR (value
);
8160 else if (NILP (value
))
8162 if (used_mouse_menu
)
8163 *used_mouse_menu
= 1;
8166 #endif /* HAVE_MENUS */
8170 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8171 We make this bigger when necessary, and never free it. */
8172 static char *read_char_minibuf_menu_text
;
8173 /* Size of that buffer. */
8174 static int read_char_minibuf_menu_width
;
8177 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8183 register Lisp_Object name
;
8185 /* FIXME: Use the minibuffer's frame width. */
8186 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8189 Lisp_Object rest
, vector
;
8195 if (! menu_prompting
)
8198 /* Make sure we have a big enough buffer for the menu text. */
8199 if (read_char_minibuf_menu_text
== 0)
8201 read_char_minibuf_menu_width
= width
+ 4;
8202 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8204 else if (width
+ 4 > read_char_minibuf_menu_width
)
8206 read_char_minibuf_menu_width
= width
+ 4;
8207 read_char_minibuf_menu_text
8208 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8210 menu
= read_char_minibuf_menu_text
;
8212 /* Get the menu name from the first map that has one (a prompt string). */
8213 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8215 name
= Fkeymap_prompt (maps
[mapno
]);
8220 /* If we don't have any menus, just read a character normally. */
8221 if (!STRINGP (name
))
8224 /* Prompt string always starts with map's prompt, and a space. */
8225 strcpy (menu
, SDATA (name
));
8226 nlength
= SBYTES (name
);
8227 menu
[nlength
++] = ':';
8228 menu
[nlength
++] = ' ';
8231 /* Start prompting at start of first map. */
8235 /* Present the documented bindings, a line at a time. */
8242 Lisp_Object orig_defn_macro
;
8244 /* Loop over elements of map. */
8249 /* If reached end of map, start at beginning of next map. */
8253 /* At end of last map, wrap around to first map if just starting,
8254 or end this line if already have something on it. */
8258 if (notfirst
|| nobindings
) break;
8263 /* Look at the next element of the map. */
8265 elt
= XVECTOR (vector
)->contents
[idx
];
8267 elt
= Fcar_safe (rest
);
8269 if (idx
< 0 && VECTORP (elt
))
8271 /* If we found a dense table in the keymap,
8272 advanced past it, but start scanning its contents. */
8273 rest
= Fcdr_safe (rest
);
8279 /* An ordinary element. */
8280 Lisp_Object event
, tem
;
8284 event
= Fcar_safe (elt
); /* alist */
8285 elt
= Fcdr_safe (elt
);
8289 XSETINT (event
, idx
); /* vector */
8292 /* Ignore the element if it has no prompt string. */
8293 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8295 /* 1 if the char to type matches the string. */
8297 Lisp_Object upcased_event
, downcased_event
;
8298 Lisp_Object desc
= Qnil
;
8300 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8302 upcased_event
= Fupcase (event
);
8303 downcased_event
= Fdowncase (event
);
8304 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8305 || XINT (downcased_event
) == SREF (s
, 0));
8307 desc
= Fsingle_key_description (event
, Qnil
);
8309 #if 0 /* It is redundant to list the equivalent key bindings because
8310 the prefix is what the user has already typed. */
8312 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8314 /* Insert equivalent keybinding. */
8315 s
= concat2 (s
, tem
);
8318 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8319 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8321 /* Insert button prefix. */
8322 Lisp_Object selected
8323 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8324 if (EQ (tem
, QCradio
))
8325 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8327 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8328 s
= concat2 (tem
, s
);
8332 /* If we have room for the prompt string, add it to this line.
8333 If this is the first on the line, always add it. */
8334 if ((SCHARS (s
) + i
+ 2
8335 + (char_matches
? 0 : SCHARS (desc
) + 3))
8341 /* Punctuate between strings. */
8344 strcpy (menu
+ i
, ", ");
8350 /* If the char to type doesn't match the string's
8351 first char, explicitly show what char to type. */
8354 /* Add as much of string as fits. */
8355 thiswidth
= SCHARS (desc
);
8356 if (thiswidth
+ i
> width
)
8357 thiswidth
= width
- i
;
8358 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8360 strcpy (menu
+ i
, " = ");
8364 /* Add as much of string as fits. */
8365 thiswidth
= SCHARS (s
);
8366 if (thiswidth
+ i
> width
)
8367 thiswidth
= width
- i
;
8368 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8374 /* If this element does not fit, end the line now,
8375 and save the element for the next line. */
8376 strcpy (menu
+ i
, "...");
8381 /* Move past this element. */
8382 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8383 /* Handle reaching end of dense table. */
8388 rest
= Fcdr_safe (rest
);
8392 /* Prompt with that and read response. */
8393 message2_nolog (menu
, strlen (menu
),
8394 ! NILP (current_buffer
->enable_multibyte_characters
));
8396 /* Make believe its not a keyboard macro in case the help char
8397 is pressed. Help characters are not recorded because menu prompting
8398 is not used on replay.
8400 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8401 current_kboard
->defining_kbd_macro
= Qnil
;
8403 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8404 while (BUFFERP (obj
));
8405 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8407 if (!INTEGERP (obj
))
8412 if (! EQ (obj
, menu_prompt_more_char
)
8413 && (!INTEGERP (menu_prompt_more_char
)
8414 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8416 if (!NILP (current_kboard
->defining_kbd_macro
))
8417 store_kbd_macro_char (obj
);
8420 /* Help char - go round again */
8424 /* Reading key sequences. */
8426 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8427 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8428 keymap, or nil otherwise. Return the index of the first keymap in
8429 which KEY has any binding, or NMAPS if no map has a binding.
8431 If KEY is a meta ASCII character, treat it like meta-prefix-char
8432 followed by the corresponding non-meta character. Keymaps in
8433 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8436 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8439 NEXT may be the same array as CURRENT. */
8442 follow_key (key
, nmaps
, current
, defs
, next
)
8444 Lisp_Object
*current
, *defs
, *next
;
8447 int i
, first_binding
;
8449 first_binding
= nmaps
;
8450 for (i
= nmaps
- 1; i
>= 0; i
--)
8452 if (! NILP (current
[i
]))
8454 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8455 if (! NILP (defs
[i
]))
8462 /* Given the set of bindings we've found, produce the next set of maps. */
8463 if (first_binding
< nmaps
)
8464 for (i
= 0; i
< nmaps
; i
++)
8465 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8467 return first_binding
;
8470 /* Structure used to keep track of partial application of key remapping
8471 such as Vfunction_key_map and Vkey_translation_map. */
8472 typedef struct keyremap
8474 Lisp_Object map
, parent
;
8478 /* Lookup KEY in MAP.
8479 MAP is a keymap mapping keys to key vectors or functions.
8480 If the mapping is a function and DO_FUNCTION is non-zero, then
8481 the function is called with PROMPT as parameter and its return
8482 value is used as the return value of this function (after checking
8483 that it is indeed a vector). */
8486 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8487 Lisp_Object map
, key
, prompt
;
8492 next
= access_keymap (map
, key
, 1, 0, 1);
8494 /* Handle symbol with autoload definition. */
8495 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8496 && CONSP (XSYMBOL (next
)->function
)
8497 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8498 do_autoload (XSYMBOL (next
)->function
, next
);
8500 /* Handle a symbol whose function definition is a keymap
8502 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8503 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8504 || KEYMAPP (XSYMBOL (next
)->function
)))
8505 next
= XSYMBOL (next
)->function
;
8507 /* If the keymap gives a function, not an
8508 array, then call the function with one arg and use
8509 its value instead. */
8510 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8515 next
= call1 (next
, prompt
);
8516 /* If the function returned something invalid,
8517 barf--don't ignore it.
8518 (To ignore it safely, we would need to gcpro a bunch of
8519 other variables.) */
8520 if (! (VECTORP (next
) || STRINGP (next
)))
8521 error ("Function %s returns invalid key sequence", tem
);
8526 /* Do one step of the key remapping used for function-key-map and
8527 key-translation-map:
8528 KEYBUF is the buffer holding the input events.
8529 BUFSIZE is its maximum size.
8530 FKEY is a pointer to the keyremap structure to use.
8531 INPUT is the index of the last element in KEYBUF.
8532 DOIT if non-zero says that the remapping can actually take place.
8533 DIFF is used to return the number of keys added/removed by the remapping.
8534 PARENT is the root of the keymap.
8535 PROMPT is the prompt to use if the remapping happens through a function.
8536 The return value is non-zero if the remapping actually took place. */
8539 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8540 Lisp_Object
*keybuf
, prompt
;
8542 int input
, doit
, *diff
, bufsize
;
8544 Lisp_Object next
, key
;
8546 key
= keybuf
[fkey
->end
++];
8547 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8549 /* If keybuf[fkey->start..fkey->end] is bound in the
8550 map and we're in a position to do the key remapping, replace it with
8551 the binding and restart with fkey->start at the end. */
8552 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8554 int len
= XFASTINT (Flength (next
));
8557 *diff
= len
- (fkey
->end
- fkey
->start
);
8559 if (input
+ *diff
>= bufsize
)
8560 error ("Key sequence too long");
8562 /* Shift the keys that follow fkey->end. */
8564 for (i
= fkey
->end
; i
< input
; i
++)
8565 keybuf
[i
+ *diff
] = keybuf
[i
];
8567 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8568 keybuf
[i
+ *diff
] = keybuf
[i
];
8569 /* Overwrite the old keys with the new ones. */
8570 for (i
= 0; i
< len
; i
++)
8571 keybuf
[fkey
->start
+ i
]
8572 = Faref (next
, make_number (i
));
8574 fkey
->start
= fkey
->end
+= *diff
;
8575 fkey
->map
= fkey
->parent
;
8580 fkey
->map
= get_keymap (next
, 0, 1);
8582 /* If we no longer have a bound suffix, try a new position for
8584 if (!CONSP (fkey
->map
))
8586 fkey
->end
= ++fkey
->start
;
8587 fkey
->map
= fkey
->parent
;
8592 /* Read a sequence of keys that ends with a non prefix character,
8593 storing it in KEYBUF, a buffer of size BUFSIZE.
8595 Return the length of the key sequence stored.
8596 Return -1 if the user rejected a command menu.
8598 Echo starting immediately unless `prompt' is 0.
8600 Where a key sequence ends depends on the currently active keymaps.
8601 These include any minor mode keymaps active in the current buffer,
8602 the current buffer's local map, and the global map.
8604 If a key sequence has no other bindings, we check Vfunction_key_map
8605 to see if some trailing subsequence might be the beginning of a
8606 function key's sequence. If so, we try to read the whole function
8607 key, and substitute its symbolic name into the key sequence.
8609 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8610 `double-' events into similar click events, if that would make them
8611 bound. We try to turn `triple-' events first into `double-' events,
8614 If we get a mouse click in a mode line, vertical divider, or other
8615 non-text area, we treat the click as if it were prefixed by the
8616 symbol denoting that area - `mode-line', `vertical-line', or
8619 If the sequence starts with a mouse click, we read the key sequence
8620 with respect to the buffer clicked on, not the current buffer.
8622 If the user switches frames in the midst of a key sequence, we put
8623 off the switch-frame event until later; the next call to
8624 read_char will return it.
8626 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8627 from the selected window's buffer. */
8630 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8631 can_return_switch_frame
, fix_current_buffer
)
8632 Lisp_Object
*keybuf
;
8635 int dont_downcase_last
;
8636 int can_return_switch_frame
;
8637 int fix_current_buffer
;
8639 volatile Lisp_Object from_string
;
8640 volatile int count
= SPECPDL_INDEX ();
8642 /* How many keys there are in the current key sequence. */
8645 /* The length of the echo buffer when we started reading, and
8646 the length of this_command_keys when we started reading. */
8647 volatile int echo_start
;
8648 volatile int keys_start
;
8650 /* The number of keymaps we're scanning right now, and the number of
8651 keymaps we have allocated space for. */
8653 volatile int nmaps_allocated
= 0;
8655 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8656 the current keymaps. */
8657 Lisp_Object
*volatile defs
= NULL
;
8659 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8660 in the current keymaps, or nil where it is not a prefix. */
8661 Lisp_Object
*volatile submaps
= NULL
;
8663 /* The local map to start out with at start of key sequence. */
8664 volatile Lisp_Object orig_local_map
;
8666 /* The map from the `keymap' property to start out with at start of
8668 volatile Lisp_Object orig_keymap
;
8670 /* 1 if we have already considered switching to the local-map property
8671 of the place where a mouse click occurred. */
8672 volatile int localized_local_map
= 0;
8674 /* The index in defs[] of the first keymap that has a binding for
8675 this key sequence. In other words, the lowest i such that
8676 defs[i] is non-nil. */
8677 volatile int first_binding
;
8678 /* Index of the first key that has no binding.
8679 It is useless to try fkey.start larger than that. */
8680 volatile int first_unbound
;
8682 /* If t < mock_input, then KEYBUF[t] should be read as the next
8685 We use this to recover after recognizing a function key. Once we
8686 realize that a suffix of the current key sequence is actually a
8687 function key's escape sequence, we replace the suffix with the
8688 function key's binding from Vfunction_key_map. Now keybuf
8689 contains a new and different key sequence, so the echo area,
8690 this_command_keys, and the submaps and defs arrays are wrong. In
8691 this situation, we set mock_input to t, set t to 0, and jump to
8692 restart_sequence; the loop will read keys from keybuf up until
8693 mock_input, thus rebuilding the state; and then it will resume
8694 reading characters from the keyboard. */
8695 volatile int mock_input
= 0;
8697 /* If the sequence is unbound in submaps[], then
8698 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8699 and fkey.map is its binding.
8701 These might be > t, indicating that all function key scanning
8702 should hold off until t reaches them. We do this when we've just
8703 recognized a function key, to avoid searching for the function
8704 key's again in Vfunction_key_map. */
8705 volatile keyremap fkey
;
8707 /* Likewise, for key_translation_map. */
8708 volatile keyremap keytran
;
8710 /* If we receive a `switch-frame' or `select-window' event in the middle of
8711 a key sequence, we put it off for later.
8712 While we're reading, we keep the event here. */
8713 volatile Lisp_Object delayed_switch_frame
;
8715 /* See the comment below... */
8716 #if defined (GOBBLE_FIRST_EVENT)
8717 Lisp_Object first_event
;
8720 volatile Lisp_Object original_uppercase
;
8721 volatile int original_uppercase_position
= -1;
8723 /* Gets around Microsoft compiler limitations. */
8726 struct buffer
*starting_buffer
;
8728 /* List of events for which a fake prefix key has been generated. */
8729 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8731 #if defined (GOBBLE_FIRST_EVENT)
8735 struct gcpro gcpro1
;
8737 GCPRO1 (fake_prefixed_keys
);
8738 raw_keybuf_count
= 0;
8740 last_nonmenu_event
= Qnil
;
8742 delayed_switch_frame
= Qnil
;
8747 echo_prompt (prompt
);
8748 else if (cursor_in_echo_area
8749 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8750 && NILP (Fzerop (Vecho_keystrokes
)))
8751 /* This doesn't put in a dash if the echo buffer is empty, so
8752 you don't always see a dash hanging out in the minibuffer. */
8756 /* Record the initial state of the echo area and this_command_keys;
8757 we will need to restore them if we replay a key sequence. */
8759 echo_start
= echo_length ();
8760 keys_start
= this_command_key_count
;
8761 this_single_command_key_start
= keys_start
;
8763 #if defined (GOBBLE_FIRST_EVENT)
8764 /* This doesn't quite work, because some of the things that read_char
8765 does cannot safely be bypassed. It seems too risky to try to make
8768 /* Read the first char of the sequence specially, before setting
8769 up any keymaps, in case a filter runs and switches buffers on us. */
8770 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8772 #endif /* GOBBLE_FIRST_EVENT */
8774 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8775 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8778 /* We jump here when the key sequence has been thoroughly changed, and
8779 we need to rescan it starting from the beginning. When we jump here,
8780 keybuf[0..mock_input] holds the sequence we should reread. */
8783 /* We may switch keyboards between rescans, so we need to
8784 reinitialize fkey and keytran before each replay. */
8785 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
8786 keytran
.map
= keytran
.parent
= current_kboard
->Vlocal_key_translation_map
;
8787 /* If there is no translation map, turn off scanning. */
8788 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8789 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8791 starting_buffer
= current_buffer
;
8792 first_unbound
= bufsize
+ 1;
8794 /* Build our list of keymaps.
8795 If we recognize a function key and replace its escape sequence in
8796 keybuf with its symbol, or if the sequence starts with a mouse
8797 click and we need to switch buffers, we jump back here to rebuild
8798 the initial keymaps from the current buffer. */
8801 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8802 || !NILP (Voverriding_local_map
))
8804 if (3 > nmaps_allocated
)
8806 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8807 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8808 nmaps_allocated
= 3;
8810 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8811 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8812 if (!NILP (Voverriding_local_map
))
8813 submaps
[nmaps
++] = Voverriding_local_map
;
8821 nminor
= current_minor_maps (0, &maps
);
8822 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8824 if (total
> nmaps_allocated
)
8826 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8827 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8828 nmaps_allocated
= total
;
8831 if (!NILP (orig_keymap
))
8832 submaps
[nmaps
++] = orig_keymap
;
8834 bcopy (maps
, (void *) (submaps
+ nmaps
),
8835 nminor
* sizeof (submaps
[0]));
8839 submaps
[nmaps
++] = orig_local_map
;
8841 submaps
[nmaps
++] = current_global_map
;
8843 /* Find an accurate initial value for first_binding. */
8844 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8845 if (! NILP (submaps
[first_binding
]))
8848 /* Start from the beginning in keybuf. */
8851 /* These are no-ops the first time through, but if we restart, they
8852 revert the echo area and this_command_keys to their original state. */
8853 this_command_key_count
= keys_start
;
8854 if (INTERACTIVE
&& t
< mock_input
)
8855 echo_truncate (echo_start
);
8857 /* If the best binding for the current key sequence is a keymap, or
8858 we may be looking at a function key's escape sequence, keep on
8860 while (first_binding
< nmaps
8861 /* Keep reading as long as there's a prefix binding. */
8862 ? !NILP (submaps
[first_binding
])
8863 /* Don't return in the middle of a possible function key sequence,
8864 if the only bindings we found were via case conversion.
8865 Thus, if ESC O a has a function-key-map translation
8866 and ESC o has a binding, don't return after ESC O,
8867 so that we can translate ESC O plus the next character. */
8868 : (fkey
.start
< t
|| keytran
.start
< t
))
8871 int used_mouse_menu
= 0;
8873 /* Where the last real key started. If we need to throw away a
8874 key that has expanded into more than one element of keybuf
8875 (say, a mouse click on the mode line which is being treated
8876 as [mode-line (mouse-...)], then we backtrack to this point
8878 volatile int last_real_key_start
;
8880 /* These variables are analogous to echo_start and keys_start;
8881 while those allow us to restart the entire key sequence,
8882 echo_local_start and keys_local_start allow us to throw away
8884 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8886 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8887 eassert (fkey
.start
<= fkey
.end
);
8888 eassert (keytran
.start
<= keytran
.end
);
8889 /* key-translation-map is applied *after* function-key-map. */
8890 eassert (keytran
.end
<= fkey
.start
);
8892 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8893 { /* The prefix upto first_unbound has no binding and has
8894 no translation left to do either, so we know it's unbound.
8895 If we don't stop now, we risk staying here indefinitely
8896 (if the user keeps entering fkey or keytran prefixes
8897 like C-c ESC ESC ESC ESC ...) */
8899 for (i
= first_unbound
+ 1; i
< t
; i
++)
8900 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8901 mock_input
= t
- first_unbound
- 1;
8902 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8903 fkey
.map
= fkey
.parent
;
8904 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8905 keytran
.map
= keytran
.parent
;
8906 goto replay_sequence
;
8910 error ("Key sequence too long");
8913 echo_local_start
= echo_length ();
8914 keys_local_start
= this_command_key_count
;
8915 local_first_binding
= first_binding
;
8918 /* These are no-ops, unless we throw away a keystroke below and
8919 jumped back up to replay_key; in that case, these restore the
8920 variables to their original state, allowing us to replay the
8922 if (INTERACTIVE
&& t
< mock_input
)
8923 echo_truncate (echo_local_start
);
8924 this_command_key_count
= keys_local_start
;
8925 first_binding
= local_first_binding
;
8927 /* By default, assume each event is "real". */
8928 last_real_key_start
= t
;
8930 /* Does mock_input indicate that we are re-reading a key sequence? */
8934 add_command_key (key
);
8935 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8936 && NILP (Fzerop (Vecho_keystrokes
)))
8940 /* If not, we should actually read a character. */
8945 KBOARD
*interrupted_kboard
= current_kboard
;
8946 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8947 if (setjmp (wrong_kboard_jmpbuf
))
8949 if (!NILP (delayed_switch_frame
))
8951 interrupted_kboard
->kbd_queue
8952 = Fcons (delayed_switch_frame
,
8953 interrupted_kboard
->kbd_queue
);
8954 delayed_switch_frame
= Qnil
;
8957 interrupted_kboard
->kbd_queue
8958 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8960 /* If the side queue is non-empty, ensure it begins with a
8961 switch-frame, so we'll replay it in the right context. */
8962 if (CONSP (interrupted_kboard
->kbd_queue
)
8963 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8964 !(EVENT_HAS_PARAMETERS (key
)
8965 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8969 XSETFRAME (frame
, interrupted_frame
);
8970 interrupted_kboard
->kbd_queue
8971 = Fcons (make_lispy_switch_frame (frame
),
8972 interrupted_kboard
->kbd_queue
);
8975 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8976 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8977 goto replay_sequence
;
8980 key
= read_char (NILP (prompt
), nmaps
,
8981 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8985 /* read_char returns t when it shows a menu and the user rejects it.
8989 unbind_to (count
, Qnil
);
8994 /* read_char returns -1 at the end of a macro.
8995 Emacs 18 handles this by returning immediately with a
8996 zero, so that's what we'll do. */
8997 if (INTEGERP (key
) && XINT (key
) == -1)
9000 /* The Microsoft C compiler can't handle the goto that
9006 /* If the current buffer has been changed from under us, the
9007 keymap may have changed, so replay the sequence. */
9010 timer_resume_idle ();
9013 /* Reset the current buffer from the selected window
9014 in case something changed the former and not the latter.
9015 This is to be more consistent with the behavior
9016 of the command_loop_1. */
9017 if (fix_current_buffer
)
9019 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9021 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9022 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9025 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9026 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9027 goto replay_sequence
;
9030 /* If we have a quit that was typed in another frame, and
9031 quit_throw_to_read_char switched buffers,
9032 replay to get the right keymap. */
9034 && XINT (key
) == quit_char
9035 && current_buffer
!= starting_buffer
)
9038 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9042 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9043 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9044 goto replay_sequence
;
9049 if (EVENT_HAS_PARAMETERS (key
)
9050 /* Either a `switch-frame' or a `select-window' event. */
9051 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9053 /* If we're at the beginning of a key sequence, and the caller
9054 says it's okay, go ahead and return this event. If we're
9055 in the midst of a key sequence, delay it until the end. */
9056 if (t
> 0 || !can_return_switch_frame
)
9058 delayed_switch_frame
= key
;
9064 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9067 /* Clicks in non-text areas get prefixed by the symbol
9068 in their CHAR-ADDRESS field. For example, a click on
9069 the mode line is prefixed by the symbol `mode-line'.
9071 Furthermore, key sequences beginning with mouse clicks
9072 are read using the keymaps of the buffer clicked on, not
9073 the current buffer. So we may have to switch the buffer
9076 When we turn one event into two events, we must make sure
9077 that neither of the two looks like the original--so that,
9078 if we replay the events, they won't be expanded again.
9079 If not for this, such reexpansion could happen either here
9080 or when user programs play with this-command-keys. */
9081 if (EVENT_HAS_PARAMETERS (key
))
9086 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9087 if (EQ (kind
, Qmouse_click
))
9089 Lisp_Object window
, posn
;
9091 window
= POSN_WINDOW (EVENT_START (key
));
9092 posn
= POSN_POSN (EVENT_START (key
));
9095 || (!NILP (fake_prefixed_keys
)
9096 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9098 /* We're looking a second time at an event for which
9099 we generated a fake prefix key. Set
9100 last_real_key_start appropriately. */
9102 last_real_key_start
= t
- 1;
9105 /* Key sequences beginning with mouse clicks are
9106 read using the keymaps in the buffer clicked on,
9107 not the current buffer. If we're at the
9108 beginning of a key sequence, switch buffers. */
9109 if (last_real_key_start
== 0
9111 && BUFFERP (XWINDOW (window
)->buffer
)
9112 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9114 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9118 /* Arrange to go back to the original buffer once we're
9119 done reading the key sequence. Note that we can't
9120 use save_excursion_{save,restore} here, because they
9121 save point as well as the current buffer; we don't
9122 want to save point, because redisplay may change it,
9123 to accommodate a Fset_window_start or something. We
9124 don't want to do this at the top of the function,
9125 because we may get input from a subprocess which
9126 wants to change the selected window and stuff (say,
9128 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9130 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9132 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9133 orig_local_map
= get_local_map (PT
, current_buffer
,
9135 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9136 goto replay_sequence
;
9139 /* For a mouse click, get the local text-property keymap
9140 of the place clicked on, rather than point. */
9141 if (last_real_key_start
== 0
9142 && CONSP (XCDR (key
))
9143 && ! localized_local_map
)
9145 Lisp_Object map_here
, start
, pos
;
9147 localized_local_map
= 1;
9148 start
= EVENT_START (key
);
9150 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9152 pos
= POSN_BUFFER_POSN (start
);
9154 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9156 map_here
= get_local_map (XINT (pos
),
9157 current_buffer
, Qlocal_map
);
9158 if (!EQ (map_here
, orig_local_map
))
9160 orig_local_map
= map_here
;
9164 goto replay_sequence
;
9166 map_here
= get_local_map (XINT (pos
),
9167 current_buffer
, Qkeymap
);
9168 if (!EQ (map_here
, orig_keymap
))
9170 orig_keymap
= map_here
;
9174 goto replay_sequence
;
9180 /* Expand mode-line and scroll-bar events into two events:
9181 use posn as a fake prefix key. */
9183 && (NILP (fake_prefixed_keys
)
9184 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9186 if (t
+ 1 >= bufsize
)
9187 error ("Key sequence too long");
9190 keybuf
[t
+ 1] = key
;
9193 /* Record that a fake prefix key has been generated
9194 for KEY. Don't modify the event; this would
9195 prevent proper action when the event is pushed
9196 back into unread-command-events. */
9197 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9199 /* If on a mode line string with a local keymap,
9200 reconsider the key sequence with that keymap. */
9201 if (string
= POSN_STRING (EVENT_START (key
)),
9202 (CONSP (string
) && STRINGP (XCAR (string
))))
9204 Lisp_Object pos
, map
, map2
;
9206 pos
= XCDR (string
);
9207 string
= XCAR (string
);
9209 && XINT (pos
) < SCHARS (string
))
9211 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9213 orig_local_map
= map
;
9214 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9217 if (!NILP (map
) || !NILP (map2
))
9218 goto replay_sequence
;
9224 else if (NILP (from_string
)
9225 && (string
= POSN_STRING (EVENT_START (key
)),
9226 (CONSP (string
) && STRINGP (XCAR (string
)))))
9228 /* For a click on a string, i.e. overlay string or a
9229 string displayed via the `display' property,
9230 consider `local-map' and `keymap' properties of
9232 Lisp_Object pos
, map
, map2
;
9234 pos
= XCDR (string
);
9235 string
= XCAR (string
);
9237 && XINT (pos
) < SCHARS (string
))
9239 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9241 orig_local_map
= map
;
9242 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9246 if (!NILP (map
) || !NILP (map2
))
9248 from_string
= string
;
9249 goto replay_sequence
;
9254 else if (CONSP (XCDR (key
))
9255 && CONSP (EVENT_START (key
))
9256 && CONSP (XCDR (EVENT_START (key
))))
9260 posn
= POSN_POSN (EVENT_START (key
));
9261 /* Handle menu-bar events:
9262 insert the dummy prefix event `menu-bar'. */
9263 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9265 if (t
+ 1 >= bufsize
)
9266 error ("Key sequence too long");
9270 /* Zap the position in key, so we know that we've
9271 expanded it, and don't try to do so again. */
9272 POSN_SET_POSN (EVENT_START (key
),
9273 Fcons (posn
, Qnil
));
9276 goto replay_sequence
;
9278 else if (CONSP (posn
))
9280 /* We're looking at the second event of a
9281 sequence which we expanded before. Set
9282 last_real_key_start appropriately. */
9283 if (last_real_key_start
== t
&& t
> 0)
9284 last_real_key_start
= t
- 1;
9289 /* We have finally decided that KEY is something we might want
9291 first_binding
= (follow_key (key
,
9292 nmaps
- first_binding
,
9293 submaps
+ first_binding
,
9294 defs
+ first_binding
,
9295 submaps
+ first_binding
)
9298 /* If KEY wasn't bound, we'll try some fallbacks. */
9299 if (first_binding
< nmaps
)
9300 /* This is needed for the following scenario:
9301 event 0: a down-event that gets dropped by calling replay_key.
9302 event 1: some normal prefix like C-h.
9303 After event 0, first_unbound is 0, after event 1 fkey.start
9304 and keytran.start are both 1, so when we see that C-h is bound,
9305 we need to update first_unbound. */
9306 first_unbound
= max (t
+ 1, first_unbound
);
9311 /* Remember the position to put an upper bound on fkey.start. */
9312 first_unbound
= min (t
, first_unbound
);
9314 head
= EVENT_HEAD (key
);
9315 if (help_char_p (head
) && t
> 0)
9317 read_key_sequence_cmd
= Vprefix_help_command
;
9319 last_nonmenu_event
= key
;
9320 /* The Microsoft C compiler can't handle the goto that
9328 Lisp_Object breakdown
;
9331 breakdown
= parse_modifiers (head
);
9332 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9333 /* Attempt to reduce an unbound mouse event to a simpler
9334 event that is bound:
9335 Drags reduce to clicks.
9336 Double-clicks reduce to clicks.
9337 Triple-clicks reduce to double-clicks, then to clicks.
9338 Down-clicks are eliminated.
9339 Double-downs reduce to downs, then are eliminated.
9340 Triple-downs reduce to double-downs, then to downs,
9341 then are eliminated. */
9342 if (modifiers
& (down_modifier
| drag_modifier
9343 | double_modifier
| triple_modifier
))
9345 while (modifiers
& (down_modifier
| drag_modifier
9346 | double_modifier
| triple_modifier
))
9348 Lisp_Object new_head
, new_click
;
9349 if (modifiers
& triple_modifier
)
9350 modifiers
^= (double_modifier
| triple_modifier
);
9351 else if (modifiers
& double_modifier
)
9352 modifiers
&= ~double_modifier
;
9353 else if (modifiers
& drag_modifier
)
9354 modifiers
&= ~drag_modifier
;
9357 /* Dispose of this `down' event by simply jumping
9358 back to replay_key, to get another event.
9360 Note that if this event came from mock input,
9361 then just jumping back to replay_key will just
9362 hand it to us again. So we have to wipe out any
9365 We could delete keybuf[t] and shift everything
9366 after that to the left by one spot, but we'd also
9367 have to fix up any variable that points into
9368 keybuf, and shifting isn't really necessary
9371 Adding prefixes for non-textual mouse clicks
9372 creates two characters of mock input, and both
9373 must be thrown away. If we're only looking at
9374 the prefix now, we can just jump back to
9375 replay_key. On the other hand, if we've already
9376 processed the prefix, and now the actual click
9377 itself is giving us trouble, then we've lost the
9378 state of the keymaps we want to backtrack to, and
9379 we need to replay the whole sequence to rebuild
9382 Beyond that, only function key expansion could
9383 create more than two keys, but that should never
9384 generate mouse events, so it's okay to zero
9385 mock_input in that case too.
9387 FIXME: The above paragraph seems just plain
9388 wrong, if you consider things like
9389 xterm-mouse-mode. -stef
9391 Isn't this just the most wonderful code ever? */
9393 /* If mock_input > t + 1, the above simplification
9394 will actually end up dropping keys on the floor.
9395 This is probably OK for now, but even
9396 if mock_input <= t + 1, we need to adjust fkey
9398 Typical case [header-line down-mouse-N]:
9399 mock_input = 2, t = 1, fkey.end = 1,
9400 last_real_key_start = 0. */
9401 if (fkey
.end
> last_real_key_start
)
9403 fkey
.end
= fkey
.start
9404 = min (last_real_key_start
, fkey
.start
);
9405 fkey
.map
= fkey
.parent
;
9406 if (keytran
.end
> last_real_key_start
)
9408 keytran
.end
= keytran
.start
9409 = min (last_real_key_start
, keytran
.start
);
9410 keytran
.map
= keytran
.parent
;
9413 if (t
== last_real_key_start
)
9420 mock_input
= last_real_key_start
;
9421 goto replay_sequence
;
9426 = apply_modifiers (modifiers
, XCAR (breakdown
));
9428 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9430 /* Look for a binding for this new key. follow_key
9431 promises that it didn't munge submaps the
9432 last time we called it, since key was unbound. */
9434 = (follow_key (new_click
,
9435 nmaps
- local_first_binding
,
9436 submaps
+ local_first_binding
,
9437 defs
+ local_first_binding
,
9438 submaps
+ local_first_binding
)
9439 + local_first_binding
);
9441 /* If that click is bound, go for it. */
9442 if (first_binding
< nmaps
)
9447 /* Otherwise, we'll leave key set to the drag event. */
9454 /* Normally, last_nonmenu_event gets the previous key we read.
9455 But when a mouse popup menu is being used,
9456 we don't update last_nonmenu_event; it continues to hold the mouse
9457 event that preceded the first level of menu. */
9458 if (!used_mouse_menu
)
9459 last_nonmenu_event
= key
;
9461 /* Record what part of this_command_keys is the current key sequence. */
9462 this_single_command_key_start
= this_command_key_count
- t
;
9464 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9465 /* There is a binding and it's not a prefix.
9466 There is thus no function-key in this sequence.
9467 Moving fkey.start is important in this case to allow keytran.start
9468 to go over the sequence before we return (since we keep the
9469 invariant that keytran.end <= fkey.start). */
9472 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9475 /* If the sequence is unbound, see if we can hang a function key
9476 off the end of it. */
9477 /* Continue scan from fkey.end until we find a bound suffix. */
9478 while (fkey
.end
< t
)
9480 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9483 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9484 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9485 max (t
, mock_input
),
9486 /* If there's a binding (i.e.
9487 first_binding >= nmaps) we don't want
9488 to apply this function-key-mapping. */
9489 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9494 mock_input
= diff
+ max (t
, mock_input
);
9495 goto replay_sequence
;
9499 /* Look for this sequence in key-translation-map.
9500 Scan from keytran.end until we find a bound suffix. */
9501 while (keytran
.end
< fkey
.start
)
9503 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9506 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9507 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9512 mock_input
= diff
+ max (t
, mock_input
);
9513 /* Adjust the function-key-map counters. */
9517 goto replay_sequence
;
9521 /* If KEY is not defined in any of the keymaps,
9522 and cannot be part of a function key or translation,
9523 and is an upper case letter
9524 use the corresponding lower-case letter instead. */
9525 if (first_binding
>= nmaps
9526 && fkey
.start
>= t
&& keytran
.start
>= t
9528 && ((((XINT (key
) & 0x3ffff)
9529 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9530 && UPPERCASEP (XINT (key
) & 0x3ffff))
9531 || (XINT (key
) & shift_modifier
)))
9533 Lisp_Object new_key
;
9535 original_uppercase
= key
;
9536 original_uppercase_position
= t
- 1;
9538 if (XINT (key
) & shift_modifier
)
9539 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9541 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9542 | (XINT (key
) & ~0x3ffff)));
9544 /* We have to do this unconditionally, regardless of whether
9545 the lower-case char is defined in the keymaps, because they
9546 might get translated through function-key-map. */
9547 keybuf
[t
- 1] = new_key
;
9548 mock_input
= max (t
, mock_input
);
9550 goto replay_sequence
;
9552 /* If KEY is not defined in any of the keymaps,
9553 and cannot be part of a function key or translation,
9554 and is a shifted function key,
9555 use the corresponding unshifted function key instead. */
9556 if (first_binding
>= nmaps
9557 && fkey
.start
>= t
&& keytran
.start
>= t
9560 Lisp_Object breakdown
;
9563 breakdown
= parse_modifiers (key
);
9564 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9565 if (modifiers
& shift_modifier
)
9567 Lisp_Object new_key
;
9569 original_uppercase
= key
;
9570 original_uppercase_position
= t
- 1;
9572 modifiers
&= ~shift_modifier
;
9573 new_key
= apply_modifiers (modifiers
,
9576 keybuf
[t
- 1] = new_key
;
9577 mock_input
= max (t
, mock_input
);
9578 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9579 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9581 goto replay_sequence
;
9587 read_key_sequence_cmd
= (first_binding
< nmaps
9588 ? defs
[first_binding
]
9591 unread_switch_frame
= delayed_switch_frame
;
9592 unbind_to (count
, Qnil
);
9594 /* Don't downcase the last character if the caller says don't.
9595 Don't downcase it if the result is undefined, either. */
9596 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9597 && t
- 1 == original_uppercase_position
)
9598 keybuf
[t
- 1] = original_uppercase
;
9600 /* Occasionally we fabricate events, perhaps by expanding something
9601 according to function-key-map, or by adding a prefix symbol to a
9602 mouse click in the scroll bar or modeline. In this cases, return
9603 the entire generated key sequence, even if we hit an unbound
9604 prefix or a definition before the end. This means that you will
9605 be able to push back the event properly, and also means that
9606 read-key-sequence will always return a logical unit.
9609 for (; t
< mock_input
; t
++)
9611 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9612 && NILP (Fzerop (Vecho_keystrokes
)))
9613 echo_char (keybuf
[t
]);
9614 add_command_key (keybuf
[t
]);
9623 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9624 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9625 The sequence is sufficient to specify a non-prefix command in the
9626 current local and global maps.
9628 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9629 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9630 as a continuation of the previous key.
9632 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9633 convert the last event to lower case. (Normally any upper case event
9634 is converted to lower case if the original event is undefined and the lower
9635 case equivalent is defined.) A non-nil value is appropriate for reading
9636 a key sequence to be defined.
9638 A C-g typed while in this function is treated like any other character,
9639 and `quit-flag' is not set.
9641 If the key sequence starts with a mouse click, then the sequence is read
9642 using the keymaps of the buffer of the window clicked in, not the buffer
9643 of the selected window as normal.
9645 `read-key-sequence' drops unbound button-down events, since you normally
9646 only care about the click or drag events which follow them. If a drag
9647 or multi-click event is unbound, but the corresponding click event would
9648 be bound, `read-key-sequence' turns the event into a click event at the
9649 drag's starting position. This means that you don't have to distinguish
9650 between click and drag, double, or triple events unless you want to.
9652 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9653 lines separating windows, and scroll bars with imaginary keys
9654 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9656 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9657 function will process a switch-frame event if the user switches frames
9658 before typing anything. If the user switches frames in the middle of a
9659 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9660 is nil, then the event will be put off until after the current key sequence.
9662 `read-key-sequence' checks `function-key-map' for function key
9663 sequences, where they wouldn't conflict with ordinary bindings. See
9664 `function-key-map' for more details.
9666 The optional fifth argument COMMAND-LOOP, if non-nil, means
9667 that this key sequence is being read by something that will
9668 read commands one after another. It should be nil if the caller
9669 will read just one key sequence. */)
9670 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9672 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9673 Lisp_Object can_return_switch_frame
, command_loop
;
9675 Lisp_Object keybuf
[30];
9677 struct gcpro gcpro1
;
9678 int count
= SPECPDL_INDEX ();
9681 CHECK_STRING (prompt
);
9684 specbind (Qinput_method_exit_on_first_char
,
9685 (NILP (command_loop
) ? Qt
: Qnil
));
9686 specbind (Qinput_method_use_echo_area
,
9687 (NILP (command_loop
) ? Qt
: Qnil
));
9689 bzero (keybuf
, sizeof keybuf
);
9691 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9693 if (NILP (continue_echo
))
9695 this_command_key_count
= 0;
9696 this_command_key_count_reset
= 0;
9697 this_single_command_key_start
= 0;
9700 #ifdef HAVE_X_WINDOWS
9701 if (display_hourglass_p
)
9702 cancel_hourglass ();
9705 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9706 prompt
, ! NILP (dont_downcase_last
),
9707 ! NILP (can_return_switch_frame
), 0);
9709 #if 0 /* The following is fine for code reading a key sequence and
9710 then proceeding with a lenghty computation, but it's not good
9711 for code reading keys in a loop, like an input method. */
9712 #ifdef HAVE_X_WINDOWS
9713 if (display_hourglass_p
)
9724 return unbind_to (count
, make_event_array (i
, keybuf
));
9727 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9728 Sread_key_sequence_vector
, 1, 5, 0,
9729 doc
: /* Like `read-key-sequence' but always return a vector. */)
9730 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9732 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9733 Lisp_Object can_return_switch_frame
, command_loop
;
9735 Lisp_Object keybuf
[30];
9737 struct gcpro gcpro1
;
9738 int count
= SPECPDL_INDEX ();
9741 CHECK_STRING (prompt
);
9744 specbind (Qinput_method_exit_on_first_char
,
9745 (NILP (command_loop
) ? Qt
: Qnil
));
9746 specbind (Qinput_method_use_echo_area
,
9747 (NILP (command_loop
) ? Qt
: Qnil
));
9749 bzero (keybuf
, sizeof keybuf
);
9751 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9753 if (NILP (continue_echo
))
9755 this_command_key_count
= 0;
9756 this_command_key_count_reset
= 0;
9757 this_single_command_key_start
= 0;
9760 #ifdef HAVE_X_WINDOWS
9761 if (display_hourglass_p
)
9762 cancel_hourglass ();
9765 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9766 prompt
, ! NILP (dont_downcase_last
),
9767 ! NILP (can_return_switch_frame
), 0);
9769 #ifdef HAVE_X_WINDOWS
9770 if (display_hourglass_p
)
9780 return unbind_to (count
, Fvector (i
, keybuf
));
9783 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9784 doc
: /* Execute CMD as an editor command.
9785 CMD must be a symbol that satisfies the `commandp' predicate.
9786 Optional second arg RECORD-FLAG non-nil
9787 means unconditionally put this command in `command-history'.
9788 Otherwise, that is done only if an arg is read using the minibuffer.
9789 The argument KEYS specifies the value to use instead of (this-command-keys)
9790 when reading the arguments; if it is nil, (this-command-keys) is used.
9791 The argument SPECIAL, if non-nil, means that this command is executing
9792 a special event, so ignore the prefix argument and don't clear it. */)
9793 (cmd
, record_flag
, keys
, special
)
9794 Lisp_Object cmd
, record_flag
, keys
, special
;
9796 register Lisp_Object final
;
9797 register Lisp_Object tem
;
9798 Lisp_Object prefixarg
;
9799 struct backtrace backtrace
;
9800 extern int debug_on_next_call
;
9802 debug_on_next_call
= 0;
9806 prefixarg
= current_kboard
->Vprefix_arg
;
9807 Vcurrent_prefix_arg
= prefixarg
;
9808 current_kboard
->Vprefix_arg
= Qnil
;
9815 tem
= Fget (cmd
, Qdisabled
);
9816 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9818 tem
= Fsymbol_value (Qdisabled_command_function
);
9820 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9826 final
= Findirect_function (cmd
);
9828 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9830 struct gcpro gcpro1
, gcpro2
;
9832 GCPRO2 (cmd
, prefixarg
);
9833 do_autoload (final
, cmd
);
9840 if (STRINGP (final
) || VECTORP (final
))
9842 /* If requested, place the macro in the command history. For
9843 other sorts of commands, call-interactively takes care of
9845 if (!NILP (record_flag
))
9848 = Fcons (Fcons (Qexecute_kbd_macro
,
9849 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9852 /* Don't keep command history around forever. */
9853 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9855 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9857 XSETCDR (tem
, Qnil
);
9861 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9864 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9866 backtrace
.next
= backtrace_list
;
9867 backtrace_list
= &backtrace
;
9868 backtrace
.function
= &Qcall_interactively
;
9869 backtrace
.args
= &cmd
;
9870 backtrace
.nargs
= 1;
9871 backtrace
.evalargs
= 0;
9872 backtrace
.debug_on_exit
= 0;
9874 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9876 backtrace_list
= backtrace
.next
;
9884 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9886 doc
: /* Read function name, then read its arguments and call it. */)
9888 Lisp_Object prefixarg
;
9890 Lisp_Object function
;
9892 int saved_last_point_position
;
9893 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9894 Lisp_Object bindings
, value
;
9895 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9896 #ifdef HAVE_X_WINDOWS
9897 /* The call to Fcompleting_read wil start and cancel the hourglass,
9898 but if the hourglass was already scheduled, this means that no
9899 hourglass will be shown for the actual M-x command itself.
9900 So we restart it if it is already scheduled. Note that checking
9901 hourglass_shown_p is not enough, normally the hourglass is not shown,
9902 just scheduled to be shown. */
9903 int hstarted
= hourglass_started ();
9906 saved_keys
= Fvector (this_command_key_count
,
9907 XVECTOR (this_command_keys
)->contents
);
9908 saved_last_point_position_buffer
= last_point_position_buffer
;
9909 saved_last_point_position
= last_point_position
;
9911 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9913 if (EQ (prefixarg
, Qminus
))
9915 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9916 strcpy (buf
, "C-u ");
9917 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9918 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9919 else if (INTEGERP (prefixarg
))
9920 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9922 /* This isn't strictly correct if execute-extended-command
9923 is bound to anything else. Perhaps it should use
9924 this_command_keys? */
9925 strcat (buf
, "M-x ");
9927 /* Prompt with buf, and then read a string, completing from and
9928 restricting to the set of all defined commands. Don't provide
9929 any initial input. Save the command read on the extended-command
9931 function
= Fcompleting_read (build_string (buf
),
9932 Vobarray
, Qcommandp
,
9933 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9936 #ifdef HAVE_X_WINDOWS
9937 if (hstarted
) start_hourglass ();
9940 if (STRINGP (function
) && SCHARS (function
) == 0)
9941 error ("No command name given");
9943 /* Set this_command_keys to the concatenation of saved_keys and
9944 function, followed by a RET. */
9949 this_command_key_count
= 0;
9950 this_command_key_count_reset
= 0;
9951 this_single_command_key_start
= 0;
9953 keys
= XVECTOR (saved_keys
)->contents
;
9954 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9955 add_command_key (keys
[i
]);
9957 for (i
= 0; i
< SCHARS (function
); i
++)
9958 add_command_key (Faref (function
, make_number (i
)));
9960 add_command_key (make_number ('\015'));
9963 last_point_position
= saved_last_point_position
;
9964 last_point_position_buffer
= saved_last_point_position_buffer
;
9968 function
= Fintern (function
, Qnil
);
9969 current_kboard
->Vprefix_arg
= prefixarg
;
9970 Vthis_command
= function
;
9971 real_this_command
= function
;
9973 /* If enabled, show which key runs this command. */
9974 if (!NILP (Vsuggest_key_bindings
)
9975 && NILP (Vexecuting_kbd_macro
)
9976 && SYMBOLP (function
))
9977 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9983 GCPRO2 (bindings
, value
);
9984 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9986 /* If the command has a key binding, print it now. */
9987 if (!NILP (bindings
)
9988 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9991 /* But first wait, and skip the message if there is input. */
9993 if (!NILP (echo_area_buffer
[0]))
9994 /* This command displayed something in the echo area;
9995 so wait a few seconds, then display our suggestion message. */
9996 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9997 ? XINT (Vsuggest_key_bindings
) : 2);
9999 /* This command left the echo area empty,
10000 so display our message immediately. */
10003 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
10004 && ! CONSP (Vunread_command_events
))
10006 Lisp_Object binding
;
10008 int message_p
= push_message ();
10009 int count
= SPECPDL_INDEX ();
10011 record_unwind_protect (pop_message_unwind
, Qnil
);
10012 binding
= Fkey_description (bindings
, Qnil
);
10015 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10018 sprintf (newmessage
, "You can run the command `%s' with %s",
10019 SDATA (SYMBOL_NAME (function
)),
10021 message2_nolog (newmessage
,
10022 strlen (newmessage
),
10023 STRING_MULTIBYTE (binding
));
10024 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
10025 ? Vsuggest_key_bindings
: make_number (2)),
10028 restore_message ();
10030 unbind_to (count
, Qnil
);
10034 RETURN_UNGCPRO (value
);
10038 /* Return nonzero if input events are pending. */
10041 detect_input_pending ()
10043 if (!input_pending
)
10044 get_input_pending (&input_pending
, 0);
10046 return input_pending
;
10049 /* Return nonzero if input events other than mouse movements are
10053 detect_input_pending_ignore_squeezables ()
10055 if (!input_pending
)
10056 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10058 return input_pending
;
10061 /* Return nonzero if input events are pending, and run any pending timers. */
10064 detect_input_pending_run_timers (do_display
)
10067 int old_timers_run
= timers_run
;
10069 if (!input_pending
)
10070 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10072 if (old_timers_run
!= timers_run
&& do_display
)
10074 redisplay_preserve_echo_area (8);
10075 /* The following fixes a bug when using lazy-lock with
10076 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10077 from an idle timer function. The symptom of the bug is that
10078 the cursor sometimes doesn't become visible until the next X
10079 event is processed. --gerd. */
10081 Lisp_Object tail
, frame
;
10082 FOR_EACH_FRAME (tail
, frame
)
10083 if (FRAME_RIF (XFRAME (frame
)))
10084 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10088 return input_pending
;
10091 /* This is called in some cases before a possible quit.
10092 It cases the next call to detect_input_pending to recompute input_pending.
10093 So calling this function unnecessarily can't do any harm. */
10096 clear_input_pending ()
10101 /* Return nonzero if there are pending requeued events.
10102 This isn't used yet. The hope is to make wait_reading_process_output
10103 call it, and return if it runs Lisp code that unreads something.
10104 The problem is, kbd_buffer_get_event needs to be fixed to know what
10105 to do in that case. It isn't trivial. */
10108 requeued_events_pending_p ()
10110 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10114 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10115 doc
: /* Return t if command input is currently available with no wait.
10116 Actually, the value is nil only if we can be sure that no input is available;
10117 if there is a doubt, the value is t. */)
10120 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10123 get_input_pending (&input_pending
,
10124 READABLE_EVENTS_DO_TIMERS_NOW
10125 | READABLE_EVENTS_FILTER_EVENTS
);
10126 return input_pending
> 0 ? Qt
: Qnil
;
10129 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10130 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10133 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10136 if (total_keys
< NUM_RECENT_KEYS
)
10137 return Fvector (total_keys
, keys
);
10140 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10141 bcopy (keys
+ recent_keys_index
,
10142 XVECTOR (val
)->contents
,
10143 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10145 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10146 recent_keys_index
* sizeof (Lisp_Object
));
10151 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10152 doc
: /* Return the key sequence that invoked this command.
10153 However, if the command has called `read-key-sequence', it returns
10154 the last key sequence that has been read.
10155 The value is a string or a vector. */)
10158 return make_event_array (this_command_key_count
,
10159 XVECTOR (this_command_keys
)->contents
);
10162 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10163 doc
: /* Return the key sequence that invoked this command, as a vector.
10164 However, if the command has called `read-key-sequence', it returns
10165 the last key sequence that has been read. */)
10168 return Fvector (this_command_key_count
,
10169 XVECTOR (this_command_keys
)->contents
);
10172 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10173 Sthis_single_command_keys
, 0, 0, 0,
10174 doc
: /* Return the key sequence that invoked this command.
10175 More generally, it returns the last key sequence read, either by
10176 the command loop or by `read-key-sequence'.
10177 Unlike `this-command-keys', this function's value
10178 does not include prefix arguments.
10179 The value is always a vector. */)
10182 return Fvector (this_command_key_count
10183 - this_single_command_key_start
,
10184 (XVECTOR (this_command_keys
)->contents
10185 + this_single_command_key_start
));
10188 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10189 Sthis_single_command_raw_keys
, 0, 0, 0,
10190 doc
: /* Return the raw events that were read for this command.
10191 More generally, it returns the last key sequence read, either by
10192 the command loop or by `read-key-sequence'.
10193 Unlike `this-single-command-keys', this function's value
10194 shows the events before all translations (except for input methods).
10195 The value is always a vector. */)
10198 return Fvector (raw_keybuf_count
,
10199 (XVECTOR (raw_keybuf
)->contents
));
10202 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10203 Sreset_this_command_lengths
, 0, 0, 0,
10204 doc
: /* Make the unread events replace the last command and echo.
10205 Used in `universal-argument-other-key'.
10207 `universal-argument-other-key' rereads the event just typed.
10208 It then gets translated through `function-key-map'.
10209 The translated event has to replace the real events,
10210 both in the value of (this-command-keys) and in echoing.
10211 To achieve this, `universal-argument-other-key' calls
10212 `reset-this-command-lengths', which discards the record of reading
10213 these events the first time. */)
10216 this_command_key_count
= before_command_key_count
;
10217 if (this_command_key_count
< this_single_command_key_start
)
10218 this_single_command_key_start
= this_command_key_count
;
10220 echo_truncate (before_command_echo_length
);
10222 /* Cause whatever we put into unread-command-events
10223 to echo as if it were being freshly read from the keyboard. */
10224 this_command_key_count_reset
= 1;
10229 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10230 Sclear_this_command_keys
, 0, 1, 0,
10231 doc
: /* Clear out the vector that `this-command-keys' returns.
10232 Also clear the record of the last 100 events, unless optional arg
10233 KEEP-RECORD is non-nil. */)
10235 Lisp_Object keep_record
;
10239 this_command_key_count
= 0;
10240 this_command_key_count_reset
= 0;
10242 if (NILP (keep_record
))
10244 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10245 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10247 recent_keys_index
= 0;
10252 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10253 doc
: /* Return the current depth in recursive edits. */)
10257 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10261 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10262 "FOpen dribble file: ",
10263 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10264 If FILE is nil, close any open dribble file. */)
10275 file
= Fexpand_file_name (file
, Qnil
);
10276 dribble
= fopen (SDATA (file
), "w");
10278 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10283 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10284 doc
: /* Discard the contents of the terminal input buffer.
10285 Also end any kbd macro being defined. */)
10288 if (!NILP (current_kboard
->defining_kbd_macro
))
10290 /* Discard the last command from the macro. */
10291 Fcancel_kbd_macro_events ();
10295 update_mode_lines
++;
10297 Vunread_command_events
= Qnil
;
10298 unread_command_char
= -1;
10300 discard_tty_input ();
10302 kbd_fetch_ptr
= kbd_store_ptr
;
10308 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10309 doc
: /* Stop Emacs and return to superior process. You can resume later.
10310 If `cannot-suspend' is non-nil, or if the system doesn't support job
10311 control, run a subshell instead.
10313 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10314 to be read as terminal input by Emacs's parent, after suspension.
10316 Before suspending, run the normal hook `suspend-hook'.
10317 After resumption run the normal hook `suspend-resume-hook'.
10319 Some operating systems cannot stop the Emacs process and resume it later.
10320 On such systems, Emacs starts a subshell instead of suspending. */)
10322 Lisp_Object stuffstring
;
10324 int count
= SPECPDL_INDEX ();
10325 int old_height
, old_width
;
10327 struct gcpro gcpro1
;
10329 if (tty_list
&& tty_list
->next
)
10330 error ("There are other tty frames open; close them before suspending Emacs");
10332 if (!NILP (stuffstring
))
10333 CHECK_STRING (stuffstring
);
10335 /* Run the functions in suspend-hook. */
10336 if (!NILP (Vrun_hooks
))
10337 call1 (Vrun_hooks
, intern ("suspend-hook"));
10339 GCPRO1 (stuffstring
);
10340 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10341 reset_all_sys_modes ();
10342 /* sys_suspend can get an error if it tries to fork a subshell
10343 and the system resources aren't available for that. */
10344 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10346 stuff_buffered_input (stuffstring
);
10347 if (cannot_suspend
)
10351 unbind_to (count
, Qnil
);
10353 /* Check if terminal/window size has changed.
10354 Note that this is not useful when we are running directly
10355 with a window system; but suspend should be disabled in that case. */
10356 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10357 if (width
!= old_width
|| height
!= old_height
)
10358 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10360 /* Run suspend-resume-hook. */
10361 if (!NILP (Vrun_hooks
))
10362 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10368 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10369 Then in any case stuff anything Emacs has read ahead and not used. */
10372 stuff_buffered_input (stuffstring
)
10373 Lisp_Object stuffstring
;
10375 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10376 register unsigned char *p
;
10378 if (STRINGP (stuffstring
))
10380 register int count
;
10382 p
= SDATA (stuffstring
);
10383 count
= SBYTES (stuffstring
);
10384 while (count
-- > 0)
10389 /* Anything we have read ahead, put back for the shell to read. */
10390 /* ?? What should this do when we have multiple keyboards??
10391 Should we ignore anything that was typed in at the "wrong" kboard?
10393 rms: we should stuff everything back into the kboard
10395 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10398 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10399 kbd_fetch_ptr
= kbd_buffer
;
10400 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10401 stuff_char (kbd_fetch_ptr
->code
);
10403 clear_event (kbd_fetch_ptr
);
10407 #endif /* SIGTSTP */
10411 set_waiting_for_input (time_to_clear
)
10412 EMACS_TIME
*time_to_clear
;
10414 input_available_clear_time
= time_to_clear
;
10416 /* Tell handle_interrupt to throw back to read_char, */
10417 waiting_for_input
= 1;
10419 /* If handle_interrupt was called before and buffered a C-g,
10420 make it run again now, to avoid timing error. */
10421 if (!NILP (Vquit_flag
))
10422 quit_throw_to_read_char ();
10426 clear_waiting_for_input ()
10428 /* Tell handle_interrupt not to throw back to read_char, */
10429 waiting_for_input
= 0;
10430 input_available_clear_time
= 0;
10433 /* The SIGINT handler.
10435 If we have a frame on the controlling tty, we assume that the
10436 SIGINT was generated by C-g, so we call handle_interrupt.
10437 Otherwise, the handler kills Emacs. */
10440 interrupt_signal (signalnum
) /* If we don't have an argument, */
10441 int signalnum
; /* some compilers complain in signal calls. */
10443 /* Must preserve main program's value of errno. */
10444 int old_errno
= errno
;
10445 struct device
*device
;
10447 #if defined (USG) && !defined (POSIX_SIGNALS)
10448 /* USG systems forget handlers when they are used;
10449 must reestablish each time */
10450 signal (SIGINT
, interrupt_signal
);
10451 signal (SIGQUIT
, interrupt_signal
);
10454 SIGNAL_THREAD_CHECK (signalnum
);
10456 /* See if we have an active display on our controlling terminal. */
10457 device
= get_named_tty (NULL
);
10460 /* If there are no frames there, let's pretend that we are a
10461 well-behaving UN*X program and quit. */
10462 fatal_error_signal (SIGTERM
);
10466 /* Otherwise, the SIGINT was probably generated by C-g. */
10468 /* Set internal_last_event_frame to the top frame of the
10469 controlling tty, if we have a frame there. We disable the
10470 interrupt key on secondary ttys, so the SIGINT must have come
10471 from the controlling tty. */
10472 internal_last_event_frame
= device
->display_info
.tty
->top_frame
;
10474 handle_interrupt ();
10480 /* This routine is called at interrupt level in response to C-g.
10482 It is called from the SIGINT handler or kbd_buffer_store_event.
10484 If `waiting_for_input' is non zero, then unless `echoing' is
10485 nonzero, immediately throw back to read_char.
10487 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10488 eval to throw, when it gets a chance. If quit-flag is already
10489 non-nil, it stops the job right away. */
10492 handle_interrupt ()
10498 /* XXX This code needs to be revised for multi-tty support. */
10499 if (!NILP (Vquit_flag
)
10501 && get_named_tty (NULL
)
10505 /* If SIGINT isn't blocked, don't let us be interrupted by
10506 another SIGINT, it might be harmful due to non-reentrancy
10507 in I/O functions. */
10508 sigblock (sigmask (SIGINT
));
10511 reset_all_sys_modes ();
10513 #ifdef SIGTSTP /* Support possible in later USG versions */
10515 * On systems which can suspend the current process and return to the original
10516 * shell, this command causes the user to end up back at the shell.
10517 * The "Auto-save" and "Abort" questions are not asked until
10518 * the user elects to return to emacs, at which point he can save the current
10519 * job and either dump core or continue.
10524 if (sys_suspend () == -1)
10526 printf ("Not running as a subprocess;\n");
10527 printf ("you can continue or abort.\n");
10529 #else /* not VMS */
10530 /* Perhaps should really fork an inferior shell?
10531 But that would not provide any way to get back
10532 to the original shell, ever. */
10533 printf ("No support for stopping a process on this operating system;\n");
10534 printf ("you can continue or abort.\n");
10535 #endif /* not VMS */
10536 #endif /* not SIGTSTP */
10538 /* We must remain inside the screen area when the internal terminal
10539 is used. Note that [Enter] is not echoed by dos. */
10542 /* It doesn't work to autosave while GC is in progress;
10543 the code used for auto-saving doesn't cope with the mark bit. */
10544 if (!gc_in_progress
)
10546 printf ("Auto-save? (y or n) ");
10548 if (((c
= getchar ()) & ~040) == 'Y')
10550 Fdo_auto_save (Qt
, Qnil
);
10552 printf ("\r\nAuto-save done");
10553 #else /* not MSDOS */
10554 printf ("Auto-save done\n");
10555 #endif /* not MSDOS */
10557 while (c
!= '\n') c
= getchar ();
10561 /* During GC, it must be safe to reenable quitting again. */
10562 Vinhibit_quit
= Qnil
;
10565 #endif /* not MSDOS */
10566 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10567 printf ("but will instead do a real quit after garbage collection ends\r\n");
10572 printf ("\r\nAbort? (y or n) ");
10573 #else /* not MSDOS */
10575 printf ("Abort (and enter debugger)? (y or n) ");
10576 #else /* not VMS */
10577 printf ("Abort (and dump core)? (y or n) ");
10578 #endif /* not VMS */
10579 #endif /* not MSDOS */
10581 if (((c
= getchar ()) & ~040) == 'Y')
10583 while (c
!= '\n') c
= getchar ();
10585 printf ("\r\nContinuing...\r\n");
10586 #else /* not MSDOS */
10587 printf ("Continuing...\n");
10588 #endif /* not MSDOS */
10590 init_all_sys_modes ();
10595 /* If executing a function that wants to be interrupted out of
10596 and the user has not deferred quitting by binding `inhibit-quit'
10597 then quit right away. */
10598 if (immediate_quit
&& NILP (Vinhibit_quit
))
10600 struct gl_state_s saved
;
10601 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10603 immediate_quit
= 0;
10606 GCPRO4 (saved
.object
, saved
.global_code
,
10607 saved
.current_syntax_table
, saved
.old_prop
);
10608 Fsignal (Qquit
, Qnil
);
10613 /* Else request quit when it's safe */
10617 if (waiting_for_input
&& !echoing
)
10618 quit_throw_to_read_char ();
10621 /* Handle a C-g by making read_char return C-g. */
10624 quit_throw_to_read_char ()
10627 /* Prevent another signal from doing this before we finish. */
10628 clear_waiting_for_input ();
10631 Vunread_command_events
= Qnil
;
10632 unread_command_char
= -1;
10634 #if 0 /* Currently, sit_for is called from read_char without turning
10635 off polling. And that can call set_waiting_for_input.
10636 It seems to be harmless. */
10637 #ifdef POLL_FOR_INPUT
10638 /* May be > 1 if in recursive minibuffer. */
10639 if (poll_suppress_count
== 0)
10643 if (FRAMEP (internal_last_event_frame
)
10644 && !EQ (internal_last_event_frame
, selected_frame
))
10645 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10648 _longjmp (getcjmp
, 1);
10651 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
10652 doc
: /* Set interrupt mode of reading keyboard input.
10653 If INTERRUPT is non-nil, Emacs will use input interrupts;
10654 otherwise Emacs uses CBREAK mode.
10656 See also `current-input-mode'. */)
10658 Lisp_Object interrupt
;
10660 int new_interrupt_input
;
10662 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10664 #ifdef HAVE_X_WINDOWS
10665 || x_display_list
!= NULL
10669 /* When using X, don't give the user a real choice,
10670 because we haven't implemented the mechanisms to support it. */
10671 #ifdef NO_SOCK_SIGIO
10672 new_interrupt_input
= 0;
10673 #else /* not NO_SOCK_SIGIO */
10674 new_interrupt_input
= 1;
10675 #endif /* NO_SOCK_SIGIO */
10678 new_interrupt_input
= !NILP (interrupt
);
10679 #else /* not SIGIO */
10680 new_interrupt_input
= 0;
10681 #endif /* not SIGIO */
10683 /* Our VMS input only works by interrupts, as of now. */
10685 new_interrupt_input
= 1;
10688 if (new_interrupt_input
!= interrupt_input
)
10690 #ifdef POLL_FOR_INPUT
10694 /* this causes startup screen to be restored and messes with the mouse */
10695 reset_all_sys_modes ();
10697 interrupt_input
= new_interrupt_input
;
10699 init_all_sys_modes ();
10702 #ifdef POLL_FOR_INPUT
10703 poll_suppress_count
= 1;
10710 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10711 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10712 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10713 C-q in key sequences.
10715 This setting only has an effect on tty display devices and only when
10716 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10718 See also `current-input-mode'. */)
10720 Lisp_Object flow
, terminal
;
10722 struct device
*d
= get_device (terminal
, 1);
10723 struct tty_display_info
*tty
;
10724 if (d
== NULL
|| d
->type
!= output_termcap
)
10726 tty
= d
->display_info
.tty
;
10728 if (tty
->flow_control
!= !NILP (flow
))
10731 /* this causes startup screen to be restored and messes with the mouse */
10732 reset_sys_modes (tty
);
10735 tty
->flow_control
= !NILP (flow
);
10738 init_sys_modes (tty
);
10744 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10745 doc
: /* Enable or disable 8-bit input on TERMINAL.
10746 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10747 bit as the Meta modifier.
10749 If META is nil, Emacs will ignore the top bit, on the assumption it is
10752 Otherwise, Emacs will accept and pass through 8-bit input without
10753 specially interpreting the top bit.
10755 This setting only has an effect on tty display devices.
10757 Optional parameter TERMINAL specifies the tty display device to use.
10758 It may be a terminal id, a frame, or nil for the terminal used by the
10759 currently selected frame.
10761 See also `current-input-mode'. */)
10763 Lisp_Object meta
, terminal
;
10765 struct device
*d
= get_device (terminal
, 1);
10766 struct tty_display_info
*tty
;
10769 if (d
== NULL
|| d
->type
!= output_termcap
)
10771 tty
= d
->display_info
.tty
;
10775 else if (EQ (meta
, Qt
))
10780 if (tty
->meta_key
!= new_meta
)
10783 /* this causes startup screen to be restored and messes with the mouse */
10784 reset_sys_modes (tty
);
10787 tty
->meta_key
= new_meta
;
10790 init_sys_modes (tty
);
10796 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10797 doc
: /* Specify character used for quitting.
10798 QUIT must be an ASCII character.
10800 This function only has an effect on the tty display on the controlling
10801 tty of the Emacs process.
10803 See also `current-input-mode'. */)
10807 struct device
*d
= get_named_tty (NULL
);
10808 struct tty_display_info
*tty
;
10809 if (d
== NULL
|| d
->type
!= output_termcap
)
10811 tty
= d
->display_info
.tty
;
10814 /* this causes startup screen to be restored and messes with the mouse */
10815 reset_sys_modes (tty
);
10818 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10819 error ("QUIT must be an ASCII character");
10821 /* Don't let this value be out of range. */
10822 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10825 init_sys_modes (tty
);
10831 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10832 doc
: /* Set mode of reading keyboard input.
10833 First arg INTERRUPT non-nil means use input interrupts;
10834 nil means use CBREAK mode.
10835 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10836 (no effect except in CBREAK mode).
10837 Third arg META t means accept 8-bit input (for a Meta key).
10838 META nil means ignore the top bit, on the assumption it is parity.
10839 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10840 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10841 See also `current-input-mode'. */)
10842 (interrupt
, flow
, meta
, quit
)
10843 Lisp_Object interrupt
, flow
, meta
, quit
;
10845 Fset_input_interrupt_mode (interrupt
);
10846 Fset_output_flow_control (flow
, Qnil
);
10847 Fset_input_meta_mode (meta
, Qnil
);
10848 Fset_quit_char (quit
);
10852 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10853 doc
: /* Return information about the way Emacs currently reads keyboard input.
10854 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10855 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10856 nil, Emacs is using CBREAK mode.
10857 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10858 terminal; this does not apply if Emacs uses interrupt-driven input.
10859 META is t if accepting 8-bit input with 8th bit as Meta flag.
10860 META nil means ignoring the top bit, on the assumption it is parity.
10861 META is neither t nor nil if accepting 8-bit input and using
10862 all 8 bits as the character code.
10863 QUIT is the character Emacs currently uses to quit.
10864 The elements of this list correspond to the arguments of
10865 `set-input-mode'. */)
10868 Lisp_Object val
[4];
10869 struct frame
*sf
= XFRAME (selected_frame
);
10871 val
[0] = interrupt_input
? Qt
: Qnil
;
10872 if (FRAME_TERMCAP_P (sf
))
10874 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10875 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10877 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10884 XSETFASTINT (val
[3], quit_char
);
10886 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10889 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10890 doc
: /* Return position information for pixel coordinates X and Y.
10891 By default, X and Y are relative to text area of the selected window.
10892 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10893 If optional fourth arg WHOLE is non-nil, X is relative to the left
10894 edge of the window.
10896 The return value is similar to a mouse click position:
10897 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10898 IMAGE (DX . DY) (WIDTH . HEIGHT))
10899 The `posn-' functions access elements of such lists. */)
10900 (x
, y
, frame_or_window
, whole
)
10901 Lisp_Object x
, y
, frame_or_window
, whole
;
10906 if (NILP (frame_or_window
))
10907 frame_or_window
= selected_window
;
10909 if (WINDOWP (frame_or_window
))
10913 CHECK_LIVE_WINDOW (frame_or_window
);
10915 w
= XWINDOW (frame_or_window
);
10916 XSETINT (x
, (XINT (x
)
10917 + WINDOW_LEFT_EDGE_X (w
)
10919 ? window_box_left_offset (w
, TEXT_AREA
)
10921 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10922 frame_or_window
= w
->frame
;
10925 CHECK_LIVE_FRAME (frame_or_window
);
10927 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10930 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10931 doc
: /* Return position information for buffer POS in WINDOW.
10932 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10934 Return nil if position is not visible in window. Otherwise,
10935 the return value is similar to that returned by `event-start' for
10936 a mouse click at the upper left corner of the glyph corresponding
10937 to the given buffer position:
10938 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10939 IMAGE (DX . DY) (WIDTH . HEIGHT))
10940 The `posn-' functions access elements of such lists. */)
10942 Lisp_Object pos
, window
;
10947 window
= selected_window
;
10949 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10952 Lisp_Object x
= XCAR (tem
);
10953 Lisp_Object y
= XCAR (XCDR (tem
));
10955 /* Point invisible due to hscrolling? */
10958 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10966 * Set up a new kboard object with reasonable initial values.
10972 kb
->Voverriding_terminal_local_map
= Qnil
;
10973 kb
->Vlast_command
= Qnil
;
10974 kb
->Vreal_last_command
= Qnil
;
10975 kb
->Vkeyboard_translate_table
= Qnil
;
10976 kb
->Vprefix_arg
= Qnil
;
10977 kb
->Vlast_prefix_arg
= Qnil
;
10978 kb
->kbd_queue
= Qnil
;
10979 kb
->kbd_queue_has_data
= 0;
10980 kb
->immediate_echo
= 0;
10981 kb
->echo_string
= Qnil
;
10982 kb
->echo_after_prompt
= -1;
10983 kb
->kbd_macro_buffer
= 0;
10984 kb
->kbd_macro_bufsize
= 0;
10985 kb
->defining_kbd_macro
= Qnil
;
10986 kb
->Vlast_kbd_macro
= Qnil
;
10987 kb
->reference_count
= 0;
10988 kb
->Vsystem_key_alist
= Qnil
;
10989 kb
->system_key_syms
= Qnil
;
10990 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
10991 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
10992 kb
->Vlocal_key_translation_map
= Fmake_sparse_keymap (Qnil
);
10993 Fset_keymap_parent (kb
->Vlocal_key_translation_map
, Vkey_translation_map
);
10994 kb
->Vdefault_minibuffer_frame
= Qnil
;
10998 * Destroy the contents of a kboard object, but not the object itself.
10999 * We use this just before deleting it, or if we're going to initialize
11000 * it a second time.
11006 if (kb
->kbd_macro_buffer
)
11007 xfree (kb
->kbd_macro_buffer
);
11010 #ifdef MULTI_KBOARD
11012 /* Free KB and memory referenced from it. */
11020 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11023 *kbp
= kb
->next_kboard
;
11025 /* Prevent a dangling reference to KB. */
11026 if (kb
== current_kboard
11027 && FRAMEP (selected_frame
)
11028 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11030 current_kboard
= XFRAME (selected_frame
)->device
->kboard
;
11031 if (current_kboard
== kb
)
11039 #endif /* MULTI_KBOARD */
11044 /* This is correct before outermost invocation of the editor loop */
11045 command_loop_level
= -1;
11046 immediate_quit
= 0;
11047 quit_char
= Ctl ('g');
11048 Vunread_command_events
= Qnil
;
11049 unread_command_char
= -1;
11050 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11052 recent_keys_index
= 0;
11053 kbd_fetch_ptr
= kbd_buffer
;
11054 kbd_store_ptr
= kbd_buffer
;
11056 do_mouse_tracking
= Qnil
;
11060 /* This means that command_loop_1 won't try to select anything the first
11062 internal_last_event_frame
= Qnil
;
11063 Vlast_event_frame
= internal_last_event_frame
;
11065 #ifdef MULTI_KBOARD
11066 current_kboard
= initial_kboard
;
11068 wipe_kboard (current_kboard
);
11069 init_kboard (current_kboard
);
11071 if (!noninteractive
)
11073 /* Before multi-tty support, these handlers used to be installed
11074 only if the current session was a tty session. Now an Emacs
11075 session may have multiple display types, so we always handle
11076 SIGINT. There is special code in interrupt_signal to exit
11077 Emacs on SIGINT when there are no termcap frames on the
11078 controlling terminal. */
11079 signal (SIGINT
, interrupt_signal
);
11080 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11081 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11082 SIGQUIT and we can't tell which one it will give us. */
11083 signal (SIGQUIT
, interrupt_signal
);
11084 #endif /* HAVE_TERMIO */
11086 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11088 if (!noninteractive
)
11089 signal (SIGIO
, input_available_signal
);
11092 /* Use interrupt input by default, if it works and noninterrupt input
11093 has deficiencies. */
11095 #ifdef INTERRUPT_INPUT
11096 interrupt_input
= 1;
11098 interrupt_input
= 0;
11101 /* Our VMS input only works by interrupts, as of now. */
11103 interrupt_input
= 1;
11109 if (keyboard_init_hook
)
11110 (*keyboard_init_hook
) ();
11112 #ifdef POLL_FOR_INPUT
11113 poll_suppress_count
= 1;
11118 /* This type's only use is in syms_of_keyboard, to initialize the
11119 event header symbols and put properties on them. */
11120 struct event_head
{
11126 struct event_head head_table
[] = {
11127 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11128 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11129 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11130 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11131 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11132 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11133 /* `select-window' should be handled just like `switch-frame'
11134 in read_key_sequence. */
11135 {&Qselect_window
, "select-window", &Qswitch_frame
}
11139 syms_of_keyboard ()
11141 Vpre_help_message
= Qnil
;
11142 staticpro (&Vpre_help_message
);
11144 Vlispy_mouse_stem
= build_string ("mouse");
11145 staticpro (&Vlispy_mouse_stem
);
11148 QCimage
= intern (":image");
11149 staticpro (&QCimage
);
11151 staticpro (&Qhelp_echo
);
11152 Qhelp_echo
= intern ("help-echo");
11154 staticpro (&item_properties
);
11155 item_properties
= Qnil
;
11157 staticpro (&tool_bar_item_properties
);
11158 tool_bar_item_properties
= Qnil
;
11159 staticpro (&tool_bar_items_vector
);
11160 tool_bar_items_vector
= Qnil
;
11162 staticpro (&real_this_command
);
11163 real_this_command
= Qnil
;
11165 Qtimer_event_handler
= intern ("timer-event-handler");
11166 staticpro (&Qtimer_event_handler
);
11168 Qdisabled_command_function
= intern ("disabled-command-function");
11169 staticpro (&Qdisabled_command_function
);
11171 Qself_insert_command
= intern ("self-insert-command");
11172 staticpro (&Qself_insert_command
);
11174 Qforward_char
= intern ("forward-char");
11175 staticpro (&Qforward_char
);
11177 Qbackward_char
= intern ("backward-char");
11178 staticpro (&Qbackward_char
);
11180 Qdisabled
= intern ("disabled");
11181 staticpro (&Qdisabled
);
11183 Qundefined
= intern ("undefined");
11184 staticpro (&Qundefined
);
11186 Qpre_command_hook
= intern ("pre-command-hook");
11187 staticpro (&Qpre_command_hook
);
11189 Qpost_command_hook
= intern ("post-command-hook");
11190 staticpro (&Qpost_command_hook
);
11192 Qdeferred_action_function
= intern ("deferred-action-function");
11193 staticpro (&Qdeferred_action_function
);
11195 Qcommand_hook_internal
= intern ("command-hook-internal");
11196 staticpro (&Qcommand_hook_internal
);
11198 Qfunction_key
= intern ("function-key");
11199 staticpro (&Qfunction_key
);
11200 Qmouse_click
= intern ("mouse-click");
11201 staticpro (&Qmouse_click
);
11202 #if defined (WINDOWSNT) || defined (MAC_OS)
11203 Qlanguage_change
= intern ("language-change");
11204 staticpro (&Qlanguage_change
);
11206 Qdrag_n_drop
= intern ("drag-n-drop");
11207 staticpro (&Qdrag_n_drop
);
11209 Qsave_session
= intern ("save-session");
11210 staticpro (&Qsave_session
);
11213 Qmac_apple_event
= intern ("mac-apple-event");
11214 staticpro (&Qmac_apple_event
);
11217 Qusr1_signal
= intern ("usr1-signal");
11218 staticpro (&Qusr1_signal
);
11219 Qusr2_signal
= intern ("usr2-signal");
11220 staticpro (&Qusr2_signal
);
11222 Qmenu_enable
= intern ("menu-enable");
11223 staticpro (&Qmenu_enable
);
11224 Qmenu_alias
= intern ("menu-alias");
11225 staticpro (&Qmenu_alias
);
11226 QCenable
= intern (":enable");
11227 staticpro (&QCenable
);
11228 QCvisible
= intern (":visible");
11229 staticpro (&QCvisible
);
11230 QChelp
= intern (":help");
11231 staticpro (&QChelp
);
11232 QCfilter
= intern (":filter");
11233 staticpro (&QCfilter
);
11234 QCbutton
= intern (":button");
11235 staticpro (&QCbutton
);
11236 QCkeys
= intern (":keys");
11237 staticpro (&QCkeys
);
11238 QCkey_sequence
= intern (":key-sequence");
11239 staticpro (&QCkey_sequence
);
11240 QCtoggle
= intern (":toggle");
11241 staticpro (&QCtoggle
);
11242 QCradio
= intern (":radio");
11243 staticpro (&QCradio
);
11245 Qmode_line
= intern ("mode-line");
11246 staticpro (&Qmode_line
);
11247 Qvertical_line
= intern ("vertical-line");
11248 staticpro (&Qvertical_line
);
11249 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11250 staticpro (&Qvertical_scroll_bar
);
11251 Qmenu_bar
= intern ("menu-bar");
11252 staticpro (&Qmenu_bar
);
11255 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11256 staticpro (&Qmouse_fixup_help_message
);
11259 Qabove_handle
= intern ("above-handle");
11260 staticpro (&Qabove_handle
);
11261 Qhandle
= intern ("handle");
11262 staticpro (&Qhandle
);
11263 Qbelow_handle
= intern ("below-handle");
11264 staticpro (&Qbelow_handle
);
11265 Qup
= intern ("up");
11267 Qdown
= intern ("down");
11268 staticpro (&Qdown
);
11269 Qtop
= intern ("top");
11271 Qbottom
= intern ("bottom");
11272 staticpro (&Qbottom
);
11273 Qend_scroll
= intern ("end-scroll");
11274 staticpro (&Qend_scroll
);
11275 Qratio
= intern ("ratio");
11276 staticpro (&Qratio
);
11278 Qevent_kind
= intern ("event-kind");
11279 staticpro (&Qevent_kind
);
11280 Qevent_symbol_elements
= intern ("event-symbol-elements");
11281 staticpro (&Qevent_symbol_elements
);
11282 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11283 staticpro (&Qevent_symbol_element_mask
);
11284 Qmodifier_cache
= intern ("modifier-cache");
11285 staticpro (&Qmodifier_cache
);
11287 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11288 staticpro (&Qrecompute_lucid_menubar
);
11289 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11290 staticpro (&Qactivate_menubar_hook
);
11292 Qpolling_period
= intern ("polling-period");
11293 staticpro (&Qpolling_period
);
11295 Qinput_method_function
= intern ("input-method-function");
11296 staticpro (&Qinput_method_function
);
11298 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11299 staticpro (&Qinput_method_exit_on_first_char
);
11300 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11301 staticpro (&Qinput_method_use_echo_area
);
11303 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11304 Fset (Qinput_method_use_echo_area
, Qnil
);
11306 last_point_position_buffer
= Qnil
;
11309 struct event_head
*p
;
11311 for (p
= head_table
;
11312 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11315 *p
->var
= intern (p
->name
);
11316 staticpro (p
->var
);
11317 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11318 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11322 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11323 staticpro (&button_down_location
);
11324 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11325 staticpro (&mouse_syms
);
11326 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11327 staticpro (&wheel_syms
);
11331 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11333 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11334 for (i
= 0; i
< len
; i
++)
11335 if (modifier_names
[i
])
11336 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11337 staticpro (&modifier_symbols
);
11340 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11341 staticpro (&recent_keys
);
11343 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11344 staticpro (&this_command_keys
);
11346 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11347 staticpro (&raw_keybuf
);
11349 Qextended_command_history
= intern ("extended-command-history");
11350 Fset (Qextended_command_history
, Qnil
);
11351 staticpro (&Qextended_command_history
);
11353 accent_key_syms
= Qnil
;
11354 staticpro (&accent_key_syms
);
11356 func_key_syms
= Qnil
;
11357 staticpro (&func_key_syms
);
11359 drag_n_drop_syms
= Qnil
;
11360 staticpro (&drag_n_drop_syms
);
11362 unread_switch_frame
= Qnil
;
11363 staticpro (&unread_switch_frame
);
11365 internal_last_event_frame
= Qnil
;
11366 staticpro (&internal_last_event_frame
);
11368 read_key_sequence_cmd
= Qnil
;
11369 staticpro (&read_key_sequence_cmd
);
11371 menu_bar_one_keymap_changed_items
= Qnil
;
11372 staticpro (&menu_bar_one_keymap_changed_items
);
11374 menu_bar_items_vector
= Qnil
;
11375 staticpro (&menu_bar_items_vector
);
11377 defsubr (&Sevent_convert_list
);
11378 defsubr (&Sread_key_sequence
);
11379 defsubr (&Sread_key_sequence_vector
);
11380 defsubr (&Srecursive_edit
);
11382 defsubr (&Strack_mouse
);
11384 defsubr (&Sinput_pending_p
);
11385 defsubr (&Scommand_execute
);
11386 defsubr (&Srecent_keys
);
11387 defsubr (&Sthis_command_keys
);
11388 defsubr (&Sthis_command_keys_vector
);
11389 defsubr (&Sthis_single_command_keys
);
11390 defsubr (&Sthis_single_command_raw_keys
);
11391 defsubr (&Sreset_this_command_lengths
);
11392 defsubr (&Sclear_this_command_keys
);
11393 defsubr (&Ssuspend_emacs
);
11394 defsubr (&Sabort_recursive_edit
);
11395 defsubr (&Sexit_recursive_edit
);
11396 defsubr (&Srecursion_depth
);
11397 defsubr (&Stop_level
);
11398 defsubr (&Sdiscard_input
);
11399 defsubr (&Sopen_dribble_file
);
11400 defsubr (&Sset_input_interrupt_mode
);
11401 defsubr (&Sset_output_flow_control
);
11402 defsubr (&Sset_input_meta_mode
);
11403 defsubr (&Sset_quit_char
);
11404 defsubr (&Sset_input_mode
);
11405 defsubr (&Scurrent_input_mode
);
11406 defsubr (&Sexecute_extended_command
);
11407 defsubr (&Sposn_at_point
);
11408 defsubr (&Sposn_at_x_y
);
11410 DEFVAR_LISP ("last-command-char", &last_command_char
,
11411 doc
: /* Last input event that was part of a command. */);
11413 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11414 doc
: /* Last input event that was part of a command. */);
11416 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11417 doc
: /* Last input event in a command, except for mouse menu events.
11418 Mouse menus give back keys that don't look like mouse events;
11419 this variable holds the actual mouse event that led to the menu,
11420 so that you can determine whether the command was run by mouse or not. */);
11422 DEFVAR_LISP ("last-input-char", &last_input_char
,
11423 doc
: /* Last input event. */);
11425 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11426 doc
: /* Last input event. */);
11428 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11429 doc
: /* List of events to be read as the command input.
11430 These events are processed first, before actual keyboard input. */);
11431 Vunread_command_events
= Qnil
;
11433 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11434 doc
: /* If not -1, an object to be read as next command input event. */);
11436 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11437 doc
: /* List of events to be processed as input by input methods.
11438 These events are processed after `unread-command-events', but
11439 before actual keyboard input. */);
11440 Vunread_post_input_method_events
= Qnil
;
11442 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11443 doc
: /* List of events to be processed as input by input methods.
11444 These events are processed after `unread-command-events', but
11445 before actual keyboard input. */);
11446 Vunread_input_method_events
= Qnil
;
11448 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11449 doc
: /* Meta-prefix character code.
11450 Meta-foo as command input turns into this character followed by foo. */);
11451 XSETINT (meta_prefix_char
, 033);
11453 DEFVAR_KBOARD ("last-command", Vlast_command
,
11454 doc
: /* The last command executed.
11455 Normally a symbol with a function definition, but can be whatever was found
11456 in the keymap, or whatever the variable `this-command' was set to by that
11459 The value `mode-exit' is special; it means that the previous command
11460 read an event that told it to exit, and it did so and unread that event.
11461 In other words, the present command is the event that made the previous
11464 The value `kill-region' is special; it means that the previous command
11465 was a kill command.
11467 `last-command' has a separate binding for each display device.
11468 See Info node `(elisp)Multiple displays'. */);
11470 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11471 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11473 DEFVAR_LISP ("this-command", &Vthis_command
,
11474 doc
: /* The command now being executed.
11475 The command can set this variable; whatever is put here
11476 will be in `last-command' during the following command. */);
11477 Vthis_command
= Qnil
;
11479 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11480 doc
: /* The command bound to the current key sequence before remapping.
11481 It equals `this-command' if the original command was not remapped through
11482 any of the active keymaps. Otherwise, the value of `this-command' is the
11483 result of looking up the original command in the active keymaps. */);
11484 Vthis_original_command
= Qnil
;
11486 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11487 doc
: /* *Number of input events between auto-saves.
11488 Zero means disable autosaving due to number of characters typed. */);
11489 auto_save_interval
= 300;
11491 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11492 doc
: /* *Number of seconds idle time before auto-save.
11493 Zero or nil means disable auto-saving due to idleness.
11494 After auto-saving due to this many seconds of idle time,
11495 Emacs also does a garbage collection if that seems to be warranted. */);
11496 XSETFASTINT (Vauto_save_timeout
, 30);
11498 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11499 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11500 The value may be integer or floating point. */);
11501 Vecho_keystrokes
= make_number (1);
11503 DEFVAR_INT ("polling-period", &polling_period
,
11504 doc
: /* *Interval between polling for input during Lisp execution.
11505 The reason for polling is to make C-g work to stop a running program.
11506 Polling is needed only when using X windows and SIGIO does not work.
11507 Polling is automatically disabled in all other cases. */);
11508 polling_period
= 2;
11510 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11511 doc
: /* *Maximum time between mouse clicks to make a double-click.
11512 Measured in milliseconds. nil means disable double-click recognition;
11513 t means double-clicks have no time limit and are detected
11514 by position only. */);
11515 Vdouble_click_time
= make_number (500);
11517 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11518 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11519 On window-system frames, value is the number of pixels the mouse may have
11520 moved horizontally or vertically between two clicks to make a double-click.
11521 On non window-system frames, value is interpreted in units of 1/8 characters
11524 This variable is also the threshold for motion of the mouse
11525 to count as a drag. */);
11526 double_click_fuzz
= 3;
11528 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11529 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11530 inhibit_local_menu_bar_menus
= 0;
11532 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11533 doc
: /* Number of complete key sequences read as input so far.
11534 This includes key sequences read from keyboard macros.
11535 The number is effectively the number of interactive command invocations. */);
11536 num_input_keys
= 0;
11538 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11539 doc
: /* Number of input events read from the keyboard so far.
11540 This does not include events generated by keyboard macros. */);
11541 num_nonmacro_input_events
= 0;
11543 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11544 doc
: /* The frame in which the most recently read event occurred.
11545 If the last event came from a keyboard macro, this is set to `macro'. */);
11546 Vlast_event_frame
= Qnil
;
11548 /* This variable is set up in sysdep.c. */
11549 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11550 doc
: /* The ERASE character as set by the user with stty. */);
11552 DEFVAR_LISP ("help-char", &Vhelp_char
,
11553 doc
: /* Character to recognize as meaning Help.
11554 When it is read, do `(eval help-form)', and display result if it's a string.
11555 If the value of `help-form' is nil, this char can be read normally. */);
11556 XSETINT (Vhelp_char
, Ctl ('H'));
11558 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11559 doc
: /* List of input events to recognize as meaning Help.
11560 These work just like the value of `help-char' (see that). */);
11561 Vhelp_event_list
= Qnil
;
11563 DEFVAR_LISP ("help-form", &Vhelp_form
,
11564 doc
: /* Form to execute when character `help-char' is read.
11565 If the form returns a string, that string is displayed.
11566 If `help-form' is nil, the help char is not recognized. */);
11569 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11570 doc
: /* Command to run when `help-char' character follows a prefix key.
11571 This command is used only when there is no actual binding
11572 for that character after that prefix key. */);
11573 Vprefix_help_command
= Qnil
;
11575 DEFVAR_LISP ("top-level", &Vtop_level
,
11576 doc
: /* Form to evaluate when Emacs starts up.
11577 Useful to set before you dump a modified Emacs. */);
11580 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11581 doc
: /* Translate table for local keyboard input, or nil.
11582 If non-nil, the value should be a char-table. Each character read
11583 from the keyboard is looked up in this char-table. If the value found
11584 there is non-nil, then it is used instead of the actual input character.
11586 The value can also be a string or vector, but this is considered obsolete.
11587 If it is a string or vector of length N, character codes N and up are left
11588 untranslated. In a vector, an element which is nil means "no translation".
11590 This is applied to the characters supplied to input methods, not their
11591 output. See also `translation-table-for-input'.
11593 `local-keyboard-translate-table' has a separate binding for each
11594 terminal. See Info node `(elisp)Multiple displays'. */);
11596 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11597 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11598 \(Even if the operating system has support for stopping a process.\) */);
11599 cannot_suspend
= 0;
11601 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11602 doc
: /* Non-nil means prompt with menus when appropriate.
11603 This is done when reading from a keymap that has a prompt string,
11604 for elements that have prompt strings.
11605 The menu is displayed on the screen
11606 if X menus were enabled at configuration
11607 time and the previous event was a mouse click prefix key.
11608 Otherwise, menu prompting uses the echo area. */);
11609 menu_prompting
= 1;
11611 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11612 doc
: /* Character to see next line of menu prompt.
11613 Type this character while in a menu prompt to rotate around the lines of it. */);
11614 XSETINT (menu_prompt_more_char
, ' ');
11616 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11617 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11618 Emacs applies the modifiers of the character stored here to each keyboard
11619 character it reads. For example, after evaluating the expression
11620 (setq extra-keyboard-modifiers ?\\C-x)
11621 all input characters will have the control modifier applied to them.
11623 Note that the character ?\\C-@, equivalent to the integer zero, does
11624 not count as a control character; rather, it counts as a character
11625 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11626 cancels any modification. */);
11627 extra_keyboard_modifiers
= 0;
11629 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11630 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11631 The command loop sets this to nil before each command,
11632 and tests the value when the command returns.
11633 Buffer modification stores t in this variable. */);
11634 Vdeactivate_mark
= Qnil
;
11636 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11637 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11638 Vcommand_hook_internal
= Qnil
;
11640 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11641 doc
: /* Normal hook run before each command is executed.
11642 If an unhandled error happens in running this hook,
11643 the hook value is set to nil, since otherwise the error
11644 might happen repeatedly and make Emacs nonfunctional. */);
11645 Vpre_command_hook
= Qnil
;
11647 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11648 doc
: /* Normal hook run after each command is executed.
11649 If an unhandled error happens in running this hook,
11650 the hook value is set to nil, since otherwise the error
11651 might happen repeatedly and make Emacs nonfunctional. */);
11652 Vpost_command_hook
= Qnil
;
11655 DEFVAR_LISP ("echo-area-clear-hook", ...,
11656 doc
: /* Normal hook run when clearing the echo area. */);
11658 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11659 staticpro (&Qecho_area_clear_hook
);
11660 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11662 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11663 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11664 Vlucid_menu_bar_dirty_flag
= Qnil
;
11666 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11667 doc
: /* List of menu bar items to move to the end of the menu bar.
11668 The elements of the list are event types that may have menu bar bindings. */);
11669 Vmenu_bar_final_items
= Qnil
;
11671 DEFVAR_KBOARD ("overriding-terminal-local-map",
11672 Voverriding_terminal_local_map
,
11673 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11674 If this variable is non-nil, it is used as a keymap instead of the
11675 buffer's local map, and the minor mode keymaps and text property keymaps.
11676 It also replaces `overriding-local-map'.
11678 This variable is intended to let commands such as `universal-argument'
11679 set up a different keymap for reading the next command.
11681 `overriding-terminal-local-map' has a separate binding for each display device.
11682 See Info node `(elisp)Multiple displays'. */);
11684 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11685 doc
: /* Keymap that overrides all other local keymaps.
11686 If this variable is non-nil, it is used as a keymap--replacing the
11687 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11688 Voverriding_local_map
= Qnil
;
11690 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11691 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11692 Otherwise, the menu bar continues to reflect the buffer's local map
11693 and the minor mode maps regardless of `overriding-local-map'. */);
11694 Voverriding_local_map_menu_flag
= Qnil
;
11696 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11697 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11698 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11700 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11701 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11703 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11704 doc
: /* Alist of system-specific X windows key symbols.
11705 Each element should have the form (N . SYMBOL) where N is the
11706 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11707 and SYMBOL is its name.
11709 `system-key-alist' has a separate binding for each display device.
11710 See Info node `(elisp)Multiple displays'. */);
11712 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11713 doc
: /* Keymap that translates key sequences to key sequences during input.
11714 This is used mainly for mapping ASCII function key sequences into
11715 real Emacs function key events (symbols).
11717 The `read-key-sequence' function replaces any subsequence bound by
11718 `local-function-key-map' with its binding. More precisely, when the
11719 active keymaps have no binding for the current key sequence but
11720 `local-function-key-map' binds a suffix of the sequence to a vector or
11721 string, `read-key-sequence' replaces the matching suffix with its
11722 binding, and continues with the new sequence.
11724 The events that come from bindings in `local-function-key-map' are not
11725 themselves looked up in `local-function-key-map'.
11727 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11728 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11729 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11730 typing `ESC O P x' would return [f1 x].
11732 `local-function-key-map' has a separate binding for each display
11733 device. See Info node `(elisp)Multiple displays'. If you need to
11734 define a binding on all display devices, change `function-key-map'
11735 instead. Initially, `local-function-key-map' is an empty keymap that
11736 has `function-key-map' as its parent on all display devices. */);
11738 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
11739 doc
: /* The parent keymap of all `local-function-key-map' instances.
11740 Function key definitions that apply to all display devices should go
11741 here. If a mapping is defined in both the current
11742 `local-function-key-map' binding and this variable, then the local
11743 definition will take precendence. */);
11744 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11746 DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map
,
11747 doc
: /* Keymap of key translations that can override keymaps.
11748 This keymap works like `function-key-map', but comes after that,
11749 and its non-prefix bindings override ordinary bindings.
11751 `key-translation-map' has a separate binding for each display device.
11752 (See Info node `(elisp)Multiple displays'.) If you need to set a key
11753 translation on all devices, change `global-key-translation-map' instead. */);
11755 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
11756 doc
: /* The parent keymap of all `local-key-translation-map' instances.
11757 Key translations that apply to all display devices should go here. */);
11758 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11760 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11761 doc
: /* List of deferred actions to be performed at a later time.
11762 The precise format isn't relevant here; we just check whether it is nil. */);
11763 Vdeferred_action_list
= Qnil
;
11765 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11766 doc
: /* Function to call to handle deferred actions, after each command.
11767 This function is called with no arguments after each command
11768 whenever `deferred-action-list' is non-nil. */);
11769 Vdeferred_action_function
= Qnil
;
11771 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11772 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11773 The value can be a length of time to show the message for.
11774 If the value is non-nil and not a number, we wait 2 seconds. */);
11775 Vsuggest_key_bindings
= Qt
;
11777 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11778 doc
: /* List of active absolute time timers in order of increasing time. */);
11779 Vtimer_list
= Qnil
;
11781 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11782 doc
: /* List of active idle-time timers in order of increasing time. */);
11783 Vtimer_idle_list
= Qnil
;
11785 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11786 doc
: /* If non-nil, the function that implements the current input method.
11787 It's called with one argument, a printing character that was just read.
11788 \(That means a character with code 040...0176.)
11789 Typically this function uses `read-event' to read additional events.
11790 When it does so, it should first bind `input-method-function' to nil
11791 so it will not be called recursively.
11793 The function should return a list of zero or more events
11794 to be used as input. If it wants to put back some events
11795 to be reconsidered, separately, by the input method,
11796 it can add them to the beginning of `unread-command-events'.
11798 The input method function can find in `input-method-previous-method'
11799 the previous echo area message.
11801 The input method function should refer to the variables
11802 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11803 for guidance on what to do. */);
11804 Vinput_method_function
= Qnil
;
11806 DEFVAR_LISP ("input-method-previous-message",
11807 &Vinput_method_previous_message
,
11808 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11809 This variable exists because `read-event' clears the echo area
11810 before running the input method. It is nil if there was no message. */);
11811 Vinput_method_previous_message
= Qnil
;
11813 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11814 doc
: /* If non-nil, the function that implements the display of help.
11815 It's called with one argument, the help string to display. */);
11816 Vshow_help_function
= Qnil
;
11818 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11819 doc
: /* If non-nil, suppress point adjustment after executing a command.
11821 After a command is executed, if point is moved into a region that has
11822 special properties (e.g. composition, display), we adjust point to
11823 the boundary of the region. But, when a command sets this variable to
11824 non-nil, we suppress the point adjustment.
11826 This variable is set to nil before reading a command, and is checked
11827 just after executing the command. */);
11828 Vdisable_point_adjustment
= Qnil
;
11830 DEFVAR_LISP ("global-disable-point-adjustment",
11831 &Vglobal_disable_point_adjustment
,
11832 doc
: /* *If non-nil, always suppress point adjustment.
11834 The default value is nil, in which case, point adjustment are
11835 suppressed only after special commands that set
11836 `disable-point-adjustment' (which see) to non-nil. */);
11837 Vglobal_disable_point_adjustment
= Qnil
;
11839 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11840 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11841 If the value is not a number, such messages don't time out. */);
11842 Vminibuffer_message_timeout
= make_number (2);
11844 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11845 doc
: /* If non-nil, any keyboard input throws to this symbol.
11846 The value of that variable is passed to `quit-flag' and later causes a
11847 peculiar kind of quitting. */);
11848 Vthrow_on_input
= Qnil
;
11852 keys_of_keyboard ()
11854 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11855 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11856 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11857 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11858 initial_define_key (meta_map
, 'x', "execute-extended-command");
11860 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11861 "handle-delete-frame");
11862 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11863 current-prefix-arg, as is done in `handle-switch-frame'.
11864 But `handle-switch-frame is not run from the special-map.
11865 Commands from that map are run in a special way that automatically
11866 preserves the prefix-arg. Restoring the prefix arg here is not just
11867 redundant but harmful:
11869 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11870 - after the first prompt, the exit-minibuffer-hook is run which may
11871 iconify a frame and thus push a `iconify-frame' event.
11872 - after running exit-minibuffer-hook, current-prefix-arg is
11873 restored to the non-nil value it had before the prompt.
11874 - we enter the second prompt.
11875 current-prefix-arg is non-nil, prefix-arg is nil.
11876 - before running the first real event, we run the special iconify-frame
11877 event, but we pass the `special' arg to execute-command so
11878 current-prefix-arg and prefix-arg are left untouched.
11879 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11880 - the next key event will have a spuriously non-nil current-prefix-arg. */
11881 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11883 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11885 /* Handling it at such a low-level causes read_key_sequence to get
11886 * confused because it doesn't realize that the current_buffer was
11887 * changed by read_char.
11889 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11890 * "handle-select-window"); */
11891 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11892 "handle-save-session");
11895 /* Mark the pointers in the kboard objects.
11896 Called by the Fgarbage_collector. */
11902 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11904 if (kb
->kbd_macro_buffer
)
11905 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11907 mark_object (kb
->Voverriding_terminal_local_map
);
11908 mark_object (kb
->Vlast_command
);
11909 mark_object (kb
->Vreal_last_command
);
11910 mark_object (kb
->Vkeyboard_translate_table
);
11911 mark_object (kb
->Vprefix_arg
);
11912 mark_object (kb
->Vlast_prefix_arg
);
11913 mark_object (kb
->kbd_queue
);
11914 mark_object (kb
->defining_kbd_macro
);
11915 mark_object (kb
->Vlast_kbd_macro
);
11916 mark_object (kb
->Vsystem_key_alist
);
11917 mark_object (kb
->system_key_syms
);
11918 mark_object (kb
->Vlocal_function_key_map
);
11919 mark_object (kb
->Vlocal_key_translation_map
);
11920 mark_object (kb
->Vdefault_minibuffer_frame
);
11921 mark_object (kb
->echo_string
);
11924 struct input_event
*event
;
11925 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11927 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11928 event
= kbd_buffer
;
11929 if (event
->kind
!= SELECTION_REQUEST_EVENT
11930 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11932 mark_object (event
->x
);
11933 mark_object (event
->y
);
11935 mark_object (event
->frame_or_window
);
11936 mark_object (event
->arg
);
11941 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11942 (do not change this comment) */