1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
30 #include "termhooks.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
63 #include <sys/types.h>
72 /* This is to get the definitions of the XK_ symbols. */
79 #endif /* HAVE_NTGUI */
89 /* Variables for blockinput.h: */
91 /* Non-zero if interrupt input is blocked right now. */
92 int interrupt_input_blocked
;
94 /* Nonzero means an input interrupt has arrived
95 during the current critical section. */
96 int interrupt_input_pending
;
99 #ifdef HAVE_WINDOW_SYSTEM
100 /* Make all keyboard buffers much bigger when using X windows. */
102 /* But not too big (local data > 32K error) if on Mac OS Classic. */
103 #define KBD_BUFFER_SIZE 512
105 #define KBD_BUFFER_SIZE 4096
107 #else /* No X-windows, character input */
108 #define KBD_BUFFER_SIZE 4096
109 #endif /* No X-windows */
111 #define abs(x) ((x) >= 0 ? (x) : -(x))
113 /* Following definition copied from eval.c */
117 struct backtrace
*next
;
118 Lisp_Object
*function
;
119 Lisp_Object
*args
; /* Points to vector of args. */
120 int nargs
; /* length of vector. If nargs is UNEVALLED,
121 args points to slot holding list of
124 /* Nonzero means call value of debugger when done with this operation. */
129 KBOARD
*initial_kboard
;
130 KBOARD
*current_kboard
;
134 KBOARD the_only_kboard
;
137 /* Non-nil disable property on a command means
138 do not execute it; call disabled-command-function's value instead. */
139 Lisp_Object Qdisabled
, Qdisabled_command_function
;
141 #define NUM_RECENT_KEYS (100)
142 int recent_keys_index
; /* Index for storing next element into recent_keys */
143 int total_keys
; /* Total number of elements stored into recent_keys */
144 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
146 /* Vector holding the key sequence that invoked the current command.
147 It is reused for each command, and it may be longer than the current
148 sequence; this_command_key_count indicates how many elements
149 actually mean something.
150 It's easier to staticpro a single Lisp_Object than an array. */
151 Lisp_Object this_command_keys
;
152 int this_command_key_count
;
154 /* 1 after calling Freset_this_command_lengths.
156 int this_command_key_count_reset
;
158 /* This vector is used as a buffer to record the events that were actually read
159 by read_key_sequence. */
160 Lisp_Object raw_keybuf
;
161 int raw_keybuf_count
;
163 #define GROW_RAW_KEYBUF \
164 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
166 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
168 new = Fmake_vector (make_number (newsize), Qnil); \
169 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
170 raw_keybuf_count * sizeof (Lisp_Object)); \
174 /* Number of elements of this_command_keys
175 that precede this key sequence. */
176 int this_single_command_key_start
;
178 /* Record values of this_command_key_count and echo_length ()
179 before this command was read. */
180 static int before_command_key_count
;
181 static int before_command_echo_length
;
183 extern int minbuf_level
;
185 extern int message_enable_multibyte
;
187 extern struct backtrace
*backtrace_list
;
189 /* If non-nil, the function that implements the display of help.
190 It's called with one argument, the help string to display. */
192 Lisp_Object Vshow_help_function
;
194 /* If a string, the message displayed before displaying a help-echo
197 Lisp_Object Vpre_help_message
;
199 /* Nonzero means do menu prompting. */
201 static int menu_prompting
;
203 /* Character to see next line of menu prompt. */
205 static Lisp_Object menu_prompt_more_char
;
207 /* For longjmp to where kbd input is being done. */
209 static jmp_buf getcjmp
;
211 /* True while doing kbd input. */
212 int waiting_for_input
;
214 /* True while displaying for echoing. Delays C-g throwing. */
218 /* Non-null means we can start echoing at the next input pause even
219 though there is something in the echo area. */
221 static struct kboard
*ok_to_echo_at_next_pause
;
223 /* The kboard last echoing, or null for none. Reset to 0 in
224 cancel_echoing. If non-null, and a current echo area message
225 exists, and echo_message_buffer is eq to the current message
226 buffer, we know that the message comes from echo_kboard. */
228 struct kboard
*echo_kboard
;
230 /* The buffer used for echoing. Set in echo_now, reset in
233 Lisp_Object echo_message_buffer
;
235 /* Nonzero means disregard local maps for the menu bar. */
236 static int inhibit_local_menu_bar_menus
;
238 /* Nonzero means C-g should cause immediate error-signal. */
241 /* The user's ERASE setting. */
242 Lisp_Object Vtty_erase_char
;
244 /* Character to recognize as the help char. */
245 Lisp_Object Vhelp_char
;
247 /* List of other event types to recognize as meaning "help". */
248 Lisp_Object Vhelp_event_list
;
250 /* Form to execute when help char is typed. */
251 Lisp_Object Vhelp_form
;
253 /* Command to run when the help character follows a prefix key. */
254 Lisp_Object Vprefix_help_command
;
256 /* List of items that should move to the end of the menu bar. */
257 Lisp_Object Vmenu_bar_final_items
;
259 /* Non-nil means show the equivalent key-binding for
260 any M-x command that has one.
261 The value can be a length of time to show the message for.
262 If the value is non-nil and not a number, we wait 2 seconds. */
263 Lisp_Object Vsuggest_key_bindings
;
265 /* How long to display an echo-area message when the minibuffer is active.
266 If the value is not a number, such messages don't time out. */
267 Lisp_Object Vminibuffer_message_timeout
;
269 /* Character that causes a quit. Normally C-g.
271 If we are running on an ordinary terminal, this must be an ordinary
272 ASCII char, since we want to make it our interrupt character.
274 If we are not running on an ordinary terminal, it still needs to be
275 an ordinary ASCII char. This character needs to be recognized in
276 the input interrupt handler. At this point, the keystroke is
277 represented as a struct input_event, while the desired quit
278 character is specified as a lispy event. The mapping from struct
279 input_events to lispy events cannot run in an interrupt handler,
280 and the reverse mapping is difficult for anything but ASCII
283 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
287 extern Lisp_Object current_global_map
;
288 extern int minibuf_level
;
290 /* If non-nil, this is a map that overrides all other local maps. */
291 Lisp_Object Voverriding_local_map
;
293 /* If non-nil, Voverriding_local_map applies to the menu bar. */
294 Lisp_Object Voverriding_local_map_menu_flag
;
296 /* Keymap that defines special misc events that should
297 be processed immediately at a low level. */
298 Lisp_Object Vspecial_event_map
;
300 /* Current depth in recursive edits. */
301 int command_loop_level
;
303 /* Total number of times command_loop has read a key sequence. */
304 EMACS_INT num_input_keys
;
306 /* Last input character read as a command. */
307 Lisp_Object last_command_char
;
309 /* Last input character read as a command, not counting menus
310 reached by the mouse. */
311 Lisp_Object last_nonmenu_event
;
313 /* Last input character read for any purpose. */
314 Lisp_Object last_input_char
;
316 /* If not Qnil, a list of objects to be read as subsequent command input. */
317 Lisp_Object Vunread_command_events
;
319 /* If not Qnil, a list of objects to be read as subsequent command input
320 including input method processing. */
321 Lisp_Object Vunread_input_method_events
;
323 /* If not Qnil, a list of objects to be read as subsequent command input
324 but NOT including input method processing. */
325 Lisp_Object Vunread_post_input_method_events
;
327 /* If not -1, an event to be read as subsequent command input. */
328 EMACS_INT unread_command_char
;
330 /* If not Qnil, this is a switch-frame event which we decided to put
331 off until the end of a key sequence. This should be read as the
332 next command input, after any unread_command_events.
334 read_key_sequence uses this to delay switch-frame events until the
335 end of the key sequence; Fread_char uses it to put off switch-frame
336 events until a non-ASCII event is acceptable as input. */
337 Lisp_Object unread_switch_frame
;
339 /* A mask of extra modifier bits to put into every keyboard char. */
340 EMACS_INT extra_keyboard_modifiers
;
342 /* Char to use as prefix when a meta character is typed in.
343 This is bound on entry to minibuffer in case ESC is changed there. */
345 Lisp_Object meta_prefix_char
;
347 /* Last size recorded for a current buffer which is not a minibuffer. */
348 static int last_non_minibuf_size
;
350 /* Number of idle seconds before an auto-save and garbage collection. */
351 static Lisp_Object Vauto_save_timeout
;
353 /* Total number of times read_char has returned. */
354 int num_input_events
;
356 /* Total number of times read_char has returned, outside of macros. */
357 EMACS_INT num_nonmacro_input_events
;
359 /* Auto-save automatically when this many characters have been typed
360 since the last time. */
362 static EMACS_INT auto_save_interval
;
364 /* Value of num_nonmacro_input_events as of last auto save. */
368 /* The command being executed by the command loop.
369 Commands may set this, and the value set will be copied into
370 current_kboard->Vlast_command instead of the actual command. */
371 Lisp_Object Vthis_command
;
373 /* This is like Vthis_command, except that commands never set it. */
374 Lisp_Object real_this_command
;
376 /* If the lookup of the command returns a binding, the original
377 command is stored in this-original-command. It is nil otherwise. */
378 Lisp_Object Vthis_original_command
;
380 /* The value of point when the last command was executed. */
381 int last_point_position
;
383 /* The buffer that was current when the last command was started. */
384 Lisp_Object last_point_position_buffer
;
386 /* The frame in which the last input event occurred, or Qmacro if the
387 last event came from a macro. We use this to determine when to
388 generate switch-frame events. This may be cleared by functions
389 like Fselect_frame, to make sure that a switch-frame event is
390 generated by the next character. */
391 Lisp_Object internal_last_event_frame
;
393 /* A user-visible version of the above, intended to allow users to
394 figure out where the last event came from, if the event doesn't
395 carry that information itself (i.e. if it was a character). */
396 Lisp_Object Vlast_event_frame
;
398 /* The timestamp of the last input event we received from the X server.
399 X Windows wants this for selection ownership. */
400 unsigned long last_event_timestamp
;
402 Lisp_Object Qself_insert_command
;
403 Lisp_Object Qforward_char
;
404 Lisp_Object Qbackward_char
;
405 Lisp_Object Qundefined
;
406 Lisp_Object Qtimer_event_handler
;
408 /* read_key_sequence stores here the command definition of the
409 key sequence that it reads. */
410 Lisp_Object read_key_sequence_cmd
;
412 /* Echo unfinished commands after this many seconds of pause. */
413 Lisp_Object Vecho_keystrokes
;
415 /* Form to evaluate (if non-nil) when Emacs is started. */
416 Lisp_Object Vtop_level
;
418 /* User-supplied table to translate input characters. */
419 Lisp_Object Vkeyboard_translate_table
;
421 /* If non-nil, this implements the current input method. */
422 Lisp_Object Vinput_method_function
;
423 Lisp_Object Qinput_method_function
;
425 /* When we call Vinput_method_function,
426 this holds the echo area message that was just erased. */
427 Lisp_Object Vinput_method_previous_message
;
429 /* Non-nil means deactivate the mark at end of this command. */
430 Lisp_Object Vdeactivate_mark
;
432 /* Menu bar specified in Lucid Emacs fashion. */
434 Lisp_Object Vlucid_menu_bar_dirty_flag
;
435 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
437 Lisp_Object Qecho_area_clear_hook
;
439 /* Hooks to run before and after each command. */
440 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
441 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
442 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
444 /* Parent keymap of terminal-local function-key-map instances. */
445 Lisp_Object Vfunction_key_map
;
447 /* Parent keymap of terminal-local key-translation-map instances. */
448 Lisp_Object Vkey_translation_map
;
450 /* List of deferred actions to be performed at a later time.
451 The precise format isn't relevant here; we just check whether it is nil. */
452 Lisp_Object Vdeferred_action_list
;
454 /* Function to call to handle deferred actions, when there are any. */
455 Lisp_Object Vdeferred_action_function
;
456 Lisp_Object Qdeferred_action_function
;
458 Lisp_Object Qinput_method_exit_on_first_char
;
459 Lisp_Object Qinput_method_use_echo_area
;
461 /* File in which we write all commands we read. */
464 /* Nonzero if input is available. */
467 /* Non-zero means force key bindings update in parse_menu_item. */
469 int update_menu_bindings
;
471 extern char *pending_malloc_warning
;
473 /* Circular buffer for pre-read keyboard input. */
475 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
477 /* Pointer to next available character in kbd_buffer.
478 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
479 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
480 next available char is in kbd_buffer[0]. */
481 static struct input_event
*kbd_fetch_ptr
;
483 /* Pointer to next place to store character in kbd_buffer. This
484 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
485 character should go in kbd_buffer[0]. */
486 static struct input_event
* volatile kbd_store_ptr
;
488 /* The above pair of variables forms a "queue empty" flag. When we
489 enqueue a non-hook event, we increment kbd_store_ptr. When we
490 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
491 there is input available iff the two pointers are not equal.
493 Why not just have a flag set and cleared by the enqueuing and
494 dequeuing functions? Such a flag could be screwed up by interrupts
495 at inopportune times. */
497 /* If this flag is non-nil, we check mouse_moved to see when the
498 mouse moves, and motion events will appear in the input stream.
499 Otherwise, mouse motion is ignored. */
500 Lisp_Object do_mouse_tracking
;
502 /* Symbols to head events. */
503 Lisp_Object Qmouse_movement
;
504 Lisp_Object Qscroll_bar_movement
;
505 Lisp_Object Qswitch_frame
;
506 Lisp_Object Qdelete_frame
;
507 Lisp_Object Qiconify_frame
;
508 Lisp_Object Qmake_frame_visible
;
509 Lisp_Object Qselect_window
;
510 Lisp_Object Qhelp_echo
;
513 Lisp_Object Qmouse_fixup_help_message
;
516 /* Symbols to denote kinds of events. */
517 Lisp_Object Qfunction_key
;
518 Lisp_Object Qmouse_click
;
519 #if defined (WINDOWSNT) || defined (MAC_OS)
520 Lisp_Object Qlanguage_change
;
522 Lisp_Object Qdrag_n_drop
;
523 Lisp_Object Qsave_session
;
525 /* Lisp_Object Qmouse_movement; - also an event header */
527 /* Properties of event headers. */
528 Lisp_Object Qevent_kind
;
529 Lisp_Object Qevent_symbol_elements
;
531 /* menu item parts */
532 Lisp_Object Qmenu_alias
;
533 Lisp_Object Qmenu_enable
;
534 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
535 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
536 extern Lisp_Object Vdefine_key_rebound_commands
;
537 extern Lisp_Object Qmenu_item
;
539 /* An event header symbol HEAD may have a property named
540 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
541 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
542 mask of modifiers applied to it. If present, this is used to help
543 speed up parse_modifiers. */
544 Lisp_Object Qevent_symbol_element_mask
;
546 /* An unmodified event header BASE may have a property named
547 Qmodifier_cache, which is an alist mapping modifier masks onto
548 modified versions of BASE. If present, this helps speed up
550 Lisp_Object Qmodifier_cache
;
552 /* Symbols to use for parts of windows. */
553 Lisp_Object Qmode_line
;
554 Lisp_Object Qvertical_line
;
555 Lisp_Object Qvertical_scroll_bar
;
556 Lisp_Object Qmenu_bar
;
557 extern Lisp_Object Qleft_margin
, Qright_margin
;
558 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
559 extern Lisp_Object QCmap
;
561 Lisp_Object
recursive_edit_unwind (), command_loop ();
562 Lisp_Object
Fthis_command_keys ();
563 Lisp_Object Qextended_command_history
;
564 EMACS_TIME
timer_check ();
566 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
568 extern char *x_get_keysym_name ();
570 static void record_menu_key ();
571 static int echo_length ();
573 Lisp_Object Qpolling_period
;
575 /* List of absolute timers. Appears in order of next scheduled event. */
576 Lisp_Object Vtimer_list
;
578 /* List of idle time timers. Appears in order of next scheduled event. */
579 Lisp_Object Vtimer_idle_list
;
581 /* Incremented whenever a timer is run. */
584 extern Lisp_Object Vprint_level
, Vprint_length
;
586 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
588 EMACS_TIME
*input_available_clear_time
;
590 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
591 Default is 1 if INTERRUPT_INPUT is defined. */
594 /* Nonzero while interrupts are temporarily deferred during redisplay. */
595 int interrupts_deferred
;
597 /* Allow m- file to inhibit use of FIONREAD. */
598 #ifdef BROKEN_FIONREAD
602 /* We are unable to use interrupts if FIONREAD is not available,
603 so flush SIGIO so we won't try. */
604 #if !defined (FIONREAD)
610 /* If we support a window system, turn on the code to poll periodically
611 to detect C-g. It isn't actually used when doing interrupt input. */
612 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
613 #define POLL_FOR_INPUT
616 /* After a command is executed, if point is moved into a region that
617 has specific properties (e.g. composition, display), we adjust
618 point to the boundary of the region. But, if a command sets this
619 variable to non-nil, we suppress this point adjustment. This
620 variable is set to nil before reading a command. */
622 Lisp_Object Vdisable_point_adjustment
;
624 /* If non-nil, always disable point adjustment. */
626 Lisp_Object Vglobal_disable_point_adjustment
;
628 /* The time when Emacs started being idle. */
630 static EMACS_TIME timer_idleness_start_time
;
632 /* After Emacs stops being idle, this saves the last value
633 of timer_idleness_start_time from when it was idle. */
635 static EMACS_TIME timer_last_idleness_start_time
;
638 /* Global variable declarations. */
640 /* Flags for readable_events. */
641 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
642 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
643 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
645 /* Function for init_keyboard to call with no args (if nonzero). */
646 void (*keyboard_init_hook
) ();
648 static int read_avail_input
P_ ((int));
649 static void get_input_pending
P_ ((int *, int));
650 static int readable_events
P_ ((int));
651 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
652 Lisp_Object
, int *));
653 static Lisp_Object
read_char_x_menu_prompt ();
654 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
656 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
658 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
659 enum scroll_bar_part
,
660 Lisp_Object
, Lisp_Object
,
663 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
664 Lisp_Object
, char **,
665 Lisp_Object
*, unsigned));
666 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
667 static int parse_solitary_modifier
P_ ((Lisp_Object
));
668 static int parse_solitary_modifier ();
669 static void save_getcjmp
P_ ((jmp_buf));
670 static void save_getcjmp ();
671 static void restore_getcjmp
P_ ((jmp_buf));
672 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
673 static void clear_event
P_ ((struct input_event
*));
674 static void any_kboard_state
P_ ((void));
675 static 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 record_unwind_protect (recursive_edit_unwind
,
1038 Fcons (buffer
, single_kboard
? Qt
: Qnil
));
1040 recursive_edit_1 ();
1041 return unbind_to (count
, Qnil
);
1045 recursive_edit_unwind (info
)
1048 if (BUFFERP (XCAR (info
)))
1049 Fset_buffer (XCAR (info
));
1051 if (NILP (XCDR (info
)))
1052 any_kboard_state ();
1054 single_kboard_state ();
1056 command_loop_level
--;
1057 update_mode_lines
= 1;
1066 #if 0 /* Theory: if there's anything in Vunread_command_events,
1067 it will right away be read by read_key_sequence,
1068 and then if we do switch KBOARDS, it will go into the side
1069 queue then. So we don't need to do anything special here -- rms. */
1070 if (CONSP (Vunread_command_events
))
1072 current_kboard
->kbd_queue
1073 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1074 current_kboard
->kbd_queue_has_data
= 1;
1076 Vunread_command_events
= Qnil
;
1082 /* Switch to the single-kboard state, making current_kboard
1083 the only KBOARD from which further input is accepted. */
1086 single_kboard_state ()
1093 /* If we're in single_kboard state for kboard KBOARD,
1097 not_single_kboard_state (kboard
)
1101 if (kboard
== current_kboard
)
1106 /* Maintain a stack of kboards, so other parts of Emacs
1107 can switch temporarily to the kboard of a given frame
1108 and then revert to the previous status. */
1113 struct kboard_stack
*next
;
1116 static struct kboard_stack
*kboard_stack
;
1119 push_device_kboard (d
)
1123 struct kboard_stack
*p
1124 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1126 p
->next
= kboard_stack
;
1127 p
->kboard
= current_kboard
;
1130 current_kboard
= d
->kboard
;
1135 push_frame_kboard (f
)
1139 struct kboard_stack
*p
1140 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1142 p
->next
= kboard_stack
;
1143 p
->kboard
= current_kboard
;
1146 current_kboard
= FRAME_KBOARD (f
);
1154 struct kboard_stack
*p
= kboard_stack
;
1155 current_kboard
= p
->kboard
;
1156 kboard_stack
= p
->next
;
1161 /* Handle errors that are not handled at inner levels
1162 by printing an error message and returning to the editor command loop. */
1168 Lisp_Object old_level
, old_length
;
1169 char macroerror
[50];
1171 #ifdef HAVE_X_WINDOWS
1172 if (display_hourglass_p
)
1173 cancel_hourglass ();
1176 if (!NILP (executing_kbd_macro
))
1178 if (executing_kbd_macro_iterations
== 1)
1179 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1181 sprintf (macroerror
, "After %d kbd macro iterations: ",
1182 executing_kbd_macro_iterations
);
1187 Vstandard_output
= Qt
;
1188 Vstandard_input
= Qt
;
1189 Vexecuting_kbd_macro
= Qnil
;
1190 executing_kbd_macro
= Qnil
;
1191 current_kboard
->Vprefix_arg
= Qnil
;
1192 current_kboard
->Vlast_prefix_arg
= Qnil
;
1195 /* Avoid unquittable loop if data contains a circular list. */
1196 old_level
= Vprint_level
;
1197 old_length
= Vprint_length
;
1198 XSETFASTINT (Vprint_level
, 10);
1199 XSETFASTINT (Vprint_length
, 10);
1200 cmd_error_internal (data
, macroerror
);
1201 Vprint_level
= old_level
;
1202 Vprint_length
= old_length
;
1206 Vinhibit_quit
= Qnil
;
1208 if (command_loop_level
== 0 && minibuf_level
== 0)
1209 any_kboard_state ();
1212 return make_number (0);
1215 /* Take actions on handling an error. DATA is the data that describes
1218 CONTEXT is a C-string containing ASCII characters only which
1219 describes the context in which the error happened. If we need to
1220 generalize CONTEXT to allow multibyte characters, make it a Lisp
1224 cmd_error_internal (data
, context
)
1229 int kill_emacs_p
= 0;
1230 struct frame
*sf
= SELECTED_FRAME ();
1234 clear_message (1, 0);
1236 /* If the window system or terminal frame hasn't been initialized
1237 yet, or we're not interactive, it's best to dump this message out
1238 to stderr and exit. */
1239 if (!sf
->glyphs_initialized_p
1240 || FRAME_INITIAL_P (sf
)
1243 stream
= Qexternal_debugging_output
;
1249 message_log_maybe_newline ();
1254 /* The immediate context is not interesting for Quits,
1255 since they are asyncronous. */
1256 if (EQ (XCAR (data
), Qquit
))
1257 Vsignaling_function
= Qnil
;
1259 print_error_message (data
, stream
, context
, Vsignaling_function
);
1261 Vsignaling_function
= Qnil
;
1263 /* If the window system or terminal frame hasn't been initialized
1264 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1268 Fkill_emacs (make_number (-1));
1272 Lisp_Object
command_loop_1 ();
1273 Lisp_Object
command_loop_2 ();
1274 Lisp_Object
top_level_1 ();
1276 /* Entry to editor-command-loop.
1277 This level has the catches for exiting/returning to editor command loop.
1278 It returns nil to exit recursive edit, t to abort it. */
1283 if (command_loop_level
> 0 || minibuf_level
> 0)
1286 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1287 executing_kbd_macro
= Qnil
;
1293 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1294 /* Reset single_kboard in case top-level set it while
1295 evaluating an -f option, or we are stuck there for some
1297 any_kboard_state ();
1298 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1299 executing_kbd_macro
= Qnil
;
1301 /* End of file in -batch run causes exit here. */
1307 /* Here we catch errors in execution of commands within the
1308 editing loop, and reenter the editing loop.
1309 When there is an error, cmd_error runs and returns a non-nil
1310 value to us. A value of nil means that command_loop_1 itself
1311 returned due to end of file (or end of kbd macro). */
1316 register Lisp_Object val
;
1319 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1320 while (!NILP (val
));
1328 return Feval (Vtop_level
);
1334 /* On entry to the outer level, run the startup file */
1335 if (!NILP (Vtop_level
))
1336 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1337 else if (!NILP (Vpurify_flag
))
1338 message ("Bare impure Emacs (standard Lisp code not loaded)");
1340 message ("Bare Emacs (standard Lisp code not loaded)");
1344 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1345 doc
: /* Exit all recursive editing levels. */)
1348 #ifdef HAVE_X_WINDOWS
1349 if (display_hourglass_p
)
1350 cancel_hourglass ();
1353 /* Unblock input if we enter with input blocked. This may happen if
1354 redisplay traps e.g. during tool-bar update with input blocked. */
1355 while (INPUT_BLOCKED_P
)
1358 return Fthrow (Qtop_level
, Qnil
);
1361 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1362 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1365 if (command_loop_level
> 0 || minibuf_level
> 0)
1366 Fthrow (Qexit
, Qnil
);
1368 error ("No recursive edit is in progress");
1372 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1373 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1376 if (command_loop_level
> 0 || minibuf_level
> 0)
1379 error ("No recursive edit is in progress");
1383 /* This is the actual command reading loop,
1384 sans error-handling encapsulation. */
1386 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1388 void safe_run_hooks
P_ ((Lisp_Object
));
1389 static void adjust_point_for_property
P_ ((int, int));
1391 /* Cancel hourglass from protect_unwind.
1393 #ifdef HAVE_X_WINDOWS
1395 cancel_hourglass_unwind (arg
)
1398 cancel_hourglass ();
1409 Lisp_Object keybuf
[30];
1412 int prev_modiff
= 0;
1413 struct buffer
*prev_buffer
= NULL
;
1415 int was_locked
= single_kboard
;
1417 int already_adjusted
= 0;
1419 current_kboard
->Vprefix_arg
= Qnil
;
1420 current_kboard
->Vlast_prefix_arg
= Qnil
;
1421 Vdeactivate_mark
= Qnil
;
1422 waiting_for_input
= 0;
1426 this_command_key_count
= 0;
1427 this_command_key_count_reset
= 0;
1428 this_single_command_key_start
= 0;
1430 if (NILP (Vmemory_full
))
1432 /* Make sure this hook runs after commands that get errors and
1433 throw to top level. */
1434 /* Note that the value cell will never directly contain nil
1435 if the symbol is a local variable. */
1436 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1437 safe_run_hooks (Qpost_command_hook
);
1439 /* If displaying a message, resize the echo area window to fit
1440 that message's size exactly. */
1441 if (!NILP (echo_area_buffer
[0]))
1442 resize_echo_area_exactly ();
1444 if (!NILP (Vdeferred_action_list
))
1445 safe_run_hooks (Qdeferred_action_function
);
1448 Vmemory_full
= Qnil
;
1450 /* Do this after running Vpost_command_hook, for consistency. */
1451 current_kboard
->Vlast_command
= Vthis_command
;
1452 current_kboard
->Vreal_last_command
= real_this_command
;
1456 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1459 /* Make sure the current window's buffer is selected. */
1460 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1461 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1463 /* Display any malloc warning that just came out. Use while because
1464 displaying one warning can cause another. */
1466 while (pending_malloc_warning
)
1467 display_malloc_warning ();
1471 Vdeactivate_mark
= Qnil
;
1473 /* If minibuffer on and echo area in use,
1474 wait a short time and redraw minibuffer. */
1477 && !NILP (echo_area_buffer
[0])
1478 && EQ (minibuf_window
, echo_area_window
)
1479 && NUMBERP (Vminibuffer_message_timeout
))
1481 /* Bind inhibit-quit to t so that C-g gets read in
1482 rather than quitting back to the minibuffer. */
1483 int count
= SPECPDL_INDEX ();
1484 specbind (Qinhibit_quit
, Qt
);
1486 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1487 /* Clear the echo area. */
1489 safe_run_hooks (Qecho_area_clear_hook
);
1491 unbind_to (count
, Qnil
);
1493 /* If a C-g came in before, treat it as input now. */
1494 if (!NILP (Vquit_flag
))
1497 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1502 alloca (0); /* Cause a garbage collection now */
1503 /* Since we can free the most stuff here. */
1504 #endif /* C_ALLOCA */
1507 /* Select the frame that the last event came from. Usually,
1508 switch-frame events will take care of this, but if some lisp
1509 code swallows a switch-frame event, we'll fix things up here.
1510 Is this a good idea? */
1511 if (FRAMEP (internal_last_event_frame
)
1512 && !EQ (internal_last_event_frame
, selected_frame
))
1513 Fselect_frame (internal_last_event_frame
);
1515 /* If it has changed current-menubar from previous value,
1516 really recompute the menubar from the value. */
1517 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1518 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1519 call0 (Qrecompute_lucid_menubar
);
1521 before_command_key_count
= this_command_key_count
;
1522 before_command_echo_length
= echo_length ();
1524 Vthis_command
= Qnil
;
1525 real_this_command
= Qnil
;
1526 Vthis_original_command
= Qnil
;
1528 /* Read next key sequence; i gets its length. */
1529 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1532 /* A filter may have run while we were reading the input. */
1533 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1535 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1536 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1540 /* Now we have read a key sequence of length I,
1541 or else I is 0 and we found end of file. */
1543 if (i
== 0) /* End of file -- happens only in */
1544 return Qnil
; /* a kbd macro, at the end. */
1545 /* -1 means read_key_sequence got a menu that was rejected.
1546 Just loop around and read another command. */
1550 this_command_key_count
= 0;
1551 this_command_key_count_reset
= 0;
1552 this_single_command_key_start
= 0;
1556 last_command_char
= keybuf
[i
- 1];
1558 /* If the previous command tried to force a specific window-start,
1559 forget about that, in case this command moves point far away
1560 from that position. But also throw away beg_unchanged and
1561 end_unchanged information in that case, so that redisplay will
1562 update the whole window properly. */
1563 if (!NILP (XWINDOW (selected_window
)->force_start
))
1566 XWINDOW (selected_window
)->force_start
= Qnil
;
1567 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1568 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1571 cmd
= read_key_sequence_cmd
;
1572 if (!NILP (Vexecuting_kbd_macro
))
1574 if (!NILP (Vquit_flag
))
1576 Vexecuting_kbd_macro
= Qt
;
1577 QUIT
; /* Make some noise. */
1578 /* Will return since macro now empty. */
1582 /* Do redisplay processing after this command except in special
1583 cases identified below. */
1584 prev_buffer
= current_buffer
;
1585 prev_modiff
= MODIFF
;
1586 last_point_position
= PT
;
1587 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1589 /* By default, we adjust point to a boundary of a region that
1590 has such a property that should be treated intangible
1591 (e.g. composition, display). But, some commands will set
1592 this variable differently. */
1593 Vdisable_point_adjustment
= Qnil
;
1595 /* Process filters and timers may have messed with deactivate-mark.
1596 reset it before we execute the command. */
1597 Vdeactivate_mark
= Qnil
;
1599 /* Remap command through active keymaps */
1600 Vthis_original_command
= cmd
;
1604 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1608 /* Execute the command. */
1610 Vthis_command
= cmd
;
1611 real_this_command
= cmd
;
1612 /* Note that the value cell will never directly contain nil
1613 if the symbol is a local variable. */
1614 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1615 safe_run_hooks (Qpre_command_hook
);
1617 already_adjusted
= 0;
1619 if (NILP (Vthis_command
))
1621 /* nil means key is undefined. */
1622 Lisp_Object keys
= Fvector (i
, keybuf
);
1623 keys
= Fkey_description (keys
, Qnil
);
1625 message_with_string ("%s is undefined", keys
, 0);
1626 current_kboard
->defining_kbd_macro
= Qnil
;
1627 update_mode_lines
= 1;
1628 current_kboard
->Vprefix_arg
= Qnil
;
1632 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1634 /* In case we jump to directly_done. */
1635 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1637 /* Recognize some common commands in common situations and
1638 do them directly. */
1639 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1641 struct Lisp_Char_Table
*dp
1642 = window_display_table (XWINDOW (selected_window
));
1643 lose
= FETCH_CHAR (PT_BYTE
);
1645 if (! NILP (Vpost_command_hook
))
1646 /* Put this before calling adjust_point_for_property
1647 so it will only get called once in any case. */
1649 if (current_buffer
== prev_buffer
1650 && last_point_position
!= PT
1651 && NILP (Vdisable_point_adjustment
)
1652 && NILP (Vglobal_disable_point_adjustment
))
1653 adjust_point_for_property (last_point_position
, 0);
1654 already_adjusted
= 1;
1655 if (PT
== last_point_position
+ 1
1657 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1658 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1659 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1660 && (lose
>= 0x20 && lose
< 0x7f)))
1661 : (lose
>= 0x20 && lose
< 0x7f))
1662 /* To extract the case of continuation on
1663 wide-column characters. */
1664 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1665 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1667 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1669 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1671 && !windows_or_buffers_changed
1672 && EQ (current_buffer
->selective_display
, Qnil
)
1673 && !detect_input_pending ()
1674 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1675 && NILP (Vexecuting_kbd_macro
))
1676 direct_output_forward_char (1);
1679 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1681 struct Lisp_Char_Table
*dp
1682 = window_display_table (XWINDOW (selected_window
));
1684 lose
= FETCH_CHAR (PT_BYTE
);
1685 if (! NILP (Vpost_command_hook
))
1687 if (current_buffer
== prev_buffer
1688 && last_point_position
!= PT
1689 && NILP (Vdisable_point_adjustment
)
1690 && NILP (Vglobal_disable_point_adjustment
))
1691 adjust_point_for_property (last_point_position
, 0);
1692 already_adjusted
= 1;
1693 if (PT
== last_point_position
- 1
1695 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1696 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1697 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1698 && (lose
>= 0x20 && lose
< 0x7f)))
1699 : (lose
>= 0x20 && lose
< 0x7f))
1700 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1702 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1704 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1706 && !windows_or_buffers_changed
1707 && EQ (current_buffer
->selective_display
, Qnil
)
1708 && !detect_input_pending ()
1709 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1710 && NILP (Vexecuting_kbd_macro
))
1711 direct_output_forward_char (-1);
1714 else if (EQ (Vthis_command
, Qself_insert_command
)
1715 /* Try this optimization only on char keystrokes. */
1716 && NATNUMP (last_command_char
)
1717 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1720 = translate_char (Vtranslation_table_for_input
,
1721 XFASTINT (last_command_char
), 0, 0, 0);
1723 if (NILP (Vexecuting_kbd_macro
)
1724 && !EQ (minibuf_window
, selected_window
))
1726 if (!nonundocount
|| nonundocount
>= 20)
1734 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1736 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1738 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1740 || MODIFF
<= SAVE_MODIFF
1741 || windows_or_buffers_changed
1742 || !EQ (current_buffer
->selective_display
, Qnil
)
1743 || detect_input_pending ()
1744 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1745 || !NILP (Vexecuting_kbd_macro
));
1747 value
= internal_self_insert (c
, 0);
1752 if (! NILP (Vpost_command_hook
))
1753 /* Put this before calling adjust_point_for_property
1754 so it will only get called once in any case. */
1757 /* VALUE == 1 when AFTER-CHANGE functions are
1758 installed which is the case most of the time
1759 because FONT-LOCK installs one. */
1760 if (!lose
&& !value
)
1761 direct_output_for_insert (c
);
1766 /* Here for a command that isn't executed directly */
1769 #ifdef HAVE_X_WINDOWS
1770 int scount
= SPECPDL_INDEX ();
1772 if (display_hourglass_p
1773 && NILP (Vexecuting_kbd_macro
))
1775 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1781 if (NILP (current_kboard
->Vprefix_arg
))
1783 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1785 #ifdef HAVE_X_WINDOWS
1786 /* Do not check display_hourglass_p here, because
1787 Fcommand_execute could change it, but we should cancel
1788 hourglass cursor anyway.
1789 But don't cancel the hourglass within a macro
1790 just because a command in the macro finishes. */
1791 if (NILP (Vexecuting_kbd_macro
))
1792 unbind_to (scount
, Qnil
);
1797 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1799 /* Note that the value cell will never directly contain nil
1800 if the symbol is a local variable. */
1801 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1802 safe_run_hooks (Qpost_command_hook
);
1804 /* If displaying a message, resize the echo area window to fit
1805 that message's size exactly. */
1806 if (!NILP (echo_area_buffer
[0]))
1807 resize_echo_area_exactly ();
1809 if (!NILP (Vdeferred_action_list
))
1810 safe_run_hooks (Qdeferred_action_function
);
1812 /* If there is a prefix argument,
1813 1) We don't want Vlast_command to be ``universal-argument''
1814 (that would be dumb), so don't set Vlast_command,
1815 2) we want to leave echoing on so that the prefix will be
1816 echoed as part of this key sequence, so don't call
1818 3) we want to leave this_command_key_count non-zero, so that
1819 read_char will realize that it is re-reading a character, and
1820 not echo it a second time.
1822 If the command didn't actually create a prefix arg,
1823 but is merely a frame event that is transparent to prefix args,
1824 then the above doesn't apply. */
1825 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1827 current_kboard
->Vlast_command
= Vthis_command
;
1828 current_kboard
->Vreal_last_command
= real_this_command
;
1830 this_command_key_count
= 0;
1831 this_command_key_count_reset
= 0;
1832 this_single_command_key_start
= 0;
1835 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1837 /* Setting transient-mark-mode to `only' is a way of
1838 turning it on for just one command. */
1840 if (EQ (Vtransient_mark_mode
, Qidentity
))
1841 Vtransient_mark_mode
= Qnil
;
1842 if (EQ (Vtransient_mark_mode
, Qonly
))
1843 Vtransient_mark_mode
= Qidentity
;
1845 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1847 /* We could also call `deactivate'mark'. */
1848 if (EQ (Vtransient_mark_mode
, Qlambda
))
1849 Vtransient_mark_mode
= Qnil
;
1852 current_buffer
->mark_active
= Qnil
;
1853 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1856 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1857 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1862 if (current_buffer
== prev_buffer
1863 && last_point_position
!= PT
1864 && NILP (Vdisable_point_adjustment
)
1865 && NILP (Vglobal_disable_point_adjustment
)
1866 && !already_adjusted
)
1867 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1869 /* Install chars successfully executed in kbd macro. */
1871 if (!NILP (current_kboard
->defining_kbd_macro
)
1872 && NILP (current_kboard
->Vprefix_arg
))
1873 finalize_kbd_macro_chars ();
1877 any_kboard_state ();
1882 extern Lisp_Object Qcomposition
, Qdisplay
;
1884 /* Adjust point to a boundary of a region that has such a property
1885 that should be treated intangible. For the moment, we check
1886 `composition', `display' and `invisible' properties.
1887 LAST_PT is the last position of point. */
1889 extern Lisp_Object Qafter_string
, Qbefore_string
;
1890 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1893 adjust_point_for_property (last_pt
, modified
)
1898 Lisp_Object val
, overlay
, tmp
;
1899 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1902 /* FIXME: cycling is probably not necessary because these properties
1903 can't be usefully combined anyway. */
1904 while (check_composition
|| check_display
|| check_invisible
)
1906 if (check_composition
1907 && PT
> BEGV
&& PT
< ZV
1908 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1909 && COMPOSITION_VALID_P (beg
, end
, val
)
1910 && beg
< PT
/* && end > PT <- It's always the case. */
1911 && (last_pt
<= beg
|| last_pt
>= end
))
1914 SET_PT (PT
< last_pt
? beg
: end
);
1915 check_display
= check_invisible
= 1;
1917 check_composition
= 0;
1919 && PT
> BEGV
&& PT
< ZV
1920 && !NILP (val
= get_char_property_and_overlay
1921 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1922 && display_prop_intangible_p (val
)
1923 && (!OVERLAYP (overlay
)
1924 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1925 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1926 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1927 && (beg
< PT
/* && end > PT <- It's always the case. */
1928 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1931 SET_PT (PT
< last_pt
1932 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1934 check_composition
= check_invisible
= 1;
1937 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1939 int inv
, ellipsis
= 0;
1942 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1944 && !NILP (val
= get_char_property_and_overlay
1945 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1946 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1948 ellipsis
= ellipsis
|| inv
> 1
1949 || (OVERLAYP (overlay
)
1950 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1951 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1952 tmp
= Fnext_single_char_property_change
1953 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1954 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1957 && !NILP (val
= get_char_property_and_overlay
1958 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1959 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1961 ellipsis
= ellipsis
|| inv
> 1
1962 || (OVERLAYP (overlay
)
1963 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1964 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1965 tmp
= Fprevious_single_char_property_change
1966 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1967 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1970 /* Move away from the inside area. */
1971 if (beg
< PT
&& end
> PT
)
1973 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1974 /* We haven't moved yet (so we don't need to fear
1975 infinite-looping) and we were outside the range
1976 before (so either end of the range still corresponds
1977 to a move in the right direction): pretend we moved
1978 less than we actually did, so that we still have
1979 more freedom below in choosing which end of the range
1981 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1982 /* We either have moved already or the last point
1983 was already in the range: we don't get to choose
1984 which end of the range we have to go to. */
1985 : (PT
< last_pt
? beg
: end
));
1986 check_composition
= check_display
= 1;
1988 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1989 the point to something other than its argument, due to
1990 point-motion hooks, intangibility, etc. */
1991 xassert (PT
== beg
|| PT
== end
);
1994 /* Pretend the area doesn't exist if the buffer is not
1996 if (!modified
&& !ellipsis
&& beg
< end
)
1998 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1999 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2000 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2001 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2002 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2003 /* We've already moved as far as we can. Trying to go
2004 to the other end would mean moving backwards and thus
2005 could lead to an infinite loop. */
2007 else if (val
= get_pos_property (make_number (PT
),
2009 TEXT_PROP_MEANS_INVISIBLE (val
)
2010 && (val
= get_pos_property
2011 (make_number (PT
== beg
? end
: beg
),
2013 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2014 (check_composition
= check_display
= 1,
2015 SET_PT (PT
== beg
? end
: beg
));
2018 check_invisible
= 0;
2022 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2025 safe_run_hooks_1 (hook
)
2028 return call1 (Vrun_hooks
, Vinhibit_quit
);
2031 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2034 safe_run_hooks_error (data
)
2037 Lisp_Object args
[3];
2038 args
[0] = build_string ("Error in %s: %s");
2039 args
[1] = Vinhibit_quit
;
2042 return Fset (Vinhibit_quit
, Qnil
);
2045 /* If we get an error while running the hook, cause the hook variable
2046 to be nil. Also inhibit quits, so that C-g won't cause the hook
2047 to mysteriously evaporate. */
2050 safe_run_hooks (hook
)
2053 int count
= SPECPDL_INDEX ();
2054 specbind (Qinhibit_quit
, hook
);
2056 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2058 unbind_to (count
, Qnil
);
2062 /* Number of seconds between polling for input. This is a Lisp
2063 variable that can be bound. */
2065 EMACS_INT polling_period
;
2067 /* Nonzero means polling for input is temporarily suppressed. */
2069 int poll_suppress_count
;
2071 /* Asynchronous timer for polling. */
2073 struct atimer
*poll_timer
;
2076 #ifdef POLL_FOR_INPUT
2078 /* Poll for input, so what we catch a C-g if it comes in. This
2079 function is called from x_make_frame_visible, see comment
2085 if (interrupt_input_blocked
== 0
2086 && !waiting_for_input
)
2087 read_avail_input (0);
2090 /* Timer callback function for poll_timer. TIMER is equal to
2094 poll_for_input (timer
)
2095 struct atimer
*timer
;
2097 if (poll_suppress_count
== 0)
2099 interrupt_input_pending
= 1;
2101 poll_for_input_1 ();
2105 #endif /* POLL_FOR_INPUT */
2107 /* Begin signals to poll for input, if they are appropriate.
2108 This function is called unconditionally from various places. */
2113 #ifdef POLL_FOR_INPUT
2114 /* XXX This condition was (read_socket_hook && !interrupt_input),
2115 but read_socket_hook is not global anymore. Let's pretend that
2117 if (!interrupt_input
)
2119 /* Turn alarm handling on unconditionally. It might have
2120 been turned off in process.c. */
2121 turn_on_atimers (1);
2123 /* If poll timer doesn't exist, are we need one with
2124 a different interval, start a new one. */
2125 if (poll_timer
== NULL
2126 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2128 EMACS_TIME interval
;
2131 cancel_atimer (poll_timer
);
2133 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2134 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2135 poll_for_input
, NULL
);
2138 /* Let the timer's callback function poll for input
2139 if this becomes zero. */
2140 --poll_suppress_count
;
2145 /* Nonzero if we are using polling to handle input asynchronously. */
2148 input_polling_used ()
2150 #ifdef POLL_FOR_INPUT
2151 /* XXX This condition was (read_socket_hook && !interrupt_input),
2152 but read_socket_hook is not global anymore. Let's pretend that
2154 return !interrupt_input
;
2160 /* Turn off polling. */
2165 #ifdef POLL_FOR_INPUT
2166 /* XXX This condition was (read_socket_hook && !interrupt_input),
2167 but read_socket_hook is not global anymore. Let's pretend that
2169 if (!interrupt_input
)
2170 ++poll_suppress_count
;
2174 /* Set the value of poll_suppress_count to COUNT
2175 and start or stop polling accordingly. */
2178 set_poll_suppress_count (count
)
2181 #ifdef POLL_FOR_INPUT
2182 if (count
== 0 && poll_suppress_count
!= 0)
2184 poll_suppress_count
= 1;
2187 else if (count
!= 0 && poll_suppress_count
== 0)
2191 poll_suppress_count
= count
;
2195 /* Bind polling_period to a value at least N.
2196 But don't decrease it. */
2199 bind_polling_period (n
)
2202 #ifdef POLL_FOR_INPUT
2203 int new = polling_period
;
2208 stop_other_atimers (poll_timer
);
2210 specbind (Qpolling_period
, make_number (new));
2211 /* Start a new alarm with the new period. */
2216 /* Apply the control modifier to CHARACTER. */
2222 /* Save the upper bits here. */
2223 int upper
= c
& ~0177;
2227 /* Everything in the columns containing the upper-case letters
2228 denotes a control character. */
2229 if (c
>= 0100 && c
< 0140)
2233 /* Set the shift modifier for a control char
2234 made from a shifted letter. But only for letters! */
2235 if (oc
>= 'A' && oc
<= 'Z')
2236 c
|= shift_modifier
;
2239 /* The lower-case letters denote control characters too. */
2240 else if (c
>= 'a' && c
<= 'z')
2243 /* Include the bits for control and shift
2244 only if the basic ASCII code can't indicate them. */
2248 /* Replace the high bits. */
2249 c
|= (upper
& ~ctrl_modifier
);
2254 /* Display the help-echo property of the character after the mouse pointer.
2255 Either show it in the echo area, or call show-help-function to display
2256 it by other means (maybe in a tooltip).
2258 If HELP is nil, that means clear the previous help echo.
2260 If HELP is a string, display that string. If HELP is a function,
2261 call it with OBJECT and POS as arguments; the function should
2262 return a help string or nil for none. For all other types of HELP,
2263 evaluate it to obtain a string.
2265 WINDOW is the window in which the help was generated, if any.
2266 It is nil if not in a window.
2268 If OBJECT is a buffer, POS is the position in the buffer where the
2269 `help-echo' text property was found.
2271 If OBJECT is an overlay, that overlay has a `help-echo' property,
2272 and POS is the position in the overlay's buffer under the mouse.
2274 If OBJECT is a string (an overlay string or a string displayed with
2275 the `display' property). POS is the position in that string under
2278 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2279 echo overwrites a keystroke echo currently displayed in the echo
2282 Note: this function may only be called with HELP nil or a string
2283 from X code running asynchronously. */
2286 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2287 Lisp_Object help
, window
, object
, pos
;
2288 int ok_to_overwrite_keystroke_echo
;
2290 if (!NILP (help
) && !STRINGP (help
))
2292 if (FUNCTIONP (help
))
2294 Lisp_Object args
[4];
2299 help
= safe_call (4, args
);
2302 help
= safe_eval (help
);
2304 if (!STRINGP (help
))
2309 if (!noninteractive
&& STRINGP (help
))
2310 help
= call1 (Qmouse_fixup_help_message
, help
);
2313 if (STRINGP (help
) || NILP (help
))
2315 if (!NILP (Vshow_help_function
))
2316 call1 (Vshow_help_function
, help
);
2317 else if (/* Don't overwrite minibuffer contents. */
2318 !MINI_WINDOW_P (XWINDOW (selected_window
))
2319 /* Don't overwrite a keystroke echo. */
2320 && (NILP (echo_message_buffer
)
2321 || ok_to_overwrite_keystroke_echo
)
2322 /* Don't overwrite a prompt. */
2323 && !cursor_in_echo_area
)
2327 int count
= SPECPDL_INDEX ();
2329 if (!help_echo_showing_p
)
2330 Vpre_help_message
= current_message ();
2332 specbind (Qmessage_truncate_lines
, Qt
);
2333 message3_nolog (help
, SBYTES (help
),
2334 STRING_MULTIBYTE (help
));
2335 unbind_to (count
, Qnil
);
2337 else if (STRINGP (Vpre_help_message
))
2339 message3_nolog (Vpre_help_message
,
2340 SBYTES (Vpre_help_message
),
2341 STRING_MULTIBYTE (Vpre_help_message
));
2342 Vpre_help_message
= Qnil
;
2348 help_echo_showing_p
= STRINGP (help
);
2354 /* Input of single characters from keyboard */
2356 Lisp_Object
print_help ();
2357 static Lisp_Object
kbd_buffer_get_event ();
2358 static void record_char ();
2361 static jmp_buf wrong_kboard_jmpbuf
;
2364 #define STOP_POLLING \
2365 do { if (! polling_stopped_here) stop_polling (); \
2366 polling_stopped_here = 1; } while (0)
2368 #define RESUME_POLLING \
2369 do { if (polling_stopped_here) start_polling (); \
2370 polling_stopped_here = 0; } while (0)
2372 /* read a character from the keyboard; call the redisplay if needed */
2373 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2374 -1 means do not do redisplay, but do do autosaving.
2377 /* The arguments MAPS and NMAPS are for menu prompting.
2378 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2380 PREV_EVENT is the previous input event, or nil if we are reading
2381 the first event of a key sequence (or not reading a key sequence).
2382 If PREV_EVENT is t, that is a "magic" value that says
2383 not to run input methods, but in other respects to act as if
2384 not reading a key sequence.
2386 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2387 if we used a mouse menu to read the input, or zero otherwise. If
2388 USED_MOUSE_MENU is null, we don't dereference it.
2390 Value is t if we showed a menu and the user rejected it. */
2393 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2397 Lisp_Object prev_event
;
2398 int *used_mouse_menu
;
2400 volatile Lisp_Object c
;
2402 jmp_buf local_getcjmp
;
2404 volatile int key_already_recorded
= 0;
2405 Lisp_Object tem
, save
;
2406 volatile Lisp_Object previous_echo_area_message
;
2407 volatile Lisp_Object also_record
;
2408 volatile int reread
;
2409 struct gcpro gcpro1
, gcpro2
;
2410 int polling_stopped_here
= 0;
2414 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2415 before_command_key_count
= this_command_key_count
;
2416 before_command_echo_length
= echo_length ();
2419 previous_echo_area_message
= Qnil
;
2421 GCPRO2 (c
, previous_echo_area_message
);
2426 if (CONSP (Vunread_post_input_method_events
))
2428 c
= XCAR (Vunread_post_input_method_events
);
2429 Vunread_post_input_method_events
2430 = XCDR (Vunread_post_input_method_events
);
2432 /* Undo what read_char_x_menu_prompt did when it unread
2433 additional keys returned by Fx_popup_menu. */
2435 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2443 if (unread_command_char
!= -1)
2445 XSETINT (c
, unread_command_char
);
2446 unread_command_char
= -1;
2452 if (CONSP (Vunread_command_events
))
2454 c
= XCAR (Vunread_command_events
);
2455 Vunread_command_events
= XCDR (Vunread_command_events
);
2457 /* Undo what read_char_x_menu_prompt did when it unread
2458 additional keys returned by Fx_popup_menu. */
2460 && EQ (XCDR (c
), Qdisabled
)
2461 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2464 /* If the queued event is something that used the mouse,
2465 set used_mouse_menu accordingly. */
2467 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2468 *used_mouse_menu
= 1;
2471 goto reread_for_input_method
;
2474 if (CONSP (Vunread_input_method_events
))
2476 c
= XCAR (Vunread_input_method_events
);
2477 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2479 /* Undo what read_char_x_menu_prompt did when it unread
2480 additional keys returned by Fx_popup_menu. */
2482 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2486 goto reread_for_input_method
;
2489 this_command_key_count_reset
= 0;
2491 if (!NILP (Vexecuting_kbd_macro
))
2493 /* We set this to Qmacro; since that's not a frame, nobody will
2494 try to switch frames on us, and the selected window will
2497 Since this event came from a macro, it would be misleading to
2498 leave internal_last_event_frame set to wherever the last
2499 real event came from. Normally, a switch-frame event selects
2500 internal_last_event_frame after each command is read, but
2501 events read from a macro should never cause a new frame to be
2503 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2505 /* Exit the macro if we are at the end.
2506 Also, some things replace the macro with t
2507 to force an early exit. */
2508 if (EQ (Vexecuting_kbd_macro
, Qt
)
2509 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2515 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2516 if (STRINGP (Vexecuting_kbd_macro
)
2517 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2518 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2520 executing_kbd_macro_index
++;
2525 if (!NILP (unread_switch_frame
))
2527 c
= unread_switch_frame
;
2528 unread_switch_frame
= Qnil
;
2530 /* This event should make it into this_command_keys, and get echoed
2531 again, so we do not set `reread'. */
2535 /* if redisplay was requested */
2536 if (commandflag
>= 0)
2538 /* If there is pending input, process any events which are not
2539 user-visible, such as X selection_request events. */
2541 || detect_input_pending_run_timers (0))
2542 swallow_events (0); /* may clear input_pending */
2544 /* Redisplay if no pending input. */
2545 while (!input_pending
)
2547 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2548 redisplay_preserve_echo_area (5);
2553 /* Normal case: no input arrived during redisplay. */
2556 /* Input arrived and pre-empted redisplay.
2557 Process any events which are not user-visible. */
2559 /* If that cleared input_pending, try again to redisplay. */
2563 /* Message turns off echoing unless more keystrokes turn it on again.
2565 The code in 20.x for the condition was
2567 1. echo_area_glyphs && *echo_area_glyphs
2568 2. && echo_area_glyphs != current_kboard->echobuf
2569 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2571 (1) means there's a current message displayed
2573 (2) means it's not the message from echoing from the current
2576 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2577 is set to a non-null value. This is done in read_char and it is
2578 set to echo_area_glyphs after a call to echo_char. That means
2579 ok_to_echo_at_next_pause is either null or
2580 current_kboard->echobuf with the appropriate current_kboard at
2583 So, condition (3) means in clear text ok_to_echo_at_next_pause
2584 must be either null, or the current message isn't from echoing at
2585 all, or it's from echoing from a different kboard than the
2588 if (/* There currently is something in the echo area. */
2589 !NILP (echo_area_buffer
[0])
2590 && (/* And it's either not from echoing. */
2591 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2592 /* Or it's an echo from a different kboard. */
2593 || echo_kboard
!= current_kboard
2594 /* Or we explicitly allow overwriting whatever there is. */
2595 || ok_to_echo_at_next_pause
== NULL
))
2600 /* Try reading a character via menu prompting in the minibuf.
2601 Try this before the sit-for, because the sit-for
2602 would do the wrong thing if we are supposed to do
2603 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2604 after a mouse event so don't try a minibuf menu. */
2606 if (nmaps
> 0 && INTERACTIVE
2607 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2608 /* Don't bring up a menu if we already have another event. */
2609 && NILP (Vunread_command_events
)
2610 && unread_command_char
< 0
2611 && !detect_input_pending_run_timers (0))
2613 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2616 key_already_recorded
= 1;
2621 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2622 We will do that below, temporarily for short sections of code,
2623 when appropriate. local_getcjmp must be in effect
2624 around any call to sit_for or kbd_buffer_get_event;
2625 it *must not* be in effect when we call redisplay. */
2627 if (_setjmp (local_getcjmp
))
2629 /* We must have saved the outer value of getcjmp here,
2630 so restore it now. */
2631 restore_getcjmp (save_jump
);
2632 XSETINT (c
, quit_char
);
2633 internal_last_event_frame
= selected_frame
;
2634 Vlast_event_frame
= internal_last_event_frame
;
2635 /* If we report the quit char as an event,
2636 don't do so more than once. */
2637 if (!NILP (Vinhibit_quit
))
2642 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2643 if (kb
!= current_kboard
)
2645 Lisp_Object link
= kb
->kbd_queue
;
2646 /* We shouldn't get here if we were in single-kboard mode! */
2651 while (CONSP (XCDR (link
)))
2653 if (!NILP (XCDR (link
)))
2657 kb
->kbd_queue
= Fcons (c
, Qnil
);
2659 XSETCDR (link
, Fcons (c
, Qnil
));
2660 kb
->kbd_queue_has_data
= 1;
2661 current_kboard
= kb
;
2662 /* This is going to exit from read_char
2663 so we had better get rid of this frame's stuff. */
2665 longjmp (wrong_kboard_jmpbuf
, 1);
2672 timer_start_idle ();
2674 /* If in middle of key sequence and minibuffer not active,
2675 start echoing if enough time elapses. */
2677 if (minibuf_level
== 0
2678 && !current_kboard
->immediate_echo
2679 && this_command_key_count
> 0
2681 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2682 && NILP (Fzerop (Vecho_keystrokes
))
2683 && (/* No message. */
2684 NILP (echo_area_buffer
[0])
2685 /* Or empty message. */
2686 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2687 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2688 /* Or already echoing from same kboard. */
2689 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2690 /* Or not echoing before and echoing allowed. */
2691 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2695 /* After a mouse event, start echoing right away.
2696 This is because we are probably about to display a menu,
2697 and we don't want to delay before doing so. */
2698 if (EVENT_HAS_PARAMETERS (prev_event
))
2703 double duration
= extract_float (Vecho_keystrokes
);
2704 sec
= (int) duration
;
2705 usec
= (duration
- sec
) * 1000000;
2706 save_getcjmp (save_jump
);
2707 restore_getcjmp (local_getcjmp
);
2708 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2709 restore_getcjmp (save_jump
);
2711 && ! CONSP (Vunread_command_events
))
2716 /* Maybe auto save due to number of keystrokes. */
2718 if (commandflag
!= 0
2719 && auto_save_interval
> 0
2720 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2721 && !detect_input_pending_run_timers (0))
2723 Fdo_auto_save (Qnil
, Qnil
);
2724 /* Hooks can actually change some buffers in auto save. */
2728 /* Try reading using an X menu.
2729 This is never confused with reading using the minibuf
2730 because the recursive call of read_char in read_char_minibuf_menu_prompt
2731 does not pass on any keymaps. */
2733 if (nmaps
> 0 && INTERACTIVE
2734 && !NILP (prev_event
)
2735 && EVENT_HAS_PARAMETERS (prev_event
)
2736 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2737 && !EQ (XCAR (prev_event
), Qtool_bar
)
2738 /* Don't bring up a menu if we already have another event. */
2739 && NILP (Vunread_command_events
)
2740 && unread_command_char
< 0)
2742 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2744 /* Now that we have read an event, Emacs is not idle. */
2750 /* Maybe autosave and/or garbage collect due to idleness. */
2752 if (INTERACTIVE
&& NILP (c
))
2754 int delay_level
, buffer_size
;
2756 /* Slow down auto saves logarithmically in size of current buffer,
2757 and garbage collect while we're at it. */
2758 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2759 last_non_minibuf_size
= Z
- BEG
;
2760 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2762 while (buffer_size
> 64)
2763 delay_level
++, buffer_size
-= buffer_size
>> 2;
2764 if (delay_level
< 4) delay_level
= 4;
2765 /* delay_level is 4 for files under around 50k, 7 at 100k,
2766 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2768 /* Auto save if enough time goes by without input. */
2769 if (commandflag
!= 0
2770 && num_nonmacro_input_events
> last_auto_save
2771 && INTEGERP (Vauto_save_timeout
)
2772 && XINT (Vauto_save_timeout
) > 0)
2776 save_getcjmp (save_jump
);
2777 restore_getcjmp (local_getcjmp
);
2778 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2780 restore_getcjmp (save_jump
);
2783 && ! CONSP (Vunread_command_events
))
2785 Fdo_auto_save (Qnil
, Qnil
);
2787 /* If we have auto-saved and there is still no input
2788 available, garbage collect if there has been enough
2789 consing going on to make it worthwhile. */
2790 if (!detect_input_pending_run_timers (0)
2791 && consing_since_gc
> gc_cons_threshold
/ 2)
2792 Fgarbage_collect ();
2799 /* If this has become non-nil here, it has been set by a timer
2800 or sentinel or filter. */
2801 if (CONSP (Vunread_command_events
))
2803 c
= XCAR (Vunread_command_events
);
2804 Vunread_command_events
= XCDR (Vunread_command_events
);
2807 /* Read something from current KBOARD's side queue, if possible. */
2811 if (current_kboard
->kbd_queue_has_data
)
2813 if (!CONSP (current_kboard
->kbd_queue
))
2815 c
= XCAR (current_kboard
->kbd_queue
);
2816 current_kboard
->kbd_queue
2817 = XCDR (current_kboard
->kbd_queue
);
2818 if (NILP (current_kboard
->kbd_queue
))
2819 current_kboard
->kbd_queue_has_data
= 0;
2820 input_pending
= readable_events (0);
2821 if (EVENT_HAS_PARAMETERS (c
)
2822 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2823 internal_last_event_frame
= XCAR (XCDR (c
));
2824 Vlast_event_frame
= internal_last_event_frame
;
2829 /* If current_kboard's side queue is empty check the other kboards.
2830 If one of them has data that we have not yet seen here,
2831 switch to it and process the data waiting for it.
2833 Note: if the events queued up for another kboard
2834 have already been seen here, and therefore are not a complete command,
2835 the kbd_queue_has_data field is 0, so we skip that kboard here.
2836 That's to avoid an infinite loop switching between kboards here. */
2837 if (NILP (c
) && !single_kboard
)
2840 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2841 if (kb
->kbd_queue_has_data
)
2843 current_kboard
= kb
;
2844 /* This is going to exit from read_char
2845 so we had better get rid of this frame's stuff. */
2847 longjmp (wrong_kboard_jmpbuf
, 1);
2856 /* Finally, we read from the main queue,
2857 and if that gives us something we can't use yet, we put it on the
2858 appropriate side queue and try again. */
2864 /* Actually read a character, waiting if necessary. */
2865 save_getcjmp (save_jump
);
2866 restore_getcjmp (local_getcjmp
);
2867 timer_start_idle ();
2868 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2869 restore_getcjmp (save_jump
);
2872 if (! NILP (c
) && (kb
!= current_kboard
))
2874 Lisp_Object link
= kb
->kbd_queue
;
2877 while (CONSP (XCDR (link
)))
2879 if (!NILP (XCDR (link
)))
2883 kb
->kbd_queue
= Fcons (c
, Qnil
);
2885 XSETCDR (link
, Fcons (c
, Qnil
));
2886 kb
->kbd_queue_has_data
= 1;
2890 current_kboard
= kb
;
2891 /* This is going to exit from read_char
2892 so we had better get rid of this frame's stuff. */
2894 longjmp (wrong_kboard_jmpbuf
, 1);
2899 /* Terminate Emacs in batch mode if at eof. */
2900 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2901 Fkill_emacs (make_number (1));
2905 /* Add in any extra modifiers, where appropriate. */
2906 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2907 || ((extra_keyboard_modifiers
& 0177) < ' '
2908 && (extra_keyboard_modifiers
& 0177) != 0))
2909 XSETINT (c
, make_ctrl_char (XINT (c
)));
2911 /* Transfer any other modifier bits directly from
2912 extra_keyboard_modifiers to c. Ignore the actual character code
2913 in the low 16 bits of extra_keyboard_modifiers. */
2914 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2924 if (commandflag
>= 0
2925 && !input_pending
&& !detect_input_pending_run_timers (0))
2933 /* Buffer switch events are only for internal wakeups
2934 so don't show them to the user.
2935 Also, don't record a key if we already did. */
2936 if (BUFFERP (c
) || key_already_recorded
)
2939 /* Process special events within read_char
2940 and loop around to read another event. */
2943 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2948 int was_locked
= single_kboard
;
2950 last_input_char
= c
;
2951 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2953 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2954 /* We stopped being idle for this event; undo that. This
2955 prevents automatic window selection (under
2956 mouse_autoselect_window from acting as a real input event, for
2957 example banishing the mouse under mouse-avoidance-mode. */
2958 timer_resume_idle ();
2960 /* Resume allowing input from any kboard, if that was true before. */
2962 any_kboard_state ();
2967 /* Handle things that only apply to characters. */
2970 /* If kbd_buffer_get_event gave us an EOF, return that. */
2974 if ((STRINGP (Vkeyboard_translate_table
)
2975 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
2976 || (VECTORP (Vkeyboard_translate_table
)
2977 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
2978 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
2979 && CHAR_VALID_P (XINT (c
), 0)))
2982 d
= Faref (Vkeyboard_translate_table
, c
);
2983 /* nil in keyboard-translate-table means no translation. */
2989 /* If this event is a mouse click in the menu bar,
2990 return just menu-bar for now. Modify the mouse click event
2991 so we won't do this twice, then queue it up. */
2992 if (EVENT_HAS_PARAMETERS (c
)
2994 && CONSP (EVENT_START (c
))
2995 && CONSP (XCDR (EVENT_START (c
))))
2999 posn
= POSN_POSN (EVENT_START (c
));
3000 /* Handle menu-bar events:
3001 insert the dummy prefix event `menu-bar'. */
3002 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3004 /* Change menu-bar to (menu-bar) as the event "position". */
3005 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3008 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3013 /* Store these characters into recent_keys, the dribble file if any,
3014 and the keyboard macro being defined, if any. */
3016 if (! NILP (also_record
))
3017 record_char (also_record
);
3019 /* Wipe the echo area.
3020 But first, if we are about to use an input method,
3021 save the echo area contents for it to refer to. */
3023 && ! NILP (Vinput_method_function
)
3024 && (unsigned) XINT (c
) >= ' '
3025 && (unsigned) XINT (c
) != 127
3026 && (unsigned) XINT (c
) < 256)
3028 previous_echo_area_message
= Fcurrent_message ();
3029 Vinput_method_previous_message
= previous_echo_area_message
;
3032 /* Now wipe the echo area, except for help events which do their
3033 own stuff with the echo area. */
3035 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3036 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3038 if (!NILP (echo_area_buffer
[0]))
3039 safe_run_hooks (Qecho_area_clear_hook
);
3040 clear_message (1, 0);
3043 reread_for_input_method
:
3045 /* Pass this to the input method, if appropriate. */
3047 && ! NILP (Vinput_method_function
)
3048 /* Don't run the input method within a key sequence,
3049 after the first event of the key sequence. */
3050 && NILP (prev_event
)
3051 && (unsigned) XINT (c
) >= ' '
3052 && (unsigned) XINT (c
) != 127
3053 && (unsigned) XINT (c
) < 256)
3056 int key_count
, key_count_reset
;
3057 struct gcpro gcpro1
;
3058 int count
= SPECPDL_INDEX ();
3060 /* Save the echo status. */
3061 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3062 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3063 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3064 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3067 if (before_command_restore_flag
)
3069 this_command_key_count
= before_command_key_count_1
;
3070 if (this_command_key_count
< this_single_command_key_start
)
3071 this_single_command_key_start
= this_command_key_count
;
3072 echo_truncate (before_command_echo_length_1
);
3073 before_command_restore_flag
= 0;
3077 /* Save the this_command_keys status. */
3078 key_count
= this_command_key_count
;
3079 key_count_reset
= this_command_key_count_reset
;
3082 keys
= Fcopy_sequence (this_command_keys
);
3087 /* Clear out this_command_keys. */
3088 this_command_key_count
= 0;
3089 this_command_key_count_reset
= 0;
3091 /* Now wipe the echo area. */
3092 if (!NILP (echo_area_buffer
[0]))
3093 safe_run_hooks (Qecho_area_clear_hook
);
3094 clear_message (1, 0);
3097 /* If we are not reading a key sequence,
3098 never use the echo area. */
3101 specbind (Qinput_method_use_echo_area
, Qt
);
3104 /* Call the input method. */
3105 tem
= call1 (Vinput_method_function
, c
);
3107 tem
= unbind_to (count
, tem
);
3109 /* Restore the saved echoing state
3110 and this_command_keys state. */
3111 this_command_key_count
= key_count
;
3112 this_command_key_count_reset
= key_count_reset
;
3114 this_command_keys
= keys
;
3117 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3118 current_kboard
->echo_string
= saved_echo_string
;
3119 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3120 if (saved_immediate_echo
)
3125 /* The input method can return no events. */
3128 /* Bring back the previous message, if any. */
3129 if (! NILP (previous_echo_area_message
))
3130 message_with_string ("%s", previous_echo_area_message
, 0);
3133 /* It returned one event or more. */
3135 Vunread_post_input_method_events
3136 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3141 /* Display help if not echoing. */
3142 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3144 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3145 Lisp_Object help
, object
, position
, window
, tem
;
3147 tem
= Fcdr (XCDR (c
));
3150 window
= Fcar (tem
);
3152 object
= Fcar (tem
);
3154 position
= Fcar (tem
);
3156 show_help_echo (help
, window
, object
, position
, 0);
3158 /* We stopped being idle for this event; undo that. */
3159 timer_resume_idle ();
3163 if (! reread
|| this_command_key_count
== 0
3164 || this_command_key_count_reset
)
3167 /* Don't echo mouse motion events. */
3168 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3169 && NILP (Fzerop (Vecho_keystrokes
))
3170 && ! (EVENT_HAS_PARAMETERS (c
)
3171 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3174 if (! NILP (also_record
))
3175 echo_char (also_record
);
3176 /* Once we reread a character, echoing can happen
3177 the next time we pause to read a new one. */
3178 ok_to_echo_at_next_pause
= current_kboard
;
3181 /* Record this character as part of the current key. */
3182 add_command_key (c
);
3183 if (! NILP (also_record
))
3184 add_command_key (also_record
);
3187 last_input_char
= c
;
3190 /* Process the help character specially if enabled */
3191 if (!NILP (Vhelp_form
) && help_char_p (c
))
3194 count
= SPECPDL_INDEX ();
3196 record_unwind_protect (Fset_window_configuration
,
3197 Fcurrent_window_configuration (Qnil
));
3199 tem0
= Feval (Vhelp_form
);
3201 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3205 c
= read_char (0, 0, 0, Qnil
, 0);
3206 while (BUFFERP (c
));
3207 /* Remove the help from the frame */
3208 unbind_to (count
, Qnil
);
3211 if (EQ (c
, make_number (040)))
3215 c
= read_char (0, 0, 0, Qnil
, 0);
3216 while (BUFFERP (c
));
3225 /* Record a key that came from a mouse menu.
3226 Record it for echoing, for this-command-keys, and so on. */
3232 /* Wipe the echo area. */
3233 clear_message (1, 0);
3238 before_command_key_count
= this_command_key_count
;
3239 before_command_echo_length
= echo_length ();
3242 /* Don't echo mouse motion events. */
3243 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3244 && NILP (Fzerop (Vecho_keystrokes
)))
3248 /* Once we reread a character, echoing can happen
3249 the next time we pause to read a new one. */
3250 ok_to_echo_at_next_pause
= 0;
3253 /* Record this character as part of the current key. */
3254 add_command_key (c
);
3256 /* Re-reading in the middle of a command */
3257 last_input_char
= c
;
3261 /* Return 1 if should recognize C as "the help character". */
3269 if (EQ (c
, Vhelp_char
))
3271 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3272 if (EQ (c
, XCAR (tail
)))
3277 /* Record the input event C in various ways. */
3285 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3287 /* To avoid filling recent_keys with help-echo and mouse-movement
3288 events, we filter out repeated help-echo events, only store the
3289 first and last in a series of mouse-movement events, and don't
3290 store repeated help-echo events which are only separated by
3291 mouse-movement events. */
3293 Lisp_Object ev1
, ev2
, ev3
;
3296 if ((ix1
= recent_keys_index
- 1) < 0)
3297 ix1
= NUM_RECENT_KEYS
- 1;
3298 ev1
= AREF (recent_keys
, ix1
);
3300 if ((ix2
= ix1
- 1) < 0)
3301 ix2
= NUM_RECENT_KEYS
- 1;
3302 ev2
= AREF (recent_keys
, ix2
);
3304 if ((ix3
= ix2
- 1) < 0)
3305 ix3
= NUM_RECENT_KEYS
- 1;
3306 ev3
= AREF (recent_keys
, ix3
);
3308 if (EQ (XCAR (c
), Qhelp_echo
))
3310 /* Don't record `help-echo' in recent_keys unless it shows some help
3311 message, and a different help than the previously recorded
3313 Lisp_Object help
, last_help
;
3315 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3316 if (!STRINGP (help
))
3318 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3319 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3321 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3322 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3323 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3325 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3326 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3327 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3328 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3331 else if (EQ (XCAR (c
), Qmouse_movement
))
3333 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3334 So additional mouse movement events replace the last element. */
3335 Lisp_Object last_window
, window
;
3337 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3338 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3339 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3340 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3341 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3343 ASET (recent_keys
, ix1
, c
);
3349 store_kbd_macro_char (c
);
3354 ASET (recent_keys
, recent_keys_index
, c
);
3355 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3356 recent_keys_index
= 0;
3358 else if (recorded
< 0)
3360 /* We need to remove one or two events from recent_keys.
3361 To do this, we simply put nil at those events and move the
3362 recent_keys_index backwards over those events. Usually,
3363 users will never see those nil events, as they will be
3364 overwritten by the command keys entered to see recent_keys
3367 while (recorded
++ < 0 && total_keys
> 0)
3369 if (total_keys
< NUM_RECENT_KEYS
)
3371 if (--recent_keys_index
< 0)
3372 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3373 ASET (recent_keys
, recent_keys_index
, Qnil
);
3377 num_nonmacro_input_events
++;
3379 /* Write c to the dribble file. If c is a lispy event, write
3380 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3381 If you, dear reader, have a better idea, you've got the source. :-) */
3386 if (XUINT (c
) < 0x100)
3387 putc (XINT (c
), dribble
);
3389 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3393 Lisp_Object dribblee
;
3395 /* If it's a structured event, take the event header. */
3396 dribblee
= EVENT_HEAD (c
);
3398 if (SYMBOLP (dribblee
))
3400 putc ('<', dribble
);
3401 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3402 SBYTES (SYMBOL_NAME (dribblee
)),
3404 putc ('>', dribble
);
3416 struct buffer
*old
= current_buffer
;
3417 Fprinc (object
, Qnil
);
3418 set_buffer_internal (XBUFFER (Vstandard_output
));
3419 call0 (intern ("help-mode"));
3420 set_buffer_internal (old
);
3424 /* Copy out or in the info on where C-g should throw to.
3425 This is used when running Lisp code from within get_char,
3426 in case get_char is called recursively.
3427 See read_process_output. */
3433 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3437 restore_getcjmp (temp
)
3440 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3445 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3446 of this function. */
3449 tracking_off (old_value
)
3450 Lisp_Object old_value
;
3452 do_mouse_tracking
= old_value
;
3453 if (NILP (old_value
))
3455 /* Redisplay may have been preempted because there was input
3456 available, and it assumes it will be called again after the
3457 input has been processed. If the only input available was
3458 the sort that we have just disabled, then we need to call
3460 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3462 redisplay_preserve_echo_area (6);
3463 get_input_pending (&input_pending
,
3464 READABLE_EVENTS_DO_TIMERS_NOW
);
3470 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3471 doc
: /* Evaluate BODY with mouse movement events enabled.
3472 Within a `track-mouse' form, mouse motion generates input events that
3473 you can read with `read-event'.
3474 Normally, mouse motion is ignored.
3475 usage: (track-mouse BODY ...) */)
3479 int count
= SPECPDL_INDEX ();
3482 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3484 do_mouse_tracking
= Qt
;
3486 val
= Fprogn (args
);
3487 return unbind_to (count
, val
);
3490 /* If mouse has moved on some frame, return one of those frames.
3491 Return 0 otherwise. */
3496 Lisp_Object tail
, frame
;
3498 FOR_EACH_FRAME (tail
, frame
)
3500 if (XFRAME (frame
)->mouse_moved
)
3501 return XFRAME (frame
);
3507 #endif /* HAVE_MOUSE */
3509 /* Low level keyboard/mouse input.
3510 kbd_buffer_store_event places events in kbd_buffer, and
3511 kbd_buffer_get_event retrieves them. */
3513 /* Return true iff there are any events in the queue that read-char
3514 would return. If this returns false, a read-char would block. */
3516 readable_events (flags
)
3519 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3522 /* If the buffer contains only FOCUS_IN_EVENT events, and
3523 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3524 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3526 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3527 #ifdef USE_TOOLKIT_SCROLL_BARS
3528 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3532 struct input_event
*event
;
3534 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3541 #ifdef USE_TOOLKIT_SCROLL_BARS
3542 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3544 event
->kind
== FOCUS_IN_EVENT
)
3545 #ifdef USE_TOOLKIT_SCROLL_BARS
3546 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3547 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3548 && event
->part
== scroll_bar_handle
3549 && event
->modifiers
== 0)
3554 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3557 while (event
!= kbd_store_ptr
);
3564 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3565 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3570 if (current_kboard
->kbd_queue_has_data
)
3576 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3577 if (kb
->kbd_queue_has_data
)
3583 /* Set this for debugging, to have a way to get out */
3588 event_to_kboard (event
)
3589 struct input_event
*event
;
3592 frame
= event
->frame_or_window
;
3594 frame
= XCAR (frame
);
3595 else if (WINDOWP (frame
))
3596 frame
= WINDOW_FRAME (XWINDOW (frame
));
3598 /* There are still some events that don't set this field.
3599 For now, just ignore the problem.
3600 Also ignore dead frames here. */
3601 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3604 return FRAME_KBOARD (XFRAME (frame
));
3609 Lisp_Object Vthrow_on_input
;
3611 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3614 kbd_buffer_store_event (event
)
3615 register struct input_event
*event
;
3617 kbd_buffer_store_event_hold (event
, 0);
3620 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3622 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3623 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3624 Else, if EVENT is a quit event, store the quit event
3625 in HOLD_QUIT, and return (thus ignoring further events).
3627 This is used in read_avail_input to postpone the processing
3628 of the quit event until all subsequent input events have been
3629 parsed (and discarded).
3633 kbd_buffer_store_event_hold (event
, hold_quit
)
3634 register struct input_event
*event
;
3635 struct input_event
*hold_quit
;
3637 if (event
->kind
== NO_EVENT
)
3640 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3643 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3645 register int c
= event
->code
& 0377;
3647 if (event
->modifiers
& ctrl_modifier
)
3648 c
= make_ctrl_char (c
);
3650 c
|= (event
->modifiers
3651 & (meta_modifier
| alt_modifier
3652 | hyper_modifier
| super_modifier
));
3658 struct input_event
*sp
;
3661 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3662 kb
!= current_kboard
))
3665 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3666 Fcons (make_number (c
), Qnil
));
3667 kb
->kbd_queue_has_data
= 1;
3668 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3670 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3673 if (event_to_kboard (sp
) == kb
)
3675 sp
->kind
= NO_EVENT
;
3676 sp
->frame_or_window
= Qnil
;
3686 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3690 /* If this results in a quit_char being returned to Emacs as
3691 input, set Vlast_event_frame properly. If this doesn't
3692 get returned to Emacs as an event, the next event read
3693 will set Vlast_event_frame again, so this is safe to do. */
3697 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3699 focus
= event
->frame_or_window
;
3700 internal_last_event_frame
= focus
;
3701 Vlast_event_frame
= focus
;
3704 last_event_timestamp
= event
->timestamp
;
3705 handle_interrupt ();
3709 if (c
&& c
== stop_character
)
3715 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3716 Just ignore the second one. */
3717 else if (event
->kind
== BUFFER_SWITCH_EVENT
3718 && kbd_fetch_ptr
!= kbd_store_ptr
3719 && ((kbd_store_ptr
== kbd_buffer
3720 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3721 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3724 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3725 kbd_store_ptr
= kbd_buffer
;
3727 /* Don't let the very last slot in the buffer become full,
3728 since that would make the two pointers equal,
3729 and that is indistinguishable from an empty buffer.
3730 Discard the event if it would fill the last slot. */
3731 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3733 *kbd_store_ptr
= *event
;
3737 /* If we're inside while-no-input, and this event qualifies
3738 as input, set quit-flag to cause an interrupt. */
3739 if (!NILP (Vthrow_on_input
)
3740 && event
->kind
!= FOCUS_IN_EVENT
3741 && event
->kind
!= HELP_EVENT
3742 && event
->kind
!= DEICONIFY_EVENT
)
3744 Vquit_flag
= Vthrow_on_input
;
3745 /* If we're inside a function that wants immediate quits,
3747 if (immediate_quit
&& NILP (Vinhibit_quit
))
3757 /* Put an input event back in the head of the event queue. */
3760 kbd_buffer_unget_event (event
)
3761 register struct input_event
*event
;
3763 if (kbd_fetch_ptr
== kbd_buffer
)
3764 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3766 /* Don't let the very last slot in the buffer become full, */
3767 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3770 *kbd_fetch_ptr
= *event
;
3775 /* Generate HELP_EVENT input_events in BUFP which has room for
3776 SIZE events. If there's not enough room in BUFP, ignore this
3779 HELP is the help form.
3781 FRAME is the frame on which the help is generated. OBJECT is the
3782 Lisp object where the help was found (a buffer, a string, an
3783 overlay, or nil if neither from a string nor from a buffer. POS is
3784 the position within OBJECT where the help was found.
3786 Value is the number of input_events generated. */
3789 gen_help_event (help
, frame
, window
, object
, pos
)
3790 Lisp_Object help
, frame
, object
, window
;
3793 struct input_event event
;
3797 event
.kind
= HELP_EVENT
;
3798 event
.frame_or_window
= frame
;
3800 event
.x
= WINDOWP (window
) ? window
: frame
;
3803 kbd_buffer_store_event (&event
);
3807 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3810 kbd_buffer_store_help_event (frame
, help
)
3811 Lisp_Object frame
, help
;
3813 struct input_event event
;
3815 event
.kind
= HELP_EVENT
;
3816 event
.frame_or_window
= frame
;
3821 kbd_buffer_store_event (&event
);
3825 /* Discard any mouse events in the event buffer by setting them to
3828 discard_mouse_events ()
3830 struct input_event
*sp
;
3831 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3833 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3836 if (sp
->kind
== MOUSE_CLICK_EVENT
3837 || sp
->kind
== WHEEL_EVENT
3839 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3841 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3843 sp
->kind
= NO_EVENT
;
3849 /* Return non-zero if there are any real events waiting in the event
3850 buffer, not counting `NO_EVENT's.
3852 If DISCARD is non-zero, discard NO_EVENT events at the front of
3853 the input queue, possibly leaving the input queue empty if there
3854 are no real input events. */
3857 kbd_buffer_events_waiting (discard
)
3860 struct input_event
*sp
;
3862 for (sp
= kbd_fetch_ptr
;
3863 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3866 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3873 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3877 /* Clear input event EVENT. */
3881 struct input_event
*event
;
3883 event
->kind
= NO_EVENT
;
3887 /* Read one event from the event buffer, waiting if necessary.
3888 The value is a Lisp object representing the event.
3889 The value is nil for an event that should be ignored,
3890 or that was handled here.
3891 We always read and discard one event. */
3894 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3896 int *used_mouse_menu
;
3905 *kbp
= current_kboard
;
3909 /* Wait until there is input available. */
3912 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3915 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3919 /* If the quit flag is set, then read_char will return
3920 quit_char, so that counts as "available input." */
3921 if (!NILP (Vquit_flag
))
3922 quit_throw_to_read_char ();
3924 /* One way or another, wait until input is available; then, if
3925 interrupt handlers have not read it, read it now. */
3928 wait_for_kbd_input ();
3930 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3934 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3937 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3941 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3943 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3944 /* Pass 1 for EXPECT since we just waited to have input. */
3945 read_avail_input (1);
3947 #endif /* not VMS */
3950 if (CONSP (Vunread_command_events
))
3953 first
= XCAR (Vunread_command_events
);
3954 Vunread_command_events
= XCDR (Vunread_command_events
);
3955 *kbp
= current_kboard
;
3959 /* At this point, we know that there is a readable event available
3960 somewhere. If the event queue is empty, then there must be a
3961 mouse movement enabled and available. */
3962 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3964 struct input_event
*event
;
3966 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3970 last_event_timestamp
= event
->timestamp
;
3973 *kbp
= event_to_kboard (event
);
3975 *kbp
= current_kboard
; /* Better than returning null ptr? */
3977 *kbp
= &the_only_kboard
;
3982 /* These two kinds of events get special handling
3983 and don't actually appear to the command loop.
3984 We return nil for them. */
3985 if (event
->kind
== SELECTION_REQUEST_EVENT
3986 || event
->kind
== SELECTION_CLEAR_EVENT
)
3989 struct input_event copy
;
3991 /* Remove it from the buffer before processing it,
3992 since otherwise swallow_events will see it
3993 and process it again. */
3995 kbd_fetch_ptr
= event
+ 1;
3996 input_pending
= readable_events (0);
3997 x_handle_selection_event (©
);
3999 /* We're getting selection request events, but we don't have
4005 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4006 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4008 /* Make an event (delete-frame (FRAME)). */
4009 obj
= Fcons (event
->frame_or_window
, Qnil
);
4010 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4011 kbd_fetch_ptr
= event
+ 1;
4014 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4015 else if (event
->kind
== ICONIFY_EVENT
)
4017 /* Make an event (iconify-frame (FRAME)). */
4018 obj
= Fcons (event
->frame_or_window
, Qnil
);
4019 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4020 kbd_fetch_ptr
= event
+ 1;
4022 else if (event
->kind
== DEICONIFY_EVENT
)
4024 /* Make an event (make-frame-visible (FRAME)). */
4025 obj
= Fcons (event
->frame_or_window
, Qnil
);
4026 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4027 kbd_fetch_ptr
= event
+ 1;
4030 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4032 /* The value doesn't matter here; only the type is tested. */
4033 XSETBUFFER (obj
, current_buffer
);
4034 kbd_fetch_ptr
= event
+ 1;
4036 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4037 || defined (USE_GTK)
4038 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4040 kbd_fetch_ptr
= event
+ 1;
4041 input_pending
= readable_events (0);
4042 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4043 x_activate_menubar (XFRAME (event
->frame_or_window
));
4046 #if defined (WINDOWSNT) || defined (MAC_OS)
4047 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4050 /* Make an event (language-change (KEY_SCRIPT)). */
4051 obj
= Fcons (make_number (event
->code
), Qnil
);
4053 /* Make an event (language-change (FRAME CHARSET LCID)). */
4054 obj
= Fcons (event
->frame_or_window
, Qnil
);
4056 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4057 kbd_fetch_ptr
= event
+ 1;
4060 else if (event
->kind
== SAVE_SESSION_EVENT
)
4062 obj
= Fcons (Qsave_session
, Qnil
);
4063 kbd_fetch_ptr
= event
+ 1;
4065 /* Just discard these, by returning nil.
4066 With MULTI_KBOARD, these events are used as placeholders
4067 when we need to randomly delete events from the queue.
4068 (They shouldn't otherwise be found in the buffer,
4069 but on some machines it appears they do show up
4070 even without MULTI_KBOARD.) */
4071 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4072 mouse events during a popup-menu call. */
4073 else if (event
->kind
== NO_EVENT
)
4074 kbd_fetch_ptr
= event
+ 1;
4075 else if (event
->kind
== HELP_EVENT
)
4077 Lisp_Object object
, position
, help
, frame
, window
;
4079 frame
= event
->frame_or_window
;
4080 object
= event
->arg
;
4081 position
= make_number (event
->code
);
4084 clear_event (event
);
4086 kbd_fetch_ptr
= event
+ 1;
4087 if (!WINDOWP (window
))
4089 obj
= Fcons (Qhelp_echo
,
4090 list5 (frame
, help
, window
, object
, position
));
4092 else if (event
->kind
== FOCUS_IN_EVENT
)
4094 /* Notification of a FocusIn event. The frame receiving the
4095 focus is in event->frame_or_window. Generate a
4096 switch-frame event if necessary. */
4097 Lisp_Object frame
, focus
;
4099 frame
= event
->frame_or_window
;
4100 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4104 if (!EQ (frame
, internal_last_event_frame
)
4105 && !EQ (frame
, selected_frame
))
4106 obj
= make_lispy_switch_frame (frame
);
4107 internal_last_event_frame
= frame
;
4108 kbd_fetch_ptr
= event
+ 1;
4112 /* If this event is on a different frame, return a switch-frame this
4113 time, and leave the event in the queue for next time. */
4117 frame
= event
->frame_or_window
;
4119 frame
= XCAR (frame
);
4120 else if (WINDOWP (frame
))
4121 frame
= WINDOW_FRAME (XWINDOW (frame
));
4123 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4127 if (! EQ (frame
, internal_last_event_frame
)
4128 && !EQ (frame
, selected_frame
))
4129 obj
= make_lispy_switch_frame (frame
);
4130 internal_last_event_frame
= frame
;
4132 /* If we didn't decide to make a switch-frame event, go ahead
4133 and build a real event from the queue entry. */
4137 obj
= make_lispy_event (event
);
4139 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4140 || defined (USE_GTK)
4141 /* If this was a menu selection, then set the flag to inhibit
4142 writing to last_nonmenu_event. Don't do this if the event
4143 we're returning is (menu-bar), though; that indicates the
4144 beginning of the menu sequence, and we might as well leave
4145 that as the `event with parameters' for this selection. */
4147 && !EQ (event
->frame_or_window
, event
->arg
)
4148 && (event
->kind
== MENU_BAR_EVENT
4149 || event
->kind
== TOOL_BAR_EVENT
))
4150 *used_mouse_menu
= 1;
4153 /* Wipe out this event, to catch bugs. */
4154 clear_event (event
);
4155 kbd_fetch_ptr
= event
+ 1;
4160 /* Try generating a mouse motion event. */
4161 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4163 FRAME_PTR f
= some_mouse_moved ();
4164 Lisp_Object bar_window
;
4165 enum scroll_bar_part part
;
4169 *kbp
= current_kboard
;
4170 /* Note that this uses F to determine which display to look at.
4171 If there is no valid info, it does not store anything
4172 so x remains nil. */
4175 /* XXX Can f or mouse_position_hook be NULL here? */
4176 if (f
&& FRAME_DEVICE (f
)->mouse_position_hook
)
4177 (*FRAME_DEVICE (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4178 &part
, &x
, &y
, &time
);
4182 /* Decide if we should generate a switch-frame event. Don't
4183 generate switch-frame events for motion outside of all Emacs
4189 frame
= FRAME_FOCUS_FRAME (f
);
4191 XSETFRAME (frame
, f
);
4193 if (! EQ (frame
, internal_last_event_frame
)
4194 && !EQ (frame
, selected_frame
))
4195 obj
= make_lispy_switch_frame (frame
);
4196 internal_last_event_frame
= frame
;
4199 /* If we didn't decide to make a switch-frame event, go ahead and
4200 return a mouse-motion event. */
4201 if (!NILP (x
) && NILP (obj
))
4202 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4204 #endif /* HAVE_MOUSE */
4206 /* We were promised by the above while loop that there was
4207 something for us to read! */
4210 input_pending
= readable_events (0);
4212 Vlast_event_frame
= internal_last_event_frame
;
4217 /* Process any events that are not user-visible,
4218 then return, without reading any user-visible events. */
4221 swallow_events (do_display
)
4226 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4228 struct input_event
*event
;
4230 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4234 last_event_timestamp
= event
->timestamp
;
4236 /* These two kinds of events get special handling
4237 and don't actually appear to the command loop. */
4238 if (event
->kind
== SELECTION_REQUEST_EVENT
4239 || event
->kind
== SELECTION_CLEAR_EVENT
)
4242 struct input_event copy
;
4244 /* Remove it from the buffer before processing it,
4245 since otherwise swallow_events called recursively could see it
4246 and process it again. */
4248 kbd_fetch_ptr
= event
+ 1;
4249 input_pending
= readable_events (0);
4250 x_handle_selection_event (©
);
4252 /* We're getting selection request events, but we don't have
4261 old_timers_run
= timers_run
;
4262 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4264 if (timers_run
!= old_timers_run
&& do_display
)
4265 redisplay_preserve_echo_area (7);
4268 /* Record the start of when Emacs is idle,
4269 for the sake of running idle-time timers. */
4276 /* If we are already in the idle state, do nothing. */
4277 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4280 EMACS_GET_TIME (timer_idleness_start_time
);
4282 timer_last_idleness_start_time
= timer_idleness_start_time
;
4284 /* Mark all idle-time timers as once again candidates for running. */
4285 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4289 timer
= XCAR (timers
);
4291 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4293 XVECTOR (timer
)->contents
[0] = Qnil
;
4297 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4302 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4305 /* Resume idle timer from last idle start time. */
4308 timer_resume_idle ()
4310 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4313 timer_idleness_start_time
= timer_last_idleness_start_time
;
4316 /* This is only for debugging. */
4317 struct input_event last_timer_event
;
4319 /* Check whether a timer has fired. To prevent larger problems we simply
4320 disregard elements that are not proper timers. Do not make a circular
4321 timer list for the time being.
4323 Returns the number of seconds to wait until the next timer fires. If a
4324 timer is triggering now, return zero seconds.
4325 If no timer is active, return -1 seconds.
4327 If a timer is ripe, we run it, with quitting turned off.
4329 DO_IT_NOW is now ignored. It used to mean that we should
4330 run the timer directly instead of queueing a timer-event.
4331 Now we always run timers directly. */
4334 timer_check (do_it_now
)
4337 EMACS_TIME nexttime
;
4338 EMACS_TIME now
, idleness_now
;
4339 Lisp_Object timers
, idle_timers
, chosen_timer
;
4340 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4342 EMACS_SET_SECS (nexttime
, -1);
4343 EMACS_SET_USECS (nexttime
, -1);
4345 /* Always consider the ordinary timers. */
4346 timers
= Vtimer_list
;
4347 /* Consider the idle timers only if Emacs is idle. */
4348 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4349 idle_timers
= Vtimer_idle_list
;
4352 chosen_timer
= Qnil
;
4353 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4355 if (CONSP (timers
) || CONSP (idle_timers
))
4357 EMACS_GET_TIME (now
);
4358 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4359 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4362 while (CONSP (timers
) || CONSP (idle_timers
))
4364 Lisp_Object
*vector
;
4365 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4366 EMACS_TIME timer_time
, idle_timer_time
;
4367 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4369 /* Skip past invalid timers and timers already handled. */
4372 timer
= XCAR (timers
);
4373 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4375 timers
= XCDR (timers
);
4378 vector
= XVECTOR (timer
)->contents
;
4380 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4381 || !INTEGERP (vector
[3])
4382 || ! NILP (vector
[0]))
4384 timers
= XCDR (timers
);
4388 if (!NILP (idle_timers
))
4390 timer
= XCAR (idle_timers
);
4391 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4393 idle_timers
= XCDR (idle_timers
);
4396 vector
= XVECTOR (timer
)->contents
;
4398 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4399 || !INTEGERP (vector
[3])
4400 || ! NILP (vector
[0]))
4402 idle_timers
= XCDR (idle_timers
);
4407 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4408 based on the next ordinary timer.
4409 TIMER_DIFFERENCE is the distance in time from NOW to when
4410 this timer becomes ripe (negative if it's already ripe). */
4413 timer
= XCAR (timers
);
4414 vector
= XVECTOR (timer
)->contents
;
4415 EMACS_SET_SECS (timer_time
,
4416 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4417 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4418 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4421 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4422 based on the next idle timer. */
4423 if (!NILP (idle_timers
))
4425 idle_timer
= XCAR (idle_timers
);
4426 vector
= XVECTOR (idle_timer
)->contents
;
4427 EMACS_SET_SECS (idle_timer_time
,
4428 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4429 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4430 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4433 /* Decide which timer is the next timer,
4434 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4435 Also step down the list where we found that timer. */
4437 if (! NILP (timers
) && ! NILP (idle_timers
))
4440 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4441 if (EMACS_TIME_NEG_P (temp
))
4443 chosen_timer
= timer
;
4444 timers
= XCDR (timers
);
4445 difference
= timer_difference
;
4449 chosen_timer
= idle_timer
;
4450 idle_timers
= XCDR (idle_timers
);
4451 difference
= idle_timer_difference
;
4454 else if (! NILP (timers
))
4456 chosen_timer
= timer
;
4457 timers
= XCDR (timers
);
4458 difference
= timer_difference
;
4462 chosen_timer
= idle_timer
;
4463 idle_timers
= XCDR (idle_timers
);
4464 difference
= idle_timer_difference
;
4466 vector
= XVECTOR (chosen_timer
)->contents
;
4468 /* If timer is ripe, run it if it hasn't been run. */
4469 if (EMACS_TIME_NEG_P (difference
)
4470 || (EMACS_SECS (difference
) == 0
4471 && EMACS_USECS (difference
) == 0))
4473 if (NILP (vector
[0]))
4475 int was_locked
= single_kboard
;
4476 int count
= SPECPDL_INDEX ();
4477 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4479 /* Mark the timer as triggered to prevent problems if the lisp
4480 code fails to reschedule it right. */
4483 specbind (Qinhibit_quit
, Qt
);
4485 call1 (Qtimer_event_handler
, chosen_timer
);
4486 Vdeactivate_mark
= old_deactivate_mark
;
4488 unbind_to (count
, Qnil
);
4490 /* Resume allowing input from any kboard, if that was true before. */
4492 any_kboard_state ();
4494 /* Since we have handled the event,
4495 we don't need to tell the caller to wake up and do it. */
4499 /* When we encounter a timer that is still waiting,
4500 return the amount of time to wait before it is ripe. */
4507 /* No timers are pending in the future. */
4508 /* Return 0 if we generated an event, and -1 if not. */
4513 /* Caches for modify_event_symbol. */
4514 static Lisp_Object accent_key_syms
;
4515 static Lisp_Object func_key_syms
;
4516 static Lisp_Object mouse_syms
;
4517 static Lisp_Object wheel_syms
;
4518 static Lisp_Object drag_n_drop_syms
;
4520 /* This is a list of keysym codes for special "accent" characters.
4521 It parallels lispy_accent_keys. */
4523 static int lispy_accent_codes
[] =
4525 #ifdef XK_dead_circumflex
4530 #ifdef XK_dead_grave
4535 #ifdef XK_dead_tilde
4540 #ifdef XK_dead_diaeresis
4545 #ifdef XK_dead_macron
4550 #ifdef XK_dead_degree
4555 #ifdef XK_dead_acute
4560 #ifdef XK_dead_cedilla
4565 #ifdef XK_dead_breve
4570 #ifdef XK_dead_ogonek
4575 #ifdef XK_dead_caron
4580 #ifdef XK_dead_doubleacute
4581 XK_dead_doubleacute
,
4585 #ifdef XK_dead_abovedot
4590 #ifdef XK_dead_abovering
4600 #ifdef XK_dead_belowdot
4605 #ifdef XK_dead_voiced_sound
4606 XK_dead_voiced_sound
,
4610 #ifdef XK_dead_semivoiced_sound
4611 XK_dead_semivoiced_sound
,
4627 /* This is a list of Lisp names for special "accent" characters.
4628 It parallels lispy_accent_codes. */
4630 static char *lispy_accent_keys
[] =
4648 "dead-voiced-sound",
4649 "dead-semivoiced-sound",
4655 #define FUNCTION_KEY_OFFSET 0x0
4657 char *lispy_function_keys
[] =
4661 0, /* VK_LBUTTON 0x01 */
4662 0, /* VK_RBUTTON 0x02 */
4663 "cancel", /* VK_CANCEL 0x03 */
4664 0, /* VK_MBUTTON 0x04 */
4666 0, 0, 0, /* 0x05 .. 0x07 */
4668 "backspace", /* VK_BACK 0x08 */
4669 "tab", /* VK_TAB 0x09 */
4671 0, 0, /* 0x0A .. 0x0B */
4673 "clear", /* VK_CLEAR 0x0C */
4674 "return", /* VK_RETURN 0x0D */
4676 0, 0, /* 0x0E .. 0x0F */
4678 0, /* VK_SHIFT 0x10 */
4679 0, /* VK_CONTROL 0x11 */
4680 0, /* VK_MENU 0x12 */
4681 "pause", /* VK_PAUSE 0x13 */
4682 "capslock", /* VK_CAPITAL 0x14 */
4684 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4686 "escape", /* VK_ESCAPE 0x1B */
4688 0, 0, 0, 0, /* 0x1C .. 0x1F */
4690 0, /* VK_SPACE 0x20 */
4691 "prior", /* VK_PRIOR 0x21 */
4692 "next", /* VK_NEXT 0x22 */
4693 "end", /* VK_END 0x23 */
4694 "home", /* VK_HOME 0x24 */
4695 "left", /* VK_LEFT 0x25 */
4696 "up", /* VK_UP 0x26 */
4697 "right", /* VK_RIGHT 0x27 */
4698 "down", /* VK_DOWN 0x28 */
4699 "select", /* VK_SELECT 0x29 */
4700 "print", /* VK_PRINT 0x2A */
4701 "execute", /* VK_EXECUTE 0x2B */
4702 "snapshot", /* VK_SNAPSHOT 0x2C */
4703 "insert", /* VK_INSERT 0x2D */
4704 "delete", /* VK_DELETE 0x2E */
4705 "help", /* VK_HELP 0x2F */
4707 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4709 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4711 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4713 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4715 0, 0, 0, 0, 0, 0, 0, 0, 0,
4716 0, 0, 0, 0, 0, 0, 0, 0, 0,
4717 0, 0, 0, 0, 0, 0, 0, 0,
4719 "lwindow", /* VK_LWIN 0x5B */
4720 "rwindow", /* VK_RWIN 0x5C */
4721 "apps", /* VK_APPS 0x5D */
4723 0, 0, /* 0x5E .. 0x5F */
4725 "kp-0", /* VK_NUMPAD0 0x60 */
4726 "kp-1", /* VK_NUMPAD1 0x61 */
4727 "kp-2", /* VK_NUMPAD2 0x62 */
4728 "kp-3", /* VK_NUMPAD3 0x63 */
4729 "kp-4", /* VK_NUMPAD4 0x64 */
4730 "kp-5", /* VK_NUMPAD5 0x65 */
4731 "kp-6", /* VK_NUMPAD6 0x66 */
4732 "kp-7", /* VK_NUMPAD7 0x67 */
4733 "kp-8", /* VK_NUMPAD8 0x68 */
4734 "kp-9", /* VK_NUMPAD9 0x69 */
4735 "kp-multiply", /* VK_MULTIPLY 0x6A */
4736 "kp-add", /* VK_ADD 0x6B */
4737 "kp-separator", /* VK_SEPARATOR 0x6C */
4738 "kp-subtract", /* VK_SUBTRACT 0x6D */
4739 "kp-decimal", /* VK_DECIMAL 0x6E */
4740 "kp-divide", /* VK_DIVIDE 0x6F */
4741 "f1", /* VK_F1 0x70 */
4742 "f2", /* VK_F2 0x71 */
4743 "f3", /* VK_F3 0x72 */
4744 "f4", /* VK_F4 0x73 */
4745 "f5", /* VK_F5 0x74 */
4746 "f6", /* VK_F6 0x75 */
4747 "f7", /* VK_F7 0x76 */
4748 "f8", /* VK_F8 0x77 */
4749 "f9", /* VK_F9 0x78 */
4750 "f10", /* VK_F10 0x79 */
4751 "f11", /* VK_F11 0x7A */
4752 "f12", /* VK_F12 0x7B */
4753 "f13", /* VK_F13 0x7C */
4754 "f14", /* VK_F14 0x7D */
4755 "f15", /* VK_F15 0x7E */
4756 "f16", /* VK_F16 0x7F */
4757 "f17", /* VK_F17 0x80 */
4758 "f18", /* VK_F18 0x81 */
4759 "f19", /* VK_F19 0x82 */
4760 "f20", /* VK_F20 0x83 */
4761 "f21", /* VK_F21 0x84 */
4762 "f22", /* VK_F22 0x85 */
4763 "f23", /* VK_F23 0x86 */
4764 "f24", /* VK_F24 0x87 */
4766 0, 0, 0, 0, /* 0x88 .. 0x8B */
4767 0, 0, 0, 0, /* 0x8C .. 0x8F */
4769 "kp-numlock", /* VK_NUMLOCK 0x90 */
4770 "scroll", /* VK_SCROLL 0x91 */
4772 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4773 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4774 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4775 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4776 "kp-end", /* VK_NUMPAD_END 0x96 */
4777 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4778 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4779 "kp-up", /* VK_NUMPAD_UP 0x99 */
4780 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4781 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4782 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4783 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4785 0, 0, /* 0x9E .. 0x9F */
4788 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4789 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4790 * No other API or message will distinguish left and right keys this way.
4794 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4795 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4796 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4797 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4798 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4804 "attn", /* VK_ATTN 0xF6 */
4805 "crsel", /* VK_CRSEL 0xF7 */
4806 "exsel", /* VK_EXSEL 0xF8 */
4807 "ereof", /* VK_EREOF 0xF9 */
4808 "play", /* VK_PLAY 0xFA */
4809 "zoom", /* VK_ZOOM 0xFB */
4810 "noname", /* VK_NONAME 0xFC */
4811 "pa1", /* VK_PA1 0xFD */
4812 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4816 #else /* not HAVE_NTGUI */
4818 /* This should be dealt with in XTread_socket now, and that doesn't
4819 depend on the client system having the Kana syms defined. See also
4820 the XK_kana_A case below. */
4823 static char *lispy_kana_keys
[] =
4825 /* X Keysym value */
4826 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4827 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4828 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4829 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4830 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4831 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4832 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4833 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4834 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4835 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4836 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4837 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4838 "kana-i", "kana-u", "kana-e", "kana-o",
4839 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4840 "prolongedsound", "kana-A", "kana-I", "kana-U",
4841 "kana-E", "kana-O", "kana-KA", "kana-KI",
4842 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4843 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4844 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4845 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4846 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4847 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4848 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4849 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4850 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4851 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4852 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4853 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4855 #endif /* XK_kana_A */
4858 #define FUNCTION_KEY_OFFSET 0xff00
4860 /* You'll notice that this table is arranged to be conveniently
4861 indexed by X Windows keysym values. */
4862 static char *lispy_function_keys
[] =
4864 /* X Keysym value */
4866 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4867 "backspace", "tab", "linefeed", "clear",
4869 0, 0, 0, "pause", /* 0xff10...1f */
4870 0, 0, 0, 0, 0, 0, 0, "escape",
4872 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4873 "romaji", "hiragana", "katakana", "hiragana-katakana",
4874 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4875 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4876 "eisu-toggle", /* 0xff30...3f */
4877 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4878 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4880 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4881 "down", "prior", "next", "end",
4882 "begin", 0, 0, 0, 0, 0, 0, 0,
4883 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4894 "break", /* 0xff6b */
4897 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4898 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4899 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4900 0, 0, 0, 0, 0, 0, 0, 0,
4901 "kp-tab", /* 0xff89 */
4903 "kp-enter", /* 0xff8d */
4905 "kp-f1", /* 0xff91 */
4909 "kp-home", /* 0xff95 */
4914 "kp-prior", /* kp-page-up */
4915 "kp-next", /* kp-page-down */
4921 0, 0, 0, 0, 0, 0, 0, 0, 0,
4922 "kp-multiply", /* 0xffaa */
4927 "kp-divide", /* 0xffaf */
4928 "kp-0", /* 0xffb0 */
4929 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4932 "kp-equal", /* 0xffbd */
4933 "f1", /* 0xffbe */ /* IsFunctionKey */
4935 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4936 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4937 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4938 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4939 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4940 0, 0, 0, 0, 0, 0, 0, 0,
4941 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4942 0, 0, 0, 0, 0, 0, 0, "delete"
4945 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4946 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4948 static char *iso_lispy_function_keys
[] =
4950 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4951 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4952 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4953 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4954 "iso-lefttab", /* 0xfe20 */
4955 "iso-move-line-up", "iso-move-line-down",
4956 "iso-partial-line-up", "iso-partial-line-down",
4957 "iso-partial-space-left", "iso-partial-space-right",
4958 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4959 "iso-release-margin-left", "iso-release-margin-right",
4960 "iso-release-both-margins",
4961 "iso-fast-cursor-left", "iso-fast-cursor-right",
4962 "iso-fast-cursor-up", "iso-fast-cursor-down",
4963 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4964 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4967 #endif /* not HAVE_NTGUI */
4969 Lisp_Object Vlispy_mouse_stem
;
4971 static char *lispy_wheel_names
[] =
4973 "wheel-up", "wheel-down"
4976 /* drag-n-drop events are generated when a set of selected files are
4977 dragged from another application and dropped onto an Emacs window. */
4978 static char *lispy_drag_n_drop_names
[] =
4983 /* Scroll bar parts. */
4984 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
4985 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
4986 Lisp_Object Qtop
, Qratio
;
4988 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
4989 Lisp_Object
*scroll_bar_parts
[] = {
4990 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
4991 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
4994 /* User signal events. */
4995 Lisp_Object Qusr1_signal
, Qusr2_signal
;
4997 Lisp_Object
*lispy_user_signals
[] =
4999 &Qusr1_signal
, &Qusr2_signal
5003 /* A vector, indexed by button number, giving the down-going location
5004 of currently depressed buttons, both scroll bar and non-scroll bar.
5006 The elements have the form
5007 (BUTTON-NUMBER MODIFIER-MASK . REST)
5008 where REST is the cdr of a position as it would be reported in the event.
5010 The make_lispy_event function stores positions here to tell the
5011 difference between click and drag events, and to store the starting
5012 location to be included in drag events. */
5014 static Lisp_Object button_down_location
;
5016 /* Information about the most recent up-going button event: Which
5017 button, what location, and what time. */
5019 static int last_mouse_button
;
5020 static int last_mouse_x
;
5021 static int last_mouse_y
;
5022 static unsigned long button_down_time
;
5024 /* The maximum time between clicks to make a double-click, or Qnil to
5025 disable double-click detection, or Qt for no time limit. */
5027 Lisp_Object Vdouble_click_time
;
5029 /* Maximum number of pixels the mouse may be moved between clicks
5030 to make a double-click. */
5032 EMACS_INT double_click_fuzz
;
5034 /* The number of clicks in this multiple-click. */
5036 int double_click_count
;
5038 /* Return position of a mouse click or wheel event */
5041 make_lispy_position (f
, x
, y
, time
)
5047 enum window_part part
;
5048 Lisp_Object posn
= Qnil
;
5049 Lisp_Object extra_info
= Qnil
;
5052 /* Set `window' to the window under frame pixel coordinates (x,y) */
5054 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5055 &part
, &wx
, &wy
, 0);
5059 if (WINDOWP (window
))
5061 /* It's a click in window window at frame coordinates (x,y) */
5062 struct window
*w
= XWINDOW (window
);
5063 Lisp_Object string_info
= Qnil
;
5064 int textpos
= -1, rx
= -1, ry
= -1;
5065 int dx
= -1, dy
= -1;
5066 int width
= -1, height
= -1;
5067 Lisp_Object object
= Qnil
;
5069 /* Set event coordinates to window-relative coordinates
5070 for constructing the Lisp event below. */
5074 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5076 /* Mode line or header line. Look for a string under
5077 the mouse that may have a `local-map' property. */
5081 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5083 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5084 &object
, &dx
, &dy
, &width
, &height
);
5085 if (STRINGP (string
))
5086 string_info
= Fcons (string
, make_number (charpos
));
5087 if (w
== XWINDOW (selected_window
))
5090 textpos
= XMARKER (w
->pointm
)->charpos
;
5092 else if (part
== ON_VERTICAL_BORDER
)
5094 posn
= Qvertical_line
;
5099 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5104 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5106 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5107 &object
, &dx
, &dy
, &width
, &height
);
5108 if (STRINGP (string
))
5109 string_info
= Fcons (string
, make_number (charpos
));
5111 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5113 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5116 if (part
== ON_RIGHT_FRINGE
)
5117 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5118 + window_box_width (w
, TEXT_AREA
)
5119 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5120 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5122 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5123 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5128 Lisp_Object string2
, object2
= Qnil
;
5129 struct display_pos p
;
5131 int width2
, height2
;
5132 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5133 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5134 &object2
, &dx2
, &dy2
,
5136 textpos
= CHARPOS (p
.pos
);
5137 if (rx
< 0) rx
= wx
;
5138 if (ry
< 0) ry
= wy
;
5139 if (dx
< 0) dx
= dx2
;
5140 if (dy
< 0) dy
= dy2
;
5141 if (width
< 0) width
= width2
;
5142 if (height
< 0) height
= height2
;
5146 posn
= make_number (textpos
);
5147 if (STRINGP (string2
))
5148 string_info
= Fcons (string2
,
5149 make_number (CHARPOS (p
.string_pos
)));
5155 #ifdef HAVE_WINDOW_SYSTEM
5156 if (IMAGEP (object
))
5158 Lisp_Object image_map
, hotspot
;
5159 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5161 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5163 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5164 posn
= XCAR (hotspot
);
5169 extra_info
= Fcons (object
,
5170 Fcons (Fcons (make_number (dx
),
5172 Fcons (Fcons (make_number (width
),
5173 make_number (height
)),
5177 extra_info
= Fcons (string_info
,
5178 Fcons (make_number (textpos
),
5179 Fcons (Fcons (make_number (rx
),
5185 XSETFRAME (window
, f
);
5190 XSETFASTINT (*x
, 0);
5191 XSETFASTINT (*y
, 0);
5194 return Fcons (window
,
5196 Fcons (Fcons (*x
, *y
),
5197 Fcons (make_number (time
),
5201 /* Given a struct input_event, build the lisp event which represents
5202 it. If EVENT is 0, build a mouse movement event from the mouse
5203 movement buffer, which should have a movement event in it.
5205 Note that events must be passed to this function in the order they
5206 are received; this function stores the location of button presses
5207 in order to build drag events when the button is released. */
5210 make_lispy_event (event
)
5211 struct input_event
*event
;
5215 switch (SWITCH_ENUM_CAST (event
->kind
))
5217 /* A simple keystroke. */
5218 case ASCII_KEYSTROKE_EVENT
:
5220 Lisp_Object lispy_c
;
5221 int c
= event
->code
& 0377;
5222 /* Turn ASCII characters into control characters
5224 if (event
->modifiers
& ctrl_modifier
)
5225 c
= make_ctrl_char (c
);
5227 /* Add in the other modifier bits. We took care of ctrl_modifier
5228 just above, and the shift key was taken care of by the X code,
5229 and applied to control characters by make_ctrl_char. */
5230 c
|= (event
->modifiers
5231 & (meta_modifier
| alt_modifier
5232 | hyper_modifier
| super_modifier
));
5233 /* Distinguish Shift-SPC from SPC. */
5234 if ((event
->code
& 0377) == 040
5235 && event
->modifiers
& shift_modifier
)
5236 c
|= shift_modifier
;
5237 button_down_time
= 0;
5238 XSETFASTINT (lispy_c
, c
);
5242 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5244 Lisp_Object lispy_c
;
5245 int c
= event
->code
;
5247 /* Add in the other modifier bits. We took care of ctrl_modifier
5248 just above, and the shift key was taken care of by the X code,
5249 and applied to control characters by make_ctrl_char. */
5250 c
|= (event
->modifiers
5251 & (meta_modifier
| alt_modifier
5252 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5253 /* What about the `shift' modifier ? */
5254 button_down_time
= 0;
5255 XSETFASTINT (lispy_c
, c
);
5259 /* A function key. The symbol may need to have modifier prefixes
5261 case NON_ASCII_KEYSTROKE_EVENT
:
5262 button_down_time
= 0;
5264 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5265 if (event
->code
== lispy_accent_codes
[i
])
5266 return modify_event_symbol (i
,
5268 Qfunction_key
, Qnil
,
5269 lispy_accent_keys
, &accent_key_syms
,
5270 (sizeof (lispy_accent_keys
)
5271 / sizeof (lispy_accent_keys
[0])));
5275 if (event
->code
>= 0x400 && event
->code
< 0x500)
5276 return modify_event_symbol (event
->code
- 0x400,
5277 event
->modifiers
& ~shift_modifier
,
5278 Qfunction_key
, Qnil
,
5279 lispy_kana_keys
, &func_key_syms
,
5280 (sizeof (lispy_kana_keys
)
5281 / sizeof (lispy_kana_keys
[0])));
5282 #endif /* XK_kana_A */
5285 #ifdef ISO_FUNCTION_KEY_OFFSET
5286 if (event
->code
< FUNCTION_KEY_OFFSET
5287 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5288 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5290 Qfunction_key
, Qnil
,
5291 iso_lispy_function_keys
, &func_key_syms
,
5292 (sizeof (iso_lispy_function_keys
)
5293 / sizeof (iso_lispy_function_keys
[0])));
5296 /* Handle system-specific or unknown keysyms. */
5297 if (event
->code
& (1 << 28)
5298 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5299 || (event
->code
- FUNCTION_KEY_OFFSET
5300 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5301 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5303 /* We need to use an alist rather than a vector as the cache
5304 since we can't make a vector long enuf. */
5305 if (NILP (current_kboard
->system_key_syms
))
5306 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5307 return modify_event_symbol (event
->code
,
5310 current_kboard
->Vsystem_key_alist
,
5311 0, ¤t_kboard
->system_key_syms
,
5315 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5317 Qfunction_key
, Qnil
,
5318 lispy_function_keys
, &func_key_syms
,
5319 (sizeof (lispy_function_keys
)
5320 / sizeof (lispy_function_keys
[0])));
5323 /* A mouse click. Figure out where it is, decide whether it's
5324 a press, click or drag, and build the appropriate structure. */
5325 case MOUSE_CLICK_EVENT
:
5326 #ifndef USE_TOOLKIT_SCROLL_BARS
5327 case SCROLL_BAR_CLICK_EVENT
:
5330 int button
= event
->code
;
5332 Lisp_Object position
;
5333 Lisp_Object
*start_pos_ptr
;
5334 Lisp_Object start_pos
;
5338 /* Build the position as appropriate for this mouse click. */
5339 if (event
->kind
== MOUSE_CLICK_EVENT
)
5341 struct frame
*f
= XFRAME (event
->frame_or_window
);
5342 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5346 /* Ignore mouse events that were made on frame that
5347 have been deleted. */
5348 if (! FRAME_LIVE_P (f
))
5351 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5352 /* EVENT->x and EVENT->y are frame-relative pixel
5353 coordinates at this place. Under old redisplay, COLUMN
5354 and ROW are set to frame relative glyph coordinates
5355 which are then used to determine whether this click is
5356 in a menu (non-toolkit version). */
5357 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5358 &column
, &row
, NULL
, 1);
5360 /* In the non-toolkit version, clicks on the menu bar
5361 are ordinary button events in the event buffer.
5362 Distinguish them, and invoke the menu.
5364 (In the toolkit version, the toolkit handles the menu bar
5365 and Emacs doesn't know about it until after the user
5366 makes a selection.) */
5367 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5368 && (event
->modifiers
& down_modifier
))
5370 Lisp_Object items
, item
;
5375 /* Activate the menu bar on the down event. If the
5376 up event comes in before the menu code can deal with it,
5378 if (! (event
->modifiers
& down_modifier
))
5382 /* Find the menu bar item under `column'. */
5384 items
= FRAME_MENU_BAR_ITEMS (f
);
5385 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5387 Lisp_Object pos
, string
;
5388 string
= AREF (items
, i
+ 1);
5389 pos
= AREF (items
, i
+ 3);
5392 if (column
>= XINT (pos
)
5393 && column
< XINT (pos
) + SCHARS (string
))
5395 item
= AREF (items
, i
);
5400 /* ELisp manual 2.4b says (x y) are window relative but
5401 code says they are frame-relative. */
5403 = Fcons (event
->frame_or_window
,
5405 Fcons (Fcons (event
->x
, event
->y
),
5406 Fcons (make_number (event
->timestamp
),
5409 return Fcons (item
, Fcons (position
, Qnil
));
5411 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5413 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5416 #ifndef USE_TOOLKIT_SCROLL_BARS
5419 /* It's a scrollbar click. */
5421 Lisp_Object portion_whole
;
5424 window
= event
->frame_or_window
;
5425 portion_whole
= Fcons (event
->x
, event
->y
);
5426 part
= *scroll_bar_parts
[(int) event
->part
];
5430 Fcons (Qvertical_scroll_bar
,
5431 Fcons (portion_whole
,
5432 Fcons (make_number (event
->timestamp
),
5433 Fcons (part
, Qnil
)))));
5435 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5437 if (button
>= ASIZE (button_down_location
))
5439 button_down_location
= larger_vector (button_down_location
,
5441 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5444 start_pos_ptr
= &AREF (button_down_location
, button
);
5445 start_pos
= *start_pos_ptr
;
5446 *start_pos_ptr
= Qnil
;
5449 /* On window-system frames, use the value of
5450 double-click-fuzz as is. On other frames, interpret it
5451 as a multiple of 1/8 characters. */
5455 if (WINDOWP (event
->frame_or_window
))
5456 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5457 else if (FRAMEP (event
->frame_or_window
))
5458 f
= XFRAME (event
->frame_or_window
);
5462 if (FRAME_WINDOW_P (f
))
5463 fuzz
= double_click_fuzz
;
5465 fuzz
= double_click_fuzz
/ 8;
5467 is_double
= (button
== last_mouse_button
5468 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5469 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5470 && button_down_time
!= 0
5471 && (EQ (Vdouble_click_time
, Qt
)
5472 || (INTEGERP (Vdouble_click_time
)
5473 && ((int)(event
->timestamp
- button_down_time
)
5474 < XINT (Vdouble_click_time
)))));
5477 last_mouse_button
= button
;
5478 last_mouse_x
= XINT (event
->x
);
5479 last_mouse_y
= XINT (event
->y
);
5481 /* If this is a button press, squirrel away the location, so
5482 we can decide later whether it was a click or a drag. */
5483 if (event
->modifiers
& down_modifier
)
5487 double_click_count
++;
5488 event
->modifiers
|= ((double_click_count
> 2)
5493 double_click_count
= 1;
5494 button_down_time
= event
->timestamp
;
5495 *start_pos_ptr
= Fcopy_alist (position
);
5498 /* Now we're releasing a button - check the co-ordinates to
5499 see if this was a click or a drag. */
5500 else if (event
->modifiers
& up_modifier
)
5502 /* If we did not see a down before this up, ignore the up.
5503 Probably this happened because the down event chose a
5504 menu item. It would be an annoyance to treat the
5505 release of the button that chose the menu item as a
5508 if (!CONSP (start_pos
))
5511 event
->modifiers
&= ~up_modifier
;
5512 #if 0 /* Formerly we treated an up with no down as a click event. */
5513 if (!CONSP (start_pos
))
5514 event
->modifiers
|= click_modifier
;
5519 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5521 /* The third element of every position
5522 should be the (x,y) pair. */
5523 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5525 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5527 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5528 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5531 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5532 && ydiff
< double_click_fuzz
5533 && ydiff
> - double_click_fuzz
)
5534 /* Mouse hasn't moved (much). */
5535 event
->modifiers
|= click_modifier
;
5538 button_down_time
= 0;
5539 event
->modifiers
|= drag_modifier
;
5542 /* Don't check is_double; treat this as multiple
5543 if the down-event was multiple. */
5544 if (double_click_count
> 1)
5545 event
->modifiers
|= ((double_click_count
> 2)
5551 /* Every mouse event should either have the down_modifier or
5552 the up_modifier set. */
5556 /* Get the symbol we should use for the mouse click. */
5559 head
= modify_event_symbol (button
,
5561 Qmouse_click
, Vlispy_mouse_stem
,
5564 XVECTOR (mouse_syms
)->size
);
5565 if (event
->modifiers
& drag_modifier
)
5570 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5573 Fcons (make_number (double_click_count
),
5584 Lisp_Object position
;
5587 /* Build the position as appropriate for this mouse click. */
5588 struct frame
*f
= XFRAME (event
->frame_or_window
);
5590 /* Ignore wheel events that were made on frame that have been
5592 if (! FRAME_LIVE_P (f
))
5595 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5598 /* Set double or triple modifiers to indicate the wheel speed. */
5600 /* On window-system frames, use the value of
5601 double-click-fuzz as is. On other frames, interpret it
5602 as a multiple of 1/8 characters. */
5607 if (WINDOWP (event
->frame_or_window
))
5608 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5609 else if (FRAMEP (event
->frame_or_window
))
5610 f
= XFRAME (event
->frame_or_window
);
5614 if (FRAME_WINDOW_P (f
))
5615 fuzz
= double_click_fuzz
;
5617 fuzz
= double_click_fuzz
/ 8;
5619 is_double
= (last_mouse_button
< 0
5620 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5621 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5622 && button_down_time
!= 0
5623 && (EQ (Vdouble_click_time
, Qt
)
5624 || (INTEGERP (Vdouble_click_time
)
5625 && ((int)(event
->timestamp
- button_down_time
)
5626 < XINT (Vdouble_click_time
)))));
5629 double_click_count
++;
5630 event
->modifiers
|= ((double_click_count
> 2)
5636 double_click_count
= 1;
5637 event
->modifiers
|= click_modifier
;
5640 button_down_time
= event
->timestamp
;
5641 /* Use a negative value to distinguish wheel from mouse button. */
5642 last_mouse_button
= -1;
5643 last_mouse_x
= XINT (event
->x
);
5644 last_mouse_y
= XINT (event
->y
);
5650 if (event
->modifiers
& up_modifier
)
5652 /* Emit a wheel-up event. */
5653 event
->modifiers
&= ~up_modifier
;
5656 else if (event
->modifiers
& down_modifier
)
5658 /* Emit a wheel-down event. */
5659 event
->modifiers
&= ~down_modifier
;
5663 /* Every wheel event should either have the down_modifier or
5664 the up_modifier set. */
5667 /* Get the symbol we should use for the wheel event. */
5668 head
= modify_event_symbol (symbol_num
,
5674 ASIZE (wheel_syms
));
5677 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5680 Fcons (make_number (double_click_count
),
5689 #ifdef USE_TOOLKIT_SCROLL_BARS
5691 /* We don't have down and up events if using toolkit scroll bars,
5692 so make this always a click event. Store in the `part' of
5693 the Lisp event a symbol which maps to the following actions:
5695 `above_handle' page up
5696 `below_handle' page down
5700 `bottom' bottom of buffer
5701 `handle' thumb has been dragged.
5702 `end-scroll' end of interaction with scroll bar
5704 The incoming input_event contains in its `part' member an
5705 index of type `enum scroll_bar_part' which we can use as an
5706 index in scroll_bar_parts to get the appropriate symbol. */
5708 case SCROLL_BAR_CLICK_EVENT
:
5710 Lisp_Object position
, head
, window
, portion_whole
, part
;
5712 window
= event
->frame_or_window
;
5713 portion_whole
= Fcons (event
->x
, event
->y
);
5714 part
= *scroll_bar_parts
[(int) event
->part
];
5718 Fcons (Qvertical_scroll_bar
,
5719 Fcons (portion_whole
,
5720 Fcons (make_number (event
->timestamp
),
5721 Fcons (part
, Qnil
)))));
5723 /* Always treat scroll bar events as clicks. */
5724 event
->modifiers
|= click_modifier
;
5725 event
->modifiers
&= ~up_modifier
;
5727 if (event
->code
>= ASIZE (mouse_syms
))
5728 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5730 /* Get the symbol we should use for the mouse click. */
5731 head
= modify_event_symbol (event
->code
,
5736 XVECTOR (mouse_syms
)->size
);
5737 return Fcons (head
, Fcons (position
, Qnil
));
5740 #endif /* USE_TOOLKIT_SCROLL_BARS */
5743 case W32_SCROLL_BAR_CLICK_EVENT
:
5745 int button
= event
->code
;
5747 Lisp_Object position
;
5748 Lisp_Object
*start_pos_ptr
;
5749 Lisp_Object start_pos
;
5753 Lisp_Object portion_whole
;
5756 window
= event
->frame_or_window
;
5757 portion_whole
= Fcons (event
->x
, event
->y
);
5758 part
= *scroll_bar_parts
[(int) event
->part
];
5762 Fcons (Qvertical_scroll_bar
,
5763 Fcons (portion_whole
,
5764 Fcons (make_number (event
->timestamp
),
5765 Fcons (part
, Qnil
)))));
5768 /* Always treat W32 scroll bar events as clicks. */
5769 event
->modifiers
|= click_modifier
;
5772 /* Get the symbol we should use for the mouse click. */
5775 head
= modify_event_symbol (button
,
5780 XVECTOR (mouse_syms
)->size
);
5786 #endif /* WINDOWSNT */
5788 case DRAG_N_DROP_EVENT
:
5791 Lisp_Object head
, position
;
5794 /* The frame_or_window field should be a cons of the frame in
5795 which the event occurred and a list of the filenames
5797 if (! CONSP (event
->frame_or_window
))
5800 f
= XFRAME (XCAR (event
->frame_or_window
));
5801 files
= XCDR (event
->frame_or_window
);
5803 /* Ignore mouse events that were made on frames that
5804 have been deleted. */
5805 if (! FRAME_LIVE_P (f
))
5808 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5811 head
= modify_event_symbol (0, event
->modifiers
,
5813 lispy_drag_n_drop_names
,
5814 &drag_n_drop_syms
, 1);
5820 #endif /* HAVE_MOUSE */
5822 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5823 || defined (USE_GTK)
5824 case MENU_BAR_EVENT
:
5825 if (EQ (event
->arg
, event
->frame_or_window
))
5826 /* This is the prefix key. We translate this to
5827 `(menu_bar)' because the code in keyboard.c for menu
5828 events, which we use, relies on this. */
5829 return Fcons (Qmenu_bar
, Qnil
);
5833 case SELECT_WINDOW_EVENT
:
5834 /* Make an event (select-window (WINDOW)). */
5835 return Fcons (Qselect_window
,
5836 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5839 case TOOL_BAR_EVENT
:
5840 if (EQ (event
->arg
, event
->frame_or_window
))
5841 /* This is the prefix key. We translate this to
5842 `(tool_bar)' because the code in keyboard.c for tool bar
5843 events, which we use, relies on this. */
5844 return Fcons (Qtool_bar
, Qnil
);
5845 else if (SYMBOLP (event
->arg
))
5846 return apply_modifiers (event
->modifiers
, event
->arg
);
5849 case USER_SIGNAL_EVENT
:
5850 /* A user signal. */
5851 return *lispy_user_signals
[event
->code
];
5853 case SAVE_SESSION_EVENT
:
5854 return Qsave_session
;
5856 /* The 'kind' field of the event is something we don't recognize. */
5865 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5867 Lisp_Object bar_window
;
5868 enum scroll_bar_part part
;
5872 /* Is it a scroll bar movement? */
5873 if (frame
&& ! NILP (bar_window
))
5875 Lisp_Object part_sym
;
5877 part_sym
= *scroll_bar_parts
[(int) part
];
5878 return Fcons (Qscroll_bar_movement
,
5879 (Fcons (Fcons (bar_window
,
5880 Fcons (Qvertical_scroll_bar
,
5881 Fcons (Fcons (x
, y
),
5882 Fcons (make_number (time
),
5888 /* Or is it an ordinary mouse movement? */
5891 Lisp_Object position
;
5893 position
= make_lispy_position (frame
, &x
, &y
, time
);
5895 return Fcons (Qmouse_movement
,
5901 #endif /* HAVE_MOUSE */
5903 /* Construct a switch frame event. */
5905 make_lispy_switch_frame (frame
)
5908 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5911 /* Manipulating modifiers. */
5913 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5915 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5916 SYMBOL's name of the end of the modifiers; the string from this
5917 position is the unmodified symbol name.
5919 This doesn't use any caches. */
5922 parse_modifiers_uncached (symbol
, modifier_end
)
5930 CHECK_SYMBOL (symbol
);
5933 name
= SYMBOL_NAME (symbol
);
5935 for (i
= 0; i
+2 <= SBYTES (name
); )
5937 int this_mod_end
= 0;
5940 /* See if the name continues with a modifier word.
5941 Check that the word appears, but don't check what follows it.
5942 Set this_mod and this_mod_end to record what we find. */
5944 switch (SREF (name
, i
))
5946 #define SINGLE_LETTER_MOD(BIT) \
5947 (this_mod_end = i + 1, this_mod = BIT)
5950 SINGLE_LETTER_MOD (alt_modifier
);
5954 SINGLE_LETTER_MOD (ctrl_modifier
);
5958 SINGLE_LETTER_MOD (hyper_modifier
);
5962 SINGLE_LETTER_MOD (meta_modifier
);
5966 SINGLE_LETTER_MOD (shift_modifier
);
5970 SINGLE_LETTER_MOD (super_modifier
);
5973 #undef SINGLE_LETTER_MOD
5975 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
5976 if (i + LEN + 1 <= SBYTES (name) \
5977 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
5979 this_mod_end = i + LEN; \
5984 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
5985 MULTI_LETTER_MOD (down_modifier
, "down", 4);
5986 MULTI_LETTER_MOD (double_modifier
, "double", 6);
5990 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
5992 #undef MULTI_LETTER_MOD
5996 /* If we found no modifier, stop looking for them. */
5997 if (this_mod_end
== 0)
6000 /* Check there is a dash after the modifier, so that it
6001 really is a modifier. */
6002 if (this_mod_end
>= SBYTES (name
)
6003 || SREF (name
, this_mod_end
) != '-')
6006 /* This modifier is real; look for another. */
6007 modifiers
|= this_mod
;
6008 i
= this_mod_end
+ 1;
6011 /* Should we include the `click' modifier? */
6012 if (! (modifiers
& (down_modifier
| drag_modifier
6013 | double_modifier
| triple_modifier
))
6014 && i
+ 7 == SBYTES (name
)
6015 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6016 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6017 modifiers
|= click_modifier
;
6025 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6026 prepended to the string BASE[0..BASE_LEN-1].
6027 This doesn't use any caches. */
6029 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6032 int base_len
, base_len_byte
;
6034 /* Since BASE could contain nulls, we can't use intern here; we have
6035 to use Fintern, which expects a genuine Lisp_String, and keeps a
6038 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6044 /* Only the event queue may use the `up' modifier; it should always
6045 be turned into a click or drag event before presented to lisp code. */
6046 if (modifiers
& up_modifier
)
6049 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6050 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6051 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6052 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6053 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6054 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6055 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6056 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6057 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6058 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6059 /* The click modifier is denoted by the absence of other modifiers. */
6063 mod_len
= p
- new_mods
;
6067 Lisp_Object new_name
;
6069 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6070 mod_len
+ base_len_byte
);
6071 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6072 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6074 return Fintern (new_name
, Qnil
);
6079 static char *modifier_names
[] =
6081 "up", "down", "drag", "click", "double", "triple", 0, 0,
6082 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6083 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6085 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6087 static Lisp_Object modifier_symbols
;
6089 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6091 lispy_modifier_list (modifiers
)
6094 Lisp_Object modifier_list
;
6097 modifier_list
= Qnil
;
6098 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6099 if (modifiers
& (1<<i
))
6100 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6103 return modifier_list
;
6107 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6108 where UNMODIFIED is the unmodified form of SYMBOL,
6109 MASK is the set of modifiers present in SYMBOL's name.
6110 This is similar to parse_modifiers_uncached, but uses the cache in
6111 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6112 Qevent_symbol_elements property. */
6115 parse_modifiers (symbol
)
6118 Lisp_Object elements
;
6120 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6121 if (CONSP (elements
))
6126 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6127 Lisp_Object unmodified
;
6130 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6131 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6134 if (modifiers
& ~INTMASK
)
6136 XSETFASTINT (mask
, modifiers
);
6137 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6139 /* Cache the parsing results on SYMBOL. */
6140 Fput (symbol
, Qevent_symbol_element_mask
,
6142 Fput (symbol
, Qevent_symbol_elements
,
6143 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6145 /* Since we know that SYMBOL is modifiers applied to unmodified,
6146 it would be nice to put that in unmodified's cache.
6147 But we can't, since we're not sure that parse_modifiers is
6154 /* Apply the modifiers MODIFIERS to the symbol BASE.
6155 BASE must be unmodified.
6157 This is like apply_modifiers_uncached, but uses BASE's
6158 Qmodifier_cache property, if present. It also builds
6159 Qevent_symbol_elements properties, since it has that info anyway.
6161 apply_modifiers copies the value of BASE's Qevent_kind property to
6162 the modified symbol. */
6164 apply_modifiers (modifiers
, base
)
6168 Lisp_Object cache
, index
, entry
, new_symbol
;
6170 /* Mask out upper bits. We don't know where this value's been. */
6171 modifiers
&= INTMASK
;
6173 /* The click modifier never figures into cache indices. */
6174 cache
= Fget (base
, Qmodifier_cache
);
6175 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6176 entry
= assq_no_quit (index
, cache
);
6179 new_symbol
= XCDR (entry
);
6182 /* We have to create the symbol ourselves. */
6183 new_symbol
= apply_modifiers_uncached (modifiers
,
6184 SDATA (SYMBOL_NAME (base
)),
6185 SCHARS (SYMBOL_NAME (base
)),
6186 SBYTES (SYMBOL_NAME (base
)));
6188 /* Add the new symbol to the base's cache. */
6189 entry
= Fcons (index
, new_symbol
);
6190 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6192 /* We have the parsing info now for free, so we could add it to
6194 XSETFASTINT (index, modifiers);
6195 Fput (new_symbol, Qevent_symbol_element_mask,
6196 Fcons (base, Fcons (index, Qnil)));
6197 Fput (new_symbol, Qevent_symbol_elements,
6198 Fcons (base, lispy_modifier_list (modifiers)));
6199 Sadly, this is only correct if `base' is indeed a base event,
6200 which is not necessarily the case. -stef */
6203 /* Make sure this symbol is of the same kind as BASE.
6205 You'd think we could just set this once and for all when we
6206 intern the symbol above, but reorder_modifiers may call us when
6207 BASE's property isn't set right; we can't assume that just
6208 because it has a Qmodifier_cache property it must have its
6209 Qevent_kind set right as well. */
6210 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6214 kind
= Fget (base
, Qevent_kind
);
6216 Fput (new_symbol
, Qevent_kind
, kind
);
6223 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6224 return a symbol with the modifiers placed in the canonical order.
6225 Canonical order is alphabetical, except for down and drag, which
6226 always come last. The 'click' modifier is never written out.
6228 Fdefine_key calls this to make sure that (for example) C-M-foo
6229 and M-C-foo end up being equivalent in the keymap. */
6232 reorder_modifiers (symbol
)
6235 /* It's hopefully okay to write the code this way, since everything
6236 will soon be in caches, and no consing will be done at all. */
6239 parsed
= parse_modifiers (symbol
);
6240 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6245 /* For handling events, we often want to produce a symbol whose name
6246 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6247 to some base, like the name of a function key or mouse button.
6248 modify_event_symbol produces symbols of this sort.
6250 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6251 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6254 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6255 into symbol names, or a string specifying a name stem used to
6256 construct a symbol name or the form `STEM-N', where N is the decimal
6257 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6258 non-nil; otherwise NAME_TABLE is used.
6260 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6261 persist between calls to modify_event_symbol that it can use to
6262 store a cache of the symbols it's generated for this NAME_TABLE
6263 before. The object stored there may be a vector or an alist.
6265 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6267 MODIFIERS is a set of modifier bits (as given in struct input_events)
6268 whose prefixes should be applied to the symbol name.
6270 SYMBOL_KIND is the value to be placed in the event_kind property of
6271 the returned symbol.
6273 The symbols we create are supposed to have an
6274 `event-symbol-elements' property, which lists the modifiers present
6275 in the symbol's name. */
6278 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6279 name_table
, symbol_table
, table_size
)
6282 Lisp_Object symbol_kind
;
6283 Lisp_Object name_alist_or_stem
;
6285 Lisp_Object
*symbol_table
;
6286 unsigned int table_size
;
6289 Lisp_Object symbol_int
;
6291 /* Get rid of the "vendor-specific" bit here. */
6292 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6294 /* Is this a request for a valid symbol? */
6295 if (symbol_num
< 0 || symbol_num
>= table_size
)
6298 if (CONSP (*symbol_table
))
6299 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6301 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6302 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6303 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6304 we've never used that symbol before. */
6307 if (! VECTORP (*symbol_table
)
6308 || XVECTOR (*symbol_table
)->size
!= table_size
)
6312 XSETFASTINT (size
, table_size
);
6313 *symbol_table
= Fmake_vector (size
, Qnil
);
6316 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6319 /* Have we already used this symbol before? */
6322 /* No; let's create it. */
6323 if (CONSP (name_alist_or_stem
))
6324 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6325 else if (STRINGP (name_alist_or_stem
))
6327 int len
= SBYTES (name_alist_or_stem
);
6328 char *buf
= (char *) alloca (len
+ 50);
6329 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6330 (long) XINT (symbol_int
) + 1);
6331 value
= intern (buf
);
6333 else if (name_table
!= 0 && name_table
[symbol_num
])
6334 value
= intern (name_table
[symbol_num
]);
6336 #ifdef HAVE_WINDOW_SYSTEM
6339 char *name
= x_get_keysym_name (symbol_num
);
6341 value
= intern (name
);
6348 sprintf (buf
, "key-%d", symbol_num
);
6349 value
= intern (buf
);
6352 if (CONSP (*symbol_table
))
6353 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6355 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6357 /* Fill in the cache entries for this symbol; this also
6358 builds the Qevent_symbol_elements property, which the user
6360 apply_modifiers (modifiers
& click_modifier
, value
);
6361 Fput (value
, Qevent_kind
, symbol_kind
);
6364 /* Apply modifiers to that symbol. */
6365 return apply_modifiers (modifiers
, value
);
6368 /* Convert a list that represents an event type,
6369 such as (ctrl meta backspace), into the usual representation of that
6370 event type as a number or a symbol. */
6372 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6373 doc
: /* Convert the event description list EVENT-DESC to an event type.
6374 EVENT-DESC should contain one base event type (a character or symbol)
6375 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6376 drag, down, double or triple). The base must be last.
6377 The return value is an event type (a character or symbol) which
6378 has the same base event type and all the specified modifiers. */)
6380 Lisp_Object event_desc
;
6388 while (CONSP (rest
))
6396 /* Given a symbol, see if it is a modifier name. */
6397 if (SYMBOLP (elt
) && CONSP (rest
))
6398 this = parse_solitary_modifier (elt
);
6402 else if (!NILP (base
))
6403 error ("Two bases given in one event");
6409 /* Let the symbol A refer to the character A. */
6410 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6411 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6413 if (INTEGERP (base
))
6415 /* Turn (shift a) into A. */
6416 if ((modifiers
& shift_modifier
) != 0
6417 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6419 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6420 modifiers
&= ~shift_modifier
;
6423 /* Turn (control a) into C-a. */
6424 if (modifiers
& ctrl_modifier
)
6425 return make_number ((modifiers
& ~ctrl_modifier
)
6426 | make_ctrl_char (XINT (base
)));
6428 return make_number (modifiers
| XINT (base
));
6430 else if (SYMBOLP (base
))
6431 return apply_modifiers (modifiers
, base
);
6434 error ("Invalid base event");
6439 /* Try to recognize SYMBOL as a modifier name.
6440 Return the modifier flag bit, or 0 if not recognized. */
6443 parse_solitary_modifier (symbol
)
6446 Lisp_Object name
= SYMBOL_NAME (symbol
);
6448 switch (SREF (name
, 0))
6450 #define SINGLE_LETTER_MOD(BIT) \
6451 if (SBYTES (name) == 1) \
6454 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6455 if (LEN == SBYTES (name) \
6456 && ! strncmp (SDATA (name), NAME, LEN)) \
6460 SINGLE_LETTER_MOD (alt_modifier
);
6464 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6468 SINGLE_LETTER_MOD (ctrl_modifier
);
6472 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6473 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6477 SINGLE_LETTER_MOD (hyper_modifier
);
6481 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6485 SINGLE_LETTER_MOD (meta_modifier
);
6489 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6493 SINGLE_LETTER_MOD (shift_modifier
);
6497 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6498 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6499 SINGLE_LETTER_MOD (super_modifier
);
6503 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6504 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6505 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6509 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6512 #undef SINGLE_LETTER_MOD
6513 #undef MULTI_LETTER_MOD
6519 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6520 Such a list is not valid as an event,
6521 but it can be a Lucid-style event type list. */
6524 lucid_event_type_list_p (object
)
6529 if (! CONSP (object
))
6532 if (EQ (XCAR (object
), Qhelp_echo
)
6533 || EQ (XCAR (object
), Qvertical_line
)
6534 || EQ (XCAR (object
), Qmode_line
)
6535 || EQ (XCAR (object
), Qheader_line
))
6538 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6542 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6549 /* Store into *addr a value nonzero if terminal input chars are available.
6550 Serves the purpose of ioctl (0, FIONREAD, addr)
6551 but works even if FIONREAD does not exist.
6552 (In fact, this may actually read some input.)
6554 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6555 timer events that are ripe.
6556 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6557 events (FOCUS_IN_EVENT).
6558 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6559 movements and toolkit scroll bar thumb drags. */
6562 get_input_pending (addr
, flags
)
6566 /* First of all, have we already counted some input? */
6567 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6569 /* If input is being read as it arrives, and we have none, there is none. */
6570 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6573 /* Try to read some input and see how much we get. */
6575 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6578 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6581 gobble_input (expected
)
6586 if (interrupt_input
)
6589 mask
= sigblock (sigmask (SIGIO
));
6590 read_avail_input (expected
);
6594 #ifdef POLL_FOR_INPUT
6595 /* XXX This condition was (read_socket_hook && !interrupt_input),
6596 but read_socket_hook is not global anymore. Let's pretend that
6598 if (!interrupt_input
&& poll_suppress_count
== 0)
6601 mask
= sigblock (sigmask (SIGALRM
));
6602 read_avail_input (expected
);
6608 read_avail_input (expected
);
6612 /* Put a BUFFER_SWITCH_EVENT in the buffer
6613 so that read_key_sequence will notice the new current buffer. */
6616 record_asynch_buffer_change ()
6618 struct input_event event
;
6622 event
.kind
= BUFFER_SWITCH_EVENT
;
6623 event
.frame_or_window
= Qnil
;
6627 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6628 The purpose of the event is to make read_key_sequence look up the
6629 keymaps again. If we aren't in read_key_sequence, we don't need one,
6630 and the event could cause trouble by messing up (input-pending-p). */
6631 tem
= Fwaiting_for_user_input_p ();
6635 /* We never need these events if we have no asynchronous subprocesses. */
6639 /* Make sure no interrupt happens while storing the event. */
6641 if (interrupt_input
)
6644 mask
= sigblock (sigmask (SIGIO
));
6645 kbd_buffer_store_event (&event
);
6652 kbd_buffer_store_event (&event
);
6659 /* Read any terminal input already buffered up by the system
6660 into the kbd_buffer, but do not wait.
6662 EXPECTED should be nonzero if the caller knows there is some input.
6664 Except on VMS, all input is read by this function.
6665 If interrupt_input is nonzero, this function MUST be called
6666 only when SIGIO is blocked.
6668 Returns the number of keyboard chars read, or -1 meaning
6669 this is a bad time to try to read input. */
6672 read_avail_input (expected
)
6679 /* Loop through the available devices, and call their input hooks. */
6683 struct device
*next
= d
->next_device
;
6685 if (d
->read_socket_hook
)
6688 struct input_event hold_quit
;
6690 EVENT_INIT (hold_quit
);
6691 hold_quit
.kind
= NO_EVENT
;
6693 /* No need for FIONREAD or fcntl; just say don't wait. */
6694 while (nr
= (*d
->read_socket_hook
) (d
, expected
, &hold_quit
), nr
> 0)
6700 if (nr
== -1) /* Not OK to read input now. */
6704 else if (nr
== -2) /* Non-transient error. */
6706 /* The display device terminated; it should be closed. */
6708 /* Kill Emacs if this was our last display. */
6709 if (! device_list
->next_device
)
6710 /* Formerly simply reported no input, but that
6711 sometimes led to a failure of Emacs to terminate.
6712 SIGHUP seems appropriate if we can't reach the
6714 /* ??? Is it really right to send the signal just to
6715 this process rather than to the whole process
6716 group? Perhaps on systems with FIONREAD Emacs is
6717 alone in its group. */
6718 kill (getpid (), SIGHUP
);
6720 /* XXX Is calling delete_device safe here? It calls Fdelete_frame. */
6721 if (d
->delete_device_hook
)
6722 (*d
->delete_device_hook
) (d
);
6727 if (hold_quit
.kind
!= NO_EVENT
)
6728 kbd_buffer_store_event (&hold_quit
);
6740 /* This is the tty way of reading available input.
6742 Note that each terminal device has its own `struct device' object,
6743 and so this function is called once for each individual termcap
6744 display. The first parameter indicates which device to read from. */
6747 tty_read_avail_input (struct device
*device
,
6749 struct input_event
*hold_quit
)
6751 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6752 the kbd_buffer can really hold. That may prevent loss
6753 of characters on some systems when input is stuffed at us. */
6754 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6756 struct tty_display_info
*tty
= device
->display_info
.tty
;
6759 if (device
->type
!= output_termcap
)
6762 /* XXX I think the following code should be moved to separate hook
6763 functions in system-dependent files. */
6766 #else /* not WINDOWSNT */
6768 n_to_read
= dos_keysns ();
6772 cbuf
[0] = dos_keyread ();
6775 #else /* not MSDOS */
6777 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6781 return 0; /* The terminal is suspended. */
6783 /* Determine how many characters we should *try* to read. */
6785 /* Find out how much input is available. */
6786 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6788 if (! noninteractive
)
6789 return -2; /* Close this device. */
6795 if (n_to_read
> sizeof cbuf
)
6796 n_to_read
= sizeof cbuf
;
6797 #else /* no FIONREAD */
6798 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6799 /* Read some input if available, but don't wait. */
6800 n_to_read
= sizeof cbuf
;
6801 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6807 /* Now read; for one reason or another, this will not block.
6808 NREAD is set to the number of chars read. */
6811 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6812 /* POSIX infers that processes which are not in the session leader's
6813 process group won't get SIGHUP's at logout time. BSDI adheres to
6814 this part standard and returns -1 from read (0) with errno==EIO
6815 when the control tty is taken away.
6816 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6817 if (nread
== -1 && errno
== EIO
)
6818 return -2; /* Close this device. */
6819 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6820 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6821 This looks incorrect, but it isn't, because _BSD causes
6822 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6823 and that causes a value other than 0 when there is no input. */
6825 return -2; /* Close this device. */
6829 /* We used to retry the read if it was interrupted.
6830 But this does the wrong thing when O_NDELAY causes
6831 an EAGAIN error. Does anybody know of a situation
6832 where a retry is actually needed? */
6834 nread
< 0 && (errno
== EAGAIN
6848 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6849 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6850 #endif /* USG or DGUX or CYGWIN */
6851 #endif /* no FIONREAD */
6856 #endif /* not MSDOS */
6857 #endif /* not WINDOWSNT */
6859 for (i
= 0; i
< nread
; i
++)
6861 struct input_event buf
;
6863 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6865 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6866 buf
.modifiers
= meta_modifier
;
6867 if (tty
->meta_key
!= 2)
6871 /* Set the frame corresponding to the active tty. Note that the
6872 value of selected_frame is not reliable here, redisplay tends
6873 to temporarily change it. */
6874 buf
.frame_or_window
= tty
->top_frame
;
6877 kbd_buffer_store_event (&buf
);
6878 /* Don't look at input that follows a C-g too closely.
6879 This reduces lossage due to autorepeat on C-g. */
6880 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6881 && buf
.code
== quit_char
)
6887 #endif /* not VMS */
6890 handle_async_input ()
6893 extern int select_alarmed
;
6896 interrupt_input_pending
= 0;
6901 nread
= read_avail_input (1);
6902 /* -1 means it's not ok to read the input now.
6903 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6904 0 means there was no keyboard input available. */
6909 select_alarmed
= 1; /* Force the select emulator back to life */
6914 #ifdef SIGIO /* for entire page */
6915 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6918 input_available_signal (signo
)
6921 /* Must preserve main program's value of errno. */
6922 int old_errno
= errno
;
6923 #if defined (USG) && !defined (POSIX_SIGNALS)
6924 /* USG systems forget handlers when they are used;
6925 must reestablish each time */
6926 signal (signo
, input_available_signal
);
6934 interrupt_input_pending
= 1;
6936 SIGNAL_THREAD_CHECK (signo
);
6939 if (input_available_clear_time
)
6940 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6943 handle_async_input ();
6953 /* Send ourselves a SIGIO.
6955 This function exists so that the UNBLOCK_INPUT macro in
6956 blockinput.h can have some way to take care of input we put off
6957 dealing with, without assuming that every file which uses
6958 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6960 reinvoke_input_signal ()
6963 handle_async_input ();
6969 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6970 static Lisp_Object menu_bar_one_keymap_changed_items
;
6972 /* These variables hold the vector under construction within
6973 menu_bar_items and its subroutines, and the current index
6974 for storing into that vector. */
6975 static Lisp_Object menu_bar_items_vector
;
6976 static int menu_bar_items_index
;
6978 /* Return a vector of menu items for a menu bar, appropriate
6979 to the current buffer. Each item has three elements in the vector:
6982 OLD is an old vector we can optionally reuse, or nil. */
6985 menu_bar_items (old
)
6988 /* The number of keymaps we're scanning right now, and the number of
6989 keymaps we have allocated space for. */
6992 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
6993 in the current keymaps, or nil where it is not a prefix. */
6996 Lisp_Object def
, tail
;
7005 /* In order to build the menus, we need to call the keymap
7006 accessors. They all call QUIT. But this function is called
7007 during redisplay, during which a quit is fatal. So inhibit
7008 quitting while building the menus.
7009 We do this instead of specbind because (1) errors will clear it anyway
7010 and (2) this avoids risk of specpdl overflow. */
7011 oquit
= Vinhibit_quit
;
7015 menu_bar_items_vector
= old
;
7017 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7018 menu_bar_items_index
= 0;
7020 /* Build our list of keymaps.
7021 If we recognize a function key and replace its escape sequence in
7022 keybuf with its symbol, or if the sequence starts with a mouse
7023 click and we need to switch buffers, we jump back here to rebuild
7024 the initial keymaps from the current buffer. */
7028 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7029 if (!NILP (Voverriding_local_map_menu_flag
))
7031 /* Yes, use them (if non-nil) as well as the global map. */
7032 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7034 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7035 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7036 if (!NILP (Voverriding_local_map
))
7037 maps
[nmaps
++] = Voverriding_local_map
;
7041 /* No, so use major and minor mode keymaps and keymap property.
7042 Note that menu-bar bindings in the local-map and keymap
7043 properties may not work reliable, as they are only
7044 recognized when the menu-bar (or mode-line) is updated,
7045 which does not normally happen after every command. */
7048 nminor
= current_minor_maps (NULL
, &tmaps
);
7049 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7051 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7052 maps
[nmaps
++] = tem
;
7053 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7055 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7057 maps
[nmaps
++] = current_global_map
;
7060 /* Look up in each map the dummy prefix key `menu-bar'. */
7064 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7065 if (!NILP (maps
[mapno
]))
7067 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7071 menu_bar_one_keymap_changed_items
= Qnil
;
7072 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7076 /* Move to the end those items that should be at the end. */
7078 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7081 int end
= menu_bar_items_index
;
7083 for (i
= 0; i
< end
; i
+= 4)
7084 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7086 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7087 /* Move the item at index I to the end,
7088 shifting all the others forward. */
7089 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7090 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7091 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7092 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7094 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7095 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7096 (end
- i
- 4) * sizeof (Lisp_Object
));
7097 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7098 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7099 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7100 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7105 /* Add nil, nil, nil, nil at the end. */
7106 i
= menu_bar_items_index
;
7107 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7110 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7111 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7112 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7113 menu_bar_items_vector
= tem
;
7115 /* Add this item. */
7116 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7117 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7118 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7119 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7120 menu_bar_items_index
= i
;
7122 Vinhibit_quit
= oquit
;
7123 return menu_bar_items_vector
;
7126 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7127 If there's already an item for KEY, add this DEF to it. */
7129 Lisp_Object item_properties
;
7132 menu_bar_item (key
, item
, dummy1
, dummy2
)
7133 Lisp_Object key
, item
, dummy1
;
7136 struct gcpro gcpro1
;
7140 if (EQ (item
, Qundefined
))
7142 /* If a map has an explicit `undefined' as definition,
7143 discard any previously made menu bar item. */
7145 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7146 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7148 if (menu_bar_items_index
> i
+ 4)
7149 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7150 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7151 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7152 menu_bar_items_index
-= 4;
7156 /* If this keymap has already contributed to this KEY,
7157 don't contribute to it a second time. */
7158 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7159 if (!NILP (tem
) || NILP (item
))
7162 menu_bar_one_keymap_changed_items
7163 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7165 /* We add to menu_bar_one_keymap_changed_items before doing the
7166 parse_menu_item, so that if it turns out it wasn't a menu item,
7167 it still correctly hides any further menu item. */
7169 i
= parse_menu_item (item
, 0, 1);
7174 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7176 /* Find any existing item for this KEY. */
7177 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7178 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7181 /* If we did not find this KEY, add it at the end. */
7182 if (i
== menu_bar_items_index
)
7184 /* If vector is too small, get a bigger one. */
7185 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7188 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7189 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7190 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7191 menu_bar_items_vector
= tem
;
7194 /* Add this item. */
7195 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7196 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7197 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7198 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7199 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7200 menu_bar_items_index
= i
;
7202 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7206 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7207 /* If the new and the old items are not both keymaps,
7208 the lookup will only find `item'. */
7209 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7210 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7214 /* This is used as the handler when calling menu_item_eval_property. */
7216 menu_item_eval_property_1 (arg
)
7219 /* If we got a quit from within the menu computation,
7220 quit all the way out of it. This takes care of C-] in the debugger. */
7221 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7222 Fsignal (Qquit
, Qnil
);
7227 /* Evaluate an expression and return the result (or nil if something
7228 went wrong). Used to evaluate dynamic parts of menu items. */
7230 menu_item_eval_property (sexpr
)
7233 int count
= SPECPDL_INDEX ();
7235 specbind (Qinhibit_redisplay
, Qt
);
7236 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7237 menu_item_eval_property_1
);
7238 return unbind_to (count
, val
);
7241 /* This function parses a menu item and leaves the result in the
7242 vector item_properties.
7243 ITEM is a key binding, a possible menu item.
7244 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7245 evaluate dynamic expressions in the menu item.
7246 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7248 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7249 parse_menu_item returns true if the item is a menu item and false
7253 parse_menu_item (item
, notreal
, inmenubar
)
7255 int notreal
, inmenubar
;
7257 Lisp_Object def
, tem
, item_string
, start
;
7258 Lisp_Object cachelist
;
7260 Lisp_Object keyhint
;
7271 /* Create item_properties vector if necessary. */
7272 if (NILP (item_properties
))
7274 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7276 /* Initialize optional entries. */
7277 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7278 AREF (item_properties
, i
) = Qnil
;
7279 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7281 /* Save the item here to protect it from GC. */
7282 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7284 item_string
= XCAR (item
);
7288 if (STRINGP (item_string
))
7290 /* Old format menu item. */
7291 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7293 /* Maybe help string. */
7294 if (CONSP (item
) && STRINGP (XCAR (item
)))
7296 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7301 /* Maybe key binding cache. */
7302 if (CONSP (item
) && CONSP (XCAR (item
))
7303 && (NILP (XCAR (XCAR (item
)))
7304 || VECTORP (XCAR (XCAR (item
)))))
7306 cachelist
= XCAR (item
);
7310 /* This is the real definition--the function to run. */
7311 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7313 /* Get enable property, if any. */
7316 tem
= Fget (item
, Qmenu_enable
);
7318 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7321 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7323 /* New format menu item. */
7324 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7325 start
= XCDR (item
);
7328 /* We have a real binding. */
7329 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7331 item
= XCDR (start
);
7332 /* Is there a cache list with key equivalences. */
7333 if (CONSP (item
) && CONSP (XCAR (item
)))
7335 cachelist
= XCAR (item
);
7339 /* Parse properties. */
7340 while (CONSP (item
) && CONSP (XCDR (item
)))
7345 if (EQ (tem
, QCenable
))
7346 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7347 else if (EQ (tem
, QCvisible
) && !notreal
)
7349 /* If got a visible property and that evaluates to nil
7350 then ignore this item. */
7351 tem
= menu_item_eval_property (XCAR (item
));
7355 else if (EQ (tem
, QChelp
))
7356 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7357 else if (EQ (tem
, QCfilter
))
7359 else if (EQ (tem
, QCkey_sequence
))
7362 if (NILP (cachelist
)
7363 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7364 /* Be GC protected. Set keyhint to item instead of tem. */
7367 else if (EQ (tem
, QCkeys
))
7370 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7371 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7373 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7378 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7380 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7382 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7389 else if (inmenubar
|| !NILP (start
))
7393 return 0; /* not a menu item */
7395 /* If item string is not a string, evaluate it to get string.
7396 If we don't get a string, skip this item. */
7397 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7398 if (!(STRINGP (item_string
) || notreal
))
7400 item_string
= menu_item_eval_property (item_string
);
7401 if (!STRINGP (item_string
))
7403 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7406 /* If got a filter apply it on definition. */
7407 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7410 def
= menu_item_eval_property (list2 (XCAR (filter
),
7411 list2 (Qquote
, def
)));
7413 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7416 /* Enable or disable selection of item. */
7417 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7423 tem
= menu_item_eval_property (tem
);
7424 if (inmenubar
&& NILP (tem
))
7425 return 0; /* Ignore disabled items in menu bar. */
7426 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7429 /* If we got no definition, this item is just unselectable text which
7430 is OK in a submenu but not in the menubar. */
7432 return (inmenubar
? 0 : 1);
7434 /* See if this is a separate pane or a submenu. */
7435 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7436 tem
= get_keymap (def
, 0, 1);
7437 /* For a subkeymap, just record its details and exit. */
7440 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7441 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7445 /* At the top level in the menu bar, do likewise for commands also.
7446 The menu bar does not display equivalent key bindings anyway.
7447 ITEM_PROPERTY_DEF is already set up properly. */
7451 /* This is a command. See if there is an equivalent key binding. */
7452 if (NILP (cachelist
))
7454 /* We have to create a cachelist. */
7455 CHECK_IMPURE (start
);
7456 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7457 cachelist
= XCAR (XCDR (start
));
7459 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7460 if (!NILP (keyhint
))
7462 XSETCAR (cachelist
, XCAR (keyhint
));
7465 else if (STRINGP (tem
))
7467 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7468 XSETCAR (cachelist
, Qt
);
7472 tem
= XCAR (cachelist
);
7479 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7481 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7484 def
= XCAR (prefix
);
7485 prefix
= XCDR (prefix
);
7488 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7490 if (!update_menu_bindings
)
7492 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7494 if (newcache
/* Always check first time. */
7495 /* Should we check everything when precomputing key
7497 /* If something had no key binding before, don't recheck it
7498 because that is too slow--except if we have a list of
7499 rebound commands in Vdefine_key_rebound_commands, do
7500 recheck any command that appears in that list. */
7501 || (CONSP (Vdefine_key_rebound_commands
)
7502 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7505 /* We had a saved key. Is it still bound to the command? */
7508 /* If the command is an alias for another
7509 (such as lmenu.el set it up), check if the
7510 original command matches the cached command. */
7511 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7512 chkcache
= 1; /* Need to recompute key binding. */
7516 /* Recompute equivalent key binding. If the command is an alias
7517 for another (such as lmenu.el set it up), see if the original
7518 command name has equivalent keys. Otherwise look up the
7519 specified command itself. We don't try both, because that
7520 makes lmenu menus slow. */
7522 && SYMBOLP (XSYMBOL (def
)->function
)
7523 && ! NILP (Fget (def
, Qmenu_alias
)))
7524 def
= XSYMBOL (def
)->function
;
7525 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7526 XSETCAR (cachelist
, tem
);
7529 XSETCDR (cachelist
, Qnil
);
7533 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7535 tem
= XCAR (cachelist
);
7539 newcache
= chkcache
;
7542 tem
= Fkey_description (tem
, Qnil
);
7545 if (STRINGP (XCAR (prefix
)))
7546 tem
= concat2 (XCAR (prefix
), tem
);
7547 if (STRINGP (XCDR (prefix
)))
7548 tem
= concat2 (tem
, XCDR (prefix
));
7550 XSETCDR (cachelist
, tem
);
7554 tem
= XCDR (cachelist
);
7555 if (newcache
&& !NILP (tem
))
7557 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7558 XSETCDR (cachelist
, tem
);
7561 /* If we only want to precompute equivalent key bindings, stop here. */
7565 /* If we have an equivalent key binding, use that. */
7566 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7568 /* Include this when menu help is implemented.
7569 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7570 if (!(NILP (tem) || STRINGP (tem)))
7572 tem = menu_item_eval_property (tem);
7575 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7579 /* Handle radio buttons or toggle boxes. */
7580 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7582 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7583 = menu_item_eval_property (tem
);
7590 /***********************************************************************
7592 ***********************************************************************/
7594 /* A vector holding tool bar items while they are parsed in function
7595 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7598 static Lisp_Object tool_bar_items_vector
;
7600 /* A vector holding the result of parse_tool_bar_item. Layout is like
7601 the one for a single item in tool_bar_items_vector. */
7603 static Lisp_Object tool_bar_item_properties
;
7605 /* Next free index in tool_bar_items_vector. */
7607 static int ntool_bar_items
;
7609 /* The symbols `tool-bar', and `:image'. */
7611 extern Lisp_Object Qtool_bar
;
7612 Lisp_Object QCimage
;
7614 /* Function prototypes. */
7616 static void init_tool_bar_items
P_ ((Lisp_Object
));
7617 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7618 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7619 static void append_tool_bar_item
P_ ((void));
7622 /* Return a vector of tool bar items for keymaps currently in effect.
7623 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7624 tool bar items found. */
7627 tool_bar_items (reuse
, nitems
)
7638 /* In order to build the menus, we need to call the keymap
7639 accessors. They all call QUIT. But this function is called
7640 during redisplay, during which a quit is fatal. So inhibit
7641 quitting while building the menus. We do this instead of
7642 specbind because (1) errors will clear it anyway and (2) this
7643 avoids risk of specpdl overflow. */
7644 oquit
= Vinhibit_quit
;
7647 /* Initialize tool_bar_items_vector and protect it from GC. */
7648 init_tool_bar_items (reuse
);
7650 /* Build list of keymaps in maps. Set nmaps to the number of maps
7653 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7654 if (!NILP (Voverriding_local_map_menu_flag
))
7656 /* Yes, use them (if non-nil) as well as the global map. */
7657 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7659 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7660 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7661 if (!NILP (Voverriding_local_map
))
7662 maps
[nmaps
++] = Voverriding_local_map
;
7666 /* No, so use major and minor mode keymaps and keymap property.
7667 Note that tool-bar bindings in the local-map and keymap
7668 properties may not work reliable, as they are only
7669 recognized when the tool-bar (or mode-line) is updated,
7670 which does not normally happen after every command. */
7673 nminor
= current_minor_maps (NULL
, &tmaps
);
7674 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7676 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7677 maps
[nmaps
++] = tem
;
7678 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7680 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7683 /* Add global keymap at the end. */
7684 maps
[nmaps
++] = current_global_map
;
7686 /* Process maps in reverse order and look up in each map the prefix
7688 for (i
= nmaps
- 1; i
>= 0; --i
)
7689 if (!NILP (maps
[i
]))
7693 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7698 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7699 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7701 Lisp_Object keydef
= XCAR (tail
);
7703 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7708 Vinhibit_quit
= oquit
;
7709 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7710 return tool_bar_items_vector
;
7714 /* Process the definition of KEY which is DEF. */
7717 process_tool_bar_item (key
, def
)
7718 Lisp_Object key
, def
;
7721 extern Lisp_Object Qundefined
;
7722 struct gcpro gcpro1
, gcpro2
;
7724 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7728 if (EQ (def
, Qundefined
))
7730 /* If a map has an explicit `undefined' as definition,
7731 discard any previously made item. */
7732 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7734 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7736 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7738 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7739 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7740 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7741 * sizeof (Lisp_Object
)));
7742 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7747 else if (parse_tool_bar_item (key
, def
))
7748 /* Append a new tool bar item to tool_bar_items_vector. Accept
7749 more than one definition for the same key. */
7750 append_tool_bar_item ();
7756 /* Parse a tool bar item specification ITEM for key KEY and return the
7757 result in tool_bar_item_properties. Value is zero if ITEM is
7760 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7762 CAPTION is the caption of the item, If it's not a string, it is
7763 evaluated to get a string.
7765 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7766 as binding are currently ignored.
7768 The following properties are recognized:
7772 FORM is evaluated and specifies whether the tool bar item is
7773 enabled or disabled.
7777 FORM is evaluated and specifies whether the tool bar item is visible.
7779 - `:filter FUNCTION'
7781 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7782 result is stored as the new binding.
7784 - `:button (TYPE SELECTED)'
7786 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7787 and specifies whether the button is selected (pressed) or not.
7791 IMAGES is either a single image specification or a vector of four
7792 image specifications. See enum tool_bar_item_images.
7794 - `:help HELP-STRING'.
7796 Gives a help string to display for the tool bar item. */
7799 parse_tool_bar_item (key
, item
)
7800 Lisp_Object key
, item
;
7802 /* Access slot with index IDX of vector tool_bar_item_properties. */
7803 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7805 Lisp_Object filter
= Qnil
;
7806 Lisp_Object caption
;
7809 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7810 Rule out items that aren't lists, don't start with
7811 `menu-item' or whose rest following `tool-bar-item' is not a
7814 || !EQ (XCAR (item
), Qmenu_item
)
7815 || (item
= XCDR (item
),
7819 /* Create tool_bar_item_properties vector if necessary. Reset it to
7821 if (VECTORP (tool_bar_item_properties
))
7823 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7827 tool_bar_item_properties
7828 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7831 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7832 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7834 /* Get the caption of the item. If the caption is not a string,
7835 evaluate it to get a string. If we don't get a string, skip this
7837 caption
= XCAR (item
);
7838 if (!STRINGP (caption
))
7840 caption
= menu_item_eval_property (caption
);
7841 if (!STRINGP (caption
))
7844 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7846 /* Give up if rest following the caption is not a list. */
7851 /* Store the binding. */
7852 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7855 /* Ignore cached key binding, if any. */
7856 if (CONSP (item
) && CONSP (XCAR (item
)))
7859 /* Process the rest of the properties. */
7860 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7862 Lisp_Object key
, value
;
7865 value
= XCAR (XCDR (item
));
7867 if (EQ (key
, QCenable
))
7868 /* `:enable FORM'. */
7869 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7870 else if (EQ (key
, QCvisible
))
7872 /* `:visible FORM'. If got a visible property and that
7873 evaluates to nil then ignore this item. */
7874 if (NILP (menu_item_eval_property (value
)))
7877 else if (EQ (key
, QChelp
))
7878 /* `:help HELP-STRING'. */
7879 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7880 else if (EQ (key
, QCfilter
))
7881 /* ':filter FORM'. */
7883 else if (EQ (key
, QCbutton
) && CONSP (value
))
7885 /* `:button (TYPE . SELECTED)'. */
7886 Lisp_Object type
, selected
;
7888 type
= XCAR (value
);
7889 selected
= XCDR (value
);
7890 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7892 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7893 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7896 else if (EQ (key
, QCimage
)
7898 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7899 /* Value is either a single image specification or a vector
7900 of 4 such specifications for the different button states. */
7901 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7904 /* If got a filter apply it on binding. */
7906 PROP (TOOL_BAR_ITEM_BINDING
)
7907 = menu_item_eval_property (list2 (filter
,
7909 PROP (TOOL_BAR_ITEM_BINDING
))));
7911 /* See if the binding is a keymap. Give up if it is. */
7912 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7915 /* Enable or disable selection of item. */
7916 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7917 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7918 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7920 /* Handle radio buttons or toggle boxes. */
7921 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7922 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7923 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7931 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7932 that can be reused. */
7935 init_tool_bar_items (reuse
)
7938 if (VECTORP (reuse
))
7939 tool_bar_items_vector
= reuse
;
7941 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7942 ntool_bar_items
= 0;
7946 /* Append parsed tool bar item properties from
7947 tool_bar_item_properties */
7950 append_tool_bar_item ()
7952 Lisp_Object
*to
, *from
;
7954 /* Enlarge tool_bar_items_vector if necessary. */
7955 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7956 >= XVECTOR (tool_bar_items_vector
)->size
)
7958 Lisp_Object new_vector
;
7959 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7961 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7962 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7963 XVECTOR (new_vector
)->contents
,
7964 old_size
* sizeof (Lisp_Object
));
7965 tool_bar_items_vector
= new_vector
;
7968 /* Append entries from tool_bar_item_properties to the end of
7969 tool_bar_items_vector. */
7970 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7971 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7972 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7973 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
7980 /* Read a character using menus based on maps in the array MAPS.
7981 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
7982 Return t if we displayed a menu but the user rejected it.
7984 PREV_EVENT is the previous input event, or nil if we are reading
7985 the first event of a key sequence.
7987 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
7988 if we used a mouse menu to read the input, or zero otherwise. If
7989 USED_MOUSE_MENU is null, we don't dereference it.
7991 The prompting is done based on the prompt-string of the map
7992 and the strings associated with various map elements.
7994 This can be done with X menus or with menus put in the minibuf.
7995 These are done in different ways, depending on how the input will be read.
7996 Menus using X are done after auto-saving in read-char, getting the input
7997 event from Fx_popup_menu; menus using the minibuf use read_char recursively
7998 and do auto-saving in the inner call of read_char. */
8001 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8004 Lisp_Object prev_event
;
8005 int *used_mouse_menu
;
8008 register Lisp_Object name
= Qnil
;
8010 if (used_mouse_menu
)
8011 *used_mouse_menu
= 0;
8013 /* Use local over global Menu maps */
8015 if (! menu_prompting
)
8018 /* Optionally disregard all but the global map. */
8019 if (inhibit_local_menu_bar_menus
)
8021 maps
+= (nmaps
- 1);
8025 /* Get the menu name from the first map that has one (a prompt string). */
8026 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8028 name
= Fkeymap_prompt (maps
[mapno
]);
8033 /* If we don't have any menus, just read a character normally. */
8034 if (!STRINGP (name
))
8038 /* If we got to this point via a mouse click,
8039 use a real menu for mouse selection. */
8040 if (EVENT_HAS_PARAMETERS (prev_event
)
8041 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8042 && !EQ (XCAR (prev_event
), Qtool_bar
))
8044 /* Display the menu and get the selection. */
8045 Lisp_Object
*realmaps
8046 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8050 /* Use the maps that are not nil. */
8051 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8052 if (!NILP (maps
[mapno
]))
8053 realmaps
[nmaps1
++] = maps
[mapno
];
8055 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8060 record_menu_key (XCAR (value
));
8062 /* If we got multiple events, unread all but
8064 There is no way to prevent those unread events
8065 from showing up later in last_nonmenu_event.
8066 So turn symbol and integer events into lists,
8067 to indicate that they came from a mouse menu,
8068 so that when present in last_nonmenu_event
8069 they won't confuse things. */
8070 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8072 record_menu_key (XCAR (tem
));
8073 if (SYMBOLP (XCAR (tem
))
8074 || INTEGERP (XCAR (tem
)))
8075 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8078 /* If we got more than one event, put all but the first
8079 onto this list to be read later.
8080 Return just the first event now. */
8081 Vunread_command_events
8082 = nconc2 (XCDR (value
), Vunread_command_events
);
8083 value
= XCAR (value
);
8085 else if (NILP (value
))
8087 if (used_mouse_menu
)
8088 *used_mouse_menu
= 1;
8091 #endif /* HAVE_MENUS */
8095 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8096 We make this bigger when necessary, and never free it. */
8097 static char *read_char_minibuf_menu_text
;
8098 /* Size of that buffer. */
8099 static int read_char_minibuf_menu_width
;
8102 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8108 register Lisp_Object name
;
8110 /* FIXME: Use the minibuffer's frame width. */
8111 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8114 Lisp_Object rest
, vector
;
8120 if (! menu_prompting
)
8123 /* Make sure we have a big enough buffer for the menu text. */
8124 if (read_char_minibuf_menu_text
== 0)
8126 read_char_minibuf_menu_width
= width
+ 4;
8127 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8129 else if (width
+ 4 > read_char_minibuf_menu_width
)
8131 read_char_minibuf_menu_width
= width
+ 4;
8132 read_char_minibuf_menu_text
8133 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8135 menu
= read_char_minibuf_menu_text
;
8137 /* Get the menu name from the first map that has one (a prompt string). */
8138 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8140 name
= Fkeymap_prompt (maps
[mapno
]);
8145 /* If we don't have any menus, just read a character normally. */
8146 if (!STRINGP (name
))
8149 /* Prompt string always starts with map's prompt, and a space. */
8150 strcpy (menu
, SDATA (name
));
8151 nlength
= SBYTES (name
);
8152 menu
[nlength
++] = ':';
8153 menu
[nlength
++] = ' ';
8156 /* Start prompting at start of first map. */
8160 /* Present the documented bindings, a line at a time. */
8167 Lisp_Object orig_defn_macro
;
8169 /* Loop over elements of map. */
8174 /* If reached end of map, start at beginning of next map. */
8178 /* At end of last map, wrap around to first map if just starting,
8179 or end this line if already have something on it. */
8183 if (notfirst
|| nobindings
) break;
8188 /* Look at the next element of the map. */
8190 elt
= XVECTOR (vector
)->contents
[idx
];
8192 elt
= Fcar_safe (rest
);
8194 if (idx
< 0 && VECTORP (elt
))
8196 /* If we found a dense table in the keymap,
8197 advanced past it, but start scanning its contents. */
8198 rest
= Fcdr_safe (rest
);
8204 /* An ordinary element. */
8205 Lisp_Object event
, tem
;
8209 event
= Fcar_safe (elt
); /* alist */
8210 elt
= Fcdr_safe (elt
);
8214 XSETINT (event
, idx
); /* vector */
8217 /* Ignore the element if it has no prompt string. */
8218 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8220 /* 1 if the char to type matches the string. */
8222 Lisp_Object upcased_event
, downcased_event
;
8223 Lisp_Object desc
= Qnil
;
8225 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8227 upcased_event
= Fupcase (event
);
8228 downcased_event
= Fdowncase (event
);
8229 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8230 || XINT (downcased_event
) == SREF (s
, 0));
8232 desc
= Fsingle_key_description (event
, Qnil
);
8234 #if 0 /* It is redundant to list the equivalent key bindings because
8235 the prefix is what the user has already typed. */
8237 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8239 /* Insert equivalent keybinding. */
8240 s
= concat2 (s
, tem
);
8243 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8244 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8246 /* Insert button prefix. */
8247 Lisp_Object selected
8248 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8249 if (EQ (tem
, QCradio
))
8250 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8252 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8253 s
= concat2 (tem
, s
);
8257 /* If we have room for the prompt string, add it to this line.
8258 If this is the first on the line, always add it. */
8259 if ((SCHARS (s
) + i
+ 2
8260 + (char_matches
? 0 : SCHARS (desc
) + 3))
8266 /* Punctuate between strings. */
8269 strcpy (menu
+ i
, ", ");
8275 /* If the char to type doesn't match the string's
8276 first char, explicitly show what char to type. */
8279 /* Add as much of string as fits. */
8280 thiswidth
= SCHARS (desc
);
8281 if (thiswidth
+ i
> width
)
8282 thiswidth
= width
- i
;
8283 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8285 strcpy (menu
+ i
, " = ");
8289 /* Add as much of string as fits. */
8290 thiswidth
= SCHARS (s
);
8291 if (thiswidth
+ i
> width
)
8292 thiswidth
= width
- i
;
8293 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8299 /* If this element does not fit, end the line now,
8300 and save the element for the next line. */
8301 strcpy (menu
+ i
, "...");
8306 /* Move past this element. */
8307 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8308 /* Handle reaching end of dense table. */
8313 rest
= Fcdr_safe (rest
);
8317 /* Prompt with that and read response. */
8318 message2_nolog (menu
, strlen (menu
),
8319 ! NILP (current_buffer
->enable_multibyte_characters
));
8321 /* Make believe its not a keyboard macro in case the help char
8322 is pressed. Help characters are not recorded because menu prompting
8323 is not used on replay.
8325 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8326 current_kboard
->defining_kbd_macro
= Qnil
;
8328 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8329 while (BUFFERP (obj
));
8330 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8332 if (!INTEGERP (obj
))
8337 if (! EQ (obj
, menu_prompt_more_char
)
8338 && (!INTEGERP (menu_prompt_more_char
)
8339 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8341 if (!NILP (current_kboard
->defining_kbd_macro
))
8342 store_kbd_macro_char (obj
);
8345 /* Help char - go round again */
8349 /* Reading key sequences. */
8351 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8352 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8353 keymap, or nil otherwise. Return the index of the first keymap in
8354 which KEY has any binding, or NMAPS if no map has a binding.
8356 If KEY is a meta ASCII character, treat it like meta-prefix-char
8357 followed by the corresponding non-meta character. Keymaps in
8358 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8361 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8364 NEXT may be the same array as CURRENT. */
8367 follow_key (key
, nmaps
, current
, defs
, next
)
8369 Lisp_Object
*current
, *defs
, *next
;
8372 int i
, first_binding
;
8374 first_binding
= nmaps
;
8375 for (i
= nmaps
- 1; i
>= 0; i
--)
8377 if (! NILP (current
[i
]))
8379 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8380 if (! NILP (defs
[i
]))
8387 /* Given the set of bindings we've found, produce the next set of maps. */
8388 if (first_binding
< nmaps
)
8389 for (i
= 0; i
< nmaps
; i
++)
8390 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8392 return first_binding
;
8395 /* Structure used to keep track of partial application of key remapping
8396 such as Vfunction_key_map and Vkey_translation_map. */
8397 typedef struct keyremap
8399 Lisp_Object map
, parent
;
8403 /* Lookup KEY in MAP.
8404 MAP is a keymap mapping keys to key vectors or functions.
8405 If the mapping is a function and DO_FUNCTION is non-zero, then
8406 the function is called with PROMPT as parameter and its return
8407 value is used as the return value of this function (after checking
8408 that it is indeed a vector). */
8411 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8412 Lisp_Object map
, key
, prompt
;
8417 next
= access_keymap (map
, key
, 1, 0, 1);
8419 /* Handle symbol with autoload definition. */
8420 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8421 && CONSP (XSYMBOL (next
)->function
)
8422 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8423 do_autoload (XSYMBOL (next
)->function
, next
);
8425 /* Handle a symbol whose function definition is a keymap
8427 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8428 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8429 || KEYMAPP (XSYMBOL (next
)->function
)))
8430 next
= XSYMBOL (next
)->function
;
8432 /* If the keymap gives a function, not an
8433 array, then call the function with one arg and use
8434 its value instead. */
8435 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8440 next
= call1 (next
, prompt
);
8441 /* If the function returned something invalid,
8442 barf--don't ignore it.
8443 (To ignore it safely, we would need to gcpro a bunch of
8444 other variables.) */
8445 if (! (VECTORP (next
) || STRINGP (next
)))
8446 error ("Function %s returns invalid key sequence", tem
);
8451 /* Do one step of the key remapping used for function-key-map and
8452 key-translation-map:
8453 KEYBUF is the buffer holding the input events.
8454 BUFSIZE is its maximum size.
8455 FKEY is a pointer to the keyremap structure to use.
8456 INPUT is the index of the last element in KEYBUF.
8457 DOIT if non-zero says that the remapping can actually take place.
8458 DIFF is used to return the number of keys added/removed by the remapping.
8459 PARENT is the root of the keymap.
8460 PROMPT is the prompt to use if the remapping happens through a function.
8461 The return value is non-zero if the remapping actually took place. */
8464 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8465 Lisp_Object
*keybuf
, prompt
;
8467 int input
, doit
, *diff
, bufsize
;
8469 Lisp_Object next
, key
;
8471 key
= keybuf
[fkey
->end
++];
8472 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8474 /* If keybuf[fkey->start..fkey->end] is bound in the
8475 map and we're in a position to do the key remapping, replace it with
8476 the binding and restart with fkey->start at the end. */
8477 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8479 int len
= XFASTINT (Flength (next
));
8482 *diff
= len
- (fkey
->end
- fkey
->start
);
8484 if (input
+ *diff
>= bufsize
)
8485 error ("Key sequence too long");
8487 /* Shift the keys that follow fkey->end. */
8489 for (i
= fkey
->end
; i
< input
; i
++)
8490 keybuf
[i
+ *diff
] = keybuf
[i
];
8492 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8493 keybuf
[i
+ *diff
] = keybuf
[i
];
8494 /* Overwrite the old keys with the new ones. */
8495 for (i
= 0; i
< len
; i
++)
8496 keybuf
[fkey
->start
+ i
]
8497 = Faref (next
, make_number (i
));
8499 fkey
->start
= fkey
->end
+= *diff
;
8500 fkey
->map
= fkey
->parent
;
8505 fkey
->map
= get_keymap (next
, 0, 1);
8507 /* If we no longer have a bound suffix, try a new position for
8509 if (!CONSP (fkey
->map
))
8511 fkey
->end
= ++fkey
->start
;
8512 fkey
->map
= fkey
->parent
;
8517 /* Read a sequence of keys that ends with a non prefix character,
8518 storing it in KEYBUF, a buffer of size BUFSIZE.
8520 Return the length of the key sequence stored.
8521 Return -1 if the user rejected a command menu.
8523 Echo starting immediately unless `prompt' is 0.
8525 Where a key sequence ends depends on the currently active keymaps.
8526 These include any minor mode keymaps active in the current buffer,
8527 the current buffer's local map, and the global map.
8529 If a key sequence has no other bindings, we check Vfunction_key_map
8530 to see if some trailing subsequence might be the beginning of a
8531 function key's sequence. If so, we try to read the whole function
8532 key, and substitute its symbolic name into the key sequence.
8534 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8535 `double-' events into similar click events, if that would make them
8536 bound. We try to turn `triple-' events first into `double-' events,
8539 If we get a mouse click in a mode line, vertical divider, or other
8540 non-text area, we treat the click as if it were prefixed by the
8541 symbol denoting that area - `mode-line', `vertical-line', or
8544 If the sequence starts with a mouse click, we read the key sequence
8545 with respect to the buffer clicked on, not the current buffer.
8547 If the user switches frames in the midst of a key sequence, we put
8548 off the switch-frame event until later; the next call to
8549 read_char will return it.
8551 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8552 from the selected window's buffer. */
8555 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8556 can_return_switch_frame
, fix_current_buffer
)
8557 Lisp_Object
*keybuf
;
8560 int dont_downcase_last
;
8561 int can_return_switch_frame
;
8562 int fix_current_buffer
;
8564 volatile Lisp_Object from_string
;
8565 volatile int count
= SPECPDL_INDEX ();
8567 /* How many keys there are in the current key sequence. */
8570 /* The length of the echo buffer when we started reading, and
8571 the length of this_command_keys when we started reading. */
8572 volatile int echo_start
;
8573 volatile int keys_start
;
8575 /* The number of keymaps we're scanning right now, and the number of
8576 keymaps we have allocated space for. */
8578 volatile int nmaps_allocated
= 0;
8580 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8581 the current keymaps. */
8582 Lisp_Object
*volatile defs
= NULL
;
8584 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8585 in the current keymaps, or nil where it is not a prefix. */
8586 Lisp_Object
*volatile submaps
= NULL
;
8588 /* The local map to start out with at start of key sequence. */
8589 volatile Lisp_Object orig_local_map
;
8591 /* The map from the `keymap' property to start out with at start of
8593 volatile Lisp_Object orig_keymap
;
8595 /* 1 if we have already considered switching to the local-map property
8596 of the place where a mouse click occurred. */
8597 volatile int localized_local_map
= 0;
8599 /* The index in defs[] of the first keymap that has a binding for
8600 this key sequence. In other words, the lowest i such that
8601 defs[i] is non-nil. */
8602 volatile int first_binding
;
8603 /* Index of the first key that has no binding.
8604 It is useless to try fkey.start larger than that. */
8605 volatile int first_unbound
;
8607 /* If t < mock_input, then KEYBUF[t] should be read as the next
8610 We use this to recover after recognizing a function key. Once we
8611 realize that a suffix of the current key sequence is actually a
8612 function key's escape sequence, we replace the suffix with the
8613 function key's binding from Vfunction_key_map. Now keybuf
8614 contains a new and different key sequence, so the echo area,
8615 this_command_keys, and the submaps and defs arrays are wrong. In
8616 this situation, we set mock_input to t, set t to 0, and jump to
8617 restart_sequence; the loop will read keys from keybuf up until
8618 mock_input, thus rebuilding the state; and then it will resume
8619 reading characters from the keyboard. */
8620 volatile int mock_input
= 0;
8622 /* If the sequence is unbound in submaps[], then
8623 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8624 and fkey.map is its binding.
8626 These might be > t, indicating that all function key scanning
8627 should hold off until t reaches them. We do this when we've just
8628 recognized a function key, to avoid searching for the function
8629 key's again in Vfunction_key_map. */
8630 volatile keyremap fkey
;
8632 /* Likewise, for key_translation_map. */
8633 volatile keyremap keytran
;
8635 /* If we receive a `switch-frame' or `select-window' event in the middle of
8636 a key sequence, we put it off for later.
8637 While we're reading, we keep the event here. */
8638 volatile Lisp_Object delayed_switch_frame
;
8640 /* See the comment below... */
8641 #if defined (GOBBLE_FIRST_EVENT)
8642 Lisp_Object first_event
;
8645 volatile Lisp_Object original_uppercase
;
8646 volatile int original_uppercase_position
= -1;
8648 /* Gets around Microsoft compiler limitations. */
8651 struct buffer
*starting_buffer
;
8653 /* List of events for which a fake prefix key has been generated. */
8654 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8656 #if defined (GOBBLE_FIRST_EVENT)
8660 struct gcpro gcpro1
;
8662 GCPRO1 (fake_prefixed_keys
);
8663 raw_keybuf_count
= 0;
8665 last_nonmenu_event
= Qnil
;
8667 delayed_switch_frame
= Qnil
;
8668 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
8669 keytran
.map
= keytran
.parent
= current_kboard
->Vlocal_key_translation_map
;
8670 /* If there is no translation-map, turn off scanning. */
8671 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8672 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8677 echo_prompt (prompt
);
8678 else if (cursor_in_echo_area
8679 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8680 && NILP (Fzerop (Vecho_keystrokes
)))
8681 /* This doesn't put in a dash if the echo buffer is empty, so
8682 you don't always see a dash hanging out in the minibuffer. */
8686 /* Record the initial state of the echo area and this_command_keys;
8687 we will need to restore them if we replay a key sequence. */
8689 echo_start
= echo_length ();
8690 keys_start
= this_command_key_count
;
8691 this_single_command_key_start
= keys_start
;
8693 #if defined (GOBBLE_FIRST_EVENT)
8694 /* This doesn't quite work, because some of the things that read_char
8695 does cannot safely be bypassed. It seems too risky to try to make
8698 /* Read the first char of the sequence specially, before setting
8699 up any keymaps, in case a filter runs and switches buffers on us. */
8700 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8702 #endif /* GOBBLE_FIRST_EVENT */
8704 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8705 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8708 /* We jump here when the key sequence has been thoroughly changed, and
8709 we need to rescan it starting from the beginning. When we jump here,
8710 keybuf[0..mock_input] holds the sequence we should reread. */
8713 starting_buffer
= current_buffer
;
8714 first_unbound
= bufsize
+ 1;
8716 /* Build our list of keymaps.
8717 If we recognize a function key and replace its escape sequence in
8718 keybuf with its symbol, or if the sequence starts with a mouse
8719 click and we need to switch buffers, we jump back here to rebuild
8720 the initial keymaps from the current buffer. */
8723 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8724 || !NILP (Voverriding_local_map
))
8726 if (3 > nmaps_allocated
)
8728 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8729 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8730 nmaps_allocated
= 3;
8732 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8733 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8734 if (!NILP (Voverriding_local_map
))
8735 submaps
[nmaps
++] = Voverriding_local_map
;
8743 nminor
= current_minor_maps (0, &maps
);
8744 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8746 if (total
> nmaps_allocated
)
8748 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8749 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8750 nmaps_allocated
= total
;
8753 if (!NILP (orig_keymap
))
8754 submaps
[nmaps
++] = orig_keymap
;
8756 bcopy (maps
, (void *) (submaps
+ nmaps
),
8757 nminor
* sizeof (submaps
[0]));
8761 submaps
[nmaps
++] = orig_local_map
;
8763 submaps
[nmaps
++] = current_global_map
;
8765 /* Find an accurate initial value for first_binding. */
8766 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8767 if (! NILP (submaps
[first_binding
]))
8770 /* Start from the beginning in keybuf. */
8773 /* These are no-ops the first time through, but if we restart, they
8774 revert the echo area and this_command_keys to their original state. */
8775 this_command_key_count
= keys_start
;
8776 if (INTERACTIVE
&& t
< mock_input
)
8777 echo_truncate (echo_start
);
8779 /* If the best binding for the current key sequence is a keymap, or
8780 we may be looking at a function key's escape sequence, keep on
8782 while (first_binding
< nmaps
8783 /* Keep reading as long as there's a prefix binding. */
8784 ? !NILP (submaps
[first_binding
])
8785 /* Don't return in the middle of a possible function key sequence,
8786 if the only bindings we found were via case conversion.
8787 Thus, if ESC O a has a function-key-map translation
8788 and ESC o has a binding, don't return after ESC O,
8789 so that we can translate ESC O plus the next character. */
8790 : (fkey
.start
< t
|| keytran
.start
< t
))
8793 int used_mouse_menu
= 0;
8795 /* Where the last real key started. If we need to throw away a
8796 key that has expanded into more than one element of keybuf
8797 (say, a mouse click on the mode line which is being treated
8798 as [mode-line (mouse-...)], then we backtrack to this point
8800 volatile int last_real_key_start
;
8802 /* These variables are analogous to echo_start and keys_start;
8803 while those allow us to restart the entire key sequence,
8804 echo_local_start and keys_local_start allow us to throw away
8806 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8808 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8809 eassert (fkey
.start
<= fkey
.end
);
8810 eassert (keytran
.start
<= keytran
.end
);
8811 /* key-translation-map is applied *after* function-key-map. */
8812 eassert (keytran
.end
<= fkey
.start
);
8814 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8815 { /* The prefix upto first_unbound has no binding and has
8816 no translation left to do either, so we know it's unbound.
8817 If we don't stop now, we risk staying here indefinitely
8818 (if the user keeps entering fkey or keytran prefixes
8819 like C-c ESC ESC ESC ESC ...) */
8821 for (i
= first_unbound
+ 1; i
< t
; i
++)
8822 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8823 mock_input
= t
- first_unbound
- 1;
8824 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8825 fkey
.map
= fkey
.parent
;
8826 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8827 keytran
.map
= keytran
.parent
;
8828 goto replay_sequence
;
8832 error ("Key sequence too long");
8835 echo_local_start
= echo_length ();
8836 keys_local_start
= this_command_key_count
;
8837 local_first_binding
= first_binding
;
8840 /* These are no-ops, unless we throw away a keystroke below and
8841 jumped back up to replay_key; in that case, these restore the
8842 variables to their original state, allowing us to replay the
8844 if (INTERACTIVE
&& t
< mock_input
)
8845 echo_truncate (echo_local_start
);
8846 this_command_key_count
= keys_local_start
;
8847 first_binding
= local_first_binding
;
8849 /* By default, assume each event is "real". */
8850 last_real_key_start
= t
;
8852 /* Does mock_input indicate that we are re-reading a key sequence? */
8856 add_command_key (key
);
8857 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8858 && NILP (Fzerop (Vecho_keystrokes
)))
8862 /* If not, we should actually read a character. */
8867 KBOARD
*interrupted_kboard
= current_kboard
;
8868 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8869 if (setjmp (wrong_kboard_jmpbuf
))
8871 if (!NILP (delayed_switch_frame
))
8873 interrupted_kboard
->kbd_queue
8874 = Fcons (delayed_switch_frame
,
8875 interrupted_kboard
->kbd_queue
);
8876 delayed_switch_frame
= Qnil
;
8879 interrupted_kboard
->kbd_queue
8880 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8882 /* If the side queue is non-empty, ensure it begins with a
8883 switch-frame, so we'll replay it in the right context. */
8884 if (CONSP (interrupted_kboard
->kbd_queue
)
8885 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8886 !(EVENT_HAS_PARAMETERS (key
)
8887 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8891 XSETFRAME (frame
, interrupted_frame
);
8892 interrupted_kboard
->kbd_queue
8893 = Fcons (make_lispy_switch_frame (frame
),
8894 interrupted_kboard
->kbd_queue
);
8897 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8898 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8899 goto replay_sequence
;
8902 key
= read_char (NILP (prompt
), nmaps
,
8903 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8907 /* read_char returns t when it shows a menu and the user rejects it.
8911 unbind_to (count
, Qnil
);
8916 /* read_char returns -1 at the end of a macro.
8917 Emacs 18 handles this by returning immediately with a
8918 zero, so that's what we'll do. */
8919 if (INTEGERP (key
) && XINT (key
) == -1)
8922 /* The Microsoft C compiler can't handle the goto that
8928 /* If the current buffer has been changed from under us, the
8929 keymap may have changed, so replay the sequence. */
8932 timer_resume_idle ();
8935 /* Reset the current buffer from the selected window
8936 in case something changed the former and not the latter.
8937 This is to be more consistent with the behavior
8938 of the command_loop_1. */
8939 if (fix_current_buffer
)
8941 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8943 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8944 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8947 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8948 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8949 goto replay_sequence
;
8952 /* If we have a quit that was typed in another frame, and
8953 quit_throw_to_read_char switched buffers,
8954 replay to get the right keymap. */
8956 && XINT (key
) == quit_char
8957 && current_buffer
!= starting_buffer
)
8960 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8964 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8965 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8966 goto replay_sequence
;
8971 if (EVENT_HAS_PARAMETERS (key
)
8972 /* Either a `switch-frame' or a `select-window' event. */
8973 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
8975 /* If we're at the beginning of a key sequence, and the caller
8976 says it's okay, go ahead and return this event. If we're
8977 in the midst of a key sequence, delay it until the end. */
8978 if (t
> 0 || !can_return_switch_frame
)
8980 delayed_switch_frame
= key
;
8986 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8989 /* Clicks in non-text areas get prefixed by the symbol
8990 in their CHAR-ADDRESS field. For example, a click on
8991 the mode line is prefixed by the symbol `mode-line'.
8993 Furthermore, key sequences beginning with mouse clicks
8994 are read using the keymaps of the buffer clicked on, not
8995 the current buffer. So we may have to switch the buffer
8998 When we turn one event into two events, we must make sure
8999 that neither of the two looks like the original--so that,
9000 if we replay the events, they won't be expanded again.
9001 If not for this, such reexpansion could happen either here
9002 or when user programs play with this-command-keys. */
9003 if (EVENT_HAS_PARAMETERS (key
))
9008 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9009 if (EQ (kind
, Qmouse_click
))
9011 Lisp_Object window
, posn
;
9013 window
= POSN_WINDOW (EVENT_START (key
));
9014 posn
= POSN_POSN (EVENT_START (key
));
9017 || (!NILP (fake_prefixed_keys
)
9018 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9020 /* We're looking a second time at an event for which
9021 we generated a fake prefix key. Set
9022 last_real_key_start appropriately. */
9024 last_real_key_start
= t
- 1;
9027 /* Key sequences beginning with mouse clicks are
9028 read using the keymaps in the buffer clicked on,
9029 not the current buffer. If we're at the
9030 beginning of a key sequence, switch buffers. */
9031 if (last_real_key_start
== 0
9033 && BUFFERP (XWINDOW (window
)->buffer
)
9034 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9036 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9040 /* Arrange to go back to the original buffer once we're
9041 done reading the key sequence. Note that we can't
9042 use save_excursion_{save,restore} here, because they
9043 save point as well as the current buffer; we don't
9044 want to save point, because redisplay may change it,
9045 to accommodate a Fset_window_start or something. We
9046 don't want to do this at the top of the function,
9047 because we may get input from a subprocess which
9048 wants to change the selected window and stuff (say,
9050 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9052 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9054 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9055 orig_local_map
= get_local_map (PT
, current_buffer
,
9057 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9058 goto replay_sequence
;
9061 /* For a mouse click, get the local text-property keymap
9062 of the place clicked on, rather than point. */
9063 if (last_real_key_start
== 0
9064 && CONSP (XCDR (key
))
9065 && ! localized_local_map
)
9067 Lisp_Object map_here
, start
, pos
;
9069 localized_local_map
= 1;
9070 start
= EVENT_START (key
);
9072 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9074 pos
= POSN_BUFFER_POSN (start
);
9076 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9078 map_here
= get_local_map (XINT (pos
),
9079 current_buffer
, Qlocal_map
);
9080 if (!EQ (map_here
, orig_local_map
))
9082 orig_local_map
= map_here
;
9086 goto replay_sequence
;
9088 map_here
= get_local_map (XINT (pos
),
9089 current_buffer
, Qkeymap
);
9090 if (!EQ (map_here
, orig_keymap
))
9092 orig_keymap
= map_here
;
9096 goto replay_sequence
;
9102 /* Expand mode-line and scroll-bar events into two events:
9103 use posn as a fake prefix key. */
9105 && (NILP (fake_prefixed_keys
)
9106 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9108 if (t
+ 1 >= bufsize
)
9109 error ("Key sequence too long");
9112 keybuf
[t
+ 1] = key
;
9115 /* Record that a fake prefix key has been generated
9116 for KEY. Don't modify the event; this would
9117 prevent proper action when the event is pushed
9118 back into unread-command-events. */
9119 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9121 /* If on a mode line string with a local keymap,
9122 reconsider the key sequence with that keymap. */
9123 if (string
= POSN_STRING (EVENT_START (key
)),
9124 (CONSP (string
) && STRINGP (XCAR (string
))))
9126 Lisp_Object pos
, map
, map2
;
9128 pos
= XCDR (string
);
9129 string
= XCAR (string
);
9131 && XINT (pos
) < SCHARS (string
))
9133 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9135 orig_local_map
= map
;
9136 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9139 if (!NILP (map
) || !NILP (map2
))
9140 goto replay_sequence
;
9146 else if (NILP (from_string
)
9147 && (string
= POSN_STRING (EVENT_START (key
)),
9148 (CONSP (string
) && STRINGP (XCAR (string
)))))
9150 /* For a click on a string, i.e. overlay string or a
9151 string displayed via the `display' property,
9152 consider `local-map' and `keymap' properties of
9154 Lisp_Object pos
, map
, map2
;
9156 pos
= XCDR (string
);
9157 string
= XCAR (string
);
9159 && XINT (pos
) < SCHARS (string
))
9161 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9163 orig_local_map
= map
;
9164 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9168 if (!NILP (map
) || !NILP (map2
))
9170 from_string
= string
;
9171 goto replay_sequence
;
9176 else if (CONSP (XCDR (key
))
9177 && CONSP (EVENT_START (key
))
9178 && CONSP (XCDR (EVENT_START (key
))))
9182 posn
= POSN_POSN (EVENT_START (key
));
9183 /* Handle menu-bar events:
9184 insert the dummy prefix event `menu-bar'. */
9185 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9187 if (t
+ 1 >= bufsize
)
9188 error ("Key sequence too long");
9192 /* Zap the position in key, so we know that we've
9193 expanded it, and don't try to do so again. */
9194 POSN_SET_POSN (EVENT_START (key
),
9195 Fcons (posn
, Qnil
));
9198 goto replay_sequence
;
9200 else if (CONSP (posn
))
9202 /* We're looking at the second event of a
9203 sequence which we expanded before. Set
9204 last_real_key_start appropriately. */
9205 if (last_real_key_start
== t
&& t
> 0)
9206 last_real_key_start
= t
- 1;
9211 /* We have finally decided that KEY is something we might want
9213 first_binding
= (follow_key (key
,
9214 nmaps
- first_binding
,
9215 submaps
+ first_binding
,
9216 defs
+ first_binding
,
9217 submaps
+ first_binding
)
9220 /* If KEY wasn't bound, we'll try some fallbacks. */
9221 if (first_binding
< nmaps
)
9222 /* This is needed for the following scenario:
9223 event 0: a down-event that gets dropped by calling replay_key.
9224 event 1: some normal prefix like C-h.
9225 After event 0, first_unbound is 0, after event 1 fkey.start
9226 and keytran.start are both 1, so when we see that C-h is bound,
9227 we need to update first_unbound. */
9228 first_unbound
= max (t
+ 1, first_unbound
);
9233 /* Remember the position to put an upper bound on fkey.start. */
9234 first_unbound
= min (t
, first_unbound
);
9236 head
= EVENT_HEAD (key
);
9237 if (help_char_p (head
) && t
> 0)
9239 read_key_sequence_cmd
= Vprefix_help_command
;
9241 last_nonmenu_event
= key
;
9242 /* The Microsoft C compiler can't handle the goto that
9250 Lisp_Object breakdown
;
9253 breakdown
= parse_modifiers (head
);
9254 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9255 /* Attempt to reduce an unbound mouse event to a simpler
9256 event that is bound:
9257 Drags reduce to clicks.
9258 Double-clicks reduce to clicks.
9259 Triple-clicks reduce to double-clicks, then to clicks.
9260 Down-clicks are eliminated.
9261 Double-downs reduce to downs, then are eliminated.
9262 Triple-downs reduce to double-downs, then to downs,
9263 then are eliminated. */
9264 if (modifiers
& (down_modifier
| drag_modifier
9265 | double_modifier
| triple_modifier
))
9267 while (modifiers
& (down_modifier
| drag_modifier
9268 | double_modifier
| triple_modifier
))
9270 Lisp_Object new_head
, new_click
;
9271 if (modifiers
& triple_modifier
)
9272 modifiers
^= (double_modifier
| triple_modifier
);
9273 else if (modifiers
& double_modifier
)
9274 modifiers
&= ~double_modifier
;
9275 else if (modifiers
& drag_modifier
)
9276 modifiers
&= ~drag_modifier
;
9279 /* Dispose of this `down' event by simply jumping
9280 back to replay_key, to get another event.
9282 Note that if this event came from mock input,
9283 then just jumping back to replay_key will just
9284 hand it to us again. So we have to wipe out any
9287 We could delete keybuf[t] and shift everything
9288 after that to the left by one spot, but we'd also
9289 have to fix up any variable that points into
9290 keybuf, and shifting isn't really necessary
9293 Adding prefixes for non-textual mouse clicks
9294 creates two characters of mock input, and both
9295 must be thrown away. If we're only looking at
9296 the prefix now, we can just jump back to
9297 replay_key. On the other hand, if we've already
9298 processed the prefix, and now the actual click
9299 itself is giving us trouble, then we've lost the
9300 state of the keymaps we want to backtrack to, and
9301 we need to replay the whole sequence to rebuild
9304 Beyond that, only function key expansion could
9305 create more than two keys, but that should never
9306 generate mouse events, so it's okay to zero
9307 mock_input in that case too.
9309 FIXME: The above paragraph seems just plain
9310 wrong, if you consider things like
9311 xterm-mouse-mode. -stef
9313 Isn't this just the most wonderful code ever? */
9315 /* If mock_input > t + 1, the above simplification
9316 will actually end up dropping keys on the floor.
9317 This is probably OK for now, but even
9318 if mock_input <= t + 1, we need to adjust fkey
9320 Typical case [header-line down-mouse-N]:
9321 mock_input = 2, t = 1, fkey.end = 1,
9322 last_real_key_start = 0. */
9323 if (fkey
.end
> last_real_key_start
)
9325 fkey
.end
= fkey
.start
9326 = min (last_real_key_start
, fkey
.start
);
9327 fkey
.map
= fkey
.parent
;
9328 if (keytran
.end
> last_real_key_start
)
9330 keytran
.end
= keytran
.start
9331 = min (last_real_key_start
, keytran
.start
);
9332 keytran
.map
= keytran
.parent
;
9335 if (t
== last_real_key_start
)
9342 mock_input
= last_real_key_start
;
9343 goto replay_sequence
;
9348 = apply_modifiers (modifiers
, XCAR (breakdown
));
9350 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9352 /* Look for a binding for this new key. follow_key
9353 promises that it didn't munge submaps the
9354 last time we called it, since key was unbound. */
9356 = (follow_key (new_click
,
9357 nmaps
- local_first_binding
,
9358 submaps
+ local_first_binding
,
9359 defs
+ local_first_binding
,
9360 submaps
+ local_first_binding
)
9361 + local_first_binding
);
9363 /* If that click is bound, go for it. */
9364 if (first_binding
< nmaps
)
9369 /* Otherwise, we'll leave key set to the drag event. */
9376 /* Normally, last_nonmenu_event gets the previous key we read.
9377 But when a mouse popup menu is being used,
9378 we don't update last_nonmenu_event; it continues to hold the mouse
9379 event that preceded the first level of menu. */
9380 if (!used_mouse_menu
)
9381 last_nonmenu_event
= key
;
9383 /* Record what part of this_command_keys is the current key sequence. */
9384 this_single_command_key_start
= this_command_key_count
- t
;
9386 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9387 /* There is a binding and it's not a prefix.
9388 There is thus no function-key in this sequence.
9389 Moving fkey.start is important in this case to allow keytran.start
9390 to go over the sequence before we return (since we keep the
9391 invariant that keytran.end <= fkey.start). */
9394 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9397 /* If the sequence is unbound, see if we can hang a function key
9398 off the end of it. */
9399 /* Continue scan from fkey.end until we find a bound suffix. */
9400 while (fkey
.end
< t
)
9402 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9405 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9406 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9407 max (t
, mock_input
),
9408 /* If there's a binding (i.e.
9409 first_binding >= nmaps) we don't want
9410 to apply this function-key-mapping. */
9411 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9416 mock_input
= diff
+ max (t
, mock_input
);
9417 goto replay_sequence
;
9421 /* Look for this sequence in key-translation-map.
9422 Scan from keytran.end until we find a bound suffix. */
9423 while (keytran
.end
< fkey
.start
)
9425 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9428 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9429 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9434 mock_input
= diff
+ max (t
, mock_input
);
9435 /* Adjust the function-key-map counters. */
9439 goto replay_sequence
;
9443 /* If KEY is not defined in any of the keymaps,
9444 and cannot be part of a function key or translation,
9445 and is an upper case letter
9446 use the corresponding lower-case letter instead. */
9447 if (first_binding
>= nmaps
9448 && fkey
.start
>= t
&& keytran
.start
>= t
9450 && ((((XINT (key
) & 0x3ffff)
9451 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9452 && UPPERCASEP (XINT (key
) & 0x3ffff))
9453 || (XINT (key
) & shift_modifier
)))
9455 Lisp_Object new_key
;
9457 original_uppercase
= key
;
9458 original_uppercase_position
= t
- 1;
9460 if (XINT (key
) & shift_modifier
)
9461 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9463 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9464 | (XINT (key
) & ~0x3ffff)));
9466 /* We have to do this unconditionally, regardless of whether
9467 the lower-case char is defined in the keymaps, because they
9468 might get translated through function-key-map. */
9469 keybuf
[t
- 1] = new_key
;
9470 mock_input
= max (t
, mock_input
);
9472 goto replay_sequence
;
9474 /* If KEY is not defined in any of the keymaps,
9475 and cannot be part of a function key or translation,
9476 and is a shifted function key,
9477 use the corresponding unshifted function key instead. */
9478 if (first_binding
>= nmaps
9479 && fkey
.start
>= t
&& keytran
.start
>= t
9482 Lisp_Object breakdown
;
9485 breakdown
= parse_modifiers (key
);
9486 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9487 if (modifiers
& shift_modifier
)
9489 Lisp_Object new_key
;
9491 original_uppercase
= key
;
9492 original_uppercase_position
= t
- 1;
9494 modifiers
&= ~shift_modifier
;
9495 new_key
= apply_modifiers (modifiers
,
9498 keybuf
[t
- 1] = new_key
;
9499 mock_input
= max (t
, mock_input
);
9500 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9501 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9503 goto replay_sequence
;
9509 read_key_sequence_cmd
= (first_binding
< nmaps
9510 ? defs
[first_binding
]
9513 unread_switch_frame
= delayed_switch_frame
;
9514 unbind_to (count
, Qnil
);
9516 /* Don't downcase the last character if the caller says don't.
9517 Don't downcase it if the result is undefined, either. */
9518 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9519 && t
- 1 == original_uppercase_position
)
9520 keybuf
[t
- 1] = original_uppercase
;
9522 /* Occasionally we fabricate events, perhaps by expanding something
9523 according to function-key-map, or by adding a prefix symbol to a
9524 mouse click in the scroll bar or modeline. In this cases, return
9525 the entire generated key sequence, even if we hit an unbound
9526 prefix or a definition before the end. This means that you will
9527 be able to push back the event properly, and also means that
9528 read-key-sequence will always return a logical unit.
9531 for (; t
< mock_input
; t
++)
9533 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9534 && NILP (Fzerop (Vecho_keystrokes
)))
9535 echo_char (keybuf
[t
]);
9536 add_command_key (keybuf
[t
]);
9545 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9546 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9547 The sequence is sufficient to specify a non-prefix command in the
9548 current local and global maps.
9550 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9551 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9552 as a continuation of the previous key.
9554 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9555 convert the last event to lower case. (Normally any upper case event
9556 is converted to lower case if the original event is undefined and the lower
9557 case equivalent is defined.) A non-nil value is appropriate for reading
9558 a key sequence to be defined.
9560 A C-g typed while in this function is treated like any other character,
9561 and `quit-flag' is not set.
9563 If the key sequence starts with a mouse click, then the sequence is read
9564 using the keymaps of the buffer of the window clicked in, not the buffer
9565 of the selected window as normal.
9567 `read-key-sequence' drops unbound button-down events, since you normally
9568 only care about the click or drag events which follow them. If a drag
9569 or multi-click event is unbound, but the corresponding click event would
9570 be bound, `read-key-sequence' turns the event into a click event at the
9571 drag's starting position. This means that you don't have to distinguish
9572 between click and drag, double, or triple events unless you want to.
9574 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9575 lines separating windows, and scroll bars with imaginary keys
9576 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9578 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9579 function will process a switch-frame event if the user switches frames
9580 before typing anything. If the user switches frames in the middle of a
9581 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9582 is nil, then the event will be put off until after the current key sequence.
9584 `read-key-sequence' checks `function-key-map' for function key
9585 sequences, where they wouldn't conflict with ordinary bindings. See
9586 `function-key-map' for more details.
9588 The optional fifth argument COMMAND-LOOP, if non-nil, means
9589 that this key sequence is being read by something that will
9590 read commands one after another. It should be nil if the caller
9591 will read just one key sequence. */)
9592 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9594 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9595 Lisp_Object can_return_switch_frame
, command_loop
;
9597 Lisp_Object keybuf
[30];
9599 struct gcpro gcpro1
;
9600 int count
= SPECPDL_INDEX ();
9603 CHECK_STRING (prompt
);
9606 specbind (Qinput_method_exit_on_first_char
,
9607 (NILP (command_loop
) ? Qt
: Qnil
));
9608 specbind (Qinput_method_use_echo_area
,
9609 (NILP (command_loop
) ? Qt
: Qnil
));
9611 bzero (keybuf
, sizeof keybuf
);
9613 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9615 if (NILP (continue_echo
))
9617 this_command_key_count
= 0;
9618 this_command_key_count_reset
= 0;
9619 this_single_command_key_start
= 0;
9622 #ifdef HAVE_X_WINDOWS
9623 if (display_hourglass_p
)
9624 cancel_hourglass ();
9627 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9628 prompt
, ! NILP (dont_downcase_last
),
9629 ! NILP (can_return_switch_frame
), 0);
9631 #if 0 /* The following is fine for code reading a key sequence and
9632 then proceeding with a lenghty computation, but it's not good
9633 for code reading keys in a loop, like an input method. */
9634 #ifdef HAVE_X_WINDOWS
9635 if (display_hourglass_p
)
9646 return unbind_to (count
, make_event_array (i
, keybuf
));
9649 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9650 Sread_key_sequence_vector
, 1, 5, 0,
9651 doc
: /* Like `read-key-sequence' but always return a vector. */)
9652 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9654 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9655 Lisp_Object can_return_switch_frame
, command_loop
;
9657 Lisp_Object keybuf
[30];
9659 struct gcpro gcpro1
;
9660 int count
= SPECPDL_INDEX ();
9663 CHECK_STRING (prompt
);
9666 specbind (Qinput_method_exit_on_first_char
,
9667 (NILP (command_loop
) ? Qt
: Qnil
));
9668 specbind (Qinput_method_use_echo_area
,
9669 (NILP (command_loop
) ? Qt
: Qnil
));
9671 bzero (keybuf
, sizeof keybuf
);
9673 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9675 if (NILP (continue_echo
))
9677 this_command_key_count
= 0;
9678 this_command_key_count_reset
= 0;
9679 this_single_command_key_start
= 0;
9682 #ifdef HAVE_X_WINDOWS
9683 if (display_hourglass_p
)
9684 cancel_hourglass ();
9687 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9688 prompt
, ! NILP (dont_downcase_last
),
9689 ! NILP (can_return_switch_frame
), 0);
9691 #ifdef HAVE_X_WINDOWS
9692 if (display_hourglass_p
)
9702 return unbind_to (count
, Fvector (i
, keybuf
));
9705 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9706 doc
: /* Execute CMD as an editor command.
9707 CMD must be a symbol that satisfies the `commandp' predicate.
9708 Optional second arg RECORD-FLAG non-nil
9709 means unconditionally put this command in `command-history'.
9710 Otherwise, that is done only if an arg is read using the minibuffer.
9711 The argument KEYS specifies the value to use instead of (this-command-keys)
9712 when reading the arguments; if it is nil, (this-command-keys) is used.
9713 The argument SPECIAL, if non-nil, means that this command is executing
9714 a special event, so ignore the prefix argument and don't clear it. */)
9715 (cmd
, record_flag
, keys
, special
)
9716 Lisp_Object cmd
, record_flag
, keys
, special
;
9718 register Lisp_Object final
;
9719 register Lisp_Object tem
;
9720 Lisp_Object prefixarg
;
9721 struct backtrace backtrace
;
9722 extern int debug_on_next_call
;
9724 debug_on_next_call
= 0;
9728 prefixarg
= current_kboard
->Vprefix_arg
;
9729 Vcurrent_prefix_arg
= prefixarg
;
9730 current_kboard
->Vprefix_arg
= Qnil
;
9737 tem
= Fget (cmd
, Qdisabled
);
9738 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9740 tem
= Fsymbol_value (Qdisabled_command_function
);
9742 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9748 final
= Findirect_function (cmd
);
9750 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9752 struct gcpro gcpro1
, gcpro2
;
9754 GCPRO2 (cmd
, prefixarg
);
9755 do_autoload (final
, cmd
);
9762 if (STRINGP (final
) || VECTORP (final
))
9764 /* If requested, place the macro in the command history. For
9765 other sorts of commands, call-interactively takes care of
9767 if (!NILP (record_flag
))
9770 = Fcons (Fcons (Qexecute_kbd_macro
,
9771 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9774 /* Don't keep command history around forever. */
9775 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9777 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9779 XSETCDR (tem
, Qnil
);
9783 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9786 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9788 backtrace
.next
= backtrace_list
;
9789 backtrace_list
= &backtrace
;
9790 backtrace
.function
= &Qcall_interactively
;
9791 backtrace
.args
= &cmd
;
9792 backtrace
.nargs
= 1;
9793 backtrace
.evalargs
= 0;
9794 backtrace
.debug_on_exit
= 0;
9796 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9798 backtrace_list
= backtrace
.next
;
9806 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9808 doc
: /* Read function name, then read its arguments and call it. */)
9810 Lisp_Object prefixarg
;
9812 Lisp_Object function
;
9814 int saved_last_point_position
;
9815 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9816 Lisp_Object bindings
, value
;
9817 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9818 #ifdef HAVE_X_WINDOWS
9819 /* The call to Fcompleting_read wil start and cancel the hourglass,
9820 but if the hourglass was already scheduled, this means that no
9821 hourglass will be shown for the actual M-x command itself.
9822 So we restart it if it is already scheduled. Note that checking
9823 hourglass_shown_p is not enough, normally the hourglass is not shown,
9824 just scheduled to be shown. */
9825 int hstarted
= hourglass_started ();
9828 saved_keys
= Fvector (this_command_key_count
,
9829 XVECTOR (this_command_keys
)->contents
);
9830 saved_last_point_position_buffer
= last_point_position_buffer
;
9831 saved_last_point_position
= last_point_position
;
9833 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9835 if (EQ (prefixarg
, Qminus
))
9837 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9838 strcpy (buf
, "C-u ");
9839 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9840 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9841 else if (INTEGERP (prefixarg
))
9842 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9844 /* This isn't strictly correct if execute-extended-command
9845 is bound to anything else. Perhaps it should use
9846 this_command_keys? */
9847 strcat (buf
, "M-x ");
9849 /* Prompt with buf, and then read a string, completing from and
9850 restricting to the set of all defined commands. Don't provide
9851 any initial input. Save the command read on the extended-command
9853 function
= Fcompleting_read (build_string (buf
),
9854 Vobarray
, Qcommandp
,
9855 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9858 #ifdef HAVE_X_WINDOWS
9859 if (hstarted
) start_hourglass ();
9862 if (STRINGP (function
) && SCHARS (function
) == 0)
9863 error ("No command name given");
9865 /* Set this_command_keys to the concatenation of saved_keys and
9866 function, followed by a RET. */
9871 this_command_key_count
= 0;
9872 this_command_key_count_reset
= 0;
9873 this_single_command_key_start
= 0;
9875 keys
= XVECTOR (saved_keys
)->contents
;
9876 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9877 add_command_key (keys
[i
]);
9879 for (i
= 0; i
< SCHARS (function
); i
++)
9880 add_command_key (Faref (function
, make_number (i
)));
9882 add_command_key (make_number ('\015'));
9885 last_point_position
= saved_last_point_position
;
9886 last_point_position_buffer
= saved_last_point_position_buffer
;
9890 function
= Fintern (function
, Qnil
);
9891 current_kboard
->Vprefix_arg
= prefixarg
;
9892 Vthis_command
= function
;
9893 real_this_command
= function
;
9895 /* If enabled, show which key runs this command. */
9896 if (!NILP (Vsuggest_key_bindings
)
9897 && NILP (Vexecuting_kbd_macro
)
9898 && SYMBOLP (function
))
9899 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9905 GCPRO2 (bindings
, value
);
9906 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9908 /* If the command has a key binding, print it now. */
9909 if (!NILP (bindings
)
9910 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9913 /* But first wait, and skip the message if there is input. */
9915 if (!NILP (echo_area_buffer
[0]))
9916 /* This command displayed something in the echo area;
9917 so wait a few seconds, then display our suggestion message. */
9918 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9919 ? XINT (Vsuggest_key_bindings
) : 2);
9921 /* This command left the echo area empty,
9922 so display our message immediately. */
9925 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9926 && ! CONSP (Vunread_command_events
))
9928 Lisp_Object binding
;
9930 int message_p
= push_message ();
9931 int count
= SPECPDL_INDEX ();
9933 record_unwind_protect (pop_message_unwind
, Qnil
);
9934 binding
= Fkey_description (bindings
, Qnil
);
9937 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9940 sprintf (newmessage
, "You can run the command `%s' with %s",
9941 SDATA (SYMBOL_NAME (function
)),
9943 message2_nolog (newmessage
,
9944 strlen (newmessage
),
9945 STRING_MULTIBYTE (binding
));
9946 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9947 ? Vsuggest_key_bindings
: make_number (2)),
9952 unbind_to (count
, Qnil
);
9956 RETURN_UNGCPRO (value
);
9960 /* Return nonzero if input events are pending. */
9963 detect_input_pending ()
9966 get_input_pending (&input_pending
, 0);
9968 return input_pending
;
9971 /* Return nonzero if input events other than mouse movements are
9975 detect_input_pending_ignore_squeezables ()
9978 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9980 return input_pending
;
9983 /* Return nonzero if input events are pending, and run any pending timers. */
9986 detect_input_pending_run_timers (do_display
)
9989 int old_timers_run
= timers_run
;
9992 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
9994 if (old_timers_run
!= timers_run
&& do_display
)
9996 redisplay_preserve_echo_area (8);
9997 /* The following fixes a bug when using lazy-lock with
9998 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9999 from an idle timer function. The symptom of the bug is that
10000 the cursor sometimes doesn't become visible until the next X
10001 event is processed. --gerd. */
10003 Lisp_Object tail
, frame
;
10004 FOR_EACH_FRAME (tail
, frame
)
10005 if (FRAME_RIF (XFRAME (frame
)))
10006 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10010 return input_pending
;
10013 /* This is called in some cases before a possible quit.
10014 It cases the next call to detect_input_pending to recompute input_pending.
10015 So calling this function unnecessarily can't do any harm. */
10018 clear_input_pending ()
10023 /* Return nonzero if there are pending requeued events.
10024 This isn't used yet. The hope is to make wait_reading_process_output
10025 call it, and return if it runs Lisp code that unreads something.
10026 The problem is, kbd_buffer_get_event needs to be fixed to know what
10027 to do in that case. It isn't trivial. */
10030 requeued_events_pending_p ()
10032 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10036 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10037 doc
: /* Return t if command input is currently available with no wait.
10038 Actually, the value is nil only if we can be sure that no input is available;
10039 if there is a doubt, the value is t. */)
10042 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10045 get_input_pending (&input_pending
,
10046 READABLE_EVENTS_DO_TIMERS_NOW
10047 | READABLE_EVENTS_FILTER_EVENTS
);
10048 return input_pending
> 0 ? Qt
: Qnil
;
10051 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10052 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10055 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10058 if (total_keys
< NUM_RECENT_KEYS
)
10059 return Fvector (total_keys
, keys
);
10062 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10063 bcopy (keys
+ recent_keys_index
,
10064 XVECTOR (val
)->contents
,
10065 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10067 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10068 recent_keys_index
* sizeof (Lisp_Object
));
10073 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10074 doc
: /* Return the key sequence that invoked this command.
10075 However, if the command has called `read-key-sequence', it returns
10076 the last key sequence that has been read.
10077 The value is a string or a vector. */)
10080 return make_event_array (this_command_key_count
,
10081 XVECTOR (this_command_keys
)->contents
);
10084 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10085 doc
: /* Return the key sequence that invoked this command, as a vector.
10086 However, if the command has called `read-key-sequence', it returns
10087 the last key sequence that has been read. */)
10090 return Fvector (this_command_key_count
,
10091 XVECTOR (this_command_keys
)->contents
);
10094 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10095 Sthis_single_command_keys
, 0, 0, 0,
10096 doc
: /* Return the key sequence that invoked this command.
10097 More generally, it returns the last key sequence read, either by
10098 the command loop or by `read-key-sequence'.
10099 Unlike `this-command-keys', this function's value
10100 does not include prefix arguments.
10101 The value is always a vector. */)
10104 return Fvector (this_command_key_count
10105 - this_single_command_key_start
,
10106 (XVECTOR (this_command_keys
)->contents
10107 + this_single_command_key_start
));
10110 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10111 Sthis_single_command_raw_keys
, 0, 0, 0,
10112 doc
: /* Return the raw events that were read for this command.
10113 More generally, it returns the last key sequence read, either by
10114 the command loop or by `read-key-sequence'.
10115 Unlike `this-single-command-keys', this function's value
10116 shows the events before all translations (except for input methods).
10117 The value is always a vector. */)
10120 return Fvector (raw_keybuf_count
,
10121 (XVECTOR (raw_keybuf
)->contents
));
10124 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10125 Sreset_this_command_lengths
, 0, 0, 0,
10126 doc
: /* Make the unread events replace the last command and echo.
10127 Used in `universal-argument-other-key'.
10129 `universal-argument-other-key' rereads the event just typed.
10130 It then gets translated through `function-key-map'.
10131 The translated event has to replace the real events,
10132 both in the value of (this-command-keys) and in echoing.
10133 To achieve this, `universal-argument-other-key' calls
10134 `reset-this-command-lengths', which discards the record of reading
10135 these events the first time. */)
10138 this_command_key_count
= before_command_key_count
;
10139 if (this_command_key_count
< this_single_command_key_start
)
10140 this_single_command_key_start
= this_command_key_count
;
10142 echo_truncate (before_command_echo_length
);
10144 /* Cause whatever we put into unread-command-events
10145 to echo as if it were being freshly read from the keyboard. */
10146 this_command_key_count_reset
= 1;
10151 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10152 Sclear_this_command_keys
, 0, 1, 0,
10153 doc
: /* Clear out the vector that `this-command-keys' returns.
10154 Also clear the record of the last 100 events, unless optional arg
10155 KEEP-RECORD is non-nil. */)
10157 Lisp_Object keep_record
;
10161 this_command_key_count
= 0;
10162 this_command_key_count_reset
= 0;
10164 if (NILP (keep_record
))
10166 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10167 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10169 recent_keys_index
= 0;
10174 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10175 doc
: /* Return the current depth in recursive edits. */)
10179 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10183 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10184 "FOpen dribble file: ",
10185 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10186 If FILE is nil, close any open dribble file. */)
10197 file
= Fexpand_file_name (file
, Qnil
);
10198 dribble
= fopen (SDATA (file
), "w");
10200 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10205 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10206 doc
: /* Discard the contents of the terminal input buffer.
10207 Also end any kbd macro being defined. */)
10210 if (!NILP (current_kboard
->defining_kbd_macro
))
10212 /* Discard the last command from the macro. */
10213 Fcancel_kbd_macro_events ();
10217 update_mode_lines
++;
10219 Vunread_command_events
= Qnil
;
10220 unread_command_char
= -1;
10222 discard_tty_input ();
10224 kbd_fetch_ptr
= kbd_store_ptr
;
10230 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10231 doc
: /* Stop Emacs and return to superior process. You can resume later.
10232 If `cannot-suspend' is non-nil, or if the system doesn't support job
10233 control, run a subshell instead.
10235 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10236 to be read as terminal input by Emacs's parent, after suspension.
10238 Before suspending, run the normal hook `suspend-hook'.
10239 After resumption run the normal hook `suspend-resume-hook'.
10241 Some operating systems cannot stop the Emacs process and resume it later.
10242 On such systems, Emacs starts a subshell instead of suspending. */)
10244 Lisp_Object stuffstring
;
10246 int count
= SPECPDL_INDEX ();
10247 int old_height
, old_width
;
10249 struct gcpro gcpro1
;
10251 if (tty_list
&& tty_list
->next
)
10252 error ("There are other tty frames open; close them before suspending Emacs");
10254 if (!NILP (stuffstring
))
10255 CHECK_STRING (stuffstring
);
10257 /* Run the functions in suspend-hook. */
10258 if (!NILP (Vrun_hooks
))
10259 call1 (Vrun_hooks
, intern ("suspend-hook"));
10261 GCPRO1 (stuffstring
);
10262 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10263 reset_all_sys_modes ();
10264 /* sys_suspend can get an error if it tries to fork a subshell
10265 and the system resources aren't available for that. */
10266 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10268 stuff_buffered_input (stuffstring
);
10269 if (cannot_suspend
)
10273 unbind_to (count
, Qnil
);
10275 /* Check if terminal/window size has changed.
10276 Note that this is not useful when we are running directly
10277 with a window system; but suspend should be disabled in that case. */
10278 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10279 if (width
!= old_width
|| height
!= old_height
)
10280 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10282 /* Run suspend-resume-hook. */
10283 if (!NILP (Vrun_hooks
))
10284 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10290 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10291 Then in any case stuff anything Emacs has read ahead and not used. */
10294 stuff_buffered_input (stuffstring
)
10295 Lisp_Object stuffstring
;
10297 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10298 register unsigned char *p
;
10300 if (STRINGP (stuffstring
))
10302 register int count
;
10304 p
= SDATA (stuffstring
);
10305 count
= SBYTES (stuffstring
);
10306 while (count
-- > 0)
10311 /* Anything we have read ahead, put back for the shell to read. */
10312 /* ?? What should this do when we have multiple keyboards??
10313 Should we ignore anything that was typed in at the "wrong" kboard?
10315 rms: we should stuff everything back into the kboard
10317 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10320 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10321 kbd_fetch_ptr
= kbd_buffer
;
10322 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10323 stuff_char (kbd_fetch_ptr
->code
);
10325 clear_event (kbd_fetch_ptr
);
10329 #endif /* SIGTSTP */
10333 set_waiting_for_input (time_to_clear
)
10334 EMACS_TIME
*time_to_clear
;
10336 input_available_clear_time
= time_to_clear
;
10338 /* Tell handle_interrupt to throw back to read_char, */
10339 waiting_for_input
= 1;
10341 /* If handle_interrupt was called before and buffered a C-g,
10342 make it run again now, to avoid timing error. */
10343 if (!NILP (Vquit_flag
))
10344 quit_throw_to_read_char ();
10348 clear_waiting_for_input ()
10350 /* Tell handle_interrupt not to throw back to read_char, */
10351 waiting_for_input
= 0;
10352 input_available_clear_time
= 0;
10355 /* The SIGINT handler.
10357 If we have a frame on the controlling tty, we assume that the
10358 SIGINT was generated by C-g, so we call handle_interrupt.
10359 Otherwise, the handler kills Emacs. */
10362 interrupt_signal (signalnum
) /* If we don't have an argument, */
10363 int signalnum
; /* some compilers complain in signal calls. */
10365 /* Must preserve main program's value of errno. */
10366 int old_errno
= errno
;
10367 struct device
*device
;
10369 #if defined (USG) && !defined (POSIX_SIGNALS)
10370 /* USG systems forget handlers when they are used;
10371 must reestablish each time */
10372 signal (SIGINT
, interrupt_signal
);
10373 signal (SIGQUIT
, interrupt_signal
);
10376 SIGNAL_THREAD_CHECK (signalnum
);
10378 /* See if we have an active display on our controlling terminal. */
10379 device
= get_named_tty (NULL
);
10382 /* If there are no frames there, let's pretend that we are a
10383 well-behaving UN*X program and quit. */
10384 fatal_error_signal (SIGTERM
);
10388 /* Otherwise, the SIGINT was probably generated by C-g. */
10390 /* Set internal_last_event_frame to the top frame of the
10391 controlling tty, if we have a frame there. We disable the
10392 interrupt key on secondary ttys, so the SIGINT must have come
10393 from the controlling tty. */
10394 internal_last_event_frame
= device
->display_info
.tty
->top_frame
;
10396 handle_interrupt ();
10402 /* This routine is called at interrupt level in response to C-g.
10404 It is called from the SIGINT handler or kbd_buffer_store_event.
10406 If `waiting_for_input' is non zero, then unless `echoing' is
10407 nonzero, immediately throw back to read_char.
10409 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10410 eval to throw, when it gets a chance. If quit-flag is already
10411 non-nil, it stops the job right away. */
10414 handle_interrupt ()
10420 /* XXX This code needs to be revised for multi-tty support. */
10421 if (!NILP (Vquit_flag
)
10423 && get_named_tty (NULL
)
10427 /* If SIGINT isn't blocked, don't let us be interrupted by
10428 another SIGINT, it might be harmful due to non-reentrancy
10429 in I/O functions. */
10430 sigblock (sigmask (SIGINT
));
10433 reset_all_sys_modes ();
10435 #ifdef SIGTSTP /* Support possible in later USG versions */
10437 * On systems which can suspend the current process and return to the original
10438 * shell, this command causes the user to end up back at the shell.
10439 * The "Auto-save" and "Abort" questions are not asked until
10440 * the user elects to return to emacs, at which point he can save the current
10441 * job and either dump core or continue.
10446 if (sys_suspend () == -1)
10448 printf ("Not running as a subprocess;\n");
10449 printf ("you can continue or abort.\n");
10451 #else /* not VMS */
10452 /* Perhaps should really fork an inferior shell?
10453 But that would not provide any way to get back
10454 to the original shell, ever. */
10455 printf ("No support for stopping a process on this operating system;\n");
10456 printf ("you can continue or abort.\n");
10457 #endif /* not VMS */
10458 #endif /* not SIGTSTP */
10460 /* We must remain inside the screen area when the internal terminal
10461 is used. Note that [Enter] is not echoed by dos. */
10464 /* It doesn't work to autosave while GC is in progress;
10465 the code used for auto-saving doesn't cope with the mark bit. */
10466 if (!gc_in_progress
)
10468 printf ("Auto-save? (y or n) ");
10470 if (((c
= getchar ()) & ~040) == 'Y')
10472 Fdo_auto_save (Qt
, Qnil
);
10474 printf ("\r\nAuto-save done");
10475 #else /* not MSDOS */
10476 printf ("Auto-save done\n");
10477 #endif /* not MSDOS */
10479 while (c
!= '\n') c
= getchar ();
10483 /* During GC, it must be safe to reenable quitting again. */
10484 Vinhibit_quit
= Qnil
;
10487 #endif /* not MSDOS */
10488 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10489 printf ("but will instead do a real quit after garbage collection ends\r\n");
10494 printf ("\r\nAbort? (y or n) ");
10495 #else /* not MSDOS */
10497 printf ("Abort (and enter debugger)? (y or n) ");
10498 #else /* not VMS */
10499 printf ("Abort (and dump core)? (y or n) ");
10500 #endif /* not VMS */
10501 #endif /* not MSDOS */
10503 if (((c
= getchar ()) & ~040) == 'Y')
10505 while (c
!= '\n') c
= getchar ();
10507 printf ("\r\nContinuing...\r\n");
10508 #else /* not MSDOS */
10509 printf ("Continuing...\n");
10510 #endif /* not MSDOS */
10512 init_all_sys_modes ();
10517 /* If executing a function that wants to be interrupted out of
10518 and the user has not deferred quitting by binding `inhibit-quit'
10519 then quit right away. */
10520 if (immediate_quit
&& NILP (Vinhibit_quit
))
10522 struct gl_state_s saved
;
10523 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10525 immediate_quit
= 0;
10528 GCPRO4 (saved
.object
, saved
.global_code
,
10529 saved
.current_syntax_table
, saved
.old_prop
);
10530 Fsignal (Qquit
, Qnil
);
10535 /* Else request quit when it's safe */
10539 if (waiting_for_input
&& !echoing
)
10540 quit_throw_to_read_char ();
10543 /* Handle a C-g by making read_char return C-g. */
10546 quit_throw_to_read_char ()
10549 /* Prevent another signal from doing this before we finish. */
10550 clear_waiting_for_input ();
10553 Vunread_command_events
= Qnil
;
10554 unread_command_char
= -1;
10556 #if 0 /* Currently, sit_for is called from read_char without turning
10557 off polling. And that can call set_waiting_for_input.
10558 It seems to be harmless. */
10559 #ifdef POLL_FOR_INPUT
10560 /* May be > 1 if in recursive minibuffer. */
10561 if (poll_suppress_count
== 0)
10565 if (FRAMEP (internal_last_event_frame
)
10566 && !EQ (internal_last_event_frame
, selected_frame
))
10567 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10570 _longjmp (getcjmp
, 1);
10573 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10574 doc
: /* Set mode of reading keyboard input.
10575 First arg INTERRUPT non-nil means use input interrupts;
10576 nil means use CBREAK mode.
10577 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10578 (no effect except in CBREAK mode).
10579 Third arg META t means accept 8-bit input (for a Meta key).
10580 META nil means ignore the top bit, on the assumption it is parity.
10581 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10582 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10583 See also `current-input-mode'. */)
10584 (interrupt
, flow
, meta
, quit
)
10585 Lisp_Object interrupt
, flow
, meta
, quit
;
10587 /* XXX This function needs to be revised for multi-device support.
10588 Currently it compiles fine, but its semantics are wrong. It sets
10589 global parameters (e.g. interrupt_input) based on only the
10590 current frame's device. */
10593 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10594 error ("set-input-mode: QUIT must be an ASCII character");
10596 #ifdef POLL_FOR_INPUT
10601 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10602 /* this causes startup screen to be restored and messes with the mouse */
10603 reset_sys_modes (CURTTY ());
10607 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10608 if (FRAME_DEVICE (SELECTED_FRAME ())->read_socket_hook
)
10610 /* When using X, don't give the user a real choice,
10611 because we haven't implemented the mechanisms to support it. */
10612 #ifdef NO_SOCK_SIGIO
10613 interrupt_input
= 0;
10614 #else /* not NO_SOCK_SIGIO */
10615 interrupt_input
= 1;
10616 #endif /* NO_SOCK_SIGIO */
10619 interrupt_input
= !NILP (interrupt
);
10620 #else /* not SIGIO */
10621 interrupt_input
= 0;
10622 #endif /* not SIGIO */
10624 /* Our VMS input only works by interrupts, as of now. */
10626 interrupt_input
= 1;
10629 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10631 struct tty_display_info
*tty
= CURTTY ();
10632 tty
->flow_control
= !NILP (flow
);
10635 else if (EQ (meta
, Qt
))
10642 /* Don't let this value be out of range. */
10643 quit_char
= XINT (quit
) & (NILP (meta
) ? 0177 : 0377);
10646 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10647 init_sys_modes (CURTTY ());
10650 #ifdef POLL_FOR_INPUT
10651 poll_suppress_count
= 1;
10657 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10658 doc
: /* Return information about the way Emacs currently reads keyboard input.
10659 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10660 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10661 nil, Emacs is using CBREAK mode.
10662 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10663 terminal; this does not apply if Emacs uses interrupt-driven input.
10664 META is t if accepting 8-bit input with 8th bit as Meta flag.
10665 META nil means ignoring the top bit, on the assumption it is parity.
10666 META is neither t nor nil if accepting 8-bit input and using
10667 all 8 bits as the character code.
10668 QUIT is the character Emacs currently uses to quit.
10669 The elements of this list correspond to the arguments of
10670 `set-input-mode'. */)
10673 Lisp_Object val
[4];
10674 struct frame
*sf
= XFRAME (selected_frame
);
10676 val
[0] = interrupt_input
? Qt
: Qnil
;
10677 if (FRAME_TERMCAP_P (sf
))
10679 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10680 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10682 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10689 XSETFASTINT (val
[3], quit_char
);
10691 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10694 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10695 doc
: /* Return position information for pixel coordinates X and Y.
10696 By default, X and Y are relative to text area of the selected window.
10697 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10698 If optional fourth arg WHOLE is non-nil, X is relative to the left
10699 edge of the window.
10701 The return value is similar to a mouse click position:
10702 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10703 IMAGE (DX . DY) (WIDTH . HEIGHT))
10704 The `posn-' functions access elements of such lists. */)
10705 (x
, y
, frame_or_window
, whole
)
10706 Lisp_Object x
, y
, frame_or_window
, whole
;
10711 if (NILP (frame_or_window
))
10712 frame_or_window
= selected_window
;
10714 if (WINDOWP (frame_or_window
))
10718 CHECK_LIVE_WINDOW (frame_or_window
);
10720 w
= XWINDOW (frame_or_window
);
10721 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10723 ? window_box_left_offset (w
, TEXT_AREA
)
10724 : - (WINDOW_LEFT_SCROLL_BAR_COLS (w
)
10725 * WINDOW_FRAME_COLUMN_WIDTH (w
)))));
10726 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10727 frame_or_window
= w
->frame
;
10730 CHECK_LIVE_FRAME (frame_or_window
);
10732 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10735 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10736 doc
: /* Return position information for buffer POS in WINDOW.
10737 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10739 Return nil if position is not visible in window. Otherwise,
10740 the return value is similar to that returned by `event-start' for
10741 a mouse click at the upper left corner of the glyph corresponding
10742 to the given buffer position:
10743 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10744 IMAGE (DX . DY) (WIDTH . HEIGHT))
10745 The `posn-' functions access elements of such lists. */)
10747 Lisp_Object pos
, window
;
10751 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10753 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
, Qnil
);
10759 * Set up a new kboard object with reasonable initial values.
10765 kb
->Voverriding_terminal_local_map
= Qnil
;
10766 kb
->Vlast_command
= Qnil
;
10767 kb
->Vreal_last_command
= Qnil
;
10768 kb
->Vprefix_arg
= Qnil
;
10769 kb
->Vlast_prefix_arg
= Qnil
;
10770 kb
->kbd_queue
= Qnil
;
10771 kb
->kbd_queue_has_data
= 0;
10772 kb
->immediate_echo
= 0;
10773 kb
->echo_string
= Qnil
;
10774 kb
->echo_after_prompt
= -1;
10775 kb
->kbd_macro_buffer
= 0;
10776 kb
->kbd_macro_bufsize
= 0;
10777 kb
->defining_kbd_macro
= Qnil
;
10778 kb
->Vlast_kbd_macro
= Qnil
;
10779 kb
->reference_count
= 0;
10780 kb
->Vsystem_key_alist
= Qnil
;
10781 kb
->system_key_syms
= Qnil
;
10782 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
10783 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
10784 kb
->Vlocal_key_translation_map
= Fmake_sparse_keymap (Qnil
);
10785 Fset_keymap_parent (kb
->Vlocal_key_translation_map
, Vkey_translation_map
);
10786 kb
->Vdefault_minibuffer_frame
= Qnil
;
10790 * Destroy the contents of a kboard object, but not the object itself.
10791 * We use this just before deleting it, or if we're going to initialize
10792 * it a second time.
10798 if (kb
->kbd_macro_buffer
)
10799 xfree (kb
->kbd_macro_buffer
);
10802 #ifdef MULTI_KBOARD
10804 /* Free KB and memory referenced from it. */
10812 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10815 *kbp
= kb
->next_kboard
;
10817 /* Prevent a dangling reference to KB. */
10818 if (kb
== current_kboard
10819 && FRAMEP (selected_frame
)
10820 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10822 current_kboard
= XFRAME (selected_frame
)->device
->kboard
;
10823 if (current_kboard
== kb
)
10831 #endif /* MULTI_KBOARD */
10836 /* This is correct before outermost invocation of the editor loop */
10837 command_loop_level
= -1;
10838 immediate_quit
= 0;
10839 quit_char
= Ctl ('g');
10840 Vunread_command_events
= Qnil
;
10841 unread_command_char
= -1;
10842 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10844 recent_keys_index
= 0;
10845 kbd_fetch_ptr
= kbd_buffer
;
10846 kbd_store_ptr
= kbd_buffer
;
10848 do_mouse_tracking
= Qnil
;
10852 /* This means that command_loop_1 won't try to select anything the first
10854 internal_last_event_frame
= Qnil
;
10855 Vlast_event_frame
= internal_last_event_frame
;
10857 #ifdef MULTI_KBOARD
10858 current_kboard
= initial_kboard
;
10860 wipe_kboard (current_kboard
);
10861 init_kboard (current_kboard
);
10863 if (!noninteractive
)
10865 /* Before multi-tty support, these handlers used to be installed
10866 only if the current session was a tty session. Now an Emacs
10867 session may have multiple display types, so we always handle
10868 SIGINT. There is special code in interrupt_signal to exit
10869 Emacs on SIGINT when there are no termcap frames on the
10870 controlling terminal. */
10871 signal (SIGINT
, interrupt_signal
);
10872 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10873 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10874 SIGQUIT and we can't tell which one it will give us. */
10875 signal (SIGQUIT
, interrupt_signal
);
10876 #endif /* HAVE_TERMIO */
10878 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10880 if (!noninteractive
)
10881 signal (SIGIO
, input_available_signal
);
10884 /* Use interrupt input by default, if it works and noninterrupt input
10885 has deficiencies. */
10887 #ifdef INTERRUPT_INPUT
10888 interrupt_input
= 1;
10890 interrupt_input
= 0;
10893 /* Our VMS input only works by interrupts, as of now. */
10895 interrupt_input
= 1;
10901 if (keyboard_init_hook
)
10902 (*keyboard_init_hook
) ();
10904 #ifdef POLL_FOR_INPUT
10905 poll_suppress_count
= 1;
10910 /* At least provide an escape route since C-g doesn't work. */
10911 signal (SIGINT
, interrupt_signal
);
10915 /* This type's only use is in syms_of_keyboard, to initialize the
10916 event header symbols and put properties on them. */
10917 struct event_head
{
10923 struct event_head head_table
[] = {
10924 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10925 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10926 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10927 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10928 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10929 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10930 /* `select-window' should be handled just like `switch-frame'
10931 in read_key_sequence. */
10932 {&Qselect_window
, "select-window", &Qswitch_frame
}
10936 syms_of_keyboard ()
10938 Vpre_help_message
= Qnil
;
10939 staticpro (&Vpre_help_message
);
10941 Vlispy_mouse_stem
= build_string ("mouse");
10942 staticpro (&Vlispy_mouse_stem
);
10945 QCimage
= intern (":image");
10946 staticpro (&QCimage
);
10948 staticpro (&Qhelp_echo
);
10949 Qhelp_echo
= intern ("help-echo");
10951 staticpro (&item_properties
);
10952 item_properties
= Qnil
;
10954 staticpro (&tool_bar_item_properties
);
10955 tool_bar_item_properties
= Qnil
;
10956 staticpro (&tool_bar_items_vector
);
10957 tool_bar_items_vector
= Qnil
;
10959 staticpro (&real_this_command
);
10960 real_this_command
= Qnil
;
10962 Qtimer_event_handler
= intern ("timer-event-handler");
10963 staticpro (&Qtimer_event_handler
);
10965 Qdisabled_command_function
= intern ("disabled-command-function");
10966 staticpro (&Qdisabled_command_function
);
10968 Qself_insert_command
= intern ("self-insert-command");
10969 staticpro (&Qself_insert_command
);
10971 Qforward_char
= intern ("forward-char");
10972 staticpro (&Qforward_char
);
10974 Qbackward_char
= intern ("backward-char");
10975 staticpro (&Qbackward_char
);
10977 Qdisabled
= intern ("disabled");
10978 staticpro (&Qdisabled
);
10980 Qundefined
= intern ("undefined");
10981 staticpro (&Qundefined
);
10983 Qpre_command_hook
= intern ("pre-command-hook");
10984 staticpro (&Qpre_command_hook
);
10986 Qpost_command_hook
= intern ("post-command-hook");
10987 staticpro (&Qpost_command_hook
);
10989 Qdeferred_action_function
= intern ("deferred-action-function");
10990 staticpro (&Qdeferred_action_function
);
10992 Qcommand_hook_internal
= intern ("command-hook-internal");
10993 staticpro (&Qcommand_hook_internal
);
10995 Qfunction_key
= intern ("function-key");
10996 staticpro (&Qfunction_key
);
10997 Qmouse_click
= intern ("mouse-click");
10998 staticpro (&Qmouse_click
);
10999 #if defined (WINDOWSNT) || defined (MAC_OS)
11000 Qlanguage_change
= intern ("language-change");
11001 staticpro (&Qlanguage_change
);
11003 Qdrag_n_drop
= intern ("drag-n-drop");
11004 staticpro (&Qdrag_n_drop
);
11006 Qsave_session
= intern ("save-session");
11007 staticpro (&Qsave_session
);
11009 Qusr1_signal
= intern ("usr1-signal");
11010 staticpro (&Qusr1_signal
);
11011 Qusr2_signal
= intern ("usr2-signal");
11012 staticpro (&Qusr2_signal
);
11014 Qmenu_enable
= intern ("menu-enable");
11015 staticpro (&Qmenu_enable
);
11016 Qmenu_alias
= intern ("menu-alias");
11017 staticpro (&Qmenu_alias
);
11018 QCenable
= intern (":enable");
11019 staticpro (&QCenable
);
11020 QCvisible
= intern (":visible");
11021 staticpro (&QCvisible
);
11022 QChelp
= intern (":help");
11023 staticpro (&QChelp
);
11024 QCfilter
= intern (":filter");
11025 staticpro (&QCfilter
);
11026 QCbutton
= intern (":button");
11027 staticpro (&QCbutton
);
11028 QCkeys
= intern (":keys");
11029 staticpro (&QCkeys
);
11030 QCkey_sequence
= intern (":key-sequence");
11031 staticpro (&QCkey_sequence
);
11032 QCtoggle
= intern (":toggle");
11033 staticpro (&QCtoggle
);
11034 QCradio
= intern (":radio");
11035 staticpro (&QCradio
);
11037 Qmode_line
= intern ("mode-line");
11038 staticpro (&Qmode_line
);
11039 Qvertical_line
= intern ("vertical-line");
11040 staticpro (&Qvertical_line
);
11041 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11042 staticpro (&Qvertical_scroll_bar
);
11043 Qmenu_bar
= intern ("menu-bar");
11044 staticpro (&Qmenu_bar
);
11047 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11048 staticpro (&Qmouse_fixup_help_message
);
11051 Qabove_handle
= intern ("above-handle");
11052 staticpro (&Qabove_handle
);
11053 Qhandle
= intern ("handle");
11054 staticpro (&Qhandle
);
11055 Qbelow_handle
= intern ("below-handle");
11056 staticpro (&Qbelow_handle
);
11057 Qup
= intern ("up");
11059 Qdown
= intern ("down");
11060 staticpro (&Qdown
);
11061 Qtop
= intern ("top");
11063 Qbottom
= intern ("bottom");
11064 staticpro (&Qbottom
);
11065 Qend_scroll
= intern ("end-scroll");
11066 staticpro (&Qend_scroll
);
11067 Qratio
= intern ("ratio");
11068 staticpro (&Qratio
);
11070 Qevent_kind
= intern ("event-kind");
11071 staticpro (&Qevent_kind
);
11072 Qevent_symbol_elements
= intern ("event-symbol-elements");
11073 staticpro (&Qevent_symbol_elements
);
11074 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11075 staticpro (&Qevent_symbol_element_mask
);
11076 Qmodifier_cache
= intern ("modifier-cache");
11077 staticpro (&Qmodifier_cache
);
11079 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11080 staticpro (&Qrecompute_lucid_menubar
);
11081 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11082 staticpro (&Qactivate_menubar_hook
);
11084 Qpolling_period
= intern ("polling-period");
11085 staticpro (&Qpolling_period
);
11087 Qinput_method_function
= intern ("input-method-function");
11088 staticpro (&Qinput_method_function
);
11090 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11091 staticpro (&Qinput_method_exit_on_first_char
);
11092 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11093 staticpro (&Qinput_method_use_echo_area
);
11095 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11096 Fset (Qinput_method_use_echo_area
, Qnil
);
11098 last_point_position_buffer
= Qnil
;
11101 struct event_head
*p
;
11103 for (p
= head_table
;
11104 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11107 *p
->var
= intern (p
->name
);
11108 staticpro (p
->var
);
11109 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11110 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11114 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11115 staticpro (&button_down_location
);
11116 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11117 staticpro (&mouse_syms
);
11118 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11119 staticpro (&wheel_syms
);
11123 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11125 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11126 for (i
= 0; i
< len
; i
++)
11127 if (modifier_names
[i
])
11128 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11129 staticpro (&modifier_symbols
);
11132 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11133 staticpro (&recent_keys
);
11135 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11136 staticpro (&this_command_keys
);
11138 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11139 staticpro (&raw_keybuf
);
11141 Qextended_command_history
= intern ("extended-command-history");
11142 Fset (Qextended_command_history
, Qnil
);
11143 staticpro (&Qextended_command_history
);
11145 accent_key_syms
= Qnil
;
11146 staticpro (&accent_key_syms
);
11148 func_key_syms
= Qnil
;
11149 staticpro (&func_key_syms
);
11151 drag_n_drop_syms
= Qnil
;
11152 staticpro (&drag_n_drop_syms
);
11154 unread_switch_frame
= Qnil
;
11155 staticpro (&unread_switch_frame
);
11157 internal_last_event_frame
= Qnil
;
11158 staticpro (&internal_last_event_frame
);
11160 read_key_sequence_cmd
= Qnil
;
11161 staticpro (&read_key_sequence_cmd
);
11163 menu_bar_one_keymap_changed_items
= Qnil
;
11164 staticpro (&menu_bar_one_keymap_changed_items
);
11166 menu_bar_items_vector
= Qnil
;
11167 staticpro (&menu_bar_items_vector
);
11169 defsubr (&Sevent_convert_list
);
11170 defsubr (&Sread_key_sequence
);
11171 defsubr (&Sread_key_sequence_vector
);
11172 defsubr (&Srecursive_edit
);
11174 defsubr (&Strack_mouse
);
11176 defsubr (&Sinput_pending_p
);
11177 defsubr (&Scommand_execute
);
11178 defsubr (&Srecent_keys
);
11179 defsubr (&Sthis_command_keys
);
11180 defsubr (&Sthis_command_keys_vector
);
11181 defsubr (&Sthis_single_command_keys
);
11182 defsubr (&Sthis_single_command_raw_keys
);
11183 defsubr (&Sreset_this_command_lengths
);
11184 defsubr (&Sclear_this_command_keys
);
11185 defsubr (&Ssuspend_emacs
);
11186 defsubr (&Sabort_recursive_edit
);
11187 defsubr (&Sexit_recursive_edit
);
11188 defsubr (&Srecursion_depth
);
11189 defsubr (&Stop_level
);
11190 defsubr (&Sdiscard_input
);
11191 defsubr (&Sopen_dribble_file
);
11192 defsubr (&Sset_input_mode
);
11193 defsubr (&Scurrent_input_mode
);
11194 defsubr (&Sexecute_extended_command
);
11195 defsubr (&Sposn_at_point
);
11196 defsubr (&Sposn_at_x_y
);
11198 DEFVAR_LISP ("last-command-char", &last_command_char
,
11199 doc
: /* Last input event that was part of a command. */);
11201 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11202 doc
: /* Last input event that was part of a command. */);
11204 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11205 doc
: /* Last input event in a command, except for mouse menu events.
11206 Mouse menus give back keys that don't look like mouse events;
11207 this variable holds the actual mouse event that led to the menu,
11208 so that you can determine whether the command was run by mouse or not. */);
11210 DEFVAR_LISP ("last-input-char", &last_input_char
,
11211 doc
: /* Last input event. */);
11213 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11214 doc
: /* Last input event. */);
11216 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11217 doc
: /* List of events to be read as the command input.
11218 These events are processed first, before actual keyboard input. */);
11219 Vunread_command_events
= Qnil
;
11221 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11222 doc
: /* If not -1, an object to be read as next command input event. */);
11224 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11225 doc
: /* List of events to be processed as input by input methods.
11226 These events are processed after `unread-command-events', but
11227 before actual keyboard input. */);
11228 Vunread_post_input_method_events
= Qnil
;
11230 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11231 doc
: /* List of events to be processed as input by input methods.
11232 These events are processed after `unread-command-events', but
11233 before actual keyboard input. */);
11234 Vunread_input_method_events
= Qnil
;
11236 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11237 doc
: /* Meta-prefix character code.
11238 Meta-foo as command input turns into this character followed by foo. */);
11239 XSETINT (meta_prefix_char
, 033);
11241 DEFVAR_KBOARD ("last-command", Vlast_command
,
11242 doc
: /* The last command executed.
11243 Normally a symbol with a function definition, but can be whatever was found
11244 in the keymap, or whatever the variable `this-command' was set to by that
11247 The value `mode-exit' is special; it means that the previous command
11248 read an event that told it to exit, and it did so and unread that event.
11249 In other words, the present command is the event that made the previous
11252 The value `kill-region' is special; it means that the previous command
11253 was a kill command.
11255 `last-command' has a separate binding for each display device.
11256 See Info node `(elisp)Multiple displays'. */);
11258 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11259 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11261 DEFVAR_LISP ("this-command", &Vthis_command
,
11262 doc
: /* The command now being executed.
11263 The command can set this variable; whatever is put here
11264 will be in `last-command' during the following command. */);
11265 Vthis_command
= Qnil
;
11267 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11268 doc
: /* The command bound to the current key sequence before remapping.
11269 It equals `this-command' if the original command was not remapped through
11270 any of the active keymaps. Otherwise, the value of `this-command' is the
11271 result of looking up the original command in the active keymaps. */);
11272 Vthis_original_command
= Qnil
;
11274 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11275 doc
: /* *Number of input events between auto-saves.
11276 Zero means disable autosaving due to number of characters typed. */);
11277 auto_save_interval
= 300;
11279 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11280 doc
: /* *Number of seconds idle time before auto-save.
11281 Zero or nil means disable auto-saving due to idleness.
11282 After auto-saving due to this many seconds of idle time,
11283 Emacs also does a garbage collection if that seems to be warranted. */);
11284 XSETFASTINT (Vauto_save_timeout
, 30);
11286 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11287 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11288 The value may be integer or floating point. */);
11289 Vecho_keystrokes
= make_number (1);
11291 DEFVAR_INT ("polling-period", &polling_period
,
11292 doc
: /* *Interval between polling for input during Lisp execution.
11293 The reason for polling is to make C-g work to stop a running program.
11294 Polling is needed only when using X windows and SIGIO does not work.
11295 Polling is automatically disabled in all other cases. */);
11296 polling_period
= 2;
11298 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11299 doc
: /* *Maximum time between mouse clicks to make a double-click.
11300 Measured in milliseconds. nil means disable double-click recognition;
11301 t means double-clicks have no time limit and are detected
11302 by position only. */);
11303 Vdouble_click_time
= make_number (500);
11305 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11306 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11307 On window-system frames, value is the number of pixels the mouse may have
11308 moved horizontally or vertically between two clicks to make a double-click.
11309 On non window-system frames, value is interpreted in units of 1/8 characters
11312 This variable is also the threshold for motion of the mouse
11313 to count as a drag. */);
11314 double_click_fuzz
= 3;
11316 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11317 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11318 inhibit_local_menu_bar_menus
= 0;
11320 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11321 doc
: /* Number of complete key sequences read as input so far.
11322 This includes key sequences read from keyboard macros.
11323 The number is effectively the number of interactive command invocations. */);
11324 num_input_keys
= 0;
11326 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11327 doc
: /* Number of input events read from the keyboard so far.
11328 This does not include events generated by keyboard macros. */);
11329 num_nonmacro_input_events
= 0;
11331 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11332 doc
: /* The frame in which the most recently read event occurred.
11333 If the last event came from a keyboard macro, this is set to `macro'. */);
11334 Vlast_event_frame
= Qnil
;
11336 /* This variable is set up in sysdep.c. */
11337 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11338 doc
: /* The ERASE character as set by the user with stty. */);
11340 DEFVAR_LISP ("help-char", &Vhelp_char
,
11341 doc
: /* Character to recognize as meaning Help.
11342 When it is read, do `(eval help-form)', and display result if it's a string.
11343 If the value of `help-form' is nil, this char can be read normally. */);
11344 XSETINT (Vhelp_char
, Ctl ('H'));
11346 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11347 doc
: /* List of input events to recognize as meaning Help.
11348 These work just like the value of `help-char' (see that). */);
11349 Vhelp_event_list
= Qnil
;
11351 DEFVAR_LISP ("help-form", &Vhelp_form
,
11352 doc
: /* Form to execute when character `help-char' is read.
11353 If the form returns a string, that string is displayed.
11354 If `help-form' is nil, the help char is not recognized. */);
11357 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11358 doc
: /* Command to run when `help-char' character follows a prefix key.
11359 This command is used only when there is no actual binding
11360 for that character after that prefix key. */);
11361 Vprefix_help_command
= Qnil
;
11363 DEFVAR_LISP ("top-level", &Vtop_level
,
11364 doc
: /* Form to evaluate when Emacs starts up.
11365 Useful to set before you dump a modified Emacs. */);
11368 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11369 doc
: /* Translate table for keyboard input, or nil.
11370 If non-nil, the value should be a char-table. Each character read
11371 from the keyboard is looked up in this char-table. If the value found
11372 there is non-nil, then it is used instead of the actual input character.
11374 The value can also be a string or vector, but this is considered obsolete.
11375 If it is a string or vector of length N, character codes N and up are left
11376 untranslated. In a vector, an element which is nil means "no translation".
11378 This is applied to the characters supplied to input methods, not their
11379 output. See also `translation-table-for-input'. */);
11380 Vkeyboard_translate_table
= Qnil
;
11382 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11383 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11384 \(Even if the operating system has support for stopping a process.\) */);
11385 cannot_suspend
= 0;
11387 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11388 doc
: /* Non-nil means prompt with menus when appropriate.
11389 This is done when reading from a keymap that has a prompt string,
11390 for elements that have prompt strings.
11391 The menu is displayed on the screen
11392 if X menus were enabled at configuration
11393 time and the previous event was a mouse click prefix key.
11394 Otherwise, menu prompting uses the echo area. */);
11395 menu_prompting
= 1;
11397 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11398 doc
: /* Character to see next line of menu prompt.
11399 Type this character while in a menu prompt to rotate around the lines of it. */);
11400 XSETINT (menu_prompt_more_char
, ' ');
11402 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11403 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11404 Emacs applies the modifiers of the character stored here to each keyboard
11405 character it reads. For example, after evaluating the expression
11406 (setq extra-keyboard-modifiers ?\\C-x)
11407 all input characters will have the control modifier applied to them.
11409 Note that the character ?\\C-@, equivalent to the integer zero, does
11410 not count as a control character; rather, it counts as a character
11411 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11412 cancels any modification. */);
11413 extra_keyboard_modifiers
= 0;
11415 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11416 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11417 The command loop sets this to nil before each command,
11418 and tests the value when the command returns.
11419 Buffer modification stores t in this variable. */);
11420 Vdeactivate_mark
= Qnil
;
11422 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11423 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11424 Vcommand_hook_internal
= Qnil
;
11426 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11427 doc
: /* Normal hook run before each command is executed.
11428 If an unhandled error happens in running this hook,
11429 the hook value is set to nil, since otherwise the error
11430 might happen repeatedly and make Emacs nonfunctional. */);
11431 Vpre_command_hook
= Qnil
;
11433 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11434 doc
: /* Normal hook run after each command is executed.
11435 If an unhandled error happens in running this hook,
11436 the hook value is set to nil, since otherwise the error
11437 might happen repeatedly and make Emacs nonfunctional. */);
11438 Vpost_command_hook
= Qnil
;
11441 DEFVAR_LISP ("echo-area-clear-hook", ...,
11442 doc
: /* Normal hook run when clearing the echo area. */);
11444 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11445 staticpro (&Qecho_area_clear_hook
);
11446 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11448 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11449 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11450 Vlucid_menu_bar_dirty_flag
= Qnil
;
11452 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11453 doc
: /* List of menu bar items to move to the end of the menu bar.
11454 The elements of the list are event types that may have menu bar bindings. */);
11455 Vmenu_bar_final_items
= Qnil
;
11457 DEFVAR_KBOARD ("overriding-terminal-local-map",
11458 Voverriding_terminal_local_map
,
11459 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11460 If this variable is non-nil, it is used as a keymap instead of the
11461 buffer's local map, and the minor mode keymaps and text property keymaps.
11462 It also replaces `overriding-local-map'.
11464 This variable is intended to let commands such as `universal-argument'
11465 set up a different keymap for reading the next command.
11467 `overriding-terminal-local-map' has a separate binding for each display device.
11468 See Info node `(elisp)Multiple displays'. */);
11470 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11471 doc
: /* Keymap that overrides all other local keymaps.
11472 If this variable is non-nil, it is used as a keymap--replacing the
11473 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11474 Voverriding_local_map
= Qnil
;
11476 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11477 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11478 Otherwise, the menu bar continues to reflect the buffer's local map
11479 and the minor mode maps regardless of `overriding-local-map'. */);
11480 Voverriding_local_map_menu_flag
= Qnil
;
11482 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11483 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11484 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11486 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11487 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11489 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11490 doc
: /* Alist of system-specific X windows key symbols.
11491 Each element should have the form (N . SYMBOL) where N is the
11492 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11493 and SYMBOL is its name.
11495 `system-key-alist' has a separate binding for each display device.
11496 See Info node `(elisp)Multiple displays'.
11498 Note that the currently selected frame has very little to do with
11499 which binding of this variable is active at any given moment. If you
11500 need set or get the binding on a specific display, use
11501 `terminal-local-value' and `set-terminal-local-value'. */);
11503 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11504 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
11505 This allows Emacs to recognize function keys sent from ASCII
11506 terminals at any point in a key sequence.
11508 The `read-key-sequence' function replaces any subsequence bound by
11509 `function-key-map' with its binding. More precisely, when the active
11510 keymaps have no binding for the current key sequence but
11511 `function-key-map' binds a suffix of the sequence to a vector or string,
11512 `read-key-sequence' replaces the matching suffix with its binding, and
11513 continues with the new sequence.
11515 The events that come from bindings in `function-key-map' are not
11516 themselves looked up in `function-key-map'.
11518 For example, suppose `function-key-map' binds `ESC O P' to [f1].
11519 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11520 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
11521 key, typing `ESC O P x' would return [f1 x].
11523 `function-key-map' has a separate binding for each display device.
11524 See Info node `(elisp)Multiple displays'. If you need to define a
11525 binding on all display devices, change `global-function-key-map'
11528 Note that the currently selected frame has very little to do with
11529 which binding of this variable is active at any given moment. If you
11530 need set or get the binding on a specific display, use
11531 `terminal-local-value' and `set-terminal-local-value'. */);
11533 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
11534 doc
: /* The parent keymap of all `local-function-key-map' instances.
11535 Function key definitions that apply to all display devices should go
11537 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11539 DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map
,
11540 doc
: /* Keymap of key translations that can override keymaps.
11541 This keymap works like `function-key-map', but comes after that,
11542 and its non-prefix bindings override ordinary bindings.
11544 `key-translation-map' has a separate binding for each display device.
11545 (See Info node `(elisp)Multiple displays'.) If you need to set a key
11546 translation on all devices, change `global-key-translation-map' instead.
11548 Note that the currently selected frame has very little to do with
11549 which binding of this variable is active at any given moment. If you
11550 need set or get the binding on a specific display, use
11551 `terminal-local-value' and `set-terminal-local-value'. */);
11553 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
11554 doc
: /* The parent keymap of all `local-key-translation-map' instances.
11555 Key translations that apply to all display devices should go here. */);
11556 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11558 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11559 doc
: /* List of deferred actions to be performed at a later time.
11560 The precise format isn't relevant here; we just check whether it is nil. */);
11561 Vdeferred_action_list
= Qnil
;
11563 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11564 doc
: /* Function to call to handle deferred actions, after each command.
11565 This function is called with no arguments after each command
11566 whenever `deferred-action-list' is non-nil. */);
11567 Vdeferred_action_function
= Qnil
;
11569 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11570 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11571 The value can be a length of time to show the message for.
11572 If the value is non-nil and not a number, we wait 2 seconds. */);
11573 Vsuggest_key_bindings
= Qt
;
11575 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11576 doc
: /* List of active absolute time timers in order of increasing time. */);
11577 Vtimer_list
= Qnil
;
11579 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11580 doc
: /* List of active idle-time timers in order of increasing time. */);
11581 Vtimer_idle_list
= Qnil
;
11583 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11584 doc
: /* If non-nil, the function that implements the current input method.
11585 It's called with one argument, a printing character that was just read.
11586 \(That means a character with code 040...0176.)
11587 Typically this function uses `read-event' to read additional events.
11588 When it does so, it should first bind `input-method-function' to nil
11589 so it will not be called recursively.
11591 The function should return a list of zero or more events
11592 to be used as input. If it wants to put back some events
11593 to be reconsidered, separately, by the input method,
11594 it can add them to the beginning of `unread-command-events'.
11596 The input method function can find in `input-method-previous-method'
11597 the previous echo area message.
11599 The input method function should refer to the variables
11600 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11601 for guidance on what to do. */);
11602 Vinput_method_function
= Qnil
;
11604 DEFVAR_LISP ("input-method-previous-message",
11605 &Vinput_method_previous_message
,
11606 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11607 This variable exists because `read-event' clears the echo area
11608 before running the input method. It is nil if there was no message. */);
11609 Vinput_method_previous_message
= Qnil
;
11611 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11612 doc
: /* If non-nil, the function that implements the display of help.
11613 It's called with one argument, the help string to display. */);
11614 Vshow_help_function
= Qnil
;
11616 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11617 doc
: /* If non-nil, suppress point adjustment after executing a command.
11619 After a command is executed, if point is moved into a region that has
11620 special properties (e.g. composition, display), we adjust point to
11621 the boundary of the region. But, when a command sets this variable to
11622 non-nil, we suppress the point adjustment.
11624 This variable is set to nil before reading a command, and is checked
11625 just after executing the command. */);
11626 Vdisable_point_adjustment
= Qnil
;
11628 DEFVAR_LISP ("global-disable-point-adjustment",
11629 &Vglobal_disable_point_adjustment
,
11630 doc
: /* *If non-nil, always suppress point adjustment.
11632 The default value is nil, in which case, point adjustment are
11633 suppressed only after special commands that set
11634 `disable-point-adjustment' (which see) to non-nil. */);
11635 Vglobal_disable_point_adjustment
= Qnil
;
11637 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11638 doc
: /* Non-nil means updating menu bindings is allowed.
11639 A value of nil means menu bindings should not be updated.
11640 Used during Emacs' startup. */);
11641 update_menu_bindings
= 1;
11643 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11644 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11645 If the value is not a number, such messages don't time out. */);
11646 Vminibuffer_message_timeout
= make_number (2);
11648 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11649 doc
: /* If non-nil, any keyboard input throws to this symbol.
11650 The value of that variable is passed to `quit-flag' and later causes a
11651 peculiar kind of quitting. */);
11652 Vthrow_on_input
= Qnil
;
11656 keys_of_keyboard ()
11658 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11659 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11660 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11661 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11662 initial_define_key (meta_map
, 'x', "execute-extended-command");
11664 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11665 "handle-delete-frame");
11666 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11667 current-prefix-arg, as is done in `handle-switch-frame'.
11668 But `handle-switch-frame is not run from the special-map.
11669 Commands from that map are run in a special way that automatically
11670 preserves the prefix-arg. Restoring the prefix arg here is not just
11671 redundant but harmful:
11673 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11674 - after the first prompt, the exit-minibuffer-hook is run which may
11675 iconify a frame and thus push a `iconify-frame' event.
11676 - after running exit-minibuffer-hook, current-prefix-arg is
11677 restored to the non-nil value it had before the prompt.
11678 - we enter the second prompt.
11679 current-prefix-arg is non-nil, prefix-arg is nil.
11680 - before running the first real event, we run the special iconify-frame
11681 event, but we pass the `special' arg to execute-command so
11682 current-prefix-arg and prefix-arg are left untouched.
11683 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11684 - the next key event will have a spuriously non-nil current-prefix-arg. */
11685 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11687 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11689 /* Handling it at such a low-level causes read_key_sequence to get
11690 * confused because it doesn't realize that the current_buffer was
11691 * changed by read_char.
11693 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11694 * "handle-select-window"); */
11695 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11696 "handle-save-session");
11699 /* Mark the pointers in the kboard objects.
11700 Called by the Fgarbage_collector. */
11706 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11708 if (kb
->kbd_macro_buffer
)
11709 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11711 mark_object (kb
->Voverriding_terminal_local_map
);
11712 mark_object (kb
->Vlast_command
);
11713 mark_object (kb
->Vreal_last_command
);
11714 mark_object (kb
->Vprefix_arg
);
11715 mark_object (kb
->Vlast_prefix_arg
);
11716 mark_object (kb
->kbd_queue
);
11717 mark_object (kb
->defining_kbd_macro
);
11718 mark_object (kb
->Vlast_kbd_macro
);
11719 mark_object (kb
->Vsystem_key_alist
);
11720 mark_object (kb
->system_key_syms
);
11721 mark_object (kb
->Vlocal_function_key_map
);
11722 mark_object (kb
->Vlocal_key_translation_map
);
11723 mark_object (kb
->Vdefault_minibuffer_frame
);
11724 mark_object (kb
->echo_string
);
11727 struct input_event
*event
;
11728 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11730 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11731 event
= kbd_buffer
;
11732 if (event
->kind
!= SELECTION_REQUEST_EVENT
11733 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11735 mark_object (event
->x
);
11736 mark_object (event
->y
);
11738 mark_object (event
->frame_or_window
);
11739 mark_object (event
->arg
);
11744 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11745 (do not change this comment) */