1 /* Keyboard and mouse input; editor command loop.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994, 1995,
3 1996, 1997, 1999, 2000, 2001, 2002, 2003, 2004,
4 2005 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
30 #include "termhooks.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
49 #ifdef HAVE_GTK_AND_PTHREAD
57 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #include "syssignal.h"
63 #include <sys/types.h>
72 /* This is to get the definitions of the XK_ symbols. */
79 #endif /* HAVE_NTGUI */
89 /* Variables for blockinput.h: */
91 /* Non-zero if interrupt input is blocked right now. */
92 int interrupt_input_blocked
;
94 /* Nonzero means an input interrupt has arrived
95 during the current critical section. */
96 int interrupt_input_pending
;
99 #ifdef HAVE_WINDOW_SYSTEM
100 /* Make all keyboard buffers much bigger when using X windows. */
102 /* But not too big (local data > 32K error) if on Mac OS Classic. */
103 #define KBD_BUFFER_SIZE 512
105 #define KBD_BUFFER_SIZE 4096
107 #else /* No X-windows, character input */
108 #define KBD_BUFFER_SIZE 4096
109 #endif /* No X-windows */
111 #define abs(x) ((x) >= 0 ? (x) : -(x))
113 /* Following definition copied from eval.c */
117 struct backtrace
*next
;
118 Lisp_Object
*function
;
119 Lisp_Object
*args
; /* Points to vector of args. */
120 int nargs
; /* length of vector. If nargs is UNEVALLED,
121 args points to slot holding list of
124 /* Nonzero means call value of debugger when done with this operation. */
129 KBOARD
*initial_kboard
;
130 KBOARD
*current_kboard
;
134 KBOARD the_only_kboard
;
137 /* Non-nil disable property on a command means
138 do not execute it; call disabled-command-function's value instead. */
139 Lisp_Object Qdisabled
, Qdisabled_command_function
;
141 #define NUM_RECENT_KEYS (100)
142 int recent_keys_index
; /* Index for storing next element into recent_keys */
143 int total_keys
; /* Total number of elements stored into recent_keys */
144 Lisp_Object recent_keys
; /* A vector, holding the last 100 keystrokes */
146 /* Vector holding the key sequence that invoked the current command.
147 It is reused for each command, and it may be longer than the current
148 sequence; this_command_key_count indicates how many elements
149 actually mean something.
150 It's easier to staticpro a single Lisp_Object than an array. */
151 Lisp_Object this_command_keys
;
152 int this_command_key_count
;
154 /* 1 after calling Freset_this_command_lengths.
156 int this_command_key_count_reset
;
158 /* This vector is used as a buffer to record the events that were actually read
159 by read_key_sequence. */
160 Lisp_Object raw_keybuf
;
161 int raw_keybuf_count
;
163 #define GROW_RAW_KEYBUF \
164 if (raw_keybuf_count == XVECTOR (raw_keybuf)->size) \
166 int newsize = 2 * XVECTOR (raw_keybuf)->size; \
168 new = Fmake_vector (make_number (newsize), Qnil); \
169 bcopy (XVECTOR (raw_keybuf)->contents, XVECTOR (new)->contents, \
170 raw_keybuf_count * sizeof (Lisp_Object)); \
174 /* Number of elements of this_command_keys
175 that precede this key sequence. */
176 int this_single_command_key_start
;
178 /* Record values of this_command_key_count and echo_length ()
179 before this command was read. */
180 static int before_command_key_count
;
181 static int before_command_echo_length
;
183 extern int minbuf_level
;
185 extern int message_enable_multibyte
;
187 extern struct backtrace
*backtrace_list
;
189 /* If non-nil, the function that implements the display of help.
190 It's called with one argument, the help string to display. */
192 Lisp_Object Vshow_help_function
;
194 /* If a string, the message displayed before displaying a help-echo
197 Lisp_Object Vpre_help_message
;
199 /* Nonzero means do menu prompting. */
201 static int menu_prompting
;
203 /* Character to see next line of menu prompt. */
205 static Lisp_Object menu_prompt_more_char
;
207 /* For longjmp to where kbd input is being done. */
209 static jmp_buf getcjmp
;
211 /* True while doing kbd input. */
212 int waiting_for_input
;
214 /* True while displaying for echoing. Delays C-g throwing. */
218 /* Non-null means we can start echoing at the next input pause even
219 though there is something in the echo area. */
221 static struct kboard
*ok_to_echo_at_next_pause
;
223 /* The kboard last echoing, or null for none. Reset to 0 in
224 cancel_echoing. If non-null, and a current echo area message
225 exists, and echo_message_buffer is eq to the current message
226 buffer, we know that the message comes from echo_kboard. */
228 struct kboard
*echo_kboard
;
230 /* The buffer used for echoing. Set in echo_now, reset in
233 Lisp_Object echo_message_buffer
;
235 /* Nonzero means disregard local maps for the menu bar. */
236 static int inhibit_local_menu_bar_menus
;
238 /* Nonzero means C-g should cause immediate error-signal. */
241 /* The user's ERASE setting. */
242 Lisp_Object Vtty_erase_char
;
244 /* Character to recognize as the help char. */
245 Lisp_Object Vhelp_char
;
247 /* List of other event types to recognize as meaning "help". */
248 Lisp_Object Vhelp_event_list
;
250 /* Form to execute when help char is typed. */
251 Lisp_Object Vhelp_form
;
253 /* Command to run when the help character follows a prefix key. */
254 Lisp_Object Vprefix_help_command
;
256 /* List of items that should move to the end of the menu bar. */
257 Lisp_Object Vmenu_bar_final_items
;
259 /* Non-nil means show the equivalent key-binding for
260 any M-x command that has one.
261 The value can be a length of time to show the message for.
262 If the value is non-nil and not a number, we wait 2 seconds. */
263 Lisp_Object Vsuggest_key_bindings
;
265 /* How long to display an echo-area message when the minibuffer is active.
266 If the value is not a number, such messages don't time out. */
267 Lisp_Object Vminibuffer_message_timeout
;
269 /* Character that causes a quit. Normally C-g.
271 If we are running on an ordinary terminal, this must be an ordinary
272 ASCII char, since we want to make it our interrupt character.
274 If we are not running on an ordinary terminal, it still needs to be
275 an ordinary ASCII char. This character needs to be recognized in
276 the input interrupt handler. At this point, the keystroke is
277 represented as a struct input_event, while the desired quit
278 character is specified as a lispy event. The mapping from struct
279 input_events to lispy events cannot run in an interrupt handler,
280 and the reverse mapping is difficult for anything but ASCII
283 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
287 extern Lisp_Object current_global_map
;
288 extern int minibuf_level
;
290 /* If non-nil, this is a map that overrides all other local maps. */
291 Lisp_Object Voverriding_local_map
;
293 /* If non-nil, Voverriding_local_map applies to the menu bar. */
294 Lisp_Object Voverriding_local_map_menu_flag
;
296 /* Keymap that defines special misc events that should
297 be processed immediately at a low level. */
298 Lisp_Object Vspecial_event_map
;
300 /* Current depth in recursive edits. */
301 int command_loop_level
;
303 /* Total number of times command_loop has read a key sequence. */
304 EMACS_INT num_input_keys
;
306 /* Last input character read as a command. */
307 Lisp_Object last_command_char
;
309 /* Last input character read as a command, not counting menus
310 reached by the mouse. */
311 Lisp_Object last_nonmenu_event
;
313 /* Last input character read for any purpose. */
314 Lisp_Object last_input_char
;
316 /* If not Qnil, a list of objects to be read as subsequent command input. */
317 Lisp_Object Vunread_command_events
;
319 /* If not Qnil, a list of objects to be read as subsequent command input
320 including input method processing. */
321 Lisp_Object Vunread_input_method_events
;
323 /* If not Qnil, a list of objects to be read as subsequent command input
324 but NOT including input method processing. */
325 Lisp_Object Vunread_post_input_method_events
;
327 /* If not -1, an event to be read as subsequent command input. */
328 EMACS_INT unread_command_char
;
330 /* If not Qnil, this is a switch-frame event which we decided to put
331 off until the end of a key sequence. This should be read as the
332 next command input, after any unread_command_events.
334 read_key_sequence uses this to delay switch-frame events until the
335 end of the key sequence; Fread_char uses it to put off switch-frame
336 events until a non-ASCII event is acceptable as input. */
337 Lisp_Object unread_switch_frame
;
339 /* A mask of extra modifier bits to put into every keyboard char. */
340 EMACS_INT extra_keyboard_modifiers
;
342 /* Char to use as prefix when a meta character is typed in.
343 This is bound on entry to minibuffer in case ESC is changed there. */
345 Lisp_Object meta_prefix_char
;
347 /* Last size recorded for a current buffer which is not a minibuffer. */
348 static int last_non_minibuf_size
;
350 /* Number of idle seconds before an auto-save and garbage collection. */
351 static Lisp_Object Vauto_save_timeout
;
353 /* Total number of times read_char has returned. */
354 int num_input_events
;
356 /* Total number of times read_char has returned, outside of macros. */
357 EMACS_INT num_nonmacro_input_events
;
359 /* Auto-save automatically when this many characters have been typed
360 since the last time. */
362 static EMACS_INT auto_save_interval
;
364 /* Value of num_nonmacro_input_events as of last auto save. */
368 /* The command being executed by the command loop.
369 Commands may set this, and the value set will be copied into
370 current_kboard->Vlast_command instead of the actual command. */
371 Lisp_Object Vthis_command
;
373 /* This is like Vthis_command, except that commands never set it. */
374 Lisp_Object real_this_command
;
376 /* If the lookup of the command returns a binding, the original
377 command is stored in this-original-command. It is nil otherwise. */
378 Lisp_Object Vthis_original_command
;
380 /* The value of point when the last command was executed. */
381 int last_point_position
;
383 /* The buffer that was current when the last command was started. */
384 Lisp_Object last_point_position_buffer
;
386 /* The frame in which the last input event occurred, or Qmacro if the
387 last event came from a macro. We use this to determine when to
388 generate switch-frame events. This may be cleared by functions
389 like Fselect_frame, to make sure that a switch-frame event is
390 generated by the next character. */
391 Lisp_Object internal_last_event_frame
;
393 /* A user-visible version of the above, intended to allow users to
394 figure out where the last event came from, if the event doesn't
395 carry that information itself (i.e. if it was a character). */
396 Lisp_Object Vlast_event_frame
;
398 /* The timestamp of the last input event we received from the X server.
399 X Windows wants this for selection ownership. */
400 unsigned long last_event_timestamp
;
402 Lisp_Object Qself_insert_command
;
403 Lisp_Object Qforward_char
;
404 Lisp_Object Qbackward_char
;
405 Lisp_Object Qundefined
;
406 Lisp_Object Qtimer_event_handler
;
408 /* read_key_sequence stores here the command definition of the
409 key sequence that it reads. */
410 Lisp_Object read_key_sequence_cmd
;
412 /* Echo unfinished commands after this many seconds of pause. */
413 Lisp_Object Vecho_keystrokes
;
415 /* Form to evaluate (if non-nil) when Emacs is started. */
416 Lisp_Object Vtop_level
;
418 /* User-supplied table to translate input characters. */
419 Lisp_Object Vkeyboard_translate_table
;
421 /* If non-nil, this implements the current input method. */
422 Lisp_Object Vinput_method_function
;
423 Lisp_Object Qinput_method_function
;
425 /* When we call Vinput_method_function,
426 this holds the echo area message that was just erased. */
427 Lisp_Object Vinput_method_previous_message
;
429 /* Non-nil means deactivate the mark at end of this command. */
430 Lisp_Object Vdeactivate_mark
;
432 /* Menu bar specified in Lucid Emacs fashion. */
434 Lisp_Object Vlucid_menu_bar_dirty_flag
;
435 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
437 Lisp_Object Qecho_area_clear_hook
;
439 /* Hooks to run before and after each command. */
440 Lisp_Object Qpre_command_hook
, Vpre_command_hook
;
441 Lisp_Object Qpost_command_hook
, Vpost_command_hook
;
442 Lisp_Object Qcommand_hook_internal
, Vcommand_hook_internal
;
444 /* Parent keymap of terminal-local function-key-map instances. */
445 Lisp_Object Vfunction_key_map
;
447 /* Parent keymap of terminal-local key-translation-map instances. */
448 Lisp_Object Vkey_translation_map
;
450 /* List of deferred actions to be performed at a later time.
451 The precise format isn't relevant here; we just check whether it is nil. */
452 Lisp_Object Vdeferred_action_list
;
454 /* Function to call to handle deferred actions, when there are any. */
455 Lisp_Object Vdeferred_action_function
;
456 Lisp_Object Qdeferred_action_function
;
458 Lisp_Object Qinput_method_exit_on_first_char
;
459 Lisp_Object Qinput_method_use_echo_area
;
461 /* File in which we write all commands we read. */
464 /* Nonzero if input is available. */
467 /* Non-zero means force key bindings update in parse_menu_item. */
469 int update_menu_bindings
;
471 extern char *pending_malloc_warning
;
473 /* Circular buffer for pre-read keyboard input. */
475 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
477 /* Pointer to next available character in kbd_buffer.
478 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
479 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
480 next available char is in kbd_buffer[0]. */
481 static struct input_event
*kbd_fetch_ptr
;
483 /* Pointer to next place to store character in kbd_buffer. This
484 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
485 character should go in kbd_buffer[0]. */
486 static struct input_event
* volatile kbd_store_ptr
;
488 /* The above pair of variables forms a "queue empty" flag. When we
489 enqueue a non-hook event, we increment kbd_store_ptr. When we
490 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
491 there is input available iff the two pointers are not equal.
493 Why not just have a flag set and cleared by the enqueuing and
494 dequeuing functions? Such a flag could be screwed up by interrupts
495 at inopportune times. */
497 /* If this flag is non-nil, we check mouse_moved to see when the
498 mouse moves, and motion events will appear in the input stream.
499 Otherwise, mouse motion is ignored. */
500 Lisp_Object do_mouse_tracking
;
502 /* Symbols to head events. */
503 Lisp_Object Qmouse_movement
;
504 Lisp_Object Qscroll_bar_movement
;
505 Lisp_Object Qswitch_frame
;
506 Lisp_Object Qdelete_frame
;
507 Lisp_Object Qiconify_frame
;
508 Lisp_Object Qmake_frame_visible
;
509 Lisp_Object Qselect_window
;
510 Lisp_Object Qhelp_echo
;
513 Lisp_Object Qmouse_fixup_help_message
;
516 /* Symbols to denote kinds of events. */
517 Lisp_Object Qfunction_key
;
518 Lisp_Object Qmouse_click
;
519 #if defined (WINDOWSNT) || defined (MAC_OS)
520 Lisp_Object Qlanguage_change
;
522 Lisp_Object Qdrag_n_drop
;
523 Lisp_Object Qsave_session
;
525 /* Lisp_Object Qmouse_movement; - also an event header */
527 /* Properties of event headers. */
528 Lisp_Object Qevent_kind
;
529 Lisp_Object Qevent_symbol_elements
;
531 /* menu item parts */
532 Lisp_Object Qmenu_alias
;
533 Lisp_Object Qmenu_enable
;
534 Lisp_Object QCenable
, QCvisible
, QChelp
, QCfilter
, QCkeys
, QCkey_sequence
;
535 Lisp_Object QCbutton
, QCtoggle
, QCradio
;
536 extern Lisp_Object Vdefine_key_rebound_commands
;
537 extern Lisp_Object Qmenu_item
;
539 /* An event header symbol HEAD may have a property named
540 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
541 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
542 mask of modifiers applied to it. If present, this is used to help
543 speed up parse_modifiers. */
544 Lisp_Object Qevent_symbol_element_mask
;
546 /* An unmodified event header BASE may have a property named
547 Qmodifier_cache, which is an alist mapping modifier masks onto
548 modified versions of BASE. If present, this helps speed up
550 Lisp_Object Qmodifier_cache
;
552 /* Symbols to use for parts of windows. */
553 Lisp_Object Qmode_line
;
554 Lisp_Object Qvertical_line
;
555 Lisp_Object Qvertical_scroll_bar
;
556 Lisp_Object Qmenu_bar
;
557 extern Lisp_Object Qleft_margin
, Qright_margin
;
558 extern Lisp_Object Qleft_fringe
, Qright_fringe
;
559 extern Lisp_Object QCmap
;
561 Lisp_Object
recursive_edit_unwind (), command_loop ();
562 Lisp_Object
Fthis_command_keys ();
563 Lisp_Object Qextended_command_history
;
564 EMACS_TIME
timer_check ();
566 extern Lisp_Object Vhistory_length
, Vtranslation_table_for_input
;
568 extern char *x_get_keysym_name ();
570 static void record_menu_key ();
571 static int echo_length ();
573 Lisp_Object Qpolling_period
;
575 /* List of absolute timers. Appears in order of next scheduled event. */
576 Lisp_Object Vtimer_list
;
578 /* List of idle time timers. Appears in order of next scheduled event. */
579 Lisp_Object Vtimer_idle_list
;
581 /* Incremented whenever a timer is run. */
584 extern Lisp_Object Vprint_level
, Vprint_length
;
586 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
588 EMACS_TIME
*input_available_clear_time
;
590 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
591 Default is 1 if INTERRUPT_INPUT is defined. */
594 /* Nonzero while interrupts are temporarily deferred during redisplay. */
595 int interrupts_deferred
;
597 /* Allow m- file to inhibit use of FIONREAD. */
598 #ifdef BROKEN_FIONREAD
602 /* We are unable to use interrupts if FIONREAD is not available,
603 so flush SIGIO so we won't try. */
604 #if !defined (FIONREAD)
610 /* If we support a window system, turn on the code to poll periodically
611 to detect C-g. It isn't actually used when doing interrupt input. */
612 #if defined(HAVE_WINDOW_SYSTEM) && !defined(USE_ASYNC_EVENTS)
613 #define POLL_FOR_INPUT
616 /* After a command is executed, if point is moved into a region that
617 has specific properties (e.g. composition, display), we adjust
618 point to the boundary of the region. But, if a command sets this
619 variable to non-nil, we suppress this point adjustment. This
620 variable is set to nil before reading a command. */
622 Lisp_Object Vdisable_point_adjustment
;
624 /* If non-nil, always disable point adjustment. */
626 Lisp_Object Vglobal_disable_point_adjustment
;
628 /* The time when Emacs started being idle. */
630 static EMACS_TIME timer_idleness_start_time
;
632 /* After Emacs stops being idle, this saves the last value
633 of timer_idleness_start_time from when it was idle. */
635 static EMACS_TIME timer_last_idleness_start_time
;
638 /* Global variable declarations. */
640 /* Flags for readable_events. */
641 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
642 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
643 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
645 /* Function for init_keyboard to call with no args (if nonzero). */
646 void (*keyboard_init_hook
) ();
648 static int read_avail_input
P_ ((int));
649 static void get_input_pending
P_ ((int *, int));
650 static int readable_events
P_ ((int));
651 static Lisp_Object read_char_x_menu_prompt
P_ ((int, Lisp_Object
*,
652 Lisp_Object
, int *));
653 static Lisp_Object
read_char_x_menu_prompt ();
654 static Lisp_Object read_char_minibuf_menu_prompt
P_ ((int, int,
656 static Lisp_Object make_lispy_event
P_ ((struct input_event
*));
658 static Lisp_Object make_lispy_movement
P_ ((struct frame
*, Lisp_Object
,
659 enum scroll_bar_part
,
660 Lisp_Object
, Lisp_Object
,
663 static Lisp_Object modify_event_symbol
P_ ((int, unsigned, Lisp_Object
,
664 Lisp_Object
, char **,
665 Lisp_Object
*, unsigned));
666 static Lisp_Object make_lispy_switch_frame
P_ ((Lisp_Object
));
667 static int parse_solitary_modifier
P_ ((Lisp_Object
));
668 static int parse_solitary_modifier ();
669 static void save_getcjmp
P_ ((jmp_buf));
670 static void save_getcjmp ();
671 static void restore_getcjmp
P_ ((jmp_buf));
672 static Lisp_Object apply_modifiers
P_ ((int, Lisp_Object
));
673 static void clear_event
P_ ((struct input_event
*));
674 static void any_kboard_state
P_ ((void));
675 static Lisp_Object restore_kboard_configuration
P_ ((Lisp_Object
));
676 static SIGTYPE interrupt_signal
P_ ((int signalnum
));
677 static void handle_interrupt
P_ ((void));
678 static void timer_start_idle
P_ ((void));
679 static void timer_stop_idle
P_ ((void));
680 static void timer_resume_idle
P_ ((void));
682 /* Nonzero means don't try to suspend even if the operating system seems
684 static int cannot_suspend
;
686 extern Lisp_Object Qidentity
, Qonly
;
688 /* Install the string STR as the beginning of the string of echoing,
689 so that it serves as a prompt for the next character.
690 Also start echoing. */
696 current_kboard
->echo_string
= str
;
697 current_kboard
->echo_after_prompt
= SCHARS (str
);
701 /* Add C to the echo string, if echoing is going on.
702 C can be a character, which is printed prettily ("M-C-x" and all that
703 jazz), or a symbol, whose name is printed. */
709 if (current_kboard
->immediate_echo
)
711 int size
= KEY_DESCRIPTION_SIZE
+ 100;
712 char *buffer
= (char *) alloca (size
);
714 Lisp_Object echo_string
;
716 echo_string
= current_kboard
->echo_string
;
718 /* If someone has passed us a composite event, use its head symbol. */
723 ptr
= push_key_description (XINT (c
), ptr
, 1);
725 else if (SYMBOLP (c
))
727 Lisp_Object name
= SYMBOL_NAME (c
);
728 int nbytes
= SBYTES (name
);
730 if (size
- (ptr
- buffer
) < nbytes
)
732 int offset
= ptr
- buffer
;
733 size
= max (2 * size
, size
+ nbytes
);
734 buffer
= (char *) alloca (size
);
735 ptr
= buffer
+ offset
;
738 ptr
+= copy_text (SDATA (name
), ptr
, nbytes
,
739 STRING_MULTIBYTE (name
), 1);
742 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
745 const char *text
= " (Type ? for further options)";
746 int len
= strlen (text
);
748 if (size
- (ptr
- buffer
) < len
)
750 int offset
= ptr
- buffer
;
752 buffer
= (char *) alloca (size
);
753 ptr
= buffer
+ offset
;
756 bcopy (text
, ptr
, len
);
760 /* Replace a dash from echo_dash with a space, otherwise
761 add a space at the end as a separator between keys. */
762 if (STRINGP (echo_string
)
763 && SCHARS (echo_string
) > 1)
765 Lisp_Object last_char
, prev_char
, idx
;
767 idx
= make_number (SCHARS (echo_string
) - 2);
768 prev_char
= Faref (echo_string
, idx
);
770 idx
= make_number (SCHARS (echo_string
) - 1);
771 last_char
= Faref (echo_string
, idx
);
773 /* We test PREV_CHAR to make sure this isn't the echoing
775 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
776 Faset (echo_string
, idx
, make_number (' '));
778 echo_string
= concat2 (echo_string
, build_string (" "));
781 current_kboard
->echo_string
782 = concat2 (echo_string
, make_string (buffer
, ptr
- buffer
));
788 /* Temporarily add a dash to the end of the echo string if it's not
789 empty, so that it serves as a mini-prompt for the very next character. */
794 /* Do nothing if not echoing at all. */
795 if (NILP (current_kboard
->echo_string
))
798 if (!current_kboard
->immediate_echo
799 && SCHARS (current_kboard
->echo_string
) == 0)
802 /* Do nothing if we just printed a prompt. */
803 if (current_kboard
->echo_after_prompt
804 == SCHARS (current_kboard
->echo_string
))
807 /* Do nothing if we have already put a dash at the end. */
808 if (SCHARS (current_kboard
->echo_string
) > 1)
810 Lisp_Object last_char
, prev_char
, idx
;
812 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 2);
813 prev_char
= Faref (current_kboard
->echo_string
, idx
);
815 idx
= make_number (SCHARS (current_kboard
->echo_string
) - 1);
816 last_char
= Faref (current_kboard
->echo_string
, idx
);
818 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
822 /* Put a dash at the end of the buffer temporarily,
823 but make it go away when the next character is added. */
824 current_kboard
->echo_string
= concat2 (current_kboard
->echo_string
,
829 /* Display the current echo string, and begin echoing if not already
835 if (!current_kboard
->immediate_echo
)
838 current_kboard
->immediate_echo
= 1;
840 for (i
= 0; i
< this_command_key_count
; i
++)
844 /* Set before_command_echo_length to the value that would
845 have been saved before the start of this subcommand in
846 command_loop_1, if we had already been echoing then. */
847 if (i
== this_single_command_key_start
)
848 before_command_echo_length
= echo_length ();
850 c
= XVECTOR (this_command_keys
)->contents
[i
];
851 if (! (EVENT_HAS_PARAMETERS (c
)
852 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
856 /* Set before_command_echo_length to the value that would
857 have been saved before the start of this subcommand in
858 command_loop_1, if we had already been echoing then. */
859 if (this_command_key_count
== this_single_command_key_start
)
860 before_command_echo_length
= echo_length ();
862 /* Put a dash at the end to invite the user to type more. */
867 message3_nolog (current_kboard
->echo_string
,
868 SBYTES (current_kboard
->echo_string
),
869 STRING_MULTIBYTE (current_kboard
->echo_string
));
872 /* Record in what buffer we echoed, and from which kboard. */
873 echo_message_buffer
= echo_area_buffer
[0];
874 echo_kboard
= current_kboard
;
876 if (waiting_for_input
&& !NILP (Vquit_flag
))
877 quit_throw_to_read_char ();
880 /* Turn off echoing, for the start of a new command. */
885 current_kboard
->immediate_echo
= 0;
886 current_kboard
->echo_after_prompt
= -1;
887 current_kboard
->echo_string
= Qnil
;
888 ok_to_echo_at_next_pause
= NULL
;
890 echo_message_buffer
= Qnil
;
893 /* Return the length of the current echo string. */
898 return (STRINGP (current_kboard
->echo_string
)
899 ? SCHARS (current_kboard
->echo_string
)
903 /* Truncate the current echo message to its first LEN chars.
904 This and echo_char get used by read_key_sequence when the user
905 switches frames while entering a key sequence. */
908 echo_truncate (nchars
)
911 if (STRINGP (current_kboard
->echo_string
))
912 current_kboard
->echo_string
913 = Fsubstring (current_kboard
->echo_string
,
914 make_number (0), make_number (nchars
));
915 truncate_echo_area (nchars
);
919 /* Functions for manipulating this_command_keys. */
921 add_command_key (key
)
924 #if 0 /* Not needed after we made Freset_this_command_lengths
925 do the job immediately. */
926 /* If reset-this-command-length was called recently, obey it now.
927 See the doc string of that function for an explanation of why. */
928 if (before_command_restore_flag
)
930 this_command_key_count
= before_command_key_count_1
;
931 if (this_command_key_count
< this_single_command_key_start
)
932 this_single_command_key_start
= this_command_key_count
;
933 echo_truncate (before_command_echo_length_1
);
934 before_command_restore_flag
= 0;
938 if (this_command_key_count
>= ASIZE (this_command_keys
))
939 this_command_keys
= larger_vector (this_command_keys
,
940 2 * ASIZE (this_command_keys
),
943 AREF (this_command_keys
, this_command_key_count
) = key
;
944 ++this_command_key_count
;
951 int count
= SPECPDL_INDEX ();
954 if (command_loop_level
> 0)
956 specbind (Qstandard_output
, Qt
);
957 specbind (Qstandard_input
, Qt
);
960 #ifdef HAVE_X_WINDOWS
961 /* The command loop has started an hourglass timer, so we have to
962 cancel it here, otherwise it will fire because the recursive edit
963 can take some time. Do not check for display_hourglass_p here,
964 because it could already be nil. */
968 /* This function may have been called from a debugger called from
969 within redisplay, for instance by Edebugging a function called
970 from fontification-functions. We want to allow redisplay in
971 the debugging session.
973 The recursive edit is left with a `(throw exit ...)'. The `exit'
974 tag is not caught anywhere in redisplay, i.e. when we leave the
975 recursive edit, the original redisplay leading to the recursive
976 edit will be unwound. The outcome should therefore be safe. */
977 specbind (Qinhibit_redisplay
, Qnil
);
980 val
= command_loop ();
982 Fsignal (Qquit
, Qnil
);
983 /* Handle throw from read_minibuf when using minibuffer
984 while it's active but we're in another window. */
986 Fsignal (Qerror
, Fcons (val
, Qnil
));
988 return unbind_to (count
, Qnil
);
991 /* When an auto-save happens, record the "time", and don't do again soon. */
996 last_auto_save
= num_nonmacro_input_events
;
999 /* Make an auto save happen as soon as possible at command level. */
1002 force_auto_save_soon ()
1004 last_auto_save
= - auto_save_interval
- 1;
1006 record_asynch_buffer_change ();
1009 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
1010 doc
: /* Invoke the editor command loop recursively.
1011 To get out of the recursive edit, a command can do `(throw 'exit nil)';
1012 that tells this function to return.
1013 Alternatively, `(throw 'exit t)' makes this function signal an error.
1014 This function is called by the editor initialization to begin editing. */)
1017 int count
= SPECPDL_INDEX ();
1020 /* If we enter while input is blocked, don't lock up here.
1021 This may happen through the debugger during redisplay. */
1022 if (INPUT_BLOCKED_P
)
1025 command_loop_level
++;
1026 update_mode_lines
= 1;
1028 if (command_loop_level
1029 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
1030 buffer
= Fcurrent_buffer ();
1034 /* If we leave recursive_edit_1 below with a `throw' for instance,
1035 like it is done in the splash screen display, we have to
1036 make sure that we restore single_kboard as command_loop_1
1037 would have done if it were left normally. */
1038 temporarily_switch_to_single_kboard (FRAME_KBOARD (SELECTED_FRAME ()));
1039 record_unwind_protect (recursive_edit_unwind
, buffer
);
1041 recursive_edit_1 ();
1042 return unbind_to (count
, Qnil
);
1046 recursive_edit_unwind (buffer
)
1049 if (BUFFERP (buffer
))
1050 Fset_buffer (buffer
);
1052 command_loop_level
--;
1053 update_mode_lines
= 1;
1062 #if 0 /* Theory: if there's anything in Vunread_command_events,
1063 it will right away be read by read_key_sequence,
1064 and then if we do switch KBOARDS, it will go into the side
1065 queue then. So we don't need to do anything special here -- rms. */
1066 if (CONSP (Vunread_command_events
))
1068 current_kboard
->kbd_queue
1069 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
1070 current_kboard
->kbd_queue_has_data
= 1;
1072 Vunread_command_events
= Qnil
;
1078 /* Switch to the single-kboard state, making current_kboard
1079 the only KBOARD from which further input is accepted. */
1082 single_kboard_state ()
1089 /* If we're in single_kboard state for kboard KBOARD,
1093 not_single_kboard_state (kboard
)
1097 if (kboard
== current_kboard
)
1102 /* Maintain a stack of kboards, so other parts of Emacs
1103 can switch temporarily to the kboard of a given frame
1104 and then revert to the previous status. */
1109 struct kboard_stack
*next
;
1112 static struct kboard_stack
*kboard_stack
;
1119 struct kboard_stack
*p
1120 = (struct kboard_stack
*) xmalloc (sizeof (struct kboard_stack
));
1122 p
->next
= kboard_stack
;
1123 p
->kboard
= current_kboard
;
1131 push_frame_kboard (f
)
1134 push_kboard (f
->device
->kboard
);
1141 struct kboard_stack
*p
= kboard_stack
;
1142 current_kboard
= p
->kboard
;
1143 kboard_stack
= p
->next
;
1148 /* Switch to single_kboard mode. If K is non-nil, set it as the
1149 current keyboard. Use record_unwind_protect to return to the
1150 previous state later. */
1153 temporarily_switch_to_single_kboard (k
)
1157 int was_locked
= single_kboard
;
1161 push_kboard (current_kboard
);
1162 single_kboard_state ();
1163 record_unwind_protect (restore_kboard_configuration
,
1164 (was_locked
? Qt
: Qnil
));
1169 record_single_kboard_state ()
1171 push_kboard (current_kboard
);
1172 record_unwind_protect (restore_kboard_configuration
,
1173 (single_kboard
? Qt
: Qnil
));
1177 restore_kboard_configuration (was_locked
)
1178 Lisp_Object was_locked
;
1181 if (NILP (was_locked
))
1182 any_kboard_state ();
1184 single_kboard_state ();
1188 /* Handle errors that are not handled at inner levels
1189 by printing an error message and returning to the editor command loop. */
1195 Lisp_Object old_level
, old_length
;
1196 char macroerror
[50];
1198 #ifdef HAVE_X_WINDOWS
1199 if (display_hourglass_p
)
1200 cancel_hourglass ();
1203 if (!NILP (executing_kbd_macro
))
1205 if (executing_kbd_macro_iterations
== 1)
1206 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1208 sprintf (macroerror
, "After %d kbd macro iterations: ",
1209 executing_kbd_macro_iterations
);
1214 Vstandard_output
= Qt
;
1215 Vstandard_input
= Qt
;
1216 Vexecuting_kbd_macro
= Qnil
;
1217 executing_kbd_macro
= Qnil
;
1218 current_kboard
->Vprefix_arg
= Qnil
;
1219 current_kboard
->Vlast_prefix_arg
= Qnil
;
1222 /* Avoid unquittable loop if data contains a circular list. */
1223 old_level
= Vprint_level
;
1224 old_length
= Vprint_length
;
1225 XSETFASTINT (Vprint_level
, 10);
1226 XSETFASTINT (Vprint_length
, 10);
1227 cmd_error_internal (data
, macroerror
);
1228 Vprint_level
= old_level
;
1229 Vprint_length
= old_length
;
1233 Vinhibit_quit
= Qnil
;
1235 if (command_loop_level
== 0 && minibuf_level
== 0)
1236 any_kboard_state ();
1239 return make_number (0);
1242 /* Take actions on handling an error. DATA is the data that describes
1245 CONTEXT is a C-string containing ASCII characters only which
1246 describes the context in which the error happened. If we need to
1247 generalize CONTEXT to allow multibyte characters, make it a Lisp
1251 cmd_error_internal (data
, context
)
1256 int kill_emacs_p
= 0;
1257 struct frame
*sf
= SELECTED_FRAME ();
1261 clear_message (1, 0);
1263 /* If the window system or terminal frame hasn't been initialized
1264 yet, or we're not interactive, it's best to dump this message out
1265 to stderr and exit. */
1266 if (!sf
->glyphs_initialized_p
1267 || FRAME_INITIAL_P (sf
)
1270 stream
= Qexternal_debugging_output
;
1276 message_log_maybe_newline ();
1281 /* The immediate context is not interesting for Quits,
1282 since they are asyncronous. */
1283 if (EQ (XCAR (data
), Qquit
))
1284 Vsignaling_function
= Qnil
;
1286 print_error_message (data
, stream
, context
, Vsignaling_function
);
1288 Vsignaling_function
= Qnil
;
1290 /* If the window system or terminal frame hasn't been initialized
1291 yet, or we're in -batch mode, this error should cause Emacs to exit. */
1295 Fkill_emacs (make_number (-1));
1299 Lisp_Object
command_loop_1 ();
1300 Lisp_Object
command_loop_2 ();
1301 Lisp_Object
top_level_1 ();
1303 /* Entry to editor-command-loop.
1304 This level has the catches for exiting/returning to editor command loop.
1305 It returns nil to exit recursive edit, t to abort it. */
1310 if (command_loop_level
> 0 || minibuf_level
> 0)
1313 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1314 executing_kbd_macro
= Qnil
;
1320 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1321 /* Reset single_kboard in case top-level set it while
1322 evaluating an -f option, or we are stuck there for some
1324 any_kboard_state ();
1325 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1326 executing_kbd_macro
= Qnil
;
1328 /* End of file in -batch run causes exit here. */
1334 /* Here we catch errors in execution of commands within the
1335 editing loop, and reenter the editing loop.
1336 When there is an error, cmd_error runs and returns a non-nil
1337 value to us. A value of nil means that command_loop_1 itself
1338 returned due to end of file (or end of kbd macro). */
1343 register Lisp_Object val
;
1346 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1347 while (!NILP (val
));
1355 return Feval (Vtop_level
);
1361 /* On entry to the outer level, run the startup file */
1362 if (!NILP (Vtop_level
))
1363 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1364 else if (!NILP (Vpurify_flag
))
1365 message ("Bare impure Emacs (standard Lisp code not loaded)");
1367 message ("Bare Emacs (standard Lisp code not loaded)");
1371 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1372 doc
: /* Exit all recursive editing levels. */)
1375 #ifdef HAVE_X_WINDOWS
1376 if (display_hourglass_p
)
1377 cancel_hourglass ();
1380 /* Unblock input if we enter with input blocked. This may happen if
1381 redisplay traps e.g. during tool-bar update with input blocked. */
1382 while (INPUT_BLOCKED_P
)
1385 return Fthrow (Qtop_level
, Qnil
);
1388 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1389 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1392 if (command_loop_level
> 0 || minibuf_level
> 0)
1393 Fthrow (Qexit
, Qnil
);
1395 error ("No recursive edit is in progress");
1399 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1400 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1403 if (command_loop_level
> 0 || minibuf_level
> 0)
1406 error ("No recursive edit is in progress");
1410 /* This is the actual command reading loop,
1411 sans error-handling encapsulation. */
1413 static int read_key_sequence
P_ ((Lisp_Object
*, int, Lisp_Object
,
1415 void safe_run_hooks
P_ ((Lisp_Object
));
1416 static void adjust_point_for_property
P_ ((int, int));
1418 /* Cancel hourglass from protect_unwind.
1420 #ifdef HAVE_X_WINDOWS
1422 cancel_hourglass_unwind (arg
)
1425 cancel_hourglass ();
1436 Lisp_Object keybuf
[30];
1439 int prev_modiff
= 0;
1440 struct buffer
*prev_buffer
= NULL
;
1442 int was_locked
= single_kboard
;
1444 int already_adjusted
= 0;
1446 current_kboard
->Vprefix_arg
= Qnil
;
1447 current_kboard
->Vlast_prefix_arg
= Qnil
;
1448 Vdeactivate_mark
= Qnil
;
1449 waiting_for_input
= 0;
1453 this_command_key_count
= 0;
1454 this_command_key_count_reset
= 0;
1455 this_single_command_key_start
= 0;
1457 if (NILP (Vmemory_full
))
1459 /* Make sure this hook runs after commands that get errors and
1460 throw to top level. */
1461 /* Note that the value cell will never directly contain nil
1462 if the symbol is a local variable. */
1463 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1464 safe_run_hooks (Qpost_command_hook
);
1466 /* If displaying a message, resize the echo area window to fit
1467 that message's size exactly. */
1468 if (!NILP (echo_area_buffer
[0]))
1469 resize_echo_area_exactly ();
1471 if (!NILP (Vdeferred_action_list
))
1472 safe_run_hooks (Qdeferred_action_function
);
1475 Vmemory_full
= Qnil
;
1477 /* Do this after running Vpost_command_hook, for consistency. */
1478 current_kboard
->Vlast_command
= Vthis_command
;
1479 current_kboard
->Vreal_last_command
= real_this_command
;
1483 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1486 /* Make sure the current window's buffer is selected. */
1487 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1488 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1490 /* Display any malloc warning that just came out. Use while because
1491 displaying one warning can cause another. */
1493 while (pending_malloc_warning
)
1494 display_malloc_warning ();
1498 Vdeactivate_mark
= Qnil
;
1500 /* If minibuffer on and echo area in use,
1501 wait a short time and redraw minibuffer. */
1504 && !NILP (echo_area_buffer
[0])
1505 && EQ (minibuf_window
, echo_area_window
)
1506 && NUMBERP (Vminibuffer_message_timeout
))
1508 /* Bind inhibit-quit to t so that C-g gets read in
1509 rather than quitting back to the minibuffer. */
1510 int count
= SPECPDL_INDEX ();
1511 specbind (Qinhibit_quit
, Qt
);
1513 Fsit_for (Vminibuffer_message_timeout
, Qnil
, Qnil
);
1514 /* Clear the echo area. */
1516 safe_run_hooks (Qecho_area_clear_hook
);
1518 unbind_to (count
, Qnil
);
1520 /* If a C-g came in before, treat it as input now. */
1521 if (!NILP (Vquit_flag
))
1524 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1529 alloca (0); /* Cause a garbage collection now */
1530 /* Since we can free the most stuff here. */
1531 #endif /* C_ALLOCA */
1534 /* Select the frame that the last event came from. Usually,
1535 switch-frame events will take care of this, but if some lisp
1536 code swallows a switch-frame event, we'll fix things up here.
1537 Is this a good idea? */
1538 if (FRAMEP (internal_last_event_frame
)
1539 && !EQ (internal_last_event_frame
, selected_frame
))
1540 Fselect_frame (internal_last_event_frame
);
1542 /* If it has changed current-menubar from previous value,
1543 really recompute the menubar from the value. */
1544 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1545 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1546 call0 (Qrecompute_lucid_menubar
);
1548 before_command_key_count
= this_command_key_count
;
1549 before_command_echo_length
= echo_length ();
1551 Vthis_command
= Qnil
;
1552 real_this_command
= Qnil
;
1553 Vthis_original_command
= Qnil
;
1555 /* Read next key sequence; i gets its length. */
1556 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1559 /* A filter may have run while we were reading the input. */
1560 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1562 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
1563 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1567 /* Now we have read a key sequence of length I,
1568 or else I is 0 and we found end of file. */
1570 if (i
== 0) /* End of file -- happens only in */
1571 return Qnil
; /* a kbd macro, at the end. */
1572 /* -1 means read_key_sequence got a menu that was rejected.
1573 Just loop around and read another command. */
1577 this_command_key_count
= 0;
1578 this_command_key_count_reset
= 0;
1579 this_single_command_key_start
= 0;
1583 last_command_char
= keybuf
[i
- 1];
1585 /* If the previous command tried to force a specific window-start,
1586 forget about that, in case this command moves point far away
1587 from that position. But also throw away beg_unchanged and
1588 end_unchanged information in that case, so that redisplay will
1589 update the whole window properly. */
1590 if (!NILP (XWINDOW (selected_window
)->force_start
))
1593 XWINDOW (selected_window
)->force_start
= Qnil
;
1594 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1595 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1598 cmd
= read_key_sequence_cmd
;
1599 if (!NILP (Vexecuting_kbd_macro
))
1601 if (!NILP (Vquit_flag
))
1603 Vexecuting_kbd_macro
= Qt
;
1604 QUIT
; /* Make some noise. */
1605 /* Will return since macro now empty. */
1609 /* Do redisplay processing after this command except in special
1610 cases identified below. */
1611 prev_buffer
= current_buffer
;
1612 prev_modiff
= MODIFF
;
1613 last_point_position
= PT
;
1614 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1616 /* By default, we adjust point to a boundary of a region that
1617 has such a property that should be treated intangible
1618 (e.g. composition, display). But, some commands will set
1619 this variable differently. */
1620 Vdisable_point_adjustment
= Qnil
;
1622 /* Process filters and timers may have messed with deactivate-mark.
1623 reset it before we execute the command. */
1624 Vdeactivate_mark
= Qnil
;
1626 /* Remap command through active keymaps */
1627 Vthis_original_command
= cmd
;
1631 if (cmd1
= Fcommand_remapping (cmd
), !NILP (cmd1
))
1635 /* Execute the command. */
1637 Vthis_command
= cmd
;
1638 real_this_command
= cmd
;
1639 /* Note that the value cell will never directly contain nil
1640 if the symbol is a local variable. */
1641 if (!NILP (Vpre_command_hook
) && !NILP (Vrun_hooks
))
1642 safe_run_hooks (Qpre_command_hook
);
1644 already_adjusted
= 0;
1646 if (NILP (Vthis_command
))
1648 /* nil means key is undefined. */
1649 Lisp_Object keys
= Fvector (i
, keybuf
);
1650 keys
= Fkey_description (keys
, Qnil
);
1652 message_with_string ("%s is undefined", keys
, 0);
1653 current_kboard
->defining_kbd_macro
= Qnil
;
1654 update_mode_lines
= 1;
1655 current_kboard
->Vprefix_arg
= Qnil
;
1659 if (NILP (current_kboard
->Vprefix_arg
) && ! no_direct
)
1661 /* In case we jump to directly_done. */
1662 Vcurrent_prefix_arg
= current_kboard
->Vprefix_arg
;
1664 /* Recognize some common commands in common situations and
1665 do them directly. */
1666 if (EQ (Vthis_command
, Qforward_char
) && PT
< ZV
)
1668 struct Lisp_Char_Table
*dp
1669 = window_display_table (XWINDOW (selected_window
));
1670 lose
= FETCH_CHAR (PT_BYTE
);
1672 if (! NILP (Vpost_command_hook
))
1673 /* Put this before calling adjust_point_for_property
1674 so it will only get called once in any case. */
1676 if (current_buffer
== prev_buffer
1677 && last_point_position
!= PT
1678 && NILP (Vdisable_point_adjustment
)
1679 && NILP (Vglobal_disable_point_adjustment
))
1680 adjust_point_for_property (last_point_position
, 0);
1681 already_adjusted
= 1;
1682 if (PT
== last_point_position
+ 1
1684 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1685 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1686 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1687 && (lose
>= 0x20 && lose
< 0x7f)))
1688 : (lose
>= 0x20 && lose
< 0x7f))
1689 /* To extract the case of continuation on
1690 wide-column characters. */
1691 && (WIDTH_BY_CHAR_HEAD (FETCH_BYTE (PT_BYTE
)) == 1)
1692 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1694 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1696 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1698 && !windows_or_buffers_changed
1699 && EQ (current_buffer
->selective_display
, Qnil
)
1700 && !detect_input_pending ()
1701 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1702 && NILP (Vexecuting_kbd_macro
))
1703 direct_output_forward_char (1);
1706 else if (EQ (Vthis_command
, Qbackward_char
) && PT
> BEGV
)
1708 struct Lisp_Char_Table
*dp
1709 = window_display_table (XWINDOW (selected_window
));
1711 lose
= FETCH_CHAR (PT_BYTE
);
1712 if (! NILP (Vpost_command_hook
))
1714 if (current_buffer
== prev_buffer
1715 && last_point_position
!= PT
1716 && NILP (Vdisable_point_adjustment
)
1717 && NILP (Vglobal_disable_point_adjustment
))
1718 adjust_point_for_property (last_point_position
, 0);
1719 already_adjusted
= 1;
1720 if (PT
== last_point_position
- 1
1722 ? (VECTORP (DISP_CHAR_VECTOR (dp
, lose
))
1723 ? XVECTOR (DISP_CHAR_VECTOR (dp
, lose
))->size
== 1
1724 : (NILP (DISP_CHAR_VECTOR (dp
, lose
))
1725 && (lose
>= 0x20 && lose
< 0x7f)))
1726 : (lose
>= 0x20 && lose
< 0x7f))
1727 && (XFASTINT (XWINDOW (selected_window
)->last_modified
)
1729 && (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1731 && (XFASTINT (XWINDOW (selected_window
)->last_point
)
1733 && !windows_or_buffers_changed
1734 && EQ (current_buffer
->selective_display
, Qnil
)
1735 && !detect_input_pending ()
1736 && NILP (XWINDOW (selected_window
)->column_number_displayed
)
1737 && NILP (Vexecuting_kbd_macro
))
1738 direct_output_forward_char (-1);
1741 else if (EQ (Vthis_command
, Qself_insert_command
)
1742 /* Try this optimization only on char keystrokes. */
1743 && NATNUMP (last_command_char
)
1744 && CHAR_VALID_P (XFASTINT (last_command_char
), 0))
1747 = translate_char (Vtranslation_table_for_input
,
1748 XFASTINT (last_command_char
), 0, 0, 0);
1750 if (NILP (Vexecuting_kbd_macro
)
1751 && !EQ (minibuf_window
, selected_window
))
1753 if (!nonundocount
|| nonundocount
>= 20)
1761 lose
= ((XFASTINT (XWINDOW (selected_window
)->last_modified
)
1763 || (XFASTINT (XWINDOW (selected_window
)->last_overlay_modified
)
1765 || (XFASTINT (XWINDOW (selected_window
)->last_point
)
1767 || MODIFF
<= SAVE_MODIFF
1768 || windows_or_buffers_changed
1769 || !EQ (current_buffer
->selective_display
, Qnil
)
1770 || detect_input_pending ()
1771 || !NILP (XWINDOW (selected_window
)->column_number_displayed
)
1772 || !NILP (Vexecuting_kbd_macro
));
1774 value
= internal_self_insert (c
, 0);
1779 if (! NILP (Vpost_command_hook
))
1780 /* Put this before calling adjust_point_for_property
1781 so it will only get called once in any case. */
1784 /* VALUE == 1 when AFTER-CHANGE functions are
1785 installed which is the case most of the time
1786 because FONT-LOCK installs one. */
1787 if (!lose
&& !value
)
1788 direct_output_for_insert (c
);
1793 /* Here for a command that isn't executed directly */
1796 #ifdef HAVE_X_WINDOWS
1797 int scount
= SPECPDL_INDEX ();
1799 if (display_hourglass_p
1800 && NILP (Vexecuting_kbd_macro
))
1802 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1808 if (NILP (current_kboard
->Vprefix_arg
))
1810 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1812 #ifdef HAVE_X_WINDOWS
1813 /* Do not check display_hourglass_p here, because
1814 Fcommand_execute could change it, but we should cancel
1815 hourglass cursor anyway.
1816 But don't cancel the hourglass within a macro
1817 just because a command in the macro finishes. */
1818 if (NILP (Vexecuting_kbd_macro
))
1819 unbind_to (scount
, Qnil
);
1824 current_kboard
->Vlast_prefix_arg
= Vcurrent_prefix_arg
;
1826 /* Note that the value cell will never directly contain nil
1827 if the symbol is a local variable. */
1828 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1829 safe_run_hooks (Qpost_command_hook
);
1831 /* If displaying a message, resize the echo area window to fit
1832 that message's size exactly. */
1833 if (!NILP (echo_area_buffer
[0]))
1834 resize_echo_area_exactly ();
1836 if (!NILP (Vdeferred_action_list
))
1837 safe_run_hooks (Qdeferred_action_function
);
1839 /* If there is a prefix argument,
1840 1) We don't want Vlast_command to be ``universal-argument''
1841 (that would be dumb), so don't set Vlast_command,
1842 2) we want to leave echoing on so that the prefix will be
1843 echoed as part of this key sequence, so don't call
1845 3) we want to leave this_command_key_count non-zero, so that
1846 read_char will realize that it is re-reading a character, and
1847 not echo it a second time.
1849 If the command didn't actually create a prefix arg,
1850 but is merely a frame event that is transparent to prefix args,
1851 then the above doesn't apply. */
1852 if (NILP (current_kboard
->Vprefix_arg
) || CONSP (last_command_char
))
1854 current_kboard
->Vlast_command
= Vthis_command
;
1855 current_kboard
->Vreal_last_command
= real_this_command
;
1857 this_command_key_count
= 0;
1858 this_command_key_count_reset
= 0;
1859 this_single_command_key_start
= 0;
1862 if (!NILP (current_buffer
->mark_active
) && !NILP (Vrun_hooks
))
1864 /* Setting transient-mark-mode to `only' is a way of
1865 turning it on for just one command. */
1867 if (EQ (Vtransient_mark_mode
, Qidentity
))
1868 Vtransient_mark_mode
= Qnil
;
1869 if (EQ (Vtransient_mark_mode
, Qonly
))
1870 Vtransient_mark_mode
= Qidentity
;
1872 if (!NILP (Vdeactivate_mark
) && !NILP (Vtransient_mark_mode
))
1874 /* We could also call `deactivate'mark'. */
1875 if (EQ (Vtransient_mark_mode
, Qlambda
))
1876 Vtransient_mark_mode
= Qnil
;
1879 current_buffer
->mark_active
= Qnil
;
1880 call1 (Vrun_hooks
, intern ("deactivate-mark-hook"));
1883 else if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1884 call1 (Vrun_hooks
, intern ("activate-mark-hook"));
1889 if (current_buffer
== prev_buffer
1890 && last_point_position
!= PT
1891 && NILP (Vdisable_point_adjustment
)
1892 && NILP (Vglobal_disable_point_adjustment
)
1893 && !already_adjusted
)
1894 adjust_point_for_property (last_point_position
, MODIFF
!= prev_modiff
);
1896 /* Install chars successfully executed in kbd macro. */
1898 if (!NILP (current_kboard
->defining_kbd_macro
)
1899 && NILP (current_kboard
->Vprefix_arg
))
1900 finalize_kbd_macro_chars ();
1904 any_kboard_state ();
1909 extern Lisp_Object Qcomposition
, Qdisplay
;
1911 /* Adjust point to a boundary of a region that has such a property
1912 that should be treated intangible. For the moment, we check
1913 `composition', `display' and `invisible' properties.
1914 LAST_PT is the last position of point. */
1916 extern Lisp_Object Qafter_string
, Qbefore_string
;
1917 extern Lisp_Object get_pos_property
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
));
1920 adjust_point_for_property (last_pt
, modified
)
1925 Lisp_Object val
, overlay
, tmp
;
1926 int check_composition
= 1, check_display
= 1, check_invisible
= 1;
1929 /* FIXME: cycling is probably not necessary because these properties
1930 can't be usefully combined anyway. */
1931 while (check_composition
|| check_display
|| check_invisible
)
1933 if (check_composition
1934 && PT
> BEGV
&& PT
< ZV
1935 && get_property_and_range (PT
, Qcomposition
, &val
, &beg
, &end
, Qnil
)
1936 && COMPOSITION_VALID_P (beg
, end
, val
)
1937 && beg
< PT
/* && end > PT <- It's always the case. */
1938 && (last_pt
<= beg
|| last_pt
>= end
))
1941 SET_PT (PT
< last_pt
? beg
: end
);
1942 check_display
= check_invisible
= 1;
1944 check_composition
= 0;
1946 && PT
> BEGV
&& PT
< ZV
1947 && !NILP (val
= get_char_property_and_overlay
1948 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1949 && display_prop_intangible_p (val
)
1950 && (!OVERLAYP (overlay
)
1951 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1952 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1953 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1954 && (beg
< PT
/* && end > PT <- It's always the case. */
1955 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1958 SET_PT (PT
< last_pt
1959 ? (STRINGP (val
) && SCHARS (val
) == 0 ? beg
- 1 : beg
)
1961 check_composition
= check_invisible
= 1;
1964 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1966 int inv
, ellipsis
= 0;
1969 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1971 && !NILP (val
= get_char_property_and_overlay
1972 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1973 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1975 ellipsis
= ellipsis
|| inv
> 1
1976 || (OVERLAYP (overlay
)
1977 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1978 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1979 tmp
= Fnext_single_char_property_change
1980 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1981 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1984 && !NILP (val
= get_char_property_and_overlay
1985 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1986 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1988 ellipsis
= ellipsis
|| inv
> 1
1989 || (OVERLAYP (overlay
)
1990 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1991 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1992 tmp
= Fprevious_single_char_property_change
1993 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1994 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1997 /* Move away from the inside area. */
1998 if (beg
< PT
&& end
> PT
)
2000 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
2001 /* We haven't moved yet (so we don't need to fear
2002 infinite-looping) and we were outside the range
2003 before (so either end of the range still corresponds
2004 to a move in the right direction): pretend we moved
2005 less than we actually did, so that we still have
2006 more freedom below in choosing which end of the range
2008 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
2009 /* We either have moved already or the last point
2010 was already in the range: we don't get to choose
2011 which end of the range we have to go to. */
2012 : (PT
< last_pt
? beg
: end
));
2013 check_composition
= check_display
= 1;
2015 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
2016 the point to something other than its argument, due to
2017 point-motion hooks, intangibility, etc. */
2018 xassert (PT
== beg
|| PT
== end
);
2021 /* Pretend the area doesn't exist if the buffer is not
2023 if (!modified
&& !ellipsis
&& beg
< end
)
2025 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
2026 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
2027 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
2028 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
2029 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
2030 /* We've already moved as far as we can. Trying to go
2031 to the other end would mean moving backwards and thus
2032 could lead to an infinite loop. */
2034 else if (val
= get_pos_property (make_number (PT
),
2036 TEXT_PROP_MEANS_INVISIBLE (val
)
2037 && (val
= get_pos_property
2038 (make_number (PT
== beg
? end
: beg
),
2040 !TEXT_PROP_MEANS_INVISIBLE (val
)))
2041 (check_composition
= check_display
= 1,
2042 SET_PT (PT
== beg
? end
: beg
));
2045 check_invisible
= 0;
2049 /* Subroutine for safe_run_hooks: run the hook HOOK. */
2052 safe_run_hooks_1 (hook
)
2055 return call1 (Vrun_hooks
, Vinhibit_quit
);
2058 /* Subroutine for safe_run_hooks: handle an error by clearing out the hook. */
2061 safe_run_hooks_error (data
)
2064 Lisp_Object args
[3];
2065 args
[0] = build_string ("Error in %s: %s");
2066 args
[1] = Vinhibit_quit
;
2069 return Fset (Vinhibit_quit
, Qnil
);
2072 /* If we get an error while running the hook, cause the hook variable
2073 to be nil. Also inhibit quits, so that C-g won't cause the hook
2074 to mysteriously evaporate. */
2077 safe_run_hooks (hook
)
2080 int count
= SPECPDL_INDEX ();
2081 specbind (Qinhibit_quit
, hook
);
2083 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
2085 unbind_to (count
, Qnil
);
2089 /* Number of seconds between polling for input. This is a Lisp
2090 variable that can be bound. */
2092 EMACS_INT polling_period
;
2094 /* Nonzero means polling for input is temporarily suppressed. */
2096 int poll_suppress_count
;
2098 /* Asynchronous timer for polling. */
2100 struct atimer
*poll_timer
;
2103 #ifdef POLL_FOR_INPUT
2105 /* Poll for input, so what we catch a C-g if it comes in. This
2106 function is called from x_make_frame_visible, see comment
2112 if (interrupt_input_blocked
== 0
2113 && !waiting_for_input
)
2114 read_avail_input (0);
2117 /* Timer callback function for poll_timer. TIMER is equal to
2121 poll_for_input (timer
)
2122 struct atimer
*timer
;
2124 if (poll_suppress_count
== 0)
2126 interrupt_input_pending
= 1;
2128 poll_for_input_1 ();
2132 #endif /* POLL_FOR_INPUT */
2134 /* Begin signals to poll for input, if they are appropriate.
2135 This function is called unconditionally from various places. */
2140 #ifdef POLL_FOR_INPUT
2141 /* XXX This condition was (read_socket_hook && !interrupt_input),
2142 but read_socket_hook is not global anymore. Let's pretend that
2144 if (!interrupt_input
)
2146 /* Turn alarm handling on unconditionally. It might have
2147 been turned off in process.c. */
2148 turn_on_atimers (1);
2150 /* If poll timer doesn't exist, are we need one with
2151 a different interval, start a new one. */
2152 if (poll_timer
== NULL
2153 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2155 EMACS_TIME interval
;
2158 cancel_atimer (poll_timer
);
2160 EMACS_SET_SECS_USECS (interval
, polling_period
, 0);
2161 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2162 poll_for_input
, NULL
);
2165 /* Let the timer's callback function poll for input
2166 if this becomes zero. */
2167 --poll_suppress_count
;
2172 /* Nonzero if we are using polling to handle input asynchronously. */
2175 input_polling_used ()
2177 #ifdef POLL_FOR_INPUT
2178 /* XXX This condition was (read_socket_hook && !interrupt_input),
2179 but read_socket_hook is not global anymore. Let's pretend that
2181 return !interrupt_input
;
2187 /* Turn off polling. */
2192 #ifdef POLL_FOR_INPUT
2193 /* XXX This condition was (read_socket_hook && !interrupt_input),
2194 but read_socket_hook is not global anymore. Let's pretend that
2196 if (!interrupt_input
)
2197 ++poll_suppress_count
;
2201 /* Set the value of poll_suppress_count to COUNT
2202 and start or stop polling accordingly. */
2205 set_poll_suppress_count (count
)
2208 #ifdef POLL_FOR_INPUT
2209 if (count
== 0 && poll_suppress_count
!= 0)
2211 poll_suppress_count
= 1;
2214 else if (count
!= 0 && poll_suppress_count
== 0)
2218 poll_suppress_count
= count
;
2222 /* Bind polling_period to a value at least N.
2223 But don't decrease it. */
2226 bind_polling_period (n
)
2229 #ifdef POLL_FOR_INPUT
2230 int new = polling_period
;
2235 stop_other_atimers (poll_timer
);
2237 specbind (Qpolling_period
, make_number (new));
2238 /* Start a new alarm with the new period. */
2243 /* Apply the control modifier to CHARACTER. */
2249 /* Save the upper bits here. */
2250 int upper
= c
& ~0177;
2254 /* Everything in the columns containing the upper-case letters
2255 denotes a control character. */
2256 if (c
>= 0100 && c
< 0140)
2260 /* Set the shift modifier for a control char
2261 made from a shifted letter. But only for letters! */
2262 if (oc
>= 'A' && oc
<= 'Z')
2263 c
|= shift_modifier
;
2266 /* The lower-case letters denote control characters too. */
2267 else if (c
>= 'a' && c
<= 'z')
2270 /* Include the bits for control and shift
2271 only if the basic ASCII code can't indicate them. */
2275 /* Replace the high bits. */
2276 c
|= (upper
& ~ctrl_modifier
);
2281 /* Display the help-echo property of the character after the mouse pointer.
2282 Either show it in the echo area, or call show-help-function to display
2283 it by other means (maybe in a tooltip).
2285 If HELP is nil, that means clear the previous help echo.
2287 If HELP is a string, display that string. If HELP is a function,
2288 call it with OBJECT and POS as arguments; the function should
2289 return a help string or nil for none. For all other types of HELP,
2290 evaluate it to obtain a string.
2292 WINDOW is the window in which the help was generated, if any.
2293 It is nil if not in a window.
2295 If OBJECT is a buffer, POS is the position in the buffer where the
2296 `help-echo' text property was found.
2298 If OBJECT is an overlay, that overlay has a `help-echo' property,
2299 and POS is the position in the overlay's buffer under the mouse.
2301 If OBJECT is a string (an overlay string or a string displayed with
2302 the `display' property). POS is the position in that string under
2305 OK_TO_OVERWRITE_KEYSTROKE_ECHO non-zero means it's okay if the help
2306 echo overwrites a keystroke echo currently displayed in the echo
2309 Note: this function may only be called with HELP nil or a string
2310 from X code running asynchronously. */
2313 show_help_echo (help
, window
, object
, pos
, ok_to_overwrite_keystroke_echo
)
2314 Lisp_Object help
, window
, object
, pos
;
2315 int ok_to_overwrite_keystroke_echo
;
2317 if (!NILP (help
) && !STRINGP (help
))
2319 if (FUNCTIONP (help
))
2321 Lisp_Object args
[4];
2326 help
= safe_call (4, args
);
2329 help
= safe_eval (help
);
2331 if (!STRINGP (help
))
2336 if (!noninteractive
&& STRINGP (help
))
2337 help
= call1 (Qmouse_fixup_help_message
, help
);
2340 if (STRINGP (help
) || NILP (help
))
2342 if (!NILP (Vshow_help_function
))
2343 call1 (Vshow_help_function
, help
);
2344 else if (/* Don't overwrite minibuffer contents. */
2345 !MINI_WINDOW_P (XWINDOW (selected_window
))
2346 /* Don't overwrite a keystroke echo. */
2347 && (NILP (echo_message_buffer
)
2348 || ok_to_overwrite_keystroke_echo
)
2349 /* Don't overwrite a prompt. */
2350 && !cursor_in_echo_area
)
2354 int count
= SPECPDL_INDEX ();
2356 if (!help_echo_showing_p
)
2357 Vpre_help_message
= current_message ();
2359 specbind (Qmessage_truncate_lines
, Qt
);
2360 message3_nolog (help
, SBYTES (help
),
2361 STRING_MULTIBYTE (help
));
2362 unbind_to (count
, Qnil
);
2364 else if (STRINGP (Vpre_help_message
))
2366 message3_nolog (Vpre_help_message
,
2367 SBYTES (Vpre_help_message
),
2368 STRING_MULTIBYTE (Vpre_help_message
));
2369 Vpre_help_message
= Qnil
;
2375 help_echo_showing_p
= STRINGP (help
);
2381 /* Input of single characters from keyboard */
2383 Lisp_Object
print_help ();
2384 static Lisp_Object
kbd_buffer_get_event ();
2385 static void record_char ();
2388 static jmp_buf wrong_kboard_jmpbuf
;
2391 #define STOP_POLLING \
2392 do { if (! polling_stopped_here) stop_polling (); \
2393 polling_stopped_here = 1; } while (0)
2395 #define RESUME_POLLING \
2396 do { if (polling_stopped_here) start_polling (); \
2397 polling_stopped_here = 0; } while (0)
2399 /* read a character from the keyboard; call the redisplay if needed */
2400 /* commandflag 0 means do not do auto-saving, but do do redisplay.
2401 -1 means do not do redisplay, but do do autosaving.
2404 /* The arguments MAPS and NMAPS are for menu prompting.
2405 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2407 PREV_EVENT is the previous input event, or nil if we are reading
2408 the first event of a key sequence (or not reading a key sequence).
2409 If PREV_EVENT is t, that is a "magic" value that says
2410 not to run input methods, but in other respects to act as if
2411 not reading a key sequence.
2413 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2414 if we used a mouse menu to read the input, or zero otherwise. If
2415 USED_MOUSE_MENU is null, we don't dereference it.
2417 Value is t if we showed a menu and the user rejected it. */
2420 read_char (commandflag
, nmaps
, maps
, prev_event
, used_mouse_menu
)
2424 Lisp_Object prev_event
;
2425 int *used_mouse_menu
;
2427 volatile Lisp_Object c
;
2429 jmp_buf local_getcjmp
;
2431 volatile int key_already_recorded
= 0;
2432 Lisp_Object tem
, save
;
2433 volatile Lisp_Object previous_echo_area_message
;
2434 volatile Lisp_Object also_record
;
2435 volatile int reread
;
2436 struct gcpro gcpro1
, gcpro2
;
2437 int polling_stopped_here
= 0;
2441 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2442 before_command_key_count
= this_command_key_count
;
2443 before_command_echo_length
= echo_length ();
2446 previous_echo_area_message
= Qnil
;
2448 GCPRO2 (c
, previous_echo_area_message
);
2453 if (CONSP (Vunread_post_input_method_events
))
2455 c
= XCAR (Vunread_post_input_method_events
);
2456 Vunread_post_input_method_events
2457 = XCDR (Vunread_post_input_method_events
);
2459 /* Undo what read_char_x_menu_prompt did when it unread
2460 additional keys returned by Fx_popup_menu. */
2462 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2470 if (unread_command_char
!= -1)
2472 XSETINT (c
, unread_command_char
);
2473 unread_command_char
= -1;
2479 if (CONSP (Vunread_command_events
))
2481 c
= XCAR (Vunread_command_events
);
2482 Vunread_command_events
= XCDR (Vunread_command_events
);
2484 /* Undo what read_char_x_menu_prompt did when it unread
2485 additional keys returned by Fx_popup_menu. */
2487 && EQ (XCDR (c
), Qdisabled
)
2488 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2491 /* If the queued event is something that used the mouse,
2492 set used_mouse_menu accordingly. */
2494 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
)))
2495 *used_mouse_menu
= 1;
2498 goto reread_for_input_method
;
2501 if (CONSP (Vunread_input_method_events
))
2503 c
= XCAR (Vunread_input_method_events
);
2504 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2506 /* Undo what read_char_x_menu_prompt did when it unread
2507 additional keys returned by Fx_popup_menu. */
2509 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2513 goto reread_for_input_method
;
2516 this_command_key_count_reset
= 0;
2518 if (!NILP (Vexecuting_kbd_macro
))
2520 /* We set this to Qmacro; since that's not a frame, nobody will
2521 try to switch frames on us, and the selected window will
2524 Since this event came from a macro, it would be misleading to
2525 leave internal_last_event_frame set to wherever the last
2526 real event came from. Normally, a switch-frame event selects
2527 internal_last_event_frame after each command is read, but
2528 events read from a macro should never cause a new frame to be
2530 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2532 /* Exit the macro if we are at the end.
2533 Also, some things replace the macro with t
2534 to force an early exit. */
2535 if (EQ (Vexecuting_kbd_macro
, Qt
)
2536 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2542 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2543 if (STRINGP (Vexecuting_kbd_macro
)
2544 && (XINT (c
) & 0x80) && (XUINT (c
) <= 0xff))
2545 XSETFASTINT (c
, CHAR_META
| (XINT (c
) & ~0x80));
2547 executing_kbd_macro_index
++;
2552 if (!NILP (unread_switch_frame
))
2554 c
= unread_switch_frame
;
2555 unread_switch_frame
= Qnil
;
2557 /* This event should make it into this_command_keys, and get echoed
2558 again, so we do not set `reread'. */
2562 /* if redisplay was requested */
2563 if (commandflag
>= 0)
2565 /* If there is pending input, process any events which are not
2566 user-visible, such as X selection_request events. */
2568 || detect_input_pending_run_timers (0))
2569 swallow_events (0); /* may clear input_pending */
2571 /* Redisplay if no pending input. */
2572 while (!input_pending
)
2574 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2575 redisplay_preserve_echo_area (5);
2580 /* Normal case: no input arrived during redisplay. */
2583 /* Input arrived and pre-empted redisplay.
2584 Process any events which are not user-visible. */
2586 /* If that cleared input_pending, try again to redisplay. */
2590 /* Message turns off echoing unless more keystrokes turn it on again.
2592 The code in 20.x for the condition was
2594 1. echo_area_glyphs && *echo_area_glyphs
2595 2. && echo_area_glyphs != current_kboard->echobuf
2596 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2598 (1) means there's a current message displayed
2600 (2) means it's not the message from echoing from the current
2603 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2604 is set to a non-null value. This is done in read_char and it is
2605 set to echo_area_glyphs after a call to echo_char. That means
2606 ok_to_echo_at_next_pause is either null or
2607 current_kboard->echobuf with the appropriate current_kboard at
2610 So, condition (3) means in clear text ok_to_echo_at_next_pause
2611 must be either null, or the current message isn't from echoing at
2612 all, or it's from echoing from a different kboard than the
2615 if (/* There currently is something in the echo area. */
2616 !NILP (echo_area_buffer
[0])
2617 && (/* And it's either not from echoing. */
2618 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2619 /* Or it's an echo from a different kboard. */
2620 || echo_kboard
!= current_kboard
2621 /* Or we explicitly allow overwriting whatever there is. */
2622 || ok_to_echo_at_next_pause
== NULL
))
2627 /* Try reading a character via menu prompting in the minibuf.
2628 Try this before the sit-for, because the sit-for
2629 would do the wrong thing if we are supposed to do
2630 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2631 after a mouse event so don't try a minibuf menu. */
2633 if (nmaps
> 0 && INTERACTIVE
2634 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2635 /* Don't bring up a menu if we already have another event. */
2636 && NILP (Vunread_command_events
)
2637 && unread_command_char
< 0
2638 && !detect_input_pending_run_timers (0))
2640 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2643 key_already_recorded
= 1;
2648 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2649 We will do that below, temporarily for short sections of code,
2650 when appropriate. local_getcjmp must be in effect
2651 around any call to sit_for or kbd_buffer_get_event;
2652 it *must not* be in effect when we call redisplay. */
2654 if (_setjmp (local_getcjmp
))
2656 /* We must have saved the outer value of getcjmp here,
2657 so restore it now. */
2658 restore_getcjmp (save_jump
);
2659 XSETINT (c
, quit_char
);
2660 internal_last_event_frame
= selected_frame
;
2661 Vlast_event_frame
= internal_last_event_frame
;
2662 /* If we report the quit char as an event,
2663 don't do so more than once. */
2664 if (!NILP (Vinhibit_quit
))
2669 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2670 if (kb
!= current_kboard
)
2672 Lisp_Object link
= kb
->kbd_queue
;
2673 /* We shouldn't get here if we were in single-kboard mode! */
2678 while (CONSP (XCDR (link
)))
2680 if (!NILP (XCDR (link
)))
2684 kb
->kbd_queue
= Fcons (c
, Qnil
);
2686 XSETCDR (link
, Fcons (c
, Qnil
));
2687 kb
->kbd_queue_has_data
= 1;
2688 current_kboard
= kb
;
2689 /* This is going to exit from read_char
2690 so we had better get rid of this frame's stuff. */
2692 longjmp (wrong_kboard_jmpbuf
, 1);
2699 timer_start_idle ();
2701 /* If in middle of key sequence and minibuffer not active,
2702 start echoing if enough time elapses. */
2704 if (minibuf_level
== 0
2705 && !current_kboard
->immediate_echo
2706 && this_command_key_count
> 0
2708 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2709 && NILP (Fzerop (Vecho_keystrokes
))
2710 && (/* No message. */
2711 NILP (echo_area_buffer
[0])
2712 /* Or empty message. */
2713 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2714 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2715 /* Or already echoing from same kboard. */
2716 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2717 /* Or not echoing before and echoing allowed. */
2718 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2722 /* After a mouse event, start echoing right away.
2723 This is because we are probably about to display a menu,
2724 and we don't want to delay before doing so. */
2725 if (EVENT_HAS_PARAMETERS (prev_event
))
2730 double duration
= extract_float (Vecho_keystrokes
);
2731 sec
= (int) duration
;
2732 usec
= (duration
- sec
) * 1000000;
2733 save_getcjmp (save_jump
);
2734 restore_getcjmp (local_getcjmp
);
2735 tem0
= sit_for (sec
, usec
, 1, 1, 0);
2736 restore_getcjmp (save_jump
);
2738 && ! CONSP (Vunread_command_events
))
2743 /* Maybe auto save due to number of keystrokes. */
2745 if (commandflag
!= 0
2746 && auto_save_interval
> 0
2747 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2748 && !detect_input_pending_run_timers (0))
2750 Fdo_auto_save (Qnil
, Qnil
);
2751 /* Hooks can actually change some buffers in auto save. */
2755 /* Try reading using an X menu.
2756 This is never confused with reading using the minibuf
2757 because the recursive call of read_char in read_char_minibuf_menu_prompt
2758 does not pass on any keymaps. */
2760 if (nmaps
> 0 && INTERACTIVE
2761 && !NILP (prev_event
)
2762 && EVENT_HAS_PARAMETERS (prev_event
)
2763 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2764 && !EQ (XCAR (prev_event
), Qtool_bar
)
2765 /* Don't bring up a menu if we already have another event. */
2766 && NILP (Vunread_command_events
)
2767 && unread_command_char
< 0)
2769 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2771 /* Now that we have read an event, Emacs is not idle. */
2777 /* Maybe autosave and/or garbage collect due to idleness. */
2779 if (INTERACTIVE
&& NILP (c
))
2781 int delay_level
, buffer_size
;
2783 /* Slow down auto saves logarithmically in size of current buffer,
2784 and garbage collect while we're at it. */
2785 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2786 last_non_minibuf_size
= Z
- BEG
;
2787 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2789 while (buffer_size
> 64)
2790 delay_level
++, buffer_size
-= buffer_size
>> 2;
2791 if (delay_level
< 4) delay_level
= 4;
2792 /* delay_level is 4 for files under around 50k, 7 at 100k,
2793 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2795 /* Auto save if enough time goes by without input. */
2796 if (commandflag
!= 0
2797 && num_nonmacro_input_events
> last_auto_save
2798 && INTEGERP (Vauto_save_timeout
)
2799 && XINT (Vauto_save_timeout
) > 0)
2803 save_getcjmp (save_jump
);
2804 restore_getcjmp (local_getcjmp
);
2805 tem0
= sit_for (delay_level
* XFASTINT (Vauto_save_timeout
) / 4,
2807 restore_getcjmp (save_jump
);
2810 && ! CONSP (Vunread_command_events
))
2812 Fdo_auto_save (Qnil
, Qnil
);
2814 /* If we have auto-saved and there is still no input
2815 available, garbage collect if there has been enough
2816 consing going on to make it worthwhile. */
2817 if (!detect_input_pending_run_timers (0)
2818 && consing_since_gc
> gc_cons_threshold
/ 2)
2819 Fgarbage_collect ();
2826 /* If this has become non-nil here, it has been set by a timer
2827 or sentinel or filter. */
2828 if (CONSP (Vunread_command_events
))
2830 c
= XCAR (Vunread_command_events
);
2831 Vunread_command_events
= XCDR (Vunread_command_events
);
2834 /* Read something from current KBOARD's side queue, if possible. */
2838 if (current_kboard
->kbd_queue_has_data
)
2840 if (!CONSP (current_kboard
->kbd_queue
))
2842 c
= XCAR (current_kboard
->kbd_queue
);
2843 current_kboard
->kbd_queue
2844 = XCDR (current_kboard
->kbd_queue
);
2845 if (NILP (current_kboard
->kbd_queue
))
2846 current_kboard
->kbd_queue_has_data
= 0;
2847 input_pending
= readable_events (0);
2848 if (EVENT_HAS_PARAMETERS (c
)
2849 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2850 internal_last_event_frame
= XCAR (XCDR (c
));
2851 Vlast_event_frame
= internal_last_event_frame
;
2856 /* If current_kboard's side queue is empty check the other kboards.
2857 If one of them has data that we have not yet seen here,
2858 switch to it and process the data waiting for it.
2860 Note: if the events queued up for another kboard
2861 have already been seen here, and therefore are not a complete command,
2862 the kbd_queue_has_data field is 0, so we skip that kboard here.
2863 That's to avoid an infinite loop switching between kboards here. */
2864 if (NILP (c
) && !single_kboard
)
2867 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2868 if (kb
->kbd_queue_has_data
)
2870 current_kboard
= kb
;
2871 /* This is going to exit from read_char
2872 so we had better get rid of this frame's stuff. */
2874 longjmp (wrong_kboard_jmpbuf
, 1);
2883 /* Finally, we read from the main queue,
2884 and if that gives us something we can't use yet, we put it on the
2885 appropriate side queue and try again. */
2891 /* Actually read a character, waiting if necessary. */
2892 save_getcjmp (save_jump
);
2893 restore_getcjmp (local_getcjmp
);
2894 timer_start_idle ();
2895 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
);
2896 restore_getcjmp (save_jump
);
2899 if (! NILP (c
) && (kb
!= current_kboard
))
2901 Lisp_Object link
= kb
->kbd_queue
;
2904 while (CONSP (XCDR (link
)))
2906 if (!NILP (XCDR (link
)))
2910 kb
->kbd_queue
= Fcons (c
, Qnil
);
2912 XSETCDR (link
, Fcons (c
, Qnil
));
2913 kb
->kbd_queue_has_data
= 1;
2917 current_kboard
= kb
;
2918 /* This is going to exit from read_char
2919 so we had better get rid of this frame's stuff. */
2921 longjmp (wrong_kboard_jmpbuf
, 1);
2926 /* Terminate Emacs in batch mode if at eof. */
2927 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2928 Fkill_emacs (make_number (1));
2932 /* Add in any extra modifiers, where appropriate. */
2933 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2934 || ((extra_keyboard_modifiers
& 0177) < ' '
2935 && (extra_keyboard_modifiers
& 0177) != 0))
2936 XSETINT (c
, make_ctrl_char (XINT (c
)));
2938 /* Transfer any other modifier bits directly from
2939 extra_keyboard_modifiers to c. Ignore the actual character code
2940 in the low 16 bits of extra_keyboard_modifiers. */
2941 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2951 if (commandflag
>= 0
2952 && !input_pending
&& !detect_input_pending_run_timers (0))
2960 /* Buffer switch events are only for internal wakeups
2961 so don't show them to the user.
2962 Also, don't record a key if we already did. */
2963 if (BUFFERP (c
) || key_already_recorded
)
2966 /* Process special events within read_char
2967 and loop around to read another event. */
2970 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2975 int was_locked
= single_kboard
;
2977 last_input_char
= c
;
2978 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_char
), Qt
);
2980 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
))
2981 /* We stopped being idle for this event; undo that. This
2982 prevents automatic window selection (under
2983 mouse_autoselect_window from acting as a real input event, for
2984 example banishing the mouse under mouse-avoidance-mode. */
2985 timer_resume_idle ();
2987 /* Resume allowing input from any kboard, if that was true before. */
2989 any_kboard_state ();
2994 /* Handle things that only apply to characters. */
2997 /* If kbd_buffer_get_event gave us an EOF, return that. */
3001 if ((STRINGP (Vkeyboard_translate_table
)
3002 && SCHARS (Vkeyboard_translate_table
) > (unsigned) XFASTINT (c
))
3003 || (VECTORP (Vkeyboard_translate_table
)
3004 && XVECTOR (Vkeyboard_translate_table
)->size
> (unsigned) XFASTINT (c
))
3005 || (CHAR_TABLE_P (Vkeyboard_translate_table
)
3006 && CHAR_VALID_P (XINT (c
), 0)))
3009 d
= Faref (Vkeyboard_translate_table
, c
);
3010 /* nil in keyboard-translate-table means no translation. */
3016 /* If this event is a mouse click in the menu bar,
3017 return just menu-bar for now. Modify the mouse click event
3018 so we won't do this twice, then queue it up. */
3019 if (EVENT_HAS_PARAMETERS (c
)
3021 && CONSP (EVENT_START (c
))
3022 && CONSP (XCDR (EVENT_START (c
))))
3026 posn
= POSN_POSN (EVENT_START (c
));
3027 /* Handle menu-bar events:
3028 insert the dummy prefix event `menu-bar'. */
3029 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3031 /* Change menu-bar to (menu-bar) as the event "position". */
3032 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3035 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3040 /* Store these characters into recent_keys, the dribble file if any,
3041 and the keyboard macro being defined, if any. */
3043 if (! NILP (also_record
))
3044 record_char (also_record
);
3046 /* Wipe the echo area.
3047 But first, if we are about to use an input method,
3048 save the echo area contents for it to refer to. */
3050 && ! NILP (Vinput_method_function
)
3051 && (unsigned) XINT (c
) >= ' '
3052 && (unsigned) XINT (c
) != 127
3053 && (unsigned) XINT (c
) < 256)
3055 previous_echo_area_message
= Fcurrent_message ();
3056 Vinput_method_previous_message
= previous_echo_area_message
;
3059 /* Now wipe the echo area, except for help events which do their
3060 own stuff with the echo area. */
3062 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3063 && !(EQ (Qswitch_frame
, XCAR (c
)))))
3065 if (!NILP (echo_area_buffer
[0]))
3066 safe_run_hooks (Qecho_area_clear_hook
);
3067 clear_message (1, 0);
3070 reread_for_input_method
:
3072 /* Pass this to the input method, if appropriate. */
3074 && ! NILP (Vinput_method_function
)
3075 /* Don't run the input method within a key sequence,
3076 after the first event of the key sequence. */
3077 && NILP (prev_event
)
3078 && (unsigned) XINT (c
) >= ' '
3079 && (unsigned) XINT (c
) != 127
3080 && (unsigned) XINT (c
) < 256)
3083 int key_count
, key_count_reset
;
3084 struct gcpro gcpro1
;
3085 int count
= SPECPDL_INDEX ();
3087 /* Save the echo status. */
3088 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3089 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3090 Lisp_Object saved_echo_string
= current_kboard
->echo_string
;
3091 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3094 if (before_command_restore_flag
)
3096 this_command_key_count
= before_command_key_count_1
;
3097 if (this_command_key_count
< this_single_command_key_start
)
3098 this_single_command_key_start
= this_command_key_count
;
3099 echo_truncate (before_command_echo_length_1
);
3100 before_command_restore_flag
= 0;
3104 /* Save the this_command_keys status. */
3105 key_count
= this_command_key_count
;
3106 key_count_reset
= this_command_key_count_reset
;
3109 keys
= Fcopy_sequence (this_command_keys
);
3114 /* Clear out this_command_keys. */
3115 this_command_key_count
= 0;
3116 this_command_key_count_reset
= 0;
3118 /* Now wipe the echo area. */
3119 if (!NILP (echo_area_buffer
[0]))
3120 safe_run_hooks (Qecho_area_clear_hook
);
3121 clear_message (1, 0);
3124 /* If we are not reading a key sequence,
3125 never use the echo area. */
3128 specbind (Qinput_method_use_echo_area
, Qt
);
3131 /* Call the input method. */
3132 tem
= call1 (Vinput_method_function
, c
);
3134 tem
= unbind_to (count
, tem
);
3136 /* Restore the saved echoing state
3137 and this_command_keys state. */
3138 this_command_key_count
= key_count
;
3139 this_command_key_count_reset
= key_count_reset
;
3141 this_command_keys
= keys
;
3144 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3145 current_kboard
->echo_string
= saved_echo_string
;
3146 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3147 if (saved_immediate_echo
)
3152 /* The input method can return no events. */
3155 /* Bring back the previous message, if any. */
3156 if (! NILP (previous_echo_area_message
))
3157 message_with_string ("%s", previous_echo_area_message
, 0);
3160 /* It returned one event or more. */
3162 Vunread_post_input_method_events
3163 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3168 /* Display help if not echoing. */
3169 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3171 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3172 Lisp_Object help
, object
, position
, window
, tem
;
3174 tem
= Fcdr (XCDR (c
));
3177 window
= Fcar (tem
);
3179 object
= Fcar (tem
);
3181 position
= Fcar (tem
);
3183 show_help_echo (help
, window
, object
, position
, 0);
3185 /* We stopped being idle for this event; undo that. */
3186 timer_resume_idle ();
3190 if (! reread
|| this_command_key_count
== 0
3191 || this_command_key_count_reset
)
3194 /* Don't echo mouse motion events. */
3195 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3196 && NILP (Fzerop (Vecho_keystrokes
))
3197 && ! (EVENT_HAS_PARAMETERS (c
)
3198 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3201 if (! NILP (also_record
))
3202 echo_char (also_record
);
3203 /* Once we reread a character, echoing can happen
3204 the next time we pause to read a new one. */
3205 ok_to_echo_at_next_pause
= current_kboard
;
3208 /* Record this character as part of the current key. */
3209 add_command_key (c
);
3210 if (! NILP (also_record
))
3211 add_command_key (also_record
);
3214 last_input_char
= c
;
3217 /* Process the help character specially if enabled */
3218 if (!NILP (Vhelp_form
) && help_char_p (c
))
3221 count
= SPECPDL_INDEX ();
3223 record_unwind_protect (Fset_window_configuration
,
3224 Fcurrent_window_configuration (Qnil
));
3226 tem0
= Feval (Vhelp_form
);
3228 internal_with_output_to_temp_buffer ("*Help*", print_help
, tem0
);
3232 c
= read_char (0, 0, 0, Qnil
, 0);
3233 while (BUFFERP (c
));
3234 /* Remove the help from the frame */
3235 unbind_to (count
, Qnil
);
3238 if (EQ (c
, make_number (040)))
3242 c
= read_char (0, 0, 0, Qnil
, 0);
3243 while (BUFFERP (c
));
3252 /* Record a key that came from a mouse menu.
3253 Record it for echoing, for this-command-keys, and so on. */
3259 /* Wipe the echo area. */
3260 clear_message (1, 0);
3265 before_command_key_count
= this_command_key_count
;
3266 before_command_echo_length
= echo_length ();
3269 /* Don't echo mouse motion events. */
3270 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3271 && NILP (Fzerop (Vecho_keystrokes
)))
3275 /* Once we reread a character, echoing can happen
3276 the next time we pause to read a new one. */
3277 ok_to_echo_at_next_pause
= 0;
3280 /* Record this character as part of the current key. */
3281 add_command_key (c
);
3283 /* Re-reading in the middle of a command */
3284 last_input_char
= c
;
3288 /* Return 1 if should recognize C as "the help character". */
3296 if (EQ (c
, Vhelp_char
))
3298 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3299 if (EQ (c
, XCAR (tail
)))
3304 /* Record the input event C in various ways. */
3312 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3314 /* To avoid filling recent_keys with help-echo and mouse-movement
3315 events, we filter out repeated help-echo events, only store the
3316 first and last in a series of mouse-movement events, and don't
3317 store repeated help-echo events which are only separated by
3318 mouse-movement events. */
3320 Lisp_Object ev1
, ev2
, ev3
;
3323 if ((ix1
= recent_keys_index
- 1) < 0)
3324 ix1
= NUM_RECENT_KEYS
- 1;
3325 ev1
= AREF (recent_keys
, ix1
);
3327 if ((ix2
= ix1
- 1) < 0)
3328 ix2
= NUM_RECENT_KEYS
- 1;
3329 ev2
= AREF (recent_keys
, ix2
);
3331 if ((ix3
= ix2
- 1) < 0)
3332 ix3
= NUM_RECENT_KEYS
- 1;
3333 ev3
= AREF (recent_keys
, ix3
);
3335 if (EQ (XCAR (c
), Qhelp_echo
))
3337 /* Don't record `help-echo' in recent_keys unless it shows some help
3338 message, and a different help than the previously recorded
3340 Lisp_Object help
, last_help
;
3342 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3343 if (!STRINGP (help
))
3345 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3346 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3348 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3349 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3350 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3352 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3353 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3354 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3355 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3358 else if (EQ (XCAR (c
), Qmouse_movement
))
3360 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3361 So additional mouse movement events replace the last element. */
3362 Lisp_Object last_window
, window
;
3364 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3365 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3366 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3367 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3368 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3370 ASET (recent_keys
, ix1
, c
);
3376 store_kbd_macro_char (c
);
3381 ASET (recent_keys
, recent_keys_index
, c
);
3382 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3383 recent_keys_index
= 0;
3385 else if (recorded
< 0)
3387 /* We need to remove one or two events from recent_keys.
3388 To do this, we simply put nil at those events and move the
3389 recent_keys_index backwards over those events. Usually,
3390 users will never see those nil events, as they will be
3391 overwritten by the command keys entered to see recent_keys
3394 while (recorded
++ < 0 && total_keys
> 0)
3396 if (total_keys
< NUM_RECENT_KEYS
)
3398 if (--recent_keys_index
< 0)
3399 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3400 ASET (recent_keys
, recent_keys_index
, Qnil
);
3404 num_nonmacro_input_events
++;
3406 /* Write c to the dribble file. If c is a lispy event, write
3407 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3408 If you, dear reader, have a better idea, you've got the source. :-) */
3413 if (XUINT (c
) < 0x100)
3414 putc (XINT (c
), dribble
);
3416 fprintf (dribble
, " 0x%x", (int) XUINT (c
));
3420 Lisp_Object dribblee
;
3422 /* If it's a structured event, take the event header. */
3423 dribblee
= EVENT_HEAD (c
);
3425 if (SYMBOLP (dribblee
))
3427 putc ('<', dribble
);
3428 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3429 SBYTES (SYMBOL_NAME (dribblee
)),
3431 putc ('>', dribble
);
3443 struct buffer
*old
= current_buffer
;
3444 Fprinc (object
, Qnil
);
3445 set_buffer_internal (XBUFFER (Vstandard_output
));
3446 call0 (intern ("help-mode"));
3447 set_buffer_internal (old
);
3451 /* Copy out or in the info on where C-g should throw to.
3452 This is used when running Lisp code from within get_char,
3453 in case get_char is called recursively.
3454 See read_process_output. */
3460 bcopy (getcjmp
, temp
, sizeof getcjmp
);
3464 restore_getcjmp (temp
)
3467 bcopy (temp
, getcjmp
, sizeof getcjmp
);
3472 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
3473 of this function. */
3476 tracking_off (old_value
)
3477 Lisp_Object old_value
;
3479 do_mouse_tracking
= old_value
;
3480 if (NILP (old_value
))
3482 /* Redisplay may have been preempted because there was input
3483 available, and it assumes it will be called again after the
3484 input has been processed. If the only input available was
3485 the sort that we have just disabled, then we need to call
3487 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
3489 redisplay_preserve_echo_area (6);
3490 get_input_pending (&input_pending
,
3491 READABLE_EVENTS_DO_TIMERS_NOW
);
3497 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
3498 doc
: /* Evaluate BODY with mouse movement events enabled.
3499 Within a `track-mouse' form, mouse motion generates input events that
3500 you can read with `read-event'.
3501 Normally, mouse motion is ignored.
3502 usage: (track-mouse BODY ...) */)
3506 int count
= SPECPDL_INDEX ();
3509 record_unwind_protect (tracking_off
, do_mouse_tracking
);
3511 do_mouse_tracking
= Qt
;
3513 val
= Fprogn (args
);
3514 return unbind_to (count
, val
);
3517 /* If mouse has moved on some frame, return one of those frames.
3518 Return 0 otherwise. */
3523 Lisp_Object tail
, frame
;
3525 FOR_EACH_FRAME (tail
, frame
)
3527 if (XFRAME (frame
)->mouse_moved
)
3528 return XFRAME (frame
);
3534 #endif /* HAVE_MOUSE */
3536 /* Low level keyboard/mouse input.
3537 kbd_buffer_store_event places events in kbd_buffer, and
3538 kbd_buffer_get_event retrieves them. */
3540 /* Return true iff there are any events in the queue that read-char
3541 would return. If this returns false, a read-char would block. */
3543 readable_events (flags
)
3546 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3549 /* If the buffer contains only FOCUS_IN_EVENT events, and
3550 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3551 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3553 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3554 #ifdef USE_TOOLKIT_SCROLL_BARS
3555 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3559 struct input_event
*event
;
3561 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3568 #ifdef USE_TOOLKIT_SCROLL_BARS
3569 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3571 event
->kind
== FOCUS_IN_EVENT
)
3572 #ifdef USE_TOOLKIT_SCROLL_BARS
3573 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3574 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3575 && event
->part
== scroll_bar_handle
3576 && event
->modifiers
== 0)
3581 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3584 while (event
!= kbd_store_ptr
);
3591 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3592 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3597 if (current_kboard
->kbd_queue_has_data
)
3603 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3604 if (kb
->kbd_queue_has_data
)
3610 /* Set this for debugging, to have a way to get out */
3615 event_to_kboard (event
)
3616 struct input_event
*event
;
3619 frame
= event
->frame_or_window
;
3621 frame
= XCAR (frame
);
3622 else if (WINDOWP (frame
))
3623 frame
= WINDOW_FRAME (XWINDOW (frame
));
3625 /* There are still some events that don't set this field.
3626 For now, just ignore the problem.
3627 Also ignore dead frames here. */
3628 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3631 return FRAME_KBOARD (XFRAME (frame
));
3636 Lisp_Object Vthrow_on_input
;
3638 /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3641 kbd_buffer_store_event (event
)
3642 register struct input_event
*event
;
3644 kbd_buffer_store_event_hold (event
, 0);
3647 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3649 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3650 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3651 Else, if EVENT is a quit event, store the quit event
3652 in HOLD_QUIT, and return (thus ignoring further events).
3654 This is used in read_avail_input to postpone the processing
3655 of the quit event until all subsequent input events have been
3656 parsed (and discarded).
3660 kbd_buffer_store_event_hold (event
, hold_quit
)
3661 register struct input_event
*event
;
3662 struct input_event
*hold_quit
;
3664 if (event
->kind
== NO_EVENT
)
3667 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3670 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3672 register int c
= event
->code
& 0377;
3674 if (event
->modifiers
& ctrl_modifier
)
3675 c
= make_ctrl_char (c
);
3677 c
|= (event
->modifiers
3678 & (meta_modifier
| alt_modifier
3679 | hyper_modifier
| super_modifier
));
3685 struct input_event
*sp
;
3688 && (kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
)),
3689 kb
!= current_kboard
))
3692 = Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3693 Fcons (make_number (c
), Qnil
));
3694 kb
->kbd_queue_has_data
= 1;
3695 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3697 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3700 if (event_to_kboard (sp
) == kb
)
3702 sp
->kind
= NO_EVENT
;
3703 sp
->frame_or_window
= Qnil
;
3713 bcopy (event
, (char *) hold_quit
, sizeof (*event
));
3717 /* If this results in a quit_char being returned to Emacs as
3718 input, set Vlast_event_frame properly. If this doesn't
3719 get returned to Emacs as an event, the next event read
3720 will set Vlast_event_frame again, so this is safe to do. */
3724 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3726 focus
= event
->frame_or_window
;
3727 internal_last_event_frame
= focus
;
3728 Vlast_event_frame
= focus
;
3731 last_event_timestamp
= event
->timestamp
;
3732 handle_interrupt ();
3736 if (c
&& c
== stop_character
)
3742 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3743 Just ignore the second one. */
3744 else if (event
->kind
== BUFFER_SWITCH_EVENT
3745 && kbd_fetch_ptr
!= kbd_store_ptr
3746 && ((kbd_store_ptr
== kbd_buffer
3747 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3748 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3751 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3752 kbd_store_ptr
= kbd_buffer
;
3754 /* Don't let the very last slot in the buffer become full,
3755 since that would make the two pointers equal,
3756 and that is indistinguishable from an empty buffer.
3757 Discard the event if it would fill the last slot. */
3758 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3760 *kbd_store_ptr
= *event
;
3764 /* If we're inside while-no-input, and this event qualifies
3765 as input, set quit-flag to cause an interrupt. */
3766 if (!NILP (Vthrow_on_input
)
3767 && event
->kind
!= FOCUS_IN_EVENT
3768 && event
->kind
!= HELP_EVENT
3769 && event
->kind
!= DEICONIFY_EVENT
)
3771 Vquit_flag
= Vthrow_on_input
;
3772 /* If we're inside a function that wants immediate quits,
3774 if (immediate_quit
&& NILP (Vinhibit_quit
))
3784 /* Put an input event back in the head of the event queue. */
3787 kbd_buffer_unget_event (event
)
3788 register struct input_event
*event
;
3790 if (kbd_fetch_ptr
== kbd_buffer
)
3791 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3793 /* Don't let the very last slot in the buffer become full, */
3794 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3797 *kbd_fetch_ptr
= *event
;
3802 /* Generate HELP_EVENT input_events in BUFP which has room for
3803 SIZE events. If there's not enough room in BUFP, ignore this
3806 HELP is the help form.
3808 FRAME is the frame on which the help is generated. OBJECT is the
3809 Lisp object where the help was found (a buffer, a string, an
3810 overlay, or nil if neither from a string nor from a buffer. POS is
3811 the position within OBJECT where the help was found.
3813 Value is the number of input_events generated. */
3816 gen_help_event (help
, frame
, window
, object
, pos
)
3817 Lisp_Object help
, frame
, object
, window
;
3820 struct input_event event
;
3824 event
.kind
= HELP_EVENT
;
3825 event
.frame_or_window
= frame
;
3827 event
.x
= WINDOWP (window
) ? window
: frame
;
3830 kbd_buffer_store_event (&event
);
3834 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3837 kbd_buffer_store_help_event (frame
, help
)
3838 Lisp_Object frame
, help
;
3840 struct input_event event
;
3842 event
.kind
= HELP_EVENT
;
3843 event
.frame_or_window
= frame
;
3848 kbd_buffer_store_event (&event
);
3852 /* Discard any mouse events in the event buffer by setting them to
3855 discard_mouse_events ()
3857 struct input_event
*sp
;
3858 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3860 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3863 if (sp
->kind
== MOUSE_CLICK_EVENT
3864 || sp
->kind
== WHEEL_EVENT
3866 || sp
->kind
== W32_SCROLL_BAR_CLICK_EVENT
3868 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3870 sp
->kind
= NO_EVENT
;
3876 /* Return non-zero if there are any real events waiting in the event
3877 buffer, not counting `NO_EVENT's.
3879 If DISCARD is non-zero, discard NO_EVENT events at the front of
3880 the input queue, possibly leaving the input queue empty if there
3881 are no real input events. */
3884 kbd_buffer_events_waiting (discard
)
3887 struct input_event
*sp
;
3889 for (sp
= kbd_fetch_ptr
;
3890 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3893 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3900 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3904 /* Clear input event EVENT. */
3908 struct input_event
*event
;
3910 event
->kind
= NO_EVENT
;
3914 /* Read one event from the event buffer, waiting if necessary.
3915 The value is a Lisp object representing the event.
3916 The value is nil for an event that should be ignored,
3917 or that was handled here.
3918 We always read and discard one event. */
3921 kbd_buffer_get_event (kbp
, used_mouse_menu
)
3923 int *used_mouse_menu
;
3932 *kbp
= current_kboard
;
3936 /* Wait until there is input available. */
3939 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3942 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3946 /* If the quit flag is set, then read_char will return
3947 quit_char, so that counts as "available input." */
3948 if (!NILP (Vquit_flag
))
3949 quit_throw_to_read_char ();
3951 /* One way or another, wait until input is available; then, if
3952 interrupt handlers have not read it, read it now. */
3955 wait_for_kbd_input ();
3957 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3961 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3964 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3968 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3970 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3971 /* Pass 1 for EXPECT since we just waited to have input. */
3972 read_avail_input (1);
3974 #endif /* not VMS */
3977 if (CONSP (Vunread_command_events
))
3980 first
= XCAR (Vunread_command_events
);
3981 Vunread_command_events
= XCDR (Vunread_command_events
);
3982 *kbp
= current_kboard
;
3986 /* At this point, we know that there is a readable event available
3987 somewhere. If the event queue is empty, then there must be a
3988 mouse movement enabled and available. */
3989 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3991 struct input_event
*event
;
3993 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3997 last_event_timestamp
= event
->timestamp
;
4000 *kbp
= event_to_kboard (event
);
4002 *kbp
= current_kboard
; /* Better than returning null ptr? */
4004 *kbp
= &the_only_kboard
;
4009 /* These two kinds of events get special handling
4010 and don't actually appear to the command loop.
4011 We return nil for them. */
4012 if (event
->kind
== SELECTION_REQUEST_EVENT
4013 || event
->kind
== SELECTION_CLEAR_EVENT
)
4016 struct input_event copy
;
4018 /* Remove it from the buffer before processing it,
4019 since otherwise swallow_events will see it
4020 and process it again. */
4022 kbd_fetch_ptr
= event
+ 1;
4023 input_pending
= readable_events (0);
4024 x_handle_selection_event (©
);
4026 /* We're getting selection request events, but we don't have
4032 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4033 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4035 /* Make an event (delete-frame (FRAME)). */
4036 obj
= Fcons (event
->frame_or_window
, Qnil
);
4037 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
4038 kbd_fetch_ptr
= event
+ 1;
4041 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (MAC_OS)
4042 else if (event
->kind
== ICONIFY_EVENT
)
4044 /* Make an event (iconify-frame (FRAME)). */
4045 obj
= Fcons (event
->frame_or_window
, Qnil
);
4046 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
4047 kbd_fetch_ptr
= event
+ 1;
4049 else if (event
->kind
== DEICONIFY_EVENT
)
4051 /* Make an event (make-frame-visible (FRAME)). */
4052 obj
= Fcons (event
->frame_or_window
, Qnil
);
4053 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
4054 kbd_fetch_ptr
= event
+ 1;
4057 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4059 /* The value doesn't matter here; only the type is tested. */
4060 XSETBUFFER (obj
, current_buffer
);
4061 kbd_fetch_ptr
= event
+ 1;
4063 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
4064 || defined (USE_GTK)
4065 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4067 kbd_fetch_ptr
= event
+ 1;
4068 input_pending
= readable_events (0);
4069 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4070 x_activate_menubar (XFRAME (event
->frame_or_window
));
4073 #if defined (WINDOWSNT) || defined (MAC_OS)
4074 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4077 /* Make an event (language-change (KEY_SCRIPT)). */
4078 obj
= Fcons (make_number (event
->code
), Qnil
);
4080 /* Make an event (language-change (FRAME CHARSET LCID)). */
4081 obj
= Fcons (event
->frame_or_window
, Qnil
);
4083 obj
= Fcons (Qlanguage_change
, Fcons (obj
, Qnil
));
4084 kbd_fetch_ptr
= event
+ 1;
4087 else if (event
->kind
== SAVE_SESSION_EVENT
)
4089 obj
= Fcons (Qsave_session
, Qnil
);
4090 kbd_fetch_ptr
= event
+ 1;
4092 /* Just discard these, by returning nil.
4093 With MULTI_KBOARD, these events are used as placeholders
4094 when we need to randomly delete events from the queue.
4095 (They shouldn't otherwise be found in the buffer,
4096 but on some machines it appears they do show up
4097 even without MULTI_KBOARD.) */
4098 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4099 mouse events during a popup-menu call. */
4100 else if (event
->kind
== NO_EVENT
)
4101 kbd_fetch_ptr
= event
+ 1;
4102 else if (event
->kind
== HELP_EVENT
)
4104 Lisp_Object object
, position
, help
, frame
, window
;
4106 frame
= event
->frame_or_window
;
4107 object
= event
->arg
;
4108 position
= make_number (event
->code
);
4111 clear_event (event
);
4113 kbd_fetch_ptr
= event
+ 1;
4114 if (!WINDOWP (window
))
4116 obj
= Fcons (Qhelp_echo
,
4117 list5 (frame
, help
, window
, object
, position
));
4119 else if (event
->kind
== FOCUS_IN_EVENT
)
4121 /* Notification of a FocusIn event. The frame receiving the
4122 focus is in event->frame_or_window. Generate a
4123 switch-frame event if necessary. */
4124 Lisp_Object frame
, focus
;
4126 frame
= event
->frame_or_window
;
4127 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4131 if (!EQ (frame
, internal_last_event_frame
)
4132 && !EQ (frame
, selected_frame
))
4133 obj
= make_lispy_switch_frame (frame
);
4134 internal_last_event_frame
= frame
;
4135 kbd_fetch_ptr
= event
+ 1;
4139 /* If this event is on a different frame, return a switch-frame this
4140 time, and leave the event in the queue for next time. */
4144 frame
= event
->frame_or_window
;
4146 frame
= XCAR (frame
);
4147 else if (WINDOWP (frame
))
4148 frame
= WINDOW_FRAME (XWINDOW (frame
));
4150 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4154 if (! EQ (frame
, internal_last_event_frame
)
4155 && !EQ (frame
, selected_frame
))
4156 obj
= make_lispy_switch_frame (frame
);
4157 internal_last_event_frame
= frame
;
4159 /* If we didn't decide to make a switch-frame event, go ahead
4160 and build a real event from the queue entry. */
4164 obj
= make_lispy_event (event
);
4166 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined(MAC_OS) \
4167 || defined (USE_GTK)
4168 /* If this was a menu selection, then set the flag to inhibit
4169 writing to last_nonmenu_event. Don't do this if the event
4170 we're returning is (menu-bar), though; that indicates the
4171 beginning of the menu sequence, and we might as well leave
4172 that as the `event with parameters' for this selection. */
4174 && !EQ (event
->frame_or_window
, event
->arg
)
4175 && (event
->kind
== MENU_BAR_EVENT
4176 || event
->kind
== TOOL_BAR_EVENT
))
4177 *used_mouse_menu
= 1;
4180 /* Wipe out this event, to catch bugs. */
4181 clear_event (event
);
4182 kbd_fetch_ptr
= event
+ 1;
4187 /* Try generating a mouse motion event. */
4188 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4190 FRAME_PTR f
= some_mouse_moved ();
4191 Lisp_Object bar_window
;
4192 enum scroll_bar_part part
;
4196 *kbp
= current_kboard
;
4197 /* Note that this uses F to determine which display to look at.
4198 If there is no valid info, it does not store anything
4199 so x remains nil. */
4202 /* XXX Can f or mouse_position_hook be NULL here? */
4203 if (f
&& FRAME_DEVICE (f
)->mouse_position_hook
)
4204 (*FRAME_DEVICE (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4205 &part
, &x
, &y
, &time
);
4209 /* Decide if we should generate a switch-frame event. Don't
4210 generate switch-frame events for motion outside of all Emacs
4216 frame
= FRAME_FOCUS_FRAME (f
);
4218 XSETFRAME (frame
, f
);
4220 if (! EQ (frame
, internal_last_event_frame
)
4221 && !EQ (frame
, selected_frame
))
4222 obj
= make_lispy_switch_frame (frame
);
4223 internal_last_event_frame
= frame
;
4226 /* If we didn't decide to make a switch-frame event, go ahead and
4227 return a mouse-motion event. */
4228 if (!NILP (x
) && NILP (obj
))
4229 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, time
);
4231 #endif /* HAVE_MOUSE */
4233 /* We were promised by the above while loop that there was
4234 something for us to read! */
4237 input_pending
= readable_events (0);
4239 Vlast_event_frame
= internal_last_event_frame
;
4244 /* Process any events that are not user-visible,
4245 then return, without reading any user-visible events. */
4248 swallow_events (do_display
)
4253 while (kbd_fetch_ptr
!= kbd_store_ptr
)
4255 struct input_event
*event
;
4257 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
4261 last_event_timestamp
= event
->timestamp
;
4263 /* These two kinds of events get special handling
4264 and don't actually appear to the command loop. */
4265 if (event
->kind
== SELECTION_REQUEST_EVENT
4266 || event
->kind
== SELECTION_CLEAR_EVENT
)
4269 struct input_event copy
;
4271 /* Remove it from the buffer before processing it,
4272 since otherwise swallow_events called recursively could see it
4273 and process it again. */
4275 kbd_fetch_ptr
= event
+ 1;
4276 input_pending
= readable_events (0);
4277 x_handle_selection_event (©
);
4279 /* We're getting selection request events, but we don't have
4288 old_timers_run
= timers_run
;
4289 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4291 if (timers_run
!= old_timers_run
&& do_display
)
4292 redisplay_preserve_echo_area (7);
4295 /* Record the start of when Emacs is idle,
4296 for the sake of running idle-time timers. */
4303 /* If we are already in the idle state, do nothing. */
4304 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4307 EMACS_GET_TIME (timer_idleness_start_time
);
4309 timer_last_idleness_start_time
= timer_idleness_start_time
;
4311 /* Mark all idle-time timers as once again candidates for running. */
4312 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4316 timer
= XCAR (timers
);
4318 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4320 XVECTOR (timer
)->contents
[0] = Qnil
;
4324 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4329 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
4332 /* Resume idle timer from last idle start time. */
4335 timer_resume_idle ()
4337 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4340 timer_idleness_start_time
= timer_last_idleness_start_time
;
4343 /* This is only for debugging. */
4344 struct input_event last_timer_event
;
4346 /* Check whether a timer has fired. To prevent larger problems we simply
4347 disregard elements that are not proper timers. Do not make a circular
4348 timer list for the time being.
4350 Returns the number of seconds to wait until the next timer fires. If a
4351 timer is triggering now, return zero seconds.
4352 If no timer is active, return -1 seconds.
4354 If a timer is ripe, we run it, with quitting turned off.
4356 DO_IT_NOW is now ignored. It used to mean that we should
4357 run the timer directly instead of queueing a timer-event.
4358 Now we always run timers directly. */
4361 timer_check (do_it_now
)
4364 EMACS_TIME nexttime
;
4365 EMACS_TIME now
, idleness_now
;
4366 Lisp_Object timers
, idle_timers
, chosen_timer
;
4367 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4369 EMACS_SET_SECS (nexttime
, -1);
4370 EMACS_SET_USECS (nexttime
, -1);
4372 /* Always consider the ordinary timers. */
4373 timers
= Vtimer_list
;
4374 /* Consider the idle timers only if Emacs is idle. */
4375 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4376 idle_timers
= Vtimer_idle_list
;
4379 chosen_timer
= Qnil
;
4380 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4382 if (CONSP (timers
) || CONSP (idle_timers
))
4384 EMACS_GET_TIME (now
);
4385 if (! EMACS_TIME_NEG_P (timer_idleness_start_time
))
4386 EMACS_SUB_TIME (idleness_now
, now
, timer_idleness_start_time
);
4389 while (CONSP (timers
) || CONSP (idle_timers
))
4391 Lisp_Object
*vector
;
4392 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4393 EMACS_TIME timer_time
, idle_timer_time
;
4394 EMACS_TIME difference
, timer_difference
, idle_timer_difference
;
4396 /* Skip past invalid timers and timers already handled. */
4399 timer
= XCAR (timers
);
4400 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4402 timers
= XCDR (timers
);
4405 vector
= XVECTOR (timer
)->contents
;
4407 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4408 || !INTEGERP (vector
[3])
4409 || ! NILP (vector
[0]))
4411 timers
= XCDR (timers
);
4415 if (!NILP (idle_timers
))
4417 timer
= XCAR (idle_timers
);
4418 if (!VECTORP (timer
) || XVECTOR (timer
)->size
!= 8)
4420 idle_timers
= XCDR (idle_timers
);
4423 vector
= XVECTOR (timer
)->contents
;
4425 if (!INTEGERP (vector
[1]) || !INTEGERP (vector
[2])
4426 || !INTEGERP (vector
[3])
4427 || ! NILP (vector
[0]))
4429 idle_timers
= XCDR (idle_timers
);
4434 /* Set TIMER, TIMER_TIME and TIMER_DIFFERENCE
4435 based on the next ordinary timer.
4436 TIMER_DIFFERENCE is the distance in time from NOW to when
4437 this timer becomes ripe (negative if it's already ripe). */
4440 timer
= XCAR (timers
);
4441 vector
= XVECTOR (timer
)->contents
;
4442 EMACS_SET_SECS (timer_time
,
4443 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4444 EMACS_SET_USECS (timer_time
, XINT (vector
[3]));
4445 EMACS_SUB_TIME (timer_difference
, timer_time
, now
);
4448 /* Set IDLE_TIMER, IDLE_TIMER_TIME and IDLE_TIMER_DIFFERENCE
4449 based on the next idle timer. */
4450 if (!NILP (idle_timers
))
4452 idle_timer
= XCAR (idle_timers
);
4453 vector
= XVECTOR (idle_timer
)->contents
;
4454 EMACS_SET_SECS (idle_timer_time
,
4455 (XINT (vector
[1]) << 16) | (XINT (vector
[2])));
4456 EMACS_SET_USECS (idle_timer_time
, XINT (vector
[3]));
4457 EMACS_SUB_TIME (idle_timer_difference
, idle_timer_time
, idleness_now
);
4460 /* Decide which timer is the next timer,
4461 and set CHOSEN_TIMER, VECTOR and DIFFERENCE accordingly.
4462 Also step down the list where we found that timer. */
4464 if (! NILP (timers
) && ! NILP (idle_timers
))
4467 EMACS_SUB_TIME (temp
, timer_difference
, idle_timer_difference
);
4468 if (EMACS_TIME_NEG_P (temp
))
4470 chosen_timer
= timer
;
4471 timers
= XCDR (timers
);
4472 difference
= timer_difference
;
4476 chosen_timer
= idle_timer
;
4477 idle_timers
= XCDR (idle_timers
);
4478 difference
= idle_timer_difference
;
4481 else if (! NILP (timers
))
4483 chosen_timer
= timer
;
4484 timers
= XCDR (timers
);
4485 difference
= timer_difference
;
4489 chosen_timer
= idle_timer
;
4490 idle_timers
= XCDR (idle_timers
);
4491 difference
= idle_timer_difference
;
4493 vector
= XVECTOR (chosen_timer
)->contents
;
4495 /* If timer is ripe, run it if it hasn't been run. */
4496 if (EMACS_TIME_NEG_P (difference
)
4497 || (EMACS_SECS (difference
) == 0
4498 && EMACS_USECS (difference
) == 0))
4500 if (NILP (vector
[0]))
4502 int count
= SPECPDL_INDEX ();
4503 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4505 /* On unbind_to, resume allowing input from any kboard, if that
4507 record_single_kboard_state ();
4509 /* Mark the timer as triggered to prevent problems if the lisp
4510 code fails to reschedule it right. */
4513 specbind (Qinhibit_quit
, Qt
);
4515 call1 (Qtimer_event_handler
, chosen_timer
);
4516 Vdeactivate_mark
= old_deactivate_mark
;
4518 unbind_to (count
, Qnil
);
4520 /* Since we have handled the event,
4521 we don't need to tell the caller to wake up and do it. */
4525 /* When we encounter a timer that is still waiting,
4526 return the amount of time to wait before it is ripe. */
4533 /* No timers are pending in the future. */
4534 /* Return 0 if we generated an event, and -1 if not. */
4539 /* Caches for modify_event_symbol. */
4540 static Lisp_Object accent_key_syms
;
4541 static Lisp_Object func_key_syms
;
4542 static Lisp_Object mouse_syms
;
4543 static Lisp_Object wheel_syms
;
4544 static Lisp_Object drag_n_drop_syms
;
4546 /* This is a list of keysym codes for special "accent" characters.
4547 It parallels lispy_accent_keys. */
4549 static int lispy_accent_codes
[] =
4551 #ifdef XK_dead_circumflex
4556 #ifdef XK_dead_grave
4561 #ifdef XK_dead_tilde
4566 #ifdef XK_dead_diaeresis
4571 #ifdef XK_dead_macron
4576 #ifdef XK_dead_degree
4581 #ifdef XK_dead_acute
4586 #ifdef XK_dead_cedilla
4591 #ifdef XK_dead_breve
4596 #ifdef XK_dead_ogonek
4601 #ifdef XK_dead_caron
4606 #ifdef XK_dead_doubleacute
4607 XK_dead_doubleacute
,
4611 #ifdef XK_dead_abovedot
4616 #ifdef XK_dead_abovering
4626 #ifdef XK_dead_belowdot
4631 #ifdef XK_dead_voiced_sound
4632 XK_dead_voiced_sound
,
4636 #ifdef XK_dead_semivoiced_sound
4637 XK_dead_semivoiced_sound
,
4653 /* This is a list of Lisp names for special "accent" characters.
4654 It parallels lispy_accent_codes. */
4656 static char *lispy_accent_keys
[] =
4674 "dead-voiced-sound",
4675 "dead-semivoiced-sound",
4681 #define FUNCTION_KEY_OFFSET 0x0
4683 char *lispy_function_keys
[] =
4687 0, /* VK_LBUTTON 0x01 */
4688 0, /* VK_RBUTTON 0x02 */
4689 "cancel", /* VK_CANCEL 0x03 */
4690 0, /* VK_MBUTTON 0x04 */
4692 0, 0, 0, /* 0x05 .. 0x07 */
4694 "backspace", /* VK_BACK 0x08 */
4695 "tab", /* VK_TAB 0x09 */
4697 0, 0, /* 0x0A .. 0x0B */
4699 "clear", /* VK_CLEAR 0x0C */
4700 "return", /* VK_RETURN 0x0D */
4702 0, 0, /* 0x0E .. 0x0F */
4704 0, /* VK_SHIFT 0x10 */
4705 0, /* VK_CONTROL 0x11 */
4706 0, /* VK_MENU 0x12 */
4707 "pause", /* VK_PAUSE 0x13 */
4708 "capslock", /* VK_CAPITAL 0x14 */
4710 0, 0, 0, 0, 0, 0, /* 0x15 .. 0x1A */
4712 "escape", /* VK_ESCAPE 0x1B */
4714 0, 0, 0, 0, /* 0x1C .. 0x1F */
4716 0, /* VK_SPACE 0x20 */
4717 "prior", /* VK_PRIOR 0x21 */
4718 "next", /* VK_NEXT 0x22 */
4719 "end", /* VK_END 0x23 */
4720 "home", /* VK_HOME 0x24 */
4721 "left", /* VK_LEFT 0x25 */
4722 "up", /* VK_UP 0x26 */
4723 "right", /* VK_RIGHT 0x27 */
4724 "down", /* VK_DOWN 0x28 */
4725 "select", /* VK_SELECT 0x29 */
4726 "print", /* VK_PRINT 0x2A */
4727 "execute", /* VK_EXECUTE 0x2B */
4728 "snapshot", /* VK_SNAPSHOT 0x2C */
4729 "insert", /* VK_INSERT 0x2D */
4730 "delete", /* VK_DELETE 0x2E */
4731 "help", /* VK_HELP 0x2F */
4733 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4735 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4737 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4739 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4741 0, 0, 0, 0, 0, 0, 0, 0, 0,
4742 0, 0, 0, 0, 0, 0, 0, 0, 0,
4743 0, 0, 0, 0, 0, 0, 0, 0,
4745 "lwindow", /* VK_LWIN 0x5B */
4746 "rwindow", /* VK_RWIN 0x5C */
4747 "apps", /* VK_APPS 0x5D */
4749 0, 0, /* 0x5E .. 0x5F */
4751 "kp-0", /* VK_NUMPAD0 0x60 */
4752 "kp-1", /* VK_NUMPAD1 0x61 */
4753 "kp-2", /* VK_NUMPAD2 0x62 */
4754 "kp-3", /* VK_NUMPAD3 0x63 */
4755 "kp-4", /* VK_NUMPAD4 0x64 */
4756 "kp-5", /* VK_NUMPAD5 0x65 */
4757 "kp-6", /* VK_NUMPAD6 0x66 */
4758 "kp-7", /* VK_NUMPAD7 0x67 */
4759 "kp-8", /* VK_NUMPAD8 0x68 */
4760 "kp-9", /* VK_NUMPAD9 0x69 */
4761 "kp-multiply", /* VK_MULTIPLY 0x6A */
4762 "kp-add", /* VK_ADD 0x6B */
4763 "kp-separator", /* VK_SEPARATOR 0x6C */
4764 "kp-subtract", /* VK_SUBTRACT 0x6D */
4765 "kp-decimal", /* VK_DECIMAL 0x6E */
4766 "kp-divide", /* VK_DIVIDE 0x6F */
4767 "f1", /* VK_F1 0x70 */
4768 "f2", /* VK_F2 0x71 */
4769 "f3", /* VK_F3 0x72 */
4770 "f4", /* VK_F4 0x73 */
4771 "f5", /* VK_F5 0x74 */
4772 "f6", /* VK_F6 0x75 */
4773 "f7", /* VK_F7 0x76 */
4774 "f8", /* VK_F8 0x77 */
4775 "f9", /* VK_F9 0x78 */
4776 "f10", /* VK_F10 0x79 */
4777 "f11", /* VK_F11 0x7A */
4778 "f12", /* VK_F12 0x7B */
4779 "f13", /* VK_F13 0x7C */
4780 "f14", /* VK_F14 0x7D */
4781 "f15", /* VK_F15 0x7E */
4782 "f16", /* VK_F16 0x7F */
4783 "f17", /* VK_F17 0x80 */
4784 "f18", /* VK_F18 0x81 */
4785 "f19", /* VK_F19 0x82 */
4786 "f20", /* VK_F20 0x83 */
4787 "f21", /* VK_F21 0x84 */
4788 "f22", /* VK_F22 0x85 */
4789 "f23", /* VK_F23 0x86 */
4790 "f24", /* VK_F24 0x87 */
4792 0, 0, 0, 0, /* 0x88 .. 0x8B */
4793 0, 0, 0, 0, /* 0x8C .. 0x8F */
4795 "kp-numlock", /* VK_NUMLOCK 0x90 */
4796 "scroll", /* VK_SCROLL 0x91 */
4798 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4799 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4800 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4801 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4802 "kp-end", /* VK_NUMPAD_END 0x96 */
4803 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4804 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4805 "kp-up", /* VK_NUMPAD_UP 0x99 */
4806 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4807 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4808 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4809 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4811 0, 0, /* 0x9E .. 0x9F */
4814 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4815 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4816 * No other API or message will distinguish left and right keys this way.
4820 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4821 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4822 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4823 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4824 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4830 "attn", /* VK_ATTN 0xF6 */
4831 "crsel", /* VK_CRSEL 0xF7 */
4832 "exsel", /* VK_EXSEL 0xF8 */
4833 "ereof", /* VK_EREOF 0xF9 */
4834 "play", /* VK_PLAY 0xFA */
4835 "zoom", /* VK_ZOOM 0xFB */
4836 "noname", /* VK_NONAME 0xFC */
4837 "pa1", /* VK_PA1 0xFD */
4838 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4842 #else /* not HAVE_NTGUI */
4844 /* This should be dealt with in XTread_socket now, and that doesn't
4845 depend on the client system having the Kana syms defined. See also
4846 the XK_kana_A case below. */
4849 static char *lispy_kana_keys
[] =
4851 /* X Keysym value */
4852 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4853 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4854 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4855 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4856 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4857 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4858 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4859 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4860 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4861 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4862 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4863 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4864 "kana-i", "kana-u", "kana-e", "kana-o",
4865 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4866 "prolongedsound", "kana-A", "kana-I", "kana-U",
4867 "kana-E", "kana-O", "kana-KA", "kana-KI",
4868 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4869 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4870 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4871 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4872 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4873 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4874 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4875 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4876 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4877 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4878 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4879 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4881 #endif /* XK_kana_A */
4884 #define FUNCTION_KEY_OFFSET 0xff00
4886 /* You'll notice that this table is arranged to be conveniently
4887 indexed by X Windows keysym values. */
4888 static char *lispy_function_keys
[] =
4890 /* X Keysym value */
4892 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4893 "backspace", "tab", "linefeed", "clear",
4895 0, 0, 0, "pause", /* 0xff10...1f */
4896 0, 0, 0, 0, 0, 0, 0, "escape",
4898 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4899 "romaji", "hiragana", "katakana", "hiragana-katakana",
4900 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4901 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4902 "eisu-toggle", /* 0xff30...3f */
4903 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4904 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4906 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4907 "down", "prior", "next", "end",
4908 "begin", 0, 0, 0, 0, 0, 0, 0,
4909 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4920 "break", /* 0xff6b */
4923 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4924 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4925 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4926 0, 0, 0, 0, 0, 0, 0, 0,
4927 "kp-tab", /* 0xff89 */
4929 "kp-enter", /* 0xff8d */
4931 "kp-f1", /* 0xff91 */
4935 "kp-home", /* 0xff95 */
4940 "kp-prior", /* kp-page-up */
4941 "kp-next", /* kp-page-down */
4947 0, 0, 0, 0, 0, 0, 0, 0, 0,
4948 "kp-multiply", /* 0xffaa */
4953 "kp-divide", /* 0xffaf */
4954 "kp-0", /* 0xffb0 */
4955 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4958 "kp-equal", /* 0xffbd */
4959 "f1", /* 0xffbe */ /* IsFunctionKey */
4961 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4962 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4963 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4964 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4965 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4966 0, 0, 0, 0, 0, 0, 0, 0,
4967 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4968 0, 0, 0, 0, 0, 0, 0, "delete"
4971 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4972 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4974 static char *iso_lispy_function_keys
[] =
4976 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4977 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4978 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4979 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4980 "iso-lefttab", /* 0xfe20 */
4981 "iso-move-line-up", "iso-move-line-down",
4982 "iso-partial-line-up", "iso-partial-line-down",
4983 "iso-partial-space-left", "iso-partial-space-right",
4984 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4985 "iso-release-margin-left", "iso-release-margin-right",
4986 "iso-release-both-margins",
4987 "iso-fast-cursor-left", "iso-fast-cursor-right",
4988 "iso-fast-cursor-up", "iso-fast-cursor-down",
4989 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
4990 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
4993 #endif /* not HAVE_NTGUI */
4995 Lisp_Object Vlispy_mouse_stem
;
4997 static char *lispy_wheel_names
[] =
4999 "wheel-up", "wheel-down"
5002 /* drag-n-drop events are generated when a set of selected files are
5003 dragged from another application and dropped onto an Emacs window. */
5004 static char *lispy_drag_n_drop_names
[] =
5009 /* Scroll bar parts. */
5010 Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5011 Lisp_Object Qup
, Qdown
, Qbottom
, Qend_scroll
;
5012 Lisp_Object Qtop
, Qratio
;
5014 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5015 Lisp_Object
*scroll_bar_parts
[] = {
5016 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5017 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5020 /* User signal events. */
5021 Lisp_Object Qusr1_signal
, Qusr2_signal
;
5023 Lisp_Object
*lispy_user_signals
[] =
5025 &Qusr1_signal
, &Qusr2_signal
5029 /* A vector, indexed by button number, giving the down-going location
5030 of currently depressed buttons, both scroll bar and non-scroll bar.
5032 The elements have the form
5033 (BUTTON-NUMBER MODIFIER-MASK . REST)
5034 where REST is the cdr of a position as it would be reported in the event.
5036 The make_lispy_event function stores positions here to tell the
5037 difference between click and drag events, and to store the starting
5038 location to be included in drag events. */
5040 static Lisp_Object button_down_location
;
5042 /* Information about the most recent up-going button event: Which
5043 button, what location, and what time. */
5045 static int last_mouse_button
;
5046 static int last_mouse_x
;
5047 static int last_mouse_y
;
5048 static unsigned long button_down_time
;
5050 /* The maximum time between clicks to make a double-click, or Qnil to
5051 disable double-click detection, or Qt for no time limit. */
5053 Lisp_Object Vdouble_click_time
;
5055 /* Maximum number of pixels the mouse may be moved between clicks
5056 to make a double-click. */
5058 EMACS_INT double_click_fuzz
;
5060 /* The number of clicks in this multiple-click. */
5062 int double_click_count
;
5064 /* Return position of a mouse click or wheel event */
5067 make_lispy_position (f
, x
, y
, time
)
5073 enum window_part part
;
5074 Lisp_Object posn
= Qnil
;
5075 Lisp_Object extra_info
= Qnil
;
5078 /* Set `window' to the window under frame pixel coordinates (x,y) */
5080 window
= window_from_coordinates (f
, XINT (*x
), XINT (*y
),
5081 &part
, &wx
, &wy
, 0);
5085 if (WINDOWP (window
))
5087 /* It's a click in window window at frame coordinates (x,y) */
5088 struct window
*w
= XWINDOW (window
);
5089 Lisp_Object string_info
= Qnil
;
5090 int textpos
= -1, rx
= -1, ry
= -1;
5091 int dx
= -1, dy
= -1;
5092 int width
= -1, height
= -1;
5093 Lisp_Object object
= Qnil
;
5095 /* Set event coordinates to window-relative coordinates
5096 for constructing the Lisp event below. */
5100 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5102 /* Mode line or header line. Look for a string under
5103 the mouse that may have a `local-map' property. */
5107 posn
= part
== ON_MODE_LINE
? Qmode_line
: Qheader_line
;
5109 string
= mode_line_string (w
, part
, &rx
, &ry
, &charpos
,
5110 &object
, &dx
, &dy
, &width
, &height
);
5111 if (STRINGP (string
))
5112 string_info
= Fcons (string
, make_number (charpos
));
5113 if (w
== XWINDOW (selected_window
))
5116 textpos
= XMARKER (w
->pointm
)->charpos
;
5118 else if (part
== ON_VERTICAL_BORDER
)
5120 posn
= Qvertical_line
;
5125 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5130 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5132 string
= marginal_area_string (w
, part
, &rx
, &ry
, &charpos
,
5133 &object
, &dx
, &dy
, &width
, &height
);
5134 if (STRINGP (string
))
5135 string_info
= Fcons (string
, make_number (charpos
));
5137 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
)
5139 posn
= (part
== ON_LEFT_FRINGE
) ? Qleft_fringe
: Qright_fringe
;
5142 if (part
== ON_RIGHT_FRINGE
)
5143 dx
-= (window_box_width (w
, LEFT_MARGIN_AREA
)
5144 + window_box_width (w
, TEXT_AREA
)
5145 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5146 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5148 else if (!WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
5149 dx
-= window_box_width (w
, LEFT_MARGIN_AREA
);
5154 Lisp_Object string2
, object2
= Qnil
;
5155 struct display_pos p
;
5157 int width2
, height2
;
5158 wx
= max (WINDOW_LEFT_MARGIN_WIDTH (w
), wx
);
5159 string2
= buffer_posn_from_coords (w
, &wx
, &wy
, &p
,
5160 &object2
, &dx2
, &dy2
,
5162 textpos
= CHARPOS (p
.pos
);
5163 if (rx
< 0) rx
= wx
;
5164 if (ry
< 0) ry
= wy
;
5165 if (dx
< 0) dx
= dx2
;
5166 if (dy
< 0) dy
= dy2
;
5167 if (width
< 0) width
= width2
;
5168 if (height
< 0) height
= height2
;
5172 posn
= make_number (textpos
);
5173 if (STRINGP (string2
))
5174 string_info
= Fcons (string2
,
5175 make_number (CHARPOS (p
.string_pos
)));
5181 #ifdef HAVE_WINDOW_SYSTEM
5182 if (IMAGEP (object
))
5184 Lisp_Object image_map
, hotspot
;
5185 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5187 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5189 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5190 posn
= XCAR (hotspot
);
5195 extra_info
= Fcons (object
,
5196 Fcons (Fcons (make_number (dx
),
5198 Fcons (Fcons (make_number (width
),
5199 make_number (height
)),
5203 extra_info
= Fcons (string_info
,
5204 Fcons (make_number (textpos
),
5205 Fcons (Fcons (make_number (rx
),
5211 XSETFRAME (window
, f
);
5216 XSETFASTINT (*x
, 0);
5217 XSETFASTINT (*y
, 0);
5220 return Fcons (window
,
5222 Fcons (Fcons (*x
, *y
),
5223 Fcons (make_number (time
),
5227 /* Given a struct input_event, build the lisp event which represents
5228 it. If EVENT is 0, build a mouse movement event from the mouse
5229 movement buffer, which should have a movement event in it.
5231 Note that events must be passed to this function in the order they
5232 are received; this function stores the location of button presses
5233 in order to build drag events when the button is released. */
5236 make_lispy_event (event
)
5237 struct input_event
*event
;
5241 switch (SWITCH_ENUM_CAST (event
->kind
))
5243 /* A simple keystroke. */
5244 case ASCII_KEYSTROKE_EVENT
:
5246 Lisp_Object lispy_c
;
5247 int c
= event
->code
& 0377;
5248 /* Turn ASCII characters into control characters
5250 if (event
->modifiers
& ctrl_modifier
)
5251 c
= make_ctrl_char (c
);
5253 /* Add in the other modifier bits. We took care of ctrl_modifier
5254 just above, and the shift key was taken care of by the X code,
5255 and applied to control characters by make_ctrl_char. */
5256 c
|= (event
->modifiers
5257 & (meta_modifier
| alt_modifier
5258 | hyper_modifier
| super_modifier
));
5259 /* Distinguish Shift-SPC from SPC. */
5260 if ((event
->code
& 0377) == 040
5261 && event
->modifiers
& shift_modifier
)
5262 c
|= shift_modifier
;
5263 button_down_time
= 0;
5264 XSETFASTINT (lispy_c
, c
);
5268 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5270 Lisp_Object lispy_c
;
5271 int c
= event
->code
;
5273 /* Add in the other modifier bits. We took care of ctrl_modifier
5274 just above, and the shift key was taken care of by the X code,
5275 and applied to control characters by make_ctrl_char. */
5276 c
|= (event
->modifiers
5277 & (meta_modifier
| alt_modifier
5278 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5279 /* What about the `shift' modifier ? */
5280 button_down_time
= 0;
5281 XSETFASTINT (lispy_c
, c
);
5285 /* A function key. The symbol may need to have modifier prefixes
5287 case NON_ASCII_KEYSTROKE_EVENT
:
5288 button_down_time
= 0;
5290 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5291 if (event
->code
== lispy_accent_codes
[i
])
5292 return modify_event_symbol (i
,
5294 Qfunction_key
, Qnil
,
5295 lispy_accent_keys
, &accent_key_syms
,
5296 (sizeof (lispy_accent_keys
)
5297 / sizeof (lispy_accent_keys
[0])));
5301 if (event
->code
>= 0x400 && event
->code
< 0x500)
5302 return modify_event_symbol (event
->code
- 0x400,
5303 event
->modifiers
& ~shift_modifier
,
5304 Qfunction_key
, Qnil
,
5305 lispy_kana_keys
, &func_key_syms
,
5306 (sizeof (lispy_kana_keys
)
5307 / sizeof (lispy_kana_keys
[0])));
5308 #endif /* XK_kana_A */
5311 #ifdef ISO_FUNCTION_KEY_OFFSET
5312 if (event
->code
< FUNCTION_KEY_OFFSET
5313 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5314 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5316 Qfunction_key
, Qnil
,
5317 iso_lispy_function_keys
, &func_key_syms
,
5318 (sizeof (iso_lispy_function_keys
)
5319 / sizeof (iso_lispy_function_keys
[0])));
5322 /* Handle system-specific or unknown keysyms. */
5323 if (event
->code
& (1 << 28)
5324 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5325 || (event
->code
- FUNCTION_KEY_OFFSET
5326 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5327 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5329 /* We need to use an alist rather than a vector as the cache
5330 since we can't make a vector long enuf. */
5331 if (NILP (current_kboard
->system_key_syms
))
5332 current_kboard
->system_key_syms
= Fcons (Qnil
, Qnil
);
5333 return modify_event_symbol (event
->code
,
5336 current_kboard
->Vsystem_key_alist
,
5337 0, ¤t_kboard
->system_key_syms
,
5341 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5343 Qfunction_key
, Qnil
,
5344 lispy_function_keys
, &func_key_syms
,
5345 (sizeof (lispy_function_keys
)
5346 / sizeof (lispy_function_keys
[0])));
5349 /* A mouse click. Figure out where it is, decide whether it's
5350 a press, click or drag, and build the appropriate structure. */
5351 case MOUSE_CLICK_EVENT
:
5352 #ifndef USE_TOOLKIT_SCROLL_BARS
5353 case SCROLL_BAR_CLICK_EVENT
:
5356 int button
= event
->code
;
5358 Lisp_Object position
;
5359 Lisp_Object
*start_pos_ptr
;
5360 Lisp_Object start_pos
;
5364 /* Build the position as appropriate for this mouse click. */
5365 if (event
->kind
== MOUSE_CLICK_EVENT
)
5367 struct frame
*f
= XFRAME (event
->frame_or_window
);
5368 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5372 /* Ignore mouse events that were made on frame that
5373 have been deleted. */
5374 if (! FRAME_LIVE_P (f
))
5377 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
5378 /* EVENT->x and EVENT->y are frame-relative pixel
5379 coordinates at this place. Under old redisplay, COLUMN
5380 and ROW are set to frame relative glyph coordinates
5381 which are then used to determine whether this click is
5382 in a menu (non-toolkit version). */
5383 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5384 &column
, &row
, NULL
, 1);
5386 /* In the non-toolkit version, clicks on the menu bar
5387 are ordinary button events in the event buffer.
5388 Distinguish them, and invoke the menu.
5390 (In the toolkit version, the toolkit handles the menu bar
5391 and Emacs doesn't know about it until after the user
5392 makes a selection.) */
5393 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5394 && (event
->modifiers
& down_modifier
))
5396 Lisp_Object items
, item
;
5401 /* Activate the menu bar on the down event. If the
5402 up event comes in before the menu code can deal with it,
5404 if (! (event
->modifiers
& down_modifier
))
5408 /* Find the menu bar item under `column'. */
5410 items
= FRAME_MENU_BAR_ITEMS (f
);
5411 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
5413 Lisp_Object pos
, string
;
5414 string
= AREF (items
, i
+ 1);
5415 pos
= AREF (items
, i
+ 3);
5418 if (column
>= XINT (pos
)
5419 && column
< XINT (pos
) + SCHARS (string
))
5421 item
= AREF (items
, i
);
5426 /* ELisp manual 2.4b says (x y) are window relative but
5427 code says they are frame-relative. */
5429 = Fcons (event
->frame_or_window
,
5431 Fcons (Fcons (event
->x
, event
->y
),
5432 Fcons (make_number (event
->timestamp
),
5435 return Fcons (item
, Fcons (position
, Qnil
));
5437 #endif /* not USE_X_TOOLKIT && not USE_GTK */
5439 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5442 #ifndef USE_TOOLKIT_SCROLL_BARS
5445 /* It's a scrollbar click. */
5447 Lisp_Object portion_whole
;
5450 window
= event
->frame_or_window
;
5451 portion_whole
= Fcons (event
->x
, event
->y
);
5452 part
= *scroll_bar_parts
[(int) event
->part
];
5456 Fcons (Qvertical_scroll_bar
,
5457 Fcons (portion_whole
,
5458 Fcons (make_number (event
->timestamp
),
5459 Fcons (part
, Qnil
)))));
5461 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5463 if (button
>= ASIZE (button_down_location
))
5465 button_down_location
= larger_vector (button_down_location
,
5467 mouse_syms
= larger_vector (mouse_syms
, button
+ 1, Qnil
);
5470 start_pos_ptr
= &AREF (button_down_location
, button
);
5471 start_pos
= *start_pos_ptr
;
5472 *start_pos_ptr
= Qnil
;
5475 /* On window-system frames, use the value of
5476 double-click-fuzz as is. On other frames, interpret it
5477 as a multiple of 1/8 characters. */
5481 if (WINDOWP (event
->frame_or_window
))
5482 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5483 else if (FRAMEP (event
->frame_or_window
))
5484 f
= XFRAME (event
->frame_or_window
);
5488 if (FRAME_WINDOW_P (f
))
5489 fuzz
= double_click_fuzz
;
5491 fuzz
= double_click_fuzz
/ 8;
5493 is_double
= (button
== last_mouse_button
5494 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5495 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5496 && button_down_time
!= 0
5497 && (EQ (Vdouble_click_time
, Qt
)
5498 || (INTEGERP (Vdouble_click_time
)
5499 && ((int)(event
->timestamp
- button_down_time
)
5500 < XINT (Vdouble_click_time
)))));
5503 last_mouse_button
= button
;
5504 last_mouse_x
= XINT (event
->x
);
5505 last_mouse_y
= XINT (event
->y
);
5507 /* If this is a button press, squirrel away the location, so
5508 we can decide later whether it was a click or a drag. */
5509 if (event
->modifiers
& down_modifier
)
5513 double_click_count
++;
5514 event
->modifiers
|= ((double_click_count
> 2)
5519 double_click_count
= 1;
5520 button_down_time
= event
->timestamp
;
5521 *start_pos_ptr
= Fcopy_alist (position
);
5524 /* Now we're releasing a button - check the co-ordinates to
5525 see if this was a click or a drag. */
5526 else if (event
->modifiers
& up_modifier
)
5528 /* If we did not see a down before this up, ignore the up.
5529 Probably this happened because the down event chose a
5530 menu item. It would be an annoyance to treat the
5531 release of the button that chose the menu item as a
5534 if (!CONSP (start_pos
))
5537 event
->modifiers
&= ~up_modifier
;
5538 #if 0 /* Formerly we treated an up with no down as a click event. */
5539 if (!CONSP (start_pos
))
5540 event
->modifiers
|= click_modifier
;
5545 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5547 /* The third element of every position
5548 should be the (x,y) pair. */
5549 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5551 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5553 xdiff
= XFASTINT (event
->x
) - XFASTINT (XCAR (down
));
5554 ydiff
= XFASTINT (event
->y
) - XFASTINT (XCDR (down
));
5557 if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5558 && ydiff
< double_click_fuzz
5559 && ydiff
> - double_click_fuzz
)
5560 /* Mouse hasn't moved (much). */
5561 event
->modifiers
|= click_modifier
;
5564 button_down_time
= 0;
5565 event
->modifiers
|= drag_modifier
;
5568 /* Don't check is_double; treat this as multiple
5569 if the down-event was multiple. */
5570 if (double_click_count
> 1)
5571 event
->modifiers
|= ((double_click_count
> 2)
5577 /* Every mouse event should either have the down_modifier or
5578 the up_modifier set. */
5582 /* Get the symbol we should use for the mouse click. */
5585 head
= modify_event_symbol (button
,
5587 Qmouse_click
, Vlispy_mouse_stem
,
5590 XVECTOR (mouse_syms
)->size
);
5591 if (event
->modifiers
& drag_modifier
)
5596 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5599 Fcons (make_number (double_click_count
),
5610 Lisp_Object position
;
5613 /* Build the position as appropriate for this mouse click. */
5614 struct frame
*f
= XFRAME (event
->frame_or_window
);
5616 /* Ignore wheel events that were made on frame that have been
5618 if (! FRAME_LIVE_P (f
))
5621 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5624 /* Set double or triple modifiers to indicate the wheel speed. */
5626 /* On window-system frames, use the value of
5627 double-click-fuzz as is. On other frames, interpret it
5628 as a multiple of 1/8 characters. */
5633 if (WINDOWP (event
->frame_or_window
))
5634 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5635 else if (FRAMEP (event
->frame_or_window
))
5636 f
= XFRAME (event
->frame_or_window
);
5640 if (FRAME_WINDOW_P (f
))
5641 fuzz
= double_click_fuzz
;
5643 fuzz
= double_click_fuzz
/ 8;
5645 is_double
= (last_mouse_button
< 0
5646 && (abs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5647 && (abs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5648 && button_down_time
!= 0
5649 && (EQ (Vdouble_click_time
, Qt
)
5650 || (INTEGERP (Vdouble_click_time
)
5651 && ((int)(event
->timestamp
- button_down_time
)
5652 < XINT (Vdouble_click_time
)))));
5655 double_click_count
++;
5656 event
->modifiers
|= ((double_click_count
> 2)
5662 double_click_count
= 1;
5663 event
->modifiers
|= click_modifier
;
5666 button_down_time
= event
->timestamp
;
5667 /* Use a negative value to distinguish wheel from mouse button. */
5668 last_mouse_button
= -1;
5669 last_mouse_x
= XINT (event
->x
);
5670 last_mouse_y
= XINT (event
->y
);
5676 if (event
->modifiers
& up_modifier
)
5678 /* Emit a wheel-up event. */
5679 event
->modifiers
&= ~up_modifier
;
5682 else if (event
->modifiers
& down_modifier
)
5684 /* Emit a wheel-down event. */
5685 event
->modifiers
&= ~down_modifier
;
5689 /* Every wheel event should either have the down_modifier or
5690 the up_modifier set. */
5693 /* Get the symbol we should use for the wheel event. */
5694 head
= modify_event_symbol (symbol_num
,
5700 ASIZE (wheel_syms
));
5703 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5706 Fcons (make_number (double_click_count
),
5715 #ifdef USE_TOOLKIT_SCROLL_BARS
5717 /* We don't have down and up events if using toolkit scroll bars,
5718 so make this always a click event. Store in the `part' of
5719 the Lisp event a symbol which maps to the following actions:
5721 `above_handle' page up
5722 `below_handle' page down
5726 `bottom' bottom of buffer
5727 `handle' thumb has been dragged.
5728 `end-scroll' end of interaction with scroll bar
5730 The incoming input_event contains in its `part' member an
5731 index of type `enum scroll_bar_part' which we can use as an
5732 index in scroll_bar_parts to get the appropriate symbol. */
5734 case SCROLL_BAR_CLICK_EVENT
:
5736 Lisp_Object position
, head
, window
, portion_whole
, part
;
5738 window
= event
->frame_or_window
;
5739 portion_whole
= Fcons (event
->x
, event
->y
);
5740 part
= *scroll_bar_parts
[(int) event
->part
];
5744 Fcons (Qvertical_scroll_bar
,
5745 Fcons (portion_whole
,
5746 Fcons (make_number (event
->timestamp
),
5747 Fcons (part
, Qnil
)))));
5749 /* Always treat scroll bar events as clicks. */
5750 event
->modifiers
|= click_modifier
;
5751 event
->modifiers
&= ~up_modifier
;
5753 if (event
->code
>= ASIZE (mouse_syms
))
5754 mouse_syms
= larger_vector (mouse_syms
, event
->code
+ 1, Qnil
);
5756 /* Get the symbol we should use for the mouse click. */
5757 head
= modify_event_symbol (event
->code
,
5762 XVECTOR (mouse_syms
)->size
);
5763 return Fcons (head
, Fcons (position
, Qnil
));
5766 #endif /* USE_TOOLKIT_SCROLL_BARS */
5769 case W32_SCROLL_BAR_CLICK_EVENT
:
5771 int button
= event
->code
;
5773 Lisp_Object position
;
5774 Lisp_Object
*start_pos_ptr
;
5775 Lisp_Object start_pos
;
5779 Lisp_Object portion_whole
;
5782 window
= event
->frame_or_window
;
5783 portion_whole
= Fcons (event
->x
, event
->y
);
5784 part
= *scroll_bar_parts
[(int) event
->part
];
5788 Fcons (Qvertical_scroll_bar
,
5789 Fcons (portion_whole
,
5790 Fcons (make_number (event
->timestamp
),
5791 Fcons (part
, Qnil
)))));
5794 /* Always treat W32 scroll bar events as clicks. */
5795 event
->modifiers
|= click_modifier
;
5798 /* Get the symbol we should use for the mouse click. */
5801 head
= modify_event_symbol (button
,
5806 XVECTOR (mouse_syms
)->size
);
5812 #endif /* WINDOWSNT */
5814 case DRAG_N_DROP_EVENT
:
5817 Lisp_Object head
, position
;
5820 /* The frame_or_window field should be a cons of the frame in
5821 which the event occurred and a list of the filenames
5823 if (! CONSP (event
->frame_or_window
))
5826 f
= XFRAME (XCAR (event
->frame_or_window
));
5827 files
= XCDR (event
->frame_or_window
);
5829 /* Ignore mouse events that were made on frames that
5830 have been deleted. */
5831 if (! FRAME_LIVE_P (f
))
5834 position
= make_lispy_position (f
, &event
->x
, &event
->y
,
5837 head
= modify_event_symbol (0, event
->modifiers
,
5839 lispy_drag_n_drop_names
,
5840 &drag_n_drop_syms
, 1);
5846 #endif /* HAVE_MOUSE */
5848 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
5849 || defined (USE_GTK)
5850 case MENU_BAR_EVENT
:
5851 if (EQ (event
->arg
, event
->frame_or_window
))
5852 /* This is the prefix key. We translate this to
5853 `(menu_bar)' because the code in keyboard.c for menu
5854 events, which we use, relies on this. */
5855 return Fcons (Qmenu_bar
, Qnil
);
5859 case SELECT_WINDOW_EVENT
:
5860 /* Make an event (select-window (WINDOW)). */
5861 return Fcons (Qselect_window
,
5862 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5865 case TOOL_BAR_EVENT
:
5866 if (EQ (event
->arg
, event
->frame_or_window
))
5867 /* This is the prefix key. We translate this to
5868 `(tool_bar)' because the code in keyboard.c for tool bar
5869 events, which we use, relies on this. */
5870 return Fcons (Qtool_bar
, Qnil
);
5871 else if (SYMBOLP (event
->arg
))
5872 return apply_modifiers (event
->modifiers
, event
->arg
);
5875 case USER_SIGNAL_EVENT
:
5876 /* A user signal. */
5877 return *lispy_user_signals
[event
->code
];
5879 case SAVE_SESSION_EVENT
:
5880 return Qsave_session
;
5882 /* The 'kind' field of the event is something we don't recognize. */
5891 make_lispy_movement (frame
, bar_window
, part
, x
, y
, time
)
5893 Lisp_Object bar_window
;
5894 enum scroll_bar_part part
;
5898 /* Is it a scroll bar movement? */
5899 if (frame
&& ! NILP (bar_window
))
5901 Lisp_Object part_sym
;
5903 part_sym
= *scroll_bar_parts
[(int) part
];
5904 return Fcons (Qscroll_bar_movement
,
5905 (Fcons (Fcons (bar_window
,
5906 Fcons (Qvertical_scroll_bar
,
5907 Fcons (Fcons (x
, y
),
5908 Fcons (make_number (time
),
5914 /* Or is it an ordinary mouse movement? */
5917 Lisp_Object position
;
5919 position
= make_lispy_position (frame
, &x
, &y
, time
);
5921 return Fcons (Qmouse_movement
,
5927 #endif /* HAVE_MOUSE */
5929 /* Construct a switch frame event. */
5931 make_lispy_switch_frame (frame
)
5934 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5937 /* Manipulating modifiers. */
5939 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5941 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5942 SYMBOL's name of the end of the modifiers; the string from this
5943 position is the unmodified symbol name.
5945 This doesn't use any caches. */
5948 parse_modifiers_uncached (symbol
, modifier_end
)
5956 CHECK_SYMBOL (symbol
);
5959 name
= SYMBOL_NAME (symbol
);
5961 for (i
= 0; i
+2 <= SBYTES (name
); )
5963 int this_mod_end
= 0;
5966 /* See if the name continues with a modifier word.
5967 Check that the word appears, but don't check what follows it.
5968 Set this_mod and this_mod_end to record what we find. */
5970 switch (SREF (name
, i
))
5972 #define SINGLE_LETTER_MOD(BIT) \
5973 (this_mod_end = i + 1, this_mod = BIT)
5976 SINGLE_LETTER_MOD (alt_modifier
);
5980 SINGLE_LETTER_MOD (ctrl_modifier
);
5984 SINGLE_LETTER_MOD (hyper_modifier
);
5988 SINGLE_LETTER_MOD (meta_modifier
);
5992 SINGLE_LETTER_MOD (shift_modifier
);
5996 SINGLE_LETTER_MOD (super_modifier
);
5999 #undef SINGLE_LETTER_MOD
6001 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6002 if (i + LEN + 1 <= SBYTES (name) \
6003 && ! strncmp (SDATA (name) + i, NAME, LEN)) \
6005 this_mod_end = i + LEN; \
6010 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6011 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6012 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6016 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6018 #undef MULTI_LETTER_MOD
6022 /* If we found no modifier, stop looking for them. */
6023 if (this_mod_end
== 0)
6026 /* Check there is a dash after the modifier, so that it
6027 really is a modifier. */
6028 if (this_mod_end
>= SBYTES (name
)
6029 || SREF (name
, this_mod_end
) != '-')
6032 /* This modifier is real; look for another. */
6033 modifiers
|= this_mod
;
6034 i
= this_mod_end
+ 1;
6037 /* Should we include the `click' modifier? */
6038 if (! (modifiers
& (down_modifier
| drag_modifier
6039 | double_modifier
| triple_modifier
))
6040 && i
+ 7 == SBYTES (name
)
6041 && strncmp (SDATA (name
) + i
, "mouse-", 6) == 0
6042 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6043 modifiers
|= click_modifier
;
6051 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6052 prepended to the string BASE[0..BASE_LEN-1].
6053 This doesn't use any caches. */
6055 apply_modifiers_uncached (modifiers
, base
, base_len
, base_len_byte
)
6058 int base_len
, base_len_byte
;
6060 /* Since BASE could contain nulls, we can't use intern here; we have
6061 to use Fintern, which expects a genuine Lisp_String, and keeps a
6064 = (char *) alloca (sizeof ("A-C-H-M-S-s-down-drag-double-triple-"));
6070 /* Only the event queue may use the `up' modifier; it should always
6071 be turned into a click or drag event before presented to lisp code. */
6072 if (modifiers
& up_modifier
)
6075 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6076 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6077 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6078 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6079 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6080 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6081 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6082 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6083 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6084 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6085 /* The click modifier is denoted by the absence of other modifiers. */
6089 mod_len
= p
- new_mods
;
6093 Lisp_Object new_name
;
6095 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6096 mod_len
+ base_len_byte
);
6097 bcopy (new_mods
, SDATA (new_name
), mod_len
);
6098 bcopy (base
, SDATA (new_name
) + mod_len
, base_len_byte
);
6100 return Fintern (new_name
, Qnil
);
6105 static char *modifier_names
[] =
6107 "up", "down", "drag", "click", "double", "triple", 0, 0,
6108 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6109 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6111 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6113 static Lisp_Object modifier_symbols
;
6115 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6117 lispy_modifier_list (modifiers
)
6120 Lisp_Object modifier_list
;
6123 modifier_list
= Qnil
;
6124 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6125 if (modifiers
& (1<<i
))
6126 modifier_list
= Fcons (XVECTOR (modifier_symbols
)->contents
[i
],
6129 return modifier_list
;
6133 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6134 where UNMODIFIED is the unmodified form of SYMBOL,
6135 MASK is the set of modifiers present in SYMBOL's name.
6136 This is similar to parse_modifiers_uncached, but uses the cache in
6137 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6138 Qevent_symbol_elements property. */
6141 parse_modifiers (symbol
)
6144 Lisp_Object elements
;
6146 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6147 if (CONSP (elements
))
6152 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6153 Lisp_Object unmodified
;
6156 unmodified
= Fintern (make_string (SDATA (SYMBOL_NAME (symbol
)) + end
,
6157 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6160 if (modifiers
& ~INTMASK
)
6162 XSETFASTINT (mask
, modifiers
);
6163 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6165 /* Cache the parsing results on SYMBOL. */
6166 Fput (symbol
, Qevent_symbol_element_mask
,
6168 Fput (symbol
, Qevent_symbol_elements
,
6169 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6171 /* Since we know that SYMBOL is modifiers applied to unmodified,
6172 it would be nice to put that in unmodified's cache.
6173 But we can't, since we're not sure that parse_modifiers is
6180 /* Apply the modifiers MODIFIERS to the symbol BASE.
6181 BASE must be unmodified.
6183 This is like apply_modifiers_uncached, but uses BASE's
6184 Qmodifier_cache property, if present. It also builds
6185 Qevent_symbol_elements properties, since it has that info anyway.
6187 apply_modifiers copies the value of BASE's Qevent_kind property to
6188 the modified symbol. */
6190 apply_modifiers (modifiers
, base
)
6194 Lisp_Object cache
, index
, entry
, new_symbol
;
6196 /* Mask out upper bits. We don't know where this value's been. */
6197 modifiers
&= INTMASK
;
6199 /* The click modifier never figures into cache indices. */
6200 cache
= Fget (base
, Qmodifier_cache
);
6201 XSETFASTINT (index
, (modifiers
& ~click_modifier
));
6202 entry
= assq_no_quit (index
, cache
);
6205 new_symbol
= XCDR (entry
);
6208 /* We have to create the symbol ourselves. */
6209 new_symbol
= apply_modifiers_uncached (modifiers
,
6210 SDATA (SYMBOL_NAME (base
)),
6211 SCHARS (SYMBOL_NAME (base
)),
6212 SBYTES (SYMBOL_NAME (base
)));
6214 /* Add the new symbol to the base's cache. */
6215 entry
= Fcons (index
, new_symbol
);
6216 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6218 /* We have the parsing info now for free, so we could add it to
6220 XSETFASTINT (index, modifiers);
6221 Fput (new_symbol, Qevent_symbol_element_mask,
6222 Fcons (base, Fcons (index, Qnil)));
6223 Fput (new_symbol, Qevent_symbol_elements,
6224 Fcons (base, lispy_modifier_list (modifiers)));
6225 Sadly, this is only correct if `base' is indeed a base event,
6226 which is not necessarily the case. -stef */
6229 /* Make sure this symbol is of the same kind as BASE.
6231 You'd think we could just set this once and for all when we
6232 intern the symbol above, but reorder_modifiers may call us when
6233 BASE's property isn't set right; we can't assume that just
6234 because it has a Qmodifier_cache property it must have its
6235 Qevent_kind set right as well. */
6236 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6240 kind
= Fget (base
, Qevent_kind
);
6242 Fput (new_symbol
, Qevent_kind
, kind
);
6249 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6250 return a symbol with the modifiers placed in the canonical order.
6251 Canonical order is alphabetical, except for down and drag, which
6252 always come last. The 'click' modifier is never written out.
6254 Fdefine_key calls this to make sure that (for example) C-M-foo
6255 and M-C-foo end up being equivalent in the keymap. */
6258 reorder_modifiers (symbol
)
6261 /* It's hopefully okay to write the code this way, since everything
6262 will soon be in caches, and no consing will be done at all. */
6265 parsed
= parse_modifiers (symbol
);
6266 return apply_modifiers ((int) XINT (XCAR (XCDR (parsed
))),
6271 /* For handling events, we often want to produce a symbol whose name
6272 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6273 to some base, like the name of a function key or mouse button.
6274 modify_event_symbol produces symbols of this sort.
6276 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6277 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6280 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6281 into symbol names, or a string specifying a name stem used to
6282 construct a symbol name or the form `STEM-N', where N is the decimal
6283 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6284 non-nil; otherwise NAME_TABLE is used.
6286 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6287 persist between calls to modify_event_symbol that it can use to
6288 store a cache of the symbols it's generated for this NAME_TABLE
6289 before. The object stored there may be a vector or an alist.
6291 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6293 MODIFIERS is a set of modifier bits (as given in struct input_events)
6294 whose prefixes should be applied to the symbol name.
6296 SYMBOL_KIND is the value to be placed in the event_kind property of
6297 the returned symbol.
6299 The symbols we create are supposed to have an
6300 `event-symbol-elements' property, which lists the modifiers present
6301 in the symbol's name. */
6304 modify_event_symbol (symbol_num
, modifiers
, symbol_kind
, name_alist_or_stem
,
6305 name_table
, symbol_table
, table_size
)
6308 Lisp_Object symbol_kind
;
6309 Lisp_Object name_alist_or_stem
;
6311 Lisp_Object
*symbol_table
;
6312 unsigned int table_size
;
6315 Lisp_Object symbol_int
;
6317 /* Get rid of the "vendor-specific" bit here. */
6318 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6320 /* Is this a request for a valid symbol? */
6321 if (symbol_num
< 0 || symbol_num
>= table_size
)
6324 if (CONSP (*symbol_table
))
6325 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6327 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6328 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6329 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6330 we've never used that symbol before. */
6333 if (! VECTORP (*symbol_table
)
6334 || XVECTOR (*symbol_table
)->size
!= table_size
)
6338 XSETFASTINT (size
, table_size
);
6339 *symbol_table
= Fmake_vector (size
, Qnil
);
6342 value
= XVECTOR (*symbol_table
)->contents
[symbol_num
];
6345 /* Have we already used this symbol before? */
6348 /* No; let's create it. */
6349 if (CONSP (name_alist_or_stem
))
6350 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6351 else if (STRINGP (name_alist_or_stem
))
6353 int len
= SBYTES (name_alist_or_stem
);
6354 char *buf
= (char *) alloca (len
+ 50);
6355 sprintf (buf
, "%s-%ld", SDATA (name_alist_or_stem
),
6356 (long) XINT (symbol_int
) + 1);
6357 value
= intern (buf
);
6359 else if (name_table
!= 0 && name_table
[symbol_num
])
6360 value
= intern (name_table
[symbol_num
]);
6362 #ifdef HAVE_WINDOW_SYSTEM
6365 char *name
= x_get_keysym_name (symbol_num
);
6367 value
= intern (name
);
6374 sprintf (buf
, "key-%d", symbol_num
);
6375 value
= intern (buf
);
6378 if (CONSP (*symbol_table
))
6379 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6381 XVECTOR (*symbol_table
)->contents
[symbol_num
] = value
;
6383 /* Fill in the cache entries for this symbol; this also
6384 builds the Qevent_symbol_elements property, which the user
6386 apply_modifiers (modifiers
& click_modifier
, value
);
6387 Fput (value
, Qevent_kind
, symbol_kind
);
6390 /* Apply modifiers to that symbol. */
6391 return apply_modifiers (modifiers
, value
);
6394 /* Convert a list that represents an event type,
6395 such as (ctrl meta backspace), into the usual representation of that
6396 event type as a number or a symbol. */
6398 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6399 doc
: /* Convert the event description list EVENT-DESC to an event type.
6400 EVENT-DESC should contain one base event type (a character or symbol)
6401 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6402 drag, down, double or triple). The base must be last.
6403 The return value is an event type (a character or symbol) which
6404 has the same base event type and all the specified modifiers. */)
6406 Lisp_Object event_desc
;
6414 while (CONSP (rest
))
6422 /* Given a symbol, see if it is a modifier name. */
6423 if (SYMBOLP (elt
) && CONSP (rest
))
6424 this = parse_solitary_modifier (elt
);
6428 else if (!NILP (base
))
6429 error ("Two bases given in one event");
6435 /* Let the symbol A refer to the character A. */
6436 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6437 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6439 if (INTEGERP (base
))
6441 /* Turn (shift a) into A. */
6442 if ((modifiers
& shift_modifier
) != 0
6443 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6445 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6446 modifiers
&= ~shift_modifier
;
6449 /* Turn (control a) into C-a. */
6450 if (modifiers
& ctrl_modifier
)
6451 return make_number ((modifiers
& ~ctrl_modifier
)
6452 | make_ctrl_char (XINT (base
)));
6454 return make_number (modifiers
| XINT (base
));
6456 else if (SYMBOLP (base
))
6457 return apply_modifiers (modifiers
, base
);
6460 error ("Invalid base event");
6465 /* Try to recognize SYMBOL as a modifier name.
6466 Return the modifier flag bit, or 0 if not recognized. */
6469 parse_solitary_modifier (symbol
)
6472 Lisp_Object name
= SYMBOL_NAME (symbol
);
6474 switch (SREF (name
, 0))
6476 #define SINGLE_LETTER_MOD(BIT) \
6477 if (SBYTES (name) == 1) \
6480 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6481 if (LEN == SBYTES (name) \
6482 && ! strncmp (SDATA (name), NAME, LEN)) \
6486 SINGLE_LETTER_MOD (alt_modifier
);
6490 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6494 SINGLE_LETTER_MOD (ctrl_modifier
);
6498 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6499 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6503 SINGLE_LETTER_MOD (hyper_modifier
);
6507 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6511 SINGLE_LETTER_MOD (meta_modifier
);
6515 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6519 SINGLE_LETTER_MOD (shift_modifier
);
6523 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6524 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6525 SINGLE_LETTER_MOD (super_modifier
);
6529 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6530 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6531 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6535 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6538 #undef SINGLE_LETTER_MOD
6539 #undef MULTI_LETTER_MOD
6545 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6546 Such a list is not valid as an event,
6547 but it can be a Lucid-style event type list. */
6550 lucid_event_type_list_p (object
)
6555 if (! CONSP (object
))
6558 if (EQ (XCAR (object
), Qhelp_echo
)
6559 || EQ (XCAR (object
), Qvertical_line
)
6560 || EQ (XCAR (object
), Qmode_line
)
6561 || EQ (XCAR (object
), Qheader_line
))
6564 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6568 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6575 /* Store into *addr a value nonzero if terminal input chars are available.
6576 Serves the purpose of ioctl (0, FIONREAD, addr)
6577 but works even if FIONREAD does not exist.
6578 (In fact, this may actually read some input.)
6580 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6581 timer events that are ripe.
6582 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6583 events (FOCUS_IN_EVENT).
6584 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6585 movements and toolkit scroll bar thumb drags. */
6588 get_input_pending (addr
, flags
)
6592 /* First of all, have we already counted some input? */
6593 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6595 /* If input is being read as it arrives, and we have none, there is none. */
6596 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6599 /* Try to read some input and see how much we get. */
6601 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6604 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6607 gobble_input (expected
)
6612 if (interrupt_input
)
6615 mask
= sigblock (sigmask (SIGIO
));
6616 read_avail_input (expected
);
6620 #ifdef POLL_FOR_INPUT
6621 /* XXX This condition was (read_socket_hook && !interrupt_input),
6622 but read_socket_hook is not global anymore. Let's pretend that
6624 if (!interrupt_input
&& poll_suppress_count
== 0)
6627 mask
= sigblock (sigmask (SIGALRM
));
6628 read_avail_input (expected
);
6634 read_avail_input (expected
);
6638 /* Put a BUFFER_SWITCH_EVENT in the buffer
6639 so that read_key_sequence will notice the new current buffer. */
6642 record_asynch_buffer_change ()
6644 struct input_event event
;
6648 event
.kind
= BUFFER_SWITCH_EVENT
;
6649 event
.frame_or_window
= Qnil
;
6653 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6654 The purpose of the event is to make read_key_sequence look up the
6655 keymaps again. If we aren't in read_key_sequence, we don't need one,
6656 and the event could cause trouble by messing up (input-pending-p). */
6657 tem
= Fwaiting_for_user_input_p ();
6661 /* We never need these events if we have no asynchronous subprocesses. */
6665 /* Make sure no interrupt happens while storing the event. */
6667 if (interrupt_input
)
6670 mask
= sigblock (sigmask (SIGIO
));
6671 kbd_buffer_store_event (&event
);
6678 kbd_buffer_store_event (&event
);
6685 /* Read any terminal input already buffered up by the system
6686 into the kbd_buffer, but do not wait.
6688 EXPECTED should be nonzero if the caller knows there is some input.
6690 Except on VMS, all input is read by this function.
6691 If interrupt_input is nonzero, this function MUST be called
6692 only when SIGIO is blocked.
6694 Returns the number of keyboard chars read, or -1 meaning
6695 this is a bad time to try to read input. */
6698 read_avail_input (expected
)
6705 /* Loop through the available devices, and call their input hooks. */
6709 struct device
*next
= d
->next_device
;
6711 if (d
->read_socket_hook
)
6714 struct input_event hold_quit
;
6716 EVENT_INIT (hold_quit
);
6717 hold_quit
.kind
= NO_EVENT
;
6719 /* No need for FIONREAD or fcntl; just say don't wait. */
6720 while (nr
= (*d
->read_socket_hook
) (d
, expected
, &hold_quit
), nr
> 0)
6726 if (nr
== -1) /* Not OK to read input now. */
6730 else if (nr
== -2) /* Non-transient error. */
6732 /* The display device terminated; it should be closed. */
6734 /* Kill Emacs if this was our last display. */
6735 if (! device_list
->next_device
)
6736 /* Formerly simply reported no input, but that
6737 sometimes led to a failure of Emacs to terminate.
6738 SIGHUP seems appropriate if we can't reach the
6740 /* ??? Is it really right to send the signal just to
6741 this process rather than to the whole process
6742 group? Perhaps on systems with FIONREAD Emacs is
6743 alone in its group. */
6744 kill (getpid (), SIGHUP
);
6746 /* XXX Is calling delete_device safe here? It calls Fdelete_frame. */
6747 if (d
->delete_device_hook
)
6748 (*d
->delete_device_hook
) (d
);
6753 if (hold_quit
.kind
!= NO_EVENT
)
6754 kbd_buffer_store_event (&hold_quit
);
6766 /* This is the tty way of reading available input.
6768 Note that each terminal device has its own `struct device' object,
6769 and so this function is called once for each individual termcap
6770 display. The first parameter indicates which device to read from. */
6773 tty_read_avail_input (struct device
*device
,
6775 struct input_event
*hold_quit
)
6777 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6778 the kbd_buffer can really hold. That may prevent loss
6779 of characters on some systems when input is stuffed at us. */
6780 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6782 struct tty_display_info
*tty
= device
->display_info
.tty
;
6785 if (device
->type
!= output_termcap
)
6788 /* XXX I think the following code should be moved to separate hook
6789 functions in system-dependent files. */
6792 #else /* not WINDOWSNT */
6794 n_to_read
= dos_keysns ();
6798 cbuf
[0] = dos_keyread ();
6801 #else /* not MSDOS */
6803 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6807 return 0; /* The terminal is suspended. */
6809 /* Determine how many characters we should *try* to read. */
6811 /* Find out how much input is available. */
6812 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6814 if (! noninteractive
)
6815 return -2; /* Close this device. */
6821 if (n_to_read
> sizeof cbuf
)
6822 n_to_read
= sizeof cbuf
;
6823 #else /* no FIONREAD */
6824 #if defined (USG) || defined (DGUX) || defined(CYGWIN)
6825 /* Read some input if available, but don't wait. */
6826 n_to_read
= sizeof cbuf
;
6827 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6833 /* Now read; for one reason or another, this will not block.
6834 NREAD is set to the number of chars read. */
6837 nread
= emacs_read (fileno (tty
->input
), cbuf
, n_to_read
);
6838 /* POSIX infers that processes which are not in the session leader's
6839 process group won't get SIGHUP's at logout time. BSDI adheres to
6840 this part standard and returns -1 from read (0) with errno==EIO
6841 when the control tty is taken away.
6842 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6843 if (nread
== -1 && errno
== EIO
)
6844 return -2; /* Close this device. */
6845 #if defined (AIX) && (! defined (aix386) && defined (_BSD))
6846 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6847 This looks incorrect, but it isn't, because _BSD causes
6848 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6849 and that causes a value other than 0 when there is no input. */
6851 return -2; /* Close this device. */
6855 /* We used to retry the read if it was interrupted.
6856 But this does the wrong thing when O_NDELAY causes
6857 an EAGAIN error. Does anybody know of a situation
6858 where a retry is actually needed? */
6860 nread
< 0 && (errno
== EAGAIN
6874 #if defined (USG) || defined (DGUX) || defined (CYGWIN)
6875 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6876 #endif /* USG or DGUX or CYGWIN */
6877 #endif /* no FIONREAD */
6882 #endif /* not MSDOS */
6883 #endif /* not WINDOWSNT */
6885 for (i
= 0; i
< nread
; i
++)
6887 struct input_event buf
;
6889 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6891 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6892 buf
.modifiers
= meta_modifier
;
6893 if (tty
->meta_key
!= 2)
6897 /* Set the frame corresponding to the active tty. Note that the
6898 value of selected_frame is not reliable here, redisplay tends
6899 to temporarily change it. */
6900 buf
.frame_or_window
= tty
->top_frame
;
6903 kbd_buffer_store_event (&buf
);
6904 /* Don't look at input that follows a C-g too closely.
6905 This reduces lossage due to autorepeat on C-g. */
6906 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6907 && buf
.code
== quit_char
)
6913 #endif /* not VMS */
6916 handle_async_input ()
6919 extern int select_alarmed
;
6922 interrupt_input_pending
= 0;
6927 nread
= read_avail_input (1);
6928 /* -1 means it's not ok to read the input now.
6929 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
6930 0 means there was no keyboard input available. */
6935 select_alarmed
= 1; /* Force the select emulator back to life */
6940 #ifdef SIGIO /* for entire page */
6941 /* Note SIGIO has been undef'd if FIONREAD is missing. */
6944 input_available_signal (signo
)
6947 /* Must preserve main program's value of errno. */
6948 int old_errno
= errno
;
6949 #if defined (USG) && !defined (POSIX_SIGNALS)
6950 /* USG systems forget handlers when they are used;
6951 must reestablish each time */
6952 signal (signo
, input_available_signal
);
6960 interrupt_input_pending
= 1;
6962 SIGNAL_THREAD_CHECK (signo
);
6965 if (input_available_clear_time
)
6966 EMACS_SET_SECS_USECS (*input_available_clear_time
, 0, 0);
6969 handle_async_input ();
6979 /* Send ourselves a SIGIO.
6981 This function exists so that the UNBLOCK_INPUT macro in
6982 blockinput.h can have some way to take care of input we put off
6983 dealing with, without assuming that every file which uses
6984 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
6986 reinvoke_input_signal ()
6989 handle_async_input ();
6995 static void menu_bar_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
, void*));
6996 static Lisp_Object menu_bar_one_keymap_changed_items
;
6998 /* These variables hold the vector under construction within
6999 menu_bar_items and its subroutines, and the current index
7000 for storing into that vector. */
7001 static Lisp_Object menu_bar_items_vector
;
7002 static int menu_bar_items_index
;
7004 /* Return a vector of menu items for a menu bar, appropriate
7005 to the current buffer. Each item has three elements in the vector:
7008 OLD is an old vector we can optionally reuse, or nil. */
7011 menu_bar_items (old
)
7014 /* The number of keymaps we're scanning right now, and the number of
7015 keymaps we have allocated space for. */
7018 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7019 in the current keymaps, or nil where it is not a prefix. */
7022 Lisp_Object def
, tail
;
7031 /* In order to build the menus, we need to call the keymap
7032 accessors. They all call QUIT. But this function is called
7033 during redisplay, during which a quit is fatal. So inhibit
7034 quitting while building the menus.
7035 We do this instead of specbind because (1) errors will clear it anyway
7036 and (2) this avoids risk of specpdl overflow. */
7037 oquit
= Vinhibit_quit
;
7041 menu_bar_items_vector
= old
;
7043 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7044 menu_bar_items_index
= 0;
7046 /* Build our list of keymaps.
7047 If we recognize a function key and replace its escape sequence in
7048 keybuf with its symbol, or if the sequence starts with a mouse
7049 click and we need to switch buffers, we jump back here to rebuild
7050 the initial keymaps from the current buffer. */
7054 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7055 if (!NILP (Voverriding_local_map_menu_flag
))
7057 /* Yes, use them (if non-nil) as well as the global map. */
7058 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7060 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7061 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7062 if (!NILP (Voverriding_local_map
))
7063 maps
[nmaps
++] = Voverriding_local_map
;
7067 /* No, so use major and minor mode keymaps and keymap property.
7068 Note that menu-bar bindings in the local-map and keymap
7069 properties may not work reliable, as they are only
7070 recognized when the menu-bar (or mode-line) is updated,
7071 which does not normally happen after every command. */
7074 nminor
= current_minor_maps (NULL
, &tmaps
);
7075 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7077 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7078 maps
[nmaps
++] = tem
;
7079 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7081 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7083 maps
[nmaps
++] = current_global_map
;
7086 /* Look up in each map the dummy prefix key `menu-bar'. */
7090 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7091 if (!NILP (maps
[mapno
]))
7093 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7097 menu_bar_one_keymap_changed_items
= Qnil
;
7098 map_keymap (def
, menu_bar_item
, Qnil
, NULL
, 1);
7102 /* Move to the end those items that should be at the end. */
7104 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7107 int end
= menu_bar_items_index
;
7109 for (i
= 0; i
< end
; i
+= 4)
7110 if (EQ (XCAR (tail
), XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7112 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7113 /* Move the item at index I to the end,
7114 shifting all the others forward. */
7115 tem0
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 0];
7116 tem1
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 1];
7117 tem2
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7118 tem3
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 3];
7120 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7121 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7122 (end
- i
- 4) * sizeof (Lisp_Object
));
7123 XVECTOR (menu_bar_items_vector
)->contents
[end
- 4] = tem0
;
7124 XVECTOR (menu_bar_items_vector
)->contents
[end
- 3] = tem1
;
7125 XVECTOR (menu_bar_items_vector
)->contents
[end
- 2] = tem2
;
7126 XVECTOR (menu_bar_items_vector
)->contents
[end
- 1] = tem3
;
7131 /* Add nil, nil, nil, nil at the end. */
7132 i
= menu_bar_items_index
;
7133 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7136 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7137 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7138 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7139 menu_bar_items_vector
= tem
;
7141 /* Add this item. */
7142 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7143 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7144 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7145 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Qnil
;
7146 menu_bar_items_index
= i
;
7148 Vinhibit_quit
= oquit
;
7149 return menu_bar_items_vector
;
7152 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7153 If there's already an item for KEY, add this DEF to it. */
7155 Lisp_Object item_properties
;
7158 menu_bar_item (key
, item
, dummy1
, dummy2
)
7159 Lisp_Object key
, item
, dummy1
;
7162 struct gcpro gcpro1
;
7166 if (EQ (item
, Qundefined
))
7168 /* If a map has an explicit `undefined' as definition,
7169 discard any previously made menu bar item. */
7171 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7172 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7174 if (menu_bar_items_index
> i
+ 4)
7175 bcopy (&XVECTOR (menu_bar_items_vector
)->contents
[i
+ 4],
7176 &XVECTOR (menu_bar_items_vector
)->contents
[i
],
7177 (menu_bar_items_index
- i
- 4) * sizeof (Lisp_Object
));
7178 menu_bar_items_index
-= 4;
7182 /* If this keymap has already contributed to this KEY,
7183 don't contribute to it a second time. */
7184 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7185 if (!NILP (tem
) || NILP (item
))
7188 menu_bar_one_keymap_changed_items
7189 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7191 /* We add to menu_bar_one_keymap_changed_items before doing the
7192 parse_menu_item, so that if it turns out it wasn't a menu item,
7193 it still correctly hides any further menu item. */
7195 i
= parse_menu_item (item
, 0, 1);
7200 item
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
];
7202 /* Find any existing item for this KEY. */
7203 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7204 if (EQ (key
, XVECTOR (menu_bar_items_vector
)->contents
[i
]))
7207 /* If we did not find this KEY, add it at the end. */
7208 if (i
== menu_bar_items_index
)
7210 /* If vector is too small, get a bigger one. */
7211 if (i
+ 4 > XVECTOR (menu_bar_items_vector
)->size
)
7214 tem
= Fmake_vector (make_number (2 * i
), Qnil
);
7215 bcopy (XVECTOR (menu_bar_items_vector
)->contents
,
7216 XVECTOR (tem
)->contents
, i
* sizeof (Lisp_Object
));
7217 menu_bar_items_vector
= tem
;
7220 /* Add this item. */
7221 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = key
;
7222 XVECTOR (menu_bar_items_vector
)->contents
[i
++]
7223 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
7224 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = Fcons (item
, Qnil
);
7225 XVECTOR (menu_bar_items_vector
)->contents
[i
++] = make_number (0);
7226 menu_bar_items_index
= i
;
7228 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7232 old
= XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2];
7233 /* If the new and the old items are not both keymaps,
7234 the lookup will only find `item'. */
7235 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7236 XVECTOR (menu_bar_items_vector
)->contents
[i
+ 2] = item
;
7240 /* This is used as the handler when calling menu_item_eval_property. */
7242 menu_item_eval_property_1 (arg
)
7245 /* If we got a quit from within the menu computation,
7246 quit all the way out of it. This takes care of C-] in the debugger. */
7247 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7248 Fsignal (Qquit
, Qnil
);
7253 /* Evaluate an expression and return the result (or nil if something
7254 went wrong). Used to evaluate dynamic parts of menu items. */
7256 menu_item_eval_property (sexpr
)
7259 int count
= SPECPDL_INDEX ();
7261 specbind (Qinhibit_redisplay
, Qt
);
7262 val
= internal_condition_case_1 (Feval
, sexpr
, Qerror
,
7263 menu_item_eval_property_1
);
7264 return unbind_to (count
, val
);
7267 /* This function parses a menu item and leaves the result in the
7268 vector item_properties.
7269 ITEM is a key binding, a possible menu item.
7270 If NOTREAL is nonzero, only check for equivalent key bindings, don't
7271 evaluate dynamic expressions in the menu item.
7272 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7274 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7275 parse_menu_item returns true if the item is a menu item and false
7279 parse_menu_item (item
, notreal
, inmenubar
)
7281 int notreal
, inmenubar
;
7283 Lisp_Object def
, tem
, item_string
, start
;
7284 Lisp_Object cachelist
;
7286 Lisp_Object keyhint
;
7297 /* Create item_properties vector if necessary. */
7298 if (NILP (item_properties
))
7300 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7302 /* Initialize optional entries. */
7303 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7304 AREF (item_properties
, i
) = Qnil
;
7305 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = Qt
;
7307 /* Save the item here to protect it from GC. */
7308 AREF (item_properties
, ITEM_PROPERTY_ITEM
) = item
;
7310 item_string
= XCAR (item
);
7314 if (STRINGP (item_string
))
7316 /* Old format menu item. */
7317 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7319 /* Maybe help string. */
7320 if (CONSP (item
) && STRINGP (XCAR (item
)))
7322 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7327 /* Maybe key binding cache. */
7328 if (CONSP (item
) && CONSP (XCAR (item
))
7329 && (NILP (XCAR (XCAR (item
)))
7330 || VECTORP (XCAR (XCAR (item
)))))
7332 cachelist
= XCAR (item
);
7336 /* This is the real definition--the function to run. */
7337 AREF (item_properties
, ITEM_PROPERTY_DEF
) = item
;
7339 /* Get enable property, if any. */
7342 tem
= Fget (item
, Qmenu_enable
);
7344 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7347 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7349 /* New format menu item. */
7350 AREF (item_properties
, ITEM_PROPERTY_NAME
) = XCAR (item
);
7351 start
= XCDR (item
);
7354 /* We have a real binding. */
7355 AREF (item_properties
, ITEM_PROPERTY_DEF
) = XCAR (start
);
7357 item
= XCDR (start
);
7358 /* Is there a cache list with key equivalences. */
7359 if (CONSP (item
) && CONSP (XCAR (item
)))
7361 cachelist
= XCAR (item
);
7365 /* Parse properties. */
7366 while (CONSP (item
) && CONSP (XCDR (item
)))
7371 if (EQ (tem
, QCenable
))
7372 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = XCAR (item
);
7373 else if (EQ (tem
, QCvisible
) && !notreal
)
7375 /* If got a visible property and that evaluates to nil
7376 then ignore this item. */
7377 tem
= menu_item_eval_property (XCAR (item
));
7381 else if (EQ (tem
, QChelp
))
7382 AREF (item_properties
, ITEM_PROPERTY_HELP
) = XCAR (item
);
7383 else if (EQ (tem
, QCfilter
))
7385 else if (EQ (tem
, QCkey_sequence
))
7388 if (NILP (cachelist
)
7389 && (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
)))
7390 /* Be GC protected. Set keyhint to item instead of tem. */
7393 else if (EQ (tem
, QCkeys
))
7396 if (CONSP (tem
) || (STRINGP (tem
) && NILP (cachelist
)))
7397 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7399 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7404 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7406 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7408 AREF (item_properties
, ITEM_PROPERTY_TYPE
)
7415 else if (inmenubar
|| !NILP (start
))
7419 return 0; /* not a menu item */
7421 /* If item string is not a string, evaluate it to get string.
7422 If we don't get a string, skip this item. */
7423 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7424 if (!(STRINGP (item_string
) || notreal
))
7426 item_string
= menu_item_eval_property (item_string
);
7427 if (!STRINGP (item_string
))
7429 AREF (item_properties
, ITEM_PROPERTY_NAME
) = item_string
;
7432 /* If got a filter apply it on definition. */
7433 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7436 def
= menu_item_eval_property (list2 (XCAR (filter
),
7437 list2 (Qquote
, def
)));
7439 AREF (item_properties
, ITEM_PROPERTY_DEF
) = def
;
7442 /* Enable or disable selection of item. */
7443 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7449 tem
= menu_item_eval_property (tem
);
7450 if (inmenubar
&& NILP (tem
))
7451 return 0; /* Ignore disabled items in menu bar. */
7452 AREF (item_properties
, ITEM_PROPERTY_ENABLE
) = tem
;
7455 /* If we got no definition, this item is just unselectable text which
7456 is OK in a submenu but not in the menubar. */
7458 return (inmenubar
? 0 : 1);
7460 /* See if this is a separate pane or a submenu. */
7461 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7462 tem
= get_keymap (def
, 0, 1);
7463 /* For a subkeymap, just record its details and exit. */
7466 AREF (item_properties
, ITEM_PROPERTY_MAP
) = tem
;
7467 AREF (item_properties
, ITEM_PROPERTY_DEF
) = tem
;
7471 /* At the top level in the menu bar, do likewise for commands also.
7472 The menu bar does not display equivalent key bindings anyway.
7473 ITEM_PROPERTY_DEF is already set up properly. */
7477 /* This is a command. See if there is an equivalent key binding. */
7478 if (NILP (cachelist
))
7480 /* We have to create a cachelist. */
7481 CHECK_IMPURE (start
);
7482 XSETCDR (start
, Fcons (Fcons (Qnil
, Qnil
), XCDR (start
)));
7483 cachelist
= XCAR (XCDR (start
));
7485 tem
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7486 if (!NILP (keyhint
))
7488 XSETCAR (cachelist
, XCAR (keyhint
));
7491 else if (STRINGP (tem
))
7493 XSETCDR (cachelist
, Fsubstitute_command_keys (tem
));
7494 XSETCAR (cachelist
, Qt
);
7498 tem
= XCAR (cachelist
);
7505 tem
= Fkey_binding (tem
, Qnil
, Qnil
);
7507 prefix
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7510 def
= XCAR (prefix
);
7511 prefix
= XCDR (prefix
);
7514 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7516 if (!update_menu_bindings
)
7518 else if (NILP (XCAR (cachelist
))) /* Have no saved key. */
7520 if (newcache
/* Always check first time. */
7521 /* Should we check everything when precomputing key
7523 /* If something had no key binding before, don't recheck it
7524 because that is too slow--except if we have a list of
7525 rebound commands in Vdefine_key_rebound_commands, do
7526 recheck any command that appears in that list. */
7527 || (CONSP (Vdefine_key_rebound_commands
)
7528 && !NILP (Fmemq (def
, Vdefine_key_rebound_commands
))))
7531 /* We had a saved key. Is it still bound to the command? */
7534 /* If the command is an alias for another
7535 (such as lmenu.el set it up), check if the
7536 original command matches the cached command. */
7537 && !(SYMBOLP (def
) && EQ (tem
, XSYMBOL (def
)->function
))))
7538 chkcache
= 1; /* Need to recompute key binding. */
7542 /* Recompute equivalent key binding. If the command is an alias
7543 for another (such as lmenu.el set it up), see if the original
7544 command name has equivalent keys. Otherwise look up the
7545 specified command itself. We don't try both, because that
7546 makes lmenu menus slow. */
7548 && SYMBOLP (XSYMBOL (def
)->function
)
7549 && ! NILP (Fget (def
, Qmenu_alias
)))
7550 def
= XSYMBOL (def
)->function
;
7551 tem
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qt
);
7552 XSETCAR (cachelist
, tem
);
7555 XSETCDR (cachelist
, Qnil
);
7559 else if (!NILP (keyhint
) && !NILP (XCAR (cachelist
)))
7561 tem
= XCAR (cachelist
);
7565 newcache
= chkcache
;
7568 tem
= Fkey_description (tem
, Qnil
);
7571 if (STRINGP (XCAR (prefix
)))
7572 tem
= concat2 (XCAR (prefix
), tem
);
7573 if (STRINGP (XCDR (prefix
)))
7574 tem
= concat2 (tem
, XCDR (prefix
));
7576 XSETCDR (cachelist
, tem
);
7580 tem
= XCDR (cachelist
);
7581 if (newcache
&& !NILP (tem
))
7583 tem
= concat3 (build_string (" ("), tem
, build_string (")"));
7584 XSETCDR (cachelist
, tem
);
7587 /* If we only want to precompute equivalent key bindings, stop here. */
7591 /* If we have an equivalent key binding, use that. */
7592 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
) = tem
;
7594 /* Include this when menu help is implemented.
7595 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7596 if (!(NILP (tem) || STRINGP (tem)))
7598 tem = menu_item_eval_property (tem);
7601 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7605 /* Handle radio buttons or toggle boxes. */
7606 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7608 AREF (item_properties
, ITEM_PROPERTY_SELECTED
)
7609 = menu_item_eval_property (tem
);
7616 /***********************************************************************
7618 ***********************************************************************/
7620 /* A vector holding tool bar items while they are parsed in function
7621 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7624 static Lisp_Object tool_bar_items_vector
;
7626 /* A vector holding the result of parse_tool_bar_item. Layout is like
7627 the one for a single item in tool_bar_items_vector. */
7629 static Lisp_Object tool_bar_item_properties
;
7631 /* Next free index in tool_bar_items_vector. */
7633 static int ntool_bar_items
;
7635 /* The symbols `tool-bar', and `:image'. */
7637 extern Lisp_Object Qtool_bar
;
7638 Lisp_Object QCimage
;
7640 /* Function prototypes. */
7642 static void init_tool_bar_items
P_ ((Lisp_Object
));
7643 static void process_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7644 static int parse_tool_bar_item
P_ ((Lisp_Object
, Lisp_Object
));
7645 static void append_tool_bar_item
P_ ((void));
7648 /* Return a vector of tool bar items for keymaps currently in effect.
7649 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7650 tool bar items found. */
7653 tool_bar_items (reuse
, nitems
)
7664 /* In order to build the menus, we need to call the keymap
7665 accessors. They all call QUIT. But this function is called
7666 during redisplay, during which a quit is fatal. So inhibit
7667 quitting while building the menus. We do this instead of
7668 specbind because (1) errors will clear it anyway and (2) this
7669 avoids risk of specpdl overflow. */
7670 oquit
= Vinhibit_quit
;
7673 /* Initialize tool_bar_items_vector and protect it from GC. */
7674 init_tool_bar_items (reuse
);
7676 /* Build list of keymaps in maps. Set nmaps to the number of maps
7679 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7680 if (!NILP (Voverriding_local_map_menu_flag
))
7682 /* Yes, use them (if non-nil) as well as the global map. */
7683 maps
= (Lisp_Object
*) alloca (3 * sizeof (maps
[0]));
7685 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
7686 maps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
7687 if (!NILP (Voverriding_local_map
))
7688 maps
[nmaps
++] = Voverriding_local_map
;
7692 /* No, so use major and minor mode keymaps and keymap property.
7693 Note that tool-bar bindings in the local-map and keymap
7694 properties may not work reliable, as they are only
7695 recognized when the tool-bar (or mode-line) is updated,
7696 which does not normally happen after every command. */
7699 nminor
= current_minor_maps (NULL
, &tmaps
);
7700 maps
= (Lisp_Object
*) alloca ((nminor
+ 3) * sizeof (maps
[0]));
7702 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7703 maps
[nmaps
++] = tem
;
7704 bcopy (tmaps
, (void *) (maps
+ nmaps
), nminor
* sizeof (maps
[0]));
7706 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7709 /* Add global keymap at the end. */
7710 maps
[nmaps
++] = current_global_map
;
7712 /* Process maps in reverse order and look up in each map the prefix
7714 for (i
= nmaps
- 1; i
>= 0; --i
)
7715 if (!NILP (maps
[i
]))
7719 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7724 /* KEYMAP is a list `(keymap (KEY . BINDING) ...)'. */
7725 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
7727 Lisp_Object keydef
= XCAR (tail
);
7729 process_tool_bar_item (XCAR (keydef
), XCDR (keydef
));
7734 Vinhibit_quit
= oquit
;
7735 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7736 return tool_bar_items_vector
;
7740 /* Process the definition of KEY which is DEF. */
7743 process_tool_bar_item (key
, def
)
7744 Lisp_Object key
, def
;
7747 extern Lisp_Object Qundefined
;
7748 struct gcpro gcpro1
, gcpro2
;
7750 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7754 if (EQ (def
, Qundefined
))
7756 /* If a map has an explicit `undefined' as definition,
7757 discard any previously made item. */
7758 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7760 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7762 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7764 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7765 bcopy (v
+ TOOL_BAR_ITEM_NSLOTS
, v
,
7766 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7767 * sizeof (Lisp_Object
)));
7768 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7773 else if (parse_tool_bar_item (key
, def
))
7774 /* Append a new tool bar item to tool_bar_items_vector. Accept
7775 more than one definition for the same key. */
7776 append_tool_bar_item ();
7782 /* Parse a tool bar item specification ITEM for key KEY and return the
7783 result in tool_bar_item_properties. Value is zero if ITEM is
7786 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7788 CAPTION is the caption of the item, If it's not a string, it is
7789 evaluated to get a string.
7791 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7792 as binding are currently ignored.
7794 The following properties are recognized:
7798 FORM is evaluated and specifies whether the tool bar item is
7799 enabled or disabled.
7803 FORM is evaluated and specifies whether the tool bar item is visible.
7805 - `:filter FUNCTION'
7807 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7808 result is stored as the new binding.
7810 - `:button (TYPE SELECTED)'
7812 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7813 and specifies whether the button is selected (pressed) or not.
7817 IMAGES is either a single image specification or a vector of four
7818 image specifications. See enum tool_bar_item_images.
7820 - `:help HELP-STRING'.
7822 Gives a help string to display for the tool bar item. */
7825 parse_tool_bar_item (key
, item
)
7826 Lisp_Object key
, item
;
7828 /* Access slot with index IDX of vector tool_bar_item_properties. */
7829 #define PROP(IDX) XVECTOR (tool_bar_item_properties)->contents[IDX]
7831 Lisp_Object filter
= Qnil
;
7832 Lisp_Object caption
;
7835 /* Defininition looks like `(menu-item CAPTION BINDING PROPS...)'.
7836 Rule out items that aren't lists, don't start with
7837 `menu-item' or whose rest following `tool-bar-item' is not a
7840 || !EQ (XCAR (item
), Qmenu_item
)
7841 || (item
= XCDR (item
),
7845 /* Create tool_bar_item_properties vector if necessary. Reset it to
7847 if (VECTORP (tool_bar_item_properties
))
7849 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
7853 tool_bar_item_properties
7854 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
7857 PROP (TOOL_BAR_ITEM_KEY
) = key
;
7858 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qt
;
7860 /* Get the caption of the item. If the caption is not a string,
7861 evaluate it to get a string. If we don't get a string, skip this
7863 caption
= XCAR (item
);
7864 if (!STRINGP (caption
))
7866 caption
= menu_item_eval_property (caption
);
7867 if (!STRINGP (caption
))
7870 PROP (TOOL_BAR_ITEM_CAPTION
) = caption
;
7872 /* Give up if rest following the caption is not a list. */
7877 /* Store the binding. */
7878 PROP (TOOL_BAR_ITEM_BINDING
) = XCAR (item
);
7881 /* Ignore cached key binding, if any. */
7882 if (CONSP (item
) && CONSP (XCAR (item
)))
7885 /* Process the rest of the properties. */
7886 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
7888 Lisp_Object key
, value
;
7891 value
= XCAR (XCDR (item
));
7893 if (EQ (key
, QCenable
))
7894 /* `:enable FORM'. */
7895 PROP (TOOL_BAR_ITEM_ENABLED_P
) = value
;
7896 else if (EQ (key
, QCvisible
))
7898 /* `:visible FORM'. If got a visible property and that
7899 evaluates to nil then ignore this item. */
7900 if (NILP (menu_item_eval_property (value
)))
7903 else if (EQ (key
, QChelp
))
7904 /* `:help HELP-STRING'. */
7905 PROP (TOOL_BAR_ITEM_HELP
) = value
;
7906 else if (EQ (key
, QCfilter
))
7907 /* ':filter FORM'. */
7909 else if (EQ (key
, QCbutton
) && CONSP (value
))
7911 /* `:button (TYPE . SELECTED)'. */
7912 Lisp_Object type
, selected
;
7914 type
= XCAR (value
);
7915 selected
= XCDR (value
);
7916 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7918 PROP (TOOL_BAR_ITEM_SELECTED_P
) = selected
;
7919 PROP (TOOL_BAR_ITEM_TYPE
) = type
;
7922 else if (EQ (key
, QCimage
)
7924 || (VECTORP (value
) && XVECTOR (value
)->size
== 4)))
7925 /* Value is either a single image specification or a vector
7926 of 4 such specifications for the different button states. */
7927 PROP (TOOL_BAR_ITEM_IMAGES
) = value
;
7930 /* If got a filter apply it on binding. */
7932 PROP (TOOL_BAR_ITEM_BINDING
)
7933 = menu_item_eval_property (list2 (filter
,
7935 PROP (TOOL_BAR_ITEM_BINDING
))));
7937 /* See if the binding is a keymap. Give up if it is. */
7938 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
7941 /* Enable or disable selection of item. */
7942 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
7943 PROP (TOOL_BAR_ITEM_ENABLED_P
)
7944 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
));
7946 /* Handle radio buttons or toggle boxes. */
7947 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
7948 PROP (TOOL_BAR_ITEM_SELECTED_P
)
7949 = menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
));
7957 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
7958 that can be reused. */
7961 init_tool_bar_items (reuse
)
7964 if (VECTORP (reuse
))
7965 tool_bar_items_vector
= reuse
;
7967 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
7968 ntool_bar_items
= 0;
7972 /* Append parsed tool bar item properties from
7973 tool_bar_item_properties */
7976 append_tool_bar_item ()
7978 Lisp_Object
*to
, *from
;
7980 /* Enlarge tool_bar_items_vector if necessary. */
7981 if (ntool_bar_items
+ TOOL_BAR_ITEM_NSLOTS
7982 >= XVECTOR (tool_bar_items_vector
)->size
)
7984 Lisp_Object new_vector
;
7985 int old_size
= XVECTOR (tool_bar_items_vector
)->size
;
7987 new_vector
= Fmake_vector (make_number (2 * old_size
), Qnil
);
7988 bcopy (XVECTOR (tool_bar_items_vector
)->contents
,
7989 XVECTOR (new_vector
)->contents
,
7990 old_size
* sizeof (Lisp_Object
));
7991 tool_bar_items_vector
= new_vector
;
7994 /* Append entries from tool_bar_item_properties to the end of
7995 tool_bar_items_vector. */
7996 to
= XVECTOR (tool_bar_items_vector
)->contents
+ ntool_bar_items
;
7997 from
= XVECTOR (tool_bar_item_properties
)->contents
;
7998 bcopy (from
, to
, TOOL_BAR_ITEM_NSLOTS
* sizeof *to
);
7999 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8006 /* Read a character using menus based on maps in the array MAPS.
8007 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8008 Return t if we displayed a menu but the user rejected it.
8010 PREV_EVENT is the previous input event, or nil if we are reading
8011 the first event of a key sequence.
8013 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8014 if we used a mouse menu to read the input, or zero otherwise. If
8015 USED_MOUSE_MENU is null, we don't dereference it.
8017 The prompting is done based on the prompt-string of the map
8018 and the strings associated with various map elements.
8020 This can be done with X menus or with menus put in the minibuf.
8021 These are done in different ways, depending on how the input will be read.
8022 Menus using X are done after auto-saving in read-char, getting the input
8023 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8024 and do auto-saving in the inner call of read_char. */
8027 read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
)
8030 Lisp_Object prev_event
;
8031 int *used_mouse_menu
;
8034 register Lisp_Object name
= Qnil
;
8036 if (used_mouse_menu
)
8037 *used_mouse_menu
= 0;
8039 /* Use local over global Menu maps */
8041 if (! menu_prompting
)
8044 /* Optionally disregard all but the global map. */
8045 if (inhibit_local_menu_bar_menus
)
8047 maps
+= (nmaps
- 1);
8051 /* Get the menu name from the first map that has one (a prompt string). */
8052 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8054 name
= Fkeymap_prompt (maps
[mapno
]);
8059 /* If we don't have any menus, just read a character normally. */
8060 if (!STRINGP (name
))
8064 /* If we got to this point via a mouse click,
8065 use a real menu for mouse selection. */
8066 if (EVENT_HAS_PARAMETERS (prev_event
)
8067 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8068 && !EQ (XCAR (prev_event
), Qtool_bar
))
8070 /* Display the menu and get the selection. */
8071 Lisp_Object
*realmaps
8072 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
8076 /* Use the maps that are not nil. */
8077 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8078 if (!NILP (maps
[mapno
]))
8079 realmaps
[nmaps1
++] = maps
[mapno
];
8081 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8086 record_menu_key (XCAR (value
));
8088 /* If we got multiple events, unread all but
8090 There is no way to prevent those unread events
8091 from showing up later in last_nonmenu_event.
8092 So turn symbol and integer events into lists,
8093 to indicate that they came from a mouse menu,
8094 so that when present in last_nonmenu_event
8095 they won't confuse things. */
8096 for (tem
= XCDR (value
); !NILP (tem
); tem
= XCDR (tem
))
8098 record_menu_key (XCAR (tem
));
8099 if (SYMBOLP (XCAR (tem
))
8100 || INTEGERP (XCAR (tem
)))
8101 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8104 /* If we got more than one event, put all but the first
8105 onto this list to be read later.
8106 Return just the first event now. */
8107 Vunread_command_events
8108 = nconc2 (XCDR (value
), Vunread_command_events
);
8109 value
= XCAR (value
);
8111 else if (NILP (value
))
8113 if (used_mouse_menu
)
8114 *used_mouse_menu
= 1;
8117 #endif /* HAVE_MENUS */
8121 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8122 We make this bigger when necessary, and never free it. */
8123 static char *read_char_minibuf_menu_text
;
8124 /* Size of that buffer. */
8125 static int read_char_minibuf_menu_width
;
8128 read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
)
8134 register Lisp_Object name
;
8136 /* FIXME: Use the minibuffer's frame width. */
8137 int width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8140 Lisp_Object rest
, vector
;
8146 if (! menu_prompting
)
8149 /* Make sure we have a big enough buffer for the menu text. */
8150 if (read_char_minibuf_menu_text
== 0)
8152 read_char_minibuf_menu_width
= width
+ 4;
8153 read_char_minibuf_menu_text
= (char *) xmalloc (width
+ 4);
8155 else if (width
+ 4 > read_char_minibuf_menu_width
)
8157 read_char_minibuf_menu_width
= width
+ 4;
8158 read_char_minibuf_menu_text
8159 = (char *) xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8161 menu
= read_char_minibuf_menu_text
;
8163 /* Get the menu name from the first map that has one (a prompt string). */
8164 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8166 name
= Fkeymap_prompt (maps
[mapno
]);
8171 /* If we don't have any menus, just read a character normally. */
8172 if (!STRINGP (name
))
8175 /* Prompt string always starts with map's prompt, and a space. */
8176 strcpy (menu
, SDATA (name
));
8177 nlength
= SBYTES (name
);
8178 menu
[nlength
++] = ':';
8179 menu
[nlength
++] = ' ';
8182 /* Start prompting at start of first map. */
8186 /* Present the documented bindings, a line at a time. */
8193 Lisp_Object orig_defn_macro
;
8195 /* Loop over elements of map. */
8200 /* If reached end of map, start at beginning of next map. */
8204 /* At end of last map, wrap around to first map if just starting,
8205 or end this line if already have something on it. */
8209 if (notfirst
|| nobindings
) break;
8214 /* Look at the next element of the map. */
8216 elt
= XVECTOR (vector
)->contents
[idx
];
8218 elt
= Fcar_safe (rest
);
8220 if (idx
< 0 && VECTORP (elt
))
8222 /* If we found a dense table in the keymap,
8223 advanced past it, but start scanning its contents. */
8224 rest
= Fcdr_safe (rest
);
8230 /* An ordinary element. */
8231 Lisp_Object event
, tem
;
8235 event
= Fcar_safe (elt
); /* alist */
8236 elt
= Fcdr_safe (elt
);
8240 XSETINT (event
, idx
); /* vector */
8243 /* Ignore the element if it has no prompt string. */
8244 if (INTEGERP (event
) && parse_menu_item (elt
, 0, -1))
8246 /* 1 if the char to type matches the string. */
8248 Lisp_Object upcased_event
, downcased_event
;
8249 Lisp_Object desc
= Qnil
;
8251 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
8253 upcased_event
= Fupcase (event
);
8254 downcased_event
= Fdowncase (event
);
8255 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8256 || XINT (downcased_event
) == SREF (s
, 0));
8258 desc
= Fsingle_key_description (event
, Qnil
);
8260 #if 0 /* It is redundant to list the equivalent key bindings because
8261 the prefix is what the user has already typed. */
8263 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8265 /* Insert equivalent keybinding. */
8266 s
= concat2 (s
, tem
);
8269 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
8270 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8272 /* Insert button prefix. */
8273 Lisp_Object selected
8274 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
8275 if (EQ (tem
, QCradio
))
8276 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8278 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8279 s
= concat2 (tem
, s
);
8283 /* If we have room for the prompt string, add it to this line.
8284 If this is the first on the line, always add it. */
8285 if ((SCHARS (s
) + i
+ 2
8286 + (char_matches
? 0 : SCHARS (desc
) + 3))
8292 /* Punctuate between strings. */
8295 strcpy (menu
+ i
, ", ");
8301 /* If the char to type doesn't match the string's
8302 first char, explicitly show what char to type. */
8305 /* Add as much of string as fits. */
8306 thiswidth
= SCHARS (desc
);
8307 if (thiswidth
+ i
> width
)
8308 thiswidth
= width
- i
;
8309 bcopy (SDATA (desc
), menu
+ i
, thiswidth
);
8311 strcpy (menu
+ i
, " = ");
8315 /* Add as much of string as fits. */
8316 thiswidth
= SCHARS (s
);
8317 if (thiswidth
+ i
> width
)
8318 thiswidth
= width
- i
;
8319 bcopy (SDATA (s
), menu
+ i
, thiswidth
);
8325 /* If this element does not fit, end the line now,
8326 and save the element for the next line. */
8327 strcpy (menu
+ i
, "...");
8332 /* Move past this element. */
8333 if (idx
>= 0 && idx
+ 1 >= XVECTOR (vector
)->size
)
8334 /* Handle reaching end of dense table. */
8339 rest
= Fcdr_safe (rest
);
8343 /* Prompt with that and read response. */
8344 message2_nolog (menu
, strlen (menu
),
8345 ! NILP (current_buffer
->enable_multibyte_characters
));
8347 /* Make believe its not a keyboard macro in case the help char
8348 is pressed. Help characters are not recorded because menu prompting
8349 is not used on replay.
8351 orig_defn_macro
= current_kboard
->defining_kbd_macro
;
8352 current_kboard
->defining_kbd_macro
= Qnil
;
8354 obj
= read_char (commandflag
, 0, 0, Qt
, 0);
8355 while (BUFFERP (obj
));
8356 current_kboard
->defining_kbd_macro
= orig_defn_macro
;
8358 if (!INTEGERP (obj
))
8363 if (! EQ (obj
, menu_prompt_more_char
)
8364 && (!INTEGERP (menu_prompt_more_char
)
8365 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8367 if (!NILP (current_kboard
->defining_kbd_macro
))
8368 store_kbd_macro_char (obj
);
8371 /* Help char - go round again */
8375 /* Reading key sequences. */
8377 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8378 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8379 keymap, or nil otherwise. Return the index of the first keymap in
8380 which KEY has any binding, or NMAPS if no map has a binding.
8382 If KEY is a meta ASCII character, treat it like meta-prefix-char
8383 followed by the corresponding non-meta character. Keymaps in
8384 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8387 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8390 NEXT may be the same array as CURRENT. */
8393 follow_key (key
, nmaps
, current
, defs
, next
)
8395 Lisp_Object
*current
, *defs
, *next
;
8398 int i
, first_binding
;
8400 first_binding
= nmaps
;
8401 for (i
= nmaps
- 1; i
>= 0; i
--)
8403 if (! NILP (current
[i
]))
8405 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8406 if (! NILP (defs
[i
]))
8413 /* Given the set of bindings we've found, produce the next set of maps. */
8414 if (first_binding
< nmaps
)
8415 for (i
= 0; i
< nmaps
; i
++)
8416 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8418 return first_binding
;
8421 /* Structure used to keep track of partial application of key remapping
8422 such as Vfunction_key_map and Vkey_translation_map. */
8423 typedef struct keyremap
8425 Lisp_Object map
, parent
;
8429 /* Lookup KEY in MAP.
8430 MAP is a keymap mapping keys to key vectors or functions.
8431 If the mapping is a function and DO_FUNCTION is non-zero, then
8432 the function is called with PROMPT as parameter and its return
8433 value is used as the return value of this function (after checking
8434 that it is indeed a vector). */
8437 access_keymap_keyremap (map
, key
, prompt
, do_funcall
)
8438 Lisp_Object map
, key
, prompt
;
8443 next
= access_keymap (map
, key
, 1, 0, 1);
8445 /* Handle symbol with autoload definition. */
8446 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8447 && CONSP (XSYMBOL (next
)->function
)
8448 && EQ (XCAR (XSYMBOL (next
)->function
), Qautoload
))
8449 do_autoload (XSYMBOL (next
)->function
, next
);
8451 /* Handle a symbol whose function definition is a keymap
8453 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8454 && (!NILP (Farrayp (XSYMBOL (next
)->function
))
8455 || KEYMAPP (XSYMBOL (next
)->function
)))
8456 next
= XSYMBOL (next
)->function
;
8458 /* If the keymap gives a function, not an
8459 array, then call the function with one arg and use
8460 its value instead. */
8461 if (SYMBOLP (next
) && !NILP (Ffboundp (next
)) && do_funcall
)
8466 next
= call1 (next
, prompt
);
8467 /* If the function returned something invalid,
8468 barf--don't ignore it.
8469 (To ignore it safely, we would need to gcpro a bunch of
8470 other variables.) */
8471 if (! (VECTORP (next
) || STRINGP (next
)))
8472 error ("Function %s returns invalid key sequence", tem
);
8477 /* Do one step of the key remapping used for function-key-map and
8478 key-translation-map:
8479 KEYBUF is the buffer holding the input events.
8480 BUFSIZE is its maximum size.
8481 FKEY is a pointer to the keyremap structure to use.
8482 INPUT is the index of the last element in KEYBUF.
8483 DOIT if non-zero says that the remapping can actually take place.
8484 DIFF is used to return the number of keys added/removed by the remapping.
8485 PARENT is the root of the keymap.
8486 PROMPT is the prompt to use if the remapping happens through a function.
8487 The return value is non-zero if the remapping actually took place. */
8490 keyremap_step (keybuf
, bufsize
, fkey
, input
, doit
, diff
, prompt
)
8491 Lisp_Object
*keybuf
, prompt
;
8493 int input
, doit
, *diff
, bufsize
;
8495 Lisp_Object next
, key
;
8497 key
= keybuf
[fkey
->end
++];
8498 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8500 /* If keybuf[fkey->start..fkey->end] is bound in the
8501 map and we're in a position to do the key remapping, replace it with
8502 the binding and restart with fkey->start at the end. */
8503 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8505 int len
= XFASTINT (Flength (next
));
8508 *diff
= len
- (fkey
->end
- fkey
->start
);
8510 if (input
+ *diff
>= bufsize
)
8511 error ("Key sequence too long");
8513 /* Shift the keys that follow fkey->end. */
8515 for (i
= fkey
->end
; i
< input
; i
++)
8516 keybuf
[i
+ *diff
] = keybuf
[i
];
8518 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8519 keybuf
[i
+ *diff
] = keybuf
[i
];
8520 /* Overwrite the old keys with the new ones. */
8521 for (i
= 0; i
< len
; i
++)
8522 keybuf
[fkey
->start
+ i
]
8523 = Faref (next
, make_number (i
));
8525 fkey
->start
= fkey
->end
+= *diff
;
8526 fkey
->map
= fkey
->parent
;
8531 fkey
->map
= get_keymap (next
, 0, 1);
8533 /* If we no longer have a bound suffix, try a new position for
8535 if (!CONSP (fkey
->map
))
8537 fkey
->end
= ++fkey
->start
;
8538 fkey
->map
= fkey
->parent
;
8543 /* Read a sequence of keys that ends with a non prefix character,
8544 storing it in KEYBUF, a buffer of size BUFSIZE.
8546 Return the length of the key sequence stored.
8547 Return -1 if the user rejected a command menu.
8549 Echo starting immediately unless `prompt' is 0.
8551 Where a key sequence ends depends on the currently active keymaps.
8552 These include any minor mode keymaps active in the current buffer,
8553 the current buffer's local map, and the global map.
8555 If a key sequence has no other bindings, we check Vfunction_key_map
8556 to see if some trailing subsequence might be the beginning of a
8557 function key's sequence. If so, we try to read the whole function
8558 key, and substitute its symbolic name into the key sequence.
8560 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8561 `double-' events into similar click events, if that would make them
8562 bound. We try to turn `triple-' events first into `double-' events,
8565 If we get a mouse click in a mode line, vertical divider, or other
8566 non-text area, we treat the click as if it were prefixed by the
8567 symbol denoting that area - `mode-line', `vertical-line', or
8570 If the sequence starts with a mouse click, we read the key sequence
8571 with respect to the buffer clicked on, not the current buffer.
8573 If the user switches frames in the midst of a key sequence, we put
8574 off the switch-frame event until later; the next call to
8575 read_char will return it.
8577 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
8578 from the selected window's buffer. */
8581 read_key_sequence (keybuf
, bufsize
, prompt
, dont_downcase_last
,
8582 can_return_switch_frame
, fix_current_buffer
)
8583 Lisp_Object
*keybuf
;
8586 int dont_downcase_last
;
8587 int can_return_switch_frame
;
8588 int fix_current_buffer
;
8590 volatile Lisp_Object from_string
;
8591 volatile int count
= SPECPDL_INDEX ();
8593 /* How many keys there are in the current key sequence. */
8596 /* The length of the echo buffer when we started reading, and
8597 the length of this_command_keys when we started reading. */
8598 volatile int echo_start
;
8599 volatile int keys_start
;
8601 /* The number of keymaps we're scanning right now, and the number of
8602 keymaps we have allocated space for. */
8604 volatile int nmaps_allocated
= 0;
8606 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8607 the current keymaps. */
8608 Lisp_Object
*volatile defs
= NULL
;
8610 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8611 in the current keymaps, or nil where it is not a prefix. */
8612 Lisp_Object
*volatile submaps
= NULL
;
8614 /* The local map to start out with at start of key sequence. */
8615 volatile Lisp_Object orig_local_map
;
8617 /* The map from the `keymap' property to start out with at start of
8619 volatile Lisp_Object orig_keymap
;
8621 /* 1 if we have already considered switching to the local-map property
8622 of the place where a mouse click occurred. */
8623 volatile int localized_local_map
= 0;
8625 /* The index in defs[] of the first keymap that has a binding for
8626 this key sequence. In other words, the lowest i such that
8627 defs[i] is non-nil. */
8628 volatile int first_binding
;
8629 /* Index of the first key that has no binding.
8630 It is useless to try fkey.start larger than that. */
8631 volatile int first_unbound
;
8633 /* If t < mock_input, then KEYBUF[t] should be read as the next
8636 We use this to recover after recognizing a function key. Once we
8637 realize that a suffix of the current key sequence is actually a
8638 function key's escape sequence, we replace the suffix with the
8639 function key's binding from Vfunction_key_map. Now keybuf
8640 contains a new and different key sequence, so the echo area,
8641 this_command_keys, and the submaps and defs arrays are wrong. In
8642 this situation, we set mock_input to t, set t to 0, and jump to
8643 restart_sequence; the loop will read keys from keybuf up until
8644 mock_input, thus rebuilding the state; and then it will resume
8645 reading characters from the keyboard. */
8646 volatile int mock_input
= 0;
8648 /* If the sequence is unbound in submaps[], then
8649 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8650 and fkey.map is its binding.
8652 These might be > t, indicating that all function key scanning
8653 should hold off until t reaches them. We do this when we've just
8654 recognized a function key, to avoid searching for the function
8655 key's again in Vfunction_key_map. */
8656 volatile keyremap fkey
;
8658 /* Likewise, for key_translation_map. */
8659 volatile keyremap keytran
;
8661 /* If we receive a `switch-frame' or `select-window' event in the middle of
8662 a key sequence, we put it off for later.
8663 While we're reading, we keep the event here. */
8664 volatile Lisp_Object delayed_switch_frame
;
8666 /* See the comment below... */
8667 #if defined (GOBBLE_FIRST_EVENT)
8668 Lisp_Object first_event
;
8671 volatile Lisp_Object original_uppercase
;
8672 volatile int original_uppercase_position
= -1;
8674 /* Gets around Microsoft compiler limitations. */
8677 struct buffer
*starting_buffer
;
8679 /* List of events for which a fake prefix key has been generated. */
8680 volatile Lisp_Object fake_prefixed_keys
= Qnil
;
8682 #if defined (GOBBLE_FIRST_EVENT)
8686 struct gcpro gcpro1
;
8688 GCPRO1 (fake_prefixed_keys
);
8689 raw_keybuf_count
= 0;
8691 last_nonmenu_event
= Qnil
;
8693 delayed_switch_frame
= Qnil
;
8694 fkey
.map
= fkey
.parent
= current_kboard
->Vlocal_function_key_map
;
8695 keytran
.map
= keytran
.parent
= current_kboard
->Vlocal_key_translation_map
;
8696 /* If there is no translation-map, turn off scanning. */
8697 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
8698 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
8703 echo_prompt (prompt
);
8704 else if (cursor_in_echo_area
8705 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8706 && NILP (Fzerop (Vecho_keystrokes
)))
8707 /* This doesn't put in a dash if the echo buffer is empty, so
8708 you don't always see a dash hanging out in the minibuffer. */
8712 /* Record the initial state of the echo area and this_command_keys;
8713 we will need to restore them if we replay a key sequence. */
8715 echo_start
= echo_length ();
8716 keys_start
= this_command_key_count
;
8717 this_single_command_key_start
= keys_start
;
8719 #if defined (GOBBLE_FIRST_EVENT)
8720 /* This doesn't quite work, because some of the things that read_char
8721 does cannot safely be bypassed. It seems too risky to try to make
8724 /* Read the first char of the sequence specially, before setting
8725 up any keymaps, in case a filter runs and switches buffers on us. */
8726 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
8728 #endif /* GOBBLE_FIRST_EVENT */
8730 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8731 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8734 /* We jump here when the key sequence has been thoroughly changed, and
8735 we need to rescan it starting from the beginning. When we jump here,
8736 keybuf[0..mock_input] holds the sequence we should reread. */
8739 starting_buffer
= current_buffer
;
8740 first_unbound
= bufsize
+ 1;
8742 /* Build our list of keymaps.
8743 If we recognize a function key and replace its escape sequence in
8744 keybuf with its symbol, or if the sequence starts with a mouse
8745 click and we need to switch buffers, we jump back here to rebuild
8746 the initial keymaps from the current buffer. */
8749 if (!NILP (current_kboard
->Voverriding_terminal_local_map
)
8750 || !NILP (Voverriding_local_map
))
8752 if (3 > nmaps_allocated
)
8754 submaps
= (Lisp_Object
*) alloca (3 * sizeof (submaps
[0]));
8755 defs
= (Lisp_Object
*) alloca (3 * sizeof (defs
[0]));
8756 nmaps_allocated
= 3;
8758 if (!NILP (current_kboard
->Voverriding_terminal_local_map
))
8759 submaps
[nmaps
++] = current_kboard
->Voverriding_terminal_local_map
;
8760 if (!NILP (Voverriding_local_map
))
8761 submaps
[nmaps
++] = Voverriding_local_map
;
8769 nminor
= current_minor_maps (0, &maps
);
8770 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
8772 if (total
> nmaps_allocated
)
8774 submaps
= (Lisp_Object
*) alloca (total
* sizeof (submaps
[0]));
8775 defs
= (Lisp_Object
*) alloca (total
* sizeof (defs
[0]));
8776 nmaps_allocated
= total
;
8779 if (!NILP (orig_keymap
))
8780 submaps
[nmaps
++] = orig_keymap
;
8782 bcopy (maps
, (void *) (submaps
+ nmaps
),
8783 nminor
* sizeof (submaps
[0]));
8787 submaps
[nmaps
++] = orig_local_map
;
8789 submaps
[nmaps
++] = current_global_map
;
8791 /* Find an accurate initial value for first_binding. */
8792 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
8793 if (! NILP (submaps
[first_binding
]))
8796 /* Start from the beginning in keybuf. */
8799 /* These are no-ops the first time through, but if we restart, they
8800 revert the echo area and this_command_keys to their original state. */
8801 this_command_key_count
= keys_start
;
8802 if (INTERACTIVE
&& t
< mock_input
)
8803 echo_truncate (echo_start
);
8805 /* If the best binding for the current key sequence is a keymap, or
8806 we may be looking at a function key's escape sequence, keep on
8808 while (first_binding
< nmaps
8809 /* Keep reading as long as there's a prefix binding. */
8810 ? !NILP (submaps
[first_binding
])
8811 /* Don't return in the middle of a possible function key sequence,
8812 if the only bindings we found were via case conversion.
8813 Thus, if ESC O a has a function-key-map translation
8814 and ESC o has a binding, don't return after ESC O,
8815 so that we can translate ESC O plus the next character. */
8816 : (fkey
.start
< t
|| keytran
.start
< t
))
8819 int used_mouse_menu
= 0;
8821 /* Where the last real key started. If we need to throw away a
8822 key that has expanded into more than one element of keybuf
8823 (say, a mouse click on the mode line which is being treated
8824 as [mode-line (mouse-...)], then we backtrack to this point
8826 volatile int last_real_key_start
;
8828 /* These variables are analogous to echo_start and keys_start;
8829 while those allow us to restart the entire key sequence,
8830 echo_local_start and keys_local_start allow us to throw away
8832 volatile int echo_local_start
, keys_local_start
, local_first_binding
;
8834 eassert (fkey
.end
== t
|| (fkey
.end
> t
&& fkey
.end
<= mock_input
));
8835 eassert (fkey
.start
<= fkey
.end
);
8836 eassert (keytran
.start
<= keytran
.end
);
8837 /* key-translation-map is applied *after* function-key-map. */
8838 eassert (keytran
.end
<= fkey
.start
);
8840 if (first_unbound
< fkey
.start
&& first_unbound
< keytran
.start
)
8841 { /* The prefix upto first_unbound has no binding and has
8842 no translation left to do either, so we know it's unbound.
8843 If we don't stop now, we risk staying here indefinitely
8844 (if the user keeps entering fkey or keytran prefixes
8845 like C-c ESC ESC ESC ESC ...) */
8847 for (i
= first_unbound
+ 1; i
< t
; i
++)
8848 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8849 mock_input
= t
- first_unbound
- 1;
8850 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8851 fkey
.map
= fkey
.parent
;
8852 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8853 keytran
.map
= keytran
.parent
;
8854 goto replay_sequence
;
8858 error ("Key sequence too long");
8861 echo_local_start
= echo_length ();
8862 keys_local_start
= this_command_key_count
;
8863 local_first_binding
= first_binding
;
8866 /* These are no-ops, unless we throw away a keystroke below and
8867 jumped back up to replay_key; in that case, these restore the
8868 variables to their original state, allowing us to replay the
8870 if (INTERACTIVE
&& t
< mock_input
)
8871 echo_truncate (echo_local_start
);
8872 this_command_key_count
= keys_local_start
;
8873 first_binding
= local_first_binding
;
8875 /* By default, assume each event is "real". */
8876 last_real_key_start
= t
;
8878 /* Does mock_input indicate that we are re-reading a key sequence? */
8882 add_command_key (key
);
8883 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8884 && NILP (Fzerop (Vecho_keystrokes
)))
8888 /* If not, we should actually read a character. */
8893 KBOARD
*interrupted_kboard
= current_kboard
;
8894 struct frame
*interrupted_frame
= SELECTED_FRAME ();
8895 if (setjmp (wrong_kboard_jmpbuf
))
8897 if (!NILP (delayed_switch_frame
))
8899 interrupted_kboard
->kbd_queue
8900 = Fcons (delayed_switch_frame
,
8901 interrupted_kboard
->kbd_queue
);
8902 delayed_switch_frame
= Qnil
;
8905 interrupted_kboard
->kbd_queue
8906 = Fcons (keybuf
[--t
], interrupted_kboard
->kbd_queue
);
8908 /* If the side queue is non-empty, ensure it begins with a
8909 switch-frame, so we'll replay it in the right context. */
8910 if (CONSP (interrupted_kboard
->kbd_queue
)
8911 && (key
= XCAR (interrupted_kboard
->kbd_queue
),
8912 !(EVENT_HAS_PARAMETERS (key
)
8913 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
8917 XSETFRAME (frame
, interrupted_frame
);
8918 interrupted_kboard
->kbd_queue
8919 = Fcons (make_lispy_switch_frame (frame
),
8920 interrupted_kboard
->kbd_queue
);
8923 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8924 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8925 goto replay_sequence
;
8928 key
= read_char (NILP (prompt
), nmaps
,
8929 (Lisp_Object
*) submaps
, last_nonmenu_event
,
8933 /* read_char returns t when it shows a menu and the user rejects it.
8937 unbind_to (count
, Qnil
);
8942 /* read_char returns -1 at the end of a macro.
8943 Emacs 18 handles this by returning immediately with a
8944 zero, so that's what we'll do. */
8945 if (INTEGERP (key
) && XINT (key
) == -1)
8948 /* The Microsoft C compiler can't handle the goto that
8954 /* If the current buffer has been changed from under us, the
8955 keymap may have changed, so replay the sequence. */
8958 timer_resume_idle ();
8961 /* Reset the current buffer from the selected window
8962 in case something changed the former and not the latter.
8963 This is to be more consistent with the behavior
8964 of the command_loop_1. */
8965 if (fix_current_buffer
)
8967 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
8969 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
8970 Fset_buffer (XWINDOW (selected_window
)->buffer
);
8973 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8974 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8975 goto replay_sequence
;
8978 /* If we have a quit that was typed in another frame, and
8979 quit_throw_to_read_char switched buffers,
8980 replay to get the right keymap. */
8982 && XINT (key
) == quit_char
8983 && current_buffer
!= starting_buffer
)
8986 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
8990 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
8991 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
8992 goto replay_sequence
;
8997 if (EVENT_HAS_PARAMETERS (key
)
8998 /* Either a `switch-frame' or a `select-window' event. */
8999 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9001 /* If we're at the beginning of a key sequence, and the caller
9002 says it's okay, go ahead and return this event. If we're
9003 in the midst of a key sequence, delay it until the end. */
9004 if (t
> 0 || !can_return_switch_frame
)
9006 delayed_switch_frame
= key
;
9012 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9015 /* Clicks in non-text areas get prefixed by the symbol
9016 in their CHAR-ADDRESS field. For example, a click on
9017 the mode line is prefixed by the symbol `mode-line'.
9019 Furthermore, key sequences beginning with mouse clicks
9020 are read using the keymaps of the buffer clicked on, not
9021 the current buffer. So we may have to switch the buffer
9024 When we turn one event into two events, we must make sure
9025 that neither of the two looks like the original--so that,
9026 if we replay the events, they won't be expanded again.
9027 If not for this, such reexpansion could happen either here
9028 or when user programs play with this-command-keys. */
9029 if (EVENT_HAS_PARAMETERS (key
))
9034 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9035 if (EQ (kind
, Qmouse_click
))
9037 Lisp_Object window
, posn
;
9039 window
= POSN_WINDOW (EVENT_START (key
));
9040 posn
= POSN_POSN (EVENT_START (key
));
9043 || (!NILP (fake_prefixed_keys
)
9044 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9046 /* We're looking a second time at an event for which
9047 we generated a fake prefix key. Set
9048 last_real_key_start appropriately. */
9050 last_real_key_start
= t
- 1;
9053 /* Key sequences beginning with mouse clicks are
9054 read using the keymaps in the buffer clicked on,
9055 not the current buffer. If we're at the
9056 beginning of a key sequence, switch buffers. */
9057 if (last_real_key_start
== 0
9059 && BUFFERP (XWINDOW (window
)->buffer
)
9060 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9062 XVECTOR (raw_keybuf
)->contents
[raw_keybuf_count
++] = key
;
9066 /* Arrange to go back to the original buffer once we're
9067 done reading the key sequence. Note that we can't
9068 use save_excursion_{save,restore} here, because they
9069 save point as well as the current buffer; we don't
9070 want to save point, because redisplay may change it,
9071 to accommodate a Fset_window_start or something. We
9072 don't want to do this at the top of the function,
9073 because we may get input from a subprocess which
9074 wants to change the selected window and stuff (say,
9076 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
9078 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9080 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9081 orig_local_map
= get_local_map (PT
, current_buffer
,
9083 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9084 goto replay_sequence
;
9087 /* For a mouse click, get the local text-property keymap
9088 of the place clicked on, rather than point. */
9089 if (last_real_key_start
== 0
9090 && CONSP (XCDR (key
))
9091 && ! localized_local_map
)
9093 Lisp_Object map_here
, start
, pos
;
9095 localized_local_map
= 1;
9096 start
= EVENT_START (key
);
9098 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9100 pos
= POSN_BUFFER_POSN (start
);
9102 && XINT (pos
) >= BEG
&& XINT (pos
) <= Z
)
9104 map_here
= get_local_map (XINT (pos
),
9105 current_buffer
, Qlocal_map
);
9106 if (!EQ (map_here
, orig_local_map
))
9108 orig_local_map
= map_here
;
9112 goto replay_sequence
;
9114 map_here
= get_local_map (XINT (pos
),
9115 current_buffer
, Qkeymap
);
9116 if (!EQ (map_here
, orig_keymap
))
9118 orig_keymap
= map_here
;
9122 goto replay_sequence
;
9128 /* Expand mode-line and scroll-bar events into two events:
9129 use posn as a fake prefix key. */
9131 && (NILP (fake_prefixed_keys
)
9132 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9134 if (t
+ 1 >= bufsize
)
9135 error ("Key sequence too long");
9138 keybuf
[t
+ 1] = key
;
9141 /* Record that a fake prefix key has been generated
9142 for KEY. Don't modify the event; this would
9143 prevent proper action when the event is pushed
9144 back into unread-command-events. */
9145 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9147 /* If on a mode line string with a local keymap,
9148 reconsider the key sequence with that keymap. */
9149 if (string
= POSN_STRING (EVENT_START (key
)),
9150 (CONSP (string
) && STRINGP (XCAR (string
))))
9152 Lisp_Object pos
, map
, map2
;
9154 pos
= XCDR (string
);
9155 string
= XCAR (string
);
9157 && XINT (pos
) < SCHARS (string
))
9159 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9161 orig_local_map
= map
;
9162 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9165 if (!NILP (map
) || !NILP (map2
))
9166 goto replay_sequence
;
9172 else if (NILP (from_string
)
9173 && (string
= POSN_STRING (EVENT_START (key
)),
9174 (CONSP (string
) && STRINGP (XCAR (string
)))))
9176 /* For a click on a string, i.e. overlay string or a
9177 string displayed via the `display' property,
9178 consider `local-map' and `keymap' properties of
9180 Lisp_Object pos
, map
, map2
;
9182 pos
= XCDR (string
);
9183 string
= XCAR (string
);
9185 && XINT (pos
) < SCHARS (string
))
9187 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9189 orig_local_map
= map
;
9190 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9194 if (!NILP (map
) || !NILP (map2
))
9196 from_string
= string
;
9197 goto replay_sequence
;
9202 else if (CONSP (XCDR (key
))
9203 && CONSP (EVENT_START (key
))
9204 && CONSP (XCDR (EVENT_START (key
))))
9208 posn
= POSN_POSN (EVENT_START (key
));
9209 /* Handle menu-bar events:
9210 insert the dummy prefix event `menu-bar'. */
9211 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9213 if (t
+ 1 >= bufsize
)
9214 error ("Key sequence too long");
9218 /* Zap the position in key, so we know that we've
9219 expanded it, and don't try to do so again. */
9220 POSN_SET_POSN (EVENT_START (key
),
9221 Fcons (posn
, Qnil
));
9224 goto replay_sequence
;
9226 else if (CONSP (posn
))
9228 /* We're looking at the second event of a
9229 sequence which we expanded before. Set
9230 last_real_key_start appropriately. */
9231 if (last_real_key_start
== t
&& t
> 0)
9232 last_real_key_start
= t
- 1;
9237 /* We have finally decided that KEY is something we might want
9239 first_binding
= (follow_key (key
,
9240 nmaps
- first_binding
,
9241 submaps
+ first_binding
,
9242 defs
+ first_binding
,
9243 submaps
+ first_binding
)
9246 /* If KEY wasn't bound, we'll try some fallbacks. */
9247 if (first_binding
< nmaps
)
9248 /* This is needed for the following scenario:
9249 event 0: a down-event that gets dropped by calling replay_key.
9250 event 1: some normal prefix like C-h.
9251 After event 0, first_unbound is 0, after event 1 fkey.start
9252 and keytran.start are both 1, so when we see that C-h is bound,
9253 we need to update first_unbound. */
9254 first_unbound
= max (t
+ 1, first_unbound
);
9259 /* Remember the position to put an upper bound on fkey.start. */
9260 first_unbound
= min (t
, first_unbound
);
9262 head
= EVENT_HEAD (key
);
9263 if (help_char_p (head
) && t
> 0)
9265 read_key_sequence_cmd
= Vprefix_help_command
;
9267 last_nonmenu_event
= key
;
9268 /* The Microsoft C compiler can't handle the goto that
9276 Lisp_Object breakdown
;
9279 breakdown
= parse_modifiers (head
);
9280 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9281 /* Attempt to reduce an unbound mouse event to a simpler
9282 event that is bound:
9283 Drags reduce to clicks.
9284 Double-clicks reduce to clicks.
9285 Triple-clicks reduce to double-clicks, then to clicks.
9286 Down-clicks are eliminated.
9287 Double-downs reduce to downs, then are eliminated.
9288 Triple-downs reduce to double-downs, then to downs,
9289 then are eliminated. */
9290 if (modifiers
& (down_modifier
| drag_modifier
9291 | double_modifier
| triple_modifier
))
9293 while (modifiers
& (down_modifier
| drag_modifier
9294 | double_modifier
| triple_modifier
))
9296 Lisp_Object new_head
, new_click
;
9297 if (modifiers
& triple_modifier
)
9298 modifiers
^= (double_modifier
| triple_modifier
);
9299 else if (modifiers
& double_modifier
)
9300 modifiers
&= ~double_modifier
;
9301 else if (modifiers
& drag_modifier
)
9302 modifiers
&= ~drag_modifier
;
9305 /* Dispose of this `down' event by simply jumping
9306 back to replay_key, to get another event.
9308 Note that if this event came from mock input,
9309 then just jumping back to replay_key will just
9310 hand it to us again. So we have to wipe out any
9313 We could delete keybuf[t] and shift everything
9314 after that to the left by one spot, but we'd also
9315 have to fix up any variable that points into
9316 keybuf, and shifting isn't really necessary
9319 Adding prefixes for non-textual mouse clicks
9320 creates two characters of mock input, and both
9321 must be thrown away. If we're only looking at
9322 the prefix now, we can just jump back to
9323 replay_key. On the other hand, if we've already
9324 processed the prefix, and now the actual click
9325 itself is giving us trouble, then we've lost the
9326 state of the keymaps we want to backtrack to, and
9327 we need to replay the whole sequence to rebuild
9330 Beyond that, only function key expansion could
9331 create more than two keys, but that should never
9332 generate mouse events, so it's okay to zero
9333 mock_input in that case too.
9335 FIXME: The above paragraph seems just plain
9336 wrong, if you consider things like
9337 xterm-mouse-mode. -stef
9339 Isn't this just the most wonderful code ever? */
9341 /* If mock_input > t + 1, the above simplification
9342 will actually end up dropping keys on the floor.
9343 This is probably OK for now, but even
9344 if mock_input <= t + 1, we need to adjust fkey
9346 Typical case [header-line down-mouse-N]:
9347 mock_input = 2, t = 1, fkey.end = 1,
9348 last_real_key_start = 0. */
9349 if (fkey
.end
> last_real_key_start
)
9351 fkey
.end
= fkey
.start
9352 = min (last_real_key_start
, fkey
.start
);
9353 fkey
.map
= fkey
.parent
;
9354 if (keytran
.end
> last_real_key_start
)
9356 keytran
.end
= keytran
.start
9357 = min (last_real_key_start
, keytran
.start
);
9358 keytran
.map
= keytran
.parent
;
9361 if (t
== last_real_key_start
)
9368 mock_input
= last_real_key_start
;
9369 goto replay_sequence
;
9374 = apply_modifiers (modifiers
, XCAR (breakdown
));
9376 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9378 /* Look for a binding for this new key. follow_key
9379 promises that it didn't munge submaps the
9380 last time we called it, since key was unbound. */
9382 = (follow_key (new_click
,
9383 nmaps
- local_first_binding
,
9384 submaps
+ local_first_binding
,
9385 defs
+ local_first_binding
,
9386 submaps
+ local_first_binding
)
9387 + local_first_binding
);
9389 /* If that click is bound, go for it. */
9390 if (first_binding
< nmaps
)
9395 /* Otherwise, we'll leave key set to the drag event. */
9402 /* Normally, last_nonmenu_event gets the previous key we read.
9403 But when a mouse popup menu is being used,
9404 we don't update last_nonmenu_event; it continues to hold the mouse
9405 event that preceded the first level of menu. */
9406 if (!used_mouse_menu
)
9407 last_nonmenu_event
= key
;
9409 /* Record what part of this_command_keys is the current key sequence. */
9410 this_single_command_key_start
= this_command_key_count
- t
;
9412 if (first_binding
< nmaps
&& NILP (submaps
[first_binding
]))
9413 /* There is a binding and it's not a prefix.
9414 There is thus no function-key in this sequence.
9415 Moving fkey.start is important in this case to allow keytran.start
9416 to go over the sequence before we return (since we keep the
9417 invariant that keytran.end <= fkey.start). */
9420 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9423 /* If the sequence is unbound, see if we can hang a function key
9424 off the end of it. */
9425 /* Continue scan from fkey.end until we find a bound suffix. */
9426 while (fkey
.end
< t
)
9428 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9431 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9432 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9433 max (t
, mock_input
),
9434 /* If there's a binding (i.e.
9435 first_binding >= nmaps) we don't want
9436 to apply this function-key-mapping. */
9437 fkey
.end
+ 1 == t
&& first_binding
>= nmaps
,
9442 mock_input
= diff
+ max (t
, mock_input
);
9443 goto replay_sequence
;
9447 /* Look for this sequence in key-translation-map.
9448 Scan from keytran.end until we find a bound suffix. */
9449 while (keytran
.end
< fkey
.start
)
9451 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9454 GCPRO3 (fkey
.map
, keytran
.map
, delayed_switch_frame
);
9455 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9460 mock_input
= diff
+ max (t
, mock_input
);
9461 /* Adjust the function-key-map counters. */
9465 goto replay_sequence
;
9469 /* If KEY is not defined in any of the keymaps,
9470 and cannot be part of a function key or translation,
9471 and is an upper case letter
9472 use the corresponding lower-case letter instead. */
9473 if (first_binding
>= nmaps
9474 && fkey
.start
>= t
&& keytran
.start
>= t
9476 && ((((XINT (key
) & 0x3ffff)
9477 < XCHAR_TABLE (current_buffer
->downcase_table
)->size
)
9478 && UPPERCASEP (XINT (key
) & 0x3ffff))
9479 || (XINT (key
) & shift_modifier
)))
9481 Lisp_Object new_key
;
9483 original_uppercase
= key
;
9484 original_uppercase_position
= t
- 1;
9486 if (XINT (key
) & shift_modifier
)
9487 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9489 XSETINT (new_key
, (DOWNCASE (XINT (key
) & 0x3ffff)
9490 | (XINT (key
) & ~0x3ffff)));
9492 /* We have to do this unconditionally, regardless of whether
9493 the lower-case char is defined in the keymaps, because they
9494 might get translated through function-key-map. */
9495 keybuf
[t
- 1] = new_key
;
9496 mock_input
= max (t
, mock_input
);
9498 goto replay_sequence
;
9500 /* If KEY is not defined in any of the keymaps,
9501 and cannot be part of a function key or translation,
9502 and is a shifted function key,
9503 use the corresponding unshifted function key instead. */
9504 if (first_binding
>= nmaps
9505 && fkey
.start
>= t
&& keytran
.start
>= t
9508 Lisp_Object breakdown
;
9511 breakdown
= parse_modifiers (key
);
9512 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9513 if (modifiers
& shift_modifier
)
9515 Lisp_Object new_key
;
9517 original_uppercase
= key
;
9518 original_uppercase_position
= t
- 1;
9520 modifiers
&= ~shift_modifier
;
9521 new_key
= apply_modifiers (modifiers
,
9524 keybuf
[t
- 1] = new_key
;
9525 mock_input
= max (t
, mock_input
);
9526 fkey
.start
= fkey
.end
= KEYMAPP (fkey
.map
) ? 0 : bufsize
+ 1;
9527 keytran
.start
= keytran
.end
= KEYMAPP (keytran
.map
) ? 0 : bufsize
+ 1;
9529 goto replay_sequence
;
9535 read_key_sequence_cmd
= (first_binding
< nmaps
9536 ? defs
[first_binding
]
9539 unread_switch_frame
= delayed_switch_frame
;
9540 unbind_to (count
, Qnil
);
9542 /* Don't downcase the last character if the caller says don't.
9543 Don't downcase it if the result is undefined, either. */
9544 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9545 && t
- 1 == original_uppercase_position
)
9546 keybuf
[t
- 1] = original_uppercase
;
9548 /* Occasionally we fabricate events, perhaps by expanding something
9549 according to function-key-map, or by adding a prefix symbol to a
9550 mouse click in the scroll bar or modeline. In this cases, return
9551 the entire generated key sequence, even if we hit an unbound
9552 prefix or a definition before the end. This means that you will
9553 be able to push back the event properly, and also means that
9554 read-key-sequence will always return a logical unit.
9557 for (; t
< mock_input
; t
++)
9559 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9560 && NILP (Fzerop (Vecho_keystrokes
)))
9561 echo_char (keybuf
[t
]);
9562 add_command_key (keybuf
[t
]);
9571 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9572 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9573 The sequence is sufficient to specify a non-prefix command in the
9574 current local and global maps.
9576 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9577 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9578 as a continuation of the previous key.
9580 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9581 convert the last event to lower case. (Normally any upper case event
9582 is converted to lower case if the original event is undefined and the lower
9583 case equivalent is defined.) A non-nil value is appropriate for reading
9584 a key sequence to be defined.
9586 A C-g typed while in this function is treated like any other character,
9587 and `quit-flag' is not set.
9589 If the key sequence starts with a mouse click, then the sequence is read
9590 using the keymaps of the buffer of the window clicked in, not the buffer
9591 of the selected window as normal.
9593 `read-key-sequence' drops unbound button-down events, since you normally
9594 only care about the click or drag events which follow them. If a drag
9595 or multi-click event is unbound, but the corresponding click event would
9596 be bound, `read-key-sequence' turns the event into a click event at the
9597 drag's starting position. This means that you don't have to distinguish
9598 between click and drag, double, or triple events unless you want to.
9600 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9601 lines separating windows, and scroll bars with imaginary keys
9602 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9604 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9605 function will process a switch-frame event if the user switches frames
9606 before typing anything. If the user switches frames in the middle of a
9607 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9608 is nil, then the event will be put off until after the current key sequence.
9610 `read-key-sequence' checks `function-key-map' for function key
9611 sequences, where they wouldn't conflict with ordinary bindings. See
9612 `function-key-map' for more details.
9614 The optional fifth argument COMMAND-LOOP, if non-nil, means
9615 that this key sequence is being read by something that will
9616 read commands one after another. It should be nil if the caller
9617 will read just one key sequence. */)
9618 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9620 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9621 Lisp_Object can_return_switch_frame
, command_loop
;
9623 Lisp_Object keybuf
[30];
9625 struct gcpro gcpro1
;
9626 int count
= SPECPDL_INDEX ();
9629 CHECK_STRING (prompt
);
9632 specbind (Qinput_method_exit_on_first_char
,
9633 (NILP (command_loop
) ? Qt
: Qnil
));
9634 specbind (Qinput_method_use_echo_area
,
9635 (NILP (command_loop
) ? Qt
: Qnil
));
9637 bzero (keybuf
, sizeof keybuf
);
9639 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9641 if (NILP (continue_echo
))
9643 this_command_key_count
= 0;
9644 this_command_key_count_reset
= 0;
9645 this_single_command_key_start
= 0;
9648 #ifdef HAVE_X_WINDOWS
9649 if (display_hourglass_p
)
9650 cancel_hourglass ();
9653 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9654 prompt
, ! NILP (dont_downcase_last
),
9655 ! NILP (can_return_switch_frame
), 0);
9657 #if 0 /* The following is fine for code reading a key sequence and
9658 then proceeding with a lenghty computation, but it's not good
9659 for code reading keys in a loop, like an input method. */
9660 #ifdef HAVE_X_WINDOWS
9661 if (display_hourglass_p
)
9672 return unbind_to (count
, make_event_array (i
, keybuf
));
9675 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9676 Sread_key_sequence_vector
, 1, 5, 0,
9677 doc
: /* Like `read-key-sequence' but always return a vector. */)
9678 (prompt
, continue_echo
, dont_downcase_last
, can_return_switch_frame
,
9680 Lisp_Object prompt
, continue_echo
, dont_downcase_last
;
9681 Lisp_Object can_return_switch_frame
, command_loop
;
9683 Lisp_Object keybuf
[30];
9685 struct gcpro gcpro1
;
9686 int count
= SPECPDL_INDEX ();
9689 CHECK_STRING (prompt
);
9692 specbind (Qinput_method_exit_on_first_char
,
9693 (NILP (command_loop
) ? Qt
: Qnil
));
9694 specbind (Qinput_method_use_echo_area
,
9695 (NILP (command_loop
) ? Qt
: Qnil
));
9697 bzero (keybuf
, sizeof keybuf
);
9699 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
9701 if (NILP (continue_echo
))
9703 this_command_key_count
= 0;
9704 this_command_key_count_reset
= 0;
9705 this_single_command_key_start
= 0;
9708 #ifdef HAVE_X_WINDOWS
9709 if (display_hourglass_p
)
9710 cancel_hourglass ();
9713 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
9714 prompt
, ! NILP (dont_downcase_last
),
9715 ! NILP (can_return_switch_frame
), 0);
9717 #ifdef HAVE_X_WINDOWS
9718 if (display_hourglass_p
)
9728 return unbind_to (count
, Fvector (i
, keybuf
));
9731 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9732 doc
: /* Execute CMD as an editor command.
9733 CMD must be a symbol that satisfies the `commandp' predicate.
9734 Optional second arg RECORD-FLAG non-nil
9735 means unconditionally put this command in `command-history'.
9736 Otherwise, that is done only if an arg is read using the minibuffer.
9737 The argument KEYS specifies the value to use instead of (this-command-keys)
9738 when reading the arguments; if it is nil, (this-command-keys) is used.
9739 The argument SPECIAL, if non-nil, means that this command is executing
9740 a special event, so ignore the prefix argument and don't clear it. */)
9741 (cmd
, record_flag
, keys
, special
)
9742 Lisp_Object cmd
, record_flag
, keys
, special
;
9744 register Lisp_Object final
;
9745 register Lisp_Object tem
;
9746 Lisp_Object prefixarg
;
9747 struct backtrace backtrace
;
9748 extern int debug_on_next_call
;
9750 debug_on_next_call
= 0;
9754 prefixarg
= current_kboard
->Vprefix_arg
;
9755 Vcurrent_prefix_arg
= prefixarg
;
9756 current_kboard
->Vprefix_arg
= Qnil
;
9763 tem
= Fget (cmd
, Qdisabled
);
9764 if (!NILP (tem
) && !NILP (Vrun_hooks
))
9766 tem
= Fsymbol_value (Qdisabled_command_function
);
9768 return call1 (Vrun_hooks
, Qdisabled_command_function
);
9774 final
= Findirect_function (cmd
);
9776 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9778 struct gcpro gcpro1
, gcpro2
;
9780 GCPRO2 (cmd
, prefixarg
);
9781 do_autoload (final
, cmd
);
9788 if (STRINGP (final
) || VECTORP (final
))
9790 /* If requested, place the macro in the command history. For
9791 other sorts of commands, call-interactively takes care of
9793 if (!NILP (record_flag
))
9796 = Fcons (Fcons (Qexecute_kbd_macro
,
9797 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9800 /* Don't keep command history around forever. */
9801 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9803 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9805 XSETCDR (tem
, Qnil
);
9809 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9812 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9814 backtrace
.next
= backtrace_list
;
9815 backtrace_list
= &backtrace
;
9816 backtrace
.function
= &Qcall_interactively
;
9817 backtrace
.args
= &cmd
;
9818 backtrace
.nargs
= 1;
9819 backtrace
.evalargs
= 0;
9820 backtrace
.debug_on_exit
= 0;
9822 tem
= Fcall_interactively (cmd
, record_flag
, keys
);
9824 backtrace_list
= backtrace
.next
;
9832 DEFUN ("execute-extended-command", Fexecute_extended_command
, Sexecute_extended_command
,
9834 doc
: /* Read function name, then read its arguments and call it. */)
9836 Lisp_Object prefixarg
;
9838 Lisp_Object function
;
9840 int saved_last_point_position
;
9841 Lisp_Object saved_keys
, saved_last_point_position_buffer
;
9842 Lisp_Object bindings
, value
;
9843 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9844 #ifdef HAVE_X_WINDOWS
9845 /* The call to Fcompleting_read wil start and cancel the hourglass,
9846 but if the hourglass was already scheduled, this means that no
9847 hourglass will be shown for the actual M-x command itself.
9848 So we restart it if it is already scheduled. Note that checking
9849 hourglass_shown_p is not enough, normally the hourglass is not shown,
9850 just scheduled to be shown. */
9851 int hstarted
= hourglass_started ();
9854 saved_keys
= Fvector (this_command_key_count
,
9855 XVECTOR (this_command_keys
)->contents
);
9856 saved_last_point_position_buffer
= last_point_position_buffer
;
9857 saved_last_point_position
= last_point_position
;
9859 GCPRO3 (saved_keys
, prefixarg
, saved_last_point_position_buffer
);
9861 if (EQ (prefixarg
, Qminus
))
9863 else if (CONSP (prefixarg
) && XINT (XCAR (prefixarg
)) == 4)
9864 strcpy (buf
, "C-u ");
9865 else if (CONSP (prefixarg
) && INTEGERP (XCAR (prefixarg
)))
9866 sprintf (buf
, "%ld ", (long) XINT (XCAR (prefixarg
)));
9867 else if (INTEGERP (prefixarg
))
9868 sprintf (buf
, "%ld ", (long) XINT (prefixarg
));
9870 /* This isn't strictly correct if execute-extended-command
9871 is bound to anything else. Perhaps it should use
9872 this_command_keys? */
9873 strcat (buf
, "M-x ");
9875 /* Prompt with buf, and then read a string, completing from and
9876 restricting to the set of all defined commands. Don't provide
9877 any initial input. Save the command read on the extended-command
9879 function
= Fcompleting_read (build_string (buf
),
9880 Vobarray
, Qcommandp
,
9881 Qt
, Qnil
, Qextended_command_history
, Qnil
,
9884 #ifdef HAVE_X_WINDOWS
9885 if (hstarted
) start_hourglass ();
9888 if (STRINGP (function
) && SCHARS (function
) == 0)
9889 error ("No command name given");
9891 /* Set this_command_keys to the concatenation of saved_keys and
9892 function, followed by a RET. */
9897 this_command_key_count
= 0;
9898 this_command_key_count_reset
= 0;
9899 this_single_command_key_start
= 0;
9901 keys
= XVECTOR (saved_keys
)->contents
;
9902 for (i
= 0; i
< XVECTOR (saved_keys
)->size
; i
++)
9903 add_command_key (keys
[i
]);
9905 for (i
= 0; i
< SCHARS (function
); i
++)
9906 add_command_key (Faref (function
, make_number (i
)));
9908 add_command_key (make_number ('\015'));
9911 last_point_position
= saved_last_point_position
;
9912 last_point_position_buffer
= saved_last_point_position_buffer
;
9916 function
= Fintern (function
, Qnil
);
9917 current_kboard
->Vprefix_arg
= prefixarg
;
9918 Vthis_command
= function
;
9919 real_this_command
= function
;
9921 /* If enabled, show which key runs this command. */
9922 if (!NILP (Vsuggest_key_bindings
)
9923 && NILP (Vexecuting_kbd_macro
)
9924 && SYMBOLP (function
))
9925 bindings
= Fwhere_is_internal (function
, Voverriding_local_map
,
9931 GCPRO2 (bindings
, value
);
9932 value
= Fcommand_execute (function
, Qt
, Qnil
, Qnil
);
9934 /* If the command has a key binding, print it now. */
9935 if (!NILP (bindings
)
9936 && ! (VECTORP (bindings
) && EQ (Faref (bindings
, make_number (0)),
9939 /* But first wait, and skip the message if there is input. */
9941 if (!NILP (echo_area_buffer
[0]))
9942 /* This command displayed something in the echo area;
9943 so wait a few seconds, then display our suggestion message. */
9944 delay_time
= (NUMBERP (Vsuggest_key_bindings
)
9945 ? XINT (Vsuggest_key_bindings
) : 2);
9947 /* This command left the echo area empty,
9948 so display our message immediately. */
9951 if (!NILP (Fsit_for (make_number (delay_time
), Qnil
, Qnil
))
9952 && ! CONSP (Vunread_command_events
))
9954 Lisp_Object binding
;
9956 int message_p
= push_message ();
9957 int count
= SPECPDL_INDEX ();
9959 record_unwind_protect (pop_message_unwind
, Qnil
);
9960 binding
= Fkey_description (bindings
, Qnil
);
9963 = (char *) alloca (SCHARS (SYMBOL_NAME (function
))
9966 sprintf (newmessage
, "You can run the command `%s' with %s",
9967 SDATA (SYMBOL_NAME (function
)),
9969 message2_nolog (newmessage
,
9970 strlen (newmessage
),
9971 STRING_MULTIBYTE (binding
));
9972 if (!NILP (Fsit_for ((NUMBERP (Vsuggest_key_bindings
)
9973 ? Vsuggest_key_bindings
: make_number (2)),
9978 unbind_to (count
, Qnil
);
9982 RETURN_UNGCPRO (value
);
9986 /* Return nonzero if input events are pending. */
9989 detect_input_pending ()
9992 get_input_pending (&input_pending
, 0);
9994 return input_pending
;
9997 /* Return nonzero if input events other than mouse movements are
10001 detect_input_pending_ignore_squeezables ()
10003 if (!input_pending
)
10004 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10006 return input_pending
;
10009 /* Return nonzero if input events are pending, and run any pending timers. */
10012 detect_input_pending_run_timers (do_display
)
10015 int old_timers_run
= timers_run
;
10017 if (!input_pending
)
10018 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10020 if (old_timers_run
!= timers_run
&& do_display
)
10022 redisplay_preserve_echo_area (8);
10023 /* The following fixes a bug when using lazy-lock with
10024 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10025 from an idle timer function. The symptom of the bug is that
10026 the cursor sometimes doesn't become visible until the next X
10027 event is processed. --gerd. */
10029 Lisp_Object tail
, frame
;
10030 FOR_EACH_FRAME (tail
, frame
)
10031 if (FRAME_RIF (XFRAME (frame
)))
10032 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10036 return input_pending
;
10039 /* This is called in some cases before a possible quit.
10040 It cases the next call to detect_input_pending to recompute input_pending.
10041 So calling this function unnecessarily can't do any harm. */
10044 clear_input_pending ()
10049 /* Return nonzero if there are pending requeued events.
10050 This isn't used yet. The hope is to make wait_reading_process_output
10051 call it, and return if it runs Lisp code that unreads something.
10052 The problem is, kbd_buffer_get_event needs to be fixed to know what
10053 to do in that case. It isn't trivial. */
10056 requeued_events_pending_p ()
10058 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10062 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10063 doc
: /* Return t if command input is currently available with no wait.
10064 Actually, the value is nil only if we can be sure that no input is available;
10065 if there is a doubt, the value is t. */)
10068 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1)
10071 get_input_pending (&input_pending
,
10072 READABLE_EVENTS_DO_TIMERS_NOW
10073 | READABLE_EVENTS_FILTER_EVENTS
);
10074 return input_pending
> 0 ? Qt
: Qnil
;
10077 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10078 doc
: /* Return vector of last 100 events, not counting those from keyboard macros. */)
10081 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10084 if (total_keys
< NUM_RECENT_KEYS
)
10085 return Fvector (total_keys
, keys
);
10088 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10089 bcopy (keys
+ recent_keys_index
,
10090 XVECTOR (val
)->contents
,
10091 (NUM_RECENT_KEYS
- recent_keys_index
) * sizeof (Lisp_Object
));
10093 XVECTOR (val
)->contents
+ NUM_RECENT_KEYS
- recent_keys_index
,
10094 recent_keys_index
* sizeof (Lisp_Object
));
10099 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10100 doc
: /* Return the key sequence that invoked this command.
10101 However, if the command has called `read-key-sequence', it returns
10102 the last key sequence that has been read.
10103 The value is a string or a vector. */)
10106 return make_event_array (this_command_key_count
,
10107 XVECTOR (this_command_keys
)->contents
);
10110 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10111 doc
: /* Return the key sequence that invoked this command, as a vector.
10112 However, if the command has called `read-key-sequence', it returns
10113 the last key sequence that has been read. */)
10116 return Fvector (this_command_key_count
,
10117 XVECTOR (this_command_keys
)->contents
);
10120 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10121 Sthis_single_command_keys
, 0, 0, 0,
10122 doc
: /* Return the key sequence that invoked this command.
10123 More generally, it returns the last key sequence read, either by
10124 the command loop or by `read-key-sequence'.
10125 Unlike `this-command-keys', this function's value
10126 does not include prefix arguments.
10127 The value is always a vector. */)
10130 return Fvector (this_command_key_count
10131 - this_single_command_key_start
,
10132 (XVECTOR (this_command_keys
)->contents
10133 + this_single_command_key_start
));
10136 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10137 Sthis_single_command_raw_keys
, 0, 0, 0,
10138 doc
: /* Return the raw events that were read for this command.
10139 More generally, it returns the last key sequence read, either by
10140 the command loop or by `read-key-sequence'.
10141 Unlike `this-single-command-keys', this function's value
10142 shows the events before all translations (except for input methods).
10143 The value is always a vector. */)
10146 return Fvector (raw_keybuf_count
,
10147 (XVECTOR (raw_keybuf
)->contents
));
10150 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10151 Sreset_this_command_lengths
, 0, 0, 0,
10152 doc
: /* Make the unread events replace the last command and echo.
10153 Used in `universal-argument-other-key'.
10155 `universal-argument-other-key' rereads the event just typed.
10156 It then gets translated through `function-key-map'.
10157 The translated event has to replace the real events,
10158 both in the value of (this-command-keys) and in echoing.
10159 To achieve this, `universal-argument-other-key' calls
10160 `reset-this-command-lengths', which discards the record of reading
10161 these events the first time. */)
10164 this_command_key_count
= before_command_key_count
;
10165 if (this_command_key_count
< this_single_command_key_start
)
10166 this_single_command_key_start
= this_command_key_count
;
10168 echo_truncate (before_command_echo_length
);
10170 /* Cause whatever we put into unread-command-events
10171 to echo as if it were being freshly read from the keyboard. */
10172 this_command_key_count_reset
= 1;
10177 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10178 Sclear_this_command_keys
, 0, 1, 0,
10179 doc
: /* Clear out the vector that `this-command-keys' returns.
10180 Also clear the record of the last 100 events, unless optional arg
10181 KEEP-RECORD is non-nil. */)
10183 Lisp_Object keep_record
;
10187 this_command_key_count
= 0;
10188 this_command_key_count_reset
= 0;
10190 if (NILP (keep_record
))
10192 for (i
= 0; i
< XVECTOR (recent_keys
)->size
; ++i
)
10193 XVECTOR (recent_keys
)->contents
[i
] = Qnil
;
10195 recent_keys_index
= 0;
10200 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10201 doc
: /* Return the current depth in recursive edits. */)
10205 XSETFASTINT (temp
, command_loop_level
+ minibuf_level
);
10209 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10210 "FOpen dribble file: ",
10211 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10212 If FILE is nil, close any open dribble file. */)
10223 file
= Fexpand_file_name (file
, Qnil
);
10224 dribble
= fopen (SDATA (file
), "w");
10226 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10231 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10232 doc
: /* Discard the contents of the terminal input buffer.
10233 Also end any kbd macro being defined. */)
10236 if (!NILP (current_kboard
->defining_kbd_macro
))
10238 /* Discard the last command from the macro. */
10239 Fcancel_kbd_macro_events ();
10243 update_mode_lines
++;
10245 Vunread_command_events
= Qnil
;
10246 unread_command_char
= -1;
10248 discard_tty_input ();
10250 kbd_fetch_ptr
= kbd_store_ptr
;
10256 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10257 doc
: /* Stop Emacs and return to superior process. You can resume later.
10258 If `cannot-suspend' is non-nil, or if the system doesn't support job
10259 control, run a subshell instead.
10261 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10262 to be read as terminal input by Emacs's parent, after suspension.
10264 Before suspending, run the normal hook `suspend-hook'.
10265 After resumption run the normal hook `suspend-resume-hook'.
10267 Some operating systems cannot stop the Emacs process and resume it later.
10268 On such systems, Emacs starts a subshell instead of suspending. */)
10270 Lisp_Object stuffstring
;
10272 int count
= SPECPDL_INDEX ();
10273 int old_height
, old_width
;
10275 struct gcpro gcpro1
;
10277 if (tty_list
&& tty_list
->next
)
10278 error ("There are other tty frames open; close them before suspending Emacs");
10280 if (!NILP (stuffstring
))
10281 CHECK_STRING (stuffstring
);
10283 /* Run the functions in suspend-hook. */
10284 if (!NILP (Vrun_hooks
))
10285 call1 (Vrun_hooks
, intern ("suspend-hook"));
10287 GCPRO1 (stuffstring
);
10288 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10289 reset_all_sys_modes ();
10290 /* sys_suspend can get an error if it tries to fork a subshell
10291 and the system resources aren't available for that. */
10292 record_unwind_protect ((Lisp_Object (*) P_ ((Lisp_Object
))) init_all_sys_modes
,
10294 stuff_buffered_input (stuffstring
);
10295 if (cannot_suspend
)
10299 unbind_to (count
, Qnil
);
10301 /* Check if terminal/window size has changed.
10302 Note that this is not useful when we are running directly
10303 with a window system; but suspend should be disabled in that case. */
10304 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10305 if (width
!= old_width
|| height
!= old_height
)
10306 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10308 /* Run suspend-resume-hook. */
10309 if (!NILP (Vrun_hooks
))
10310 call1 (Vrun_hooks
, intern ("suspend-resume-hook"));
10316 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10317 Then in any case stuff anything Emacs has read ahead and not used. */
10320 stuff_buffered_input (stuffstring
)
10321 Lisp_Object stuffstring
;
10323 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10324 register unsigned char *p
;
10326 if (STRINGP (stuffstring
))
10328 register int count
;
10330 p
= SDATA (stuffstring
);
10331 count
= SBYTES (stuffstring
);
10332 while (count
-- > 0)
10337 /* Anything we have read ahead, put back for the shell to read. */
10338 /* ?? What should this do when we have multiple keyboards??
10339 Should we ignore anything that was typed in at the "wrong" kboard?
10341 rms: we should stuff everything back into the kboard
10343 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10346 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10347 kbd_fetch_ptr
= kbd_buffer
;
10348 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10349 stuff_char (kbd_fetch_ptr
->code
);
10351 clear_event (kbd_fetch_ptr
);
10355 #endif /* SIGTSTP */
10359 set_waiting_for_input (time_to_clear
)
10360 EMACS_TIME
*time_to_clear
;
10362 input_available_clear_time
= time_to_clear
;
10364 /* Tell handle_interrupt to throw back to read_char, */
10365 waiting_for_input
= 1;
10367 /* If handle_interrupt was called before and buffered a C-g,
10368 make it run again now, to avoid timing error. */
10369 if (!NILP (Vquit_flag
))
10370 quit_throw_to_read_char ();
10374 clear_waiting_for_input ()
10376 /* Tell handle_interrupt not to throw back to read_char, */
10377 waiting_for_input
= 0;
10378 input_available_clear_time
= 0;
10381 /* The SIGINT handler.
10383 If we have a frame on the controlling tty, we assume that the
10384 SIGINT was generated by C-g, so we call handle_interrupt.
10385 Otherwise, the handler kills Emacs. */
10388 interrupt_signal (signalnum
) /* If we don't have an argument, */
10389 int signalnum
; /* some compilers complain in signal calls. */
10391 /* Must preserve main program's value of errno. */
10392 int old_errno
= errno
;
10393 struct device
*device
;
10395 #if defined (USG) && !defined (POSIX_SIGNALS)
10396 /* USG systems forget handlers when they are used;
10397 must reestablish each time */
10398 signal (SIGINT
, interrupt_signal
);
10399 signal (SIGQUIT
, interrupt_signal
);
10402 SIGNAL_THREAD_CHECK (signalnum
);
10404 /* See if we have an active display on our controlling terminal. */
10405 device
= get_named_tty (NULL
);
10408 /* If there are no frames there, let's pretend that we are a
10409 well-behaving UN*X program and quit. */
10410 fatal_error_signal (SIGTERM
);
10414 /* Otherwise, the SIGINT was probably generated by C-g. */
10416 /* Set internal_last_event_frame to the top frame of the
10417 controlling tty, if we have a frame there. We disable the
10418 interrupt key on secondary ttys, so the SIGINT must have come
10419 from the controlling tty. */
10420 internal_last_event_frame
= device
->display_info
.tty
->top_frame
;
10422 handle_interrupt ();
10428 /* This routine is called at interrupt level in response to C-g.
10430 It is called from the SIGINT handler or kbd_buffer_store_event.
10432 If `waiting_for_input' is non zero, then unless `echoing' is
10433 nonzero, immediately throw back to read_char.
10435 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10436 eval to throw, when it gets a chance. If quit-flag is already
10437 non-nil, it stops the job right away. */
10440 handle_interrupt ()
10446 /* XXX This code needs to be revised for multi-tty support. */
10447 if (!NILP (Vquit_flag
)
10449 && get_named_tty (NULL
)
10453 /* If SIGINT isn't blocked, don't let us be interrupted by
10454 another SIGINT, it might be harmful due to non-reentrancy
10455 in I/O functions. */
10456 sigblock (sigmask (SIGINT
));
10459 reset_all_sys_modes ();
10461 #ifdef SIGTSTP /* Support possible in later USG versions */
10463 * On systems which can suspend the current process and return to the original
10464 * shell, this command causes the user to end up back at the shell.
10465 * The "Auto-save" and "Abort" questions are not asked until
10466 * the user elects to return to emacs, at which point he can save the current
10467 * job and either dump core or continue.
10472 if (sys_suspend () == -1)
10474 printf ("Not running as a subprocess;\n");
10475 printf ("you can continue or abort.\n");
10477 #else /* not VMS */
10478 /* Perhaps should really fork an inferior shell?
10479 But that would not provide any way to get back
10480 to the original shell, ever. */
10481 printf ("No support for stopping a process on this operating system;\n");
10482 printf ("you can continue or abort.\n");
10483 #endif /* not VMS */
10484 #endif /* not SIGTSTP */
10486 /* We must remain inside the screen area when the internal terminal
10487 is used. Note that [Enter] is not echoed by dos. */
10490 /* It doesn't work to autosave while GC is in progress;
10491 the code used for auto-saving doesn't cope with the mark bit. */
10492 if (!gc_in_progress
)
10494 printf ("Auto-save? (y or n) ");
10496 if (((c
= getchar ()) & ~040) == 'Y')
10498 Fdo_auto_save (Qt
, Qnil
);
10500 printf ("\r\nAuto-save done");
10501 #else /* not MSDOS */
10502 printf ("Auto-save done\n");
10503 #endif /* not MSDOS */
10505 while (c
!= '\n') c
= getchar ();
10509 /* During GC, it must be safe to reenable quitting again. */
10510 Vinhibit_quit
= Qnil
;
10513 #endif /* not MSDOS */
10514 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10515 printf ("but will instead do a real quit after garbage collection ends\r\n");
10520 printf ("\r\nAbort? (y or n) ");
10521 #else /* not MSDOS */
10523 printf ("Abort (and enter debugger)? (y or n) ");
10524 #else /* not VMS */
10525 printf ("Abort (and dump core)? (y or n) ");
10526 #endif /* not VMS */
10527 #endif /* not MSDOS */
10529 if (((c
= getchar ()) & ~040) == 'Y')
10531 while (c
!= '\n') c
= getchar ();
10533 printf ("\r\nContinuing...\r\n");
10534 #else /* not MSDOS */
10535 printf ("Continuing...\n");
10536 #endif /* not MSDOS */
10538 init_all_sys_modes ();
10543 /* If executing a function that wants to be interrupted out of
10544 and the user has not deferred quitting by binding `inhibit-quit'
10545 then quit right away. */
10546 if (immediate_quit
&& NILP (Vinhibit_quit
))
10548 struct gl_state_s saved
;
10549 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10551 immediate_quit
= 0;
10554 GCPRO4 (saved
.object
, saved
.global_code
,
10555 saved
.current_syntax_table
, saved
.old_prop
);
10556 Fsignal (Qquit
, Qnil
);
10561 /* Else request quit when it's safe */
10565 if (waiting_for_input
&& !echoing
)
10566 quit_throw_to_read_char ();
10569 /* Handle a C-g by making read_char return C-g. */
10572 quit_throw_to_read_char ()
10575 /* Prevent another signal from doing this before we finish. */
10576 clear_waiting_for_input ();
10579 Vunread_command_events
= Qnil
;
10580 unread_command_char
= -1;
10582 #if 0 /* Currently, sit_for is called from read_char without turning
10583 off polling. And that can call set_waiting_for_input.
10584 It seems to be harmless. */
10585 #ifdef POLL_FOR_INPUT
10586 /* May be > 1 if in recursive minibuffer. */
10587 if (poll_suppress_count
== 0)
10591 if (FRAMEP (internal_last_event_frame
)
10592 && !EQ (internal_last_event_frame
, selected_frame
))
10593 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10596 _longjmp (getcjmp
, 1);
10599 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10600 doc
: /* Set mode of reading keyboard input.
10601 First arg INTERRUPT non-nil means use input interrupts;
10602 nil means use CBREAK mode.
10603 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10604 (no effect except in CBREAK mode).
10605 Third arg META t means accept 8-bit input (for a Meta key).
10606 META nil means ignore the top bit, on the assumption it is parity.
10607 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10608 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10609 See also `current-input-mode'. */)
10610 (interrupt
, flow
, meta
, quit
)
10611 Lisp_Object interrupt
, flow
, meta
, quit
;
10613 /* XXX This function needs to be revised for multi-device support.
10614 Currently it compiles fine, but its semantics are wrong. It sets
10615 global parameters (e.g. interrupt_input) based on only the
10616 current frame's device. */
10619 && (!INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400))
10620 error ("set-input-mode: QUIT must be an ASCII character");
10622 #ifdef POLL_FOR_INPUT
10627 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10628 /* this causes startup screen to be restored and messes with the mouse */
10629 reset_sys_modes (CURTTY ());
10633 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10634 if (FRAME_DEVICE (SELECTED_FRAME ())->read_socket_hook
)
10636 /* When using X, don't give the user a real choice,
10637 because we haven't implemented the mechanisms to support it. */
10638 #ifdef NO_SOCK_SIGIO
10639 interrupt_input
= 0;
10640 #else /* not NO_SOCK_SIGIO */
10641 interrupt_input
= 1;
10642 #endif /* NO_SOCK_SIGIO */
10645 interrupt_input
= !NILP (interrupt
);
10646 #else /* not SIGIO */
10647 interrupt_input
= 0;
10648 #endif /* not SIGIO */
10650 /* Our VMS input only works by interrupts, as of now. */
10652 interrupt_input
= 1;
10655 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10657 struct tty_display_info
*tty
= CURTTY ();
10658 tty
->flow_control
= !NILP (flow
);
10661 else if (EQ (meta
, Qt
))
10668 /* Don't let this value be out of range. */
10669 quit_char
= XINT (quit
) & (NILP (meta
) ? 0177 : 0377);
10672 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
10673 init_sys_modes (CURTTY ());
10676 #ifdef POLL_FOR_INPUT
10677 poll_suppress_count
= 1;
10683 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10684 doc
: /* Return information about the way Emacs currently reads keyboard input.
10685 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10686 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10687 nil, Emacs is using CBREAK mode.
10688 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10689 terminal; this does not apply if Emacs uses interrupt-driven input.
10690 META is t if accepting 8-bit input with 8th bit as Meta flag.
10691 META nil means ignoring the top bit, on the assumption it is parity.
10692 META is neither t nor nil if accepting 8-bit input and using
10693 all 8 bits as the character code.
10694 QUIT is the character Emacs currently uses to quit.
10695 The elements of this list correspond to the arguments of
10696 `set-input-mode'. */)
10699 Lisp_Object val
[4];
10700 struct frame
*sf
= XFRAME (selected_frame
);
10702 val
[0] = interrupt_input
? Qt
: Qnil
;
10703 if (FRAME_TERMCAP_P (sf
))
10705 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10706 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10708 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10715 XSETFASTINT (val
[3], quit_char
);
10717 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10720 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10721 doc
: /* Return position information for pixel coordinates X and Y.
10722 By default, X and Y are relative to text area of the selected window.
10723 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10724 If optional fourth arg WHOLE is non-nil, X is relative to the left
10725 edge of the window.
10727 The return value is similar to a mouse click position:
10728 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10729 IMAGE (DX . DY) (WIDTH . HEIGHT))
10730 The `posn-' functions access elements of such lists. */)
10731 (x
, y
, frame_or_window
, whole
)
10732 Lisp_Object x
, y
, frame_or_window
, whole
;
10737 if (NILP (frame_or_window
))
10738 frame_or_window
= selected_window
;
10740 if (WINDOWP (frame_or_window
))
10744 CHECK_LIVE_WINDOW (frame_or_window
);
10746 w
= XWINDOW (frame_or_window
);
10747 XSETINT (x
, (WINDOW_TO_FRAME_PIXEL_X (w
, XINT (x
))
10749 ? window_box_left_offset (w
, TEXT_AREA
)
10750 : - (WINDOW_LEFT_SCROLL_BAR_COLS (w
)
10751 * WINDOW_FRAME_COLUMN_WIDTH (w
)))));
10752 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10753 frame_or_window
= w
->frame
;
10756 CHECK_LIVE_FRAME (frame_or_window
);
10758 return make_lispy_position (XFRAME (frame_or_window
), &x
, &y
, 0);
10761 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10762 doc
: /* Return position information for buffer POS in WINDOW.
10763 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10765 Return nil if position is not visible in window. Otherwise,
10766 the return value is similar to that returned by `event-start' for
10767 a mouse click at the upper left corner of the glyph corresponding
10768 to the given buffer position:
10769 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10770 IMAGE (DX . DY) (WIDTH . HEIGHT))
10771 The `posn-' functions access elements of such lists. */)
10773 Lisp_Object pos
, window
;
10777 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10779 tem
= Fposn_at_x_y (XCAR (tem
), XCAR (XCDR (tem
)), window
, Qnil
);
10785 * Set up a new kboard object with reasonable initial values.
10791 kb
->Voverriding_terminal_local_map
= Qnil
;
10792 kb
->Vlast_command
= Qnil
;
10793 kb
->Vreal_last_command
= Qnil
;
10794 kb
->Vprefix_arg
= Qnil
;
10795 kb
->Vlast_prefix_arg
= Qnil
;
10796 kb
->kbd_queue
= Qnil
;
10797 kb
->kbd_queue_has_data
= 0;
10798 kb
->immediate_echo
= 0;
10799 kb
->echo_string
= Qnil
;
10800 kb
->echo_after_prompt
= -1;
10801 kb
->kbd_macro_buffer
= 0;
10802 kb
->kbd_macro_bufsize
= 0;
10803 kb
->defining_kbd_macro
= Qnil
;
10804 kb
->Vlast_kbd_macro
= Qnil
;
10805 kb
->reference_count
= 0;
10806 kb
->Vsystem_key_alist
= Qnil
;
10807 kb
->system_key_syms
= Qnil
;
10808 kb
->Vlocal_function_key_map
= Fmake_sparse_keymap (Qnil
);
10809 Fset_keymap_parent (kb
->Vlocal_function_key_map
, Vfunction_key_map
);
10810 kb
->Vlocal_key_translation_map
= Fmake_sparse_keymap (Qnil
);
10811 Fset_keymap_parent (kb
->Vlocal_key_translation_map
, Vkey_translation_map
);
10812 kb
->Vdefault_minibuffer_frame
= Qnil
;
10816 * Destroy the contents of a kboard object, but not the object itself.
10817 * We use this just before deleting it, or if we're going to initialize
10818 * it a second time.
10824 if (kb
->kbd_macro_buffer
)
10825 xfree (kb
->kbd_macro_buffer
);
10828 #ifdef MULTI_KBOARD
10830 /* Free KB and memory referenced from it. */
10838 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10841 *kbp
= kb
->next_kboard
;
10843 /* Prevent a dangling reference to KB. */
10844 if (kb
== current_kboard
10845 && FRAMEP (selected_frame
)
10846 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10848 current_kboard
= XFRAME (selected_frame
)->device
->kboard
;
10849 if (current_kboard
== kb
)
10857 #endif /* MULTI_KBOARD */
10862 /* This is correct before outermost invocation of the editor loop */
10863 command_loop_level
= -1;
10864 immediate_quit
= 0;
10865 quit_char
= Ctl ('g');
10866 Vunread_command_events
= Qnil
;
10867 unread_command_char
= -1;
10868 EMACS_SET_SECS_USECS (timer_idleness_start_time
, -1, -1);
10870 recent_keys_index
= 0;
10871 kbd_fetch_ptr
= kbd_buffer
;
10872 kbd_store_ptr
= kbd_buffer
;
10874 do_mouse_tracking
= Qnil
;
10878 /* This means that command_loop_1 won't try to select anything the first
10880 internal_last_event_frame
= Qnil
;
10881 Vlast_event_frame
= internal_last_event_frame
;
10883 #ifdef MULTI_KBOARD
10884 current_kboard
= initial_kboard
;
10886 wipe_kboard (current_kboard
);
10887 init_kboard (current_kboard
);
10889 if (!noninteractive
)
10891 /* Before multi-tty support, these handlers used to be installed
10892 only if the current session was a tty session. Now an Emacs
10893 session may have multiple display types, so we always handle
10894 SIGINT. There is special code in interrupt_signal to exit
10895 Emacs on SIGINT when there are no termcap frames on the
10896 controlling terminal. */
10897 signal (SIGINT
, interrupt_signal
);
10898 #if defined (HAVE_TERMIO) || defined (HAVE_TERMIOS)
10899 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10900 SIGQUIT and we can't tell which one it will give us. */
10901 signal (SIGQUIT
, interrupt_signal
);
10902 #endif /* HAVE_TERMIO */
10904 /* Note SIGIO has been undef'd if FIONREAD is missing. */
10906 if (!noninteractive
)
10907 signal (SIGIO
, input_available_signal
);
10910 /* Use interrupt input by default, if it works and noninterrupt input
10911 has deficiencies. */
10913 #ifdef INTERRUPT_INPUT
10914 interrupt_input
= 1;
10916 interrupt_input
= 0;
10919 /* Our VMS input only works by interrupts, as of now. */
10921 interrupt_input
= 1;
10927 if (keyboard_init_hook
)
10928 (*keyboard_init_hook
) ();
10930 #ifdef POLL_FOR_INPUT
10931 poll_suppress_count
= 1;
10936 /* At least provide an escape route since C-g doesn't work. */
10937 signal (SIGINT
, interrupt_signal
);
10941 /* This type's only use is in syms_of_keyboard, to initialize the
10942 event header symbols and put properties on them. */
10943 struct event_head
{
10949 struct event_head head_table
[] = {
10950 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10951 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10952 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10953 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10954 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10955 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10956 /* `select-window' should be handled just like `switch-frame'
10957 in read_key_sequence. */
10958 {&Qselect_window
, "select-window", &Qswitch_frame
}
10962 syms_of_keyboard ()
10964 Vpre_help_message
= Qnil
;
10965 staticpro (&Vpre_help_message
);
10967 Vlispy_mouse_stem
= build_string ("mouse");
10968 staticpro (&Vlispy_mouse_stem
);
10971 QCimage
= intern (":image");
10972 staticpro (&QCimage
);
10974 staticpro (&Qhelp_echo
);
10975 Qhelp_echo
= intern ("help-echo");
10977 staticpro (&item_properties
);
10978 item_properties
= Qnil
;
10980 staticpro (&tool_bar_item_properties
);
10981 tool_bar_item_properties
= Qnil
;
10982 staticpro (&tool_bar_items_vector
);
10983 tool_bar_items_vector
= Qnil
;
10985 staticpro (&real_this_command
);
10986 real_this_command
= Qnil
;
10988 Qtimer_event_handler
= intern ("timer-event-handler");
10989 staticpro (&Qtimer_event_handler
);
10991 Qdisabled_command_function
= intern ("disabled-command-function");
10992 staticpro (&Qdisabled_command_function
);
10994 Qself_insert_command
= intern ("self-insert-command");
10995 staticpro (&Qself_insert_command
);
10997 Qforward_char
= intern ("forward-char");
10998 staticpro (&Qforward_char
);
11000 Qbackward_char
= intern ("backward-char");
11001 staticpro (&Qbackward_char
);
11003 Qdisabled
= intern ("disabled");
11004 staticpro (&Qdisabled
);
11006 Qundefined
= intern ("undefined");
11007 staticpro (&Qundefined
);
11009 Qpre_command_hook
= intern ("pre-command-hook");
11010 staticpro (&Qpre_command_hook
);
11012 Qpost_command_hook
= intern ("post-command-hook");
11013 staticpro (&Qpost_command_hook
);
11015 Qdeferred_action_function
= intern ("deferred-action-function");
11016 staticpro (&Qdeferred_action_function
);
11018 Qcommand_hook_internal
= intern ("command-hook-internal");
11019 staticpro (&Qcommand_hook_internal
);
11021 Qfunction_key
= intern ("function-key");
11022 staticpro (&Qfunction_key
);
11023 Qmouse_click
= intern ("mouse-click");
11024 staticpro (&Qmouse_click
);
11025 #if defined (WINDOWSNT) || defined (MAC_OS)
11026 Qlanguage_change
= intern ("language-change");
11027 staticpro (&Qlanguage_change
);
11029 Qdrag_n_drop
= intern ("drag-n-drop");
11030 staticpro (&Qdrag_n_drop
);
11032 Qsave_session
= intern ("save-session");
11033 staticpro (&Qsave_session
);
11035 Qusr1_signal
= intern ("usr1-signal");
11036 staticpro (&Qusr1_signal
);
11037 Qusr2_signal
= intern ("usr2-signal");
11038 staticpro (&Qusr2_signal
);
11040 Qmenu_enable
= intern ("menu-enable");
11041 staticpro (&Qmenu_enable
);
11042 Qmenu_alias
= intern ("menu-alias");
11043 staticpro (&Qmenu_alias
);
11044 QCenable
= intern (":enable");
11045 staticpro (&QCenable
);
11046 QCvisible
= intern (":visible");
11047 staticpro (&QCvisible
);
11048 QChelp
= intern (":help");
11049 staticpro (&QChelp
);
11050 QCfilter
= intern (":filter");
11051 staticpro (&QCfilter
);
11052 QCbutton
= intern (":button");
11053 staticpro (&QCbutton
);
11054 QCkeys
= intern (":keys");
11055 staticpro (&QCkeys
);
11056 QCkey_sequence
= intern (":key-sequence");
11057 staticpro (&QCkey_sequence
);
11058 QCtoggle
= intern (":toggle");
11059 staticpro (&QCtoggle
);
11060 QCradio
= intern (":radio");
11061 staticpro (&QCradio
);
11063 Qmode_line
= intern ("mode-line");
11064 staticpro (&Qmode_line
);
11065 Qvertical_line
= intern ("vertical-line");
11066 staticpro (&Qvertical_line
);
11067 Qvertical_scroll_bar
= intern ("vertical-scroll-bar");
11068 staticpro (&Qvertical_scroll_bar
);
11069 Qmenu_bar
= intern ("menu-bar");
11070 staticpro (&Qmenu_bar
);
11073 Qmouse_fixup_help_message
= intern ("mouse-fixup-help-message");
11074 staticpro (&Qmouse_fixup_help_message
);
11077 Qabove_handle
= intern ("above-handle");
11078 staticpro (&Qabove_handle
);
11079 Qhandle
= intern ("handle");
11080 staticpro (&Qhandle
);
11081 Qbelow_handle
= intern ("below-handle");
11082 staticpro (&Qbelow_handle
);
11083 Qup
= intern ("up");
11085 Qdown
= intern ("down");
11086 staticpro (&Qdown
);
11087 Qtop
= intern ("top");
11089 Qbottom
= intern ("bottom");
11090 staticpro (&Qbottom
);
11091 Qend_scroll
= intern ("end-scroll");
11092 staticpro (&Qend_scroll
);
11093 Qratio
= intern ("ratio");
11094 staticpro (&Qratio
);
11096 Qevent_kind
= intern ("event-kind");
11097 staticpro (&Qevent_kind
);
11098 Qevent_symbol_elements
= intern ("event-symbol-elements");
11099 staticpro (&Qevent_symbol_elements
);
11100 Qevent_symbol_element_mask
= intern ("event-symbol-element-mask");
11101 staticpro (&Qevent_symbol_element_mask
);
11102 Qmodifier_cache
= intern ("modifier-cache");
11103 staticpro (&Qmodifier_cache
);
11105 Qrecompute_lucid_menubar
= intern ("recompute-lucid-menubar");
11106 staticpro (&Qrecompute_lucid_menubar
);
11107 Qactivate_menubar_hook
= intern ("activate-menubar-hook");
11108 staticpro (&Qactivate_menubar_hook
);
11110 Qpolling_period
= intern ("polling-period");
11111 staticpro (&Qpolling_period
);
11113 Qinput_method_function
= intern ("input-method-function");
11114 staticpro (&Qinput_method_function
);
11116 Qinput_method_exit_on_first_char
= intern ("input-method-exit-on-first-char");
11117 staticpro (&Qinput_method_exit_on_first_char
);
11118 Qinput_method_use_echo_area
= intern ("input-method-use-echo-area");
11119 staticpro (&Qinput_method_use_echo_area
);
11121 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11122 Fset (Qinput_method_use_echo_area
, Qnil
);
11124 last_point_position_buffer
= Qnil
;
11127 struct event_head
*p
;
11129 for (p
= head_table
;
11130 p
< head_table
+ (sizeof (head_table
) / sizeof (head_table
[0]));
11133 *p
->var
= intern (p
->name
);
11134 staticpro (p
->var
);
11135 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11136 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11140 button_down_location
= Fmake_vector (make_number (1), Qnil
);
11141 staticpro (&button_down_location
);
11142 mouse_syms
= Fmake_vector (make_number (1), Qnil
);
11143 staticpro (&mouse_syms
);
11144 wheel_syms
= Fmake_vector (make_number (2), Qnil
);
11145 staticpro (&wheel_syms
);
11149 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11151 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11152 for (i
= 0; i
< len
; i
++)
11153 if (modifier_names
[i
])
11154 XVECTOR (modifier_symbols
)->contents
[i
] = intern (modifier_names
[i
]);
11155 staticpro (&modifier_symbols
);
11158 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11159 staticpro (&recent_keys
);
11161 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11162 staticpro (&this_command_keys
);
11164 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11165 staticpro (&raw_keybuf
);
11167 Qextended_command_history
= intern ("extended-command-history");
11168 Fset (Qextended_command_history
, Qnil
);
11169 staticpro (&Qextended_command_history
);
11171 accent_key_syms
= Qnil
;
11172 staticpro (&accent_key_syms
);
11174 func_key_syms
= Qnil
;
11175 staticpro (&func_key_syms
);
11177 drag_n_drop_syms
= Qnil
;
11178 staticpro (&drag_n_drop_syms
);
11180 unread_switch_frame
= Qnil
;
11181 staticpro (&unread_switch_frame
);
11183 internal_last_event_frame
= Qnil
;
11184 staticpro (&internal_last_event_frame
);
11186 read_key_sequence_cmd
= Qnil
;
11187 staticpro (&read_key_sequence_cmd
);
11189 menu_bar_one_keymap_changed_items
= Qnil
;
11190 staticpro (&menu_bar_one_keymap_changed_items
);
11192 menu_bar_items_vector
= Qnil
;
11193 staticpro (&menu_bar_items_vector
);
11195 defsubr (&Sevent_convert_list
);
11196 defsubr (&Sread_key_sequence
);
11197 defsubr (&Sread_key_sequence_vector
);
11198 defsubr (&Srecursive_edit
);
11200 defsubr (&Strack_mouse
);
11202 defsubr (&Sinput_pending_p
);
11203 defsubr (&Scommand_execute
);
11204 defsubr (&Srecent_keys
);
11205 defsubr (&Sthis_command_keys
);
11206 defsubr (&Sthis_command_keys_vector
);
11207 defsubr (&Sthis_single_command_keys
);
11208 defsubr (&Sthis_single_command_raw_keys
);
11209 defsubr (&Sreset_this_command_lengths
);
11210 defsubr (&Sclear_this_command_keys
);
11211 defsubr (&Ssuspend_emacs
);
11212 defsubr (&Sabort_recursive_edit
);
11213 defsubr (&Sexit_recursive_edit
);
11214 defsubr (&Srecursion_depth
);
11215 defsubr (&Stop_level
);
11216 defsubr (&Sdiscard_input
);
11217 defsubr (&Sopen_dribble_file
);
11218 defsubr (&Sset_input_mode
);
11219 defsubr (&Scurrent_input_mode
);
11220 defsubr (&Sexecute_extended_command
);
11221 defsubr (&Sposn_at_point
);
11222 defsubr (&Sposn_at_x_y
);
11224 DEFVAR_LISP ("last-command-char", &last_command_char
,
11225 doc
: /* Last input event that was part of a command. */);
11227 DEFVAR_LISP_NOPRO ("last-command-event", &last_command_char
,
11228 doc
: /* Last input event that was part of a command. */);
11230 DEFVAR_LISP ("last-nonmenu-event", &last_nonmenu_event
,
11231 doc
: /* Last input event in a command, except for mouse menu events.
11232 Mouse menus give back keys that don't look like mouse events;
11233 this variable holds the actual mouse event that led to the menu,
11234 so that you can determine whether the command was run by mouse or not. */);
11236 DEFVAR_LISP ("last-input-char", &last_input_char
,
11237 doc
: /* Last input event. */);
11239 DEFVAR_LISP_NOPRO ("last-input-event", &last_input_char
,
11240 doc
: /* Last input event. */);
11242 DEFVAR_LISP ("unread-command-events", &Vunread_command_events
,
11243 doc
: /* List of events to be read as the command input.
11244 These events are processed first, before actual keyboard input. */);
11245 Vunread_command_events
= Qnil
;
11247 DEFVAR_INT ("unread-command-char", &unread_command_char
,
11248 doc
: /* If not -1, an object to be read as next command input event. */);
11250 DEFVAR_LISP ("unread-post-input-method-events", &Vunread_post_input_method_events
,
11251 doc
: /* List of events to be processed as input by input methods.
11252 These events are processed after `unread-command-events', but
11253 before actual keyboard input. */);
11254 Vunread_post_input_method_events
= Qnil
;
11256 DEFVAR_LISP ("unread-input-method-events", &Vunread_input_method_events
,
11257 doc
: /* List of events to be processed as input by input methods.
11258 These events are processed after `unread-command-events', but
11259 before actual keyboard input. */);
11260 Vunread_input_method_events
= Qnil
;
11262 DEFVAR_LISP ("meta-prefix-char", &meta_prefix_char
,
11263 doc
: /* Meta-prefix character code.
11264 Meta-foo as command input turns into this character followed by foo. */);
11265 XSETINT (meta_prefix_char
, 033);
11267 DEFVAR_KBOARD ("last-command", Vlast_command
,
11268 doc
: /* The last command executed.
11269 Normally a symbol with a function definition, but can be whatever was found
11270 in the keymap, or whatever the variable `this-command' was set to by that
11273 The value `mode-exit' is special; it means that the previous command
11274 read an event that told it to exit, and it did so and unread that event.
11275 In other words, the present command is the event that made the previous
11278 The value `kill-region' is special; it means that the previous command
11279 was a kill command.
11281 `last-command' has a separate binding for each display device.
11282 See Info node `(elisp)Multiple displays'. */);
11284 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11285 doc
: /* Same as `last-command', but never altered by Lisp code. */);
11287 DEFVAR_LISP ("this-command", &Vthis_command
,
11288 doc
: /* The command now being executed.
11289 The command can set this variable; whatever is put here
11290 will be in `last-command' during the following command. */);
11291 Vthis_command
= Qnil
;
11293 DEFVAR_LISP ("this-original-command", &Vthis_original_command
,
11294 doc
: /* The command bound to the current key sequence before remapping.
11295 It equals `this-command' if the original command was not remapped through
11296 any of the active keymaps. Otherwise, the value of `this-command' is the
11297 result of looking up the original command in the active keymaps. */);
11298 Vthis_original_command
= Qnil
;
11300 DEFVAR_INT ("auto-save-interval", &auto_save_interval
,
11301 doc
: /* *Number of input events between auto-saves.
11302 Zero means disable autosaving due to number of characters typed. */);
11303 auto_save_interval
= 300;
11305 DEFVAR_LISP ("auto-save-timeout", &Vauto_save_timeout
,
11306 doc
: /* *Number of seconds idle time before auto-save.
11307 Zero or nil means disable auto-saving due to idleness.
11308 After auto-saving due to this many seconds of idle time,
11309 Emacs also does a garbage collection if that seems to be warranted. */);
11310 XSETFASTINT (Vauto_save_timeout
, 30);
11312 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes
,
11313 doc
: /* *Nonzero means echo unfinished commands after this many seconds of pause.
11314 The value may be integer or floating point. */);
11315 Vecho_keystrokes
= make_number (1);
11317 DEFVAR_INT ("polling-period", &polling_period
,
11318 doc
: /* *Interval between polling for input during Lisp execution.
11319 The reason for polling is to make C-g work to stop a running program.
11320 Polling is needed only when using X windows and SIGIO does not work.
11321 Polling is automatically disabled in all other cases. */);
11322 polling_period
= 2;
11324 DEFVAR_LISP ("double-click-time", &Vdouble_click_time
,
11325 doc
: /* *Maximum time between mouse clicks to make a double-click.
11326 Measured in milliseconds. nil means disable double-click recognition;
11327 t means double-clicks have no time limit and are detected
11328 by position only. */);
11329 Vdouble_click_time
= make_number (500);
11331 DEFVAR_INT ("double-click-fuzz", &double_click_fuzz
,
11332 doc
: /* *Maximum mouse movement between clicks to make a double-click.
11333 On window-system frames, value is the number of pixels the mouse may have
11334 moved horizontally or vertically between two clicks to make a double-click.
11335 On non window-system frames, value is interpreted in units of 1/8 characters
11338 This variable is also the threshold for motion of the mouse
11339 to count as a drag. */);
11340 double_click_fuzz
= 3;
11342 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", &inhibit_local_menu_bar_menus
,
11343 doc
: /* *Non-nil means inhibit local map menu bar menus. */);
11344 inhibit_local_menu_bar_menus
= 0;
11346 DEFVAR_INT ("num-input-keys", &num_input_keys
,
11347 doc
: /* Number of complete key sequences read as input so far.
11348 This includes key sequences read from keyboard macros.
11349 The number is effectively the number of interactive command invocations. */);
11350 num_input_keys
= 0;
11352 DEFVAR_INT ("num-nonmacro-input-events", &num_nonmacro_input_events
,
11353 doc
: /* Number of input events read from the keyboard so far.
11354 This does not include events generated by keyboard macros. */);
11355 num_nonmacro_input_events
= 0;
11357 DEFVAR_LISP ("last-event-frame", &Vlast_event_frame
,
11358 doc
: /* The frame in which the most recently read event occurred.
11359 If the last event came from a keyboard macro, this is set to `macro'. */);
11360 Vlast_event_frame
= Qnil
;
11362 /* This variable is set up in sysdep.c. */
11363 DEFVAR_LISP ("tty-erase-char", &Vtty_erase_char
,
11364 doc
: /* The ERASE character as set by the user with stty. */);
11366 DEFVAR_LISP ("help-char", &Vhelp_char
,
11367 doc
: /* Character to recognize as meaning Help.
11368 When it is read, do `(eval help-form)', and display result if it's a string.
11369 If the value of `help-form' is nil, this char can be read normally. */);
11370 XSETINT (Vhelp_char
, Ctl ('H'));
11372 DEFVAR_LISP ("help-event-list", &Vhelp_event_list
,
11373 doc
: /* List of input events to recognize as meaning Help.
11374 These work just like the value of `help-char' (see that). */);
11375 Vhelp_event_list
= Qnil
;
11377 DEFVAR_LISP ("help-form", &Vhelp_form
,
11378 doc
: /* Form to execute when character `help-char' is read.
11379 If the form returns a string, that string is displayed.
11380 If `help-form' is nil, the help char is not recognized. */);
11383 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command
,
11384 doc
: /* Command to run when `help-char' character follows a prefix key.
11385 This command is used only when there is no actual binding
11386 for that character after that prefix key. */);
11387 Vprefix_help_command
= Qnil
;
11389 DEFVAR_LISP ("top-level", &Vtop_level
,
11390 doc
: /* Form to evaluate when Emacs starts up.
11391 Useful to set before you dump a modified Emacs. */);
11394 DEFVAR_LISP ("keyboard-translate-table", &Vkeyboard_translate_table
,
11395 doc
: /* Translate table for keyboard input, or nil.
11396 If non-nil, the value should be a char-table. Each character read
11397 from the keyboard is looked up in this char-table. If the value found
11398 there is non-nil, then it is used instead of the actual input character.
11400 The value can also be a string or vector, but this is considered obsolete.
11401 If it is a string or vector of length N, character codes N and up are left
11402 untranslated. In a vector, an element which is nil means "no translation".
11404 This is applied to the characters supplied to input methods, not their
11405 output. See also `translation-table-for-input'. */);
11406 Vkeyboard_translate_table
= Qnil
;
11408 DEFVAR_BOOL ("cannot-suspend", &cannot_suspend
,
11409 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11410 \(Even if the operating system has support for stopping a process.\) */);
11411 cannot_suspend
= 0;
11413 DEFVAR_BOOL ("menu-prompting", &menu_prompting
,
11414 doc
: /* Non-nil means prompt with menus when appropriate.
11415 This is done when reading from a keymap that has a prompt string,
11416 for elements that have prompt strings.
11417 The menu is displayed on the screen
11418 if X menus were enabled at configuration
11419 time and the previous event was a mouse click prefix key.
11420 Otherwise, menu prompting uses the echo area. */);
11421 menu_prompting
= 1;
11423 DEFVAR_LISP ("menu-prompt-more-char", &menu_prompt_more_char
,
11424 doc
: /* Character to see next line of menu prompt.
11425 Type this character while in a menu prompt to rotate around the lines of it. */);
11426 XSETINT (menu_prompt_more_char
, ' ');
11428 DEFVAR_INT ("extra-keyboard-modifiers", &extra_keyboard_modifiers
,
11429 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11430 Emacs applies the modifiers of the character stored here to each keyboard
11431 character it reads. For example, after evaluating the expression
11432 (setq extra-keyboard-modifiers ?\\C-x)
11433 all input characters will have the control modifier applied to them.
11435 Note that the character ?\\C-@, equivalent to the integer zero, does
11436 not count as a control character; rather, it counts as a character
11437 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11438 cancels any modification. */);
11439 extra_keyboard_modifiers
= 0;
11441 DEFVAR_LISP ("deactivate-mark", &Vdeactivate_mark
,
11442 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11443 The command loop sets this to nil before each command,
11444 and tests the value when the command returns.
11445 Buffer modification stores t in this variable. */);
11446 Vdeactivate_mark
= Qnil
;
11448 DEFVAR_LISP ("command-hook-internal", &Vcommand_hook_internal
,
11449 doc
: /* Temporary storage of pre-command-hook or post-command-hook. */);
11450 Vcommand_hook_internal
= Qnil
;
11452 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook
,
11453 doc
: /* Normal hook run before each command is executed.
11454 If an unhandled error happens in running this hook,
11455 the hook value is set to nil, since otherwise the error
11456 might happen repeatedly and make Emacs nonfunctional. */);
11457 Vpre_command_hook
= Qnil
;
11459 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook
,
11460 doc
: /* Normal hook run after each command is executed.
11461 If an unhandled error happens in running this hook,
11462 the hook value is set to nil, since otherwise the error
11463 might happen repeatedly and make Emacs nonfunctional. */);
11464 Vpost_command_hook
= Qnil
;
11467 DEFVAR_LISP ("echo-area-clear-hook", ...,
11468 doc
: /* Normal hook run when clearing the echo area. */);
11470 Qecho_area_clear_hook
= intern ("echo-area-clear-hook");
11471 staticpro (&Qecho_area_clear_hook
);
11472 SET_SYMBOL_VALUE (Qecho_area_clear_hook
, Qnil
);
11474 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", &Vlucid_menu_bar_dirty_flag
,
11475 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11476 Vlucid_menu_bar_dirty_flag
= Qnil
;
11478 DEFVAR_LISP ("menu-bar-final-items", &Vmenu_bar_final_items
,
11479 doc
: /* List of menu bar items to move to the end of the menu bar.
11480 The elements of the list are event types that may have menu bar bindings. */);
11481 Vmenu_bar_final_items
= Qnil
;
11483 DEFVAR_KBOARD ("overriding-terminal-local-map",
11484 Voverriding_terminal_local_map
,
11485 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11486 If this variable is non-nil, it is used as a keymap instead of the
11487 buffer's local map, and the minor mode keymaps and text property keymaps.
11488 It also replaces `overriding-local-map'.
11490 This variable is intended to let commands such as `universal-argument'
11491 set up a different keymap for reading the next command.
11493 `overriding-terminal-local-map' has a separate binding for each display device.
11494 See Info node `(elisp)Multiple displays'. */);
11496 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map
,
11497 doc
: /* Keymap that overrides all other local keymaps.
11498 If this variable is non-nil, it is used as a keymap--replacing the
11499 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11500 Voverriding_local_map
= Qnil
;
11502 DEFVAR_LISP ("overriding-local-map-menu-flag", &Voverriding_local_map_menu_flag
,
11503 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11504 Otherwise, the menu bar continues to reflect the buffer's local map
11505 and the minor mode maps regardless of `overriding-local-map'. */);
11506 Voverriding_local_map_menu_flag
= Qnil
;
11508 DEFVAR_LISP ("special-event-map", &Vspecial_event_map
,
11509 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11510 Vspecial_event_map
= Fcons (intern ("keymap"), Qnil
);
11512 DEFVAR_LISP ("track-mouse", &do_mouse_tracking
,
11513 doc
: /* *Non-nil means generate motion events for mouse motion. */);
11515 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11516 doc
: /* Alist of system-specific X windows key symbols.
11517 Each element should have the form (N . SYMBOL) where N is the
11518 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11519 and SYMBOL is its name.
11521 `system-key-alist' has a separate binding for each display device.
11522 See Info node `(elisp)Multiple displays'.
11524 Note that the currently selected frame has very little to do with
11525 which binding of this variable is active at any given moment. If you
11526 need set or get the binding on a specific display, use
11527 `terminal-local-value' and `set-terminal-local-value'. */);
11529 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11530 doc
: /* Keymap mapping ASCII function key sequences onto their preferred forms.
11531 This allows Emacs to recognize function keys sent from ASCII
11532 terminals at any point in a key sequence.
11534 The `read-key-sequence' function replaces any subsequence bound by
11535 `function-key-map' with its binding. More precisely, when the active
11536 keymaps have no binding for the current key sequence but
11537 `function-key-map' binds a suffix of the sequence to a vector or string,
11538 `read-key-sequence' replaces the matching suffix with its binding, and
11539 continues with the new sequence.
11541 The events that come from bindings in `function-key-map' are not
11542 themselves looked up in `function-key-map'.
11544 For example, suppose `function-key-map' binds `ESC O P' to [f1].
11545 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11546 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix
11547 key, typing `ESC O P x' would return [f1 x].
11549 `function-key-map' has a separate binding for each display device.
11550 See Info node `(elisp)Multiple displays'. If you need to define a
11551 binding on all display devices, change `global-function-key-map'
11554 Note that the currently selected frame has very little to do with
11555 which binding of this variable is active at any given moment. If you
11556 need set or get the binding on a specific display, use
11557 `terminal-local-value' and `set-terminal-local-value'. */);
11559 DEFVAR_LISP ("function-key-map", &Vfunction_key_map
,
11560 doc
: /* The parent keymap of all `local-function-key-map' instances.
11561 Function key definitions that apply to all display devices should go
11563 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11565 DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map
,
11566 doc
: /* Keymap of key translations that can override keymaps.
11567 This keymap works like `function-key-map', but comes after that,
11568 and its non-prefix bindings override ordinary bindings.
11570 `key-translation-map' has a separate binding for each display device.
11571 (See Info node `(elisp)Multiple displays'.) If you need to set a key
11572 translation on all devices, change `global-key-translation-map' instead.
11574 Note that the currently selected frame has very little to do with
11575 which binding of this variable is active at any given moment. If you
11576 need set or get the binding on a specific display, use
11577 `terminal-local-value' and `set-terminal-local-value'. */);
11579 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map
,
11580 doc
: /* The parent keymap of all `local-key-translation-map' instances.
11581 Key translations that apply to all display devices should go here. */);
11582 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11584 DEFVAR_LISP ("deferred-action-list", &Vdeferred_action_list
,
11585 doc
: /* List of deferred actions to be performed at a later time.
11586 The precise format isn't relevant here; we just check whether it is nil. */);
11587 Vdeferred_action_list
= Qnil
;
11589 DEFVAR_LISP ("deferred-action-function", &Vdeferred_action_function
,
11590 doc
: /* Function to call to handle deferred actions, after each command.
11591 This function is called with no arguments after each command
11592 whenever `deferred-action-list' is non-nil. */);
11593 Vdeferred_action_function
= Qnil
;
11595 DEFVAR_LISP ("suggest-key-bindings", &Vsuggest_key_bindings
,
11596 doc
: /* *Non-nil means show the equivalent key-binding when M-x command has one.
11597 The value can be a length of time to show the message for.
11598 If the value is non-nil and not a number, we wait 2 seconds. */);
11599 Vsuggest_key_bindings
= Qt
;
11601 DEFVAR_LISP ("timer-list", &Vtimer_list
,
11602 doc
: /* List of active absolute time timers in order of increasing time. */);
11603 Vtimer_list
= Qnil
;
11605 DEFVAR_LISP ("timer-idle-list", &Vtimer_idle_list
,
11606 doc
: /* List of active idle-time timers in order of increasing time. */);
11607 Vtimer_idle_list
= Qnil
;
11609 DEFVAR_LISP ("input-method-function", &Vinput_method_function
,
11610 doc
: /* If non-nil, the function that implements the current input method.
11611 It's called with one argument, a printing character that was just read.
11612 \(That means a character with code 040...0176.)
11613 Typically this function uses `read-event' to read additional events.
11614 When it does so, it should first bind `input-method-function' to nil
11615 so it will not be called recursively.
11617 The function should return a list of zero or more events
11618 to be used as input. If it wants to put back some events
11619 to be reconsidered, separately, by the input method,
11620 it can add them to the beginning of `unread-command-events'.
11622 The input method function can find in `input-method-previous-method'
11623 the previous echo area message.
11625 The input method function should refer to the variables
11626 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11627 for guidance on what to do. */);
11628 Vinput_method_function
= Qnil
;
11630 DEFVAR_LISP ("input-method-previous-message",
11631 &Vinput_method_previous_message
,
11632 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11633 This variable exists because `read-event' clears the echo area
11634 before running the input method. It is nil if there was no message. */);
11635 Vinput_method_previous_message
= Qnil
;
11637 DEFVAR_LISP ("show-help-function", &Vshow_help_function
,
11638 doc
: /* If non-nil, the function that implements the display of help.
11639 It's called with one argument, the help string to display. */);
11640 Vshow_help_function
= Qnil
;
11642 DEFVAR_LISP ("disable-point-adjustment", &Vdisable_point_adjustment
,
11643 doc
: /* If non-nil, suppress point adjustment after executing a command.
11645 After a command is executed, if point is moved into a region that has
11646 special properties (e.g. composition, display), we adjust point to
11647 the boundary of the region. But, when a command sets this variable to
11648 non-nil, we suppress the point adjustment.
11650 This variable is set to nil before reading a command, and is checked
11651 just after executing the command. */);
11652 Vdisable_point_adjustment
= Qnil
;
11654 DEFVAR_LISP ("global-disable-point-adjustment",
11655 &Vglobal_disable_point_adjustment
,
11656 doc
: /* *If non-nil, always suppress point adjustment.
11658 The default value is nil, in which case, point adjustment are
11659 suppressed only after special commands that set
11660 `disable-point-adjustment' (which see) to non-nil. */);
11661 Vglobal_disable_point_adjustment
= Qnil
;
11663 DEFVAR_BOOL ("update-menu-bindings", &update_menu_bindings
,
11664 doc
: /* Non-nil means updating menu bindings is allowed.
11665 A value of nil means menu bindings should not be updated.
11666 Used during Emacs' startup. */);
11667 update_menu_bindings
= 1;
11669 DEFVAR_LISP ("minibuffer-message-timeout", &Vminibuffer_message_timeout
,
11670 doc
: /* *How long to display an echo-area message when the minibuffer is active.
11671 If the value is not a number, such messages don't time out. */);
11672 Vminibuffer_message_timeout
= make_number (2);
11674 DEFVAR_LISP ("throw-on-input", &Vthrow_on_input
,
11675 doc
: /* If non-nil, any keyboard input throws to this symbol.
11676 The value of that variable is passed to `quit-flag' and later causes a
11677 peculiar kind of quitting. */);
11678 Vthrow_on_input
= Qnil
;
11682 keys_of_keyboard ()
11684 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11685 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11686 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11687 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11688 initial_define_key (meta_map
, 'x', "execute-extended-command");
11690 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11691 "handle-delete-frame");
11692 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11693 current-prefix-arg, as is done in `handle-switch-frame'.
11694 But `handle-switch-frame is not run from the special-map.
11695 Commands from that map are run in a special way that automatically
11696 preserves the prefix-arg. Restoring the prefix arg here is not just
11697 redundant but harmful:
11699 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11700 - after the first prompt, the exit-minibuffer-hook is run which may
11701 iconify a frame and thus push a `iconify-frame' event.
11702 - after running exit-minibuffer-hook, current-prefix-arg is
11703 restored to the non-nil value it had before the prompt.
11704 - we enter the second prompt.
11705 current-prefix-arg is non-nil, prefix-arg is nil.
11706 - before running the first real event, we run the special iconify-frame
11707 event, but we pass the `special' arg to execute-command so
11708 current-prefix-arg and prefix-arg are left untouched.
11709 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11710 - the next key event will have a spuriously non-nil current-prefix-arg. */
11711 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11713 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11715 /* Handling it at such a low-level causes read_key_sequence to get
11716 * confused because it doesn't realize that the current_buffer was
11717 * changed by read_char.
11719 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11720 * "handle-select-window"); */
11721 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11722 "handle-save-session");
11725 /* Mark the pointers in the kboard objects.
11726 Called by the Fgarbage_collector. */
11732 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11734 if (kb
->kbd_macro_buffer
)
11735 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11737 mark_object (kb
->Voverriding_terminal_local_map
);
11738 mark_object (kb
->Vlast_command
);
11739 mark_object (kb
->Vreal_last_command
);
11740 mark_object (kb
->Vprefix_arg
);
11741 mark_object (kb
->Vlast_prefix_arg
);
11742 mark_object (kb
->kbd_queue
);
11743 mark_object (kb
->defining_kbd_macro
);
11744 mark_object (kb
->Vlast_kbd_macro
);
11745 mark_object (kb
->Vsystem_key_alist
);
11746 mark_object (kb
->system_key_syms
);
11747 mark_object (kb
->Vlocal_function_key_map
);
11748 mark_object (kb
->Vlocal_key_translation_map
);
11749 mark_object (kb
->Vdefault_minibuffer_frame
);
11750 mark_object (kb
->echo_string
);
11753 struct input_event
*event
;
11754 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11756 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11757 event
= kbd_buffer
;
11758 if (event
->kind
!= SELECTION_REQUEST_EVENT
11759 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11761 mark_object (event
->x
);
11762 mark_object (event
->y
);
11764 mark_object (event
->frame_or_window
);
11765 mark_object (event
->arg
);
11770 /* arch-tag: 774e34d7-6d31-42f3-8397-e079a4e4c9ca
11771 (do not change this comment) */