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 started. */
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 window that was selected when the last command was started. */
387 Lisp_Object last_point_position_window
;
389 /* The frame in which the last input event occurred, or Qmacro if the
390 last event came from a macro. We use this to determine when to
391 generate switch-frame events. This may be cleared by functions
392 like Fselect_frame, to make sure that a switch-frame event is
393 generated by the next character. */
394 Lisp_Object internal_last_event_frame
;
396 /* A user-visible version of the above, intended to allow users to
397 figure out where the last event came from, if the event doesn't
398 carry that information itself (i.e. if it was a character). */
399 Lisp_Object Vlast_event_frame
;
401 /* The timestamp of the last input event we received from the X server.
402 X Windows wants this for selection ownership. */
403 unsigned long last_event_timestamp
;
405 Lisp_Object Qself_insert_command
;
406 Lisp_Object Qforward_char
;
407 Lisp_Object Qbackward_char
;
408 Lisp_Object Qundefined
;
409 Lisp_Object Qtimer_event_handler
;
411 /* read_key_sequence stores here the command definition of the
412 key sequence that it reads. */
413 Lisp_Object read_key_sequence_cmd
;
415 /* Echo unfinished commands after this many seconds of pause. */
416 Lisp_Object Vecho_keystrokes
;
418 /* Form to evaluate (if non-nil) when Emacs is started. */
419 Lisp_Object Vtop_level
;
421 /* If non-nil, this implements the current input method. */
422 Lisp_Object Vinput_method_function
;
423 Lisp_Object Qinput_method_function
;
425 /* When we call Vinput_method_function,
426 this holds the echo area message that was just erased. */
427 Lisp_Object Vinput_method_previous_message
;
429 /* Non-nil means deactivate the mark at end of this command. */
430 Lisp_Object Vdeactivate_mark
;
432 /* Menu bar specified in Lucid Emacs fashion. */
434 Lisp_Object Vlucid_menu_bar_dirty_flag
;
435 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
437 Lisp_Object Qecho_area_clear_hook
;
439 /* Hooks to run before and after each command. */
440 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
441 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
442 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
444 /* Parent keymap of terminal-local function-key-map instances. */
445 Lisp_Object Vfunction_key_map
;
447 /* Parent keymap of terminal-local key-translation-map instances. */
448 Lisp_Object Vkey_translation_map
;
450 /* List of deferred actions to be performed at a later time.
451 The precise format isn't relevant here; we just check whether it is nil. */
452 Lisp_Object Vdeferred_action_list
;
454 /* Function to call to handle deferred actions, when there are any. */
455 Lisp_Object Vdeferred_action_function
;
456 Lisp_Object Qdeferred_action_function
;
458 Lisp_Object Qinput_method_exit_on_first_char
;
459 Lisp_Object Qinput_method_use_echo_area
;
461 /* File in which we write all commands we read. */
464 /* Nonzero if input is available. */
467 extern char *pending_malloc_warning
;
469 /* Circular buffer for pre-read keyboard input. */
471 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
473 /* Pointer to next available character in kbd_buffer.
474 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
475 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
476 next available char is in kbd_buffer[0]. */
477 static struct input_event
*kbd_fetch_ptr
;
479 /* Pointer to next place to store character in kbd_buffer. This
480 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
481 character should go in kbd_buffer[0]. */
482 static struct input_event
* volatile kbd_store_ptr
;
484 /* The above pair of variables forms a "queue empty" flag. When we
485 enqueue a non-hook event, we increment kbd_store_ptr. When we
486 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
487 there is input available iff the two pointers are not equal.
489 Why not just have a flag set and cleared by the enqueuing and
490 dequeuing functions? Such a flag could be screwed up by interrupts
491 at inopportune times. */
493 /* If this flag is non-nil, we check mouse_moved to see when the
494 mouse moves, and motion events will appear in the input stream.
495 Otherwise, mouse motion is ignored. */
496 Lisp_Object do_mouse_tracking
;
498 /* Symbols to head events. */
499 Lisp_Object Qmouse_movement
;
500 Lisp_Object Qscroll_bar_movement
;
501 Lisp_Object Qswitch_frame
;
502 Lisp_Object Qdelete_frame
;
503 Lisp_Object Qiconify_frame
;
504 Lisp_Object Qmake_frame_visible
;
505 Lisp_Object Qselect_window
;
506 Lisp_Object Qhelp_echo
;
509 Lisp_Object Qmouse_fixup_help_message
;
512 /* Symbols to denote kinds of events. */
513 Lisp_Object Qfunction_key
;
514 Lisp_Object Qmouse_click
;
515 #if defined (WINDOWSNT) || defined (MAC_OS)
516 Lisp_Object Qlanguage_change
;
518 Lisp_Object Qdrag_n_drop
;
519 Lisp_Object Qsave_session
;
521 Lisp_Object Qmac_apple_event
;
524 /* Lisp_Object Qmouse_movement; - also an event header */
526 /* Properties of event headers. */
527 Lisp_Object Qevent_kind
;
528 Lisp_Object Qevent_symbol_elements
;
530 /* menu item parts */
531 Lisp_Object Qmenu_alias
;
532 Lisp_Object Qmenu_enable
;
533 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
534 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
535 extern Lisp_Object Vdefine_key_rebound_commands
;
536 extern Lisp_Object Qmenu_item
;
538 /* An event header symbol HEAD may have a property named
539 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
540 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
541 mask of modifiers applied to it. If present, this is used to help
542 speed up parse_modifiers. */
543 Lisp_Object Qevent_symbol_element_mask
;
545 /* An unmodified event header BASE may have a property named
546 Qmodifier_cache, which is an alist mapping modifier masks onto
547 modified versions of BASE. If present, this helps speed up
549 Lisp_Object Qmodifier_cache
;
551 /* Symbols to use for parts of windows. */
552 Lisp_Object Qmode_line
;
553 Lisp_Object Qvertical_line
;
554 Lisp_Object Qvertical_scroll_bar
;
555 Lisp_Object Qmenu_bar
;
556 extern Lisp_Object Qleft_margin
, Qright_margin
;
557 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
558 extern Lisp_Object QCmap
;
560 Lisp_Object
recursive_edit_unwind (), command_loop ();
561 Lisp_Object
Fthis_command_keys ();
562 Lisp_Object Qextended_command_history
;
563 EMACS_TIME
timer_check ();
565 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
567 extern char *x_get_keysym_name ();
569 static void record_menu_key ();
570 static int echo_length ();
572 Lisp_Object Qpolling_period
;
574 /* List of absolute timers. Appears in order of next scheduled event. */
575 Lisp_Object Vtimer_list
;
577 /* List of idle time timers. Appears in order of next scheduled event. */
578 Lisp_Object Vtimer_idle_list
;
580 /* Incremented whenever a timer is run. */
583 extern Lisp_Object Vprint_level
, Vprint_length
;
585 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
587 EMACS_TIME
*input_available_clear_time
;
589 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
590 Default is 1 if INTERRUPT_INPUT is defined. */
593 /* Nonzero while interrupts are temporarily deferred during redisplay. */
594 int interrupts_deferred
;
596 /* Allow m- file to inhibit use of FIONREAD. */
597 #ifdef BROKEN_FIONREAD
601 /* We are unable to use interrupts if FIONREAD is not available,
602 so flush SIGIO so we won't try. */
603 #if !defined (FIONREAD)
609 /* If we support a window system, turn on the code to poll periodically
610 to detect C-g. It isn't actually used when doing interrupt input. */
611 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
612 #define POLL_FOR_INPUT
615 /* After a command is executed, if point is moved into a region that
616 has specific properties (e.g. composition, display), we adjust
617 point to the boundary of the region. But, if a command sets this
618 variable to non-nil, we suppress this point adjustment. This
619 variable is set to nil before reading a command. */
621 Lisp_Object Vdisable_point_adjustment
;
623 /* If non-nil, always disable point adjustment. */
625 Lisp_Object Vglobal_disable_point_adjustment
;
627 /* The time when Emacs started being idle. */
629 static EMACS_TIME timer_idleness_start_time
;
631 /* After Emacs stops being idle, this saves the last value
632 of timer_idleness_start_time from when it was idle. */
634 static EMACS_TIME timer_last_idleness_start_time
;
637 /* Global variable declarations. */
639 /* Flags for readable_events. */
640 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
641 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
642 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
644 /* Function for init_keyboard to call with no args (if nonzero). */
645 void (*keyboard_init_hook
) ();
647 static int read_avail_input
P_ ((int));
648 static void get_input_pending
P_ ((int *, int));
649 static int readable_events
P_ ((int));
650 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
651 Lisp_Object
, int *));
652 static Lisp_Object
read_char_x_menu_prompt ();
653 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
655 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
657 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
658 enum scroll_bar_part
,
659 Lisp_Object
, Lisp_Object
,
662 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
663 Lisp_Object
, char **,
664 Lisp_Object
*, unsigned));
665 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
666 static int parse_solitary_modifier
P_ ((Lisp_Object
));
667 static int parse_solitary_modifier ();
668 static void save_getcjmp
P_ ((jmp_buf));
669 static void save_getcjmp ();
670 static void restore_getcjmp
P_ ((jmp_buf));
671 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
672 static void clear_event
P_ ((struct input_event
*));
673 static void any_kboard_state
P_ ((void));
674 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
675 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
676 static void handle_interrupt
P_ ((void));
677 static void timer_start_idle
P_ ((void));
678 static void timer_stop_idle
P_ ((void));
679 static void timer_resume_idle
P_ ((void));
681 /* Nonzero means don't try to suspend even if the operating system seems
683 static int cannot_suspend
;
685 extern Lisp_Object Qidentity
, Qonly
;
687 /* Install the string STR as the beginning of the string of echoing,
688 so that it serves as a prompt for the next character.
689 Also start echoing. */
695 current_kboard
->echo_string
= str
;
696 current_kboard
->echo_after_prompt
= SCHARS (str
);
700 /* Add C to the echo string, if echoing is going on.
701 C can be a character, which is printed prettily ("M-C-x" and all that
702 jazz), or a symbol, whose name is printed. */
708 if (current_kboard
->immediate_echo
)
710 int size
= KEY_DESCRIPTION_SIZE
+ 100;
711 char *buffer
= (char *) alloca (size
);
713 Lisp_Object echo_string
;
715 echo_string
= current_kboard
->echo_string
;
717 /* If someone has passed us a composite event, use its head symbol. */
722 ptr
= push_key_description (XINT (c
), ptr
, 1);
724 else if (SYMBOLP (c
))
726 Lisp_Object name
= SYMBOL_NAME (c
);
727 int nbytes
= SBYTES (name
);
729 if (size
- (ptr
- buffer
) < nbytes
)
731 int offset
= ptr
- buffer
;
732 size
= max (2 * size
, size
+ nbytes
);
733 buffer
= (char *) alloca (size
);
734 ptr
= buffer
+ offset
;
737 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
738 STRING_MULTIBYTE (name
), 1);
741 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
744 const char *text
= " (Type ? for further options)";
745 int len
= strlen (text
);
747 if (size
- (ptr
- buffer
) < len
)
749 int offset
= ptr
- buffer
;
751 buffer
= (char *) alloca (size
);
752 ptr
= buffer
+ offset
;
755 bcopy (text
, ptr
, len
);
759 /* Replace a dash from echo_dash with a space, otherwise
760 add a space at the end as a separator between keys. */
761 if (STRINGP (echo_string
)
762 && SCHARS (echo_string
) > 1)
764 Lisp_Object last_char
, prev_char
, idx
;
766 idx
= make_number (SCHARS (echo_string
) - 2);
767 prev_char
= Faref (echo_string
, idx
);
769 idx
= make_number (SCHARS (echo_string
) - 1);
770 last_char
= Faref (echo_string
, idx
);
772 /* We test PREV_CHAR to make sure this isn't the echoing
774 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
775 Faset (echo_string
, idx
, make_number (' '));
777 echo_string
= concat2 (echo_string
, build_string (" "));
780 current_kboard
->echo_string
781 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
787 /* Temporarily add a dash to the end of the echo string if it's not
788 empty, so that it serves as a mini-prompt for the very next character. */
793 /* Do nothing if not echoing at all. */
794 if (NILP (current_kboard
->echo_string
))
797 if (!current_kboard
->immediate_echo
798 && SCHARS (current_kboard
->echo_string
) == 0)
801 /* Do nothing if we just printed a prompt. */
802 if (current_kboard
->echo_after_prompt
803 == SCHARS (current_kboard
->echo_string
))
806 /* Do nothing if we have already put a dash at the end. */
807 if (SCHARS (current_kboard
->echo_string
) > 1)
809 Lisp_Object last_char
, prev_char
, idx
;
811 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
812 prev_char
= Faref (current_kboard
->echo_string
, idx
);
814 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
815 last_char
= Faref (current_kboard
->echo_string
, idx
);
817 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
821 /* Put a dash at the end of the buffer temporarily,
822 but make it go away when the next character is added. */
823 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
828 /* Display the current echo string, and begin echoing if not already
834 if (!current_kboard
->immediate_echo
)
837 current_kboard
->immediate_echo
= 1;
839 for (i
= 0; i
< this_command_key_count
; i
++)
843 /* Set before_command_echo_length to the value that would
844 have been saved before the start of this subcommand in
845 command_loop_1, if we had already been echoing then. */
846 if (i
== this_single_command_key_start
)
847 before_command_echo_length
= echo_length ();
849 c
= XVECTOR (this_command_keys
)->contents
[i
];
850 if (! (EVENT_HAS_PARAMETERS (c
)
851 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
855 /* Set before_command_echo_length to the value that would
856 have been saved before the start of this subcommand in
857 command_loop_1, if we had already been echoing then. */
858 if (this_command_key_count
== this_single_command_key_start
)
859 before_command_echo_length
= echo_length ();
861 /* Put a dash at the end to invite the user to type more. */
866 message3_nolog (current_kboard
->echo_string
,
867 SBYTES (current_kboard
->echo_string
),
868 STRING_MULTIBYTE (current_kboard
->echo_string
));
871 /* Record in what buffer we echoed, and from which kboard. */
872 echo_message_buffer
= echo_area_buffer
[0];
873 echo_kboard
= current_kboard
;
875 if (waiting_for_input
&& !NILP (Vquit_flag
))
876 quit_throw_to_read_char ();
879 /* Turn off echoing, for the start of a new command. */
884 current_kboard
->immediate_echo
= 0;
885 current_kboard
->echo_after_prompt
= -1;
886 current_kboard
->echo_string
= Qnil
;
887 ok_to_echo_at_next_pause
= NULL
;
889 echo_message_buffer
= Qnil
;
892 /* Return the length of the current echo string. */
897 return (STRINGP (current_kboard
->echo_string
)
898 ? SCHARS (current_kboard
->echo_string
)
902 /* Truncate the current echo message to its first LEN chars.
903 This and echo_char get used by read_key_sequence when the user
904 switches frames while entering a key sequence. */
907 echo_truncate (nchars
)
910 if (STRINGP (current_kboard
->echo_string
))
911 current_kboard
->echo_string
912 = Fsubstring (current_kboard
->echo_string
,
913 make_number (0), make_number (nchars
));
914 truncate_echo_area (nchars
);
918 /* Functions for manipulating this_command_keys. */
920 add_command_key (key
)
923 #if 0 /* Not needed after we made Freset_this_command_lengths
924 do the job immediately. */
925 /* If reset-this-command-length was called recently, obey it now.
926 See the doc string of that function for an explanation of why. */
927 if (before_command_restore_flag
)
929 this_command_key_count
= before_command_key_count_1
;
930 if (this_command_key_count
< this_single_command_key_start
)
931 this_single_command_key_start
= this_command_key_count
;
932 echo_truncate (before_command_echo_length_1
);
933 before_command_restore_flag
= 0;
937 if (this_command_key_count
>= ASIZE (this_command_keys
))
938 this_command_keys
= larger_vector (this_command_keys
,
939 2 * ASIZE (this_command_keys
),
942 AREF (this_command_keys
, this_command_key_count
) = key
;
943 ++this_command_key_count
;
950 int count
= SPECPDL_INDEX ();
953 if (command_loop_level
> 0)
955 specbind (Qstandard_output
, Qt
);
956 specbind (Qstandard_input
, Qt
);
959 #ifdef HAVE_X_WINDOWS
960 /* The command loop has started an hourglass timer, so we have to
961 cancel it here, otherwise it will fire because the recursive edit
962 can take some time. Do not check for display_hourglass_p here,
963 because it could already be nil. */
967 /* This function may have been called from a debugger called from
968 within redisplay, for instance by Edebugging a function called
969 from fontification-functions. We want to allow redisplay in
970 the debugging session.
972 The recursive edit is left with a `(throw exit ...)'. The `exit'
973 tag is not caught anywhere in redisplay, i.e. when we leave the
974 recursive edit, the original redisplay leading to the recursive
975 edit will be unwound. The outcome should therefore be safe. */
976 specbind (Qinhibit_redisplay
, Qnil
);
979 val
= command_loop ();
981 Fsignal (Qquit
, Qnil
);
982 /* Handle throw from read_minibuf when using minibuffer
983 while it's active but we're in another window. */
985 Fsignal (Qerror
, Fcons (val
, Qnil
));
987 return unbind_to (count
, Qnil
);
990 /* When an auto-save happens, record the "time", and don't do again soon. */
995 last_auto_save
= num_nonmacro_input_events
;
998 /* Make an auto save happen as soon as possible at command level. */
1001 force_auto_save_soon ()
1003 last_auto_save
= - auto_save_interval
- 1;
1005 record_asynch_buffer_change ();
1008 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1009 doc
: /* Invoke the editor command loop recursively.
1010 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1011 that tells this function to return.
1012 Alternatively, `(throw 'exit t)' makes this function signal an error.
1013 This function is called by the editor initialization to begin editing. */)
1016 int count
= SPECPDL_INDEX ();
1019 /* If we enter while input is blocked, don't lock up here.
1020 This may happen through the debugger during redisplay. */
1021 if (INPUT_BLOCKED_P
)
1024 command_loop_level
++;
1025 update_mode_lines
= 1;
1027 if (command_loop_level
1028 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1029 buffer
= Fcurrent_buffer ();
1033 /* If we leave recursive_edit_1 below with a `throw' for instance,
1034 like it is done in the splash screen display, we have to
1035 make sure that we restore single_kboard as command_loop_1
1036 would have done if it were left normally. */
1037 temporarily_switch_to_single_kboard (FRAME_KBOARD (SELECTED_FRAME ()));
1038 record_unwind_protect (recursive_edit_unwind
, buffer
);
1040 recursive_edit_1 ();
1041 return unbind_to (count
, Qnil
);
1045 recursive_edit_unwind (buffer
)
1048 if (BUFFERP (buffer
))
1049 Fset_buffer (buffer
);
1051 command_loop_level
--;
1052 update_mode_lines
= 1;
1061 #if 0 /* Theory: if there's anything in Vunread_command_events,
1062 it will right away be read by read_key_sequence,
1063 and then if we do switch KBOARDS, it will go into the side
1064 queue then. So we don't need to do anything special here -- rms. */
1065 if (CONSP (Vunread_command_events
))
1067 current_kboard
->kbd_queue
1068 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1069 current_kboard
->kbd_queue_has_data
= 1;
1071 Vunread_command_events
= Qnil
;
1077 /* Switch to the single-kboard state, making current_kboard
1078 the only KBOARD from which further input is accepted. */
1081 single_kboard_state ()
1088 /* If we're in single_kboard state for kboard KBOARD,
1092 not_single_kboard_state (kboard
)
1096 if (kboard
== current_kboard
)
1101 /* Maintain a stack of kboards, so other parts of Emacs
1102 can switch temporarily to the kboard of a given frame
1103 and then revert to the previous status. */
1108 struct kboard_stack
*next
;
1111 static struct kboard_stack
*kboard_stack
;
1118 struct kboard_stack
*p
1119 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1121 p
->next
= kboard_stack
;
1122 p
->kboard
= current_kboard
;
1130 push_frame_kboard (f
)
1133 push_kboard (f
->device
->kboard
);
1141 struct kboard_stack
*p
= kboard_stack
;
1142 current_kboard
= NULL
;
1143 for (d
= device_list
; d
; d
= d
->next_device
)
1145 if (d
->kboard
== p
->kboard
)
1147 current_kboard
= p
->kboard
;
1151 if (current_kboard
== NULL
)
1153 /* The display we remembered has been deleted. */
1154 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
1156 kboard_stack
= p
->next
;
1161 /* Switch to single_kboard mode. If K is non-nil, set it as the
1162 current keyboard. Use record_unwind_protect to return to the
1163 previous state later. */
1166 temporarily_switch_to_single_kboard (k
)
1170 int was_locked
= single_kboard
;
1174 push_kboard (current_kboard
);
1175 single_kboard_state ();
1176 record_unwind_protect (restore_kboard_configuration
,
1177 (was_locked
? Qt
: Qnil
));
1182 record_single_kboard_state ()
1184 push_kboard (current_kboard
);
1185 record_unwind_protect (restore_kboard_configuration
,
1186 (single_kboard
? Qt
: Qnil
));
1190 restore_kboard_configuration (was_locked
)
1191 Lisp_Object was_locked
;
1193 if (NILP (was_locked
))
1194 any_kboard_state ();
1196 single_kboard_state ();
1201 /* Handle errors that are not handled at inner levels
1202 by printing an error message and returning to the editor command loop. */
1208 Lisp_Object old_level
, old_length
;
1209 char macroerror
[50];
1211 #ifdef HAVE_X_WINDOWS
1212 if (display_hourglass_p
)
1213 cancel_hourglass ();
1216 if (!NILP (executing_kbd_macro
))
1218 if (executing_kbd_macro_iterations
== 1)
1219 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1221 sprintf (macroerror
, "After %d kbd macro iterations: ",
1222 executing_kbd_macro_iterations
);
1227 Vstandard_output
= Qt
;
1228 Vstandard_input
= Qt
;
1229 Vexecuting_kbd_macro
= Qnil
;
1230 executing_kbd_macro
= Qnil
;
1231 current_kboard
->Vprefix_arg
= Qnil
;
1232 current_kboard
->Vlast_prefix_arg
= Qnil
;
1235 /* Avoid unquittable loop if data contains a circular list. */
1236 old_level
= Vprint_level
;
1237 old_length
= Vprint_length
;
1238 XSETFASTINT (Vprint_level
, 10);
1239 XSETFASTINT (Vprint_length
, 10);
1240 cmd_error_internal (data
, macroerror
);
1241 Vprint_level
= old_level
;
1242 Vprint_length
= old_length
;
1246 Vinhibit_quit
= Qnil
;
1248 if (command_loop_level
== 0 && minibuf_level
== 0)
1249 any_kboard_state ();
1252 return make_number (0);
1255 /* Take actions on handling an error. DATA is the data that describes
1258 CONTEXT is a C-string containing ASCII characters only which
1259 describes the context in which the error happened. If we need to
1260 generalize CONTEXT to allow multibyte characters, make it a Lisp
1264 cmd_error_internal (data
, context
)
1269 int kill_emacs_p
= 0;
1270 struct frame
*sf
= SELECTED_FRAME ();
1274 clear_message (1, 0);
1276 /* If the window system or terminal frame hasn't been initialized
1277 yet, or we're not interactive, it's best to dump this message out
1278 to stderr and exit. */
1279 if (!sf
->glyphs_initialized_p
1280 || FRAME_INITIAL_P (sf
)
1283 stream
= Qexternal_debugging_output
;
1289 message_log_maybe_newline ();
1294 /* The immediate context is not interesting for Quits,
1295 since they are asyncronous. */
1296 if (EQ (XCAR (data
), Qquit
))
1297 Vsignaling_function
= Qnil
;
1299 print_error_message (data
, stream
, context
, Vsignaling_function
);
1301 Vsignaling_function
= Qnil
;
1303 /* If the window system or terminal frame hasn't been initialized
1304 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1308 Fkill_emacs (make_number (-1));
1312 Lisp_Object
command_loop_1 ();
1313 Lisp_Object
command_loop_2 ();
1314 Lisp_Object
top_level_1 ();
1316 /* Entry to editor-command-loop.
1317 This level has the catches for exiting/returning to editor command loop.
1318 It returns nil to exit recursive edit, t to abort it. */
1323 if (command_loop_level
> 0 || minibuf_level
> 0)
1326 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1327 executing_kbd_macro
= Qnil
;
1333 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1334 /* Reset single_kboard in case top-level set it while
1335 evaluating an -f option, or we are stuck there for some
1337 any_kboard_state ();
1338 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1339 executing_kbd_macro
= Qnil
;
1341 /* End of file in -batch run causes exit here. */
1347 /* Here we catch errors in execution of commands within the
1348 editing loop, and reenter the editing loop.
1349 When there is an error, cmd_error runs and returns a non-nil
1350 value to us. A value of nil means that command_loop_1 itself
1351 returned due to end of file (or end of kbd macro). */
1356 register Lisp_Object val
;
1359 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1360 while (!NILP (val
));
1368 return Feval (Vtop_level
);
1374 /* On entry to the outer level, run the startup file */
1375 if (!NILP (Vtop_level
))
1376 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1377 else if (!NILP (Vpurify_flag
))
1378 message ("Bare impure Emacs (standard Lisp code not loaded)");
1380 message ("Bare Emacs (standard Lisp code not loaded)");
1384 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1385 doc
: /* Exit all recursive editing levels. */)
1388 #ifdef HAVE_X_WINDOWS
1389 if (display_hourglass_p
)
1390 cancel_hourglass ();
1393 /* Unblock input if we enter with input blocked. This may happen if
1394 redisplay traps e.g. during tool-bar update with input blocked. */
1395 while (INPUT_BLOCKED_P
)
1398 return Fthrow (Qtop_level
, Qnil
);
1401 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1402 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1405 if (command_loop_level
> 0 || minibuf_level
> 0)
1406 Fthrow (Qexit
, Qnil
);
1408 error ("No recursive edit is in progress");
1412 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1413 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1416 if (command_loop_level
> 0 || minibuf_level
> 0)
1419 error ("No recursive edit is in progress");
1423 /* This is the actual command reading loop,
1424 sans error-handling encapsulation. */
1426 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1428 void safe_run_hooks
P_ ((Lisp_Object
));
1429 static void adjust_point_for_property
P_ ((int, int));
1431 /* Cancel hourglass from protect_unwind.
1433 #ifdef HAVE_X_WINDOWS
1435 cancel_hourglass_unwind (arg
)
1438 cancel_hourglass ();
1449 Lisp_Object keybuf
[30];
1452 int prev_modiff
= 0;
1453 struct buffer
*prev_buffer
= NULL
;
1455 int was_locked
= single_kboard
;
1457 int already_adjusted
= 0;
1459 current_kboard
->Vprefix_arg
= Qnil
;
1460 current_kboard
->Vlast_prefix_arg
= Qnil
;
1461 Vdeactivate_mark
= Qnil
;
1462 waiting_for_input
= 0;
1466 this_command_key_count
= 0;
1467 this_command_key_count_reset
= 0;
1468 this_single_command_key_start
= 0;
1470 if (NILP (Vmemory_full
))
1472 /* Make sure this hook runs after commands that get errors and
1473 throw to top level. */
1474 /* Note that the value cell will never directly contain nil
1475 if the symbol is a local variable. */
1476 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1477 safe_run_hooks (Qpost_command_hook
);
1479 /* If displaying a message, resize the echo area window to fit
1480 that message's size exactly. */
1481 if (!NILP (echo_area_buffer
[0]))
1482 resize_echo_area_exactly ();
1484 if (!NILP (Vdeferred_action_list
))
1485 safe_run_hooks (Qdeferred_action_function
);
1488 /* Do this after running Vpost_command_hook, for consistency. */
1489 current_kboard
->Vlast_command
= Vthis_command
;
1490 current_kboard
->Vreal_last_command
= real_this_command
;
1494 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1497 /* Make sure the current window's buffer is selected. */
1498 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1499 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1501 /* Display any malloc warning that just came out. Use while because
1502 displaying one warning can cause another. */
1504 while (pending_malloc_warning
)
1505 display_malloc_warning ();
1509 Vdeactivate_mark
= Qnil
;
1511 /* If minibuffer on and echo area in use,
1512 wait a short time and redraw minibuffer. */
1515 && !NILP (echo_area_buffer
[0])
1516 && EQ (minibuf_window
, echo_area_window
)
1517 && NUMBERP (Vminibuffer_message_timeout
))
1519 /* Bind inhibit-quit to t so that C-g gets read in
1520 rather than quitting back to the minibuffer. */
1521 int count
= SPECPDL_INDEX ();
1522 specbind (Qinhibit_quit
, Qt
);
1524 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1525 /* Clear the echo area. */
1527 safe_run_hooks (Qecho_area_clear_hook
);
1529 unbind_to (count
, Qnil
);
1531 /* If a C-g came in before, treat it as input now. */
1532 if (!NILP (Vquit_flag
))
1535 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1540 alloca (0); /* Cause a garbage collection now */
1541 /* Since we can free the most stuff here. */
1542 #endif /* C_ALLOCA */
1545 /* Select the frame that the last event came from. Usually,
1546 switch-frame events will take care of this, but if some lisp
1547 code swallows a switch-frame event, we'll fix things up here.
1548 Is this a good idea? */
1549 if (FRAMEP (internal_last_event_frame
)
1550 && !EQ (internal_last_event_frame
, selected_frame
))
1551 Fselect_frame (internal_last_event_frame
);
1553 /* If it has changed current-menubar from previous value,
1554 really recompute the menubar from the value. */
1555 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1556 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1557 call0 (Qrecompute_lucid_menubar
);
1559 before_command_key_count
= this_command_key_count
;
1560 before_command_echo_length
= echo_length ();
1562 Vthis_command
= Qnil
;
1563 real_this_command
= Qnil
;
1564 Vthis_original_command
= Qnil
;
1566 /* Read next key sequence; i gets its length. */
1567 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1570 /* A filter may have run while we were reading the input. */
1571 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1573 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1574 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1578 /* Now we have read a key sequence of length I,
1579 or else I is 0 and we found end of file. */
1581 if (i
== 0) /* End of file -- happens only in */
1582 return Qnil
; /* a kbd macro, at the end. */
1583 /* -1 means read_key_sequence got a menu that was rejected.
1584 Just loop around and read another command. */
1588 this_command_key_count
= 0;
1589 this_command_key_count_reset
= 0;
1590 this_single_command_key_start
= 0;
1594 last_command_char
= keybuf
[i
- 1];
1596 /* If the previous command tried to force a specific window-start,
1597 forget about that, in case this command moves point far away
1598 from that position. But also throw away beg_unchanged and
1599 end_unchanged information in that case, so that redisplay will
1600 update the whole window properly. */
1601 if (!NILP (XWINDOW (selected_window
)->force_start
))
1604 XWINDOW (selected_window
)->force_start
= Qnil
;
1605 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1606 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1609 cmd
= read_key_sequence_cmd
;
1610 if (!NILP (Vexecuting_kbd_macro
))
1612 if (!NILP (Vquit_flag
))
1614 Vexecuting_kbd_macro
= Qt
;
1615 QUIT
; /* Make some noise. */
1616 /* Will return since macro now empty. */
1620 /* Do redisplay processing after this command except in special
1621 cases identified below. */
1622 prev_buffer
= current_buffer
;
1623 prev_modiff
= MODIFF
;
1624 last_point_position
= PT
;
1625 last_point_position_window
= selected_window
;
1626 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1628 /* By default, we adjust point to a boundary of a region that
1629 has such a property that should be treated intangible
1630 (e.g. composition, display). But, some commands will set
1631 this variable differently. */
1632 Vdisable_point_adjustment
= Qnil
;
1634 /* Process filters and timers may have messed with deactivate-mark.
1635 reset it before we execute the command. */
1636 Vdeactivate_mark
= Qnil
;
1638 /* Remap command through active keymaps */
1639 Vthis_original_command
= cmd
;
1643 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1647 /* Execute the command. */
1649 Vthis_command
= cmd
;
1650 real_this_command
= cmd
;
1651 /* Note that the value cell will never directly contain nil
1652 if the symbol is a local variable. */
1653 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1654 safe_run_hooks (Qpre_command_hook
);
1656 already_adjusted
= 0;
1658 if (NILP (Vthis_command
))
1660 /* nil means key is undefined. */
1661 Lisp_Object keys
= Fvector (i
, keybuf
);
1662 keys
= Fkey_description (keys
, Qnil
);
1664 message_with_string ("%s is undefined", keys
, 0);
1665 current_kboard
->defining_kbd_macro
= Qnil
;
1666 update_mode_lines
= 1;
1667 current_kboard
->Vprefix_arg
= Qnil
;
1671 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1673 /* In case we jump to directly_done. */
1674 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1676 /* Recognize some common commands in common situations and
1677 do them directly. */
1678 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1680 struct Lisp_Char_Table
*dp
1681 = window_display_table (XWINDOW (selected_window
));
1682 lose
= FETCH_CHAR (PT_BYTE
);
1684 if (! NILP (Vpost_command_hook
))
1685 /* Put this before calling adjust_point_for_property
1686 so it will only get called once in any case. */
1688 if (current_buffer
== prev_buffer
1689 && last_point_position
!= PT
1690 && NILP (Vdisable_point_adjustment
)
1691 && NILP (Vglobal_disable_point_adjustment
))
1692 adjust_point_for_property (last_point_position
, 0);
1693 already_adjusted
= 1;
1694 if (PT
== last_point_position
+ 1
1696 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1697 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1698 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1699 && (lose
>= 0x20 && lose
< 0x7f)))
1700 : (lose
>= 0x20 && lose
< 0x7f))
1701 /* To extract the case of continuation on
1702 wide-column characters. */
1703 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1704 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1706 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1708 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1710 && !windows_or_buffers_changed
1711 && EQ (current_buffer
->selective_display
, Qnil
)
1712 && !detect_input_pending ()
1713 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1714 && NILP (Vexecuting_kbd_macro
))
1715 direct_output_forward_char (1);
1718 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1720 struct Lisp_Char_Table
*dp
1721 = window_display_table (XWINDOW (selected_window
));
1723 lose
= FETCH_CHAR (PT_BYTE
);
1724 if (! NILP (Vpost_command_hook
))
1726 if (current_buffer
== prev_buffer
1727 && last_point_position
!= PT
1728 && NILP (Vdisable_point_adjustment
)
1729 && NILP (Vglobal_disable_point_adjustment
))
1730 adjust_point_for_property (last_point_position
, 0);
1731 already_adjusted
= 1;
1732 if (PT
== last_point_position
- 1
1734 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1735 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1736 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1737 && (lose
>= 0x20 && lose
< 0x7f)))
1738 : (lose
>= 0x20 && lose
< 0x7f))
1739 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1741 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1743 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1745 && !windows_or_buffers_changed
1746 && EQ (current_buffer
->selective_display
, Qnil
)
1747 && !detect_input_pending ()
1748 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1749 && NILP (Vexecuting_kbd_macro
))
1750 direct_output_forward_char (-1);
1753 else if (EQ (Vthis_command
, Qself_insert_command
)
1754 /* Try this optimization only on char keystrokes. */
1755 && NATNUMP (last_command_char
)
1756 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1759 = translate_char (Vtranslation_table_for_input
,
1760 XFASTINT (last_command_char
), 0, 0, 0);
1762 if (NILP (Vexecuting_kbd_macro
)
1763 && !EQ (minibuf_window
, selected_window
))
1765 if (!nonundocount
|| nonundocount
>= 20)
1773 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1775 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1777 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1779 || MODIFF
<= SAVE_MODIFF
1780 || windows_or_buffers_changed
1781 || !EQ (current_buffer
->selective_display
, Qnil
)
1782 || detect_input_pending ()
1783 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1784 || !NILP (Vexecuting_kbd_macro
));
1786 value
= internal_self_insert (c
, 0);
1791 if (! NILP (Vpost_command_hook
))
1792 /* Put this before calling adjust_point_for_property
1793 so it will only get called once in any case. */
1796 /* VALUE == 1 when AFTER-CHANGE functions are
1797 installed which is the case most of the time
1798 because FONT-LOCK installs one. */
1799 if (!lose
&& !value
)
1800 direct_output_for_insert (c
);
1805 /* Here for a command that isn't executed directly */
1808 #ifdef HAVE_X_WINDOWS
1809 int scount
= SPECPDL_INDEX ();
1811 if (display_hourglass_p
1812 && NILP (Vexecuting_kbd_macro
))
1814 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1820 if (NILP (current_kboard
->Vprefix_arg
))
1822 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1824 #ifdef HAVE_X_WINDOWS
1825 /* Do not check display_hourglass_p here, because
1826 Fcommand_execute could change it, but we should cancel
1827 hourglass cursor anyway.
1828 But don't cancel the hourglass within a macro
1829 just because a command in the macro finishes. */
1830 if (NILP (Vexecuting_kbd_macro
))
1831 unbind_to (scount
, Qnil
);
1836 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1838 /* Note that the value cell will never directly contain nil
1839 if the symbol is a local variable. */
1840 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1841 safe_run_hooks (Qpost_command_hook
);
1843 /* If displaying a message, resize the echo area window to fit
1844 that message's size exactly. */
1845 if (!NILP (echo_area_buffer
[0]))
1846 resize_echo_area_exactly ();
1848 if (!NILP (Vdeferred_action_list
))
1849 safe_run_hooks (Qdeferred_action_function
);
1851 /* If there is a prefix argument,
1852 1) We don't want Vlast_command to be ``universal-argument''
1853 (that would be dumb), so don't set Vlast_command,
1854 2) we want to leave echoing on so that the prefix will be
1855 echoed as part of this key sequence, so don't call
1857 3) we want to leave this_command_key_count non-zero, so that
1858 read_char will realize that it is re-reading a character, and
1859 not echo it a second time.
1861 If the command didn't actually create a prefix arg,
1862 but is merely a frame event that is transparent to prefix args,
1863 then the above doesn't apply. */
1864 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1866 current_kboard
->Vlast_command
= Vthis_command
;
1867 current_kboard
->Vreal_last_command
= real_this_command
;
1869 this_command_key_count
= 0;
1870 this_command_key_count_reset
= 0;
1871 this_single_command_key_start
= 0;
1874 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1876 /* Setting transient-mark-mode to `only' is a way of
1877 turning it on for just one command. */
1879 if (EQ (Vtransient_mark_mode
, Qidentity
))
1880 Vtransient_mark_mode
= Qnil
;
1881 if (EQ (Vtransient_mark_mode
, Qonly
))
1882 Vtransient_mark_mode
= Qidentity
;
1884 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1886 /* We could also call `deactivate'mark'. */
1887 if (EQ (Vtransient_mark_mode
, Qlambda
))
1888 Vtransient_mark_mode
= Qnil
;
1891 current_buffer
->mark_active
= Qnil
;
1892 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1895 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1896 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1901 if (current_buffer
== prev_buffer
1902 && last_point_position
!= PT
1903 && NILP (Vdisable_point_adjustment
)
1904 && NILP (Vglobal_disable_point_adjustment
)
1905 && !already_adjusted
)
1906 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1908 /* Install chars successfully executed in kbd macro. */
1910 if (!NILP (current_kboard
->defining_kbd_macro
)
1911 && NILP (current_kboard
->Vprefix_arg
))
1912 finalize_kbd_macro_chars ();
1916 any_kboard_state ();
1921 extern Lisp_Object Qcomposition
, Qdisplay
;
1923 /* Adjust point to a boundary of a region that has such a property
1924 that should be treated intangible. For the moment, we check
1925 `composition', `display' and `invisible' properties.
1926 LAST_PT is the last position of point. */
1928 extern Lisp_Object Qafter_string
, Qbefore_string
;
1929 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1932 adjust_point_for_property (last_pt
, modified
)
1937 Lisp_Object val
, overlay
, tmp
;
1938 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1941 /* FIXME: cycling is probably not necessary because these properties
1942 can't be usefully combined anyway. */
1943 while (check_composition
|| check_display
|| check_invisible
)
1945 if (check_composition
1946 && PT
> BEGV
&& PT
< ZV
1947 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1948 && COMPOSITION_VALID_P (beg
, end
, val
)
1949 && beg
< PT
/* && end > PT <- It's always the case. */
1950 && (last_pt
<= beg
|| last_pt
>= end
))
1953 SET_PT (PT
< last_pt
? beg
: end
);
1954 check_display
= check_invisible
= 1;
1956 check_composition
= 0;
1958 && PT
> BEGV
&& PT
< ZV
1959 && !NILP (val
= get_char_property_and_overlay
1960 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1961 && display_prop_intangible_p (val
)
1962 && (!OVERLAYP (overlay
)
1963 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1964 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1965 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1966 && (beg
< PT
/* && end > PT <- It's always the case. */
1967 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1970 SET_PT (PT
< last_pt
1971 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1973 check_composition
= check_invisible
= 1;
1976 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1978 int inv
, ellipsis
= 0;
1981 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1983 && !NILP (val
= get_char_property_and_overlay
1984 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1985 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1987 ellipsis
= ellipsis
|| inv
> 1
1988 || (OVERLAYP (overlay
)
1989 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1990 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1991 tmp
= Fnext_single_char_property_change
1992 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1993 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1996 && !NILP (val
= get_char_property_and_overlay
1997 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1998 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
2000 ellipsis
= ellipsis
|| inv
> 1
2001 || (OVERLAYP (overlay
)
2002 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
2003 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
2004 tmp
= Fprevious_single_char_property_change
2005 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
2006 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
2009 /* Move away from the inside area. */
2010 if (beg
< PT
&& end
> PT
)
2012 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2013 /* We haven't moved yet (so we don't need to fear
2014 infinite-looping) and we were outside the range
2015 before (so either end of the range still corresponds
2016 to a move in the right direction): pretend we moved
2017 less than we actually did, so that we still have
2018 more freedom below in choosing which end of the range
2020 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2021 /* We either have moved already or the last point
2022 was already in the range: we don't get to choose
2023 which end of the range we have to go to. */
2024 : (PT
< last_pt
? beg
: end
));
2025 check_composition
= check_display
= 1;
2027 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2028 the point to something other than its argument, due to
2029 point-motion hooks, intangibility, etc. */
2030 xassert (PT
== beg
|| PT
== end
);
2033 /* Pretend the area doesn't exist if the buffer is not
2035 if (!modified
&& !ellipsis
&& beg
< end
)
2037 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2038 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2039 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2040 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2041 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2042 /* We've already moved as far as we can. Trying to go
2043 to the other end would mean moving backwards and thus
2044 could lead to an infinite loop. */
2046 else if (val
= get_pos_property (make_number (PT
),
2048 TEXT_PROP_MEANS_INVISIBLE (val
)
2049 && (val
= get_pos_property
2050 (make_number (PT
== beg
? end
: beg
),
2052 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2053 (check_composition
= check_display
= 1,
2054 SET_PT (PT
== beg
? end
: beg
));
2057 check_invisible
= 0;
2061 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2064 safe_run_hooks_1 (hook
)
2067 return call1 (Vrun_hooks
, Vinhibit_quit
);
2070 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2073 safe_run_hooks_error (data
)
2076 Lisp_Object args
[3];
2077 args
[0] = build_string ("Error in %s: %s");
2078 args
[1] = Vinhibit_quit
;
2081 return Fset (Vinhibit_quit
, Qnil
);
2084 /* If we get an error while running the hook, cause the hook variable
2085 to be nil. Also inhibit quits, so that C-g won't cause the hook
2086 to mysteriously evaporate. */
2089 safe_run_hooks (hook
)
2092 int count
= SPECPDL_INDEX ();
2093 specbind (Qinhibit_quit
, hook
);
2095 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2097 unbind_to (count
, Qnil
);
2101 /* Number of seconds between polling for input. This is a Lisp
2102 variable that can be bound. */
2104 EMACS_INT polling_period
;
2106 /* Nonzero means polling for input is temporarily suppressed. */
2108 int poll_suppress_count
;
2110 /* Asynchronous timer for polling. */
2112 struct atimer
*poll_timer
;
2115 #ifdef POLL_FOR_INPUT
2117 /* Poll for input, so what we catch a C-g if it comes in. This
2118 function is called from x_make_frame_visible, see comment
2124 if (interrupt_input_blocked
== 0
2125 && !waiting_for_input
)
2126 read_avail_input (0);
2129 /* Timer callback function for poll_timer. TIMER is equal to
2133 poll_for_input (timer
)
2134 struct atimer
*timer
;
2136 if (poll_suppress_count
== 0)
2138 interrupt_input_pending
= 1;
2140 poll_for_input_1 ();
2144 #endif /* POLL_FOR_INPUT */
2146 /* Begin signals to poll for input, if they are appropriate.
2147 This function is called unconditionally from various places. */
2152 #ifdef POLL_FOR_INPUT
2153 /* XXX This condition was (read_socket_hook && !interrupt_input),
2154 but read_socket_hook is not global anymore. Let's pretend that
2156 if (!interrupt_input
)
2158 /* Turn alarm handling on unconditionally. It might have
2159 been turned off in process.c. */
2160 turn_on_atimers (1);
2162 /* If poll timer doesn't exist, are we need one with
2163 a different interval, start a new one. */
2164 if (poll_timer
== NULL
2165 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2167 EMACS_TIME interval
;
2170 cancel_atimer (poll_timer
);
2172 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2173 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2174 poll_for_input
, NULL
);
2177 /* Let the timer's callback function poll for input
2178 if this becomes zero. */
2179 --poll_suppress_count
;
2184 /* Nonzero if we are using polling to handle input asynchronously. */
2187 input_polling_used ()
2189 #ifdef POLL_FOR_INPUT
2190 /* XXX This condition was (read_socket_hook && !interrupt_input),
2191 but read_socket_hook is not global anymore. Let's pretend that
2193 return !interrupt_input
;
2199 /* Turn off polling. */
2204 #ifdef POLL_FOR_INPUT
2205 /* XXX This condition was (read_socket_hook && !interrupt_input),
2206 but read_socket_hook is not global anymore. Let's pretend that
2208 if (!interrupt_input
)
2209 ++poll_suppress_count
;
2213 /* Set the value of poll_suppress_count to COUNT
2214 and start or stop polling accordingly. */
2217 set_poll_suppress_count (count
)
2220 #ifdef POLL_FOR_INPUT
2221 if (count
== 0 && poll_suppress_count
!= 0)
2223 poll_suppress_count
= 1;
2226 else if (count
!= 0 && poll_suppress_count
== 0)
2230 poll_suppress_count
= count
;
2234 /* Bind polling_period to a value at least N.
2235 But don't decrease it. */
2238 bind_polling_period (n
)
2241 #ifdef POLL_FOR_INPUT
2242 int new = polling_period
;
2247 stop_other_atimers (poll_timer
);
2249 specbind (Qpolling_period
, make_number (new));
2250 /* Start a new alarm with the new period. */
2255 /* Apply the control modifier to CHARACTER. */
2261 /* Save the upper bits here. */
2262 int upper
= c
& ~0177;
2266 /* Everything in the columns containing the upper-case letters
2267 denotes a control character. */
2268 if (c
>= 0100 && c
< 0140)
2272 /* Set the shift modifier for a control char
2273 made from a shifted letter. But only for letters! */
2274 if (oc
>= 'A' && oc
<= 'Z')
2275 c
|= shift_modifier
;
2278 /* The lower-case letters denote control characters too. */
2279 else if (c
>= 'a' && c
<= 'z')
2282 /* Include the bits for control and shift
2283 only if the basic ASCII code can't indicate them. */
2287 /* Replace the high bits. */
2288 c
|= (upper
& ~ctrl_modifier
);
2293 /* Display the help-echo property of the character after the mouse pointer.
2294 Either show it in the echo area, or call show-help-function to display
2295 it by other means (maybe in a tooltip).
2297 If HELP is nil, that means clear the previous help echo.
2299 If HELP is a string, display that string. If HELP is a function,
2300 call it with OBJECT and POS as arguments; the function should
2301 return a help string or nil for none. For all other types of HELP,
2302 evaluate it to obtain a string.
2304 WINDOW is the window in which the help was generated, if any.
2305 It is nil if not in a window.
2307 If OBJECT is a buffer, POS is the position in the buffer where the
2308 `help-echo' text property was found.
2310 If OBJECT is an overlay, that overlay has a `help-echo' property,
2311 and POS is the position in the overlay's buffer under the mouse.
2313 If OBJECT is a string (an overlay string or a string displayed with
2314 the `display' property). POS is the position in that string under
2317 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2318 echo overwrites a keystroke echo currently displayed in the echo
2321 Note: this function may only be called with HELP nil or a string
2322 from X code running asynchronously. */
2325 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2326 Lisp_Object help
, window
, object
, pos
;
2327 int ok_to_overwrite_keystroke_echo
;
2329 if (!NILP (help
) && !STRINGP (help
))
2331 if (FUNCTIONP (help
))
2333 Lisp_Object args
[4];
2338 help
= safe_call (4, args
);
2341 help
= safe_eval (help
);
2343 if (!STRINGP (help
))
2348 if (!noninteractive
&& STRINGP (help
))
2349 help
= call1 (Qmouse_fixup_help_message
, help
);
2352 if (STRINGP (help
) || NILP (help
))
2354 if (!NILP (Vshow_help_function
))
2355 call1 (Vshow_help_function
, help
);
2356 else if (/* Don't overwrite minibuffer contents. */
2357 !MINI_WINDOW_P (XWINDOW (selected_window
))
2358 /* Don't overwrite a keystroke echo. */
2359 && (NILP (echo_message_buffer
)
2360 || ok_to_overwrite_keystroke_echo
)
2361 /* Don't overwrite a prompt. */
2362 && !cursor_in_echo_area
)
2366 int count
= SPECPDL_INDEX ();
2368 if (!help_echo_showing_p
)
2369 Vpre_help_message
= current_message ();
2371 specbind (Qmessage_truncate_lines
, Qt
);
2372 message3_nolog (help
, SBYTES (help
),
2373 STRING_MULTIBYTE (help
));
2374 unbind_to (count
, Qnil
);
2376 else if (STRINGP (Vpre_help_message
))
2378 message3_nolog (Vpre_help_message
,
2379 SBYTES (Vpre_help_message
),
2380 STRING_MULTIBYTE (Vpre_help_message
));
2381 Vpre_help_message
= Qnil
;
2387 help_echo_showing_p
= STRINGP (help
);
2393 /* Input of single characters from keyboard */
2395 Lisp_Object
print_help ();
2396 static Lisp_Object
kbd_buffer_get_event ();
2397 static void record_char ();
2400 static jmp_buf wrong_kboard_jmpbuf
;
2403 #define STOP_POLLING \
2404 do { if (! polling_stopped_here) stop_polling (); \
2405 polling_stopped_here = 1; } while (0)
2407 #define RESUME_POLLING \
2408 do { if (polling_stopped_here) start_polling (); \
2409 polling_stopped_here = 0; } while (0)
2411 /* read a character from the keyboard; call the redisplay if needed */
2412 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2413 -1 means do not do redisplay, but do do autosaving.
2416 /* The arguments MAPS and NMAPS are for menu prompting.
2417 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2419 PREV_EVENT is the previous input event, or nil if we are reading
2420 the first event of a key sequence (or not reading a key sequence).
2421 If PREV_EVENT is t, that is a "magic" value that says
2422 not to run input methods, but in other respects to act as if
2423 not reading a key sequence.
2425 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2426 if we used a mouse menu to read the input, or zero otherwise. If
2427 USED_MOUSE_MENU is null, we don't dereference it.
2429 Value is t if we showed a menu and the user rejected it. */
2432 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2436 Lisp_Object prev_event
;
2437 int *used_mouse_menu
;
2439 volatile Lisp_Object c
;
2441 jmp_buf local_getcjmp
;
2443 volatile int key_already_recorded
= 0;
2444 Lisp_Object tem
, save
;
2445 volatile Lisp_Object previous_echo_area_message
;
2446 volatile Lisp_Object also_record
;
2447 volatile int reread
;
2448 struct gcpro gcpro1
, gcpro2
;
2449 int polling_stopped_here
= 0;
2453 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2454 before_command_key_count
= this_command_key_count
;
2455 before_command_echo_length
= echo_length ();
2458 previous_echo_area_message
= Qnil
;
2460 GCPRO2 (c
, previous_echo_area_message
);
2465 if (CONSP (Vunread_post_input_method_events
))
2467 c
= XCAR (Vunread_post_input_method_events
);
2468 Vunread_post_input_method_events
2469 = XCDR (Vunread_post_input_method_events
);
2471 /* Undo what read_char_x_menu_prompt did when it unread
2472 additional keys returned by Fx_popup_menu. */
2474 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2482 if (unread_command_char
!= -1)
2484 XSETINT (c
, unread_command_char
);
2485 unread_command_char
= -1;
2491 if (CONSP (Vunread_command_events
))
2493 c
= XCAR (Vunread_command_events
);
2494 Vunread_command_events
= XCDR (Vunread_command_events
);
2496 /* Undo what read_char_x_menu_prompt did when it unread
2497 additional keys returned by Fx_popup_menu. */
2499 && EQ (XCDR (c
), Qdisabled
)
2500 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2503 /* If the queued event is something that used the mouse,
2504 set used_mouse_menu accordingly. */
2506 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2507 *used_mouse_menu
= 1;
2510 goto reread_for_input_method
;
2513 if (CONSP (Vunread_input_method_events
))
2515 c
= XCAR (Vunread_input_method_events
);
2516 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2518 /* Undo what read_char_x_menu_prompt did when it unread
2519 additional keys returned by Fx_popup_menu. */
2521 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2525 goto reread_for_input_method
;
2528 this_command_key_count_reset
= 0;
2530 if (!NILP (Vexecuting_kbd_macro
))
2532 /* We set this to Qmacro; since that's not a frame, nobody will
2533 try to switch frames on us, and the selected window will
2536 Since this event came from a macro, it would be misleading to
2537 leave internal_last_event_frame set to wherever the last
2538 real event came from. Normally, a switch-frame event selects
2539 internal_last_event_frame after each command is read, but
2540 events read from a macro should never cause a new frame to be
2542 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2544 /* Exit the macro if we are at the end.
2545 Also, some things replace the macro with t
2546 to force an early exit. */
2547 if (EQ (Vexecuting_kbd_macro
, Qt
)
2548 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2554 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2555 if (STRINGP (Vexecuting_kbd_macro
)
2556 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2557 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2559 executing_kbd_macro_index
++;
2564 if (!NILP (unread_switch_frame
))
2566 c
= unread_switch_frame
;
2567 unread_switch_frame
= Qnil
;
2569 /* This event should make it into this_command_keys, and get echoed
2570 again, so we do not set `reread'. */
2574 /* if redisplay was requested */
2575 if (commandflag
>= 0)
2577 /* If there is pending input, process any events which are not
2578 user-visible, such as X selection_request events. */
2580 || detect_input_pending_run_timers (0))
2581 swallow_events (0); /* may clear input_pending */
2583 /* Redisplay if no pending input. */
2584 while (!input_pending
)
2586 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2587 redisplay_preserve_echo_area (5);
2592 /* Normal case: no input arrived during redisplay. */
2595 /* Input arrived and pre-empted redisplay.
2596 Process any events which are not user-visible. */
2598 /* If that cleared input_pending, try again to redisplay. */
2602 /* Message turns off echoing unless more keystrokes turn it on again.
2604 The code in 20.x for the condition was
2606 1. echo_area_glyphs && *echo_area_glyphs
2607 2. && echo_area_glyphs != current_kboard->echobuf
2608 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2610 (1) means there's a current message displayed
2612 (2) means it's not the message from echoing from the current
2615 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2616 is set to a non-null value. This is done in read_char and it is
2617 set to echo_area_glyphs after a call to echo_char. That means
2618 ok_to_echo_at_next_pause is either null or
2619 current_kboard->echobuf with the appropriate current_kboard at
2622 So, condition (3) means in clear text ok_to_echo_at_next_pause
2623 must be either null, or the current message isn't from echoing at
2624 all, or it's from echoing from a different kboard than the
2627 if (/* There currently is something in the echo area. */
2628 !NILP (echo_area_buffer
[0])
2629 && (/* And it's either not from echoing. */
2630 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2631 /* Or it's an echo from a different kboard. */
2632 || echo_kboard
!= current_kboard
2633 /* Or we explicitly allow overwriting whatever there is. */
2634 || ok_to_echo_at_next_pause
== NULL
))
2639 /* Try reading a character via menu prompting in the minibuf.
2640 Try this before the sit-for, because the sit-for
2641 would do the wrong thing if we are supposed to do
2642 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2643 after a mouse event so don't try a minibuf menu. */
2645 if (nmaps
> 0 && INTERACTIVE
2646 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2647 /* Don't bring up a menu if we already have another event. */
2648 && NILP (Vunread_command_events
)
2649 && unread_command_char
< 0
2650 && !detect_input_pending_run_timers (0))
2652 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2655 key_already_recorded
= 1;
2660 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2661 We will do that below, temporarily for short sections of code,
2662 when appropriate. local_getcjmp must be in effect
2663 around any call to sit_for or kbd_buffer_get_event;
2664 it *must not* be in effect when we call redisplay. */
2666 if (_setjmp (local_getcjmp
))
2668 /* Handle quits while reading the keyboard. */
2669 /* We must have saved the outer value of getcjmp here,
2670 so restore it now. */
2671 restore_getcjmp (save_jump
);
2672 XSETINT (c
, quit_char
);
2673 internal_last_event_frame
= selected_frame
;
2674 Vlast_event_frame
= internal_last_event_frame
;
2675 /* If we report the quit char as an event,
2676 don't do so more than once. */
2677 if (!NILP (Vinhibit_quit
))
2682 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2683 if (kb
!= current_kboard
)
2685 Lisp_Object link
= kb
->kbd_queue
;
2686 /* We shouldn't get here if we were in single-kboard mode! */
2691 while (CONSP (XCDR (link
)))
2693 if (!NILP (XCDR (link
)))
2697 kb
->kbd_queue
= Fcons (c
, Qnil
);
2699 XSETCDR (link
, Fcons (c
, Qnil
));
2700 kb
->kbd_queue_has_data
= 1;
2701 current_kboard
= kb
;
2702 /* This is going to exit from read_char
2703 so we had better get rid of this frame's stuff. */
2705 longjmp (wrong_kboard_jmpbuf
, 1);
2712 timer_start_idle ();
2714 /* If in middle of key sequence and minibuffer not active,
2715 start echoing if enough time elapses. */
2717 if (minibuf_level
== 0
2718 && !current_kboard
->immediate_echo
2719 && this_command_key_count
> 0
2721 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2722 && NILP (Fzerop (Vecho_keystrokes
))
2723 && (/* No message. */
2724 NILP (echo_area_buffer
[0])
2725 /* Or empty message. */
2726 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2727 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2728 /* Or already echoing from same kboard. */
2729 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2730 /* Or not echoing before and echoing allowed. */
2731 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2735 /* After a mouse event, start echoing right away.
2736 This is because we are probably about to display a menu,
2737 and we don't want to delay before doing so. */
2738 if (EVENT_HAS_PARAMETERS (prev_event
))
2743 double duration
= extract_float (Vecho_keystrokes
);
2744 sec
= (int) duration
;
2745 usec
= (duration
- sec
) * 1000000;
2746 save_getcjmp (save_jump
);
2747 restore_getcjmp (local_getcjmp
);
2748 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2749 restore_getcjmp (save_jump
);
2751 && ! CONSP (Vunread_command_events
))
2756 /* Maybe auto save due to number of keystrokes. */
2758 if (commandflag
!= 0
2759 && auto_save_interval
> 0
2760 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2761 && !detect_input_pending_run_timers (0))
2763 Fdo_auto_save (Qnil
, Qnil
);
2764 /* Hooks can actually change some buffers in auto save. */
2768 /* Try reading using an X menu.
2769 This is never confused with reading using the minibuf
2770 because the recursive call of read_char in read_char_minibuf_menu_prompt
2771 does not pass on any keymaps. */
2773 if (nmaps
> 0 && INTERACTIVE
2774 && !NILP (prev_event
)
2775 && EVENT_HAS_PARAMETERS (prev_event
)
2776 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2777 && !EQ (XCAR (prev_event
), Qtool_bar
)
2778 /* Don't bring up a menu if we already have another event. */
2779 && NILP (Vunread_command_events
)
2780 && unread_command_char
< 0)
2782 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2784 /* Now that we have read an event, Emacs is not idle. */
2790 /* Maybe autosave and/or garbage collect due to idleness. */
2792 if (INTERACTIVE
&& NILP (c
))
2794 int delay_level
, buffer_size
;
2796 /* Slow down auto saves logarithmically in size of current buffer,
2797 and garbage collect while we're at it. */
2798 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2799 last_non_minibuf_size
= Z
- BEG
;
2800 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2802 while (buffer_size
> 64)
2803 delay_level
++, buffer_size
-= buffer_size
>> 2;
2804 if (delay_level
< 4) delay_level
= 4;
2805 /* delay_level is 4 for files under around 50k, 7 at 100k,
2806 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2808 /* Auto save if enough time goes by without input. */
2809 if (commandflag
!= 0
2810 && num_nonmacro_input_events
> last_auto_save
2811 && INTEGERP (Vauto_save_timeout
)
2812 && XINT (Vauto_save_timeout
) > 0)
2816 save_getcjmp (save_jump
);
2817 restore_getcjmp (local_getcjmp
);
2818 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2820 restore_getcjmp (save_jump
);
2823 && ! CONSP (Vunread_command_events
))
2825 Fdo_auto_save (Qnil
, Qnil
);
2827 /* If we have auto-saved and there is still no input
2828 available, garbage collect if there has been enough
2829 consing going on to make it worthwhile. */
2830 if (!detect_input_pending_run_timers (0)
2831 && consing_since_gc
> gc_cons_threshold
/ 2)
2832 Fgarbage_collect ();
2839 /* If this has become non-nil here, it has been set by a timer
2840 or sentinel or filter. */
2841 if (CONSP (Vunread_command_events
))
2843 c
= XCAR (Vunread_command_events
);
2844 Vunread_command_events
= XCDR (Vunread_command_events
);
2847 /* Read something from current KBOARD's side queue, if possible. */
2851 if (current_kboard
->kbd_queue_has_data
)
2853 if (!CONSP (current_kboard
->kbd_queue
))
2855 c
= XCAR (current_kboard
->kbd_queue
);
2856 current_kboard
->kbd_queue
2857 = XCDR (current_kboard
->kbd_queue
);
2858 if (NILP (current_kboard
->kbd_queue
))
2859 current_kboard
->kbd_queue_has_data
= 0;
2860 input_pending
= readable_events (0);
2861 if (EVENT_HAS_PARAMETERS (c
)
2862 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2863 internal_last_event_frame
= XCAR (XCDR (c
));
2864 Vlast_event_frame
= internal_last_event_frame
;
2869 /* If current_kboard's side queue is empty check the other kboards.
2870 If one of them has data that we have not yet seen here,
2871 switch to it and process the data waiting for it.
2873 Note: if the events queued up for another kboard
2874 have already been seen here, and therefore are not a complete command,
2875 the kbd_queue_has_data field is 0, so we skip that kboard here.
2876 That's to avoid an infinite loop switching between kboards here. */
2877 if (NILP (c
) && !single_kboard
)
2880 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2881 if (kb
->kbd_queue_has_data
)
2883 current_kboard
= kb
;
2884 /* This is going to exit from read_char
2885 so we had better get rid of this frame's stuff. */
2887 longjmp (wrong_kboard_jmpbuf
, 1);
2896 /* Finally, we read from the main queue,
2897 and if that gives us something we can't use yet, we put it on the
2898 appropriate side queue and try again. */
2904 /* Actually read a character, waiting if necessary. */
2905 save_getcjmp (save_jump
);
2906 restore_getcjmp (local_getcjmp
);
2907 timer_start_idle ();
2908 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2909 restore_getcjmp (save_jump
);
2912 if (! NILP (c
) && (kb
!= current_kboard
))
2914 Lisp_Object link
= kb
->kbd_queue
;
2917 while (CONSP (XCDR (link
)))
2919 if (!NILP (XCDR (link
)))
2923 kb
->kbd_queue
= Fcons (c
, Qnil
);
2925 XSETCDR (link
, Fcons (c
, Qnil
));
2926 kb
->kbd_queue_has_data
= 1;
2930 current_kboard
= kb
;
2931 /* This is going to exit from read_char
2932 so we had better get rid of this frame's stuff. */
2934 longjmp (wrong_kboard_jmpbuf
, 1);
2939 /* Terminate Emacs in batch mode if at eof. */
2940 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2941 Fkill_emacs (make_number (1));
2945 /* Add in any extra modifiers, where appropriate. */
2946 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2947 || ((extra_keyboard_modifiers
& 0177) < ' '
2948 && (extra_keyboard_modifiers
& 0177) != 0))
2949 XSETINT (c
, make_ctrl_char (XINT (c
)));
2951 /* Transfer any other modifier bits directly from
2952 extra_keyboard_modifiers to c. Ignore the actual character code
2953 in the low 16 bits of extra_keyboard_modifiers. */
2954 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2964 if (commandflag
>= 0
2965 && !input_pending
&& !detect_input_pending_run_timers (0))
2973 /* Buffer switch events are only for internal wakeups
2974 so don't show them to the user.
2975 Also, don't record a key if we already did. */
2976 if (BUFFERP (c
) || key_already_recorded
)
2979 /* Process special events within read_char
2980 and loop around to read another event. */
2983 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2988 int was_locked
= single_kboard
;
2990 last_input_char
= c
;
2991 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2993 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2994 /* We stopped being idle for this event; undo that. This
2995 prevents automatic window selection (under
2996 mouse_autoselect_window from acting as a real input event, for
2997 example banishing the mouse under mouse-avoidance-mode. */
2998 timer_resume_idle ();
3000 /* Resume allowing input from any kboard, if that was true before. */
3002 any_kboard_state ();
3007 /* Handle things that only apply to characters. */
3010 /* If kbd_buffer_get_event gave us an EOF, return that. */
3014 if ((STRINGP (current_kboard
->Vkeyboard_translate_table
)
3015 && SCHARS (current_kboard
->Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3016 || (VECTORP (current_kboard
->Vkeyboard_translate_table
)
3017 && XVECTOR (current_kboard
->Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3018 || (CHAR_TABLE_P (current_kboard
->Vkeyboard_translate_table
)
3019 && CHAR_VALID_P (XINT (c
), 0)))
3022 d
= Faref (current_kboard
->Vkeyboard_translate_table
, c
);
3023 /* nil in keyboard-translate-table means no translation. */
3029 /* If this event is a mouse click in the menu bar,
3030 return just menu-bar for now. Modify the mouse click event
3031 so we won't do this twice, then queue it up. */
3032 if (EVENT_HAS_PARAMETERS (c
)
3034 && CONSP (EVENT_START (c
))
3035 && CONSP (XCDR (EVENT_START (c
))))
3039 posn
= POSN_POSN (EVENT_START (c
));
3040 /* Handle menu-bar events:
3041 insert the dummy prefix event `menu-bar'. */
3042 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3044 /* Change menu-bar to (menu-bar) as the event "position". */
3045 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3048 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3053 /* Store these characters into recent_keys, the dribble file if any,
3054 and the keyboard macro being defined, if any. */
3056 if (! NILP (also_record
))
3057 record_char (also_record
);
3059 /* Wipe the echo area.
3060 But first, if we are about to use an input method,
3061 save the echo area contents for it to refer to. */
3063 && ! NILP (Vinput_method_function
)
3064 && (unsigned) XINT (c
) >= ' '
3065 && (unsigned) XINT (c
) != 127
3066 && (unsigned) XINT (c
) < 256)
3068 previous_echo_area_message
= Fcurrent_message ();
3069 Vinput_method_previous_message
= previous_echo_area_message
;
3072 /* Now wipe the echo area, except for help events which do their
3073 own stuff with the echo area. */
3075 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3076 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3078 if (!NILP (echo_area_buffer
[0]))
3079 safe_run_hooks (Qecho_area_clear_hook
);
3080 clear_message (1, 0);
3083 reread_for_input_method
:
3085 /* Pass this to the input method, if appropriate. */
3087 && ! NILP (Vinput_method_function
)
3088 /* Don't run the input method within a key sequence,
3089 after the first event of the key sequence. */
3090 && NILP (prev_event
)
3091 && (unsigned) XINT (c
) >= ' '
3092 && (unsigned) XINT (c
) != 127
3093 && (unsigned) XINT (c
) < 256)
3096 int key_count
, key_count_reset
;
3097 struct gcpro gcpro1
;
3098 int count
= SPECPDL_INDEX ();
3100 /* Save the echo status. */
3101 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3102 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3103 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3104 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3107 if (before_command_restore_flag
)
3109 this_command_key_count
= before_command_key_count_1
;
3110 if (this_command_key_count
< this_single_command_key_start
)
3111 this_single_command_key_start
= this_command_key_count
;
3112 echo_truncate (before_command_echo_length_1
);
3113 before_command_restore_flag
= 0;
3117 /* Save the this_command_keys status. */
3118 key_count
= this_command_key_count
;
3119 key_count_reset
= this_command_key_count_reset
;
3122 keys
= Fcopy_sequence (this_command_keys
);
3127 /* Clear out this_command_keys. */
3128 this_command_key_count
= 0;
3129 this_command_key_count_reset
= 0;
3131 /* Now wipe the echo area. */
3132 if (!NILP (echo_area_buffer
[0]))
3133 safe_run_hooks (Qecho_area_clear_hook
);
3134 clear_message (1, 0);
3137 /* If we are not reading a key sequence,
3138 never use the echo area. */
3141 specbind (Qinput_method_use_echo_area
, Qt
);
3144 /* Call the input method. */
3145 tem
= call1 (Vinput_method_function
, c
);
3147 tem
= unbind_to (count
, tem
);
3149 /* Restore the saved echoing state
3150 and this_command_keys state. */
3151 this_command_key_count
= key_count
;
3152 this_command_key_count_reset
= key_count_reset
;
3154 this_command_keys
= keys
;
3157 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3158 current_kboard
->echo_string
= saved_echo_string
;
3159 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3160 if (saved_immediate_echo
)
3165 /* The input method can return no events. */
3168 /* Bring back the previous message, if any. */
3169 if (! NILP (previous_echo_area_message
))
3170 message_with_string ("%s", previous_echo_area_message
, 0);
3173 /* It returned one event or more. */
3175 Vunread_post_input_method_events
3176 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3181 /* Display help if not echoing. */
3182 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3184 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3185 Lisp_Object help
, object
, position
, window
, tem
;
3187 tem
= Fcdr (XCDR (c
));
3190 window
= Fcar (tem
);
3192 object
= Fcar (tem
);
3194 position
= Fcar (tem
);
3196 show_help_echo (help
, window
, object
, position
, 0);
3198 /* We stopped being idle for this event; undo that. */
3199 timer_resume_idle ();
3203 if (! reread
|| this_command_key_count
== 0
3204 || this_command_key_count_reset
)
3207 /* Don't echo mouse motion events. */
3208 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3209 && NILP (Fzerop (Vecho_keystrokes
))
3210 && ! (EVENT_HAS_PARAMETERS (c
)
3211 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3214 if (! NILP (also_record
))
3215 echo_char (also_record
);
3216 /* Once we reread a character, echoing can happen
3217 the next time we pause to read a new one. */
3218 ok_to_echo_at_next_pause
= current_kboard
;
3221 /* Record this character as part of the current key. */
3222 add_command_key (c
);
3223 if (! NILP (also_record
))
3224 add_command_key (also_record
);
3227 last_input_char
= c
;
3230 /* Process the help character specially if enabled */
3231 if (!NILP (Vhelp_form
) && help_char_p (c
))
3234 count
= SPECPDL_INDEX ();
3236 record_unwind_protect (Fset_window_configuration
,
3237 Fcurrent_window_configuration (Qnil
));
3239 tem0
= Feval (Vhelp_form
);
3241 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3245 c
= read_char (0, 0, 0, Qnil
, 0);
3246 while (BUFFERP (c
));
3247 /* Remove the help from the frame */
3248 unbind_to (count
, Qnil
);
3251 if (EQ (c
, make_number (040)))
3255 c
= read_char (0, 0, 0, Qnil
, 0);
3256 while (BUFFERP (c
));
3265 /* Record a key that came from a mouse menu.
3266 Record it for echoing, for this-command-keys, and so on. */
3272 /* Wipe the echo area. */
3273 clear_message (1, 0);
3278 before_command_key_count
= this_command_key_count
;
3279 before_command_echo_length
= echo_length ();
3282 /* Don't echo mouse motion events. */
3283 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3284 && NILP (Fzerop (Vecho_keystrokes
)))
3288 /* Once we reread a character, echoing can happen
3289 the next time we pause to read a new one. */
3290 ok_to_echo_at_next_pause
= 0;
3293 /* Record this character as part of the current key. */
3294 add_command_key (c
);
3296 /* Re-reading in the middle of a command */
3297 last_input_char
= c
;
3301 /* Return 1 if should recognize C as "the help character". */
3309 if (EQ (c
, Vhelp_char
))
3311 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3312 if (EQ (c
, XCAR (tail
)))
3317 /* Record the input event C in various ways. */
3325 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3327 /* To avoid filling recent_keys with help-echo and mouse-movement
3328 events, we filter out repeated help-echo events, only store the
3329 first and last in a series of mouse-movement events, and don't
3330 store repeated help-echo events which are only separated by
3331 mouse-movement events. */
3333 Lisp_Object ev1
, ev2
, ev3
;
3336 if ((ix1
= recent_keys_index
- 1) < 0)
3337 ix1
= NUM_RECENT_KEYS
- 1;
3338 ev1
= AREF (recent_keys
, ix1
);
3340 if ((ix2
= ix1
- 1) < 0)
3341 ix2
= NUM_RECENT_KEYS
- 1;
3342 ev2
= AREF (recent_keys
, ix2
);
3344 if ((ix3
= ix2
- 1) < 0)
3345 ix3
= NUM_RECENT_KEYS
- 1;
3346 ev3
= AREF (recent_keys
, ix3
);
3348 if (EQ (XCAR (c
), Qhelp_echo
))
3350 /* Don't record `help-echo' in recent_keys unless it shows some help
3351 message, and a different help than the previously recorded
3353 Lisp_Object help
, last_help
;
3355 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3356 if (!STRINGP (help
))
3358 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3359 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3361 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3362 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3363 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3365 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3366 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3367 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3368 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3371 else if (EQ (XCAR (c
), Qmouse_movement
))
3373 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3374 So additional mouse movement events replace the last element. */
3375 Lisp_Object last_window
, window
;
3377 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3378 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3379 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3380 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3381 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3383 ASET (recent_keys
, ix1
, c
);
3389 store_kbd_macro_char (c
);
3394 ASET (recent_keys
, recent_keys_index
, c
);
3395 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3396 recent_keys_index
= 0;
3398 else if (recorded
< 0)
3400 /* We need to remove one or two events from recent_keys.
3401 To do this, we simply put nil at those events and move the
3402 recent_keys_index backwards over those events. Usually,
3403 users will never see those nil events, as they will be
3404 overwritten by the command keys entered to see recent_keys
3407 while (recorded
++ < 0 && total_keys
> 0)
3409 if (total_keys
< NUM_RECENT_KEYS
)
3411 if (--recent_keys_index
< 0)
3412 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3413 ASET (recent_keys
, recent_keys_index
, Qnil
);
3417 num_nonmacro_input_events
++;
3419 /* Write c to the dribble file. If c is a lispy event, write
3420 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3421 If you, dear reader, have a better idea, you've got the source. :-) */
3426 if (XUINT (c
) < 0x100)
3427 putc (XINT (c
), dribble
);
3429 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3433 Lisp_Object dribblee
;
3435 /* If it's a structured event, take the event header. */
3436 dribblee
= EVENT_HEAD (c
);
3438 if (SYMBOLP (dribblee
))
3440 putc ('<', dribble
);
3441 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3442 SBYTES (SYMBOL_NAME (dribblee
)),
3444 putc ('>', dribble
);
3456 struct buffer
*old
= current_buffer
;
3457 Fprinc (object
, Qnil
);
3458 set_buffer_internal (XBUFFER (Vstandard_output
));
3459 call0 (intern ("help-mode"));
3460 set_buffer_internal (old
);
3464 /* Copy out or in the info on where C-g should throw to.
3465 This is used when running Lisp code from within get_char,
3466 in case get_char is called recursively.
3467 See read_process_output. */
3473 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3477 restore_getcjmp (temp
)
3480 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3485 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3486 of this function. */
3489 tracking_off (old_value
)
3490 Lisp_Object old_value
;
3492 do_mouse_tracking
= old_value
;
3493 if (NILP (old_value
))
3495 /* Redisplay may have been preempted because there was input
3496 available, and it assumes it will be called again after the
3497 input has been processed. If the only input available was
3498 the sort that we have just disabled, then we need to call
3500 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3502 redisplay_preserve_echo_area (6);
3503 get_input_pending (&input_pending
,
3504 READABLE_EVENTS_DO_TIMERS_NOW
);
3510 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3511 doc
: /* Evaluate BODY with mouse movement events enabled.
3512 Within a `track-mouse' form, mouse motion generates input events that
3513 you can read with `read-event'.
3514 Normally, mouse motion is ignored.
3515 usage: (track-mouse BODY ...) */)
3519 int count
= SPECPDL_INDEX ();
3522 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3524 do_mouse_tracking
= Qt
;
3526 val
= Fprogn (args
);
3527 return unbind_to (count
, val
);
3530 /* If mouse has moved on some frame, return one of those frames.
3531 Return 0 otherwise. */
3536 Lisp_Object tail
, frame
;
3538 FOR_EACH_FRAME (tail
, frame
)
3540 if (XFRAME (frame
)->mouse_moved
)
3541 return XFRAME (frame
);
3547 #endif /* HAVE_MOUSE */
3549 /* Low level keyboard/mouse input.
3550 kbd_buffer_store_event places events in kbd_buffer, and
3551 kbd_buffer_get_event retrieves them. */
3553 /* Return true iff there are any events in the queue that read-char
3554 would return. If this returns false, a read-char would block. */
3556 readable_events (flags
)
3559 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3562 /* If the buffer contains only FOCUS_IN_EVENT events, and
3563 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3564 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3566 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3567 #ifdef USE_TOOLKIT_SCROLL_BARS
3568 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3572 struct input_event
*event
;
3574 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3581 #ifdef USE_TOOLKIT_SCROLL_BARS
3582 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3584 event
->kind
== FOCUS_IN_EVENT
)
3585 #ifdef USE_TOOLKIT_SCROLL_BARS
3586 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3587 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3588 && event
->part
== scroll_bar_handle
3589 && event
->modifiers
== 0)
3594 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3597 while (event
!= kbd_store_ptr
);
3604 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3605 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3610 if (current_kboard
->kbd_queue_has_data
)
3616 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3617 if (kb
->kbd_queue_has_data
)
3623 /* Set this for debugging, to have a way to get out */
3628 event_to_kboard (event
)
3629 struct input_event
*event
;
3632 frame
= event
->frame_or_window
;
3634 frame
= XCAR (frame
);
3635 else if (WINDOWP (frame
))
3636 frame
= WINDOW_FRAME (XWINDOW (frame
));
3638 /* There are still some events that don't set this field.
3639 For now, just ignore the problem.
3640 Also ignore dead frames here. */
3641 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3644 return FRAME_KBOARD (XFRAME (frame
));
3649 Lisp_Object Vthrow_on_input
;
3651 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3654 kbd_buffer_store_event (event
)
3655 register struct input_event
*event
;
3657 kbd_buffer_store_event_hold (event
, 0);
3660 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3662 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3663 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3664 Else, if EVENT is a quit event, store the quit event
3665 in HOLD_QUIT, and return (thus ignoring further events).
3667 This is used in read_avail_input to postpone the processing
3668 of the quit event until all subsequent input events have been
3669 parsed (and discarded).
3673 kbd_buffer_store_event_hold (event
, hold_quit
)
3674 register struct input_event
*event
;
3675 struct input_event
*hold_quit
;
3677 if (event
->kind
== NO_EVENT
)
3680 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3683 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3685 register int c
= event
->code
& 0377;
3687 if (event
->modifiers
& ctrl_modifier
)
3688 c
= make_ctrl_char (c
);
3690 c
|= (event
->modifiers
3691 & (meta_modifier
| alt_modifier
3692 | hyper_modifier
| super_modifier
));
3697 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3698 struct input_event
*sp
;
3700 if (single_kboard
&& kb
!= current_kboard
)
3703 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3704 Fcons (make_number (c
), Qnil
));
3705 kb
->kbd_queue_has_data
= 1;
3706 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3708 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3711 if (event_to_kboard (sp
) == kb
)
3713 sp
->kind
= NO_EVENT
;
3714 sp
->frame_or_window
= Qnil
;
3724 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3728 /* If this results in a quit_char being returned to Emacs as
3729 input, set Vlast_event_frame properly. If this doesn't
3730 get returned to Emacs as an event, the next event read
3731 will set Vlast_event_frame again, so this is safe to do. */
3735 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3737 focus
= event
->frame_or_window
;
3738 internal_last_event_frame
= focus
;
3739 Vlast_event_frame
= focus
;
3742 last_event_timestamp
= event
->timestamp
;
3743 handle_interrupt ();
3747 if (c
&& c
== stop_character
)
3753 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3754 Just ignore the second one. */
3755 else if (event
->kind
== BUFFER_SWITCH_EVENT
3756 && kbd_fetch_ptr
!= kbd_store_ptr
3757 && ((kbd_store_ptr
== kbd_buffer
3758 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3759 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3762 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3763 kbd_store_ptr
= kbd_buffer
;
3765 /* Don't let the very last slot in the buffer become full,
3766 since that would make the two pointers equal,
3767 and that is indistinguishable from an empty buffer.
3768 Discard the event if it would fill the last slot. */
3769 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3771 *kbd_store_ptr
= *event
;
3775 /* If we're inside while-no-input, and this event qualifies
3776 as input, set quit-flag to cause an interrupt. */
3777 if (!NILP (Vthrow_on_input
)
3778 && event
->kind
!= FOCUS_IN_EVENT
3779 && event
->kind
!= HELP_EVENT
3780 && event
->kind
!= DEICONIFY_EVENT
)
3782 Vquit_flag
= Vthrow_on_input
;
3783 /* If we're inside a function that wants immediate quits,
3785 if (immediate_quit
&& NILP (Vinhibit_quit
))
3795 /* Put an input event back in the head of the event queue. */
3798 kbd_buffer_unget_event (event
)
3799 register struct input_event
*event
;
3801 if (kbd_fetch_ptr
== kbd_buffer
)
3802 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3804 /* Don't let the very last slot in the buffer become full, */
3805 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3808 *kbd_fetch_ptr
= *event
;
3813 /* Generate HELP_EVENT input_events in BUFP which has room for
3814 SIZE events. If there's not enough room in BUFP, ignore this
3817 HELP is the help form.
3819 FRAME is the frame on which the help is generated. OBJECT is the
3820 Lisp object where the help was found (a buffer, a string, an
3821 overlay, or nil if neither from a string nor from a buffer. POS is
3822 the position within OBJECT where the help was found.
3824 Value is the number of input_events generated. */
3827 gen_help_event (help
, frame
, window
, object
, pos
)
3828 Lisp_Object help
, frame
, object
, window
;
3831 struct input_event event
;
3835 event
.kind
= HELP_EVENT
;
3836 event
.frame_or_window
= frame
;
3838 event
.x
= WINDOWP (window
) ? window
: frame
;
3841 kbd_buffer_store_event (&event
);
3845 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3848 kbd_buffer_store_help_event (frame
, help
)
3849 Lisp_Object frame
, help
;
3851 struct input_event event
;
3853 event
.kind
= HELP_EVENT
;
3854 event
.frame_or_window
= frame
;
3859 kbd_buffer_store_event (&event
);
3863 /* Discard any mouse events in the event buffer by setting them to
3866 discard_mouse_events ()
3868 struct input_event
*sp
;
3869 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3871 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3874 if (sp
->kind
== MOUSE_CLICK_EVENT
3875 || sp
->kind
== WHEEL_EVENT
3877 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3879 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3881 sp
->kind
= NO_EVENT
;
3887 /* Return non-zero if there are any real events waiting in the event
3888 buffer, not counting `NO_EVENT's.
3890 If DISCARD is non-zero, discard NO_EVENT events at the front of
3891 the input queue, possibly leaving the input queue empty if there
3892 are no real input events. */
3895 kbd_buffer_events_waiting (discard
)
3898 struct input_event
*sp
;
3900 for (sp
= kbd_fetch_ptr
;
3901 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3904 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3911 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3915 /* Clear input event EVENT. */
3919 struct input_event
*event
;
3921 event
->kind
= NO_EVENT
;
3925 /* Read one event from the event buffer, waiting if necessary.
3926 The value is a Lisp object representing the event.
3927 The value is nil for an event that should be ignored,
3928 or that was handled here.
3929 We always read and discard one event. */
3932 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3934 int *used_mouse_menu
;
3943 *kbp
= current_kboard
;
3947 /* Wait until there is input available. */
3950 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3953 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3957 /* If the quit flag is set, then read_char will return
3958 quit_char, so that counts as "available input." */
3959 if (!NILP (Vquit_flag
))
3960 quit_throw_to_read_char ();
3962 /* One way or another, wait until input is available; then, if
3963 interrupt handlers have not read it, read it now. */
3966 wait_for_kbd_input ();
3968 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3972 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3975 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3979 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3981 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3982 /* Pass 1 for EXPECT since we just waited to have input. */
3983 read_avail_input (1);
3985 #endif /* not VMS */
3988 if (CONSP (Vunread_command_events
))
3991 first
= XCAR (Vunread_command_events
);
3992 Vunread_command_events
= XCDR (Vunread_command_events
);
3993 *kbp
= current_kboard
;
3997 /* At this point, we know that there is a readable event available
3998 somewhere. If the event queue is empty, then there must be a
3999 mouse movement enabled and available. */
4000 if (kbd_fetch_ptr
!= kbd_store_ptr
)
4002 struct input_event
*event
;
4004 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4008 last_event_timestamp
= event
->timestamp
;
4011 *kbp
= event_to_kboard (event
);
4013 *kbp
= current_kboard
; /* Better than returning null ptr? */
4015 *kbp
= &the_only_kboard
;
4020 /* These two kinds of events get special handling
4021 and don't actually appear to the command loop.
4022 We return nil for them. */
4023 if (event
->kind
== SELECTION_REQUEST_EVENT
4024 || event
->kind
== SELECTION_CLEAR_EVENT
)
4027 struct input_event copy
;
4029 /* Remove it from the buffer before processing it,
4030 since otherwise swallow_events will see it
4031 and process it again. */
4033 kbd_fetch_ptr
= event
+ 1;
4034 input_pending
= readable_events (0);
4035 x_handle_selection_event (©
);
4037 /* We're getting selection request events, but we don't have
4043 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4044 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4046 /* Make an event (delete-frame (FRAME)). */
4047 obj
= Fcons (event
->frame_or_window
, Qnil
);
4048 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4049 kbd_fetch_ptr
= event
+ 1;
4052 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4053 else if (event
->kind
== ICONIFY_EVENT
)
4055 /* Make an event (iconify-frame (FRAME)). */
4056 obj
= Fcons (event
->frame_or_window
, Qnil
);
4057 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4058 kbd_fetch_ptr
= event
+ 1;
4060 else if (event
->kind
== DEICONIFY_EVENT
)
4062 /* Make an event (make-frame-visible (FRAME)). */
4063 obj
= Fcons (event
->frame_or_window
, Qnil
);
4064 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4065 kbd_fetch_ptr
= event
+ 1;
4068 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4070 /* The value doesn't matter here; only the type is tested. */
4071 XSETBUFFER (obj
, current_buffer
);
4072 kbd_fetch_ptr
= event
+ 1;
4074 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4075 || defined (USE_GTK)
4076 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4078 kbd_fetch_ptr
= event
+ 1;
4079 input_pending
= readable_events (0);
4080 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4081 x_activate_menubar (XFRAME (event
->frame_or_window
));
4084 #if defined (WINDOWSNT) || defined (MAC_OS)
4085 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4088 /* Make an event (language-change (KEY_SCRIPT)). */
4089 obj
= Fcons (make_number (event
->code
), Qnil
);
4091 /* Make an event (language-change (FRAME CHARSET LCID)). */
4092 obj
= Fcons (event
->frame_or_window
, Qnil
);
4094 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4095 kbd_fetch_ptr
= event
+ 1;
4098 else if (event
->kind
== SAVE_SESSION_EVENT
)
4100 obj
= Fcons (Qsave_session
, Qnil
);
4101 kbd_fetch_ptr
= event
+ 1;
4103 /* Just discard these, by returning nil.
4104 With MULTI_KBOARD, these events are used as placeholders
4105 when we need to randomly delete events from the queue.
4106 (They shouldn't otherwise be found in the buffer,
4107 but on some machines it appears they do show up
4108 even without MULTI_KBOARD.) */
4109 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4110 mouse events during a popup-menu call. */
4111 else if (event
->kind
== NO_EVENT
)
4112 kbd_fetch_ptr
= event
+ 1;
4113 else if (event
->kind
== HELP_EVENT
)
4115 Lisp_Object object
, position
, help
, frame
, window
;
4117 frame
= event
->frame_or_window
;
4118 object
= event
->arg
;
4119 position
= make_number (event
->code
);
4122 clear_event (event
);
4124 kbd_fetch_ptr
= event
+ 1;
4125 if (!WINDOWP (window
))
4127 obj
= Fcons (Qhelp_echo
,
4128 list5 (frame
, help
, window
, object
, position
));
4130 else if (event
->kind
== FOCUS_IN_EVENT
)
4132 /* Notification of a FocusIn event. The frame receiving the
4133 focus is in event->frame_or_window. Generate a
4134 switch-frame event if necessary. */
4135 Lisp_Object frame
, focus
;
4137 frame
= event
->frame_or_window
;
4138 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4142 if (!EQ (frame
, internal_last_event_frame
)
4143 && !EQ (frame
, selected_frame
))
4144 obj
= make_lispy_switch_frame (frame
);
4145 internal_last_event_frame
= frame
;
4146 kbd_fetch_ptr
= event
+ 1;
4150 /* If this event is on a different frame, return a switch-frame this
4151 time, and leave the event in the queue for next time. */
4155 frame
= event
->frame_or_window
;
4157 frame
= XCAR (frame
);
4158 else if (WINDOWP (frame
))
4159 frame
= WINDOW_FRAME (XWINDOW (frame
));
4161 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4165 if (! EQ (frame
, internal_last_event_frame
)
4166 && !EQ (frame
, selected_frame
))
4167 obj
= make_lispy_switch_frame (frame
);
4168 internal_last_event_frame
= frame
;
4170 /* If we didn't decide to make a switch-frame event, go ahead
4171 and build a real event from the queue entry. */
4175 obj
= make_lispy_event (event
);
4177 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4178 || defined (USE_GTK)
4179 /* If this was a menu selection, then set the flag to inhibit
4180 writing to last_nonmenu_event. Don't do this if the event
4181 we're returning is (menu-bar), though; that indicates the
4182 beginning of the menu sequence, and we might as well leave
4183 that as the `event with parameters' for this selection. */
4185 && !EQ (event
->frame_or_window
, event
->arg
)
4186 && (event
->kind
== MENU_BAR_EVENT
4187 || event
->kind
== TOOL_BAR_EVENT
))
4188 *used_mouse_menu
= 1;
4191 /* Wipe out this event, to catch bugs. */
4192 clear_event (event
);
4193 kbd_fetch_ptr
= event
+ 1;
4198 /* Try generating a mouse motion event. */
4199 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4201 FRAME_PTR f
= some_mouse_moved ();
4202 Lisp_Object bar_window
;
4203 enum scroll_bar_part part
;
4207 *kbp
= current_kboard
;
4208 /* Note that this uses F to determine which display to look at.
4209 If there is no valid info, it does not store anything
4210 so x remains nil. */
4213 /* XXX Can f or mouse_position_hook be NULL here? */
4214 if (f
&& FRAME_DEVICE (f
)->mouse_position_hook
)
4215 (*FRAME_DEVICE (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4216 &part
, &x
, &y
, &time
);
4220 /* Decide if we should generate a switch-frame event. Don't
4221 generate switch-frame events for motion outside of all Emacs
4227 frame
= FRAME_FOCUS_FRAME (f
);
4229 XSETFRAME (frame
, f
);
4231 if (! EQ (frame
, internal_last_event_frame
)
4232 && !EQ (frame
, selected_frame
))
4233 obj
= make_lispy_switch_frame (frame
);
4234 internal_last_event_frame
= frame
;
4237 /* If we didn't decide to make a switch-frame event, go ahead and
4238 return a mouse-motion event. */
4239 if (!NILP (x
) && NILP (obj
))
4240 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4242 #endif /* HAVE_MOUSE */
4244 /* We were promised by the above while loop that there was
4245 something for us to read! */
4248 input_pending
= readable_events (0);
4250 Vlast_event_frame
= internal_last_event_frame
;
4255 /* Process any events that are not user-visible,
4256 then return, without reading any user-visible events. */
4259 swallow_events (do_display
)
4264 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4266 struct input_event
*event
;
4268 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4272 last_event_timestamp
= event
->timestamp
;
4274 /* These two kinds of events get special handling
4275 and don't actually appear to the command loop. */
4276 if (event
->kind
== SELECTION_REQUEST_EVENT
4277 || event
->kind
== SELECTION_CLEAR_EVENT
)
4280 struct input_event copy
;
4282 /* Remove it from the buffer before processing it,
4283 since otherwise swallow_events called recursively could see it
4284 and process it again. */
4286 kbd_fetch_ptr
= event
+ 1;
4287 input_pending
= readable_events (0);
4288 x_handle_selection_event (©
);
4290 /* We're getting selection request events, but we don't have
4299 old_timers_run
= timers_run
;
4300 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4302 if (timers_run
!= old_timers_run
&& do_display
)
4303 redisplay_preserve_echo_area (7);
4306 /* Record the start of when Emacs is idle,
4307 for the sake of running idle-time timers. */
4314 /* If we are already in the idle state, do nothing. */
4315 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4318 EMACS_GET_TIME (timer_idleness_start_time
);
4320 timer_last_idleness_start_time
= timer_idleness_start_time
;
4322 /* Mark all idle-time timers as once again candidates for running. */
4323 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4327 timer
= XCAR (timers
);
4329 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4331 XVECTOR (timer
)->contents
[0] = Qnil
;
4335 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4340 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4343 /* Resume idle timer from last idle start time. */
4346 timer_resume_idle ()
4348 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4351 timer_idleness_start_time
= timer_last_idleness_start_time
;
4354 /* This is only for debugging. */
4355 struct input_event last_timer_event
;
4357 /* Check whether a timer has fired. To prevent larger problems we simply
4358 disregard elements that are not proper timers. Do not make a circular
4359 timer list for the time being.
4361 Returns the number of seconds to wait until the next timer fires. If a
4362 timer is triggering now, return zero seconds.
4363 If no timer is active, return -1 seconds.
4365 If a timer is ripe, we run it, with quitting turned off.
4367 DO_IT_NOW is now ignored. It used to mean that we should
4368 run the timer directly instead of queueing a timer-event.
4369 Now we always run timers directly. */
4372 timer_check (do_it_now
)
4375 EMACS_TIME nexttime
;
4376 EMACS_TIME now
, idleness_now
;
4377 Lisp_Object timers
, idle_timers
, chosen_timer
;
4378 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4380 EMACS_SET_SECS (nexttime
, -1);
4381 EMACS_SET_USECS (nexttime
, -1);
4383 /* Always consider the ordinary timers. */
4384 timers
= Vtimer_list
;
4385 /* Consider the idle timers only if Emacs is idle. */
4386 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4387 idle_timers
= Vtimer_idle_list
;
4390 chosen_timer
= Qnil
;
4391 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4393 if (CONSP (timers
) || CONSP (idle_timers
))
4395 EMACS_GET_TIME (now
);
4396 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4397 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4400 while (CONSP (timers
) || CONSP (idle_timers
))
4402 Lisp_Object
*vector
;
4403 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4404 EMACS_TIME timer_time
, idle_timer_time
;
4405 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4407 /* Skip past invalid timers and timers already handled. */
4410 timer
= XCAR (timers
);
4411 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4413 timers
= XCDR (timers
);
4416 vector
= XVECTOR (timer
)->contents
;
4418 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4419 || !INTEGERP (vector
[3])
4420 || ! NILP (vector
[0]))
4422 timers
= XCDR (timers
);
4426 if (!NILP (idle_timers
))
4428 timer
= XCAR (idle_timers
);
4429 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4431 idle_timers
= XCDR (idle_timers
);
4434 vector
= XVECTOR (timer
)->contents
;
4436 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4437 || !INTEGERP (vector
[3])
4438 || ! NILP (vector
[0]))
4440 idle_timers
= XCDR (idle_timers
);
4445 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4446 based on the next ordinary timer.
4447 TIMER_DIFFERENCE is the distance in time from NOW to when
4448 this timer becomes ripe (negative if it's already ripe). */
4451 timer
= XCAR (timers
);
4452 vector
= XVECTOR (timer
)->contents
;
4453 EMACS_SET_SECS (timer_time
,
4454 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4455 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4456 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4459 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4460 based on the next idle timer. */
4461 if (!NILP (idle_timers
))
4463 idle_timer
= XCAR (idle_timers
);
4464 vector
= XVECTOR (idle_timer
)->contents
;
4465 EMACS_SET_SECS (idle_timer_time
,
4466 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4467 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4468 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4471 /* Decide which timer is the next timer,
4472 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4473 Also step down the list where we found that timer. */
4475 if (! NILP (timers
) && ! NILP (idle_timers
))
4478 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4479 if (EMACS_TIME_NEG_P (temp
))
4481 chosen_timer
= timer
;
4482 timers
= XCDR (timers
);
4483 difference
= timer_difference
;
4487 chosen_timer
= idle_timer
;
4488 idle_timers
= XCDR (idle_timers
);
4489 difference
= idle_timer_difference
;
4492 else if (! NILP (timers
))
4494 chosen_timer
= timer
;
4495 timers
= XCDR (timers
);
4496 difference
= timer_difference
;
4500 chosen_timer
= idle_timer
;
4501 idle_timers
= XCDR (idle_timers
);
4502 difference
= idle_timer_difference
;
4504 vector
= XVECTOR (chosen_timer
)->contents
;
4506 /* If timer is ripe, run it if it hasn't been run. */
4507 if (EMACS_TIME_NEG_P (difference
)
4508 || (EMACS_SECS (difference
) == 0
4509 && EMACS_USECS (difference
) == 0))
4511 if (NILP (vector
[0]))
4513 int count
= SPECPDL_INDEX ();
4514 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4516 /* On unbind_to, resume allowing input from any kboard, if that
4518 record_single_kboard_state ();
4520 /* Mark the timer as triggered to prevent problems if the lisp
4521 code fails to reschedule it right. */
4524 specbind (Qinhibit_quit
, Qt
);
4526 call1 (Qtimer_event_handler
, chosen_timer
);
4527 Vdeactivate_mark
= old_deactivate_mark
;
4529 unbind_to (count
, Qnil
);
4531 /* Since we have handled the event,
4532 we don't need to tell the caller to wake up and do it. */
4536 /* When we encounter a timer that is still waiting,
4537 return the amount of time to wait before it is ripe. */
4544 /* No timers are pending in the future. */
4545 /* Return 0 if we generated an event, and -1 if not. */
4550 /* Caches for modify_event_symbol. */
4551 static Lisp_Object accent_key_syms
;
4552 static Lisp_Object func_key_syms
;
4553 static Lisp_Object mouse_syms
;
4554 static Lisp_Object wheel_syms
;
4555 static Lisp_Object drag_n_drop_syms
;
4557 /* This is a list of keysym codes for special "accent" characters.
4558 It parallels lispy_accent_keys. */
4560 static int lispy_accent_codes
[] =
4562 #ifdef XK_dead_circumflex
4567 #ifdef XK_dead_grave
4572 #ifdef XK_dead_tilde
4577 #ifdef XK_dead_diaeresis
4582 #ifdef XK_dead_macron
4587 #ifdef XK_dead_degree
4592 #ifdef XK_dead_acute
4597 #ifdef XK_dead_cedilla
4602 #ifdef XK_dead_breve
4607 #ifdef XK_dead_ogonek
4612 #ifdef XK_dead_caron
4617 #ifdef XK_dead_doubleacute
4618 XK_dead_doubleacute
,
4622 #ifdef XK_dead_abovedot
4627 #ifdef XK_dead_abovering
4637 #ifdef XK_dead_belowdot
4642 #ifdef XK_dead_voiced_sound
4643 XK_dead_voiced_sound
,
4647 #ifdef XK_dead_semivoiced_sound
4648 XK_dead_semivoiced_sound
,
4664 /* This is a list of Lisp names for special "accent" characters.
4665 It parallels lispy_accent_codes. */
4667 static char *lispy_accent_keys
[] =
4685 "dead-voiced-sound",
4686 "dead-semivoiced-sound",
4692 #define FUNCTION_KEY_OFFSET 0x0
4694 char *lispy_function_keys
[] =
4698 0, /* VK_LBUTTON 0x01 */
4699 0, /* VK_RBUTTON 0x02 */
4700 "cancel", /* VK_CANCEL 0x03 */
4701 0, /* VK_MBUTTON 0x04 */
4703 0, 0, 0, /* 0x05 .. 0x07 */
4705 "backspace", /* VK_BACK 0x08 */
4706 "tab", /* VK_TAB 0x09 */
4708 0, 0, /* 0x0A .. 0x0B */
4710 "clear", /* VK_CLEAR 0x0C */
4711 "return", /* VK_RETURN 0x0D */
4713 0, 0, /* 0x0E .. 0x0F */
4715 0, /* VK_SHIFT 0x10 */
4716 0, /* VK_CONTROL 0x11 */
4717 0, /* VK_MENU 0x12 */
4718 "pause", /* VK_PAUSE 0x13 */
4719 "capslock", /* VK_CAPITAL 0x14 */
4721 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4723 "escape", /* VK_ESCAPE 0x1B */
4725 0, 0, 0, 0, /* 0x1C .. 0x1F */
4727 0, /* VK_SPACE 0x20 */
4728 "prior", /* VK_PRIOR 0x21 */
4729 "next", /* VK_NEXT 0x22 */
4730 "end", /* VK_END 0x23 */
4731 "home", /* VK_HOME 0x24 */
4732 "left", /* VK_LEFT 0x25 */
4733 "up", /* VK_UP 0x26 */
4734 "right", /* VK_RIGHT 0x27 */
4735 "down", /* VK_DOWN 0x28 */
4736 "select", /* VK_SELECT 0x29 */
4737 "print", /* VK_PRINT 0x2A */
4738 "execute", /* VK_EXECUTE 0x2B */
4739 "snapshot", /* VK_SNAPSHOT 0x2C */
4740 "insert", /* VK_INSERT 0x2D */
4741 "delete", /* VK_DELETE 0x2E */
4742 "help", /* VK_HELP 0x2F */
4744 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4746 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4748 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4750 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4752 0, 0, 0, 0, 0, 0, 0, 0, 0,
4753 0, 0, 0, 0, 0, 0, 0, 0, 0,
4754 0, 0, 0, 0, 0, 0, 0, 0,
4756 "lwindow", /* VK_LWIN 0x5B */
4757 "rwindow", /* VK_RWIN 0x5C */
4758 "apps", /* VK_APPS 0x5D */
4760 0, 0, /* 0x5E .. 0x5F */
4762 "kp-0", /* VK_NUMPAD0 0x60 */
4763 "kp-1", /* VK_NUMPAD1 0x61 */
4764 "kp-2", /* VK_NUMPAD2 0x62 */
4765 "kp-3", /* VK_NUMPAD3 0x63 */
4766 "kp-4", /* VK_NUMPAD4 0x64 */
4767 "kp-5", /* VK_NUMPAD5 0x65 */
4768 "kp-6", /* VK_NUMPAD6 0x66 */
4769 "kp-7", /* VK_NUMPAD7 0x67 */
4770 "kp-8", /* VK_NUMPAD8 0x68 */
4771 "kp-9", /* VK_NUMPAD9 0x69 */
4772 "kp-multiply", /* VK_MULTIPLY 0x6A */
4773 "kp-add", /* VK_ADD 0x6B */
4774 "kp-separator", /* VK_SEPARATOR 0x6C */
4775 "kp-subtract", /* VK_SUBTRACT 0x6D */
4776 "kp-decimal", /* VK_DECIMAL 0x6E */
4777 "kp-divide", /* VK_DIVIDE 0x6F */
4778 "f1", /* VK_F1 0x70 */
4779 "f2", /* VK_F2 0x71 */
4780 "f3", /* VK_F3 0x72 */
4781 "f4", /* VK_F4 0x73 */
4782 "f5", /* VK_F5 0x74 */
4783 "f6", /* VK_F6 0x75 */
4784 "f7", /* VK_F7 0x76 */
4785 "f8", /* VK_F8 0x77 */
4786 "f9", /* VK_F9 0x78 */
4787 "f10", /* VK_F10 0x79 */
4788 "f11", /* VK_F11 0x7A */
4789 "f12", /* VK_F12 0x7B */
4790 "f13", /* VK_F13 0x7C */
4791 "f14", /* VK_F14 0x7D */
4792 "f15", /* VK_F15 0x7E */
4793 "f16", /* VK_F16 0x7F */
4794 "f17", /* VK_F17 0x80 */
4795 "f18", /* VK_F18 0x81 */
4796 "f19", /* VK_F19 0x82 */
4797 "f20", /* VK_F20 0x83 */
4798 "f21", /* VK_F21 0x84 */
4799 "f22", /* VK_F22 0x85 */
4800 "f23", /* VK_F23 0x86 */
4801 "f24", /* VK_F24 0x87 */
4803 0, 0, 0, 0, /* 0x88 .. 0x8B */
4804 0, 0, 0, 0, /* 0x8C .. 0x8F */
4806 "kp-numlock", /* VK_NUMLOCK 0x90 */
4807 "scroll", /* VK_SCROLL 0x91 */
4809 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4810 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4811 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4812 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4813 "kp-end", /* VK_NUMPAD_END 0x96 */
4814 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4815 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4816 "kp-up", /* VK_NUMPAD_UP 0x99 */
4817 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4818 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4819 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4820 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4822 0, 0, /* 0x9E .. 0x9F */
4825 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4826 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4827 * No other API or message will distinguish left and right keys this way.
4831 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4832 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4833 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4834 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4835 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4841 "attn", /* VK_ATTN 0xF6 */
4842 "crsel", /* VK_CRSEL 0xF7 */
4843 "exsel", /* VK_EXSEL 0xF8 */
4844 "ereof", /* VK_EREOF 0xF9 */
4845 "play", /* VK_PLAY 0xFA */
4846 "zoom", /* VK_ZOOM 0xFB */
4847 "noname", /* VK_NONAME 0xFC */
4848 "pa1", /* VK_PA1 0xFD */
4849 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4853 #else /* not HAVE_NTGUI */
4855 /* This should be dealt with in XTread_socket now, and that doesn't
4856 depend on the client system having the Kana syms defined. See also
4857 the XK_kana_A case below. */
4860 static char *lispy_kana_keys
[] =
4862 /* X Keysym value */
4863 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4864 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4865 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4866 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4867 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4868 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4869 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4870 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4871 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4872 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4873 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4874 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4875 "kana-i", "kana-u", "kana-e", "kana-o",
4876 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4877 "prolongedsound", "kana-A", "kana-I", "kana-U",
4878 "kana-E", "kana-O", "kana-KA", "kana-KI",
4879 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4880 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4881 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4882 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4883 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4884 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4885 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4886 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4887 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4888 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4889 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4890 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4892 #endif /* XK_kana_A */
4895 #define FUNCTION_KEY_OFFSET 0xff00
4897 /* You'll notice that this table is arranged to be conveniently
4898 indexed by X Windows keysym values. */
4899 static char *lispy_function_keys
[] =
4901 /* X Keysym value */
4903 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4904 "backspace", "tab", "linefeed", "clear",
4906 0, 0, 0, "pause", /* 0xff10...1f */
4907 0, 0, 0, 0, 0, 0, 0, "escape",
4909 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4910 "romaji", "hiragana", "katakana", "hiragana-katakana",
4911 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4912 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4913 "eisu-toggle", /* 0xff30...3f */
4914 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4915 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4917 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4918 "down", "prior", "next", "end",
4919 "begin", 0, 0, 0, 0, 0, 0, 0,
4920 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4931 "break", /* 0xff6b */
4934 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4935 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4936 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4937 0, 0, 0, 0, 0, 0, 0, 0,
4938 "kp-tab", /* 0xff89 */
4940 "kp-enter", /* 0xff8d */
4942 "kp-f1", /* 0xff91 */
4946 "kp-home", /* 0xff95 */
4951 "kp-prior", /* kp-page-up */
4952 "kp-next", /* kp-page-down */
4958 0, 0, 0, 0, 0, 0, 0, 0, 0,
4959 "kp-multiply", /* 0xffaa */
4964 "kp-divide", /* 0xffaf */
4965 "kp-0", /* 0xffb0 */
4966 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4969 "kp-equal", /* 0xffbd */
4970 "f1", /* 0xffbe */ /* IsFunctionKey */
4972 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4973 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4974 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4975 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4976 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4977 0, 0, 0, 0, 0, 0, 0, 0,
4978 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4979 0, 0, 0, 0, 0, 0, 0, "delete"
4982 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4983 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4985 static char *iso_lispy_function_keys
[] =
4987 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4988 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4989 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4990 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4991 "iso-lefttab", /* 0xfe20 */
4992 "iso-move-line-up", "iso-move-line-down",
4993 "iso-partial-line-up", "iso-partial-line-down",
4994 "iso-partial-space-left", "iso-partial-space-right",
4995 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4996 "iso-release-margin-left", "iso-release-margin-right",
4997 "iso-release-both-margins",
4998 "iso-fast-cursor-left", "iso-fast-cursor-right",
4999 "iso-fast-cursor-up", "iso-fast-cursor-down",
5000 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5001 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5004 #endif /* not HAVE_NTGUI */
5006 Lisp_Object Vlispy_mouse_stem
;
5008 static char *lispy_wheel_names
[] =
5010 "wheel-up", "wheel-down"
5013 /* drag-n-drop events are generated when a set of selected files are
5014 dragged from another application and dropped onto an Emacs window. */
5015 static char *lispy_drag_n_drop_names
[] =
5020 /* Scroll bar parts. */
5021 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5022 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5023 Lisp_Object Qtop
, Qratio
;
5025 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5026 Lisp_Object
*scroll_bar_parts
[] = {
5027 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5028 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5031 /* User signal events. */
5032 Lisp_Object Qusr1_signal
, Qusr2_signal
;
5034 Lisp_Object
*lispy_user_signals
[] =
5036 &Qusr1_signal
, &Qusr2_signal
5040 /* A vector, indexed by button number, giving the down-going location
5041 of currently depressed buttons, both scroll bar and non-scroll bar.
5043 The elements have the form
5044 (BUTTON-NUMBER MODIFIER-MASK . REST)
5045 where REST is the cdr of a position as it would be reported in the event.
5047 The make_lispy_event function stores positions here to tell the
5048 difference between click and drag events, and to store the starting
5049 location to be included in drag events. */
5051 static Lisp_Object button_down_location
;
5053 /* Information about the most recent up-going button event: Which
5054 button, what location, and what time. */
5056 static int last_mouse_button
;
5057 static int last_mouse_x
;
5058 static int last_mouse_y
;
5059 static unsigned long button_down_time
;
5061 /* The maximum time between clicks to make a double-click, or Qnil to
5062 disable double-click detection, or Qt for no time limit. */
5064 Lisp_Object Vdouble_click_time
;
5066 /* Maximum number of pixels the mouse may be moved between clicks
5067 to make a double-click. */
5069 EMACS_INT double_click_fuzz
;
5071 /* The number of clicks in this multiple-click. */
5073 int double_click_count
;
5075 /* Return position of a mouse click or wheel event */
5078 make_lispy_position (f
, x
, y
, time
)
5084 enum window_part part
;
5085 Lisp_Object posn
= Qnil
;
5086 Lisp_Object extra_info
= Qnil
;
5089 /* Set `window' to the window under frame pixel coordinates (x,y) */
5091 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5092 &part
, &wx
, &wy
, 0);
5096 if (WINDOWP (window
))
5098 /* It's a click in window window at frame coordinates (x,y) */
5099 struct window
*w
= XWINDOW (window
);
5100 Lisp_Object string_info
= Qnil
;
5101 int textpos
= -1, rx
= -1, ry
= -1;
5102 int dx
= -1, dy
= -1;
5103 int width
= -1, height
= -1;
5104 Lisp_Object object
= Qnil
;
5106 /* Set event coordinates to window-relative coordinates
5107 for constructing the Lisp event below. */
5111 if (part
== ON_TEXT
)
5113 wx
+= WINDOW_LEFT_MARGIN_WIDTH (w
);
5115 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5117 /* Mode line or header line. Look for a string under
5118 the mouse that may have a `local-map' property. */
5122 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5124 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5125 &object
, &dx
, &dy
, &width
, &height
);
5126 if (STRINGP (string
))
5127 string_info
= Fcons (string
, make_number (charpos
));
5128 if (w
== XWINDOW (selected_window
))
5131 textpos
= XMARKER (w
->pointm
)->charpos
;
5133 else if (part
== ON_VERTICAL_BORDER
)
5135 posn
= Qvertical_line
;
5140 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5145 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5147 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5148 &object
, &dx
, &dy
, &width
, &height
);
5149 if (STRINGP (string
))
5150 string_info
= Fcons (string
, make_number (charpos
));
5151 if (part
== ON_LEFT_MARGIN
)
5154 wx
= window_box_right_offset (w
, TEXT_AREA
) - 1;
5156 else if (part
== ON_LEFT_FRINGE
)
5158 posn
= Qleft_fringe
;
5161 wx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5163 : window_box_width (w
, LEFT_MARGIN_AREA
));
5166 else if (part
== ON_RIGHT_FRINGE
)
5168 posn
= Qright_fringe
;
5171 wx
= (window_box_width (w
, LEFT_MARGIN_AREA
)
5172 + window_box_width (w
, TEXT_AREA
)
5173 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5174 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5180 /* Note: We have no special posn for part == ON_SCROLL_BAR. */
5181 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5186 Lisp_Object string2
, object2
= Qnil
;
5187 struct display_pos p
;
5189 int width2
, height2
;
5190 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5191 &object2
, &dx2
, &dy2
,
5193 textpos
= CHARPOS (p
.pos
);
5194 if (rx
< 0) rx
= wx
;
5195 if (ry
< 0) ry
= wy
;
5196 if (dx
< 0) dx
= dx2
;
5197 if (dy
< 0) dy
= dy2
;
5198 if (width
< 0) width
= width2
;
5199 if (height
< 0) height
= height2
;
5203 posn
= make_number (textpos
);
5204 if (STRINGP (string2
))
5205 string_info
= Fcons (string2
,
5206 make_number (CHARPOS (p
.string_pos
)));
5212 #ifdef HAVE_WINDOW_SYSTEM
5213 if (IMAGEP (object
))
5215 Lisp_Object image_map
, hotspot
;
5216 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5218 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5220 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5221 posn
= XCAR (hotspot
);
5226 extra_info
= Fcons (object
,
5227 Fcons (Fcons (make_number (dx
),
5229 Fcons (Fcons (make_number (width
),
5230 make_number (height
)),
5234 extra_info
= Fcons (string_info
,
5235 Fcons (make_number (textpos
),
5236 Fcons (Fcons (make_number (rx
),
5242 XSETFRAME (window
, f
);
5247 XSETFASTINT (*x
, 0);
5248 XSETFASTINT (*y
, 0);
5251 return Fcons (window
,
5253 Fcons (Fcons (*x
, *y
),
5254 Fcons (make_number (time
),
5258 /* Given a struct input_event, build the lisp event which represents
5259 it. If EVENT is 0, build a mouse movement event from the mouse
5260 movement buffer, which should have a movement event in it.
5262 Note that events must be passed to this function in the order they
5263 are received; this function stores the location of button presses
5264 in order to build drag events when the button is released. */
5267 make_lispy_event (event
)
5268 struct input_event
*event
;
5272 switch (SWITCH_ENUM_CAST (event
->kind
))
5274 /* A simple keystroke. */
5275 case ASCII_KEYSTROKE_EVENT
:
5277 Lisp_Object lispy_c
;
5278 int c
= event
->code
& 0377;
5279 /* Turn ASCII characters into control characters
5281 if (event
->modifiers
& ctrl_modifier
)
5282 c
= make_ctrl_char (c
);
5284 /* Add in the other modifier bits. We took care of ctrl_modifier
5285 just above, and the shift key was taken care of by the X code,
5286 and applied to control characters by make_ctrl_char. */
5287 c
|= (event
->modifiers
5288 & (meta_modifier
| alt_modifier
5289 | hyper_modifier
| super_modifier
));
5290 /* Distinguish Shift-SPC from SPC. */
5291 if ((event
->code
& 0377) == 040
5292 && event
->modifiers
& shift_modifier
)
5293 c
|= shift_modifier
;
5294 button_down_time
= 0;
5295 XSETFASTINT (lispy_c
, c
);
5299 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5301 Lisp_Object lispy_c
;
5302 int c
= event
->code
;
5304 /* Add in the other modifier bits. We took care of ctrl_modifier
5305 just above, and the shift key was taken care of by the X code,
5306 and applied to control characters by make_ctrl_char. */
5307 c
|= (event
->modifiers
5308 & (meta_modifier
| alt_modifier
5309 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5310 /* What about the `shift' modifier ? */
5311 button_down_time
= 0;
5312 XSETFASTINT (lispy_c
, c
);
5316 /* A function key. The symbol may need to have modifier prefixes
5318 case NON_ASCII_KEYSTROKE_EVENT
:
5319 button_down_time
= 0;
5321 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5322 if (event
->code
== lispy_accent_codes
[i
])
5323 return modify_event_symbol (i
,
5325 Qfunction_key
, Qnil
,
5326 lispy_accent_keys
, &accent_key_syms
,
5327 (sizeof (lispy_accent_keys
)
5328 / sizeof (lispy_accent_keys
[0])));
5332 if (event
->code
>= 0x400 && event
->code
< 0x500)
5333 return modify_event_symbol (event
->code
- 0x400,
5334 event
->modifiers
& ~shift_modifier
,
5335 Qfunction_key
, Qnil
,
5336 lispy_kana_keys
, &func_key_syms
,
5337 (sizeof (lispy_kana_keys
)
5338 / sizeof (lispy_kana_keys
[0])));
5339 #endif /* XK_kana_A */
5342 #ifdef ISO_FUNCTION_KEY_OFFSET
5343 if (event
->code
< FUNCTION_KEY_OFFSET
5344 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5345 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5347 Qfunction_key
, Qnil
,
5348 iso_lispy_function_keys
, &func_key_syms
,
5349 (sizeof (iso_lispy_function_keys
)
5350 / sizeof (iso_lispy_function_keys
[0])));
5353 /* Handle system-specific or unknown keysyms. */
5354 if (event
->code
& (1 << 28)
5355 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5356 || (event
->code
- FUNCTION_KEY_OFFSET
5357 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5358 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5360 /* We need to use an alist rather than a vector as the cache
5361 since we can't make a vector long enuf. */
5362 if (NILP (current_kboard
->system_key_syms
))
5363 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5364 return modify_event_symbol (event
->code
,
5367 current_kboard
->Vsystem_key_alist
,
5368 0, ¤t_kboard
->system_key_syms
,
5372 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5374 Qfunction_key
, Qnil
,
5375 lispy_function_keys
, &func_key_syms
,
5376 (sizeof (lispy_function_keys
)
5377 / sizeof (lispy_function_keys
[0])));
5380 /* A mouse click. Figure out where it is, decide whether it's
5381 a press, click or drag, and build the appropriate structure. */
5382 case MOUSE_CLICK_EVENT
:
5383 #ifndef USE_TOOLKIT_SCROLL_BARS
5384 case SCROLL_BAR_CLICK_EVENT
:
5387 int button
= event
->code
;
5389 Lisp_Object position
;
5390 Lisp_Object
*start_pos_ptr
;
5391 Lisp_Object start_pos
;
5395 /* Build the position as appropriate for this mouse click. */
5396 if (event
->kind
== MOUSE_CLICK_EVENT
)
5398 struct frame
*f
= XFRAME (event
->frame_or_window
);
5399 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5403 /* Ignore mouse events that were made on frame that
5404 have been deleted. */
5405 if (! FRAME_LIVE_P (f
))
5408 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5409 /* EVENT->x and EVENT->y are frame-relative pixel
5410 coordinates at this place. Under old redisplay, COLUMN
5411 and ROW are set to frame relative glyph coordinates
5412 which are then used to determine whether this click is
5413 in a menu (non-toolkit version). */
5414 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5415 &column
, &row
, NULL
, 1);
5417 /* In the non-toolkit version, clicks on the menu bar
5418 are ordinary button events in the event buffer.
5419 Distinguish them, and invoke the menu.
5421 (In the toolkit version, the toolkit handles the menu bar
5422 and Emacs doesn't know about it until after the user
5423 makes a selection.) */
5424 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5425 && (event
->modifiers
& down_modifier
))
5427 Lisp_Object items
, item
;
5432 /* Activate the menu bar on the down event. If the
5433 up event comes in before the menu code can deal with it,
5435 if (! (event
->modifiers
& down_modifier
))
5439 /* Find the menu bar item under `column'. */
5441 items
= FRAME_MENU_BAR_ITEMS (f
);
5442 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5444 Lisp_Object pos
, string
;
5445 string
= AREF (items
, i
+ 1);
5446 pos
= AREF (items
, i
+ 3);
5449 if (column
>= XINT (pos
)
5450 && column
< XINT (pos
) + SCHARS (string
))
5452 item
= AREF (items
, i
);
5457 /* ELisp manual 2.4b says (x y) are window relative but
5458 code says they are frame-relative. */
5460 = Fcons (event
->frame_or_window
,
5462 Fcons (Fcons (event
->x
, event
->y
),
5463 Fcons (make_number (event
->timestamp
),
5466 return Fcons (item
, Fcons (position
, Qnil
));
5468 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5470 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5473 #ifndef USE_TOOLKIT_SCROLL_BARS
5476 /* It's a scrollbar click. */
5478 Lisp_Object portion_whole
;
5481 window
= event
->frame_or_window
;
5482 portion_whole
= Fcons (event
->x
, event
->y
);
5483 part
= *scroll_bar_parts
[(int) event
->part
];
5487 Fcons (Qvertical_scroll_bar
,
5488 Fcons (portion_whole
,
5489 Fcons (make_number (event
->timestamp
),
5490 Fcons (part
, Qnil
)))));
5492 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5494 if (button
>= ASIZE (button_down_location
))
5496 button_down_location
= larger_vector (button_down_location
,
5498 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5501 start_pos_ptr
= &AREF (button_down_location
, button
);
5502 start_pos
= *start_pos_ptr
;
5503 *start_pos_ptr
= Qnil
;
5506 /* On window-system frames, use the value of
5507 double-click-fuzz as is. On other frames, interpret it
5508 as a multiple of 1/8 characters. */
5512 if (WINDOWP (event
->frame_or_window
))
5513 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5514 else if (FRAMEP (event
->frame_or_window
))
5515 f
= XFRAME (event
->frame_or_window
);
5519 if (FRAME_WINDOW_P (f
))
5520 fuzz
= double_click_fuzz
;
5522 fuzz
= double_click_fuzz
/ 8;
5524 is_double
= (button
== last_mouse_button
5525 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5526 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5527 && button_down_time
!= 0
5528 && (EQ (Vdouble_click_time
, Qt
)
5529 || (INTEGERP (Vdouble_click_time
)
5530 && ((int)(event
->timestamp
- button_down_time
)
5531 < XINT (Vdouble_click_time
)))));
5534 last_mouse_button
= button
;
5535 last_mouse_x
= XINT (event
->x
);
5536 last_mouse_y
= XINT (event
->y
);
5538 /* If this is a button press, squirrel away the location, so
5539 we can decide later whether it was a click or a drag. */
5540 if (event
->modifiers
& down_modifier
)
5544 double_click_count
++;
5545 event
->modifiers
|= ((double_click_count
> 2)
5550 double_click_count
= 1;
5551 button_down_time
= event
->timestamp
;
5552 *start_pos_ptr
= Fcopy_alist (position
);
5555 /* Now we're releasing a button - check the co-ordinates to
5556 see if this was a click or a drag. */
5557 else if (event
->modifiers
& up_modifier
)
5559 /* If we did not see a down before this up, ignore the up.
5560 Probably this happened because the down event chose a
5561 menu item. It would be an annoyance to treat the
5562 release of the button that chose the menu item as a
5565 if (!CONSP (start_pos
))
5568 event
->modifiers
&= ~up_modifier
;
5569 #if 0 /* Formerly we treated an up with no down as a click event. */
5570 if (!CONSP (start_pos
))
5571 event
->modifiers
|= click_modifier
;
5576 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5578 /* The third element of every position
5579 should be the (x,y) pair. */
5580 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5582 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5584 xdiff
= XINT (event
->x
) - XINT (XCAR (down
));
5585 ydiff
= XINT (event
->y
) - XINT (XCDR (down
));
5588 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5589 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5590 /* Maybe the mouse has moved a lot, caused scrolling, and
5591 eventually ended up at the same screen position (but
5592 not buffer position) in which case it is a drag, not
5594 /* FIXME: OTOH if the buffer position has changed
5595 because of a timer or process filter rather than
5596 because of mouse movement, it should be considered as
5597 a click. But mouse-drag-region completely ignores
5598 this case and it hasn't caused any real problem, so
5599 it's probably OK to ignore it as well. */
5600 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5601 /* Mouse hasn't moved (much). */
5602 event
->modifiers
|= click_modifier
;
5605 button_down_time
= 0;
5606 event
->modifiers
|= drag_modifier
;
5609 /* Don't check is_double; treat this as multiple
5610 if the down-event was multiple. */
5611 if (double_click_count
> 1)
5612 event
->modifiers
|= ((double_click_count
> 2)
5618 /* Every mouse event should either have the down_modifier or
5619 the up_modifier set. */
5623 /* Get the symbol we should use for the mouse click. */
5626 head
= modify_event_symbol (button
,
5628 Qmouse_click
, Vlispy_mouse_stem
,
5631 XVECTOR (mouse_syms
)->size
);
5632 if (event
->modifiers
& drag_modifier
)
5637 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5640 Fcons (make_number (double_click_count
),
5651 Lisp_Object position
;
5654 /* Build the position as appropriate for this mouse click. */
5655 struct frame
*f
= XFRAME (event
->frame_or_window
);
5657 /* Ignore wheel events that were made on frame that have been
5659 if (! FRAME_LIVE_P (f
))
5662 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5665 /* Set double or triple modifiers to indicate the wheel speed. */
5667 /* On window-system frames, use the value of
5668 double-click-fuzz as is. On other frames, interpret it
5669 as a multiple of 1/8 characters. */
5674 if (WINDOWP (event
->frame_or_window
))
5675 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5676 else if (FRAMEP (event
->frame_or_window
))
5677 f
= XFRAME (event
->frame_or_window
);
5681 if (FRAME_WINDOW_P (f
))
5682 fuzz
= double_click_fuzz
;
5684 fuzz
= double_click_fuzz
/ 8;
5686 is_double
= (last_mouse_button
< 0
5687 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5688 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5689 && button_down_time
!= 0
5690 && (EQ (Vdouble_click_time
, Qt
)
5691 || (INTEGERP (Vdouble_click_time
)
5692 && ((int)(event
->timestamp
- button_down_time
)
5693 < XINT (Vdouble_click_time
)))));
5696 double_click_count
++;
5697 event
->modifiers
|= ((double_click_count
> 2)
5703 double_click_count
= 1;
5704 event
->modifiers
|= click_modifier
;
5707 button_down_time
= event
->timestamp
;
5708 /* Use a negative value to distinguish wheel from mouse button. */
5709 last_mouse_button
= -1;
5710 last_mouse_x
= XINT (event
->x
);
5711 last_mouse_y
= XINT (event
->y
);
5717 if (event
->modifiers
& up_modifier
)
5719 /* Emit a wheel-up event. */
5720 event
->modifiers
&= ~up_modifier
;
5723 else if (event
->modifiers
& down_modifier
)
5725 /* Emit a wheel-down event. */
5726 event
->modifiers
&= ~down_modifier
;
5730 /* Every wheel event should either have the down_modifier or
5731 the up_modifier set. */
5734 /* Get the symbol we should use for the wheel event. */
5735 head
= modify_event_symbol (symbol_num
,
5741 ASIZE (wheel_syms
));
5744 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5747 Fcons (make_number (double_click_count
),
5756 #ifdef USE_TOOLKIT_SCROLL_BARS
5758 /* We don't have down and up events if using toolkit scroll bars,
5759 so make this always a click event. Store in the `part' of
5760 the Lisp event a symbol which maps to the following actions:
5762 `above_handle' page up
5763 `below_handle' page down
5767 `bottom' bottom of buffer
5768 `handle' thumb has been dragged.
5769 `end-scroll' end of interaction with scroll bar
5771 The incoming input_event contains in its `part' member an
5772 index of type `enum scroll_bar_part' which we can use as an
5773 index in scroll_bar_parts to get the appropriate symbol. */
5775 case SCROLL_BAR_CLICK_EVENT
:
5777 Lisp_Object position
, head
, window
, portion_whole
, part
;
5779 window
= event
->frame_or_window
;
5780 portion_whole
= Fcons (event
->x
, event
->y
);
5781 part
= *scroll_bar_parts
[(int) event
->part
];
5785 Fcons (Qvertical_scroll_bar
,
5786 Fcons (portion_whole
,
5787 Fcons (make_number (event
->timestamp
),
5788 Fcons (part
, Qnil
)))));
5790 /* Always treat scroll bar events as clicks. */
5791 event
->modifiers
|= click_modifier
;
5792 event
->modifiers
&= ~up_modifier
;
5794 if (event
->code
>= ASIZE (mouse_syms
))
5795 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5797 /* Get the symbol we should use for the mouse click. */
5798 head
= modify_event_symbol (event
->code
,
5803 XVECTOR (mouse_syms
)->size
);
5804 return Fcons (head
, Fcons (position
, Qnil
));
5807 #endif /* USE_TOOLKIT_SCROLL_BARS */
5810 case W32_SCROLL_BAR_CLICK_EVENT
:
5812 int button
= event
->code
;
5814 Lisp_Object position
;
5815 Lisp_Object
*start_pos_ptr
;
5816 Lisp_Object start_pos
;
5820 Lisp_Object portion_whole
;
5823 window
= event
->frame_or_window
;
5824 portion_whole
= Fcons (event
->x
, event
->y
);
5825 part
= *scroll_bar_parts
[(int) event
->part
];
5829 Fcons (Qvertical_scroll_bar
,
5830 Fcons (portion_whole
,
5831 Fcons (make_number (event
->timestamp
),
5832 Fcons (part
, Qnil
)))));
5835 /* Always treat W32 scroll bar events as clicks. */
5836 event
->modifiers
|= click_modifier
;
5839 /* Get the symbol we should use for the mouse click. */
5842 head
= modify_event_symbol (button
,
5847 XVECTOR (mouse_syms
)->size
);
5853 #endif /* WINDOWSNT */
5855 case DRAG_N_DROP_EVENT
:
5858 Lisp_Object head
, position
;
5861 f
= XFRAME (event
->frame_or_window
);
5864 /* Ignore mouse events that were made on frames that
5865 have been deleted. */
5866 if (! FRAME_LIVE_P (f
))
5869 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5872 head
= modify_event_symbol (0, event
->modifiers
,
5874 lispy_drag_n_drop_names
,
5875 &drag_n_drop_syms
, 1);
5881 #endif /* HAVE_MOUSE */
5883 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5884 || defined (USE_GTK)
5885 case MENU_BAR_EVENT
:
5886 if (EQ (event
->arg
, event
->frame_or_window
))
5887 /* This is the prefix key. We translate this to
5888 `(menu_bar)' because the code in keyboard.c for menu
5889 events, which we use, relies on this. */
5890 return Fcons (Qmenu_bar
, Qnil
);
5894 case SELECT_WINDOW_EVENT
:
5895 /* Make an event (select-window (WINDOW)). */
5896 return Fcons (Qselect_window
,
5897 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5900 case TOOL_BAR_EVENT
:
5901 if (EQ (event
->arg
, event
->frame_or_window
))
5902 /* This is the prefix key. We translate this to
5903 `(tool_bar)' because the code in keyboard.c for tool bar
5904 events, which we use, relies on this. */
5905 return Fcons (Qtool_bar
, Qnil
);
5906 else if (SYMBOLP (event
->arg
))
5907 return apply_modifiers (event
->modifiers
, event
->arg
);
5910 case USER_SIGNAL_EVENT
:
5911 /* A user signal. */
5912 return *lispy_user_signals
[event
->code
];
5914 case SAVE_SESSION_EVENT
:
5915 return Qsave_session
;
5918 case MAC_APPLE_EVENT
:
5920 Lisp_Object spec
[2];
5924 return Fcons (Qmac_apple_event
,
5925 Fcons (Fvector (2, spec
),
5926 Fcons (mac_make_lispy_event_code (event
->code
),
5931 /* The 'kind' field of the event is something we don't recognize. */
5940 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5942 Lisp_Object bar_window
;
5943 enum scroll_bar_part part
;
5947 /* Is it a scroll bar movement? */
5948 if (frame
&& ! NILP (bar_window
))
5950 Lisp_Object part_sym
;
5952 part_sym
= *scroll_bar_parts
[(int) part
];
5953 return Fcons (Qscroll_bar_movement
,
5954 (Fcons (Fcons (bar_window
,
5955 Fcons (Qvertical_scroll_bar
,
5956 Fcons (Fcons (x
, y
),
5957 Fcons (make_number (time
),
5963 /* Or is it an ordinary mouse movement? */
5966 Lisp_Object position
;
5968 position
= make_lispy_position (frame
, &x
, &y
, time
);
5970 return Fcons (Qmouse_movement
,
5976 #endif /* HAVE_MOUSE */
5978 /* Construct a switch frame event. */
5980 make_lispy_switch_frame (frame
)
5983 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5986 /* Manipulating modifiers. */
5988 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5990 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5991 SYMBOL's name of the end of the modifiers; the string from this
5992 position is the unmodified symbol name.
5994 This doesn't use any caches. */
5997 parse_modifiers_uncached (symbol
, modifier_end
)
6005 CHECK_SYMBOL (symbol
);
6008 name
= SYMBOL_NAME (symbol
);
6010 for (i
= 0; i
+2 <= SBYTES (name
); )
6012 int this_mod_end
= 0;
6015 /* See if the name continues with a modifier word.
6016 Check that the word appears, but don't check what follows it.
6017 Set this_mod and this_mod_end to record what we find. */
6019 switch (SREF (name
, i
))
6021 #define SINGLE_LETTER_MOD(BIT) \
6022 (this_mod_end = i + 1, this_mod = BIT)
6025 SINGLE_LETTER_MOD (alt_modifier
);
6029 SINGLE_LETTER_MOD (ctrl_modifier
);
6033 SINGLE_LETTER_MOD (hyper_modifier
);
6037 SINGLE_LETTER_MOD (meta_modifier
);
6041 SINGLE_LETTER_MOD (shift_modifier
);
6045 SINGLE_LETTER_MOD (super_modifier
);
6048 #undef SINGLE_LETTER_MOD
6050 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6051 if (i + LEN + 1 <= SBYTES (name) \
6052 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6054 this_mod_end = i + LEN; \
6059 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6060 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6061 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6065 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6067 #undef MULTI_LETTER_MOD
6071 /* If we found no modifier, stop looking for them. */
6072 if (this_mod_end
== 0)
6075 /* Check there is a dash after the modifier, so that it
6076 really is a modifier. */
6077 if (this_mod_end
>= SBYTES (name
)
6078 || SREF (name
, this_mod_end
) != '-')
6081 /* This modifier is real; look for another. */
6082 modifiers
|= this_mod
;
6083 i
= this_mod_end
+ 1;
6086 /* Should we include the `click' modifier? */
6087 if (! (modifiers
& (down_modifier
| drag_modifier
6088 | double_modifier
| triple_modifier
))
6089 && i
+ 7 == SBYTES (name
)
6090 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6091 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6092 modifiers
|= click_modifier
;
6100 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6101 prepended to the string BASE[0..BASE_LEN-1].
6102 This doesn't use any caches. */
6104 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6107 int base_len
, base_len_byte
;
6109 /* Since BASE could contain nulls, we can't use intern here; we have
6110 to use Fintern, which expects a genuine Lisp_String, and keeps a
6113 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6119 /* Only the event queue may use the `up' modifier; it should always
6120 be turned into a click or drag event before presented to lisp code. */
6121 if (modifiers
& up_modifier
)
6124 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6125 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6126 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6127 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6128 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6129 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6130 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6131 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6132 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6133 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6134 /* The click modifier is denoted by the absence of other modifiers. */
6138 mod_len
= p
- new_mods
;
6142 Lisp_Object new_name
;
6144 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6145 mod_len
+ base_len_byte
);
6146 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6147 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6149 return Fintern (new_name
, Qnil
);
6154 static char *modifier_names
[] =
6156 "up", "down", "drag", "click", "double", "triple", 0, 0,
6157 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6158 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6160 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6162 static Lisp_Object modifier_symbols
;
6164 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6166 lispy_modifier_list (modifiers
)
6169 Lisp_Object modifier_list
;
6172 modifier_list
= Qnil
;
6173 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6174 if (modifiers
& (1<<i
))
6175 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6178 return modifier_list
;
6182 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6183 where UNMODIFIED is the unmodified form of SYMBOL,
6184 MASK is the set of modifiers present in SYMBOL's name.
6185 This is similar to parse_modifiers_uncached, but uses the cache in
6186 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6187 Qevent_symbol_elements property. */
6190 parse_modifiers (symbol
)
6193 Lisp_Object elements
;
6195 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6196 if (CONSP (elements
))
6201 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6202 Lisp_Object unmodified
;
6205 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6206 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6209 if (modifiers
& ~INTMASK
)
6211 XSETFASTINT (mask
, modifiers
);
6212 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6214 /* Cache the parsing results on SYMBOL. */
6215 Fput (symbol
, Qevent_symbol_element_mask
,
6217 Fput (symbol
, Qevent_symbol_elements
,
6218 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6220 /* Since we know that SYMBOL is modifiers applied to unmodified,
6221 it would be nice to put that in unmodified's cache.
6222 But we can't, since we're not sure that parse_modifiers is
6229 /* Apply the modifiers MODIFIERS to the symbol BASE.
6230 BASE must be unmodified.
6232 This is like apply_modifiers_uncached, but uses BASE's
6233 Qmodifier_cache property, if present. It also builds
6234 Qevent_symbol_elements properties, since it has that info anyway.
6236 apply_modifiers copies the value of BASE's Qevent_kind property to
6237 the modified symbol. */
6239 apply_modifiers (modifiers
, base
)
6243 Lisp_Object cache
, index
, entry
, new_symbol
;
6245 /* Mask out upper bits. We don't know where this value's been. */
6246 modifiers
&= INTMASK
;
6248 /* The click modifier never figures into cache indices. */
6249 cache
= Fget (base
, Qmodifier_cache
);
6250 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6251 entry
= assq_no_quit (index
, cache
);
6254 new_symbol
= XCDR (entry
);
6257 /* We have to create the symbol ourselves. */
6258 new_symbol
= apply_modifiers_uncached (modifiers
,
6259 SDATA (SYMBOL_NAME (base
)),
6260 SCHARS (SYMBOL_NAME (base
)),
6261 SBYTES (SYMBOL_NAME (base
)));
6263 /* Add the new symbol to the base's cache. */
6264 entry
= Fcons (index
, new_symbol
);
6265 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6267 /* We have the parsing info now for free, so we could add it to
6269 XSETFASTINT (index, modifiers);
6270 Fput (new_symbol, Qevent_symbol_element_mask,
6271 Fcons (base, Fcons (index, Qnil)));
6272 Fput (new_symbol, Qevent_symbol_elements,
6273 Fcons (base, lispy_modifier_list (modifiers)));
6274 Sadly, this is only correct if `base' is indeed a base event,
6275 which is not necessarily the case. -stef */
6278 /* Make sure this symbol is of the same kind as BASE.
6280 You'd think we could just set this once and for all when we
6281 intern the symbol above, but reorder_modifiers may call us when
6282 BASE's property isn't set right; we can't assume that just
6283 because it has a Qmodifier_cache property it must have its
6284 Qevent_kind set right as well. */
6285 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6289 kind
= Fget (base
, Qevent_kind
);
6291 Fput (new_symbol
, Qevent_kind
, kind
);
6298 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6299 return a symbol with the modifiers placed in the canonical order.
6300 Canonical order is alphabetical, except for down and drag, which
6301 always come last. The 'click' modifier is never written out.
6303 Fdefine_key calls this to make sure that (for example) C-M-foo
6304 and M-C-foo end up being equivalent in the keymap. */
6307 reorder_modifiers (symbol
)
6310 /* It's hopefully okay to write the code this way, since everything
6311 will soon be in caches, and no consing will be done at all. */
6314 parsed
= parse_modifiers (symbol
);
6315 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6320 /* For handling events, we often want to produce a symbol whose name
6321 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6322 to some base, like the name of a function key or mouse button.
6323 modify_event_symbol produces symbols of this sort.
6325 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6326 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6329 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6330 into symbol names, or a string specifying a name stem used to
6331 construct a symbol name or the form `STEM-N', where N is the decimal
6332 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6333 non-nil; otherwise NAME_TABLE is used.
6335 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6336 persist between calls to modify_event_symbol that it can use to
6337 store a cache of the symbols it's generated for this NAME_TABLE
6338 before. The object stored there may be a vector or an alist.
6340 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6342 MODIFIERS is a set of modifier bits (as given in struct input_events)
6343 whose prefixes should be applied to the symbol name.
6345 SYMBOL_KIND is the value to be placed in the event_kind property of
6346 the returned symbol.
6348 The symbols we create are supposed to have an
6349 `event-symbol-elements' property, which lists the modifiers present
6350 in the symbol's name. */
6353 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6354 name_table
, symbol_table
, table_size
)
6357 Lisp_Object symbol_kind
;
6358 Lisp_Object name_alist_or_stem
;
6360 Lisp_Object
*symbol_table
;
6361 unsigned int table_size
;
6364 Lisp_Object symbol_int
;
6366 /* Get rid of the "vendor-specific" bit here. */
6367 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6369 /* Is this a request for a valid symbol? */
6370 if (symbol_num
< 0 || symbol_num
>= table_size
)
6373 if (CONSP (*symbol_table
))
6374 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6376 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6377 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6378 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6379 we've never used that symbol before. */
6382 if (! VECTORP (*symbol_table
)
6383 || XVECTOR (*symbol_table
)->size
!= table_size
)
6387 XSETFASTINT (size
, table_size
);
6388 *symbol_table
= Fmake_vector (size
, Qnil
);
6391 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6394 /* Have we already used this symbol before? */
6397 /* No; let's create it. */
6398 if (CONSP (name_alist_or_stem
))
6399 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6400 else if (STRINGP (name_alist_or_stem
))
6402 int len
= SBYTES (name_alist_or_stem
);
6403 char *buf
= (char *) alloca (len
+ 50);
6404 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6405 (long) XINT (symbol_int
) + 1);
6406 value
= intern (buf
);
6408 else if (name_table
!= 0 && name_table
[symbol_num
])
6409 value
= intern (name_table
[symbol_num
]);
6411 #ifdef HAVE_WINDOW_SYSTEM
6414 char *name
= x_get_keysym_name (symbol_num
);
6416 value
= intern (name
);
6423 sprintf (buf
, "key-%d", symbol_num
);
6424 value
= intern (buf
);
6427 if (CONSP (*symbol_table
))
6428 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6430 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6432 /* Fill in the cache entries for this symbol; this also
6433 builds the Qevent_symbol_elements property, which the user
6435 apply_modifiers (modifiers
& click_modifier
, value
);
6436 Fput (value
, Qevent_kind
, symbol_kind
);
6439 /* Apply modifiers to that symbol. */
6440 return apply_modifiers (modifiers
, value
);
6443 /* Convert a list that represents an event type,
6444 such as (ctrl meta backspace), into the usual representation of that
6445 event type as a number or a symbol. */
6447 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6448 doc
: /* Convert the event description list EVENT-DESC to an event type.
6449 EVENT-DESC should contain one base event type (a character or symbol)
6450 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6451 drag, down, double or triple). The base must be last.
6452 The return value is an event type (a character or symbol) which
6453 has the same base event type and all the specified modifiers. */)
6455 Lisp_Object event_desc
;
6463 while (CONSP (rest
))
6471 /* Given a symbol, see if it is a modifier name. */
6472 if (SYMBOLP (elt
) && CONSP (rest
))
6473 this = parse_solitary_modifier (elt
);
6477 else if (!NILP (base
))
6478 error ("Two bases given in one event");
6484 /* Let the symbol A refer to the character A. */
6485 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6486 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6488 if (INTEGERP (base
))
6490 /* Turn (shift a) into A. */
6491 if ((modifiers
& shift_modifier
) != 0
6492 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6494 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6495 modifiers
&= ~shift_modifier
;
6498 /* Turn (control a) into C-a. */
6499 if (modifiers
& ctrl_modifier
)
6500 return make_number ((modifiers
& ~ctrl_modifier
)
6501 | make_ctrl_char (XINT (base
)));
6503 return make_number (modifiers
| XINT (base
));
6505 else if (SYMBOLP (base
))
6506 return apply_modifiers (modifiers
, base
);
6509 error ("Invalid base event");
6514 /* Try to recognize SYMBOL as a modifier name.
6515 Return the modifier flag bit, or 0 if not recognized. */
6518 parse_solitary_modifier (symbol
)
6521 Lisp_Object name
= SYMBOL_NAME (symbol
);
6523 switch (SREF (name
, 0))
6525 #define SINGLE_LETTER_MOD(BIT) \
6526 if (SBYTES (name) == 1) \
6529 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6530 if (LEN == SBYTES (name) \
6531 && ! strncmp (SDATA (name), NAME, LEN)) \
6535 SINGLE_LETTER_MOD (alt_modifier
);
6539 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6543 SINGLE_LETTER_MOD (ctrl_modifier
);
6547 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6548 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6552 SINGLE_LETTER_MOD (hyper_modifier
);
6556 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6560 SINGLE_LETTER_MOD (meta_modifier
);
6564 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6568 SINGLE_LETTER_MOD (shift_modifier
);
6572 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6573 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6574 SINGLE_LETTER_MOD (super_modifier
);
6578 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6579 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6580 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6584 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6587 #undef SINGLE_LETTER_MOD
6588 #undef MULTI_LETTER_MOD
6594 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6595 Such a list is not valid as an event,
6596 but it can be a Lucid-style event type list. */
6599 lucid_event_type_list_p (object
)
6604 if (! CONSP (object
))
6607 if (EQ (XCAR (object
), Qhelp_echo
)
6608 || EQ (XCAR (object
), Qvertical_line
)
6609 || EQ (XCAR (object
), Qmode_line
)
6610 || EQ (XCAR (object
), Qheader_line
))
6613 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6617 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6624 /* Store into *addr a value nonzero if terminal input chars are available.
6625 Serves the purpose of ioctl (0, FIONREAD, addr)
6626 but works even if FIONREAD does not exist.
6627 (In fact, this may actually read some input.)
6629 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6630 timer events that are ripe.
6631 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6632 events (FOCUS_IN_EVENT).
6633 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6634 movements and toolkit scroll bar thumb drags. */
6637 get_input_pending (addr
, flags
)
6641 /* First of all, have we already counted some input? */
6642 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6644 /* If input is being read as it arrives, and we have none, there is none. */
6645 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6648 /* Try to read some input and see how much we get. */
6650 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6653 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6656 gobble_input (expected
)
6661 if (interrupt_input
)
6664 mask
= sigblock (sigmask (SIGIO
));
6665 read_avail_input (expected
);
6669 #ifdef POLL_FOR_INPUT
6670 /* XXX This condition was (read_socket_hook && !interrupt_input),
6671 but read_socket_hook is not global anymore. Let's pretend that
6673 if (!interrupt_input
&& poll_suppress_count
== 0)
6676 mask
= sigblock (sigmask (SIGALRM
));
6677 read_avail_input (expected
);
6683 read_avail_input (expected
);
6687 /* Put a BUFFER_SWITCH_EVENT in the buffer
6688 so that read_key_sequence will notice the new current buffer. */
6691 record_asynch_buffer_change ()
6693 struct input_event event
;
6697 event
.kind
= BUFFER_SWITCH_EVENT
;
6698 event
.frame_or_window
= Qnil
;
6702 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6703 The purpose of the event is to make read_key_sequence look up the
6704 keymaps again. If we aren't in read_key_sequence, we don't need one,
6705 and the event could cause trouble by messing up (input-pending-p). */
6706 tem
= Fwaiting_for_user_input_p ();
6710 /* We never need these events if we have no asynchronous subprocesses. */
6714 /* Make sure no interrupt happens while storing the event. */
6716 if (interrupt_input
)
6719 mask
= sigblock (sigmask (SIGIO
));
6720 kbd_buffer_store_event (&event
);
6727 kbd_buffer_store_event (&event
);
6734 /* Read any terminal input already buffered up by the system
6735 into the kbd_buffer, but do not wait.
6737 EXPECTED should be nonzero if the caller knows there is some input.
6739 Except on VMS, all input is read by this function.
6740 If interrupt_input is nonzero, this function MUST be called
6741 only when SIGIO is blocked.
6743 Returns the number of keyboard chars read, or -1 meaning
6744 this is a bad time to try to read input. */
6747 read_avail_input (expected
)
6754 /* Loop through the available devices, and call their input hooks. */
6758 struct device
*next
= d
->next_device
;
6760 if (d
->read_socket_hook
)
6763 struct input_event hold_quit
;
6765 EVENT_INIT (hold_quit
);
6766 hold_quit
.kind
= NO_EVENT
;
6768 /* No need for FIONREAD or fcntl; just say don't wait. */
6769 while (nr
= (*d
->read_socket_hook
) (d
, expected
, &hold_quit
), nr
> 0)
6775 if (nr
== -1) /* Not OK to read input now. */
6779 else if (nr
== -2) /* Non-transient error. */
6781 /* The display device terminated; it should be closed. */
6783 /* Kill Emacs if this was our last display. */
6784 if (! device_list
->next_device
)
6785 /* Formerly simply reported no input, but that
6786 sometimes led to a failure of Emacs to terminate.
6787 SIGHUP seems appropriate if we can't reach the
6789 /* ??? Is it really right to send the signal just to
6790 this process rather than to the whole process
6791 group? Perhaps on systems with FIONREAD Emacs is
6792 alone in its group. */
6793 kill (getpid (), SIGHUP
);
6795 /* XXX Is calling delete_device safe here? It calls Fdelete_frame. */
6796 if (d
->delete_device_hook
)
6797 (*d
->delete_device_hook
) (d
);
6802 if (hold_quit
.kind
!= NO_EVENT
)
6803 kbd_buffer_store_event (&hold_quit
);
6815 /* This is the tty way of reading available input.
6817 Note that each terminal device has its own `struct device' object,
6818 and so this function is called once for each individual termcap
6819 display. The first parameter indicates which device to read from. */
6822 tty_read_avail_input (struct device
*device
,
6824 struct input_event
*hold_quit
)
6826 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6827 the kbd_buffer can really hold. That may prevent loss
6828 of characters on some systems when input is stuffed at us. */
6829 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6831 struct tty_display_info
*tty
= device
->display_info
.tty
;
6834 if (device
->type
!= output_termcap
)
6837 /* XXX I think the following code should be moved to separate hook
6838 functions in system-dependent files. */
6841 #else /* not WINDOWSNT */
6843 n_to_read
= dos_keysns ();
6847 cbuf
[0] = dos_keyread ();
6850 #else /* not MSDOS */
6852 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6856 return 0; /* The terminal is suspended. */
6858 /* Determine how many characters we should *try* to read. */
6860 /* Find out how much input is available. */
6861 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6863 if (! noninteractive
)
6864 return -2; /* Close this device. */
6870 if (n_to_read
> sizeof cbuf
)
6871 n_to_read
= sizeof cbuf
;
6872 #else /* no FIONREAD */
6873 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6874 /* Read some input if available, but don't wait. */
6875 n_to_read
= sizeof cbuf
;
6876 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6882 /* Now read; for one reason or another, this will not block.
6883 NREAD is set to the number of chars read. */
6886 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6887 /* POSIX infers that processes which are not in the session leader's
6888 process group won't get SIGHUP's at logout time. BSDI adheres to
6889 this part standard and returns -1 from read (0) with errno==EIO
6890 when the control tty is taken away.
6891 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6892 if (nread
== -1 && errno
== EIO
)
6893 return -2; /* Close this device. */
6894 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6895 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6896 This looks incorrect, but it isn't, because _BSD causes
6897 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6898 and that causes a value other than 0 when there is no input. */
6900 return -2; /* Close this device. */
6904 /* We used to retry the read if it was interrupted.
6905 But this does the wrong thing when O_NDELAY causes
6906 an EAGAIN error. Does anybody know of a situation
6907 where a retry is actually needed? */
6909 nread
< 0 && (errno
== EAGAIN
6923 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6924 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6925 #endif /* USG or DGUX or CYGWIN */
6926 #endif /* no FIONREAD */
6931 #endif /* not MSDOS */
6932 #endif /* not WINDOWSNT */
6934 for (i
= 0; i
< nread
; i
++)
6936 struct input_event buf
;
6938 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6940 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6941 buf
.modifiers
= meta_modifier
;
6942 if (tty
->meta_key
!= 2)
6946 /* Set the frame corresponding to the active tty. Note that the
6947 value of selected_frame is not reliable here, redisplay tends
6948 to temporarily change it. */
6949 buf
.frame_or_window
= tty
->top_frame
;
6952 kbd_buffer_store_event (&buf
);
6953 /* Don't look at input that follows a C-g too closely.
6954 This reduces lossage due to autorepeat on C-g. */
6955 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6956 && buf
.code
== quit_char
)
6962 #endif /* not VMS */
6965 handle_async_input ()
6968 extern int select_alarmed
;
6971 interrupt_input_pending
= 0;
6976 nread
= read_avail_input (1);
6977 /* -1 means it's not ok to read the input now.
6978 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6979 0 means there was no keyboard input available. */
6984 select_alarmed
= 1; /* Force the select emulator back to life */
6989 #ifdef SIGIO /* for entire page */
6990 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6993 input_available_signal (signo
)
6996 /* Must preserve main program's value of errno. */
6997 int old_errno
= errno
;
6998 #if defined (USG) && !defined (POSIX_SIGNALS)
6999 /* USG systems forget handlers when they are used;
7000 must reestablish each time */
7001 signal (signo
, input_available_signal
);
7009 interrupt_input_pending
= 1;
7011 SIGNAL_THREAD_CHECK (signo
);
7014 if (input_available_clear_time
)
7015 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
7018 handle_async_input ();
7028 /* Send ourselves a SIGIO.
7030 This function exists so that the UNBLOCK_INPUT macro in
7031 blockinput.h can have some way to take care of input we put off
7032 dealing with, without assuming that every file which uses
7033 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7035 reinvoke_input_signal ()
7038 handle_async_input ();
7044 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
7045 static Lisp_Object menu_bar_one_keymap_changed_items
;
7047 /* These variables hold the vector under construction within
7048 menu_bar_items and its subroutines, and the current index
7049 for storing into that vector. */
7050 static Lisp_Object menu_bar_items_vector
;
7051 static int menu_bar_items_index
;
7053 /* Return a vector of menu items for a menu bar, appropriate
7054 to the current buffer. Each item has three elements in the vector:
7057 OLD is an old vector we can optionally reuse, or nil. */
7060 menu_bar_items (old
)
7063 /* The number of keymaps we're scanning right now, and the number of
7064 keymaps we have allocated space for. */
7067 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7068 in the current keymaps, or nil where it is not a prefix. */
7071 Lisp_Object def
, tail
;
7080 /* In order to build the menus, we need to call the keymap
7081 accessors. They all call QUIT. But this function is called
7082 during redisplay, during which a quit is fatal. So inhibit
7083 quitting while building the menus.
7084 We do this instead of specbind because (1) errors will clear it anyway
7085 and (2) this avoids risk of specpdl overflow. */
7086 oquit
= Vinhibit_quit
;
7090 menu_bar_items_vector
= old
;
7092 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7093 menu_bar_items_index
= 0;
7095 /* Build our list of keymaps.
7096 If we recognize a function key and replace its escape sequence in
7097 keybuf with its symbol, or if the sequence starts with a mouse
7098 click and we need to switch buffers, we jump back here to rebuild
7099 the initial keymaps from the current buffer. */
7103 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7104 if (!NILP (Voverriding_local_map_menu_flag
))
7106 /* Yes, use them (if non-nil) as well as the global map. */
7107 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7109 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7110 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7111 if (!NILP (Voverriding_local_map
))
7112 maps
[nmaps
++] = Voverriding_local_map
;
7116 /* No, so use major and minor mode keymaps and keymap property.
7117 Note that menu-bar bindings in the local-map and keymap
7118 properties may not work reliable, as they are only
7119 recognized when the menu-bar (or mode-line) is updated,
7120 which does not normally happen after every command. */
7123 nminor
= current_minor_maps (NULL
, &tmaps
);
7124 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7126 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7127 maps
[nmaps
++] = tem
;
7128 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7130 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7132 maps
[nmaps
++] = current_global_map
;
7135 /* Look up in each map the dummy prefix key `menu-bar'. */
7139 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7140 if (!NILP (maps
[mapno
]))
7142 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7146 menu_bar_one_keymap_changed_items
= Qnil
;
7147 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7151 /* Move to the end those items that should be at the end. */
7153 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7156 int end
= menu_bar_items_index
;
7158 for (i
= 0; i
< end
; i
+= 4)
7159 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7161 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7162 /* Move the item at index I to the end,
7163 shifting all the others forward. */
7164 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7165 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7166 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7167 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7169 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7170 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7171 (end
- i
- 4) * sizeof (Lisp_Object
));
7172 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7173 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7174 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7175 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7180 /* Add nil, nil, nil, nil at the end. */
7181 i
= menu_bar_items_index
;
7182 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7185 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7186 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7187 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7188 menu_bar_items_vector
= tem
;
7190 /* Add this item. */
7191 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7192 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7193 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7194 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7195 menu_bar_items_index
= i
;
7197 Vinhibit_quit
= oquit
;
7198 return menu_bar_items_vector
;
7201 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7202 If there's already an item for KEY, add this DEF to it. */
7204 Lisp_Object item_properties
;
7207 menu_bar_item (key
, item
, dummy1
, dummy2
)
7208 Lisp_Object key
, item
, dummy1
;
7211 struct gcpro gcpro1
;
7215 if (EQ (item
, Qundefined
))
7217 /* If a map has an explicit `undefined' as definition,
7218 discard any previously made menu bar item. */
7220 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7221 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7223 if (menu_bar_items_index
> i
+ 4)
7224 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7225 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7226 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7227 menu_bar_items_index
-= 4;
7231 /* If this keymap has already contributed to this KEY,
7232 don't contribute to it a second time. */
7233 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7234 if (!NILP (tem
) || NILP (item
))
7237 menu_bar_one_keymap_changed_items
7238 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7240 /* We add to menu_bar_one_keymap_changed_items before doing the
7241 parse_menu_item, so that if it turns out it wasn't a menu item,
7242 it still correctly hides any further menu item. */
7244 i
= parse_menu_item (item
, 0, 1);
7249 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7251 /* Find any existing item for this KEY. */
7252 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7253 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7256 /* If we did not find this KEY, add it at the end. */
7257 if (i
== menu_bar_items_index
)
7259 /* If vector is too small, get a bigger one. */
7260 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7263 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7264 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7265 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7266 menu_bar_items_vector
= tem
;
7269 /* Add this item. */
7270 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7271 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7272 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7273 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7274 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7275 menu_bar_items_index
= i
;
7277 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7281 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7282 /* If the new and the old items are not both keymaps,
7283 the lookup will only find `item'. */
7284 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7285 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7289 /* This is used as the handler when calling menu_item_eval_property. */
7291 menu_item_eval_property_1 (arg
)
7294 /* If we got a quit from within the menu computation,
7295 quit all the way out of it. This takes care of C-] in the debugger. */
7296 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7297 Fsignal (Qquit
, Qnil
);
7302 /* Evaluate an expression and return the result (or nil if something
7303 went wrong). Used to evaluate dynamic parts of menu items. */
7305 menu_item_eval_property (sexpr
)
7308 int count
= SPECPDL_INDEX ();
7310 specbind (Qinhibit_redisplay
, Qt
);
7311 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7312 menu_item_eval_property_1
);
7313 return unbind_to (count
, val
);
7316 /* This function parses a menu item and leaves the result in the
7317 vector item_properties.
7318 ITEM is a key binding, a possible menu item.
7319 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7320 evaluate dynamic expressions in the menu item.
7321 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7323 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7324 parse_menu_item returns true if the item is a menu item and false
7328 parse_menu_item (item
, notreal
, inmenubar
)
7330 int notreal
, inmenubar
;
7332 Lisp_Object def
, tem
, item_string
, start
;
7333 Lisp_Object cachelist
;
7335 Lisp_Object keyhint
;
7346 /* Create item_properties vector if necessary. */
7347 if (NILP (item_properties
))
7349 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7351 /* Initialize optional entries. */
7352 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7353 AREF (item_properties
, i
) = Qnil
;
7354 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7356 /* Save the item here to protect it from GC. */
7357 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7359 item_string
= XCAR (item
);
7363 if (STRINGP (item_string
))
7365 /* Old format menu item. */
7366 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7368 /* Maybe help string. */
7369 if (CONSP (item
) && STRINGP (XCAR (item
)))
7371 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7376 /* Maybe key binding cache. */
7377 if (CONSP (item
) && CONSP (XCAR (item
))
7378 && (NILP (XCAR (XCAR (item
)))
7379 || VECTORP (XCAR (XCAR (item
)))))
7381 cachelist
= XCAR (item
);
7385 /* This is the real definition--the function to run. */
7386 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7388 /* Get enable property, if any. */
7391 tem
= Fget (item
, Qmenu_enable
);
7393 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7396 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7398 /* New format menu item. */
7399 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7400 start
= XCDR (item
);
7403 /* We have a real binding. */
7404 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7406 item
= XCDR (start
);
7407 /* Is there a cache list with key equivalences. */
7408 if (CONSP (item
) && CONSP (XCAR (item
)))
7410 cachelist
= XCAR (item
);
7414 /* Parse properties. */
7415 while (CONSP (item
) && CONSP (XCDR (item
)))
7420 if (EQ (tem
, QCenable
))
7421 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7422 else if (EQ (tem
, QCvisible
) && !notreal
)
7424 /* If got a visible property and that evaluates to nil
7425 then ignore this item. */
7426 tem
= menu_item_eval_property (XCAR (item
));
7430 else if (EQ (tem
, QChelp
))
7431 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7432 else if (EQ (tem
, QCfilter
))
7434 else if (EQ (tem
, QCkey_sequence
))
7437 if (NILP (cachelist
)
7438 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7439 /* Be GC protected. Set keyhint to item instead of tem. */
7442 else if (EQ (tem
, QCkeys
))
7445 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7446 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7448 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7453 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7455 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7457 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7464 else if (inmenubar
|| !NILP (start
))
7468 return 0; /* not a menu item */
7470 /* If item string is not a string, evaluate it to get string.
7471 If we don't get a string, skip this item. */
7472 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7473 if (!(STRINGP (item_string
) || notreal
))
7475 item_string
= menu_item_eval_property (item_string
);
7476 if (!STRINGP (item_string
))
7478 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7481 /* If got a filter apply it on definition. */
7482 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7485 def
= menu_item_eval_property (list2 (XCAR (filter
),
7486 list2 (Qquote
, def
)));
7488 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7491 /* Enable or disable selection of item. */
7492 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7498 tem
= menu_item_eval_property (tem
);
7499 if (inmenubar
&& NILP (tem
))
7500 return 0; /* Ignore disabled items in menu bar. */
7501 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7504 /* If we got no definition, this item is just unselectable text which
7505 is OK in a submenu but not in the menubar. */
7507 return (inmenubar
? 0 : 1);
7509 /* See if this is a separate pane or a submenu. */
7510 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7511 tem
= get_keymap (def
, 0, 1);
7512 /* For a subkeymap, just record its details and exit. */
7515 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7516 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7520 /* At the top level in the menu bar, do likewise for commands also.
7521 The menu bar does not display equivalent key bindings anyway.
7522 ITEM_PROPERTY_DEF is already set up properly. */
7526 /* This is a command. See if there is an equivalent key binding. */
7527 if (NILP (cachelist
))
7529 /* We have to create a cachelist. */
7530 CHECK_IMPURE (start
);
7531 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7532 cachelist
= XCAR (XCDR (start
));
7534 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7535 if (!NILP (keyhint
))
7537 XSETCAR (cachelist
, XCAR (keyhint
));
7540 else if (STRINGP (tem
))
7542 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7543 XSETCAR (cachelist
, Qt
);
7547 tem
= XCAR (cachelist
);
7554 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7556 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7559 def
= XCAR (prefix
);
7560 prefix
= XCDR (prefix
);
7563 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7565 if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7567 if (newcache
/* Always check first time. */
7568 /* Should we check everything when precomputing key
7570 /* If something had no key binding before, don't recheck it
7571 because that is too slow--except if we have a list of
7572 rebound commands in Vdefine_key_rebound_commands, do
7573 recheck any command that appears in that list. */
7574 || (CONSP (Vdefine_key_rebound_commands
)
7575 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7578 /* We had a saved key. Is it still bound to the command? */
7581 /* If the command is an alias for another
7582 (such as lmenu.el set it up), check if the
7583 original command matches the cached command. */
7584 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7585 chkcache
= 1; /* Need to recompute key binding. */
7589 /* Recompute equivalent key binding. If the command is an alias
7590 for another (such as lmenu.el set it up), see if the original
7591 command name has equivalent keys. Otherwise look up the
7592 specified command itself. We don't try both, because that
7593 makes lmenu menus slow. */
7595 && SYMBOLP (XSYMBOL (def
)->function
)
7596 && ! NILP (Fget (def
, Qmenu_alias
)))
7597 def
= XSYMBOL (def
)->function
;
7598 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7599 XSETCAR (cachelist
, tem
);
7602 XSETCDR (cachelist
, Qnil
);
7606 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7608 tem
= XCAR (cachelist
);
7612 newcache
= chkcache
;
7615 tem
= Fkey_description (tem
, Qnil
);
7618 if (STRINGP (XCAR (prefix
)))
7619 tem
= concat2 (XCAR (prefix
), tem
);
7620 if (STRINGP (XCDR (prefix
)))
7621 tem
= concat2 (tem
, XCDR (prefix
));
7623 XSETCDR (cachelist
, tem
);
7627 tem
= XCDR (cachelist
);
7628 if (newcache
&& !NILP (tem
))
7630 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7631 XSETCDR (cachelist
, tem
);
7634 /* If we only want to precompute equivalent key bindings, stop here. */
7638 /* If we have an equivalent key binding, use that. */
7639 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7641 /* Include this when menu help is implemented.
7642 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7643 if (!(NILP (tem) || STRINGP (tem)))
7645 tem = menu_item_eval_property (tem);
7648 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7652 /* Handle radio buttons or toggle boxes. */
7653 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7655 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7656 = menu_item_eval_property (tem
);
7663 /***********************************************************************
7665 ***********************************************************************/
7667 /* A vector holding tool bar items while they are parsed in function
7668 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7671 static Lisp_Object tool_bar_items_vector
;
7673 /* A vector holding the result of parse_tool_bar_item. Layout is like
7674 the one for a single item in tool_bar_items_vector. */
7676 static Lisp_Object tool_bar_item_properties
;
7678 /* Next free index in tool_bar_items_vector. */
7680 static int ntool_bar_items
;
7682 /* The symbols `tool-bar', and `:image'. */
7684 extern Lisp_Object Qtool_bar
;
7685 Lisp_Object QCimage
;
7687 /* Function prototypes. */
7689 static void init_tool_bar_items
P_ ((Lisp_Object
));
7690 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7691 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7692 static void append_tool_bar_item
P_ ((void));
7695 /* Return a vector of tool bar items for keymaps currently in effect.
7696 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7697 tool bar items found. */
7700 tool_bar_items (reuse
, nitems
)
7711 /* In order to build the menus, we need to call the keymap
7712 accessors. They all call QUIT. But this function is called
7713 during redisplay, during which a quit is fatal. So inhibit
7714 quitting while building the menus. We do this instead of
7715 specbind because (1) errors will clear it anyway and (2) this
7716 avoids risk of specpdl overflow. */
7717 oquit
= Vinhibit_quit
;
7720 /* Initialize tool_bar_items_vector and protect it from GC. */
7721 init_tool_bar_items (reuse
);
7723 /* Build list of keymaps in maps. Set nmaps to the number of maps
7726 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7727 if (!NILP (Voverriding_local_map_menu_flag
))
7729 /* Yes, use them (if non-nil) as well as the global map. */
7730 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7732 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7733 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7734 if (!NILP (Voverriding_local_map
))
7735 maps
[nmaps
++] = Voverriding_local_map
;
7739 /* No, so use major and minor mode keymaps and keymap property.
7740 Note that tool-bar bindings in the local-map and keymap
7741 properties may not work reliable, as they are only
7742 recognized when the tool-bar (or mode-line) is updated,
7743 which does not normally happen after every command. */
7746 nminor
= current_minor_maps (NULL
, &tmaps
);
7747 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7749 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7750 maps
[nmaps
++] = tem
;
7751 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7753 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7756 /* Add global keymap at the end. */
7757 maps
[nmaps
++] = current_global_map
;
7759 /* Process maps in reverse order and look up in each map the prefix
7761 for (i
= nmaps
- 1; i
>= 0; --i
)
7762 if (!NILP (maps
[i
]))
7766 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7771 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7772 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7774 Lisp_Object keydef
= XCAR (tail
);
7776 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7781 Vinhibit_quit
= oquit
;
7782 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7783 return tool_bar_items_vector
;
7787 /* Process the definition of KEY which is DEF. */
7790 process_tool_bar_item (key
, def
)
7791 Lisp_Object key
, def
;
7794 extern Lisp_Object Qundefined
;
7795 struct gcpro gcpro1
, gcpro2
;
7797 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7801 if (EQ (def
, Qundefined
))
7803 /* If a map has an explicit `undefined' as definition,
7804 discard any previously made item. */
7805 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7807 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7809 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7811 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7812 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7813 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7814 * sizeof (Lisp_Object
)));
7815 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7820 else if (parse_tool_bar_item (key
, def
))
7821 /* Append a new tool bar item to tool_bar_items_vector. Accept
7822 more than one definition for the same key. */
7823 append_tool_bar_item ();
7829 /* Parse a tool bar item specification ITEM for key KEY and return the
7830 result in tool_bar_item_properties. Value is zero if ITEM is
7833 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7835 CAPTION is the caption of the item, If it's not a string, it is
7836 evaluated to get a string.
7838 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7839 as binding are currently ignored.
7841 The following properties are recognized:
7845 FORM is evaluated and specifies whether the tool bar item is
7846 enabled or disabled.
7850 FORM is evaluated and specifies whether the tool bar item is visible.
7852 - `:filter FUNCTION'
7854 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7855 result is stored as the new binding.
7857 - `:button (TYPE SELECTED)'
7859 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7860 and specifies whether the button is selected (pressed) or not.
7864 IMAGES is either a single image specification or a vector of four
7865 image specifications. See enum tool_bar_item_images.
7867 - `:help HELP-STRING'.
7869 Gives a help string to display for the tool bar item. */
7872 parse_tool_bar_item (key
, item
)
7873 Lisp_Object key
, item
;
7875 /* Access slot with index IDX of vector tool_bar_item_properties. */
7876 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7878 Lisp_Object filter
= Qnil
;
7879 Lisp_Object caption
;
7882 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7883 Rule out items that aren't lists, don't start with
7884 `menu-item' or whose rest following `tool-bar-item' is not a
7887 || !EQ (XCAR (item
), Qmenu_item
)
7888 || (item
= XCDR (item
),
7892 /* Create tool_bar_item_properties vector if necessary. Reset it to
7894 if (VECTORP (tool_bar_item_properties
))
7896 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7900 tool_bar_item_properties
7901 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7904 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7905 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7907 /* Get the caption of the item. If the caption is not a string,
7908 evaluate it to get a string. If we don't get a string, skip this
7910 caption
= XCAR (item
);
7911 if (!STRINGP (caption
))
7913 caption
= menu_item_eval_property (caption
);
7914 if (!STRINGP (caption
))
7917 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7919 /* Give up if rest following the caption is not a list. */
7924 /* Store the binding. */
7925 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7928 /* Ignore cached key binding, if any. */
7929 if (CONSP (item
) && CONSP (XCAR (item
)))
7932 /* Process the rest of the properties. */
7933 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7935 Lisp_Object key
, value
;
7938 value
= XCAR (XCDR (item
));
7940 if (EQ (key
, QCenable
))
7941 /* `:enable FORM'. */
7942 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7943 else if (EQ (key
, QCvisible
))
7945 /* `:visible FORM'. If got a visible property and that
7946 evaluates to nil then ignore this item. */
7947 if (NILP (menu_item_eval_property (value
)))
7950 else if (EQ (key
, QChelp
))
7951 /* `:help HELP-STRING'. */
7952 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7953 else if (EQ (key
, QCfilter
))
7954 /* ':filter FORM'. */
7956 else if (EQ (key
, QCbutton
) && CONSP (value
))
7958 /* `:button (TYPE . SELECTED)'. */
7959 Lisp_Object type
, selected
;
7961 type
= XCAR (value
);
7962 selected
= XCDR (value
);
7963 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7965 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7966 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7969 else if (EQ (key
, QCimage
)
7971 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7972 /* Value is either a single image specification or a vector
7973 of 4 such specifications for the different button states. */
7974 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7977 /* If got a filter apply it on binding. */
7979 PROP (TOOL_BAR_ITEM_BINDING
)
7980 = menu_item_eval_property (list2 (filter
,
7982 PROP (TOOL_BAR_ITEM_BINDING
))));
7984 /* See if the binding is a keymap. Give up if it is. */
7985 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7988 /* Enable or disable selection of item. */
7989 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7990 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7991 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7993 /* Handle radio buttons or toggle boxes. */
7994 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7995 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7996 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
8004 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8005 that can be reused. */
8008 init_tool_bar_items (reuse
)
8011 if (VECTORP (reuse
))
8012 tool_bar_items_vector
= reuse
;
8014 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8015 ntool_bar_items
= 0;
8019 /* Append parsed tool bar item properties from
8020 tool_bar_item_properties */
8023 append_tool_bar_item ()
8025 Lisp_Object
*to
, *from
;
8027 /* Enlarge tool_bar_items_vector if necessary. */
8028 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
8029 >= XVECTOR (tool_bar_items_vector
)->size
)
8031 Lisp_Object new_vector
;
8032 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
8034 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
8035 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
8036 XVECTOR (new_vector
)->contents
,
8037 old_size
* sizeof (Lisp_Object
));
8038 tool_bar_items_vector
= new_vector
;
8041 /* Append entries from tool_bar_item_properties to the end of
8042 tool_bar_items_vector. */
8043 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
8044 from
= XVECTOR (tool_bar_item_properties
)->contents
;
8045 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
8046 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8053 /* Read a character using menus based on maps in the array MAPS.
8054 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8055 Return t if we displayed a menu but the user rejected it.
8057 PREV_EVENT is the previous input event, or nil if we are reading
8058 the first event of a key sequence.
8060 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8061 if we used a mouse menu to read the input, or zero otherwise. If
8062 USED_MOUSE_MENU is null, we don't dereference it.
8064 The prompting is done based on the prompt-string of the map
8065 and the strings associated with various map elements.
8067 This can be done with X menus or with menus put in the minibuf.
8068 These are done in different ways, depending on how the input will be read.
8069 Menus using X are done after auto-saving in read-char, getting the input
8070 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8071 and do auto-saving in the inner call of read_char. */
8074 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8077 Lisp_Object prev_event
;
8078 int *used_mouse_menu
;
8081 register Lisp_Object name
= Qnil
;
8083 if (used_mouse_menu
)
8084 *used_mouse_menu
= 0;
8086 /* Use local over global Menu maps */
8088 if (! menu_prompting
)
8091 /* Optionally disregard all but the global map. */
8092 if (inhibit_local_menu_bar_menus
)
8094 maps
+= (nmaps
- 1);
8098 /* Get the menu name from the first map that has one (a prompt string). */
8099 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8101 name
= Fkeymap_prompt (maps
[mapno
]);
8106 /* If we don't have any menus, just read a character normally. */
8107 if (!STRINGP (name
))
8111 /* If we got to this point via a mouse click,
8112 use a real menu for mouse selection. */
8113 if (EVENT_HAS_PARAMETERS (prev_event
)
8114 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8115 && !EQ (XCAR (prev_event
), Qtool_bar
))
8117 /* Display the menu and get the selection. */
8118 Lisp_Object
*realmaps
8119 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8123 /* Use the maps that are not nil. */
8124 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8125 if (!NILP (maps
[mapno
]))
8126 realmaps
[nmaps1
++] = maps
[mapno
];
8128 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8133 record_menu_key (XCAR (value
));
8135 /* If we got multiple events, unread all but
8137 There is no way to prevent those unread events
8138 from showing up later in last_nonmenu_event.
8139 So turn symbol and integer events into lists,
8140 to indicate that they came from a mouse menu,
8141 so that when present in last_nonmenu_event
8142 they won't confuse things. */
8143 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8145 record_menu_key (XCAR (tem
));
8146 if (SYMBOLP (XCAR (tem
))
8147 || INTEGERP (XCAR (tem
)))
8148 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8151 /* If we got more than one event, put all but the first
8152 onto this list to be read later.
8153 Return just the first event now. */
8154 Vunread_command_events
8155 = nconc2 (XCDR (value
), Vunread_command_events
);
8156 value
= XCAR (value
);
8158 else if (NILP (value
))
8160 if (used_mouse_menu
)
8161 *used_mouse_menu
= 1;
8164 #endif /* HAVE_MENUS */
8168 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8169 We make this bigger when necessary, and never free it. */
8170 static char *read_char_minibuf_menu_text
;
8171 /* Size of that buffer. */
8172 static int read_char_minibuf_menu_width
;
8175 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8181 register Lisp_Object name
;
8183 /* FIXME: Use the minibuffer's frame width. */
8184 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8187 Lisp_Object rest
, vector
;
8193 if (! menu_prompting
)
8196 /* Make sure we have a big enough buffer for the menu text. */
8197 if (read_char_minibuf_menu_text
== 0)
8199 read_char_minibuf_menu_width
= width
+ 4;
8200 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8202 else if (width
+ 4 > read_char_minibuf_menu_width
)
8204 read_char_minibuf_menu_width
= width
+ 4;
8205 read_char_minibuf_menu_text
8206 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8208 menu
= read_char_minibuf_menu_text
;
8210 /* Get the menu name from the first map that has one (a prompt string). */
8211 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8213 name
= Fkeymap_prompt (maps
[mapno
]);
8218 /* If we don't have any menus, just read a character normally. */
8219 if (!STRINGP (name
))
8222 /* Prompt string always starts with map's prompt, and a space. */
8223 strcpy (menu
, SDATA (name
));
8224 nlength
= SBYTES (name
);
8225 menu
[nlength
++] = ':';
8226 menu
[nlength
++] = ' ';
8229 /* Start prompting at start of first map. */
8233 /* Present the documented bindings, a line at a time. */
8240 Lisp_Object orig_defn_macro
;
8242 /* Loop over elements of map. */
8247 /* If reached end of map, start at beginning of next map. */
8251 /* At end of last map, wrap around to first map if just starting,
8252 or end this line if already have something on it. */
8256 if (notfirst
|| nobindings
) break;
8261 /* Look at the next element of the map. */
8263 elt
= XVECTOR (vector
)->contents
[idx
];
8265 elt
= Fcar_safe (rest
);
8267 if (idx
< 0 && VECTORP (elt
))
8269 /* If we found a dense table in the keymap,
8270 advanced past it, but start scanning its contents. */
8271 rest
= Fcdr_safe (rest
);
8277 /* An ordinary element. */
8278 Lisp_Object event
, tem
;
8282 event
= Fcar_safe (elt
); /* alist */
8283 elt
= Fcdr_safe (elt
);
8287 XSETINT (event
, idx
); /* vector */
8290 /* Ignore the element if it has no prompt string. */
8291 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8293 /* 1 if the char to type matches the string. */
8295 Lisp_Object upcased_event
, downcased_event
;
8296 Lisp_Object desc
= Qnil
;
8298 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8300 upcased_event
= Fupcase (event
);
8301 downcased_event
= Fdowncase (event
);
8302 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8303 || XINT (downcased_event
) == SREF (s
, 0));
8305 desc
= Fsingle_key_description (event
, Qnil
);
8307 #if 0 /* It is redundant to list the equivalent key bindings because
8308 the prefix is what the user has already typed. */
8310 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8312 /* Insert equivalent keybinding. */
8313 s
= concat2 (s
, tem
);
8316 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8317 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8319 /* Insert button prefix. */
8320 Lisp_Object selected
8321 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8322 if (EQ (tem
, QCradio
))
8323 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8325 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8326 s
= concat2 (tem
, s
);
8330 /* If we have room for the prompt string, add it to this line.
8331 If this is the first on the line, always add it. */
8332 if ((SCHARS (s
) + i
+ 2
8333 + (char_matches
? 0 : SCHARS (desc
) + 3))
8339 /* Punctuate between strings. */
8342 strcpy (menu
+ i
, ", ");
8348 /* If the char to type doesn't match the string's
8349 first char, explicitly show what char to type. */
8352 /* Add as much of string as fits. */
8353 thiswidth
= SCHARS (desc
);
8354 if (thiswidth
+ i
> width
)
8355 thiswidth
= width
- i
;
8356 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8358 strcpy (menu
+ i
, " = ");
8362 /* Add as much of string as fits. */
8363 thiswidth
= SCHARS (s
);
8364 if (thiswidth
+ i
> width
)
8365 thiswidth
= width
- i
;
8366 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8372 /* If this element does not fit, end the line now,
8373 and save the element for the next line. */
8374 strcpy (menu
+ i
, "...");
8379 /* Move past this element. */
8380 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8381 /* Handle reaching end of dense table. */
8386 rest
= Fcdr_safe (rest
);
8390 /* Prompt with that and read response. */
8391 message2_nolog (menu
, strlen (menu
),
8392 ! NILP (current_buffer
->enable_multibyte_characters
));
8394 /* Make believe its not a keyboard macro in case the help char
8395 is pressed. Help characters are not recorded because menu prompting
8396 is not used on replay.
8398 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8399 current_kboard
->defining_kbd_macro
= Qnil
;
8401 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8402 while (BUFFERP (obj
));
8403 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8405 if (!INTEGERP (obj
))
8410 if (! EQ (obj
, menu_prompt_more_char
)
8411 && (!INTEGERP (menu_prompt_more_char
)
8412 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8414 if (!NILP (current_kboard
->defining_kbd_macro
))
8415 store_kbd_macro_char (obj
);
8418 /* Help char - go round again */
8422 /* Reading key sequences. */
8424 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8425 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8426 keymap, or nil otherwise. Return the index of the first keymap in
8427 which KEY has any binding, or NMAPS if no map has a binding.
8429 If KEY is a meta ASCII character, treat it like meta-prefix-char
8430 followed by the corresponding non-meta character. Keymaps in
8431 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8434 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8437 NEXT may be the same array as CURRENT. */
8440 follow_key (key
, nmaps
, current
, defs
, next
)
8442 Lisp_Object
*current
, *defs
, *next
;
8445 int i
, first_binding
;
8447 first_binding
= nmaps
;
8448 for (i
= nmaps
- 1; i
>= 0; i
--)
8450 if (! NILP (current
[i
]))
8452 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8453 if (! NILP (defs
[i
]))
8460 /* Given the set of bindings we've found, produce the next set of maps. */
8461 if (first_binding
< nmaps
)
8462 for (i
= 0; i
< nmaps
; i
++)
8463 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8465 return first_binding
;
8468 /* Structure used to keep track of partial application of key remapping
8469 such as Vfunction_key_map and Vkey_translation_map. */
8470 typedef struct keyremap
8472 Lisp_Object map
, parent
;
8476 /* Lookup KEY in MAP.
8477 MAP is a keymap mapping keys to key vectors or functions.
8478 If the mapping is a function and DO_FUNCTION is non-zero, then
8479 the function is called with PROMPT as parameter and its return
8480 value is used as the return value of this function (after checking
8481 that it is indeed a vector). */
8484 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8485 Lisp_Object map
, key
, prompt
;
8490 next
= access_keymap (map
, key
, 1, 0, 1);
8492 /* Handle symbol with autoload definition. */
8493 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8494 && CONSP (XSYMBOL (next
)->function
)
8495 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8496 do_autoload (XSYMBOL (next
)->function
, next
);
8498 /* Handle a symbol whose function definition is a keymap
8500 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8501 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8502 || KEYMAPP (XSYMBOL (next
)->function
)))
8503 next
= XSYMBOL (next
)->function
;
8505 /* If the keymap gives a function, not an
8506 array, then call the function with one arg and use
8507 its value instead. */
8508 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8513 next
= call1 (next
, prompt
);
8514 /* If the function returned something invalid,
8515 barf--don't ignore it.
8516 (To ignore it safely, we would need to gcpro a bunch of
8517 other variables.) */
8518 if (! (VECTORP (next
) || STRINGP (next
)))
8519 error ("Function %s returns invalid key sequence", tem
);
8524 /* Do one step of the key remapping used for function-key-map and
8525 key-translation-map:
8526 KEYBUF is the buffer holding the input events.
8527 BUFSIZE is its maximum size.
8528 FKEY is a pointer to the keyremap structure to use.
8529 INPUT is the index of the last element in KEYBUF.
8530 DOIT if non-zero says that the remapping can actually take place.
8531 DIFF is used to return the number of keys added/removed by the remapping.
8532 PARENT is the root of the keymap.
8533 PROMPT is the prompt to use if the remapping happens through a function.
8534 The return value is non-zero if the remapping actually took place. */
8537 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8538 Lisp_Object
*keybuf
, prompt
;
8540 int input
, doit
, *diff
, bufsize
;
8542 Lisp_Object next
, key
;
8544 key
= keybuf
[fkey
->end
++];
8545 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8547 /* If keybuf[fkey->start..fkey->end] is bound in the
8548 map and we're in a position to do the key remapping, replace it with
8549 the binding and restart with fkey->start at the end. */
8550 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8552 int len
= XFASTINT (Flength (next
));
8555 *diff
= len
- (fkey
->end
- fkey
->start
);
8557 if (input
+ *diff
>= bufsize
)
8558 error ("Key sequence too long");
8560 /* Shift the keys that follow fkey->end. */
8562 for (i
= fkey
->end
; i
< input
; i
++)
8563 keybuf
[i
+ *diff
] = keybuf
[i
];
8565 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8566 keybuf
[i
+ *diff
] = keybuf
[i
];
8567 /* Overwrite the old keys with the new ones. */
8568 for (i
= 0; i
< len
; i
++)
8569 keybuf
[fkey
->start
+ i
]
8570 = Faref (next
, make_number (i
));
8572 fkey
->start
= fkey
->end
+= *diff
;
8573 fkey
->map
= fkey
->parent
;
8578 fkey
->map
= get_keymap (next
, 0, 1);
8580 /* If we no longer have a bound suffix, try a new position for
8582 if (!CONSP (fkey
->map
))
8584 fkey
->end
= ++fkey
->start
;
8585 fkey
->map
= fkey
->parent
;
8590 /* Read a sequence of keys that ends with a non prefix character,
8591 storing it in KEYBUF, a buffer of size BUFSIZE.
8593 Return the length of the key sequence stored.
8594 Return -1 if the user rejected a command menu.
8596 Echo starting immediately unless `prompt' is 0.
8598 Where a key sequence ends depends on the currently active keymaps.
8599 These include any minor mode keymaps active in the current buffer,
8600 the current buffer's local map, and the global map.
8602 If a key sequence has no other bindings, we check Vfunction_key_map
8603 to see if some trailing subsequence might be the beginning of a
8604 function key's sequence. If so, we try to read the whole function
8605 key, and substitute its symbolic name into the key sequence.
8607 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8608 `double-' events into similar click events, if that would make them
8609 bound. We try to turn `triple-' events first into `double-' events,
8612 If we get a mouse click in a mode line, vertical divider, or other
8613 non-text area, we treat the click as if it were prefixed by the
8614 symbol denoting that area - `mode-line', `vertical-line', or
8617 If the sequence starts with a mouse click, we read the key sequence
8618 with respect to the buffer clicked on, not the current buffer.
8620 If the user switches frames in the midst of a key sequence, we put
8621 off the switch-frame event until later; the next call to
8622 read_char will return it.
8624 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8625 from the selected window's buffer. */
8628 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8629 can_return_switch_frame
, fix_current_buffer
)
8630 Lisp_Object
*keybuf
;
8633 int dont_downcase_last
;
8634 int can_return_switch_frame
;
8635 int fix_current_buffer
;
8637 volatile Lisp_Object from_string
;
8638 volatile int count
= SPECPDL_INDEX ();
8640 /* How many keys there are in the current key sequence. */
8643 /* The length of the echo buffer when we started reading, and
8644 the length of this_command_keys when we started reading. */
8645 volatile int echo_start
;
8646 volatile int keys_start
;
8648 /* The number of keymaps we're scanning right now, and the number of
8649 keymaps we have allocated space for. */
8651 volatile int nmaps_allocated
= 0;
8653 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8654 the current keymaps. */
8655 Lisp_Object
*volatile defs
= NULL
;
8657 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8658 in the current keymaps, or nil where it is not a prefix. */
8659 Lisp_Object
*volatile submaps
= NULL
;
8661 /* The local map to start out with at start of key sequence. */
8662 volatile Lisp_Object orig_local_map
;
8664 /* The map from the `keymap' property to start out with at start of
8666 volatile Lisp_Object orig_keymap
;
8668 /* 1 if we have already considered switching to the local-map property
8669 of the place where a mouse click occurred. */
8670 volatile int localized_local_map
= 0;
8672 /* The index in defs[] of the first keymap that has a binding for
8673 this key sequence. In other words, the lowest i such that
8674 defs[i] is non-nil. */
8675 volatile int first_binding
;
8676 /* Index of the first key that has no binding.
8677 It is useless to try fkey.start larger than that. */
8678 volatile int first_unbound
;
8680 /* If t < mock_input, then KEYBUF[t] should be read as the next
8683 We use this to recover after recognizing a function key. Once we
8684 realize that a suffix of the current key sequence is actually a
8685 function key's escape sequence, we replace the suffix with the
8686 function key's binding from Vfunction_key_map. Now keybuf
8687 contains a new and different key sequence, so the echo area,
8688 this_command_keys, and the submaps and defs arrays are wrong. In
8689 this situation, we set mock_input to t, set t to 0, and jump to
8690 restart_sequence; the loop will read keys from keybuf up until
8691 mock_input, thus rebuilding the state; and then it will resume
8692 reading characters from the keyboard. */
8693 volatile int mock_input
= 0;
8695 /* If the sequence is unbound in submaps[], then
8696 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8697 and fkey.map is its binding.
8699 These might be > t, indicating that all function key scanning
8700 should hold off until t reaches them. We do this when we've just
8701 recognized a function key, to avoid searching for the function
8702 key's again in Vfunction_key_map. */
8703 volatile keyremap fkey
;
8705 /* Likewise, for key_translation_map. */
8706 volatile keyremap keytran
;
8708 /* If we receive a `switch-frame' or `select-window' event in the middle of
8709 a key sequence, we put it off for later.
8710 While we're reading, we keep the event here. */
8711 volatile Lisp_Object delayed_switch_frame
;
8713 /* See the comment below... */
8714 #if defined (GOBBLE_FIRST_EVENT)
8715 Lisp_Object first_event
;
8718 volatile Lisp_Object original_uppercase
;
8719 volatile int original_uppercase_position
= -1;
8721 /* Gets around Microsoft compiler limitations. */
8724 struct buffer
*starting_buffer
;
8726 /* List of events for which a fake prefix key has been generated. */
8727 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8729 #if defined (GOBBLE_FIRST_EVENT)
8733 struct gcpro gcpro1
;
8735 GCPRO1 (fake_prefixed_keys
);
8736 raw_keybuf_count
= 0;
8738 last_nonmenu_event
= Qnil
;
8740 delayed_switch_frame
= Qnil
;
8745 echo_prompt (prompt
);
8746 else if (cursor_in_echo_area
8747 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8748 && NILP (Fzerop (Vecho_keystrokes
)))
8749 /* This doesn't put in a dash if the echo buffer is empty, so
8750 you don't always see a dash hanging out in the minibuffer. */
8754 /* Record the initial state of the echo area and this_command_keys;
8755 we will need to restore them if we replay a key sequence. */
8757 echo_start
= echo_length ();
8758 keys_start
= this_command_key_count
;
8759 this_single_command_key_start
= keys_start
;
8761 #if defined (GOBBLE_FIRST_EVENT)
8762 /* This doesn't quite work, because some of the things that read_char
8763 does cannot safely be bypassed. It seems too risky to try to make
8766 /* Read the first char of the sequence specially, before setting
8767 up any keymaps, in case a filter runs and switches buffers on us. */
8768 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8770 #endif /* GOBBLE_FIRST_EVENT */
8772 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8773 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8776 /* We jump here when the key sequence has been thoroughly changed, and
8777 we need to rescan it starting from the beginning. When we jump here,
8778 keybuf[0..mock_input] holds the sequence we should reread. */
8781 /* We may switch keyboards between rescans, so we need to
8782 reinitialize fkey and keytran before each replay. */
8783 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
8784 keytran
.map
= keytran
.parent
= current_kboard
->Vlocal_key_translation_map
;
8785 /* If there is no translation map, turn off scanning. */
8786 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8787 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8789 starting_buffer
= current_buffer
;
8790 first_unbound
= bufsize
+ 1;
8792 /* Build our list of keymaps.
8793 If we recognize a function key and replace its escape sequence in
8794 keybuf with its symbol, or if the sequence starts with a mouse
8795 click and we need to switch buffers, we jump back here to rebuild
8796 the initial keymaps from the current buffer. */
8799 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8800 || !NILP (Voverriding_local_map
))
8802 if (3 > nmaps_allocated
)
8804 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8805 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8806 nmaps_allocated
= 3;
8808 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8809 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8810 if (!NILP (Voverriding_local_map
))
8811 submaps
[nmaps
++] = Voverriding_local_map
;
8819 nminor
= current_minor_maps (0, &maps
);
8820 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8822 if (total
> nmaps_allocated
)
8824 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8825 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8826 nmaps_allocated
= total
;
8829 if (!NILP (orig_keymap
))
8830 submaps
[nmaps
++] = orig_keymap
;
8832 bcopy (maps
, (void *) (submaps
+ nmaps
),
8833 nminor
* sizeof (submaps
[0]));
8837 submaps
[nmaps
++] = orig_local_map
;
8839 submaps
[nmaps
++] = current_global_map
;
8841 /* Find an accurate initial value for first_binding. */
8842 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8843 if (! NILP (submaps
[first_binding
]))
8846 /* Start from the beginning in keybuf. */
8849 /* These are no-ops the first time through, but if we restart, they
8850 revert the echo area and this_command_keys to their original state. */
8851 this_command_key_count
= keys_start
;
8852 if (INTERACTIVE
&& t
< mock_input
)
8853 echo_truncate (echo_start
);
8855 /* If the best binding for the current key sequence is a keymap, or
8856 we may be looking at a function key's escape sequence, keep on
8858 while (first_binding
< nmaps
8859 /* Keep reading as long as there's a prefix binding. */
8860 ? !NILP (submaps
[first_binding
])
8861 /* Don't return in the middle of a possible function key sequence,
8862 if the only bindings we found were via case conversion.
8863 Thus, if ESC O a has a function-key-map translation
8864 and ESC o has a binding, don't return after ESC O,
8865 so that we can translate ESC O plus the next character. */
8866 : (fkey
.start
< t
|| keytran
.start
< t
))
8869 int used_mouse_menu
= 0;
8871 /* Where the last real key started. If we need to throw away a
8872 key that has expanded into more than one element of keybuf
8873 (say, a mouse click on the mode line which is being treated
8874 as [mode-line (mouse-...)], then we backtrack to this point
8876 volatile int last_real_key_start
;
8878 /* These variables are analogous to echo_start and keys_start;
8879 while those allow us to restart the entire key sequence,
8880 echo_local_start and keys_local_start allow us to throw away
8882 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8884 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8885 eassert (fkey
.start
<= fkey
.end
);
8886 eassert (keytran
.start
<= keytran
.end
);
8887 /* key-translation-map is applied *after* function-key-map. */
8888 eassert (keytran
.end
<= fkey
.start
);
8890 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8891 { /* The prefix upto first_unbound has no binding and has
8892 no translation left to do either, so we know it's unbound.
8893 If we don't stop now, we risk staying here indefinitely
8894 (if the user keeps entering fkey or keytran prefixes
8895 like C-c ESC ESC ESC ESC ...) */
8897 for (i
= first_unbound
+ 1; i
< t
; i
++)
8898 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8899 mock_input
= t
- first_unbound
- 1;
8900 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8901 fkey
.map
= fkey
.parent
;
8902 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8903 keytran
.map
= keytran
.parent
;
8904 goto replay_sequence
;
8908 error ("Key sequence too long");
8911 echo_local_start
= echo_length ();
8912 keys_local_start
= this_command_key_count
;
8913 local_first_binding
= first_binding
;
8916 /* These are no-ops, unless we throw away a keystroke below and
8917 jumped back up to replay_key; in that case, these restore the
8918 variables to their original state, allowing us to replay the
8920 if (INTERACTIVE
&& t
< mock_input
)
8921 echo_truncate (echo_local_start
);
8922 this_command_key_count
= keys_local_start
;
8923 first_binding
= local_first_binding
;
8925 /* By default, assume each event is "real". */
8926 last_real_key_start
= t
;
8928 /* Does mock_input indicate that we are re-reading a key sequence? */
8932 add_command_key (key
);
8933 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8934 && NILP (Fzerop (Vecho_keystrokes
)))
8938 /* If not, we should actually read a character. */
8943 KBOARD
*interrupted_kboard
= current_kboard
;
8944 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8945 if (setjmp (wrong_kboard_jmpbuf
))
8947 if (!NILP (delayed_switch_frame
))
8949 interrupted_kboard
->kbd_queue
8950 = Fcons (delayed_switch_frame
,
8951 interrupted_kboard
->kbd_queue
);
8952 delayed_switch_frame
= Qnil
;
8955 interrupted_kboard
->kbd_queue
8956 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8958 /* If the side queue is non-empty, ensure it begins with a
8959 switch-frame, so we'll replay it in the right context. */
8960 if (CONSP (interrupted_kboard
->kbd_queue
)
8961 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8962 !(EVENT_HAS_PARAMETERS (key
)
8963 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8967 XSETFRAME (frame
, interrupted_frame
);
8968 interrupted_kboard
->kbd_queue
8969 = Fcons (make_lispy_switch_frame (frame
),
8970 interrupted_kboard
->kbd_queue
);
8973 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8974 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8975 goto replay_sequence
;
8978 key
= read_char (NILP (prompt
), nmaps
,
8979 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8983 /* read_char returns t when it shows a menu and the user rejects it.
8987 unbind_to (count
, Qnil
);
8992 /* read_char returns -1 at the end of a macro.
8993 Emacs 18 handles this by returning immediately with a
8994 zero, so that's what we'll do. */
8995 if (INTEGERP (key
) && XINT (key
) == -1)
8998 /* The Microsoft C compiler can't handle the goto that
9004 /* If the current buffer has been changed from under us, the
9005 keymap may have changed, so replay the sequence. */
9008 timer_resume_idle ();
9011 /* Reset the current buffer from the selected window
9012 in case something changed the former and not the latter.
9013 This is to be more consistent with the behavior
9014 of the command_loop_1. */
9015 if (fix_current_buffer
)
9017 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9019 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9020 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9023 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9024 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9025 goto replay_sequence
;
9028 /* If we have a quit that was typed in another frame, and
9029 quit_throw_to_read_char switched buffers,
9030 replay to get the right keymap. */
9032 && XINT (key
) == quit_char
9033 && current_buffer
!= starting_buffer
)
9036 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9040 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9041 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9042 goto replay_sequence
;
9047 if (EVENT_HAS_PARAMETERS (key
)
9048 /* Either a `switch-frame' or a `select-window' event. */
9049 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9051 /* If we're at the beginning of a key sequence, and the caller
9052 says it's okay, go ahead and return this event. If we're
9053 in the midst of a key sequence, delay it until the end. */
9054 if (t
> 0 || !can_return_switch_frame
)
9056 delayed_switch_frame
= key
;
9062 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9065 /* Clicks in non-text areas get prefixed by the symbol
9066 in their CHAR-ADDRESS field. For example, a click on
9067 the mode line is prefixed by the symbol `mode-line'.
9069 Furthermore, key sequences beginning with mouse clicks
9070 are read using the keymaps of the buffer clicked on, not
9071 the current buffer. So we may have to switch the buffer
9074 When we turn one event into two events, we must make sure
9075 that neither of the two looks like the original--so that,
9076 if we replay the events, they won't be expanded again.
9077 If not for this, such reexpansion could happen either here
9078 or when user programs play with this-command-keys. */
9079 if (EVENT_HAS_PARAMETERS (key
))
9084 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9085 if (EQ (kind
, Qmouse_click
))
9087 Lisp_Object window
, posn
;
9089 window
= POSN_WINDOW (EVENT_START (key
));
9090 posn
= POSN_POSN (EVENT_START (key
));
9093 || (!NILP (fake_prefixed_keys
)
9094 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9096 /* We're looking a second time at an event for which
9097 we generated a fake prefix key. Set
9098 last_real_key_start appropriately. */
9100 last_real_key_start
= t
- 1;
9103 /* Key sequences beginning with mouse clicks are
9104 read using the keymaps in the buffer clicked on,
9105 not the current buffer. If we're at the
9106 beginning of a key sequence, switch buffers. */
9107 if (last_real_key_start
== 0
9109 && BUFFERP (XWINDOW (window
)->buffer
)
9110 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9112 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9116 /* Arrange to go back to the original buffer once we're
9117 done reading the key sequence. Note that we can't
9118 use save_excursion_{save,restore} here, because they
9119 save point as well as the current buffer; we don't
9120 want to save point, because redisplay may change it,
9121 to accommodate a Fset_window_start or something. We
9122 don't want to do this at the top of the function,
9123 because we may get input from a subprocess which
9124 wants to change the selected window and stuff (say,
9126 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9128 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9130 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9131 orig_local_map
= get_local_map (PT
, current_buffer
,
9133 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9134 goto replay_sequence
;
9137 /* For a mouse click, get the local text-property keymap
9138 of the place clicked on, rather than point. */
9139 if (last_real_key_start
== 0
9140 && CONSP (XCDR (key
))
9141 && ! localized_local_map
)
9143 Lisp_Object map_here
, start
, pos
;
9145 localized_local_map
= 1;
9146 start
= EVENT_START (key
);
9148 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9150 pos
= POSN_BUFFER_POSN (start
);
9152 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9154 map_here
= get_local_map (XINT (pos
),
9155 current_buffer
, Qlocal_map
);
9156 if (!EQ (map_here
, orig_local_map
))
9158 orig_local_map
= map_here
;
9162 goto replay_sequence
;
9164 map_here
= get_local_map (XINT (pos
),
9165 current_buffer
, Qkeymap
);
9166 if (!EQ (map_here
, orig_keymap
))
9168 orig_keymap
= map_here
;
9172 goto replay_sequence
;
9178 /* Expand mode-line and scroll-bar events into two events:
9179 use posn as a fake prefix key. */
9181 && (NILP (fake_prefixed_keys
)
9182 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9184 if (t
+ 1 >= bufsize
)
9185 error ("Key sequence too long");
9188 keybuf
[t
+ 1] = key
;
9191 /* Record that a fake prefix key has been generated
9192 for KEY. Don't modify the event; this would
9193 prevent proper action when the event is pushed
9194 back into unread-command-events. */
9195 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9197 /* If on a mode line string with a local keymap,
9198 reconsider the key sequence with that keymap. */
9199 if (string
= POSN_STRING (EVENT_START (key
)),
9200 (CONSP (string
) && STRINGP (XCAR (string
))))
9202 Lisp_Object pos
, map
, map2
;
9204 pos
= XCDR (string
);
9205 string
= XCAR (string
);
9207 && XINT (pos
) < SCHARS (string
))
9209 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9211 orig_local_map
= map
;
9212 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9215 if (!NILP (map
) || !NILP (map2
))
9216 goto replay_sequence
;
9222 else if (NILP (from_string
)
9223 && (string
= POSN_STRING (EVENT_START (key
)),
9224 (CONSP (string
) && STRINGP (XCAR (string
)))))
9226 /* For a click on a string, i.e. overlay string or a
9227 string displayed via the `display' property,
9228 consider `local-map' and `keymap' properties of
9230 Lisp_Object pos
, map
, map2
;
9232 pos
= XCDR (string
);
9233 string
= XCAR (string
);
9235 && XINT (pos
) < SCHARS (string
))
9237 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9239 orig_local_map
= map
;
9240 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9244 if (!NILP (map
) || !NILP (map2
))
9246 from_string
= string
;
9247 goto replay_sequence
;
9252 else if (CONSP (XCDR (key
))
9253 && CONSP (EVENT_START (key
))
9254 && CONSP (XCDR (EVENT_START (key
))))
9258 posn
= POSN_POSN (EVENT_START (key
));
9259 /* Handle menu-bar events:
9260 insert the dummy prefix event `menu-bar'. */
9261 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9263 if (t
+ 1 >= bufsize
)
9264 error ("Key sequence too long");
9268 /* Zap the position in key, so we know that we've
9269 expanded it, and don't try to do so again. */
9270 POSN_SET_POSN (EVENT_START (key
),
9271 Fcons (posn
, Qnil
));
9274 goto replay_sequence
;
9276 else if (CONSP (posn
))
9278 /* We're looking at the second event of a
9279 sequence which we expanded before. Set
9280 last_real_key_start appropriately. */
9281 if (last_real_key_start
== t
&& t
> 0)
9282 last_real_key_start
= t
- 1;
9287 /* We have finally decided that KEY is something we might want
9289 first_binding
= (follow_key (key
,
9290 nmaps
- first_binding
,
9291 submaps
+ first_binding
,
9292 defs
+ first_binding
,
9293 submaps
+ first_binding
)
9296 /* If KEY wasn't bound, we'll try some fallbacks. */
9297 if (first_binding
< nmaps
)
9298 /* This is needed for the following scenario:
9299 event 0: a down-event that gets dropped by calling replay_key.
9300 event 1: some normal prefix like C-h.
9301 After event 0, first_unbound is 0, after event 1 fkey.start
9302 and keytran.start are both 1, so when we see that C-h is bound,
9303 we need to update first_unbound. */
9304 first_unbound
= max (t
+ 1, first_unbound
);
9309 /* Remember the position to put an upper bound on fkey.start. */
9310 first_unbound
= min (t
, first_unbound
);
9312 head
= EVENT_HEAD (key
);
9313 if (help_char_p (head
) && t
> 0)
9315 read_key_sequence_cmd
= Vprefix_help_command
;
9317 last_nonmenu_event
= key
;
9318 /* The Microsoft C compiler can't handle the goto that
9326 Lisp_Object breakdown
;
9329 breakdown
= parse_modifiers (head
);
9330 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9331 /* Attempt to reduce an unbound mouse event to a simpler
9332 event that is bound:
9333 Drags reduce to clicks.
9334 Double-clicks reduce to clicks.
9335 Triple-clicks reduce to double-clicks, then to clicks.
9336 Down-clicks are eliminated.
9337 Double-downs reduce to downs, then are eliminated.
9338 Triple-downs reduce to double-downs, then to downs,
9339 then are eliminated. */
9340 if (modifiers
& (down_modifier
| drag_modifier
9341 | double_modifier
| triple_modifier
))
9343 while (modifiers
& (down_modifier
| drag_modifier
9344 | double_modifier
| triple_modifier
))
9346 Lisp_Object new_head
, new_click
;
9347 if (modifiers
& triple_modifier
)
9348 modifiers
^= (double_modifier
| triple_modifier
);
9349 else if (modifiers
& double_modifier
)
9350 modifiers
&= ~double_modifier
;
9351 else if (modifiers
& drag_modifier
)
9352 modifiers
&= ~drag_modifier
;
9355 /* Dispose of this `down' event by simply jumping
9356 back to replay_key, to get another event.
9358 Note that if this event came from mock input,
9359 then just jumping back to replay_key will just
9360 hand it to us again. So we have to wipe out any
9363 We could delete keybuf[t] and shift everything
9364 after that to the left by one spot, but we'd also
9365 have to fix up any variable that points into
9366 keybuf, and shifting isn't really necessary
9369 Adding prefixes for non-textual mouse clicks
9370 creates two characters of mock input, and both
9371 must be thrown away. If we're only looking at
9372 the prefix now, we can just jump back to
9373 replay_key. On the other hand, if we've already
9374 processed the prefix, and now the actual click
9375 itself is giving us trouble, then we've lost the
9376 state of the keymaps we want to backtrack to, and
9377 we need to replay the whole sequence to rebuild
9380 Beyond that, only function key expansion could
9381 create more than two keys, but that should never
9382 generate mouse events, so it's okay to zero
9383 mock_input in that case too.
9385 FIXME: The above paragraph seems just plain
9386 wrong, if you consider things like
9387 xterm-mouse-mode. -stef
9389 Isn't this just the most wonderful code ever? */
9391 /* If mock_input > t + 1, the above simplification
9392 will actually end up dropping keys on the floor.
9393 This is probably OK for now, but even
9394 if mock_input <= t + 1, we need to adjust fkey
9396 Typical case [header-line down-mouse-N]:
9397 mock_input = 2, t = 1, fkey.end = 1,
9398 last_real_key_start = 0. */
9399 if (fkey
.end
> last_real_key_start
)
9401 fkey
.end
= fkey
.start
9402 = min (last_real_key_start
, fkey
.start
);
9403 fkey
.map
= fkey
.parent
;
9404 if (keytran
.end
> last_real_key_start
)
9406 keytran
.end
= keytran
.start
9407 = min (last_real_key_start
, keytran
.start
);
9408 keytran
.map
= keytran
.parent
;
9411 if (t
== last_real_key_start
)
9418 mock_input
= last_real_key_start
;
9419 goto replay_sequence
;
9424 = apply_modifiers (modifiers
, XCAR (breakdown
));
9426 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9428 /* Look for a binding for this new key. follow_key
9429 promises that it didn't munge submaps the
9430 last time we called it, since key was unbound. */
9432 = (follow_key (new_click
,
9433 nmaps
- local_first_binding
,
9434 submaps
+ local_first_binding
,
9435 defs
+ local_first_binding
,
9436 submaps
+ local_first_binding
)
9437 + local_first_binding
);
9439 /* If that click is bound, go for it. */
9440 if (first_binding
< nmaps
)
9445 /* Otherwise, we'll leave key set to the drag event. */
9452 /* Normally, last_nonmenu_event gets the previous key we read.
9453 But when a mouse popup menu is being used,
9454 we don't update last_nonmenu_event; it continues to hold the mouse
9455 event that preceded the first level of menu. */
9456 if (!used_mouse_menu
)
9457 last_nonmenu_event
= key
;
9459 /* Record what part of this_command_keys is the current key sequence. */
9460 this_single_command_key_start
= this_command_key_count
- t
;
9462 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9463 /* There is a binding and it's not a prefix.
9464 There is thus no function-key in this sequence.
9465 Moving fkey.start is important in this case to allow keytran.start
9466 to go over the sequence before we return (since we keep the
9467 invariant that keytran.end <= fkey.start). */
9470 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9473 /* If the sequence is unbound, see if we can hang a function key
9474 off the end of it. */
9475 /* Continue scan from fkey.end until we find a bound suffix. */
9476 while (fkey
.end
< t
)
9478 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9481 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9482 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9483 max (t
, mock_input
),
9484 /* If there's a binding (i.e.
9485 first_binding >= nmaps) we don't want
9486 to apply this function-key-mapping. */
9487 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9492 mock_input
= diff
+ max (t
, mock_input
);
9493 goto replay_sequence
;
9497 /* Look for this sequence in key-translation-map.
9498 Scan from keytran.end until we find a bound suffix. */
9499 while (keytran
.end
< fkey
.start
)
9501 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9504 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9505 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9510 mock_input
= diff
+ max (t
, mock_input
);
9511 /* Adjust the function-key-map counters. */
9515 goto replay_sequence
;
9519 /* If KEY is not defined in any of the keymaps,
9520 and cannot be part of a function key or translation,
9521 and is an upper case letter
9522 use the corresponding lower-case letter instead. */
9523 if (first_binding
>= nmaps
9524 && fkey
.start
>= t
&& keytran
.start
>= t
9526 && ((((XINT (key
) & 0x3ffff)
9527 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9528 && UPPERCASEP (XINT (key
) & 0x3ffff))
9529 || (XINT (key
) & shift_modifier
)))
9531 Lisp_Object new_key
;
9533 original_uppercase
= key
;
9534 original_uppercase_position
= t
- 1;
9536 if (XINT (key
) & shift_modifier
)
9537 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9539 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9540 | (XINT (key
) & ~0x3ffff)));
9542 /* We have to do this unconditionally, regardless of whether
9543 the lower-case char is defined in the keymaps, because they
9544 might get translated through function-key-map. */
9545 keybuf
[t
- 1] = new_key
;
9546 mock_input
= max (t
, mock_input
);
9548 goto replay_sequence
;
9550 /* If KEY is not defined in any of the keymaps,
9551 and cannot be part of a function key or translation,
9552 and is a shifted function key,
9553 use the corresponding unshifted function key instead. */
9554 if (first_binding
>= nmaps
9555 && fkey
.start
>= t
&& keytran
.start
>= t
9558 Lisp_Object breakdown
;
9561 breakdown
= parse_modifiers (key
);
9562 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9563 if (modifiers
& shift_modifier
)
9565 Lisp_Object new_key
;
9567 original_uppercase
= key
;
9568 original_uppercase_position
= t
- 1;
9570 modifiers
&= ~shift_modifier
;
9571 new_key
= apply_modifiers (modifiers
,
9574 keybuf
[t
- 1] = new_key
;
9575 mock_input
= max (t
, mock_input
);
9576 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9577 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9579 goto replay_sequence
;
9585 read_key_sequence_cmd
= (first_binding
< nmaps
9586 ? defs
[first_binding
]
9589 unread_switch_frame
= delayed_switch_frame
;
9590 unbind_to (count
, Qnil
);
9592 /* Don't downcase the last character if the caller says don't.
9593 Don't downcase it if the result is undefined, either. */
9594 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9595 && t
- 1 == original_uppercase_position
)
9596 keybuf
[t
- 1] = original_uppercase
;
9598 /* Occasionally we fabricate events, perhaps by expanding something
9599 according to function-key-map, or by adding a prefix symbol to a
9600 mouse click in the scroll bar or modeline. In this cases, return
9601 the entire generated key sequence, even if we hit an unbound
9602 prefix or a definition before the end. This means that you will
9603 be able to push back the event properly, and also means that
9604 read-key-sequence will always return a logical unit.
9607 for (; t
< mock_input
; t
++)
9609 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9610 && NILP (Fzerop (Vecho_keystrokes
)))
9611 echo_char (keybuf
[t
]);
9612 add_command_key (keybuf
[t
]);
9621 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9622 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9623 The sequence is sufficient to specify a non-prefix command in the
9624 current local and global maps.
9626 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9627 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9628 as a continuation of the previous key.
9630 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9631 convert the last event to lower case. (Normally any upper case event
9632 is converted to lower case if the original event is undefined and the lower
9633 case equivalent is defined.) A non-nil value is appropriate for reading
9634 a key sequence to be defined.
9636 A C-g typed while in this function is treated like any other character,
9637 and `quit-flag' is not set.
9639 If the key sequence starts with a mouse click, then the sequence is read
9640 using the keymaps of the buffer of the window clicked in, not the buffer
9641 of the selected window as normal.
9643 `read-key-sequence' drops unbound button-down events, since you normally
9644 only care about the click or drag events which follow them. If a drag
9645 or multi-click event is unbound, but the corresponding click event would
9646 be bound, `read-key-sequence' turns the event into a click event at the
9647 drag's starting position. This means that you don't have to distinguish
9648 between click and drag, double, or triple events unless you want to.
9650 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9651 lines separating windows, and scroll bars with imaginary keys
9652 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9654 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9655 function will process a switch-frame event if the user switches frames
9656 before typing anything. If the user switches frames in the middle of a
9657 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9658 is nil, then the event will be put off until after the current key sequence.
9660 `read-key-sequence' checks `function-key-map' for function key
9661 sequences, where they wouldn't conflict with ordinary bindings. See
9662 `function-key-map' for more details.
9664 The optional fifth argument COMMAND-LOOP, if non-nil, means
9665 that this key sequence is being read by something that will
9666 read commands one after another. It should be nil if the caller
9667 will read just one key sequence. */)
9668 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9670 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9671 Lisp_Object can_return_switch_frame
, command_loop
;
9673 Lisp_Object keybuf
[30];
9675 struct gcpro gcpro1
;
9676 int count
= SPECPDL_INDEX ();
9679 CHECK_STRING (prompt
);
9682 specbind (Qinput_method_exit_on_first_char
,
9683 (NILP (command_loop
) ? Qt
: Qnil
));
9684 specbind (Qinput_method_use_echo_area
,
9685 (NILP (command_loop
) ? Qt
: Qnil
));
9687 bzero (keybuf
, sizeof keybuf
);
9689 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9691 if (NILP (continue_echo
))
9693 this_command_key_count
= 0;
9694 this_command_key_count_reset
= 0;
9695 this_single_command_key_start
= 0;
9698 #ifdef HAVE_X_WINDOWS
9699 if (display_hourglass_p
)
9700 cancel_hourglass ();
9703 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9704 prompt
, ! NILP (dont_downcase_last
),
9705 ! NILP (can_return_switch_frame
), 0);
9707 #if 0 /* The following is fine for code reading a key sequence and
9708 then proceeding with a lenghty computation, but it's not good
9709 for code reading keys in a loop, like an input method. */
9710 #ifdef HAVE_X_WINDOWS
9711 if (display_hourglass_p
)
9722 return unbind_to (count
, make_event_array (i
, keybuf
));
9725 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9726 Sread_key_sequence_vector
, 1, 5, 0,
9727 doc
: /* Like `read-key-sequence' but always return a vector. */)
9728 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9730 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9731 Lisp_Object can_return_switch_frame
, command_loop
;
9733 Lisp_Object keybuf
[30];
9735 struct gcpro gcpro1
;
9736 int count
= SPECPDL_INDEX ();
9739 CHECK_STRING (prompt
);
9742 specbind (Qinput_method_exit_on_first_char
,
9743 (NILP (command_loop
) ? Qt
: Qnil
));
9744 specbind (Qinput_method_use_echo_area
,
9745 (NILP (command_loop
) ? Qt
: Qnil
));
9747 bzero (keybuf
, sizeof keybuf
);
9749 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9751 if (NILP (continue_echo
))
9753 this_command_key_count
= 0;
9754 this_command_key_count_reset
= 0;
9755 this_single_command_key_start
= 0;
9758 #ifdef HAVE_X_WINDOWS
9759 if (display_hourglass_p
)
9760 cancel_hourglass ();
9763 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9764 prompt
, ! NILP (dont_downcase_last
),
9765 ! NILP (can_return_switch_frame
), 0);
9767 #ifdef HAVE_X_WINDOWS
9768 if (display_hourglass_p
)
9778 return unbind_to (count
, Fvector (i
, keybuf
));
9781 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9782 doc
: /* Execute CMD as an editor command.
9783 CMD must be a symbol that satisfies the `commandp' predicate.
9784 Optional second arg RECORD-FLAG non-nil
9785 means unconditionally put this command in `command-history'.
9786 Otherwise, that is done only if an arg is read using the minibuffer.
9787 The argument KEYS specifies the value to use instead of (this-command-keys)
9788 when reading the arguments; if it is nil, (this-command-keys) is used.
9789 The argument SPECIAL, if non-nil, means that this command is executing
9790 a special event, so ignore the prefix argument and don't clear it. */)
9791 (cmd
, record_flag
, keys
, special
)
9792 Lisp_Object cmd
, record_flag
, keys
, special
;
9794 register Lisp_Object final
;
9795 register Lisp_Object tem
;
9796 Lisp_Object prefixarg
;
9797 struct backtrace backtrace
;
9798 extern int debug_on_next_call
;
9800 debug_on_next_call
= 0;
9804 prefixarg
= current_kboard
->Vprefix_arg
;
9805 Vcurrent_prefix_arg
= prefixarg
;
9806 current_kboard
->Vprefix_arg
= Qnil
;
9813 tem
= Fget (cmd
, Qdisabled
);
9814 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9816 tem
= Fsymbol_value (Qdisabled_command_function
);
9818 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9824 final
= Findirect_function (cmd
);
9826 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9828 struct gcpro gcpro1
, gcpro2
;
9830 GCPRO2 (cmd
, prefixarg
);
9831 do_autoload (final
, cmd
);
9838 if (STRINGP (final
) || VECTORP (final
))
9840 /* If requested, place the macro in the command history. For
9841 other sorts of commands, call-interactively takes care of
9843 if (!NILP (record_flag
))
9846 = Fcons (Fcons (Qexecute_kbd_macro
,
9847 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9850 /* Don't keep command history around forever. */
9851 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9853 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9855 XSETCDR (tem
, Qnil
);
9859 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9862 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9864 backtrace
.next
= backtrace_list
;
9865 backtrace_list
= &backtrace
;
9866 backtrace
.function
= &Qcall_interactively
;
9867 backtrace
.args
= &cmd
;
9868 backtrace
.nargs
= 1;
9869 backtrace
.evalargs
= 0;
9870 backtrace
.debug_on_exit
= 0;
9872 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9874 backtrace_list
= backtrace
.next
;
9882 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9884 doc
: /* Read function name, then read its arguments and call it. */)
9886 Lisp_Object prefixarg
;
9888 Lisp_Object function
;
9890 int saved_last_point_position
;
9891 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9892 Lisp_Object bindings
, value
;
9893 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9894 #ifdef HAVE_X_WINDOWS
9895 /* The call to Fcompleting_read wil start and cancel the hourglass,
9896 but if the hourglass was already scheduled, this means that no
9897 hourglass will be shown for the actual M-x command itself.
9898 So we restart it if it is already scheduled. Note that checking
9899 hourglass_shown_p is not enough, normally the hourglass is not shown,
9900 just scheduled to be shown. */
9901 int hstarted
= hourglass_started ();
9904 saved_keys
= Fvector (this_command_key_count
,
9905 XVECTOR (this_command_keys
)->contents
);
9906 saved_last_point_position_buffer
= last_point_position_buffer
;
9907 saved_last_point_position
= last_point_position
;
9909 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9911 if (EQ (prefixarg
, Qminus
))
9913 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9914 strcpy (buf
, "C-u ");
9915 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9916 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9917 else if (INTEGERP (prefixarg
))
9918 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9920 /* This isn't strictly correct if execute-extended-command
9921 is bound to anything else. Perhaps it should use
9922 this_command_keys? */
9923 strcat (buf
, "M-x ");
9925 /* Prompt with buf, and then read a string, completing from and
9926 restricting to the set of all defined commands. Don't provide
9927 any initial input. Save the command read on the extended-command
9929 function
= Fcompleting_read (build_string (buf
),
9930 Vobarray
, Qcommandp
,
9931 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9934 #ifdef HAVE_X_WINDOWS
9935 if (hstarted
) start_hourglass ();
9938 if (STRINGP (function
) && SCHARS (function
) == 0)
9939 error ("No command name given");
9941 /* Set this_command_keys to the concatenation of saved_keys and
9942 function, followed by a RET. */
9947 this_command_key_count
= 0;
9948 this_command_key_count_reset
= 0;
9949 this_single_command_key_start
= 0;
9951 keys
= XVECTOR (saved_keys
)->contents
;
9952 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9953 add_command_key (keys
[i
]);
9955 for (i
= 0; i
< SCHARS (function
); i
++)
9956 add_command_key (Faref (function
, make_number (i
)));
9958 add_command_key (make_number ('\015'));
9961 last_point_position
= saved_last_point_position
;
9962 last_point_position_buffer
= saved_last_point_position_buffer
;
9966 function
= Fintern (function
, Qnil
);
9967 current_kboard
->Vprefix_arg
= prefixarg
;
9968 Vthis_command
= function
;
9969 real_this_command
= function
;
9971 /* If enabled, show which key runs this command. */
9972 if (!NILP (Vsuggest_key_bindings
)
9973 && NILP (Vexecuting_kbd_macro
)
9974 && SYMBOLP (function
))
9975 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9981 GCPRO2 (bindings
, value
);
9982 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9984 /* If the command has a key binding, print it now. */
9985 if (!NILP (bindings
)
9986 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9989 /* But first wait, and skip the message if there is input. */
9991 if (!NILP (echo_area_buffer
[0]))
9992 /* This command displayed something in the echo area;
9993 so wait a few seconds, then display our suggestion message. */
9994 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9995 ? XINT (Vsuggest_key_bindings
) : 2);
9997 /* This command left the echo area empty,
9998 so display our message immediately. */
10001 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
10002 && ! CONSP (Vunread_command_events
))
10004 Lisp_Object binding
;
10006 int message_p
= push_message ();
10007 int count
= SPECPDL_INDEX ();
10009 record_unwind_protect (pop_message_unwind
, Qnil
);
10010 binding
= Fkey_description (bindings
, Qnil
);
10013 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
10016 sprintf (newmessage
, "You can run the command `%s' with %s",
10017 SDATA (SYMBOL_NAME (function
)),
10019 message2_nolog (newmessage
,
10020 strlen (newmessage
),
10021 STRING_MULTIBYTE (binding
));
10022 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
10023 ? Vsuggest_key_bindings
: make_number (2)),
10026 restore_message ();
10028 unbind_to (count
, Qnil
);
10032 RETURN_UNGCPRO (value
);
10036 /* Return nonzero if input events are pending. */
10039 detect_input_pending ()
10041 if (!input_pending
)
10042 get_input_pending (&input_pending
, 0);
10044 return input_pending
;
10047 /* Return nonzero if input events other than mouse movements are
10051 detect_input_pending_ignore_squeezables ()
10053 if (!input_pending
)
10054 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10056 return input_pending
;
10059 /* Return nonzero if input events are pending, and run any pending timers. */
10062 detect_input_pending_run_timers (do_display
)
10065 int old_timers_run
= timers_run
;
10067 if (!input_pending
)
10068 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10070 if (old_timers_run
!= timers_run
&& do_display
)
10072 redisplay_preserve_echo_area (8);
10073 /* The following fixes a bug when using lazy-lock with
10074 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10075 from an idle timer function. The symptom of the bug is that
10076 the cursor sometimes doesn't become visible until the next X
10077 event is processed. --gerd. */
10079 Lisp_Object tail
, frame
;
10080 FOR_EACH_FRAME (tail
, frame
)
10081 if (FRAME_RIF (XFRAME (frame
)))
10082 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10086 return input_pending
;
10089 /* This is called in some cases before a possible quit.
10090 It cases the next call to detect_input_pending to recompute input_pending.
10091 So calling this function unnecessarily can't do any harm. */
10094 clear_input_pending ()
10099 /* Return nonzero if there are pending requeued events.
10100 This isn't used yet. The hope is to make wait_reading_process_output
10101 call it, and return if it runs Lisp code that unreads something.
10102 The problem is, kbd_buffer_get_event needs to be fixed to know what
10103 to do in that case. It isn't trivial. */
10106 requeued_events_pending_p ()
10108 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10112 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10113 doc
: /* Return t if command input is currently available with no wait.
10114 Actually, the value is nil only if we can be sure that no input is available;
10115 if there is a doubt, the value is t. */)
10118 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10121 get_input_pending (&input_pending
,
10122 READABLE_EVENTS_DO_TIMERS_NOW
10123 | READABLE_EVENTS_FILTER_EVENTS
);
10124 return input_pending
> 0 ? Qt
: Qnil
;
10127 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10128 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10131 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10134 if (total_keys
< NUM_RECENT_KEYS
)
10135 return Fvector (total_keys
, keys
);
10138 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10139 bcopy (keys
+ recent_keys_index
,
10140 XVECTOR (val
)->contents
,
10141 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10143 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10144 recent_keys_index
* sizeof (Lisp_Object
));
10149 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10150 doc
: /* Return the key sequence that invoked this command.
10151 However, if the command has called `read-key-sequence', it returns
10152 the last key sequence that has been read.
10153 The value is a string or a vector. */)
10156 return make_event_array (this_command_key_count
,
10157 XVECTOR (this_command_keys
)->contents
);
10160 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10161 doc
: /* Return the key sequence that invoked this command, as a vector.
10162 However, if the command has called `read-key-sequence', it returns
10163 the last key sequence that has been read. */)
10166 return Fvector (this_command_key_count
,
10167 XVECTOR (this_command_keys
)->contents
);
10170 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10171 Sthis_single_command_keys
, 0, 0, 0,
10172 doc
: /* Return the key sequence that invoked this command.
10173 More generally, it returns the last key sequence read, either by
10174 the command loop or by `read-key-sequence'.
10175 Unlike `this-command-keys', this function's value
10176 does not include prefix arguments.
10177 The value is always a vector. */)
10180 return Fvector (this_command_key_count
10181 - this_single_command_key_start
,
10182 (XVECTOR (this_command_keys
)->contents
10183 + this_single_command_key_start
));
10186 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10187 Sthis_single_command_raw_keys
, 0, 0, 0,
10188 doc
: /* Return the raw events that were read for this command.
10189 More generally, it returns the last key sequence read, either by
10190 the command loop or by `read-key-sequence'.
10191 Unlike `this-single-command-keys', this function's value
10192 shows the events before all translations (except for input methods).
10193 The value is always a vector. */)
10196 return Fvector (raw_keybuf_count
,
10197 (XVECTOR (raw_keybuf
)->contents
));
10200 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10201 Sreset_this_command_lengths
, 0, 0, 0,
10202 doc
: /* Make the unread events replace the last command and echo.
10203 Used in `universal-argument-other-key'.
10205 `universal-argument-other-key' rereads the event just typed.
10206 It then gets translated through `function-key-map'.
10207 The translated event has to replace the real events,
10208 both in the value of (this-command-keys) and in echoing.
10209 To achieve this, `universal-argument-other-key' calls
10210 `reset-this-command-lengths', which discards the record of reading
10211 these events the first time. */)
10214 this_command_key_count
= before_command_key_count
;
10215 if (this_command_key_count
< this_single_command_key_start
)
10216 this_single_command_key_start
= this_command_key_count
;
10218 echo_truncate (before_command_echo_length
);
10220 /* Cause whatever we put into unread-command-events
10221 to echo as if it were being freshly read from the keyboard. */
10222 this_command_key_count_reset
= 1;
10227 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10228 Sclear_this_command_keys
, 0, 1, 0,
10229 doc
: /* Clear out the vector that `this-command-keys' returns.
10230 Also clear the record of the last 100 events, unless optional arg
10231 KEEP-RECORD is non-nil. */)
10233 Lisp_Object keep_record
;
10237 this_command_key_count
= 0;
10238 this_command_key_count_reset
= 0;
10240 if (NILP (keep_record
))
10242 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10243 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10245 recent_keys_index
= 0;
10250 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10251 doc
: /* Return the current depth in recursive edits. */)
10255 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10259 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10260 "FOpen dribble file: ",
10261 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10262 If FILE is nil, close any open dribble file. */)
10273 file
= Fexpand_file_name (file
, Qnil
);
10274 dribble
= fopen (SDATA (file
), "w");
10276 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10281 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10282 doc
: /* Discard the contents of the terminal input buffer.
10283 Also end any kbd macro being defined. */)
10286 if (!NILP (current_kboard
->defining_kbd_macro
))
10288 /* Discard the last command from the macro. */
10289 Fcancel_kbd_macro_events ();
10293 update_mode_lines
++;
10295 Vunread_command_events
= Qnil
;
10296 unread_command_char
= -1;
10298 discard_tty_input ();
10300 kbd_fetch_ptr
= kbd_store_ptr
;
10306 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10307 doc
: /* Stop Emacs and return to superior process. You can resume later.
10308 If `cannot-suspend' is non-nil, or if the system doesn't support job
10309 control, run a subshell instead.
10311 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10312 to be read as terminal input by Emacs's parent, after suspension.
10314 Before suspending, run the normal hook `suspend-hook'.
10315 After resumption run the normal hook `suspend-resume-hook'.
10317 Some operating systems cannot stop the Emacs process and resume it later.
10318 On such systems, Emacs starts a subshell instead of suspending. */)
10320 Lisp_Object stuffstring
;
10322 int count
= SPECPDL_INDEX ();
10323 int old_height
, old_width
;
10325 struct gcpro gcpro1
;
10327 if (tty_list
&& tty_list
->next
)
10328 error ("There are other tty frames open; close them before suspending Emacs");
10330 if (!NILP (stuffstring
))
10331 CHECK_STRING (stuffstring
);
10333 /* Run the functions in suspend-hook. */
10334 if (!NILP (Vrun_hooks
))
10335 call1 (Vrun_hooks
, intern ("suspend-hook"));
10337 GCPRO1 (stuffstring
);
10338 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10339 reset_all_sys_modes ();
10340 /* sys_suspend can get an error if it tries to fork a subshell
10341 and the system resources aren't available for that. */
10342 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10344 stuff_buffered_input (stuffstring
);
10345 if (cannot_suspend
)
10349 unbind_to (count
, Qnil
);
10351 /* Check if terminal/window size has changed.
10352 Note that this is not useful when we are running directly
10353 with a window system; but suspend should be disabled in that case. */
10354 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10355 if (width
!= old_width
|| height
!= old_height
)
10356 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10358 /* Run suspend-resume-hook. */
10359 if (!NILP (Vrun_hooks
))
10360 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10366 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10367 Then in any case stuff anything Emacs has read ahead and not used. */
10370 stuff_buffered_input (stuffstring
)
10371 Lisp_Object stuffstring
;
10373 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10374 register unsigned char *p
;
10376 if (STRINGP (stuffstring
))
10378 register int count
;
10380 p
= SDATA (stuffstring
);
10381 count
= SBYTES (stuffstring
);
10382 while (count
-- > 0)
10387 /* Anything we have read ahead, put back for the shell to read. */
10388 /* ?? What should this do when we have multiple keyboards??
10389 Should we ignore anything that was typed in at the "wrong" kboard?
10391 rms: we should stuff everything back into the kboard
10393 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10396 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10397 kbd_fetch_ptr
= kbd_buffer
;
10398 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10399 stuff_char (kbd_fetch_ptr
->code
);
10401 clear_event (kbd_fetch_ptr
);
10405 #endif /* SIGTSTP */
10409 set_waiting_for_input (time_to_clear
)
10410 EMACS_TIME
*time_to_clear
;
10412 input_available_clear_time
= time_to_clear
;
10414 /* Tell handle_interrupt to throw back to read_char, */
10415 waiting_for_input
= 1;
10417 /* If handle_interrupt was called before and buffered a C-g,
10418 make it run again now, to avoid timing error. */
10419 if (!NILP (Vquit_flag
))
10420 quit_throw_to_read_char ();
10424 clear_waiting_for_input ()
10426 /* Tell handle_interrupt not to throw back to read_char, */
10427 waiting_for_input
= 0;
10428 input_available_clear_time
= 0;
10431 /* The SIGINT handler.
10433 If we have a frame on the controlling tty, we assume that the
10434 SIGINT was generated by C-g, so we call handle_interrupt.
10435 Otherwise, the handler kills Emacs. */
10438 interrupt_signal (signalnum
) /* If we don't have an argument, */
10439 int signalnum
; /* some compilers complain in signal calls. */
10441 /* Must preserve main program's value of errno. */
10442 int old_errno
= errno
;
10443 struct device
*device
;
10445 #if defined (USG) && !defined (POSIX_SIGNALS)
10446 /* USG systems forget handlers when they are used;
10447 must reestablish each time */
10448 signal (SIGINT
, interrupt_signal
);
10449 signal (SIGQUIT
, interrupt_signal
);
10452 SIGNAL_THREAD_CHECK (signalnum
);
10454 /* See if we have an active display on our controlling terminal. */
10455 device
= get_named_tty (NULL
);
10458 /* If there are no frames there, let's pretend that we are a
10459 well-behaving UN*X program and quit. */
10460 fatal_error_signal (SIGTERM
);
10464 /* Otherwise, the SIGINT was probably generated by C-g. */
10466 /* Set internal_last_event_frame to the top frame of the
10467 controlling tty, if we have a frame there. We disable the
10468 interrupt key on secondary ttys, so the SIGINT must have come
10469 from the controlling tty. */
10470 internal_last_event_frame
= device
->display_info
.tty
->top_frame
;
10472 handle_interrupt ();
10478 /* This routine is called at interrupt level in response to C-g.
10480 It is called from the SIGINT handler or kbd_buffer_store_event.
10482 If `waiting_for_input' is non zero, then unless `echoing' is
10483 nonzero, immediately throw back to read_char.
10485 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10486 eval to throw, when it gets a chance. If quit-flag is already
10487 non-nil, it stops the job right away. */
10490 handle_interrupt ()
10496 /* XXX This code needs to be revised for multi-tty support. */
10497 if (!NILP (Vquit_flag
)
10499 && get_named_tty (NULL
)
10503 /* If SIGINT isn't blocked, don't let us be interrupted by
10504 another SIGINT, it might be harmful due to non-reentrancy
10505 in I/O functions. */
10506 sigblock (sigmask (SIGINT
));
10509 reset_all_sys_modes ();
10511 #ifdef SIGTSTP /* Support possible in later USG versions */
10513 * On systems which can suspend the current process and return to the original
10514 * shell, this command causes the user to end up back at the shell.
10515 * The "Auto-save" and "Abort" questions are not asked until
10516 * the user elects to return to emacs, at which point he can save the current
10517 * job and either dump core or continue.
10522 if (sys_suspend () == -1)
10524 printf ("Not running as a subprocess;\n");
10525 printf ("you can continue or abort.\n");
10527 #else /* not VMS */
10528 /* Perhaps should really fork an inferior shell?
10529 But that would not provide any way to get back
10530 to the original shell, ever. */
10531 printf ("No support for stopping a process on this operating system;\n");
10532 printf ("you can continue or abort.\n");
10533 #endif /* not VMS */
10534 #endif /* not SIGTSTP */
10536 /* We must remain inside the screen area when the internal terminal
10537 is used. Note that [Enter] is not echoed by dos. */
10540 /* It doesn't work to autosave while GC is in progress;
10541 the code used for auto-saving doesn't cope with the mark bit. */
10542 if (!gc_in_progress
)
10544 printf ("Auto-save? (y or n) ");
10546 if (((c
= getchar ()) & ~040) == 'Y')
10548 Fdo_auto_save (Qt
, Qnil
);
10550 printf ("\r\nAuto-save done");
10551 #else /* not MSDOS */
10552 printf ("Auto-save done\n");
10553 #endif /* not MSDOS */
10555 while (c
!= '\n') c
= getchar ();
10559 /* During GC, it must be safe to reenable quitting again. */
10560 Vinhibit_quit
= Qnil
;
10563 #endif /* not MSDOS */
10564 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10565 printf ("but will instead do a real quit after garbage collection ends\r\n");
10570 printf ("\r\nAbort? (y or n) ");
10571 #else /* not MSDOS */
10573 printf ("Abort (and enter debugger)? (y or n) ");
10574 #else /* not VMS */
10575 printf ("Abort (and dump core)? (y or n) ");
10576 #endif /* not VMS */
10577 #endif /* not MSDOS */
10579 if (((c
= getchar ()) & ~040) == 'Y')
10581 while (c
!= '\n') c
= getchar ();
10583 printf ("\r\nContinuing...\r\n");
10584 #else /* not MSDOS */
10585 printf ("Continuing...\n");
10586 #endif /* not MSDOS */
10588 init_all_sys_modes ();
10593 /* If executing a function that wants to be interrupted out of
10594 and the user has not deferred quitting by binding `inhibit-quit'
10595 then quit right away. */
10596 if (immediate_quit
&& NILP (Vinhibit_quit
))
10598 struct gl_state_s saved
;
10599 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10601 immediate_quit
= 0;
10604 GCPRO4 (saved
.object
, saved
.global_code
,
10605 saved
.current_syntax_table
, saved
.old_prop
);
10606 Fsignal (Qquit
, Qnil
);
10611 /* Else request quit when it's safe */
10615 if (waiting_for_input
&& !echoing
)
10616 quit_throw_to_read_char ();
10619 /* Handle a C-g by making read_char return C-g. */
10622 quit_throw_to_read_char ()
10625 /* Prevent another signal from doing this before we finish. */
10626 clear_waiting_for_input ();
10629 Vunread_command_events
= Qnil
;
10630 unread_command_char
= -1;
10632 #if 0 /* Currently, sit_for is called from read_char without turning
10633 off polling. And that can call set_waiting_for_input.
10634 It seems to be harmless. */
10635 #ifdef POLL_FOR_INPUT
10636 /* May be > 1 if in recursive minibuffer. */
10637 if (poll_suppress_count
== 0)
10641 if (FRAMEP (internal_last_event_frame
)
10642 && !EQ (internal_last_event_frame
, selected_frame
))
10643 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10646 _longjmp (getcjmp
, 1);
10649 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
, Sset_input_interrupt_mode
, 1, 1, 0,
10650 doc
: /* Set interrupt mode of reading keyboard input.
10651 If INTERRUPT is non-nil, Emacs will use input interrupts;
10652 otherwise Emacs uses CBREAK mode.
10654 See also `current-input-mode'. */)
10656 Lisp_Object interrupt
;
10658 int new_interrupt_input
;
10660 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10662 #ifdef HAVE_X_WINDOWS
10663 || x_display_list
!= NULL
10667 /* When using X, don't give the user a real choice,
10668 because we haven't implemented the mechanisms to support it. */
10669 #ifdef NO_SOCK_SIGIO
10670 new_interrupt_input
= 0;
10671 #else /* not NO_SOCK_SIGIO */
10672 new_interrupt_input
= 1;
10673 #endif /* NO_SOCK_SIGIO */
10676 new_interrupt_input
= !NILP (interrupt
);
10677 #else /* not SIGIO */
10678 new_interrupt_input
= 0;
10679 #endif /* not SIGIO */
10681 /* Our VMS input only works by interrupts, as of now. */
10683 new_interrupt_input
= 1;
10686 if (new_interrupt_input
!= interrupt_input
)
10688 #ifdef POLL_FOR_INPUT
10692 /* this causes startup screen to be restored and messes with the mouse */
10693 reset_all_sys_modes ();
10695 interrupt_input
= new_interrupt_input
;
10697 init_all_sys_modes ();
10700 #ifdef POLL_FOR_INPUT
10701 poll_suppress_count
= 1;
10708 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10709 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10710 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10711 C-q in key sequences.
10713 This setting only has an effect on tty display devices and only when
10714 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10716 See also `current-input-mode'. */)
10718 Lisp_Object flow
, terminal
;
10720 struct device
*d
= get_device (terminal
, 1);
10721 struct tty_display_info
*tty
;
10722 if (d
== NULL
|| d
->type
!= output_termcap
)
10724 tty
= d
->display_info
.tty
;
10726 if (tty
->flow_control
!= !NILP (flow
))
10729 /* this causes startup screen to be restored and messes with the mouse */
10730 reset_sys_modes (tty
);
10733 tty
->flow_control
= !NILP (flow
);
10736 init_sys_modes (tty
);
10742 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10743 doc
: /* Enable or disable 8-bit input on TERMINAL.
10744 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10745 bit as the Meta modifier.
10747 If META is nil, Emacs will ignore the top bit, on the assumption it is
10750 Otherwise, Emacs will accept and pass through 8-bit input without
10751 specially interpreting the top bit.
10753 This setting only has an effect on tty display devices.
10755 Optional parameter TERMINAL specifies the tty display device to use.
10756 It may be a terminal id, a frame, or nil for the terminal used by the
10757 currently selected frame.
10759 See also `current-input-mode'. */)
10761 Lisp_Object meta
, terminal
;
10763 struct device
*d
= get_device (terminal
, 1);
10764 struct tty_display_info
*tty
;
10767 if (d
== NULL
|| d
->type
!= output_termcap
)
10769 tty
= d
->display_info
.tty
;
10773 else if (EQ (meta
, Qt
))
10778 if (tty
->meta_key
!= new_meta
)
10781 /* this causes startup screen to be restored and messes with the mouse */
10782 reset_sys_modes (tty
);
10785 tty
->meta_key
= new_meta
;
10788 init_sys_modes (tty
);
10794 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10795 doc
: /* Specify character used for quitting.
10796 QUIT must be an ASCII character.
10798 This function only has an effect on the tty display on the controlling
10799 tty of the Emacs process.
10801 See also `current-input-mode'. */)
10805 struct device
*d
= get_named_tty (NULL
);
10806 struct tty_display_info
*tty
;
10807 if (d
== NULL
|| d
->type
!= output_termcap
)
10809 tty
= d
->display_info
.tty
;
10812 /* this causes startup screen to be restored and messes with the mouse */
10813 reset_sys_modes (tty
);
10816 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10817 error ("QUIT must be an ASCII character");
10819 /* Don't let this value be out of range. */
10820 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10823 init_sys_modes (tty
);
10829 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10830 doc
: /* Set mode of reading keyboard input.
10831 First arg INTERRUPT non-nil means use input interrupts;
10832 nil means use CBREAK mode.
10833 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10834 (no effect except in CBREAK mode).
10835 Third arg META t means accept 8-bit input (for a Meta key).
10836 META nil means ignore the top bit, on the assumption it is parity.
10837 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10838 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10839 See also `current-input-mode'. */)
10840 (interrupt
, flow
, meta
, quit
)
10841 Lisp_Object interrupt
, flow
, meta
, quit
;
10843 Fset_input_interrupt_mode (interrupt
);
10844 Fset_output_flow_control (flow
, Qnil
);
10845 Fset_input_meta_mode (meta
, Qnil
);
10846 Fset_quit_char (quit
);
10850 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10851 doc
: /* Return information about the way Emacs currently reads keyboard input.
10852 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10853 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10854 nil, Emacs is using CBREAK mode.
10855 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10856 terminal; this does not apply if Emacs uses interrupt-driven input.
10857 META is t if accepting 8-bit input with 8th bit as Meta flag.
10858 META nil means ignoring the top bit, on the assumption it is parity.
10859 META is neither t nor nil if accepting 8-bit input and using
10860 all 8 bits as the character code.
10861 QUIT is the character Emacs currently uses to quit.
10862 The elements of this list correspond to the arguments of
10863 `set-input-mode'. */)
10866 Lisp_Object val
[4];
10867 struct frame
*sf
= XFRAME (selected_frame
);
10869 val
[0] = interrupt_input
? Qt
: Qnil
;
10870 if (FRAME_TERMCAP_P (sf
))
10872 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10873 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10875 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10882 XSETFASTINT (val
[3], quit_char
);
10884 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10887 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10888 doc
: /* Return position information for pixel coordinates X and Y.
10889 By default, X and Y are relative to text area of the selected window.
10890 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10891 If optional fourth arg WHOLE is non-nil, X is relative to the left
10892 edge of the window.
10894 The return value is similar to a mouse click position:
10895 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10896 IMAGE (DX . DY) (WIDTH . HEIGHT))
10897 The `posn-' functions access elements of such lists. */)
10898 (x
, y
, frame_or_window
, whole
)
10899 Lisp_Object x
, y
, frame_or_window
, whole
;
10904 if (NILP (frame_or_window
))
10905 frame_or_window
= selected_window
;
10907 if (WINDOWP (frame_or_window
))
10911 CHECK_LIVE_WINDOW (frame_or_window
);
10913 w
= XWINDOW (frame_or_window
);
10914 XSETINT (x
, (XINT (x
)
10915 + WINDOW_LEFT_EDGE_X (w
)
10917 ? window_box_left_offset (w
, TEXT_AREA
)
10919 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10920 frame_or_window
= w
->frame
;
10923 CHECK_LIVE_FRAME (frame_or_window
);
10925 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10928 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10929 doc
: /* Return position information for buffer POS in WINDOW.
10930 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10932 Return nil if position is not visible in window. Otherwise,
10933 the return value is similar to that returned by `event-start' for
10934 a mouse click at the upper left corner of the glyph corresponding
10935 to the given buffer position:
10936 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10937 IMAGE (DX . DY) (WIDTH . HEIGHT))
10938 The `posn-' functions access elements of such lists. */)
10940 Lisp_Object pos
, window
;
10945 window
= selected_window
;
10947 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10950 Lisp_Object x
= XCAR (tem
);
10951 Lisp_Object y
= XCAR (XCDR (tem
));
10953 /* Point invisible due to hscrolling? */
10956 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10964 * Set up a new kboard object with reasonable initial values.
10970 kb
->Voverriding_terminal_local_map
= Qnil
;
10971 kb
->Vlast_command
= Qnil
;
10972 kb
->Vreal_last_command
= Qnil
;
10973 kb
->Vkeyboard_translate_table
= Qnil
;
10974 kb
->Vprefix_arg
= Qnil
;
10975 kb
->Vlast_prefix_arg
= Qnil
;
10976 kb
->kbd_queue
= Qnil
;
10977 kb
->kbd_queue_has_data
= 0;
10978 kb
->immediate_echo
= 0;
10979 kb
->echo_string
= Qnil
;
10980 kb
->echo_after_prompt
= -1;
10981 kb
->kbd_macro_buffer
= 0;
10982 kb
->kbd_macro_bufsize
= 0;
10983 kb
->defining_kbd_macro
= Qnil
;
10984 kb
->Vlast_kbd_macro
= Qnil
;
10985 kb
->reference_count
= 0;
10986 kb
->Vsystem_key_alist
= Qnil
;
10987 kb
->system_key_syms
= Qnil
;
10988 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
10989 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
10990 kb
->Vlocal_key_translation_map
= Fmake_sparse_keymap (Qnil
);
10991 Fset_keymap_parent (kb
->Vlocal_key_translation_map
, Vkey_translation_map
);
10992 kb
->Vdefault_minibuffer_frame
= Qnil
;
10996 * Destroy the contents of a kboard object, but not the object itself.
10997 * We use this just before deleting it, or if we're going to initialize
10998 * it a second time.
11004 if (kb
->kbd_macro_buffer
)
11005 xfree (kb
->kbd_macro_buffer
);
11008 #ifdef MULTI_KBOARD
11010 /* Free KB and memory referenced from it. */
11018 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11021 *kbp
= kb
->next_kboard
;
11023 /* Prevent a dangling reference to KB. */
11024 if (kb
== current_kboard
11025 && FRAMEP (selected_frame
)
11026 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11028 current_kboard
= XFRAME (selected_frame
)->device
->kboard
;
11029 if (current_kboard
== kb
)
11037 #endif /* MULTI_KBOARD */
11042 /* This is correct before outermost invocation of the editor loop */
11043 command_loop_level
= -1;
11044 immediate_quit
= 0;
11045 quit_char
= Ctl ('g');
11046 Vunread_command_events
= Qnil
;
11047 unread_command_char
= -1;
11048 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
11050 recent_keys_index
= 0;
11051 kbd_fetch_ptr
= kbd_buffer
;
11052 kbd_store_ptr
= kbd_buffer
;
11054 do_mouse_tracking
= Qnil
;
11058 /* This means that command_loop_1 won't try to select anything the first
11060 internal_last_event_frame
= Qnil
;
11061 Vlast_event_frame
= internal_last_event_frame
;
11063 #ifdef MULTI_KBOARD
11064 current_kboard
= initial_kboard
;
11066 wipe_kboard (current_kboard
);
11067 init_kboard (current_kboard
);
11069 if (!noninteractive
)
11071 /* Before multi-tty support, these handlers used to be installed
11072 only if the current session was a tty session. Now an Emacs
11073 session may have multiple display types, so we always handle
11074 SIGINT. There is special code in interrupt_signal to exit
11075 Emacs on SIGINT when there are no termcap frames on the
11076 controlling terminal. */
11077 signal (SIGINT
, interrupt_signal
);
11078 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
11079 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11080 SIGQUIT and we can't tell which one it will give us. */
11081 signal (SIGQUIT
, interrupt_signal
);
11082 #endif /* HAVE_TERMIO */
11084 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11086 if (!noninteractive
)
11087 signal (SIGIO
, input_available_signal
);
11090 /* Use interrupt input by default, if it works and noninterrupt input
11091 has deficiencies. */
11093 #ifdef INTERRUPT_INPUT
11094 interrupt_input
= 1;
11096 interrupt_input
= 0;
11099 /* Our VMS input only works by interrupts, as of now. */
11101 interrupt_input
= 1;
11107 if (keyboard_init_hook
)
11108 (*keyboard_init_hook
) ();
11110 #ifdef POLL_FOR_INPUT
11111 poll_suppress_count
= 1;
11116 /* This type's only use is in syms_of_keyboard, to initialize the
11117 event header symbols and put properties on them. */
11118 struct event_head
{
11124 struct event_head head_table
[] = {
11125 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11126 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11127 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11128 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11129 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11130 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11131 /* `select-window' should be handled just like `switch-frame'
11132 in read_key_sequence. */
11133 {&Qselect_window
, "select-window", &Qswitch_frame
}
11137 syms_of_keyboard ()
11139 Vpre_help_message
= Qnil
;
11140 staticpro (&Vpre_help_message
);
11142 Vlispy_mouse_stem
= build_string ("mouse");
11143 staticpro (&Vlispy_mouse_stem
);
11146 QCimage
= intern (":image");
11147 staticpro (&QCimage
);
11149 staticpro (&Qhelp_echo
);
11150 Qhelp_echo
= intern ("help-echo");
11152 staticpro (&item_properties
);
11153 item_properties
= Qnil
;
11155 staticpro (&tool_bar_item_properties
);
11156 tool_bar_item_properties
= Qnil
;
11157 staticpro (&tool_bar_items_vector
);
11158 tool_bar_items_vector
= Qnil
;
11160 staticpro (&real_this_command
);
11161 real_this_command
= Qnil
;
11163 Qtimer_event_handler
= intern ("timer-event-handler");
11164 staticpro (&Qtimer_event_handler
);
11166 Qdisabled_command_function
= intern ("disabled-command-function");
11167 staticpro (&Qdisabled_command_function
);
11169 Qself_insert_command
= intern ("self-insert-command");
11170 staticpro (&Qself_insert_command
);
11172 Qforward_char
= intern ("forward-char");
11173 staticpro (&Qforward_char
);
11175 Qbackward_char
= intern ("backward-char");
11176 staticpro (&Qbackward_char
);
11178 Qdisabled
= intern ("disabled");
11179 staticpro (&Qdisabled
);
11181 Qundefined
= intern ("undefined");
11182 staticpro (&Qundefined
);
11184 Qpre_command_hook
= intern ("pre-command-hook");
11185 staticpro (&Qpre_command_hook
);
11187 Qpost_command_hook
= intern ("post-command-hook");
11188 staticpro (&Qpost_command_hook
);
11190 Qdeferred_action_function
= intern ("deferred-action-function");
11191 staticpro (&Qdeferred_action_function
);
11193 Qcommand_hook_internal
= intern ("command-hook-internal");
11194 staticpro (&Qcommand_hook_internal
);
11196 Qfunction_key
= intern ("function-key");
11197 staticpro (&Qfunction_key
);
11198 Qmouse_click
= intern ("mouse-click");
11199 staticpro (&Qmouse_click
);
11200 #if defined (WINDOWSNT) || defined (MAC_OS)
11201 Qlanguage_change
= intern ("language-change");
11202 staticpro (&Qlanguage_change
);
11204 Qdrag_n_drop
= intern ("drag-n-drop");
11205 staticpro (&Qdrag_n_drop
);
11207 Qsave_session
= intern ("save-session");
11208 staticpro (&Qsave_session
);
11211 Qmac_apple_event
= intern ("mac-apple-event");
11212 staticpro (&Qmac_apple_event
);
11215 Qusr1_signal
= intern ("usr1-signal");
11216 staticpro (&Qusr1_signal
);
11217 Qusr2_signal
= intern ("usr2-signal");
11218 staticpro (&Qusr2_signal
);
11220 Qmenu_enable
= intern ("menu-enable");
11221 staticpro (&Qmenu_enable
);
11222 Qmenu_alias
= intern ("menu-alias");
11223 staticpro (&Qmenu_alias
);
11224 QCenable
= intern (":enable");
11225 staticpro (&QCenable
);
11226 QCvisible
= intern (":visible");
11227 staticpro (&QCvisible
);
11228 QChelp
= intern (":help");
11229 staticpro (&QChelp
);
11230 QCfilter
= intern (":filter");
11231 staticpro (&QCfilter
);
11232 QCbutton
= intern (":button");
11233 staticpro (&QCbutton
);
11234 QCkeys
= intern (":keys");
11235 staticpro (&QCkeys
);
11236 QCkey_sequence
= intern (":key-sequence");
11237 staticpro (&QCkey_sequence
);
11238 QCtoggle
= intern (":toggle");
11239 staticpro (&QCtoggle
);
11240 QCradio
= intern (":radio");
11241 staticpro (&QCradio
);
11243 Qmode_line
= intern ("mode-line");
11244 staticpro (&Qmode_line
);
11245 Qvertical_line
= intern ("vertical-line");
11246 staticpro (&Qvertical_line
);
11247 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11248 staticpro (&Qvertical_scroll_bar
);
11249 Qmenu_bar
= intern ("menu-bar");
11250 staticpro (&Qmenu_bar
);
11253 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11254 staticpro (&Qmouse_fixup_help_message
);
11257 Qabove_handle
= intern ("above-handle");
11258 staticpro (&Qabove_handle
);
11259 Qhandle
= intern ("handle");
11260 staticpro (&Qhandle
);
11261 Qbelow_handle
= intern ("below-handle");
11262 staticpro (&Qbelow_handle
);
11263 Qup
= intern ("up");
11265 Qdown
= intern ("down");
11266 staticpro (&Qdown
);
11267 Qtop
= intern ("top");
11269 Qbottom
= intern ("bottom");
11270 staticpro (&Qbottom
);
11271 Qend_scroll
= intern ("end-scroll");
11272 staticpro (&Qend_scroll
);
11273 Qratio
= intern ("ratio");
11274 staticpro (&Qratio
);
11276 Qevent_kind
= intern ("event-kind");
11277 staticpro (&Qevent_kind
);
11278 Qevent_symbol_elements
= intern ("event-symbol-elements");
11279 staticpro (&Qevent_symbol_elements
);
11280 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11281 staticpro (&Qevent_symbol_element_mask
);
11282 Qmodifier_cache
= intern ("modifier-cache");
11283 staticpro (&Qmodifier_cache
);
11285 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11286 staticpro (&Qrecompute_lucid_menubar
);
11287 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11288 staticpro (&Qactivate_menubar_hook
);
11290 Qpolling_period
= intern ("polling-period");
11291 staticpro (&Qpolling_period
);
11293 Qinput_method_function
= intern ("input-method-function");
11294 staticpro (&Qinput_method_function
);
11296 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11297 staticpro (&Qinput_method_exit_on_first_char
);
11298 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11299 staticpro (&Qinput_method_use_echo_area
);
11301 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11302 Fset (Qinput_method_use_echo_area
, Qnil
);
11304 last_point_position_buffer
= Qnil
;
11305 last_point_position_window
= Qnil
;
11308 struct event_head
*p
;
11310 for (p
= head_table
;
11311 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11314 *p
->var
= intern (p
->name
);
11315 staticpro (p
->var
);
11316 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11317 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11321 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11322 staticpro (&button_down_location
);
11323 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11324 staticpro (&mouse_syms
);
11325 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11326 staticpro (&wheel_syms
);
11330 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11332 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11333 for (i
= 0; i
< len
; i
++)
11334 if (modifier_names
[i
])
11335 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11336 staticpro (&modifier_symbols
);
11339 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11340 staticpro (&recent_keys
);
11342 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11343 staticpro (&this_command_keys
);
11345 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11346 staticpro (&raw_keybuf
);
11348 Qextended_command_history
= intern ("extended-command-history");
11349 Fset (Qextended_command_history
, Qnil
);
11350 staticpro (&Qextended_command_history
);
11352 accent_key_syms
= Qnil
;
11353 staticpro (&accent_key_syms
);
11355 func_key_syms
= Qnil
;
11356 staticpro (&func_key_syms
);
11358 drag_n_drop_syms
= Qnil
;
11359 staticpro (&drag_n_drop_syms
);
11361 unread_switch_frame
= Qnil
;
11362 staticpro (&unread_switch_frame
);
11364 internal_last_event_frame
= Qnil
;
11365 staticpro (&internal_last_event_frame
);
11367 read_key_sequence_cmd
= Qnil
;
11368 staticpro (&read_key_sequence_cmd
);
11370 menu_bar_one_keymap_changed_items
= Qnil
;
11371 staticpro (&menu_bar_one_keymap_changed_items
);
11373 menu_bar_items_vector
= Qnil
;
11374 staticpro (&menu_bar_items_vector
);
11376 defsubr (&Sevent_convert_list
);
11377 defsubr (&Sread_key_sequence
);
11378 defsubr (&Sread_key_sequence_vector
);
11379 defsubr (&Srecursive_edit
);
11381 defsubr (&Strack_mouse
);
11383 defsubr (&Sinput_pending_p
);
11384 defsubr (&Scommand_execute
);
11385 defsubr (&Srecent_keys
);
11386 defsubr (&Sthis_command_keys
);
11387 defsubr (&Sthis_command_keys_vector
);
11388 defsubr (&Sthis_single_command_keys
);
11389 defsubr (&Sthis_single_command_raw_keys
);
11390 defsubr (&Sreset_this_command_lengths
);
11391 defsubr (&Sclear_this_command_keys
);
11392 defsubr (&Ssuspend_emacs
);
11393 defsubr (&Sabort_recursive_edit
);
11394 defsubr (&Sexit_recursive_edit
);
11395 defsubr (&Srecursion_depth
);
11396 defsubr (&Stop_level
);
11397 defsubr (&Sdiscard_input
);
11398 defsubr (&Sopen_dribble_file
);
11399 defsubr (&Sset_input_interrupt_mode
);
11400 defsubr (&Sset_output_flow_control
);
11401 defsubr (&Sset_input_meta_mode
);
11402 defsubr (&Sset_quit_char
);
11403 defsubr (&Sset_input_mode
);
11404 defsubr (&Scurrent_input_mode
);
11405 defsubr (&Sexecute_extended_command
);
11406 defsubr (&Sposn_at_point
);
11407 defsubr (&Sposn_at_x_y
);
11409 DEFVAR_LISP ("last-command-char", &last_command_char
,
11410 doc
: /* Last input event that was part of a command. */);
11412 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11413 doc
: /* Last input event that was part of a command. */);
11415 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11416 doc
: /* Last input event in a command, except for mouse menu events.
11417 Mouse menus give back keys that don't look like mouse events;
11418 this variable holds the actual mouse event that led to the menu,
11419 so that you can determine whether the command was run by mouse or not. */);
11421 DEFVAR_LISP ("last-input-char", &last_input_char
,
11422 doc
: /* Last input event. */);
11424 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11425 doc
: /* Last input event. */);
11427 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11428 doc
: /* List of events to be read as the command input.
11429 These events are processed first, before actual keyboard input. */);
11430 Vunread_command_events
= Qnil
;
11432 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11433 doc
: /* If not -1, an object to be read as next command input event. */);
11435 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11436 doc
: /* List of events to be processed as input by input methods.
11437 These events are processed after `unread-command-events', but
11438 before actual keyboard input. */);
11439 Vunread_post_input_method_events
= Qnil
;
11441 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11442 doc
: /* List of events to be processed as input by input methods.
11443 These events are processed after `unread-command-events', but
11444 before actual keyboard input. */);
11445 Vunread_input_method_events
= Qnil
;
11447 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11448 doc
: /* Meta-prefix character code.
11449 Meta-foo as command input turns into this character followed by foo. */);
11450 XSETINT (meta_prefix_char
, 033);
11452 DEFVAR_KBOARD ("last-command", Vlast_command
,
11453 doc
: /* The last command executed.
11454 Normally a symbol with a function definition, but can be whatever was found
11455 in the keymap, or whatever the variable `this-command' was set to by that
11458 The value `mode-exit' is special; it means that the previous command
11459 read an event that told it to exit, and it did so and unread that event.
11460 In other words, the present command is the event that made the previous
11463 The value `kill-region' is special; it means that the previous command
11464 was a kill command.
11466 `last-command' has a separate binding for each display device.
11467 See Info node `(elisp)Multiple displays'. */);
11469 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11470 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11472 DEFVAR_LISP ("this-command", &Vthis_command
,
11473 doc
: /* The command now being executed.
11474 The command can set this variable; whatever is put here
11475 will be in `last-command' during the following command. */);
11476 Vthis_command
= Qnil
;
11478 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11479 doc
: /* The command bound to the current key sequence before remapping.
11480 It equals `this-command' if the original command was not remapped through
11481 any of the active keymaps. Otherwise, the value of `this-command' is the
11482 result of looking up the original command in the active keymaps. */);
11483 Vthis_original_command
= Qnil
;
11485 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11486 doc
: /* *Number of input events between auto-saves.
11487 Zero means disable autosaving due to number of characters typed. */);
11488 auto_save_interval
= 300;
11490 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11491 doc
: /* *Number of seconds idle time before auto-save.
11492 Zero or nil means disable auto-saving due to idleness.
11493 After auto-saving due to this many seconds of idle time,
11494 Emacs also does a garbage collection if that seems to be warranted. */);
11495 XSETFASTINT (Vauto_save_timeout
, 30);
11497 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11498 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11499 The value may be integer or floating point. */);
11500 Vecho_keystrokes
= make_number (1);
11502 DEFVAR_INT ("polling-period", &polling_period
,
11503 doc
: /* *Interval between polling for input during Lisp execution.
11504 The reason for polling is to make C-g work to stop a running program.
11505 Polling is needed only when using X windows and SIGIO does not work.
11506 Polling is automatically disabled in all other cases. */);
11507 polling_period
= 2;
11509 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11510 doc
: /* *Maximum time between mouse clicks to make a double-click.
11511 Measured in milliseconds. nil means disable double-click recognition;
11512 t means double-clicks have no time limit and are detected
11513 by position only. */);
11514 Vdouble_click_time
= make_number (500);
11516 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11517 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11518 On window-system frames, value is the number of pixels the mouse may have
11519 moved horizontally or vertically between two clicks to make a double-click.
11520 On non window-system frames, value is interpreted in units of 1/8 characters
11523 This variable is also the threshold for motion of the mouse
11524 to count as a drag. */);
11525 double_click_fuzz
= 3;
11527 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11528 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11529 inhibit_local_menu_bar_menus
= 0;
11531 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11532 doc
: /* Number of complete key sequences read as input so far.
11533 This includes key sequences read from keyboard macros.
11534 The number is effectively the number of interactive command invocations. */);
11535 num_input_keys
= 0;
11537 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11538 doc
: /* Number of input events read from the keyboard so far.
11539 This does not include events generated by keyboard macros. */);
11540 num_nonmacro_input_events
= 0;
11542 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11543 doc
: /* The frame in which the most recently read event occurred.
11544 If the last event came from a keyboard macro, this is set to `macro'. */);
11545 Vlast_event_frame
= Qnil
;
11547 /* This variable is set up in sysdep.c. */
11548 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11549 doc
: /* The ERASE character as set by the user with stty. */);
11551 DEFVAR_LISP ("help-char", &Vhelp_char
,
11552 doc
: /* Character to recognize as meaning Help.
11553 When it is read, do `(eval help-form)', and display result if it's a string.
11554 If the value of `help-form' is nil, this char can be read normally. */);
11555 XSETINT (Vhelp_char
, Ctl ('H'));
11557 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11558 doc
: /* List of input events to recognize as meaning Help.
11559 These work just like the value of `help-char' (see that). */);
11560 Vhelp_event_list
= Qnil
;
11562 DEFVAR_LISP ("help-form", &Vhelp_form
,
11563 doc
: /* Form to execute when character `help-char' is read.
11564 If the form returns a string, that string is displayed.
11565 If `help-form' is nil, the help char is not recognized. */);
11568 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11569 doc
: /* Command to run when `help-char' character follows a prefix key.
11570 This command is used only when there is no actual binding
11571 for that character after that prefix key. */);
11572 Vprefix_help_command
= Qnil
;
11574 DEFVAR_LISP ("top-level", &Vtop_level
,
11575 doc
: /* Form to evaluate when Emacs starts up.
11576 Useful to set before you dump a modified Emacs. */);
11579 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11580 doc
: /* Translate table for local keyboard input, or nil.
11581 If non-nil, the value should be a char-table. Each character read
11582 from the keyboard is looked up in this char-table. If the value found
11583 there is non-nil, then it is used instead of the actual input character.
11585 The value can also be a string or vector, but this is considered obsolete.
11586 If it is a string or vector of length N, character codes N and up are left
11587 untranslated. In a vector, an element which is nil means "no translation".
11589 This is applied to the characters supplied to input methods, not their
11590 output. See also `translation-table-for-input'.
11592 `local-keyboard-translate-table' has a separate binding for each
11593 terminal. See Info node `(elisp)Multiple displays'. */);
11595 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11596 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11597 \(Even if the operating system has support for stopping a process.\) */);
11598 cannot_suspend
= 0;
11600 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11601 doc
: /* Non-nil means prompt with menus when appropriate.
11602 This is done when reading from a keymap that has a prompt string,
11603 for elements that have prompt strings.
11604 The menu is displayed on the screen
11605 if X menus were enabled at configuration
11606 time and the previous event was a mouse click prefix key.
11607 Otherwise, menu prompting uses the echo area. */);
11608 menu_prompting
= 1;
11610 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11611 doc
: /* Character to see next line of menu prompt.
11612 Type this character while in a menu prompt to rotate around the lines of it. */);
11613 XSETINT (menu_prompt_more_char
, ' ');
11615 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11616 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11617 Emacs applies the modifiers of the character stored here to each keyboard
11618 character it reads. For example, after evaluating the expression
11619 (setq extra-keyboard-modifiers ?\\C-x)
11620 all input characters will have the control modifier applied to them.
11622 Note that the character ?\\C-@, equivalent to the integer zero, does
11623 not count as a control character; rather, it counts as a character
11624 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11625 cancels any modification. */);
11626 extra_keyboard_modifiers
= 0;
11628 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11629 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11630 The command loop sets this to nil before each command,
11631 and tests the value when the command returns.
11632 Buffer modification stores t in this variable. */);
11633 Vdeactivate_mark
= Qnil
;
11635 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11636 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11637 Vcommand_hook_internal
= Qnil
;
11639 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11640 doc
: /* Normal hook run before each command is executed.
11641 If an unhandled error happens in running this hook,
11642 the hook value is set to nil, since otherwise the error
11643 might happen repeatedly and make Emacs nonfunctional. */);
11644 Vpre_command_hook
= Qnil
;
11646 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11647 doc
: /* Normal hook run after each command is executed.
11648 If an unhandled error happens in running this hook,
11649 the hook value is set to nil, since otherwise the error
11650 might happen repeatedly and make Emacs nonfunctional. */);
11651 Vpost_command_hook
= Qnil
;
11654 DEFVAR_LISP ("echo-area-clear-hook", ...,
11655 doc
: /* Normal hook run when clearing the echo area. */);
11657 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11658 staticpro (&Qecho_area_clear_hook
);
11659 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11661 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11662 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11663 Vlucid_menu_bar_dirty_flag
= Qnil
;
11665 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11666 doc
: /* List of menu bar items to move to the end of the menu bar.
11667 The elements of the list are event types that may have menu bar bindings. */);
11668 Vmenu_bar_final_items
= Qnil
;
11670 DEFVAR_KBOARD ("overriding-terminal-local-map",
11671 Voverriding_terminal_local_map
,
11672 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11673 If this variable is non-nil, it is used as a keymap instead of the
11674 buffer's local map, and the minor mode keymaps and text property keymaps.
11675 It also replaces `overriding-local-map'.
11677 This variable is intended to let commands such as `universal-argument'
11678 set up a different keymap for reading the next command.
11680 `overriding-terminal-local-map' has a separate binding for each display device.
11681 See Info node `(elisp)Multiple displays'. */);
11683 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11684 doc
: /* Keymap that overrides all other local keymaps.
11685 If this variable is non-nil, it is used as a keymap--replacing the
11686 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11687 Voverriding_local_map
= Qnil
;
11689 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11690 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11691 Otherwise, the menu bar continues to reflect the buffer's local map
11692 and the minor mode maps regardless of `overriding-local-map'. */);
11693 Voverriding_local_map_menu_flag
= Qnil
;
11695 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11696 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11697 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11699 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11700 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11702 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11703 doc
: /* Alist of system-specific X windows key symbols.
11704 Each element should have the form (N . SYMBOL) where N is the
11705 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11706 and SYMBOL is its name.
11708 `system-key-alist' has a separate binding for each display device.
11709 See Info node `(elisp)Multiple displays'. */);
11711 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11712 doc
: /* Keymap that translates key sequences to key sequences during input.
11713 This is used mainly for mapping ASCII function key sequences into
11714 real Emacs function key events (symbols).
11716 The `read-key-sequence' function replaces any subsequence bound by
11717 `local-function-key-map' with its binding. More precisely, when the
11718 active keymaps have no binding for the current key sequence but
11719 `local-function-key-map' binds a suffix of the sequence to a vector or
11720 string, `read-key-sequence' replaces the matching suffix with its
11721 binding, and continues with the new sequence.
11723 If the binding is a function, it is called with one argument (the prompt)
11724 and its return value (a key sequence) is used.
11726 The events that come from bindings in `local-function-key-map' are not
11727 themselves looked up in `local-function-key-map'.
11729 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11730 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11731 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11732 typing `ESC O P x' would return [f1 x].
11734 `local-function-key-map' has a separate binding for each display
11735 device. See Info node `(elisp)Multiple displays'. If you need to
11736 define a binding on all display devices, change `function-key-map'
11737 instead. Initially, `local-function-key-map' is an empty keymap that
11738 has `function-key-map' as its parent on all display devices. */);
11740 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
11741 doc
: /* The parent keymap of all `local-function-key-map' instances.
11742 Function key definitions that apply to all display devices should go
11743 here. If a mapping is defined in both the current
11744 `local-function-key-map' binding and this variable, then the local
11745 definition will take precendence. */);
11746 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11748 DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map
,
11749 doc
: /* Keymap of key translations that can override keymaps.
11750 This keymap works like `function-key-map', but comes after that,
11751 and its non-prefix bindings override ordinary bindings.
11753 `key-translation-map' has a separate binding for each display device.
11754 (See Info node `(elisp)Multiple displays'.) If you need to set a key
11755 translation on all devices, change `global-key-translation-map' instead. */);
11757 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
11758 doc
: /* The parent keymap of all `local-key-translation-map' instances.
11759 Key translations that apply to all display devices should go here. */);
11760 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11762 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11763 doc
: /* List of deferred actions to be performed at a later time.
11764 The precise format isn't relevant here; we just check whether it is nil. */);
11765 Vdeferred_action_list
= Qnil
;
11767 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11768 doc
: /* Function to call to handle deferred actions, after each command.
11769 This function is called with no arguments after each command
11770 whenever `deferred-action-list' is non-nil. */);
11771 Vdeferred_action_function
= Qnil
;
11773 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11774 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11775 The value can be a length of time to show the message for.
11776 If the value is non-nil and not a number, we wait 2 seconds. */);
11777 Vsuggest_key_bindings
= Qt
;
11779 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11780 doc
: /* List of active absolute time timers in order of increasing time. */);
11781 Vtimer_list
= Qnil
;
11783 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11784 doc
: /* List of active idle-time timers in order of increasing time. */);
11785 Vtimer_idle_list
= Qnil
;
11787 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11788 doc
: /* If non-nil, the function that implements the current input method.
11789 It's called with one argument, a printing character that was just read.
11790 \(That means a character with code 040...0176.)
11791 Typically this function uses `read-event' to read additional events.
11792 When it does so, it should first bind `input-method-function' to nil
11793 so it will not be called recursively.
11795 The function should return a list of zero or more events
11796 to be used as input. If it wants to put back some events
11797 to be reconsidered, separately, by the input method,
11798 it can add them to the beginning of `unread-command-events'.
11800 The input method function can find in `input-method-previous-method'
11801 the previous echo area message.
11803 The input method function should refer to the variables
11804 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11805 for guidance on what to do. */);
11806 Vinput_method_function
= Qnil
;
11808 DEFVAR_LISP ("input-method-previous-message",
11809 &Vinput_method_previous_message
,
11810 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11811 This variable exists because `read-event' clears the echo area
11812 before running the input method. It is nil if there was no message. */);
11813 Vinput_method_previous_message
= Qnil
;
11815 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11816 doc
: /* If non-nil, the function that implements the display of help.
11817 It's called with one argument, the help string to display. */);
11818 Vshow_help_function
= Qnil
;
11820 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11821 doc
: /* If non-nil, suppress point adjustment after executing a command.
11823 After a command is executed, if point is moved into a region that has
11824 special properties (e.g. composition, display), we adjust point to
11825 the boundary of the region. But, when a command sets this variable to
11826 non-nil, we suppress the point adjustment.
11828 This variable is set to nil before reading a command, and is checked
11829 just after executing the command. */);
11830 Vdisable_point_adjustment
= Qnil
;
11832 DEFVAR_LISP ("global-disable-point-adjustment",
11833 &Vglobal_disable_point_adjustment
,
11834 doc
: /* *If non-nil, always suppress point adjustment.
11836 The default value is nil, in which case, point adjustment are
11837 suppressed only after special commands that set
11838 `disable-point-adjustment' (which see) to non-nil. */);
11839 Vglobal_disable_point_adjustment
= Qnil
;
11841 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11842 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11843 If the value is not a number, such messages don't time out. */);
11844 Vminibuffer_message_timeout
= make_number (2);
11846 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11847 doc
: /* If non-nil, any keyboard input throws to this symbol.
11848 The value of that variable is passed to `quit-flag' and later causes a
11849 peculiar kind of quitting. */);
11850 Vthrow_on_input
= Qnil
;
11854 keys_of_keyboard ()
11856 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11857 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11858 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11859 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11860 initial_define_key (meta_map
, 'x', "execute-extended-command");
11862 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11863 "handle-delete-frame");
11864 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11865 current-prefix-arg, as is done in `handle-switch-frame'.
11866 But `handle-switch-frame is not run from the special-map.
11867 Commands from that map are run in a special way that automatically
11868 preserves the prefix-arg. Restoring the prefix arg here is not just
11869 redundant but harmful:
11871 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11872 - after the first prompt, the exit-minibuffer-hook is run which may
11873 iconify a frame and thus push a `iconify-frame' event.
11874 - after running exit-minibuffer-hook, current-prefix-arg is
11875 restored to the non-nil value it had before the prompt.
11876 - we enter the second prompt.
11877 current-prefix-arg is non-nil, prefix-arg is nil.
11878 - before running the first real event, we run the special iconify-frame
11879 event, but we pass the `special' arg to execute-command so
11880 current-prefix-arg and prefix-arg are left untouched.
11881 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11882 - the next key event will have a spuriously non-nil current-prefix-arg. */
11883 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11885 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11887 /* Handling it at such a low-level causes read_key_sequence to get
11888 * confused because it doesn't realize that the current_buffer was
11889 * changed by read_char.
11891 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11892 * "handle-select-window"); */
11893 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11894 "handle-save-session");
11897 /* Mark the pointers in the kboard objects.
11898 Called by the Fgarbage_collector. */
11904 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11906 if (kb
->kbd_macro_buffer
)
11907 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11909 mark_object (kb
->Voverriding_terminal_local_map
);
11910 mark_object (kb
->Vlast_command
);
11911 mark_object (kb
->Vreal_last_command
);
11912 mark_object (kb
->Vkeyboard_translate_table
);
11913 mark_object (kb
->Vprefix_arg
);
11914 mark_object (kb
->Vlast_prefix_arg
);
11915 mark_object (kb
->kbd_queue
);
11916 mark_object (kb
->defining_kbd_macro
);
11917 mark_object (kb
->Vlast_kbd_macro
);
11918 mark_object (kb
->Vsystem_key_alist
);
11919 mark_object (kb
->system_key_syms
);
11920 mark_object (kb
->Vlocal_function_key_map
);
11921 mark_object (kb
->Vlocal_key_translation_map
);
11922 mark_object (kb
->Vdefault_minibuffer_frame
);
11923 mark_object (kb
->echo_string
);
11926 struct input_event
*event
;
11927 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11929 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11930 event
= kbd_buffer
;
11931 if (event
->kind
!= SELECTION_REQUEST_EVENT
11932 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11934 mark_object (event
->x
);
11935 mark_object (event
->y
);
11937 mark_object (event
->frame_or_window
);
11938 mark_object (event
->arg
);
11943 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11944 (do not change this comment) */